attributor 5.0.2 → 5.1.0

data/lib/attributor/attribute_resolver.rb

@@ -1,11 +1,9 @@
 require 'ostruct'
 
 module Attributor
-
-
   class AttributeResolver
     ROOT_PREFIX = '$'.freeze
-    COLLECTION_INDEX_KEY = /^at\((\d+)\)$/.freeze
+    COLLECTION_INDEX_KEY = /^at\((\d+)\)$/
 
     class Data < ::Hash
       include Hashie::Extensions::MethodReader
@@ -17,8 +15,7 @@ module Attributor
       @data = Data.new
     end
 
-
-    def query!(key_path, path_prefix=ROOT_PREFIX)
+    def query!(key_path, path_prefix = ROOT_PREFIX)
       # If the incoming key_path is not an absolute path, append the given prefix
       # NOTE: Need to index key_path by range here because Ruby 1.8 returns a
       # FixNum for the ASCII code, not the actual character, when indexing by a number.
@@ -49,7 +46,6 @@ module Attributor
       result
     end
 
-
     # Query for a certain key in the attribute hierarchy
     #
     # @param [String] key_path The name of the key to query and its path
@@ -57,21 +53,20 @@ module Attributor
     #
     # @return [String] The value of the specified attribute/key
     #
-    def query(key_path,path_prefix=ROOT_PREFIX)
-      query!(key_path,path_prefix)
-    rescue NoMethodError => e
+    def query(key_path, path_prefix = ROOT_PREFIX)
+      query!(key_path, path_prefix)
+    rescue NoMethodError
       nil
     end
 
     def register(key_path, value)
       if key_path.split(SEPARATOR).size > 1
-        raise AttributorException.new("can only register top-level attributes. got: #{key_path}")
+        raise AttributorException, "can only register top-level attributes. got: #{key_path}"
       end
 
       @data[key_path] = value
     end
 
-
     # Checks that the the condition is met. This means the attribute identified
     # by path_prefix and key_path satisfies the optional predicate, which when
     # nil simply checks for existence.
@@ -84,13 +79,11 @@ module Attributor
     #
     # @raise [AttributorException] When an unsupported predicate is passed
     #
-    def check(path_prefix, key_path, predicate=nil)
-      value = self.query(key_path, path_prefix)
+    def check(path_prefix, key_path, predicate = nil)
+      value = query(key_path, path_prefix)
 
       # we have a value, any value, which is good enough given no predicate
-      if !value.nil? && predicate.nil?
-        return true
-      end
+      return true if !value.nil? && predicate.nil?
 
       case predicate
       when ::String, ::Regexp, ::Integer, ::Float, ::DateTime, true, false
@@ -101,9 +94,8 @@ module Attributor
       when nil
         return !value.nil?
       else
-        raise AttributorException.new("predicate not supported: #{predicate.inspect}")
+        raise AttributorException, "predicate not supported: #{predicate.inspect}"
       end
-
     end
 
     # TODO: kill this when we also kill Taylor's IdentityMap.current
@@ -111,15 +103,9 @@ module Attributor
       Thread.current[:_attributor_attribute_resolver] = resolver
     end
 
-
     def self.current
-      if resolver = Thread.current[:_attributor_attribute_resolver]
-        return resolver
-      else
-        raise AttributorException, "No AttributeResolver set."
-      end
+      raise AttributorException, 'No AttributeResolver set.' unless Thread.current[:_attributor_attribute_resolver]
+      Thread.current[:_attributor_attribute_resolver]
     end
-
   end
-
 end

data/lib/attributor/dsl_compiler.rb

@@ -1,6 +1,5 @@
-#Container of options and structure definition
+# Container of options and structure definition
 module Attributor
-
   # RULES FOR ATTRIBUTES
   #   The type of an attribute is:
   #     the specified type
@@ -11,7 +10,6 @@ module Attributor
   #   The reference option for an attribute is passed if a block is given
 
   class DSLCompiler
-
     attr_accessor :options, :target
 
     def initialize(target, **options)
@@ -21,7 +19,7 @@ module Attributor
 
     def parse(*blocks)
       blocks.push(Proc.new) if block_given?
-      blocks.each { |block| self.instance_eval(&block) }
+      blocks.each { |block| instance_eval(&block) }
       self
     end
 
@@ -33,19 +31,19 @@ module Attributor
       end
     end
 
-    def attribute(name, attr_type=nil, **opts, &block)
-      raise AttributorException, "Attribute names must be symbols, got: #{name.inspect}" unless name.kind_of? ::Symbol
+    def attribute(name, attr_type = nil, **opts, &block)
+      raise AttributorException, "Attribute names must be symbols, got: #{name.inspect}" unless name.is_a? ::Symbol
       target.attributes[name] = define(name, attr_type, **opts, &block)
     end
 
-    def key(name, attr_type=nil, **opts, &block)
-      unless name.kind_of?(options.fetch(:key_type, Attributor::Object).native_type)
+    def key(name, attr_type = nil, **opts, &block)
+      unless name.is_a?(options.fetch(:key_type, Attributor::Object).native_type)
         raise "Invalid key: #{name.inspect}, must be instance of #{options[:key_type].native_type.name}"
       end
       target.keys[name] = define(name, attr_type, **opts, &block)
     end
 
-    def extra(name, attr_type=nil, **opts, &block)
+    def extra(name, attr_type = nil, **opts, &block)
       if attr_type.nil?
         attr_type = Attributor::Hash.of(key: target.key_type, value: target.value_type)
       end
@@ -65,7 +63,7 @@ module Attributor
     #   @param [Hash] opts describe opts param
     #   @param [Block] block describe block param
     #   @example
-    #     attribute :email, String, example: /[:email:]/
+    #     attribute :email, String, example: Randgen.email
     # @overload define(name, opts, &block)
     #   Assume a type of Attributor::Struct
     #   @param [symbol] name describe name param
@@ -79,7 +77,7 @@ module Attributor
     #       attribute :state, String
     #     end
     # @api semiprivate
-    def define(name, attr_type=nil, **opts, &block)
+    def define(name, attr_type = nil, **opts, &block)
       # add to existing attribute if present
       if (existing_attribute = attributes[name])
         if existing_attribute.attributes
@@ -89,8 +87,8 @@ module Attributor
       end
 
       # determine inherited attribute
-      inherited_attribute = nil      
-      if (reference = self.options[:reference])
+      inherited_attribute = nil
+      if (reference = options[:reference])
         if (inherited_attribute = reference.attributes[name])
           opts = inherited_attribute.options.merge(opts) unless attr_type
           opts[:reference] = inherited_attribute.type if block_given?
@@ -101,12 +99,12 @@ module Attributor
       if attr_type.nil?
         if block_given?
           attr_type = if inherited_attribute && inherited_attribute.type < Attributor::Collection
-            # override the reference to be the member_attribute's type for collections
-            opts[:reference] = inherited_attribute.type.member_attribute.type
-            Attributor::Collection.of(Struct)
-          else
-            Attributor::Struct
-          end
+                        # override the reference to be the member_attribute's type for collections
+                        opts[:reference] = inherited_attribute.type.member_attribute.type
+                        Attributor::Collection.of(Struct)
+                      else
+                        Attributor::Struct
+                      end
         elsif inherited_attribute
           attr_type = inherited_attribute.type
         else
@@ -116,7 +114,5 @@ module Attributor
 
       Attributor::Attribute.new(attr_type, opts, &block)
     end
-
-
   end
 end

data/lib/attributor/dumpable.rb

@@ -6,6 +6,5 @@ module Attributor
     def dump
       raise NotImplementedError, 'Dumpable requires the implementation of #dump'
     end
-
   end
-end
+end

data/lib/attributor/example_mixin.rb

@@ -2,11 +2,9 @@
 # primarily enables support for lazy values.
 
 module Attributor
-
   module ExampleMixin
-
     def self.extended(obj)
-      if obj.kind_of? Attributor::Model
+      if obj.is_a? Attributor::Model
         obj.class.attributes.each do |name, _|
           obj.define_singleton_method(name) do
             get(name)
@@ -32,7 +30,7 @@ module Attributor
       @contents[k]
     end
 
-    def []=(k,v)
+    def []=(k, v)
       lazy_attributes.delete k
       @contents[k] = v
     end
@@ -41,7 +39,7 @@ module Attributor
       contents.each(&block)
     end
 
-    alias_method :each_pair, :each
+    alias each_pair each
 
     def values
       contents.values
@@ -63,7 +61,7 @@ module Attributor
       @contents.key?(key) || lazy_attributes.key?(key)
     end
 
-    def get(key, context: self.generate_subcontext(Attributor::DEFAULT_ROOT_CONTEXT,key))
+    def get(key, context: generate_subcontext(Attributor::DEFAULT_ROOT_CONTEXT, key))
       key = self.class.key_attribute.load(key, context)
 
       unless @contents.key? key
@@ -78,7 +76,7 @@ module Attributor
 
     def attributes
       lazy_attributes.keys.each do |name|
-        self.__send__(name)
+        __send__(name)
       end
 
       super
@@ -93,5 +91,4 @@ module Attributor
       super
     end
   end
-
 end

data/lib/attributor/exceptions.rb

@@ -6,14 +6,13 @@ module Attributor
   end
 
   class IncompatibleTypeError < LoadError
-
-    def initialize(type:, value_type: , context: )
+    def initialize(type:, value_type:, context:)
       super "Type #{type} cannot load values of type #{value_type} while loading #{Attributor.humanize_context(context)}."
     end
   end
 
   class CoercionError < LoadError
-    def initialize( context: , from: , to:, value: nil)
+    def initialize(context:, from:, to:, value: nil)
       msg = "Error coercing from #{from} to #{to} while loading #{Attributor.humanize_context(context)}."
       msg += " Received value #{Attributor.errorize_value(value)}" if value
       super msg
@@ -21,7 +20,7 @@ module Attributor
   end
 
   class DeserializationError < LoadError
-    def initialize( context: , from:, encoding: , value: nil)
+    def initialize(context:, from:, encoding:, value: nil)
       msg = "Error deserializing a #{from} using #{encoding} while loading #{Attributor.humanize_context(context)}."
       msg += " Received value #{Attributor.errorize_value(value)}" if value
       super msg
@@ -29,10 +28,10 @@ module Attributor
   end
 
   class DumpError < AttributorException
-    def initialize( context: , name: , type: , original_exception: )
+    def initialize(context:, name:, type:, original_exception:)
       msg = "Error while dumping attribute #{name} of type #{type} for context #{Attributor.humanize_context(context)}."
       msg << " Reason: #{original_exception}"
       super msg
     end
   end
-end
+end

data/lib/attributor/extensions/randexp.rb

@@ -1,15 +1,13 @@
 require 'date'
 
-
 class Randgen
   DATE_TIME_EPOCH = ::DateTime.new(2015, 1, 1, 0, 0, 0)
 
   def self.date
-    return DATE_TIME_EPOCH - rand(800)
+    DATE_TIME_EPOCH - rand(800)
   end
 
   def self.time
-    return date.to_time
+    date.to_time
   end
-
-end
+end

data/lib/attributor/extras/field_selector.rb

@@ -1,8 +1,8 @@
 begin
   require 'parslet'
 rescue LoadError
-  warn "Attributor::FieldSelector requires the 'parslet' gem, which can not be found. " +
-    "Please make sure it's in your Gemfile or installed in your system."
+  warn "Attributor::FieldSelector requires the 'parslet' gem, which can not be found. " \
+       "Please make sure it's in your Gemfile or installed in your system."
 end
 
 module Attributor
@@ -16,7 +16,7 @@ module Attributor
       ::Hash
     end
 
-    def self.example(_context = nil, _options = {})
+    def self.example(_context = nil, options: {})
       3.times.each_with_object([]) do |_i, array|
         array << /\w{5,8}/.gen
       end.join(',')
@@ -24,7 +24,7 @@ module Attributor
 
     def self.load(value, context = Attributor::DEFAULT_ROOT_CONTEXT, **_options)
       return nil if value.nil?
-      return value if self.valid_type? value
+      return value if valid_type? value
       return {} if value.empty?
 
       parsed = Parser.new.parse(value)

data/lib/attributor/extras/field_selector/transformer.rb

@@ -1,15 +1,14 @@
 module Attributor
   class FieldSelector
     class Transformer < Parslet::Transform
-
       rule(field: simple(:field_token), children: subtree(:children_tree)) do
         cs = if children_tree.empty?
-          true
-        else
-          children_tree.each_with_object({}) do |item, hash|
-            hash.merge! item
-          end
-        end
+               true
+             else
+               children_tree.each_with_object({}) do |item, hash|
+                 hash.merge! item
+               end
+             end
         { field_token.to_sym => cs }
       end
 

data/lib/attributor/families/numeric.rb

@@ -1,7 +1,6 @@
 # Abstract type for the 'numeric' family
 
 module Attributor
-
   class Numeric
     include Type
 
@@ -12,6 +11,5 @@ module Attributor
     def self.family
       'numeric'
     end
-
   end
 end

data/lib/attributor/families/temporal.rb

@@ -1,7 +1,6 @@
 # Abstract type for the 'temporal' family
 
 module Attributor
-
   class Temporal
     include Type
 
@@ -13,10 +12,8 @@ module Attributor
       'temporal'
     end
 
-    def self.dump(value,**opts)
+    def self.dump(value, **_opts)
       value && value.iso8601
     end
-
-  
   end
 end

data/lib/attributor/hash_dsl_compiler.rb

@@ -1,10 +1,7 @@
 require_relative 'dsl_compiler'
 
-
 module Attributor
-
   class HashDSLCompiler < DSLCompiler
-
     # A class that encapsulates the definition of a requirement for Hash attributes
     # It implements the validation against incoming values and it describes its format for documentation purposes
     class Requirement
@@ -18,9 +15,9 @@ module Attributor
         @type = spec.keys.first
         case type
         when :all
-          self.of(*spec[type])
+          of(*spec[type])
         when :exclusive
-          self.of(*spec[type])
+          of(*spec[type])
         else
           @number = spec[type]
         end
@@ -31,7 +28,7 @@ module Attributor
         self
       end
 
-      def validate(keys,context=Attributor::DEFAULT_ROOT_CONTEXT,_attribute=nil)
+      def validate(keys, context = Attributor::DEFAULT_ROOT_CONTEXT, _attribute = nil)
         result = []
         case type
         when :all
@@ -49,13 +46,13 @@ module Attributor
         when :at_most
           rest = attr_names & keys
           if rest.size > number
-            found = rest.empty? ? "none" : rest.inspect
+            found = rest.empty? ? 'none' : rest.inspect
             result.push "At most #{number} keys out of #{attr_names} can be passed in for #{Attributor.humanize_context(context)}. Found #{found}"
           end
         when :at_least
           rest = attr_names & keys
           if rest.size < number
-            found = rest.empty? ? "none" : rest.inspect
+            found = rest.empty? ? 'none' : rest.inspect
             result.push "At least #{number} keys out of #{attr_names} are required to be passed in for #{Attributor.humanize_context(context)}. Found #{found}"
           end
         when :exclusive
@@ -67,15 +64,14 @@ module Attributor
         result
       end
 
-      def describe(shallow=false, example: nil)
-        hash = {type: type, attributes: attr_names}
+      def describe(_shallow = false, _example: nil)
+        hash = { type: type, attributes: attr_names }
         hash[:count] = number unless number.nil?
         hash[:description] = description unless description.nil?
         hash
       end
     end
 
-
     # A class that encapsulates the available DSL under the `requires` keyword.
     # In particular it allows to define requirements like:
     # requires.all :attr1, :attr2, :attr3
@@ -91,28 +87,33 @@ module Attributor
         self.target = target
         self.options = opts
       end
+
       def all(*attr_names, **opts)
-        req = Requirement.new( options.merge(opts).merge(all: attr_names) )
+        req = Requirement.new(options.merge(opts).merge(all: attr_names))
         target.add_requirement req
         req
       end
+
       def at_most(number)
-        req = Requirement.new(  options.merge(at_most: number) )
+        req = Requirement.new(options.merge(at_most: number))
         target.add_requirement req
         req
       end
+
       def at_least(number)
-        req = Requirement.new(  options.merge(at_least: number) )
+        req = Requirement.new(options.merge(at_least: number))
         target.add_requirement req
         req
       end
+
       def exactly(number)
-        req = Requirement.new(  options.merge(exactly: number) )
+        req = Requirement.new(options.merge(exactly: number))
         target.add_requirement req
         req
       end
+
       def exclusive(*attr_names, **opts)
-        req = Requirement.new(  options.merge(opts).merge(exclusive: attr_names) )
+        req = Requirement.new(options.merge(opts).merge(exclusive: attr_names))
         target.add_requirement req
         req
       end
@@ -122,21 +123,17 @@ module Attributor
       @requirements_dsl ||= RequiresDSL.new(@target)
     end
 
-    def requires(*spec,**opts,&block)
+    def requires(*spec, **opts, &block)
       if spec.empty?
-        unless opts.empty?
-          self._requirements_dsl.options.merge(opts)
-        end
+        _requirements_dsl.options.merge(opts) unless opts.empty?
         if block_given?
-          self._requirements_dsl.instance_eval(&block)
+          _requirements_dsl.instance_eval(&block)
         else
-          self._requirements_dsl
+          _requirements_dsl
         end
       else
-        self._requirements_dsl.all(*spec,opts)
+        _requirements_dsl.all(*spec, opts)
       end
     end
-
-
   end
 end