Class: Generator::API

Inherits:
Object
  • Object
show all
Includes:
FileWriter, Formatter
Defined in:
lib/generator/api.rb

Constant Summary

Constants included from Formatter

Formatter::MAX_LINE_LENGTH

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Formatter

#convert_doc_links_to_full_url, #convert_html_links_to_yard, #format_method_definition, #split_long_comment_line

Methods included from FileWriter

#format_files, #write_file

Constructor Details

#initialize(file) ⇒ API

Returns a new instance of API.



56
57
58
59
 
# File 'lib/generator/api.rb', line 56

def initialize(file)
  @file = file
  @written_files = []
end

Instance Attribute Details

#file ⇒ Object (readonly)

Returns the value of attribute file.



24
25
26
 
# File 'lib/generator/api.rb', line 24

def file
  @file
end

Class Method Details

.apis ⇒ Object 



34
35
36
37
38
39
40
41
42
 
# File 'lib/generator/api.rb', line 34

def apis
  api_models = Dir.glob(File.join(Config::BASE_PATH, "selling-partner-api-models/models/**/*.json"))
  APINameResolver.validate_no_unmapped_collisions!(api_models)

  api_models.map { |file| new(file) }.sort_by do |api|
    version_key = api.version.start_with?("v") ? api.version : "z#{api.version}"
    [api.name, version_key]
  end
end

.cleanup! ⇒ Object 



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/generator/api.rb', line 44

def cleanup!
  ["lib", "sig"].each do |base|
    apis_path = File.join(Config::BASE_PATH, base, "peddler/apis")
    FileUtils.mkdir_p(apis_path)
    # Delete only generated API subdirectories, preserve all files (money.rb, etc.)
    Dir.glob(File.join(apis_path, "*")).select { |p| File.directory?(p) }.each do |dir|
      FileUtils.rm_rf(dir)
    end
  end
end

.generate ⇒ Object 



27
28
29
30
31
32
 
# File 'lib/generator/api.rb', line 27

def generate
  cleanup!

  # Generate each API in parallel
  Parallel.each(apis, &:generate)
end

Instance Method Details

#class_name ⇒ Object 



146
147
148
 
# File 'lib/generator/api.rb', line 146

def class_name
  name_with_version.camelize
end

#convenience_method_name ⇒ Object 



168
169
170
 
# File 'lib/generator/api.rb', line 168

def convenience_method_name
  name
end

#description ⇒ Object 



122
123
124
125
126
127
128
 
# File 'lib/generator/api.rb', line 122

def description
  description = model["info"]["description"]
  description = convert_html_links_to_yard(description)
  description = convert_doc_links_to_full_url(description)

  split_long_comment_line(description, base_indent: 4)
end

#file_path ⇒ Object 



190
191
192
 
# File 'lib/generator/api.rb', line 190

def file_path
  File.join(Config::BASE_PATH, "lib/#{library_name}.rb")
end

#generate ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/generator/api.rb', line 61

def generate
  generate_api_class!
  generate_types!

  # Reload to pick up newly generated files for RBS introspection
  IntrospectionLoader.reload
  generate_rbs!
  format_files(@written_files)

  Generator.logger.info("Generated api #{name_with_version}")
end

#generate_api_class! ⇒ Object 



73
74
75
 
# File 'lib/generator/api.rb', line 73

def generate_api_class!
  @written_files << write_file(file_path, render)
end

#generate_rbs! ⇒ Object 



98
99
100
101
 
# File 'lib/generator/api.rb', line 98

def generate_rbs!
  # Generate unified RBS file with both API operations and type definitions
  @written_files << RBS::Unified.new(self, name_with_version, @api_types || []).generate
end

#generate_types! ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/generator/api.rb', line 77

def generate_types!
  api_types = types
  return [] if api_types.empty?

  # Detect circular dependencies across all types for this API
  detector = CircularDependencyDetector.new(api_types)
  detector.detect
  api_types.each do |type|
    type.circular_dependencies = detector.circular_deps
    type.cycle_edges = detector.cycle_edges
  end

  # Generate each type Ruby file
  api_types.each do |type|
    @written_files << type.generate
  end

  # Store types for RBS generation
  @api_types = api_types
end

#github_model_filename ⇒ Object 



198
199
200
201
 
# File 'lib/generator/api.rb', line 198

def github_model_filename
  parts = file.split("/")
  "#{parts[-2]}/#{parts[-1]}"
end

#has_helper? ⇒ Boolean

Returns:

  • (Boolean) 


134
135
136
 
# File 'lib/generator/api.rb', line 134

def has_helper?
  File.exist?("lib/" + helper_library_name + ".rb")
end

#helper_class_name ⇒ Object 



138
139
140
 
# File 'lib/generator/api.rb', line 138

def helper_class_name
  "Peddler::Helpers::#{name_with_version.camelize}"
end

#helper_library_name ⇒ Object 



142
143
144
 
# File 'lib/generator/api.rb', line 142

def helper_library_name
  "peddler/helpers/#{name_with_version}"
end

#latest_version? ⇒ Boolean

Returns:

  • (Boolean) 


162
163
164
165
166
 
# File 'lib/generator/api.rb', line 162

def latest_version?
  all_apis = self.class.apis.select { |api| api.name == name }
  latest_version = VersionSelector.find_latest_version(all_apis.map(&:version))
  version == latest_version
end

#library_name ⇒ Object 



130
131
132
 
# File 'lib/generator/api.rb', line 130

def library_name
  "peddler/apis/#{name_with_version}"
end

#name ⇒ Object 



150
151
152
 
# File 'lib/generator/api.rb', line 150

def name
  @name ||= APINameResolver.new(file).name
end

#name_with_version ⇒ Object 



158
159
160
 
# File 'lib/generator/api.rb', line 158

def name_with_version
  [name, version].join("_")
end

#openapi_spec ⇒ Object 



194
195
196
 
# File 'lib/generator/api.rb', line 194

def openapi_spec
  model
end

#operations ⇒ Object 



172
173
174
175
176
177
 
# File 'lib/generator/api.rb', line 172

def operations
  @operations ||= begin
    ops = paths.flat_map { |path| path.operations(name_with_version) }.compact
    deduplicate_operations(ops)
  end
end

#paths ⇒ Object 



186
187
188
 
# File 'lib/generator/api.rb', line 186

def paths
  model["paths"].map { |path, methods| Path.new(path, methods) }
end

#title ⇒ Object 



118
119
120
 
# File 'lib/generator/api.rb', line 118

def title
  split_long_comment_line(model["info"]["title"], base_indent: 4)
end

#type_names ⇒ Object 



179
180
181
182
183
184
 
# File 'lib/generator/api.rb', line 179

def type_names
  openapi_spec["definitions"]
    .select { |name, def_| def_["type"] == "object" && !TypeResolver::MONEY_TYPES.include?(name) && !def_["additionalProperties"] }
    .keys
    .sort
end

#types ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/generator/api.rb', line 103

def types
  arr = []
  openapi_spec["definitions"].each do |name, definition|
    # Skip non-object definitions but allow allOf compositions and arrays
    next unless definition["type"] == "object" || definition["allOf"] || definition["type"] == "array"
    # Skip Money types as we use the custom Money type for these
    next if TypeResolver.money?(name)
    # Skip types with ONLY additionalProperties (no defined properties) - they'll be referenced as Hash
    next if definition["additionalProperties"] && !definition["properties"] && !definition["allOf"]

    arr << Type.new(name, definition, name_with_version, openapi_spec)
  end
  arr
end

#version ⇒ Object 



154
155
156
 
# File 'lib/generator/api.rb', line 154

def version
  model["info"]["version"].tr("-", "_")
end