Class: SchemaCamelizer

Inherits:
Object
  • Object
show all
Defined in:
lib/tasks/support/schema_camelizer.rb

Overview

Transforms a schema from ‘spec/support/schemas` into one with camelized keys like when

OliveBranch is used with the X-Key-Inflection header for `camel`

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(schema_path, destination_path = nil) ⇒ SchemaCamelizer

Returns a new instance of SchemaCamelizer.



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/tasks/support/schema_camelizer.rb', line 8

def initialize(schema_path, destination_path = nil)
  @original_path = schema_path
  @camel_path = destination_path
  @name = %r{/([^/]*)\.json$}.match(schema_path)[1]
  raw_schema = File.read(schema_path)
  # OliveBranch only changes keys, but the required key's value is an arrray of keys,
  #  these need to be camelized to match the keys to which they refer
  modified_schema = raw_schema.gsub(/"required": \[(["\w*,? \n]*)\]/) do
    # rubocop:disable Style/PerlBackrefs
    # use $1 to refer to the matched part of the gsub, which would be a string of quoted keys
    # split the string into an array of quoted keys
    # strip the whitespace
    # camelize each value without the quotes
    keys = $1.split(',').map(&:strip).map { |key| camelizer.call(key.gsub('"', '')) }
    # rubocop:enable Style/PerlBackrefs
    # rebuild the matched required key-value with quoted and camelized keys in the area
    "\"required\": [#{keys.map { |key| "\"#{key}\"" }.join(', ')}]"
  end

  @camel_schema = OliveBranch::Transformations.transform(JSON.parse(modified_schema), camelizer)
  @already_camelized = JSON.parse(raw_schema).to_json == @camel_schema.to_json

  # some schemas use "$ref" to include a definition from another file, transform any needed also
  @referenced_schemas = raw_schema.scan(/"\$ref": "(.*)\.json"/).flatten.map do |schema_name|
    reference_schema_path = schema_path.gsub(name, schema_name)
    SchemaCamelizer.new(reference_schema_path)
  end
end

Instance Attribute Details

#already_camelized ⇒ Object (readonly)

Returns the value of attribute already_camelized.



6
7
8
 
# File 'lib/tasks/support/schema_camelizer.rb', line 6

def already_camelized
  @already_camelized
end

#camel_schema ⇒ Object (readonly)

Returns the value of attribute camel_schema.



6
7
8
 
# File 'lib/tasks/support/schema_camelizer.rb', line 6

def camel_schema
  @camel_schema
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



6
7
8
 
# File 'lib/tasks/support/schema_camelizer.rb', line 6

def name
  @name
end

#original_path ⇒ Object (readonly)

Returns the value of attribute original_path.



6
7
8
 
# File 'lib/tasks/support/schema_camelizer.rb', line 6

def original_path
  @original_path
end

#referenced_schemas ⇒ Object (readonly)

Returns the value of attribute referenced_schemas.



6
7
8
 
# File 'lib/tasks/support/schema_camelizer.rb', line 6

def referenced_schemas
  @referenced_schemas
end

Instance Method Details

#camel_path ⇒ string

Getter for path to which new camel schema will be saved defaults to changing ‘path/to/schemas` to `path/to/schemas_camelized`

Returns:

  • (string) —

    the path for saving the camel schema



48
49
50
 
# File 'lib/tasks/support/schema_camelizer.rb', line 48

def camel_path
  @camel_path ||= original_path.gsub('schemas', 'schemas_camelized')
end

#camelizer ⇒ method

The method for camelizing the schema keys

Returns:

  • (method) —

    the method for camelizing schema keys



40
41
42
 
# File 'lib/tasks/support/schema_camelizer.rb', line 40

def camelizer
  OliveBranch::Transformations.method(:camelize)
end

#save! ⇒ array

Saves the #camel_schema to #camel_path raises an error when original schema is not from a schemas directory also saves a camelized version of any referenced schemas

Returns:

  • (array) —

    files created



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/tasks/support/schema_camelizer.rb', line 57

def save!
  raise "expected `#camel_path` (#{camel_path}) to be different from the given path" if original_path == camel_path

  camel_path_directories = camel_path.gsub(%r{[^/]*$}, '')
  FileUtils.mkdir_p(camel_path_directories)

  File.open(camel_path, 'w') do |file|
    file.write(JSON.pretty_generate(camel_schema))
    file.write("\n")
  end

  [camel_path].concat(@referenced_schemas.collect(&:save!).flatten)
end

#unchanged_schemas ⇒ array

Checks schema and it’s references to see if any of them were already camelized

Returns:

  • (array) —

    list of schema names with no changes



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/tasks/support/schema_camelizer.rb', line 74

def unchanged_schemas
  return @unchanged_schemas unless @unchanged_schemas.nil?

  @unchanged_schemas = []
  @unchanged_schemas << name if @already_camelized
  referenced_schemas.each do |referenced_camelizer|
    @unchanged_schemas.concat referenced_camelizer.unchanged_schemas
  end
  @unchanged_schemas
end