attributes_dsl 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0a8b2957544474ff4116fd2b6d1703de977ba74
-  data.tar.gz: b61d244f9ea674fdff84404e269dfa083fca6f64
+  metadata.gz: 7c399823c440258ebcd951ce049e16877934b630
+  data.tar.gz: 345a83666686089656e22eb5a38f88997baccd41
 SHA512:
-  metadata.gz: de35390efe7b4feb77a049d040884615e11c5de61e9d8cb3bb595fbf2b71a0b0e3d53b5dd78425c6e775774366bb39cd538b5b6fa3e1af6c67e61ec03863669d
-  data.tar.gz: 213cac8c92f35d396ce1272b53baace3a03ee635521e573cf039c85fd72bf4f43f384f46ae7d958188f9ca1d6c3424f82bc992e82c94b7fecd5221c6f10fbff4
+  metadata.gz: a25c08685b444464ad501a9a0a5a9d945ea854bef5959241b53918470a7dbda28d0c173aec1c6a57709ad637c490ec8864bafad9f2c1cc5a6d622d56450a667f
+  data.tar.gz: 36a64b86b318bbad9cfbceddefdf9fb49616f2443f259a2024642461fdb03d6eb143216913e24cfd402938c37ef38c6ea8cce2da8b1f42eec67022931cb40aac

data/.travis.yml

@@ -4,14 +4,10 @@ bundler_args: --without metrics --without benchmarks
 cache:        bundler
 script:       bundle exec rake test:coverage:run
 rvm:
-  - '1.9.3'
-  - '2.0'
   - '2.1'
   - '2.2'
   - ruby-head
-  - rbx-2 --1.9
   - rbx-2 --2.1
-  - jruby-1.7-19mode
   - jruby-9.0.0.0
   - jruby-head
 matrix:

data/CHANGELOG.md

@@ -1,3 +1,26 @@
+## version 0.1.0 2015-12-08
+
+Stabilized DSL
+
+### Added
+
+* Option `:reader` that allows skipping attribute reader (nepalez)
+* Option `:only` whitelists allowed values (nepalez)
+* Option `:except` blacklists allowed values (nepalez)
+* Option `:coercer` is an alternative to block syntax (nepalez)
+* An instance can be initialized by hash with both symbolic and string keys (nepalez)
+
+### Deleted
+
+* Support for rubies < 2.1
+
+### Internal
+
+* Removed freezing of values (nepalez)
+* Slightly (20-25%) improved efficiency due to usage of transpfoc (nepalez)
+
+[Compare v0.0.2...v0.1.0](https://github.com/nepalez/attributes_dsl/compare/v0.0.2...v0.1.0)
+
 ## version 0.0.2 2015-09-11
 
 This version is a result of applying v0.0.1 to the existing gems:

data/README.md

@@ -21,40 +21,21 @@ require "attributes_dsl"
 class User
   extend AttributesDSL
 
-  # `name` is required should be symbolized
-  attribute :name, required: true do |value|
-    value.to_s.to_sym
-  end
-
-  # `sex` is optional and set to `:male` by default.
-  # It can be set to either :male or :female
-  attribute :sex, default: :male do |value|
-    (value == :male )? :male : :female
-  end
-
-  # `age` is optional and set to `nil` by default.
-  # Then it is converted to integer
-  attribute :age, &:to_i
-
-  # `position` is optional and set to `nil` by default
-  attribute :position
-
-  # All other attributes are ignored
+  attribute :name, required: true, coerce: -> v { v.to_s }
+  attribute :sex,  default: :male, only: /male|female/
+  attribute :age,  only: 18..25
+  attribute :city, reader: false, except: %w(Moscow)
 end
 
-user = User.new(name: "Jane", sex: :women, age: "26", place: "Moscow")
+user = User.new(name: :Jane, sex: :female, age: 24, city: "Kiev")
 user.attributes
-# => { name: :Jane, sex: :female, age: 26, position: nil }
+# => { name: :Jane, sex: :female, age: 26, city: "Kiev" }
 
 # Aliases for attributes[:some_attribute]
-user.name     # => :Jane
-user.sex      # => :female
-user.age      # => 26
-user.position # => nil
-
-# Required attributes should be assigned:
-user = User.new(sex: :women, age: "26", place: "Moscow")
-# => #<ArgumentError "Undefined attributes: name">
+user.name # => "Jane"
+user.sex  # => :female
+user.age  # => 26
+user.city # => #<NoMethodError ...>
 ```
 
 Additional Details
@@ -62,10 +43,14 @@ Additional Details
 
 ### Attribute declaration
 
-The `attribute` class method takes the `name` and 2 options:
+The `attribute` class method takes the `name` and 3 options:
 
-- `:default` for the default value (otherwise `nil`);
+- `:default` for the default value (otherwise `nil`).
 - `:required` to declare the attribute as required. It will be ignored if a default value is provided!
+- `:reader` defines whether the attribute reader should be defined (`true` by default).
+- `:only` defines allowed values. You can use procs (`-> v { v.to_s }`), ranges (`18..25`), regexps (`/male|female/`), constants (`String`), or arrays (`[:male, :female]`) to define a restriction.
+- `:except` defines forbidden values.
+- `:coercer` defines a procedure to convert assigned value.
 
 It is also takes the block, used to coerce a value. The coercer is applied to the default value too.
 
@@ -75,10 +60,9 @@ Instance methods (like `#name`) are just aliases for the corresponding value of
 
 ```ruby
 user = User.new(name: "John")
-user.attributes # => { name: :John, sex: :male, age: 0, position: nil }
-user.name # => :John
+user.attributes # => { name: :John, sex: :male, age: nil, city: nil }
 
-# but
+user.name # => :John
 user.instance_variable_get :@name # => nil
 ```
 
@@ -93,7 +77,8 @@ end
 
 user = UserWithRole.new(name: "Sam")
 user.attributes
-# => { name: :Sam, sex: :male, age: 0, position: nil, role: :user }
+user.attributes
+# => { name: :John, sex: :male, age: nil, city: nil, role: :user }
 ```
 
 ### Undefining Attributes
@@ -160,29 +145,21 @@ The results are following:
 
 ```
 -------------------------------------------------
-               anima    211.638k (± 3.7%) i/s -      1.071M
-              kwattr    187.276k (± 3.6%) i/s -    947.484k
-     fast_attributes    160.916k (± 2.4%) i/s -    816.726k
-      attributes_dsl     71.850k (± 3.0%) i/s -    365.365k
-         active_attr     71.489k (± 3.6%) i/s -    357.995k
-              virtus     45.554k (± 7.1%) i/s -    229.338k
-
-Comparison:
-               anima:   211637.9 i/s
-              kwattr:   187276.2 i/s - 1.13x slower
-     fast_attributes:   160916.1 i/s - 1.32x slower
-      attributes_dsl:    71850.0 i/s - 2.95x slower
-         active_attr:    71489.1 i/s - 2.96x slower
-              virtus:    45553.8 i/s - 4.65x slower
+              kwattr:   183416.9 i/s
+               anima:   169647.3 i/s - 1.08x slower
+     fast_attributes:   156036.2 i/s - 1.18x slower
+      attributes_dsl:    74495.9 i/s - 2.46x slower
+         active_attr:    74469.4 i/s - 2.46x slower
+              virtus:    46587.0 i/s - 3.94x slower
 ```
 
 Results above are pretty reasonable.
 
 The gem is faster than `virtus` that has many additional features.
 
-It is as fast as `active_attrs` (but has more customizable coercers).
+It is as fast as `active_attrs` (but has more options).
 
-It is 2 times slower than `fast_attributes` that has no coercer and default values. And it is 3 times slower than `anima` and `kwattr` that provides only the base settings.
+It is 2 times slower than `fast_attributes` that has no coercer and default values. And it is 2.5 times slower than `anima` and `kwattr` that provide only simple attribute's declaration.
 
 Installation
 ------------
@@ -209,12 +186,10 @@ gem install attributes_dsl
 Compatibility
 -------------
 
-Tested under rubies [compatible to MRI 1.9+][versions].
+Tested under rubies [compatible to MRI 2.1+][versions].
 
 Uses [RSpec][rspec] 3.0+ for testing and [hexx-suit][hexx-suit] for dev/test tools collection.
 
-100% [mutant]-proof covered.
-
 Contributing
 ------------
 
@@ -222,7 +197,6 @@ Contributing
 * [Fork the project](https://github.com/nepalez/attributes_dsl)
 * Create your feature branch (`git checkout -b my-new-feature`)
 * Add tests for it
-* Run `rake mutant` or `rake exhort` to ensure 100% [mutant][mutant] coverage
 * Commit your changes (`git commit -am '[UPDATE] Add some feature'`)
 * Push to the branch (`git push origin my-new-feature`)
 * Create a new Pull Request

data/attributes_dsl.gemspec

@@ -2,7 +2,6 @@ $LOAD_PATH.push File.expand_path("../lib", __FILE__)
 require "attributes_dsl/version"
 
 Gem::Specification.new do |gem|
-
   gem.name        = "attributes_dsl"
   gem.version     = AttributesDSL::VERSION.dup
   gem.author      = "Andrew Kozin"
@@ -16,11 +15,11 @@ Gem::Specification.new do |gem|
   gem.extra_rdoc_files = Dir["README.md", "LICENSE"]
   gem.require_paths    = ["lib"]
 
-  gem.required_ruby_version = ">= 1.9.3"
-
-  gem.add_runtime_dependency "ice_nine", "~> 0.11"
-  gem.add_runtime_dependency "equalizer", "~> 0.0", ">= 0.0.11"
+  gem.required_ruby_version = ">= 2.1"
 
-  gem.add_development_dependency "hexx-rspec", "~> 0.5", ">= 0.5.2"
+  gem.add_runtime_dependency "equalizer", "~> 0.0.11"
+  gem.add_runtime_dependency "transproc", "~> 0.4.0"
 
-end # Gem::Specification
+  gem.add_development_dependency "hexx-rspec", "~> 0.5.2"
+  gem.add_development_dependency "ice_nine", "~> 0.11.1"
+end

data/benchmark/run.rb

@@ -6,10 +6,10 @@ module AttributesDSLExample
   class User
     extend AttributesDSL
 
-    attribute :foo, required: true, &:to_s
-    attribute :bar, default: :BAR, &:to_s
-    attribute :baz, default: :BAZ, &:to_s
-    attribute :qux, &:to_s
+    attribute :foo, required: true
+    attribute :bar, default: :BAR
+    attribute :baz, default: :BAZ
+    attribute :qux
   end
 
   def self.call

data/lib/attributes_dsl.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 require "equalizer"
-require "ice_nine"
+require "transproc"
 
 # Simple DSL for PORO attributes
 #
@@ -11,6 +11,7 @@ require "ice_nine"
 #
 module AttributesDSL
 
+  require_relative "attributes_dsl/transprocs"
   require_relative "attributes_dsl/attribute"
   require_relative "attributes_dsl/attributes"
 
@@ -31,35 +32,26 @@ module AttributesDSL
   #     extend AttributeDSL
   #
   #     attribute :foo, required: true do |value|
-  #       value.to_i % 5
+  #       value.to_i % 5 # value coercer
   #     end
   #
-  #     attribute :bar, default: :BAR
+  #     attribute :bar, default: :BAR, reader: false
   #   end
   #
   # @param [#to_sym] name The unique name of the attribute
-  # @param [Proc] coercer The proc to coerce values (including the default ones)
   # @param [Hash] options
-  #
-  # @option options [Boolean] :required
-  #   Whether the attribute should be required by the +initializer+
-  #   This option is ignored (set to +false+) when default value is provided
-  # @option options [Object] :default
-  #   The default value for the attribute
+  # @param [Proc] coercer The proc to coerce values (including the default ones)
   #
   # @return [undefined]
   #
   def attribute(name, options = {}, &coercer)
-    s_name = name.to_sym
-    @attributes = attributes.register(s_name, options, &coercer)
-
-    define_method(s_name) { attributes.fetch(s_name) }
+    @attributes = attributes.add(name, options, &coercer)
+    define_method(name) { attributes.fetch(name) } if attributes.reader? name
   end
 
   # @private
   def self.extended(klass)
-    # use __send__ for compatibility to 1.9.3 (where `.include` was private)
-    klass.__send__(:include, InstanceMethods)
+    klass.instance_eval { include InstanceMethods }
   end
 
   # @private
@@ -69,7 +61,6 @@ module AttributesDSL
 
   # Defines instance methods for the hash of attributes and its initializer
   module InstanceMethods
-
     # @!attribute [r] attributes
     #
     # @return [Hash] the hash of initialized attributes
@@ -80,12 +71,8 @@ module AttributesDSL
     #
     # @param [Hash] attributes
     #
-    # @raise [ArgumentError] in case a required attribute is missed
-    #
     def initialize(attributes = {})
-      @attributes = self.class.attributes.extract(attributes)
+      @attributes = self.class.attributes.transformer[attributes]
     end
-
-  end # module InstanceMethods
-
-end # module AttributesDSL
+  end
+end

data/lib/attributes_dsl/attribute.rb

@@ -9,7 +9,6 @@ module AttributesDSL
   # @author Andrew Kozin <Andrew.Kozin@gmail.com>
   #
   class Attribute
-
     include Equalizer.new(:name)
 
     # @!attribute [r] name
@@ -18,52 +17,68 @@ module AttributesDSL
     #
     attr_reader :name
 
-    # @!attribute [r] default
-    #
-    # @return [Object] the default value of the attribute
-    #
-    attr_reader :default
-
-    # @!attribute [r] required
-    #
-    # @return [Boolean] whether the attribute is required
-    #
-    attr_reader :required
-
-    # @!attribute [r] coercer
+    # @!attribute [r] reader
     #
-    # @return [Proc, nil] the coercer for the attribute
+    # @return [Boolean] whether an attribute should be readable
     #
-    attr_reader :coercer
+    attr_reader :reader
 
     # Initializes the attribute
     #
-    # @param [Symbol] name
+    # @param [#to_sym] name
     # @param [Hash] options
     # @param [Proc] coercer
     #
-    # @option options [Object] :default
-    # @option options [Boolean] :required
-    #
     def initialize(name, options = {}, &coercer)
-      @name = name
-      @default = options.fetch(:default) {}
-      @required = default.nil? && options.fetch(:required) { false }
-      @coercer = coercer
-
-      IceNine.deep_freeze(self)
+      @name    = name.to_sym
+      @options = { coercer: coercer }.merge(options)
+      @reader  = @options.fetch(:reader) { true }
     end
 
-    # Coerces an input assigned to the attribute
+    # A proc that transform a hash of attributes using current settings
     #
-    # @param [Object] input
+    # @return [Proc]
     #
-    # @return [Object]
-    #
-    def value(input)
-      coercer ? coercer[input] : input
+    def transformer
+      convert unless @options.empty?
     end
 
-  end # class Attribute
+    private
+
+    def convert
+      @convert ||= Transprocs[:convert, name, presence, absence]
+    end
+
+    def presence
+      [whitelist, blacklist, coercer].compact.reduce(:>>) || identity
+    end
 
-end # module AttributesDSL
+    def absence
+      [missed, default].compact.reduce(:>>) || identity
+    end
+
+    def identity
+      Transprocs[:identity]
+    end
+
+    def missed
+      Transprocs[:missed, name] if @options[:required]
+    end
+
+    def default
+      Transprocs[:default, name, @options[:default]] if @options[:default]
+    end
+
+    def whitelist
+      Transprocs[:whitelist, name, @options[:only]] if @options[:only]
+    end
+
+    def blacklist
+      Transprocs[:blacklist, name, @options[:except]] if @options[:except]
+    end
+
+    def coercer
+      Transprocs[:coerce, name, @options[:coercer]] if @options[:coercer]
+    end
+  end
+end

data/lib/attributes_dsl/attributes.rb

@@ -10,22 +10,14 @@ module AttributesDSL
   # @author Andrew Kozin <Andrew.Kozin@gmail.com>
   #
   class Attributes
-
     # @!attribute [r] attributes
     #
     # Uses the set of attributes to ensure their uniqueness (by name)
     #
     # @return [Set] the set of registered attributes
     #
-    attr_reader :attributes
-
-    # Initializes an immutable collection with an initial set of attributes
-    #
-    # @param [Hash] attributes
-    #
-    def initialize(attributes = {})
-      @attributes = attributes
-      IceNine.deep_freeze(self)
+    def attributes
+      @attributes ||= {}
     end
 
     # Initializes the attribute from given arguments
@@ -35,41 +27,49 @@ module AttributesDSL
     #
     # @return [AttributesDSL::Attributes]
     #
-    def register(name, options = {}, &coercer)
-      self.class.new(
-        attributes.merge(name => Attribute.new(name, options, &coercer))
-      )
+    def add(name, options = {}, &coercer)
+      name  = name.to_sym
+      value = Attribute.new(name, options, &coercer)
+      clone_with do
+        @attributes  = attributes.merge(name => value)
+        @transformer = nil
+      end
     end
 
-    # Extracts instance attributes from the input hash
+    # Returns the proc that converts a hash of attributes using current setting
+    #
+    # @return [Proc]
     #
-    # Assigns default values and uses coercions when applicable.
+    def transformer
+      @transformer ||= transprocs.flatten.compact.reduce(:>>)
+    end
+
+    # Checks whether an attribute reader should be defined
     #
-    # @param [Hash] input
+    # @param [#to_sym] name
     #
-    # @return [Hash]
+    # @return [Boolean]
     #
-    def extract(input)
-      validate(input).inject({}) do |a, e|
-        key = e.name
-        value = input.fetch(key) { e.default }
-        a.merge(key => e.value(value))
-      end
+    def reader?(name)
+      attributes[name.to_sym].reader
     end
 
     private
 
-    def validate(input)
-      undefined = required - input.keys
-      return attributes.values if undefined.empty?
-
-      fail ArgumentError.new "Undefined attributes: #{undefined.join(", ")}"
+    def transprocs
+      [
+        Transprocs[:filter, keys],
+        attributes.values.map(&:transformer),
+        Transprocs[:update, keys]
+      ]
     end
 
-    def required
-      attributes.values.select(&:required).map(&:name)
+    def keys
+      attributes.keys
     end
 
-  end # class Attributes
-
-end # module AttributesDSL
+    def clone_with(&block)
+      dup.tap { |instance| instance.instance_eval(&block) }
+    end
+  end
+end