assertion 0.0.1 → 0.1.0

data/lib/assertion/{exceptions/invalid_error.rb → invalid_error.rb}

@@ -21,7 +21,6 @@ module Assertion
     # @private
     def initialize(*messages)
       @messages = messages.flatten.freeze
-      super
       freeze
     end
 
@@ -31,6 +30,11 @@ module Assertion
     #
     attr_reader :messages
 
+    # @private
+    def inspect
+      "<#{self} @messages=#{messages}>"
+    end
+
   end # class InvalidError
 
 end # module Assertion

data/lib/assertion/inversion.rb

@@ -48,7 +48,7 @@ module Assertion
     # @return [String]
     #
     def message(state = nil)
-      assertion.message(!state)
+      assertion.message !state
     end
 
     # Checks the current state of the assertion

data/lib/assertion/messages.rb

@@ -0,0 +1,65 @@
+# 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/state.rb

@@ -52,7 +52,7 @@ module Assertion
     # @return [true]
     #
     # @raise [Assertion::InvalidError]
-    #   When a assertion is not satisfied (validation fails)
+    #   When an assertion is not satisfied (validation fails)
     #
     def validate!
       invalid? ? fail(InvalidError.new messages) : true

data/lib/assertion/transprocs/inflector.rb

@@ -5,6 +5,8 @@ module Assertion
   #
   # @api private
   #
+  # @todo Extract this module to the external gem `transproc-inflector`
+  #
   module Inflector
 
     extend ::Transproc::Registry

data/lib/assertion/version.rb

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

data/spec/integration/assertion_spec.rb

@@ -1,19 +1,10 @@
 # encoding: utf-8
 
-describe Assertion do
-
-  let(:load_path) { Dir[File.expand_path "../*.yml", __FILE__] }
-
-  around do |example|
-    old_locale, I18n.locale = I18n.locale, :en
-    old_path, I18n.load_path = I18n.load_path, load_path
-    I18n.backend.load_translations
+require "shared/i18n"
 
-    example.run
+describe Assertion do
 
-    I18n.locale    = old_locale
-    I18n.load_path = old_path
-  end
+  include_context "preloaded translations"
 
   it "works" do
     IsMale = Assertion.about :name, :gender do

data/spec/integration/guard_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+require "ostruct"
+require "shared/i18n"
+
+describe Assertion do
+
+  include_context "preloaded translations"
+
+  it "works" do
+    IsAdult = Assertion.about :name, :age do
+      age.to_i >= 18
+    end
+
+    AdultOnly = Assertion.guards :user do
+      IsAdult[user]
+    end
+
+    andrew = OpenStruct.new(name: "Andrew", age: 13, city: "Moscow")
+    andriy = OpenStruct.new(name: "Andriy", age: 28, city: "Kiev")
+
+    expect { AdultOnly[andrew] }.to raise_error Assertion::InvalidError
+    expect(AdultOnly[andriy]).to eql andriy
+  end
+
+  after { Object.send :remove_const, :AdultOnly }
+  after { Object.send :remove_const, :IsAdult   }
+
+end # describe Assertion

data/spec/{integration → shared}/en.yml

@@ -7,4 +7,4 @@ en:
       wrong: "%{name} is a child (age %{age})"
     is_male:
       right: "%{name} is a male"
-      wrong: "%{name} is a female"
+      wrong: "%{name} is a female"

data/spec/shared/i18n.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+shared_context "preloaded translations" do
+
+  around do |example|
+
+    load_path = Dir[File.expand_path "../*.yml", __FILE__]
+
+    old_locale, I18n.locale = I18n.locale, :en
+    old_path, I18n.load_path = I18n.load_path, load_path
+    I18n.backend.load_translations
+
+    example.run
+
+    I18n.locale    = old_locale
+    I18n.load_path = old_path
+    I18n.backend.reload!
+
+  end
+
+end # shared context

data/spec/unit/assertion/attributes_spec.rb

@@ -0,0 +1,97 @@
+# 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

data/spec/unit/assertion/base_spec.rb

@@ -5,69 +5,13 @@ describe Assertion::Base do
   let(:klass) { Class.new(described_class) }
   before { allow(klass).to receive(:name) { "Test" } }
 
-  describe ".attributes" do
+  it "can declare attributes" do
+    expect(klass).to be_kind_of Assertion::Attributes
+  end
 
-    subject(:attributes) { klass.attributes }
-
-    it { is_expected.to eql [] }
-
-  end # describe .attributes
-
-  describe ".attribute" do
-
-    subject(:attribute) { klass.attribute names }
-
-    context "with valid name" do
-
-      let(:names) { :foo }
-
-      it "defines the attribute" do
-        expect { subject }
-          .to change { klass.attributes }
-          .to [:foo]
-      end
-
-    end # context
-
-    context "with array of names" do
-
-      let(:names) { [:foo, "bar", "foo"] }
-
-      it "defines the attribute" do
-        expect { subject }
-          .to change { klass.attributes }
-          .to [:foo, :bar]
-      end
-
-    end # context
-
-    context "with a :check name" do
-
-      let(:names) { [:check] }
-
-      it "fails" do
-        expect { subject }.to raise_error do |error|
-          expect(error).to be_kind_of Assertion::NameError
-          expect(error.message).to include "check"
-        end
-      end
-
-    end # context
-
-    context "with a :call name" do
-
-      let(:names) { [:call] }
-
-      it "fails" do
-        expect { subject }.to raise_error do |error|
-          expect(error).to be_kind_of Assertion::NameError
-          expect(error.message).to include "call"
-        end
-      end
-
-    end # context
-
-  end # describe .attribute
+  it "can translate states" do
+    expect(klass).to include Assertion::Messages
+  end
 
   describe ".new" do
 
@@ -139,47 +83,6 @@ describe Assertion::Base do
 
   end # describe #attributes
 
-  describe "#message" do
-
-    let(:assertion) { klass.new }
-
-    context "for the truthy state" do
-
-      subject { assertion.message(true) }
-      it { is_expected.to eql "translation missing: en.assertion.test.right" }
-
-    end # context
-
-    context "for the falsey state" do
-
-      subject { assertion.message(false) }
-      it { is_expected.to eql "translation missing: en.assertion.test.wrong" }
-
-    end # context
-
-    context "by default" do
-
-      it "returns the message for the falsey state" do
-        expect(assertion.message).to eql assertion.message(false)
-      end
-
-    end # context
-
-  end # describe #message
-
-  describe "#check" do
-
-    subject { klass.new.check }
-
-    it "raises NotImplementedError" do
-      expect { subject }.to raise_error do |error|
-        expect(error).to be_kind_of Assertion::NotImplementedError
-        expect(error.message).to include("Test#check ")
-      end
-    end
-
-  end # describe #check
-
   describe "#call" do
 
     subject { assertion.call }

data/spec/unit/assertion/exceptions/invalid_error_spec.rb

@@ -13,16 +13,6 @@ describe Assertion::InvalidError do
 
   end # describe .new
 
-  describe "#message" do
-
-    subject { error.message }
-
-    it "returns a proper message" do
-      expect(subject).to include "#{messages.inspect}"
-    end
-
-  end # describe #message
-
   describe "#messages" do
 
     subject { error.messages }
@@ -37,4 +27,15 @@ describe Assertion::InvalidError do
 
   end # describe #message
 
+  describe "#inspect" do
+
+    subject { error.inspect }
+
+    it "returns a verbose string" do
+      expect(subject)
+        .to eql "<Assertion::InvalidError @messages=[\"foo\", \"bar\"]>"
+    end
+
+  end # describe #inspect
+
 end # describe Assertion::InvalidError