attributes_dsl 0.0.2 → 0.1.0

data/lib/attributes_dsl/transprocs.rb

@@ -0,0 +1,141 @@
+require "transproc/coercions"
+
+module AttributesDSL
+  # The collection of pure composable functions
+  #
+  module Transprocs
+    extend Transproc::Registry
+
+    import :identity, from: Transproc::Coercions
+
+    # Symbolizes hash keys and filters them by given ones
+    #
+    # @example
+    #   filter({ "foo" => :BAR, bar: :BAZ }, [:foo, :qux])
+    #   # => { foo: :BAR }
+    #
+    # @param [Hash] attributes
+    # @param [Array] keys
+    #
+    # @return [Hash] attributes
+    #
+    def self.filter(attributes, keys)
+      attributes
+        .map { |key, value| [key.to_sym, value] }
+        .select { |key, _| keys.include? key }
+        .to_h
+    end
+
+    # Ensures all given keys are present in the hash
+    #
+    # @example
+    #   filter({ foo: :BAR }, [:foo, :qux])
+    #   # => { foo: :BAR, :qux: nil }
+    #
+    # @param [Hash] attributes
+    # @param [Array] keys
+    #
+    # @return [Hash]
+    #
+    def self.update(attributes, keys)
+      keys.map { |key| [key, attributes[key]] }.to_h
+    end
+
+    # Checks whether the name is present in attributes' keys,
+    # and transforms it using either the first or the second procedure
+    #
+    # @param [Hash] attributes
+    # @param [Symbol] name
+    # @param [Proc] presence
+    # @param [Proc] absence
+    #
+    # @return [Hash]
+    #
+    def self.convert(attributes, name, presence, absence)
+      if attributes.keys.include? name
+        presence[attributes]
+      else
+        absence[attributes]
+      end
+    end
+
+    # Complains about missed attribute in a hash
+    #
+    # @param [Hash] _attributes
+    # @param [#to_s] name
+    #
+    # @return [undefined]
+    # @raise [ArgumentError]
+    #
+    def self.missed(_attributes, name)
+      fail ArgumentError.new "Attribute '#{name}' is required"
+    end
+
+    # Updates the hash with default name's value
+    #
+    # @param [Hash] attributes
+    # @param [Symbol] name
+    # @param [Object] value
+    #
+    # @return [Hash]
+    #
+    def self.default(attributes, name, value)
+      attributes.merge(name => value)
+    end
+
+    # Checks if the attributes has no blacklisted values
+    #
+    # @param [Hash] attributes
+    # @param [Symbol] name
+    # @param [Array, Proc, Regexp, Range, Module] condition
+    #
+    # @return [Hash]
+    # @raise [ArgumentError] if the condition is satisfied
+    #
+    def self.blacklist(attributes, name, condition)
+      return attributes unless check(attributes[name], condition)
+
+      fail ArgumentError.new "Attribute #{name} is invalid: #{attributes[name]}"
+    end
+
+    # Checks if the attributes has whitelisted values
+    #
+    # @param [Hash] attributes
+    # @param [Symbol] name
+    # @param [Array, Proc, Regexp, Range, Module] condition
+    #
+    # @return [Hash]
+    # @raise [ArgumentError] if the condition is NOT satisfied
+    #
+    def self.whitelist(attributes, name, condition)
+      return attributes if check(attributes[name], condition)
+
+      fail ArgumentError.new "Attribute #{name} is invalid: #{attributes[name]}"
+    end
+
+    # Coerces attributes' name's value using given proc
+    #
+    # @example
+    #   coerce({ foo: :BAR, bar: :BAZ }, :foo, -> v { v.to_s })
+    #   # => { foo: "BAR", bar: :BAZ }
+    #
+    # @param [Hash] attributes
+    # @param [Symbol] name
+    # @param [Proc] coercer
+    #
+    # @return [Hash]
+    #
+    def self.coerce(attributes, name, coercer)
+      attributes.merge(name => coercer[attributes[name]])
+    end
+
+    private
+
+    def self.check(value, condition)
+      method = condition.is_a?(Array) ? :include? : :===
+      condition.send method, value
+    rescue
+      false
+    end
+  end
+end

data/lib/attributes_dsl/version.rb

@@ -4,6 +4,6 @@ module AttributesDSL
 
   # The semantic version of the module.
   # @see http://semver.org/ Semantic versioning 2.0
-  VERSION = "0.0.2".freeze
+  VERSION = "0.1.0".freeze
 
 end # module AttributesDSL

data/spec/integration/blacklisted_attribute_spec.rb

@@ -0,0 +1,49 @@
+describe "blacklisted attribute" do
+  let(:substring) { Class.new(String) }
+  let(:klass) do
+    Class.new do
+      extend AttributesDSL
+
+      attribute :foo, except: /foo/
+      attribute :bar, except: 1..3
+      attribute :baz, except: %w(foo bar)
+      attribute :qux, except: -> v { v.even? }
+      attribute :yux, except: String
+      attribute :fix, except: String, coercer: -> v { v.to_s }
+    end
+  end
+
+  it "doesn't check unassigned values" do
+    expect { klass.new }.not_to raise_error
+  end
+
+  it "passes when all values are valid" do
+    params = { foo: "bar", bar: 0, baz: 0, qux: 3, yux: 1, fix: 2 }
+
+    expect { klass.new params }.not_to raise_error
+  end
+
+  it "checks regexp condition" do
+    expect { klass.new foo: "foo" }.to raise_error(ArgumentError, /foo/)
+  end
+
+  it "checks range condition" do
+    expect { klass.new bar: 2 }.to raise_error(ArgumentError, /bar/)
+  end
+
+  it "checks array condition" do
+    expect { klass.new baz: "foo" }.to raise_error(ArgumentError, /baz/)
+  end
+
+  it "checks proc condition" do
+    expect { klass.new qux: 4 }.to raise_error(ArgumentError, /qux/)
+  end
+
+  it "checks type" do
+    expect { klass.new yux: "foo" }.to raise_error(ArgumentError, /yux/)
+  end
+
+  it "applies validation before coersion" do
+    expect { klass.new fix: "foo" }.to raise_error(ArgumentError)
+  end
+end

data/spec/integration/coerced_attribute_spec.rb

@@ -0,0 +1,27 @@
+describe "coerced attribute" do
+  let(:klass) do
+    Class.new do
+      extend AttributesDSL
+      attribute :foo, coercer: -> v { v.to_s }
+      attribute :bar, &:to_s
+    end
+  end
+
+  it "is not applied to skipped value" do
+    subject = klass.new
+
+    expect(subject.foo).to be_nil
+  end
+
+  it "is applied to assigned value" do
+    subject = klass.new foo: nil
+
+    expect(subject.foo).to eql("")
+  end
+
+  it "can be defined via block" do
+    subject = klass.new bar: :BAZ
+
+    expect(subject.bar).to eql("BAZ")
+  end
+end

data/spec/integration/default_attribute_spec.rb

@@ -0,0 +1,20 @@
+describe "required attribute" do
+  let(:klass) do
+    Class.new do
+      extend AttributesDSL
+      attribute :foo, default: :FOO
+    end
+  end
+
+  it "adds default assignment" do
+    subject = klass.new
+
+    expect(subject.foo).to eql :FOO
+  end
+
+  it "assigns explicit value" do
+    subject = klass.new foo: :BAR
+
+    expect(subject.foo).to eql :BAR
+  end
+end

data/spec/integration/required_attribute_spec.rb

@@ -0,0 +1,17 @@
+describe "required attribute" do
+  let(:klass) do
+    Class.new do
+      extend AttributesDSL
+      attribute :foo, required: true
+      attribute :bar
+    end
+  end
+
+  it "demands explicit assignment" do
+    expect { klass.new bar: :BAZ }.to raise_error(ArgumentError, /foo/)
+  end
+
+  it "allows nil values" do
+    expect { klass.new foo: nil }.not_to raise_error
+  end
+end

data/spec/integration/simple_attribute_spec.rb

@@ -0,0 +1,29 @@
+describe "simple attribute" do
+  let(:klass) do
+    Class.new do
+      extend AttributesDSL
+      attribute :foo
+    end
+  end
+
+  it "defines empty attributes" do
+    subject = klass.new
+
+    expect(subject.attributes).to eql(foo: nil)
+    expect(subject.foo).to be_nil
+  end
+
+  it "assigns attributes by symbolic keys" do
+    subject = klass.new foo: :BAR
+
+    expect(subject.attributes).to eql(foo: :BAR)
+    expect(subject.foo).to eql :BAR
+  end
+
+  it "assigns attributes by string keys" do
+    subject = klass.new "foo" => :BAR
+
+    expect(subject.attributes).to eql(foo: :BAR)
+    expect(subject.foo).to eql :BAR
+  end
+end

data/spec/integration/unknown_attribute_spec.rb

@@ -0,0 +1,10 @@
+describe "unknown attribute" do
+  let(:klass) { Class.new { extend AttributesDSL } }
+
+  subject { klass.new foo: :BAR }
+
+  it "is ignored" do
+    expect(subject).not_to respond_to :foo
+    expect(subject.attributes).to eql({})
+  end
+end

data/spec/integration/unreadable_attribute_spec.rb

@@ -0,0 +1,18 @@
+describe "unreadable attribute" do
+  let(:klass) do
+    Class.new do
+      extend AttributesDSL
+      attribute :foo, reader: false
+    end
+  end
+
+  subject { klass.new foo: :BAR }
+
+  it "defines the attribute" do
+    expect(subject.attributes).to eql(foo: :BAR)
+  end
+
+  it "doesn't define a reader" do
+    expect(subject).not_to respond_to :foo
+  end
+end

data/spec/integration/whitelisted_attribute_spec.rb

@@ -0,0 +1,49 @@
+describe "whitelisted attribute" do
+  let(:substring) { Class.new(String) }
+  let(:klass) do
+    Class.new do
+      extend AttributesDSL
+
+      attribute :foo, only: /foo/
+      attribute :bar, only: 1..3
+      attribute :baz, only: %w(foo bar)
+      attribute :qux, only: -> v { v.even? }
+      attribute :yux, only: String
+      attribute :fix, only: String, coercer: -> v { v.to_s }
+    end
+  end
+
+  it "doesn't check unassigned values" do
+    expect { klass.new }.not_to raise_error
+  end
+
+  it "passes when all values are valid" do
+    params = { foo: "foo", bar: 2, baz: "foo", qux: 2, yux: "1", fix: "2" }
+
+    expect { klass.new params }.not_to raise_error
+  end
+
+  it "checks regexp condition" do
+    expect { klass.new foo: "bar" }.to raise_error(ArgumentError, /foo/)
+  end
+
+  it "checks range condition" do
+    expect { klass.new bar: 4 }.to raise_error(ArgumentError, /bar/)
+  end
+
+  it "checks array condition" do
+    expect { klass.new baz: "qux" }.to raise_error(ArgumentError, /baz/)
+  end
+
+  it "checks proc condition" do
+    expect { klass.new qux: 3 }.to raise_error(ArgumentError, /qux/)
+  end
+
+  it "checks type" do
+    expect { klass.new yux: :foo }.to raise_error(ArgumentError, /yux/)
+  end
+
+  it "applies validation before coersion" do
+    expect { klass.new fix: :foo }.to raise_error(ArgumentError)
+  end
+end

data/spec/spec_helper.rb

@@ -10,3 +10,6 @@ end
 
 # Loads the code under test
 require "attributes_dsl"
+
+# Loads specific matchers
+require "ice_nine"

metadata

@@ -1,57 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: attributes_dsl
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
+date: 2015-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: ice_nine
+  name: equalizer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 0.0.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: 0.0.11
 - !ruby/object:Gem::Dependency
-  name: equalizer
+  name: transproc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.11
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.0.11
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: hexx-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.2
   type: :development
@@ -59,11 +50,22 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: ice_nine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
 description: 
 email: andrew.kozin@gmail.com
 executables: []
@@ -101,11 +103,17 @@ files:
 - lib/attributes_dsl.rb
 - lib/attributes_dsl/attribute.rb
 - lib/attributes_dsl/attributes.rb
+- lib/attributes_dsl/transprocs.rb
 - lib/attributes_dsl/version.rb
-- spec/integration/attributes_dsl_spec.rb
+- spec/integration/blacklisted_attribute_spec.rb
+- spec/integration/coerced_attribute_spec.rb
+- spec/integration/default_attribute_spec.rb
+- spec/integration/required_attribute_spec.rb
+- spec/integration/simple_attribute_spec.rb
+- spec/integration/unknown_attribute_spec.rb
+- spec/integration/unreadable_attribute_spec.rb
+- spec/integration/whitelisted_attribute_spec.rb
 - spec/spec_helper.rb
-- spec/unit/attribute_spec.rb
-- spec/unit/attributes_spec.rb
 homepage: https://github.com/nepalez/attributes_dsl
 licenses:
 - MIT
@@ -118,7 +126,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -132,7 +140,12 @@ specification_version: 4
 summary: Lightweight DSL to define PORO attributes
 test_files:
 - spec/spec_helper.rb
-- spec/integration/attributes_dsl_spec.rb
-- spec/unit/attribute_spec.rb
-- spec/unit/attributes_spec.rb
+- spec/integration/required_attribute_spec.rb
+- spec/integration/unknown_attribute_spec.rb
+- spec/integration/simple_attribute_spec.rb
+- spec/integration/default_attribute_spec.rb
+- spec/integration/unreadable_attribute_spec.rb
+- spec/integration/blacklisted_attribute_spec.rb
+- spec/integration/coerced_attribute_spec.rb
+- spec/integration/whitelisted_attribute_spec.rb
 has_rdoc: