schemacop 2.4.6 → 3.0.0.rc3

data/Rakefile

@@ -18,29 +18,25 @@ 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_development_dependency 'bundler', '~> 1.3'
+    spec.add_development_dependency 'bundler'
     spec.add_development_dependency 'rake'
-    spec.add_development_dependency 'ci_reporter', '~> 2.0'
-    spec.add_development_dependency 'ci_reporter_minitest'
-    spec.add_development_dependency 'haml'
+    spec.add_development_dependency 'minitest'
+    spec.add_development_dependency 'minitest-reporters'
     spec.add_development_dependency 'colorize'
-    spec.add_development_dependency 'yard'
-    spec.add_development_dependency 'rubocop', '0.35.1'
-    spec.add_development_dependency 'redcarpet'
+    spec.add_development_dependency 'rubocop', '0.92.0'
     spec.add_development_dependency 'pry'
+    spec.add_development_dependency 'byebug'
+    spec.add_development_dependency 'simplecov', '0.21.2'
   end
 
   File.open('schemacop.gemspec', 'w') { |f| f.write(gemspec.to_ruby.strip) }
 end
 
-# rubocop: disable Lint/HandleExceptions
 begin
   require 'rake/testtask'
-  require 'ci/reporter/rake/minitest'
   Rake::TestTask.new do |t|
-    t.pattern = 'test/*_test.rb'
+    t.pattern = 'test/unit/**/*_test.rb'
     t.verbose = false
-    t.libs << 'test'
+    t.libs << 'test/lib'
   end
-rescue LoadError
 end

data/VERSION

@@ -1 +1 @@
-2.4.6
+3.0.0.rc3

data/lib/schemacop.rb

@@ -1,42 +1,41 @@
+# External dependencies
+require 'active_support/all'
+require 'set'
+
+# Schemacop module
 module Schemacop
-  DEFAULT_CASTERS = {
-    String => {
-      Integer => proc { |s| Integer(s, 10) },
-      Float => proc { |s| Float(s) }
-    },
-    Float => {
-      Integer => proc { |f| Integer(f) }
-    },
-    Integer => {
-      Float => proc { |f| Float(f) }
-    }
-  }
-end
+  CONTEXT_THREAD_KEY = :schemacop_schema_context
 
-require 'set'
-require 'active_support/core_ext/class/attribute'
-require 'active_support/hash_with_indifferent_access'
+  mattr_accessor :load_paths
+  self.load_paths = ['app/schemas']
+
+  mattr_accessor :default_schema_version
+  self.default_schema_version = 3
 
+  def self.with_context(context)
+    prev_context = Thread.current[CONTEXT_THREAD_KEY]
+    Thread.current[CONTEXT_THREAD_KEY] = context
+    return yield
+  ensure
+    Thread.current[CONTEXT_THREAD_KEY] = prev_context
+  end
+
+  def self.context
+    Thread.current[CONTEXT_THREAD_KEY] ||= V3::Context.new
+  end
+end
+
+# Load shared
 require 'schemacop/scoped_env'
 require 'schemacop/exceptions'
+require 'schemacop/base_schema'
+require 'schemacop/schema2'
+require 'schemacop/schema3'
 require 'schemacop/schema'
-require 'schemacop/collector'
-require 'schemacop/node_resolver'
-require 'schemacop/node'
-require 'schemacop/node_with_block'
-require 'schemacop/node_supporting_type'
-require 'schemacop/field_node'
-require 'schemacop/root_node'
-require 'schemacop/node_supporting_field'
-require 'schemacop/caster'
-require 'schemacop/dupper'
-require 'schemacop/validator/array_validator'
-require 'schemacop/validator/boolean_validator'
-require 'schemacop/validator/hash_validator'
-require 'schemacop/validator/number_validator'
-require 'schemacop/validator/integer_validator'
-require 'schemacop/validator/float_validator'
-require 'schemacop/validator/symbol_validator'
-require 'schemacop/validator/string_validator'
-require 'schemacop/validator/nil_validator'
-require 'schemacop/validator/object_validator' # Matches any object, must be last validator
+
+# Load individual versions
+require 'schemacop/v2'
+require 'schemacop/v3'
+
+# Load Railtie
+require 'schemacop/railtie' if defined?(Rails)

data/lib/schemacop/base_schema.rb

@@ -0,0 +1,37 @@
+module Schemacop
+  class BaseSchema
+    attr_reader :root
+
+    # Query data validity
+    #
+    # @param data The data to validate.
+    # @return [Boolean] True if the data is valid, false otherwise.
+    def valid?(data)
+      validate(data).valid?
+    end
+
+    # Query data validity
+    #
+    # @param data The data to validate.
+    # @return [Boolean] True if data is invalid, false otherwise.
+    def invalid?(data)
+      !valid?(data)
+    end
+
+    # Validate data for the defined Schema
+    #
+    # @param data The data to validate.
+    # @raise [Schemacop::Exceptions::ValidationError] If the data is invalid,
+    #   this exception is thrown.
+    # @return The processed data
+    def validate!(data)
+      result = validate(data)
+
+      unless result.valid?
+        fail Exceptions::ValidationError, result.exception_message
+      end
+
+      return result.data
+    end
+  end
+end

data/lib/schemacop/railtie.rb

@@ -0,0 +1,10 @@
+module Schemacop
+  class Railtie < Rails::Railtie
+    initializer 'schemacop' do
+      # Load global schemas
+      unless Rails.env.development?
+        V3::GlobalContext.eager_load!
+      end
+    end
+  end
+end

data/lib/schemacop/schema.rb

@@ -1,62 +1,3 @@
 module Schemacop
-  class Schema
-    # Create a new Schema
-    #
-    # For detailed usage, please refer to README.md in the root of this project.
-    #
-    # @param args [Array] An array of arguments to apply to the root node of the
-    #   Schema.
-    # @param block A block with further Schema specification.
-    # @raise [Schemacop::Exceptions::InvalidSchemaError] If the Schema defined
-    #   is invalid.
-    def initialize(*args, &block)
-      @root = HashValidator.new do
-        req :root, *args, &block
-      end
-    end
-
-    # Query data validity
-    #
-    # @param data The data to validate.
-    # @return [Boolean] True if the data is valid, false otherwise.
-    def valid?(data)
-      validate(data).valid?
-    end
-
-    # Query data validity
-    #
-    # @param data The data to validate.
-    # @return [Boolean] True if data is invalid, false otherwise.
-    def invalid?(data)
-      !valid?(data)
-    end
-
-    # Validate data for the defined Schema
-    #
-    # @param data The data to validate.
-    # @return [Schemacop::Collector] The object that collected errors
-    #   throughout the validation.
-    def validate(data)
-      dupped_data = Schemacop::Dupper.dup_data(data)
-      collector = Collector.new(dupped_data)
-      @root.fields[:root].validate({ root: data }, collector.ignore_next_segment)
-      return collector
-    end
-
-    # Validate data for the defined Schema
-    #
-    # @param data The data to validate.
-    # @raise [Schemacop::Exceptions::ValidationError] If the data is invalid,
-    #   this exception is thrown.
-    # @return nil
-    def validate!(data)
-      collector = validate(data)
-
-      unless collector.valid?
-        fail Exceptions::ValidationError, collector.exception_message
-      end
-
-      return collector.data
-    end
-  end
+  class Schema < Schemacop::Schema2; end
 end

data/lib/schemacop/schema2.rb

@@ -0,0 +1,22 @@
+module Schemacop
+  class Schema2 < BaseSchema
+    def initialize(*args, **kwargs, &block)
+      super()
+      @root = V2::HashValidator.new do
+        req :root, *args, **kwargs, &block
+      end
+    end
+
+    # Validate data for the defined Schema
+    #
+    # @param data The data to validate.
+    # @return [Schemacop::Collector] The object that collected errors
+    #   throughout the validation.
+    def validate(data)
+      dupped_data = V2::Dupper.dup_data(data)
+      collector = V2::Collector.new(dupped_data)
+      root.fields[:root].validate({ root: data }, collector.ignore_next_segment)
+      return collector
+    end
+  end
+end

data/lib/schemacop/schema3.rb

@@ -0,0 +1,21 @@
+module Schemacop
+  class Schema3 < BaseSchema
+    def initialize(*args, **kwargs, &block)
+      super()
+      @root = V3::Node.create(*args, **kwargs, &block)
+    end
+
+    # Validate data for the defined Schema
+    #
+    # @param data The data to validate.
+    # @return [Schemacop::Collector] The object that collected errors
+    #   throughout the validation.
+    def validate(data)
+      root.validate(data)
+    end
+
+    def as_json
+      root.as_json
+    end
+  end
+end

data/lib/schemacop/scoped_env.rb

@@ -1,18 +1,30 @@
-class ScopedEnv
-  def initialize(delegation_object, methods)
-    @delegation_object = delegation_object
-    @methods = methods
-  end
+module Schemacop
+  class ScopedEnv
+    def initialize(delegation_object, methods, backup_binding = nil, prefix = nil)
+      @delegation_object = delegation_object
+      @methods = methods
+      @backup_binding = backup_binding
+      @prefix = prefix
+    end
+
+    def method_missing(symbol, *args, **kwargs, &block)
+      symbol = :"#{@prefix}#{symbol}" if @prefix
 
-  def method_missing(symbol, *args, &block)
-    if @methods.include?(symbol)
-      @delegation_object.send(symbol, *args, &block)
-    else
-      super
+      if @methods.include?(symbol)
+        if @delegation_object.respond_to?(symbol)
+          @delegation_object.send(symbol, *args, **kwargs, &block)
+        elsif @backup_binding.respond_to?(symbol)
+          @backup_binding.send(symbol, *args, **kwargs, &block)
+        else
+          super
+        end
+      else
+        super
+      end
     end
-  end
 
-  def respond_to_missing?(symbol, include_private = false)
-    @methods.include?(symbol) || super
+    def respond_to_missing?(symbol, include_private = false)
+      @methods.include?(symbol) || super
+    end
   end
 end

data/lib/schemacop/v2.rb

@@ -0,0 +1,25 @@
+module Schemacop::V2
+  module Exceptions
+    include Schemacop::Exceptions
+  end
+end
+
+require 'schemacop/v2/collector'
+require 'schemacop/v2/node_resolver'
+require 'schemacop/v2/node'
+require 'schemacop/v2/node_with_block'
+require 'schemacop/v2/node_supporting_type'
+require 'schemacop/v2/field_node'
+require 'schemacop/v2/node_supporting_field'
+require 'schemacop/v2/caster'
+require 'schemacop/v2/dupper'
+require 'schemacop/v2/validator/array_validator'
+require 'schemacop/v2/validator/boolean_validator'
+require 'schemacop/v2/validator/hash_validator'
+require 'schemacop/v2/validator/number_validator'
+require 'schemacop/v2/validator/integer_validator'
+require 'schemacop/v2/validator/float_validator'
+require 'schemacop/v2/validator/symbol_validator'
+require 'schemacop/v2/validator/string_validator'
+require 'schemacop/v2/validator/nil_validator'
+require 'schemacop/v2/validator/object_validator' # Matches any object, must be last validator

data/lib/schemacop/{caster.rb → v2/caster.rb}

@@ -1,5 +1,18 @@
-module Schemacop
+module Schemacop::V2
   class Caster
+    DEFAULT_CASTERS = {
+      String  => {
+        Integer => proc { |s| s.blank? ? nil : Integer(s, 10) },
+        Float   => proc { |s| s.blank? ? nil : Float(s) }
+      },
+      Float   => {
+        Integer => proc { |f| Integer(f) }
+      },
+      Integer => {
+        Float => proc { |f| Float(f) }
+      }
+    }.freeze
+
     def initialize(casts, data, target_type)
       @casts = casts
       @data = data
@@ -29,8 +42,9 @@ module Schemacop
 
     def cast
       fail 'Not castable.' unless castable?
+
       return @caster.call(@data)
-    rescue => e
+    rescue StandardError => e
       fail Exceptions::InvalidSchemaError,
            "Could not cast value #{@value.inspect} to #{@target_type}: #{e.message}."
     end

data/lib/schemacop/{collector.rb → v2/collector.rb}

@@ -1,4 +1,4 @@
-module Schemacop
+module Schemacop::V2
   class Collector
     attr_reader :exceptions
 
@@ -12,6 +12,7 @@ module Schemacop
 
     def data
       return nil unless valid?
+
       @current_datappoint_path.first
     end
 
@@ -57,14 +58,16 @@ module Schemacop
     end
 
     def exception_message
+      # rubocop:disable Style/StringConcatenation
       return "Schemacop validation failed:\n" + @exceptions.map do |e|
         "- #{e[:path].join('')}: #{e[:message]}"
       end.join("\n")
+      # rubocop:enable Style/StringConcatenation
     end
 
     def error(error_msg)
       @exceptions << {
-        path: @current_path.dup,
+        path:    @current_path.dup,
         message: error_msg
       }
     end

data/lib/schemacop/{dupper.rb → v2/dupper.rb}

@@ -1,4 +1,4 @@
-module Schemacop
+module Schemacop::V2
   class Dupper
     def self.dup_data(data)
       if data.is_a?(Hash)

data/lib/schemacop/{field_node.rb → v2/field_node.rb}

@@ -1,4 +1,4 @@
-module Schemacop
+module Schemacop::V2
   class FieldNode < NodeSupportingType
     attr_reader :name
 
@@ -14,8 +14,8 @@ module Schemacop
     end
 
     def validate(data, collector)
-      unless data.key?(name)
-        collector.error "Missing key #{name.inspect}." if @required
+      if !data.key?(name) && @required
+        collector.error "Missing key #{name.inspect}."
       end
 
       collector.path "/#{name}", name, :hash do
@@ -36,6 +36,7 @@ module Schemacop
 
       @types.each do |type|
         next unless type.option?(:default)
+
         default = type.option(:default)
         default = default.call if default.is_a?(Proc)
         collector.override_value(default)

data/lib/schemacop/v2/node.rb

@@ -0,0 +1,142 @@
+module Schemacop
+  module V2
+    class Node
+      attr_reader :options
+
+      class_attribute :allowed_options
+      self.allowed_options = {}.freeze
+
+      class_attribute :symbols
+      self.symbols = [].freeze
+
+      class_attribute :klasses
+      self.klasses = [].freeze
+
+      def self.option(key, default: nil)
+        self.allowed_options = allowed_options.merge(key => default)
+      end
+
+      option :if
+      option :check
+      option :cast
+      option :default
+
+      def type_label
+        str = (symbols.first || 'unknown').to_s
+        str += '*' if option?(:if)
+        return str
+      end
+
+      def self.symbol(symbol)
+        self.symbols += [symbol]
+      end
+
+      def self.clear_symbols
+        self.symbols = [].freeze
+      end
+
+      def self.klass(klass)
+        self.klasses += [klass]
+      end
+
+      def self.clear_klasses
+        self.klasses = [].freeze
+      end
+
+      def self.register(symbols: [], klasses: [], clear: true, before: nil)
+        NodeResolver.register(self, before: before)
+        symbols = [*symbols]
+        klasses = [*klasses]
+        if clear
+          clear_symbols
+          clear_klasses
+        end
+        symbols.each { |s| symbol s }
+        klasses.each { |k| klass k }
+      end
+
+      def self.type_matches?(type)
+        symbol_matches?(type) || class_matches?(type)
+      end
+
+      def self.symbol_matches?(type)
+        return false unless type.is_a?(Symbol)
+
+        symbols.include?(type)
+      end
+
+      def self.class_matches?(type)
+        return false unless type.is_a?(Class)
+
+        klasses.each do |klass|
+          return true if type <= klass
+        end
+        return false
+      end
+
+      def self.build(options, &block)
+        new(options, &block)
+      end
+
+      def initialize(options = {})
+        # Check and save given options
+        @options = self.class.allowed_options.merge(options)
+        if (obsolete_opts = @options.keys - self.class.allowed_options.keys).any?
+          fail Exceptions::InvalidSchemaError,
+               "Unrecognized option(s) #{obsolete_opts.inspect} for #{self.class.inspect}, allowed options: #{self.class.allowed_options.keys.inspect}."
+        end
+
+        if option?(:cast) && self.class.klasses.size > 1
+          fail Exceptions::InvalidSchemaError,
+               "Casting is only allowed for single-value datatypes, but type #{self.class.inspect} has classes "\
+               "#{self.class.klasses.map(&:inspect)}."
+        end
+      end
+
+      def option(key)
+        options[key]
+      end
+
+      def option?(key)
+        !!options[key]
+      end
+
+      def exec_block
+        fail Exceptions::InvalidSchemaError, 'Node does not support block.' if block_given?
+      end
+
+      def resolve_type_klass(type)
+        klass = NodeResolver.resolve(type)
+        unless klass
+          fail Exceptions::InvalidSchemaError, "No validation class found for type #{type.inspect}."
+        end
+
+        return klass
+      end
+
+      def validate(data, collector)
+        validate_custom_check(data, collector)
+      end
+
+      def type_matches?(data)
+        self.class.type_matches?(data.class) && type_filter_matches?(data)
+      end
+
+      def type_filter_matches?(data)
+        !option?(:if) || option(:if).call(data)
+      end
+
+      protected
+
+      def validate_custom_check(data, collector)
+        if option?(:check) && (check_result = option(:check).call(data)) != true
+          if check_result.is_a?(String)
+            collector.error "Custom :check failed: #{check_result}."
+          else
+            collector.error 'Custom :check failed.'
+          end
+        end
+      end
+    end
+  end
+end