assertion 0.1.0 → 0.2.0

data/spec/unit/assertion/guard_spec.rb

@@ -6,32 +6,56 @@ describe Assertion::Guard do
 
   before do
     IsAdult   = Assertion.about(:age) { age.to_i >= 18 }
-    AdultOnly = Class.new(described_class) { def state; IsAdult[object]; end }
+    AdultOnly = Class.new(described_class) do
+      def state
+        IsAdult[object.to_h]
+      end
+    end
   end
 
   let(:valid)   { OpenStruct.new(name: "Joe", age: 40) }
   let(:invalid) { OpenStruct.new(name: "Ian", age: 10) }
-  let(:guard)   { AdultOnly.new valid     }
+  let(:guard)   { AdultOnly.new valid }
 
-  it "can declare attributes" do
-    expect(AdultOnly).to be_kind_of Assertion::Attributes
-  end
+  describe ".attribute" do
 
-  describe ".new" do
+    shared_examples "adding #object alias" do |name|
 
-    subject { guard }
+      subject { AdultOnly.attribute name }
 
-    it { is_expected.to be_frozen }
+      it "adds alias for the #object" do
+        subject
+        expect(guard.send name).to eql guard.object
+      end
 
-    context "with an attriubute" do
+    end # shared examples
 
-      before { allow(AdultOnly).to receive(:attributes) { [:foo] } }
+    shared_examples "raising NameError" do |with: nil|
 
-      it "adds the alias to the #object" do
-        expect(subject.foo).to eql subject.object
+      before  { Test = Class.new(described_class) } # #state not implemented yet
+      after   { Object.send :remove_const, :Test  }
+      subject { Test.attribute with               }
+
+      it "fails" do
+        expect { subject }.to raise_error do |error|
+          expect(error).to be_kind_of NameError
+          expect(error.message).to eql "Test##{with} is already defined"
+        end
       end
 
-    end # context
+    end # shared examples
+
+    it_behaves_like "adding #object alias", :foo
+    it_behaves_like "raising NameError", with: "state"
+    it_behaves_like "raising NameError", with: "call"
+
+  end # describe .attribute
+
+  describe ".new" do
+
+    subject { guard }
+
+    it { is_expected.to be_frozen }
 
   end # describe .new
 

data/spec/unit/assertion/inversion_spec.rb

@@ -2,9 +2,9 @@
 
 describe Assertion::Inversion do
 
-  before { Adult = Assertion.about(:age) { age >= 18 } }
+  before { IsAdult = Assertion.about(:age) { age >= 18 } }
 
-  let(:assertion)            { Adult.new age: 21              }
+  let(:assertion)            { IsAdult.new age: 21            }
   subject(:inversion)        { described_class.new(assertion) }
   subject(:double_inversion) { described_class.new(inversion) }
 
@@ -40,7 +40,7 @@ describe Assertion::Inversion do
 
     context "for the truthy state" do
 
-      it "is equal to wrong assertion" do
+      it "is equal to falsey assertion" do
         expect(inversion.message(true)).to eql assertion.message(false)
       end
 
@@ -52,7 +52,7 @@ describe Assertion::Inversion do
 
     context "for the falsey state" do
 
-      it "is equal to right assertion" do
+      it "is equal to truthy assertion" do
         expect(inversion.message(false)).to eql assertion.message(true)
       end
 
@@ -84,6 +84,6 @@ describe Assertion::Inversion do
 
   end # describe #call
 
-  after { Object.send :remove_const, :Adult }
+  after { Object.send :remove_const, :IsAdult }
 
 end # describe Assertion::Inversion

data/spec/unit/assertion/inverter_spec.rb

@@ -3,7 +3,7 @@
 describe Assertion::Inverter do
 
   let(:source) do
-    Man = Assertion.about(:age, :gender) { age.to_i >= 18 && gender == :male }
+    IsMan = Assertion.about(:age, :gender) { age.to_i >= 18 && gender == :male }
   end
 
   subject(:inverter) { described_class.new source }
@@ -75,6 +75,6 @@ describe Assertion::Inverter do
 
   end # describe #[]
 
-  after { Object.send :remove_const, :Man }
+  after { Object.send :remove_const, :IsMan }
 
 end # describe Assertion::Inverter

data/spec/unit/assertion/translator_spec.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+describe Assertion::Translator do
+
+  before { class IsFoo; end }
+  after  { Object.send :remove_const, :IsFoo }
+
+  subject(:translator) { described_class.new(IsFoo) }
+
+  describe ".new" do
+
+    it { is_expected.to be_frozen }
+
+  end # describe .new
+
+  describe "#assertion" do
+
+    subject { translator.assertion }
+    it { is_expected.to eql IsFoo }
+
+  end # describe #assertion
+
+  describe "#scope" do
+
+    subject { translator.scope }
+    it { is_expected.to eql [:assertion, :is_foo] }
+
+  end # describe #scope
+
+  describe "#call" do
+
+    shared_examples "translating" do |input, to: nil|
+
+      subject { translator.call(input) }
+
+      let(:attributes) { { foo: :FOO, bar: :BAR } }
+      let(:output) { "translation missing: en.assertion.is_foo.#{to}" }
+
+      it "provides translation" do
+        expect(translator.call input).to eql output
+      end
+
+      it "makes arguments available" do
+        expect(I18n).to receive(:translate) do |_, args|
+          expect(args.merge(attributes)).to eql args
+        end
+        translator.call input, attributes
+      end
+
+    end # shared examples
+
+    it_behaves_like "translating", true,  to: "truthy"
+    it_behaves_like "translating", false, to: "falsey"
+
+  end # describe #call
+
+end # describe Assertion::Translator

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assertion
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-20 00:00:00.000000000 Z
+date: 2015-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: transproc
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -100,34 +106,33 @@ files:
 - config/metrics/simplecov.yml
 - config/metrics/yardstick.yml
 - lib/assertion.rb
-- lib/assertion/attributes.rb
 - lib/assertion/base.rb
+- lib/assertion/base_dsl.rb
+- lib/assertion/dsl.rb
 - lib/assertion/guard.rb
+- lib/assertion/guard_dsl.rb
+- lib/assertion/inflector.rb
 - lib/assertion/invalid_error.rb
 - lib/assertion/inversion.rb
 - lib/assertion/inverter.rb
-- lib/assertion/messages.rb
 - lib/assertion/state.rb
-- lib/assertion/transprocs/inflector.rb
-- lib/assertion/transprocs/list.rb
+- lib/assertion/translator.rb
 - lib/assertion/version.rb
 - spec/integration/assertion_spec.rb
 - spec/integration/guard_spec.rb
 - spec/shared/en.yml
 - spec/shared/i18n.rb
 - spec/spec_helper.rb
-- spec/unit/assertion/attributes_spec.rb
 - spec/unit/assertion/base_spec.rb
-- spec/unit/assertion/exceptions/invalid_error_spec.rb
 - spec/unit/assertion/guard_spec.rb
+- spec/unit/assertion/inflector/to_path_spec.rb
+- spec/unit/assertion/inflector/to_snake_path_spec.rb
+- spec/unit/assertion/inflector/to_snake_spec.rb
+- spec/unit/assertion/invalid_error_spec.rb
 - spec/unit/assertion/inversion_spec.rb
 - spec/unit/assertion/inverter_spec.rb
-- spec/unit/assertion/messages_spec.rb
 - spec/unit/assertion/state_spec.rb
-- spec/unit/assertion/transprocs/inflector/to_path_spec.rb
-- spec/unit/assertion/transprocs/inflector/to_snake_path_spec.rb
-- spec/unit/assertion/transprocs/inflector/to_snake_spec.rb
-- spec/unit/assertion/transprocs/list/symbolize_spec.rb
+- spec/unit/assertion/translator_spec.rb
 - spec/unit/assertion_spec.rb
 homepage: https://github.com/nepalez/assertion
 licenses:
@@ -158,17 +163,15 @@ test_files:
 - spec/integration/assertion_spec.rb
 - spec/integration/guard_spec.rb
 - spec/unit/assertion_spec.rb
+- spec/unit/assertion/invalid_error_spec.rb
 - spec/unit/assertion/state_spec.rb
-- spec/unit/assertion/transprocs/inflector/to_snake_path_spec.rb
-- spec/unit/assertion/transprocs/inflector/to_snake_spec.rb
-- spec/unit/assertion/transprocs/inflector/to_path_spec.rb
-- spec/unit/assertion/transprocs/list/symbolize_spec.rb
-- spec/unit/assertion/exceptions/invalid_error_spec.rb
-- spec/unit/assertion/messages_spec.rb
+- spec/unit/assertion/inflector/to_snake_path_spec.rb
+- spec/unit/assertion/inflector/to_snake_spec.rb
+- spec/unit/assertion/inflector/to_path_spec.rb
+- spec/unit/assertion/translator_spec.rb
 - spec/unit/assertion/inverter_spec.rb
 - spec/unit/assertion/inversion_spec.rb
 - spec/unit/assertion/guard_spec.rb
-- spec/unit/assertion/attributes_spec.rb
 - spec/unit/assertion/base_spec.rb
 - spec/shared/i18n.rb
 has_rdoc: 

data/lib/assertion/attributes.rb

@@ -1,54 +0,0 @@
-# encoding: utf-8
-
-module Assertion
-
-  # Module Attributes provides features to define and store a list of attributes
-  # shared by the [Assertion::Base] and [Assertion::Guard] classes
-  #
-  module Attributes
-
-    # List of attributes, defined for the class
-    #
-    # @return [Array<Symbol>]
-    #
-    def attributes
-      @attributes ||= []
-    end
-
-    # Adds a new attribute or a list of attributes to the class
-    #
-    # @param [Symbol, Array<Symbol>] names
-    #
-    # @return [undefined]
-    #
-    # @raise [NameError]
-    #   When the name is either used by instance attribute,
-    #   or forbidden as a name of the method to be implemented later
-    #   (not as an attribute)
-    #
-    def attribute(*names)
-      @attributes = List[:symbolize][attributes + names]
-      __check_attributes__
-    end
-
-    private
-
-    # Names of the methods that should be reserved to be used later
-    #
-    # @return [Array<Symbol>]
-    #
-    # @abstract
-    #
-    def __forbidden_attributes__
-      []
-    end
-
-    def __check_attributes__
-      names = attributes & (instance_methods + __forbidden_attributes__)
-      return if names.empty?
-      fail NameError.new "Wrong name(s) for attribute(s): #{names.join(", ")}"
-    end
-
-  end # module Attributes
-
-end # module Assertion

data/lib/assertion/messages.rb

@@ -1,65 +0,0 @@
-# encoding: utf-8
-
-require "i18n"
-
-module Assertion
-
-  # Module Messages provides a feature for gem-specific translation of messages
-  # describing the desired state of the assertion
-  #
-  # You need to declare a hash of attributes to be added to the translation.
-  #
-  # @example
-  #   class MyClass
-  #     include Assertion::Messages
-  #     def attributes
-  #       {}
-  #     end
-  #   end
-  #
-  #   item = MyClass.new
-  #   item.message(true)
-  #   # => "translation missing: en.assertion.my_class.right"
-  #   item.message(false)
-  #   # => "translation missing: en.assertion.my_class.wrong"
-  #
-  # @author Andrew Kozin <Andrew.Kozin@gmail.com>
-  #
-  module Messages
-
-    # The gem-specific root scope for translations
-    #
-    # @return [Symbol]
-    #
-    ROOT = :assertion
-
-    # The states to be translated with their dictionary names
-    #
-    # @return [Hash<Object => Symbol>]
-    #
-    DICTIONARY = { true => :right, false => :wrong }
-
-    # Returns the message describing the desired state of assertion
-    #
-    # The translation is provided for the gem-specific scope for the
-    # current class
-    #
-    # @param [Boolean] state <description>
-    #
-    # @return [String] The translation
-    #
-    def message(state)
-      key   = DICTIONARY[state]
-      scope = [ROOT, Inflector[:to_snake_path][self.class.name]]
-
-      I18n.translate key, attributes.merge(scope: scope)
-    end
-
-    # @private
-    def attributes
-      {}
-    end
-
-  end # module Messages
-
-end # module Assertion

data/lib/assertion/transprocs/list.rb

@@ -1,30 +0,0 @@
-module Assertion
-
-  # The collection of pure functions for converting arrays
-  #
-  # @api private
-  #
-  module List
-
-    extend ::Transproc::Registry
-
-    # Converts the nested array of strings and symbols into the flat
-    # array of unique symbols
-    #
-    # @example
-    #   fn = List[:symbolize]
-    #   source = [:foo, ["foo", "bar"], :bar, "baz"]
-    #   fn[source]
-    #   # => [:foo, :bar, :baz]
-    #
-    # @param [Array<String, Symbol, Array>] array
-    #
-    # @return [Array<Symbol>]
-    #
-    def symbolize(array)
-      array.flatten.map(&:to_sym).uniq
-    end
-
-  end # module List
-
-end # module Assertion

data/spec/unit/assertion/attributes_spec.rb

@@ -1,97 +0,0 @@
-# encoding: utf-8
-
-describe Assertion::Attributes do
-
-  subject(:klass) do
-    class Test
-      extend Assertion::Attributes
-      attr_reader :baz, :qux
-    end
-
-    Test
-  end
-
-  describe "#attributes" do
-
-    subject { klass.attributes }
-
-    it { is_expected.to eql [] }
-
-  end # describe #attributes
-
-  describe "#attribute" do
-
-    context "single attribute" do
-
-      subject do
-        klass.attribute "foo"
-        klass.attribute "bar"
-      end
-
-      it "register the attribute" do
-        expect { subject }.to change { klass.attributes }.to [:foo, :bar]
-      end
-
-    end # context
-
-    context "list of attributes" do
-
-      subject { klass.attribute :foo, :bar }
-
-      it "register the attributes" do
-        expect { subject }.to change { klass.attributes }.to [:foo, :bar]
-      end
-
-    end # context
-
-    context "array of attributes" do
-
-      subject { klass.attribute %w(foo bar) }
-
-      it "register the attributes" do
-        expect { subject }.to change { klass.attributes }.to [:foo, :bar]
-      end
-
-    end # context
-
-    context "name of instance method" do
-
-      subject { klass.attribute :baz, :qux }
-
-      it "raises NameError" do
-        expect { subject }.to raise_error do |error|
-          expect(error).to be_kind_of NameError
-          expect(error.message)
-            .to eql "Wrong name(s) for attribute(s): baz, qux"
-        end
-      end
-
-    end # context
-
-    context "forbidden attribute" do
-
-      before do
-        class Test
-          def self.__forbidden_attributes__
-            [:foo, :bar]
-          end
-        end
-      end
-
-      subject { klass.attribute :foo, :bar }
-
-      it "raises NameError" do
-        expect { subject }.to raise_error do |error|
-          expect(error).to be_kind_of NameError
-          expect(error.message)
-            .to eql "Wrong name(s) for attribute(s): foo, bar"
-        end
-      end
-
-    end # context
-
-  end # describe #attributes
-
-  after { Object.send :remove_const, :Test }
-
-end # describe Assertion::Attributes