attributes_dsl 0.0.1

data/lib/attributes_dsl/attribute.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+
+module AttributesDSL
+
+  # Describes settings for PORO attribute
+  #
+  # @api private
+  #
+  # @author Andrew Kozin <Andrew.Kozin@gmail.com>
+  #
+  class Attribute
+
+    include Equalizer.new(:name)
+
+    # @!attribute [r] name
+    #
+    # @return [Symbol] the name of the attribute
+    #
+    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
+    #
+    # @return [Proc, nil] the coercer for the attribute
+    #
+    attr_reader :coercer
+
+    # Initializes the attribute
+    #
+    # @param [Symbol] 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)
+    end
+
+    # Coerces an input assigned to the attribute
+    #
+    # @param [Object] input
+    #
+    # @return [Object]
+    #
+    def value(input)
+      coercer ? coercer[input] : input
+    end
+
+  end # class Attribute
+
+end # module AttributesDSL

data/lib/attributes_dsl/attributes.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+
+module AttributesDSL
+
+  # Describes a collection of attributes declaration with methods
+  # to validate and extract instance attributes from a hash.
+  #
+  # @api private
+  #
+  # @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 [Set] attributes
+    #
+    def initialize(attributes = nil)
+      @attributes = Set.new attributes
+      IceNine.deep_freeze(self)
+    end
+
+    # Initializes the attribute from given arguments
+    # and returns new immutable collection with the attribute
+    #
+    # @param (see Attribute#initialize)
+    #
+    # @return [AttributesDSL::Attributes]
+    #
+    def register(name, options = {}, &coercer)
+      self.class.new(attributes.to_a << Attribute.new(name, options, &coercer))
+    end
+
+    # Extracts instance attributes from the input hash
+    #
+    # Assigns default values and uses coercions when applicable.
+    #
+    # @param [Hash] input
+    #
+    # @return [Hash]
+    #
+    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
+    end
+
+    private
+
+    def validate(input)
+      undefined = required - input.keys
+      return attributes if undefined.empty?
+
+      fail ArgumentError.new "Undefined attributes: #{undefined.join(", ")}"
+    end
+
+    def required
+      attributes.select(&:required).map(&:name)
+    end
+
+  end # class Attributes
+
+end # module AttributesDSL

data/lib/attributes_dsl/version.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module AttributesDSL
+
+  # The semantic version of the module.
+  # @see http://semver.org/ Semantic versioning 2.0
+  VERSION = "0.0.1".freeze
+
+end # module AttributesDSL

data/spec/integration/attributes_dsl_spec.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+describe AttributesDSL do
+
+  let(:coercer) { -> value { value.to_s } }
+  let(:klass) do
+    Class.new do
+      extend AttributesDSL
+
+      def initialize(attributes)
+        super
+        IceNine.deep_freeze(self)
+      end
+    end
+  end
+
+  before do
+    klass.attribute(:foo, default: :FOO, &:to_s)
+    klass.attribute("bar", required: true)
+    klass.attribute(:baz, &:to_i)
+  end
+
+  subject { klass.new(arguments) }
+
+  context "when all required attributes are set" do
+    let(:arguments) { { bar: :BAR, baz: "42" } }
+
+    it "sets the attributes" do
+      expect(subject.attributes).to eql(foo: "FOO", bar: :BAR, baz: 42)
+    end
+
+    it "defines methods for every attribute" do
+      expect(subject.foo).to eql "FOO"
+      expect(subject.bar).to eql :BAR
+      expect(subject.baz).to eql 42
+    end
+
+    it "doesn't freeze argument" do
+      expect { subject }.not_to change { arguments.frozen? }
+    end
+  end # context
+
+  context "when a required attribute is missed" do
+    let(:arguments) { { foo: :FOO, baz: "42" } }
+
+    it "fails" do
+      expect { subject }.to raise_error ArgumentError
+    end
+  end # context
+
+end # describe AttributesDSL

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+begin
+  require "hexx-suit"
+  Hexx::Suit.load_metrics_for(self)
+rescue LoadError
+  require "hexx-rspec"
+  Hexx::RSpec.load_metrics_for(self)
+end
+
+# Loads the code under test
+require "attributes_dsl"

data/spec/unit/attribute_spec.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+
+describe AttributesDSL::Attribute do
+
+  let(:attribute) do
+    described_class.new(name, default: default, required: required, &coercer)
+  end
+
+  let(:name)     { :foo }
+  let(:default)  { "FOO" }
+  let(:required) { true }
+  let(:coercer)  { -> v { v.to_s } }
+
+  describe ".new" do
+    subject { attribute }
+
+    it { is_expected.to be_frozen }
+  end # describe .new
+
+  describe "#name" do
+    subject { attribute.name }
+
+    it { is_expected.to eql name.to_sym }
+  end # describe #name
+
+  describe "#default" do
+    subject { attribute.default }
+
+    context "when value is given" do
+      it { is_expected.to eql default }
+    end
+
+    context "when value isn't set" do
+      let(:attribute) { described_class.new name }
+
+      it { is_expected.to be_nil }
+    end
+  end # describe #default
+
+  describe "#required" do
+    subject { attribute.required }
+
+    context "when set to true without default value" do
+      let(:attribute) { described_class.new name, required: true }
+
+      it { is_expected.to eql true }
+    end
+
+    context "when set to true with default value" do
+      let(:attribute) { described_class.new name, required: true, default: 1 }
+
+      it { is_expected.to eql false }
+    end
+
+    context "when value isn't set" do
+      let(:attribute) { described_class.new name }
+
+      it { is_expected.to eql false }
+    end
+  end # describe #required
+
+  describe "#coercer" do
+    subject { attribute.coercer }
+
+    context "when block is given" do
+      it { is_expected.to eql coercer }
+    end
+
+    context "when block isn't given" do
+      let(:attribute) { described_class.new name }
+
+      it { is_expected.to be_nil }
+    end
+  end # describe #coercer
+
+  describe "#value" do
+    subject { attribute.value(1) }
+
+    context "when coercer is given" do
+      it "uses the coercer" do
+        expect(subject).to eql "1"
+      end
+    end
+
+    context "when coercer isn't given" do
+      let(:attribute) { described_class.new name }
+
+      it "returns the input" do
+        expect(subject).to eql 1
+      end
+    end
+  end # describe #value
+
+  describe "#==" do
+    subject { attribute == other }
+
+    context "with the same name" do
+      let(:other) { described_class.new name }
+
+      it { is_expected.to eql true }
+    end
+
+    context "with another name" do
+      let(:other) { described_class.new :bar }
+
+      it { is_expected.to eql false }
+    end
+  end # describe #==
+
+  describe "#eql?" do
+    subject { attribute.eql? other }
+
+    context "with the same name" do
+      let(:other) { described_class.new name }
+
+      it { is_expected.to eql true }
+    end
+
+    context "with another name" do
+      let(:other) { described_class.new :bar }
+
+      it { is_expected.to eql false }
+    end
+  end # describe #eql?
+
+end # describe AttributesDSL::Attribute

data/spec/unit/attributes_spec.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+describe AttributesDSL::Attributes do
+
+  let(:attributes) { described_class.new }
+  let(:coercer)    { -> value { value.to_s } }
+
+  describe ".new" do
+    subject { attributes }
+
+    it { is_expected.to be_frozen }
+  end # describe .new
+
+  describe "#attributes" do
+    subject { attributes.attributes }
+
+    it { is_expected.to be_kind_of Set }
+    it { is_expected.to be_empty }
+  end # describe #attributes
+
+  describe "#register" do
+    subject { attributes.register(:foo, default: :FOO, &coercer) }
+
+    it "returns new collection" do
+      expect(subject).to be_kind_of described_class
+    end
+
+    it "registers the attribute" do
+      attribute = subject.attributes.first
+
+      expect(attribute).to be_kind_of AttributesDSL::Attribute
+      expect(attribute.name).to eql :foo
+      expect(attribute.default).to eql :FOO
+      expect(attribute.coercer).to eql coercer
+    end
+
+    context "without options" do
+      subject { attributes.register :foo }
+
+      it { is_expected.to be_kind_of described_class }
+    end
+  end # describe #register
+
+  describe "#extract" do
+    subject { attributes.extract hash }
+
+    let(:hash) { { bar: :BAR } }
+    let(:attributes) do
+      described_class
+        .new
+        .register(:foo, required: true, &coercer)
+        .register(:bar, required: true)
+        .register(:baz, default: :BAZ, &coercer)
+    end
+
+    context "when all required attributes are present" do
+      let(:hash) { { foo: :FOO, bar: :BAR, qux: :QUX } }
+
+      it "returns a proper hash" do
+        expect(subject).to eql(foo: "FOO", bar: :BAR, baz: "BAZ")
+      end
+    end
+
+    context "when a required attribute is absent" do
+      let(:hash) { { baz: :BAZ } }
+
+      it "fails" do
+        expect { subject }.to raise_error do |error|
+          expect(error).to be_kind_of ArgumentError
+          expect(error.message).to eql "Undefined attributes: foo, bar"
+        end
+      end
+    end
+  end # describe #extract
+
+end # describe AttributeDSL::Attributes

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: attributes_dsl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Kozin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ice_nine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: equalizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.11
+  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
+- !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
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+description: 
+email: andrew.kozin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".metrics"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- attributes_dsl.gemspec
+- benchmark/run.rb
+- config/metrics/STYLEGUIDE
+- config/metrics/cane.yml
+- config/metrics/churn.yml
+- config/metrics/flay.yml
+- config/metrics/metric_fu.yml
+- config/metrics/reek.yml
+- config/metrics/roodi.yml
+- config/metrics/rubocop.yml
+- config/metrics/saikuro.yml
+- config/metrics/simplecov.yml
+- config/metrics/yardstick.yml
+- lib/attributes_dsl.rb
+- lib/attributes_dsl/attribute.rb
+- lib/attributes_dsl/attributes.rb
+- lib/attributes_dsl/version.rb
+- spec/integration/attributes_dsl_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
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+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
+has_rdoc: