shale 0.3.0 → 0.5.0

data/lib/shale/schema/{json.rb → json_generator.rb}

@@ -1,32 +1,33 @@
 # frozen_string_literal: true
 
 require_relative '../../shale'
-require_relative 'json/schema'
-require_relative 'json/boolean'
-require_relative 'json/collection'
-require_relative 'json/date'
-require_relative 'json/float'
-require_relative 'json/integer'
-require_relative 'json/object'
-require_relative 'json/ref'
-require_relative 'json/string'
-require_relative 'json/time'
+require_relative 'json_generator/schema'
+require_relative 'json_generator/boolean'
+require_relative 'json_generator/collection'
+require_relative 'json_generator/date'
+require_relative 'json_generator/float'
+require_relative 'json_generator/integer'
+require_relative 'json_generator/object'
+require_relative 'json_generator/ref'
+require_relative 'json_generator/string'
+require_relative 'json_generator/time'
+require_relative 'json_generator/value'
 
 module Shale
   module Schema
-    # Class for handling JSON schema
+    # Class for generating JSON schema
     #
     # @api public
-    class JSON
-      @json_types = Hash.new(Shale::Schema::JSON::String)
+    class JSONGenerator
+      @json_types = Hash.new(Shale::Schema::JSONGenerator::String)
 
       # Register Shale to JSON type mapping
       #
       # @param [Shale::Type::Value] shale_type
-      # @param [Shale::Schema::JSON::Base] json_type
+      # @param [Shale::Schema::JSONGenerator::Base] json_type
       #
       # @example
-      #   Shale::Schema::JSON.register_json_type(Shale::Type::String, MyCustomJsonType)
+      #   Shale::Schema::JSONGenerator.register_json_type(Shale::Type::String, MyCustomJsonType)
       #
       # @api public
       def self.register_json_type(shale_type, json_type)
@@ -37,10 +38,10 @@ module Shale
       #
       # @param [Shale::Type::Value] shale_type
       #
-      # @return [Shale::Schema::JSON::Base]
+      # @return [Shale::Schema::JSONGenerator::Base]
       #
       # @example
-      #   Shale::Schema::JSON.get_json_type(Shale::Type::String)
+      #   Shale::Schema::JSONGenerator.get_json_type(Shale::Type::String)
       #   # => Shale::Schema::JSON::String
       #
       # @api private
@@ -48,11 +49,12 @@ module Shale
         @json_types[shale_type]
       end
 
-      register_json_type(Shale::Type::Boolean, Shale::Schema::JSON::Boolean)
-      register_json_type(Shale::Type::Date, Shale::Schema::JSON::Date)
-      register_json_type(Shale::Type::Float, Shale::Schema::JSON::Float)
-      register_json_type(Shale::Type::Integer, Shale::Schema::JSON::Integer)
-      register_json_type(Shale::Type::Time, Shale::Schema::JSON::Time)
+      register_json_type(Shale::Type::Boolean, Shale::Schema::JSONGenerator::Boolean)
+      register_json_type(Shale::Type::Date, Shale::Schema::JSONGenerator::Date)
+      register_json_type(Shale::Type::Float, Shale::Schema::JSONGenerator::Float)
+      register_json_type(Shale::Type::Integer, Shale::Schema::JSONGenerator::Integer)
+      register_json_type(Shale::Type::Time, Shale::Schema::JSONGenerator::Time)
+      register_json_type(Shale::Type::Value, Shale::Schema::JSONGenerator::Value)
 
       # Generate JSON Schema from Shale model and return it as a Ruby Hash
       #
@@ -65,15 +67,16 @@ module Shale
       # @return [Hash]
       #
       # @example
-      #   Shale::Schema::JSON.new.as_schema(Person)
+      #   Shale::Schema::JSONGenerator.new.as_schema(Person)
       #
       # @api public
-      def as_schema(klass, id: nil, description: nil)
+      def as_schema(klass, id: nil, title: nil, description: nil)
         unless mapper_type?(klass)
           raise NotAShaleMapperError, "JSON Shema can't be generated for '#{klass}' type"
         end
 
-        types = collect_composite_types(klass)
+        types = []
+        collect_complex_types(types, klass)
         objects = []
 
         types.each do |type|
@@ -103,7 +106,7 @@ module Shale
           objects << Object.new(type.name, properties)
         end
 
-        Schema.new(objects, id: id, description: description).as_json
+        Schema.new(objects, id: id, title: title, description: description).as_json
       end
 
       # Generate JSON Schema from Shale model
@@ -116,11 +119,11 @@ module Shale
       # @return [String]
       #
       # @example
-      #   Shale::Schema::JSON.new.to_schema(Person)
+      #   Shale::Schema::JSONGenerator.new.to_schema(Person)
       #
       # @api public
-      def to_schema(klass, id: nil, description: nil, pretty: false)
-        schema = as_schema(klass, id: id, description: description)
+      def to_schema(klass, id: nil, title: nil, description: nil, pretty: false)
+        schema = as_schema(klass, id: id, title: title, description: description)
         options = pretty ? :pretty : nil
 
         Shale.json_adapter.dump(schema, options)
@@ -141,24 +144,21 @@ module Shale
 
       # Collect recursively Shale::Mapper types
       #
+      # @param [Array<Shale::Mapper>] types
       # @param [Shale::Mapper] type
       #
-      # @return [Array<Shale::Mapper>]
-      #
       # @api private
-      def collect_composite_types(type)
-        types = [type]
+      def collect_complex_types(types, type)
+        types << type
 
         type.json_mapping.keys.values.each do |mapping|
           attribute = type.attributes[mapping.attribute]
           next unless attribute
 
           if mapper_type?(attribute.type) && !types.include?(attribute.type)
-            types += collect_composite_types(attribute.type)
+            collect_complex_types(types, attribute.type)
           end
         end
-
-        types.uniq
       end
     end
   end