schemacop 3.0.0.rc0 → 3.0.0.rc5

data/Rakefile

@@ -18,6 +18,7 @@ task :gemspec do
     # needs access to ActiveSupport::HashWithIndifferentAccess and expects
     # behavior of that as in version 5 of ActiveSupport.
     spec.add_dependency 'activesupport', '>= 4.0'
+    spec.add_dependency 'ruby2_keywords', '0.0.4'
     spec.add_development_dependency 'bundler'
     spec.add_development_dependency 'rake'
     spec.add_development_dependency 'minitest'

data/VERSION

@@ -1 +1 @@
-3.0.0.rc0
+3.0.0.rc5

data/lib/schemacop.rb

@@ -1,4 +1,5 @@
 # External dependencies
+require 'ruby2_keywords'
 require 'active_support/all'
 require 'set'
 

data/lib/schemacop/schema2.rb

@@ -1,9 +1,9 @@
 module Schemacop
   class Schema2 < BaseSchema
-    def initialize(*args, &block)
+    def initialize(*args, **kwargs, &block)
       super()
       @root = V2::HashValidator.new do
-        req :root, *args, &block
+        req :root, *args, **kwargs, &block
       end
     end
 

data/lib/schemacop/scoped_env.rb

@@ -7,7 +7,7 @@ module Schemacop
       @prefix = prefix
     end
 
-    def method_missing(symbol, *args, &block)
+    ruby2_keywords def method_missing(symbol, *args, &block)
       symbol = :"#{@prefix}#{symbol}" if @prefix
 
       if @methods.include?(symbol)

data/lib/schemacop/v2.rb

@@ -10,7 +10,6 @@ require 'schemacop/v2/node'
 require 'schemacop/v2/node_with_block'
 require 'schemacop/v2/node_supporting_type'
 require 'schemacop/v2/field_node'
-require 'schemacop/v2/root_node'
 require 'schemacop/v2/node_supporting_field'
 require 'schemacop/v2/caster'
 require 'schemacop/v2/dupper'

data/lib/schemacop/v2/caster.rb

@@ -18,6 +18,7 @@ module Schemacop::V2
       @data = data
       @target_type = target_type
       @caster = nil
+      @value = nil
 
       if casts.is_a?(Array)
         from_types = casts

data/lib/schemacop/v2/node_supporting_field.rb

@@ -15,36 +15,50 @@ module Schemacop::V2
       exec_block(&block)
     end
 
-    def req?(*args, &block)
-      field(*args, required: true, allow_nil: true, &block)
+    def req?(*args, **kwargs, &block)
+      kwargs ||= {}
+      kwargs[:required] = true
+      kwargs[:allow_nil] = true
+      field(*args, **kwargs, &block)
     end
 
-    def req!(*args, &block)
-      field(*args, required: true, allow_nil: false, &block)
+    def req!(*args, **kwargs, &block)
+      kwargs ||= {}
+      kwargs[:required] = true
+      kwargs[:allow_nil] = false
+      field(*args, **kwargs, &block)
     end
 
     alias req req!
 
-    def opt?(*args, &block)
-      field(*args, required: false, allow_nil: true, &block)
+    def opt?(*args, **kwargs, &block)
+      kwargs ||= {}
+      kwargs[:required] = false
+      kwargs[:allow_nil] = true
+      field(*args, **kwargs, &block)
     end
 
-    def opt!(*args, &block)
-      field(*args, required: false, allow_nil: false, &block)
+    def opt!(*args, **kwargs, &block)
+      kwargs ||= {}
+      kwargs[:required] = false
+      kwargs[:allow_nil] = false
+      field(*args, **kwargs, &block)
     end
 
     alias opt opt?
 
     protected
 
-    def field(*args, required:, allow_nil:, &block)
+    def field(*args, **kwargs, &block)
       name = args.shift
+      required = kwargs.delete(:required)
+      allow_nil = kwargs.delete(:allow_nil)
 
       if @fields[name]
-        @fields[name].type(*args, &block)
+        @fields[name].type(*args, **kwargs, &block)
       elsif args.any?
         @fields[name] = FieldNode.new(name, required) do
-          type(*args, &block)
+          type(*args, **kwargs, &block)
         end
       else
         @fields[name] = FieldNode.new(name, required, &block)

data/lib/schemacop/v2/node_supporting_type.rb

@@ -33,7 +33,7 @@ module Schemacop::V2
       super
     rescue NoMethodError
       @types = []
-      type :hash, {}, &block
+      type :hash, &block
     end
 
     # required signature:
@@ -73,7 +73,7 @@ module Schemacop::V2
           end
 
           child = klass.new do
-            self.type(*subtypes, options, &block)
+            self.type(*subtypes, **options, &block)
           end
 
           # child = klass.build(options)

data/lib/schemacop/v3/array_node.rb

@@ -172,10 +172,9 @@ module Schemacop
         list_item.present?
       end
 
-      def item_for_data(data, force: true)
+      def item_for_data(data)
         item = children.find { |c| item_matches?(c, data) }
         return item if item
-        return nil unless force
 
         fail "Could not find specification for item #{data.inspect}."
       end

data/lib/schemacop/v3/hash_node.rb

@@ -11,6 +11,8 @@ module Schemacop
 
       supports_children(name: true)
 
+      attr_reader :properties
+
       def self.allowed_options
         super + ATTRIBUTES - %i[dependencies] + %i[additional_properties]
       end
@@ -19,6 +21,14 @@ module Schemacop
         super + NodeRegistry.dsl_methods(true) + %i[dsl_dep dsl_add]
       end
 
+      def self.sanitize_exp(exp)
+        exp = exp.to_s
+        if exp.start_with?('(?-mix:')
+          exp = exp.to_s.gsub(/^\(\?-mix:/, '').gsub(/\)$/, '')
+        end
+        return exp
+      end
+
       def add_child(node)
         unless node.name
           fail Exceptions::InvalidSchemaError, 'Child nodes must have a name.'
@@ -35,7 +45,7 @@ module Schemacop
         @options[:additional_properties] = create(type, **options, &block)
       end
 
-      def dsl_dep(source, *targets)
+      def dsl_dep(source, *targets, **_kwargs)
         @options[:dependencies] ||= {}
         @options[:dependencies][source] = targets
       end
@@ -54,11 +64,11 @@ module Schemacop
 
         json = {}
         json[:properties] = Hash[properties.values.map { |p| [p.name, p.as_json] }] if properties.any?
-        json[:patternProperties] = Hash[pattern_properties.values.map { |p| [sanitize_exp(p.name), p.as_json] }] if pattern_properties.any?
+        json[:patternProperties] = Hash[pattern_properties.values.map { |p| [self.class.sanitize_exp(p.name), p.as_json] }] if pattern_properties.any?
 
         # In schemacop, by default, additional properties are not allowed,
         # the users explicitly need to enable additional properties
-        if options[:additional_properties] == true
+        if options[:additional_properties].is_a?(TrueClass)
           json[:additionalProperties] = true
         elsif options[:additional_properties].is_a?(Node)
           json[:additionalProperties] = options[:additional_properties].as_json
@@ -75,14 +85,6 @@ module Schemacop
         return process_json(ATTRIBUTES, json)
       end
 
-      def sanitize_exp(exp)
-        exp = exp.to_s
-        if exp.start_with?('(?-mix:')
-          exp = exp.to_s.gsub(/^\(\?-mix:/, '').gsub(/\)$/, '')
-        end
-        return exp
-      end
-
       def allowed_types
         { Hash => :object }
       end
@@ -91,14 +93,23 @@ module Schemacop
         super_data = super
         return if super_data.nil?
 
+        original_data_hash = super_data.dup
+        data_hash = super_data.with_indifferent_access
+
+        if original_data_hash.size != data_hash.size
+          ambiguous_properties = original_data_hash.keys - data_hash.keys
+
+          result.error "Has #{ambiguous_properties.size} ambiguous properties: #{ambiguous_properties}."
+        end
+
         # Validate min_properties #
-        if options[:min_properties] && super_data.size < options[:min_properties]
-          result.error "Has #{super_data.size} properties but needs at least #{options[:min_properties]}."
+        if options[:min_properties] && data_hash.size < options[:min_properties]
+          result.error "Has #{data_hash.size} properties but needs at least #{options[:min_properties]}."
         end
 
         # Validate max_properties #
-        if options[:max_properties] && super_data.size > options[:max_properties]
-          result.error "Has #{super_data.size} properties but needs at most #{options[:max_properties]}."
+        if options[:max_properties] && data_hash.size > options[:max_properties]
+          result.error "Has #{data_hash.size} properties but needs at most #{options[:max_properties]}."
         end
 
         # Validate specified properties #
@@ -106,13 +117,13 @@ module Schemacop
           result.in_path(node.name) do
             next if node.name.is_a?(Regexp)
 
-            node._validate(super_data[node.name], result: result)
+            node._validate(data_hash[node.name], result: result)
           end
         end
 
         # Validate additional properties #
         specified_properties = @properties.keys.to_set
-        additional_properties = super_data.reject { |k, _v| specified_properties.include?(k.to_s.to_sym) }
+        additional_properties = data_hash.reject { |k, _v| specified_properties.include?(k.to_s) }
 
         property_patterns = {}
 
@@ -130,7 +141,9 @@ module Schemacop
             result.error "Property name #{name.inspect} does not match #{options[:property_names].inspect}."
           end
 
-          if options[:additional_properties].blank?
+          if options[:additional_properties].is_a?(TrueClass)
+            next
+          elsif options[:additional_properties].is_a?(FalseClass) || options[:additional_properties].blank?
             match = property_patterns.keys.find { |p| p.match?(name.to_s) }
             if match
               result.in_path(name) do
@@ -149,7 +162,7 @@ module Schemacop
         # Validate dependencies #
         options[:dependencies]&.each do |source, targets|
           targets.each do |target|
-            if super_data[source].present? && super_data[target].blank?
+            if data_hash[source].present? && data_hash[target].blank?
               result.error "Missing property #{target.to_s.inspect} because #{source.to_s.inspect} is given."
             end
           end
@@ -161,25 +174,54 @@ module Schemacop
       end
 
       def cast(data)
-        result = {}
+        result = {}.with_indifferent_access
         data ||= default
         return nil if data.nil?
 
-        # TODO: How to handle regex / etc.?
+        data_hash = data.dup.with_indifferent_access
+
+        property_patterns = {}
+        as_names = []
+
         @properties.each_value do |prop|
-          result[prop.name] = prop.cast(data[prop.name])
+          if prop.name.is_a?(Regexp)
+            property_patterns[prop.name] = prop
+            next
+          end
+
+          as_names << prop.as&.to_s if prop.as.present?
+
+          prop_name = prop.as&.to_s || prop.name
+
+          casted_data = prop.cast(data_hash[prop.name])
+
+          if casted_data.present? || data_hash.include?(prop.name)
+            result[prop_name] = casted_data
+          end
 
-          if result[prop.name].nil? && !data.include?(prop.name)
-            result.delete(prop.name)
+          if result[prop_name].nil? && !data_hash.include?(prop.name) && !as_names.include?(prop.name)
+            result.delete(prop_name)
+          end
+        end
+
+        # Handle regex properties
+        specified_properties = @properties.keys.to_set
+        additional_properties = data_hash.reject { |k, _v| specified_properties.include?(k.to_s.to_sym) }
+
+        if additional_properties.any? && property_patterns.any?
+          additional_properties.each do |name, additional_property|
+            match_key = property_patterns.keys.find { |p| p.match?(name.to_s) }
+            match = property_patterns[match_key]
+            result[name] = match.cast(additional_property)
           end
         end
 
         # Handle additional properties
-        if options[:additional_properties] == true
-          result = data.merge(result)
+        if options[:additional_properties].is_a?(TrueClass)
+          result = data_hash.merge(result)
         elsif options[:additional_properties].is_a?(Node)
           specified_properties = @properties.keys.to_set
-          additional_properties = data.reject { |k, _v| specified_properties.include?(k.to_s.to_sym) }
+          additional_properties = data_hash.reject { |k, _v| specified_properties.include?(k.to_s.to_sym) }
           if additional_properties.any?
             additional_properties_result = {}
             additional_properties.each do |key, value|
@@ -197,6 +239,14 @@ module Schemacop
       def init
         @properties = {}
         @options[:type] = :object
+        unless @options[:additional_properties].nil? || @options[:additional_properties].is_a?(TrueClass) || @options[:additional_properties].is_a?(FalseClass)
+          fail Schemacop::Exceptions::InvalidSchemaError, 'Option "additional_properties" must be a boolean value'
+        end
+
+        # Default the additional_properties option to false if it's not given
+        if @options[:additional_properties].nil?
+          @options[:additional_properties] = false
+        end
       end
 
       def validate_self

data/lib/schemacop/v3/node.rb

@@ -2,6 +2,7 @@ module Schemacop
   module V3
     class Node
       attr_reader :name
+      attr_reader :as
       attr_reader :default
       attr_reader :title
       attr_reader :description
@@ -32,8 +33,10 @@ module Schemacop
         if options.delete(:cast_str)
           format = NodeRegistry.name(klass)
           one_of_options = {
-            required: options.delete(:required),
-            name:     options.delete(:name)
+            required:    options.delete(:required),
+            name:        options.delete(:name),
+            as:          options.delete(:as),
+            description: options.delete(:description)
           }
           node = create(:one_of, **one_of_options) do
             self.node node
@@ -45,7 +48,7 @@ module Schemacop
       end
 
       def self.allowed_options
-        %i[name required default description examples enum parent options cast_str title]
+        %i[name required default description examples enum parent options cast_str title as]
       end
 
       def self.dsl_methods
@@ -69,11 +72,13 @@ module Schemacop
         disallowed_options = options.keys - self.class.allowed_options
 
         if disallowed_options.any?
-          fail "Options #{disallowed_options.inspect} are not allowed for this node."
+          fail Schemacop::Exceptions::InvalidSchemaError, "Options #{disallowed_options.inspect} are not allowed for this node."
         end
 
         # Assign attributes #
         @name = options.delete(:name)
+        @name = @name.to_s unless @name.nil? || @name.is_a?(Regexp)
+        @as = options.delete(:as)
         @required = !!options.delete(:required)
         @default = options.delete(:default)
         @title = options.delete(:title)
@@ -90,7 +95,7 @@ module Schemacop
         # Run DSL block #
         if block_given?
           unless self.class.supports_children_options
-            fail "Node #{self.class} does not support blocks."
+            fail Schemacop::Exceptions::InvalidSchemaError, "Node #{self.class} does not support blocks."
           end
 
           scope = DslScope.new(self)
@@ -117,7 +122,7 @@ module Schemacop
         @schemas[name] = create(type, **options, &block)
       end
 
-      def dsl_node(node)
+      def dsl_node(node, *_args, **_kwargs)
         add_child node
       end
 

data/lib/schemacop/v3/node_registry.rb

@@ -40,10 +40,6 @@ module Schemacop
       def self.name(klass)
         @by_class[klass][:name]
       end
-
-      def self.short_name(klass)
-        @by_class[klass][:short_name]
-      end
     end
   end
 end

data/lib/schemacop/v3/reference_node.rb

@@ -36,7 +36,13 @@ module Schemacop
       end
 
       def used_external_schemas
-        schemas.include?(@path) ? [] : [@path]
+        target_children_schema = target.used_external_schemas
+
+        if schemas.include?(@path)
+          return target_children_schema
+        else
+          return [@path] + target_children_schema
+        end
       end
 
       protected

data/lib/schemacop/v3/string_node.rb

@@ -66,21 +66,29 @@ module Schemacop
       end
 
       def cast(value)
+        if value.present?
+          to_cast = value
+        elsif default.present?
+          to_cast = default
+        else
+          return nil
+        end
+
         case options[:format]
         when :boolean
-          return value == 'true'
+          return to_cast == 'true'
         when :date
-          return Date.parse(value)
+          return Date.parse(to_cast)
         when :'date-time'
-          return DateTime.parse(value)
+          return DateTime.parse(to_cast)
         when :time
-          Time.parse(value)
+          Time.parse(to_cast)
         when :integer
-          return Integer(value)
+          return Integer(to_cast)
         when :number
-          return Float(value)
+          return Float(to_cast)
         else
-          return value || default
+          return to_cast
         end
       end