assertion 0.0.1 → 0.1.0

data/spec/unit/assertion/guard_spec.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+
+require "ostruct"
+
+describe Assertion::Guard do
+
+  before do
+    IsAdult   = Assertion.about(:age) { age.to_i >= 18 }
+    AdultOnly = Class.new(described_class) { def state; IsAdult[object]; end }
+  end
+
+  let(:valid)   { OpenStruct.new(name: "Joe", age: 40) }
+  let(:invalid) { OpenStruct.new(name: "Ian", age: 10) }
+  let(:guard)   { AdultOnly.new valid     }
+
+  it "can declare attributes" do
+    expect(AdultOnly).to be_kind_of Assertion::Attributes
+  end
+
+  describe ".new" do
+
+    subject { guard }
+
+    it { is_expected.to be_frozen }
+
+    context "with an attriubute" do
+
+      before { allow(AdultOnly).to receive(:attributes) { [:foo] } }
+
+      it "adds the alias to the #object" do
+        expect(subject.foo).to eql subject.object
+      end
+
+    end # context
+
+  end # describe .new
+
+  describe ".[]" do
+
+    it "returns the result of the call" do
+      expect(AdultOnly[valid]).to eql valid
+      expect { AdultOnly[invalid] }.to raise_error Assertion::InvalidError
+    end
+
+  end # describe .[]
+
+  describe "#object" do
+
+    subject { guard.object }
+
+    it { is_expected.to eql valid }
+
+  end # describe #object
+
+  describe "#call" do
+
+    subject { guard.call }
+
+    context "when #state is valid" do
+
+      it { is_expected.to eql valid }
+
+    end # context
+
+    context "when #state is invalid" do
+
+      let(:guard) { AdultOnly.new invalid }
+
+      it "raises InvalidError" do
+        expect { subject }.to raise_error Assertion::InvalidError
+      end
+
+    end # context
+
+  end # describe #call
+
+  after do
+    Object.send :remove_const, :AdultOnly
+    Object.send :remove_const, :IsAdult
+  end
+
+end # describe Assertion::Guard

data/spec/unit/assertion/messages_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+describe Assertion::Messages, "#message" do
+
+  let(:test_klass)  { Test = Class.new { include Assertion::Messages } }
+  let(:instance)    { test_klass.new                                   }
+
+  shared_examples "translating" do |state, as: nil|
+
+    subject(:message) { instance.message(state) }
+
+    it { is_expected.to eql "translation missing: en.assertion.test.#{as}" }
+
+    it "sends attributes to translation" do
+      expect(I18n).to receive(:translate) do |_, args|
+        expect(args.merge(instance.attributes)).to eql args
+      end
+      subject
+    end
+
+  end # shared examples
+
+  context "without attributes" do
+
+    it_behaves_like "translating", true,  as: "right"
+    it_behaves_like "translating", false, as: "wrong"
+
+  end # context
+
+  context "with attributes" do
+
+    before { test_klass.send(:define_method, :attributes) { { foo: :FOO } } }
+
+    it_behaves_like "translating", true,  as: "right"
+    it_behaves_like "translating", false, as: "wrong"
+
+  end # context
+
+  after { Object.send :remove_const, :Test }
+
+end # describe Assertion::Messages

data/spec/unit/assertion_spec.rb

@@ -2,18 +2,18 @@
 
 describe Assertion do
 
-  describe ".about" do
+  let(:john) { { age: 17, gender: :male } }
+  let(:jack) { { age: 18, gender: :male } }
 
-    let(:john) { { age: 17, gender: :male } }
-    let(:jack) { { age: 18, gender: :male } }
+  describe ".about" do
 
     context "with attributes and a block" do
 
       subject do
-        Man = Assertion.about(:age, :gender) { age >= 18 && gender == :male }
+        IsMan = Assertion.about(:age, :gender) { age >= 18 && gender == :male }
       end
 
-      it "provides the assertion class" do
+      it "builds the assertion class" do
         expect(subject.superclass).to eql Assertion::Base
       end
 
@@ -27,10 +27,10 @@ describe Assertion do
     context "without attributes" do
 
       subject do
-        Man = Assertion.about { true }
+        IsMan = Assertion.about { true }
       end
 
-      it "provides the assertion class" do
+      it "builds the assertion class" do
         expect(subject.superclass).to eql Assertion::Base
       end
 
@@ -44,22 +44,79 @@ describe Assertion do
     context "without a block" do
 
       subject do
-        Man = Assertion.about(:age, :gender)
+        IsMan = Assertion.about(:age, :gender)
       end
 
-      it "provides the assertion class" do
+      it "builds the assertion class" do
         expect(subject.superclass).to eql Assertion::Base
       end
 
       it "doesn't implement the #check method" do
-        expect { subject[jack] }
-          .to raise_error Assertion::NotImplementedError
+        expect { subject.new(jack).check }.to raise_error NoMethodError
       end
 
     end # context
 
-    after { Object.send :remove_const, :Man }
+    after { Object.send :remove_const, :IsMan }
 
   end # describe .about
 
+  describe ".guards" do
+
+    before { IsAdult = Assertion.about(:age) { age.to_i >= 18 } }
+
+    context "with an attribute and a block" do
+
+      subject { Assertion.guards(:user) { IsAdult[user] } }
+
+      it "builds the guard class" do
+        expect(subject.superclass).to eql Assertion::Guard
+      end
+
+      it "defines an alias for the object" do
+        expect(subject.new(jack).user).to eql jack
+      end
+
+      it "implements the #state" do
+        expect { subject.new(jack).state }.not_to raise_error
+      end
+
+    end # context
+
+    context "without an attribute" do
+
+      subject { Assertion.guards { IsAdult[object] } }
+
+      it "builds the guard class" do
+        expect(subject.superclass).to eql Assertion::Guard
+      end
+
+      it "implements the #state of #object" do
+        expect { subject.new(jack).state }.not_to raise_error
+      end
+
+    end # context
+
+    context "without a block" do
+
+      subject { Assertion.guards(:user) }
+
+      it "builds the guard class" do
+        expect(subject.superclass).to eql Assertion::Guard
+      end
+
+      it "defines an alias for the object" do
+        expect(subject.new(jack).user).to eql jack
+      end
+
+      it "doesn't implement the #state" do
+        expect { subject.new(jack).state }.to raise_error NoMethodError
+      end
+
+    end # context
+
+    after { Object.send :remove_const, :IsAdult   }
+
+  end # describe .guards
+
 end # describe Assertion

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assertion
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2015-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: transproc
@@ -81,6 +81,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
@@ -99,29 +100,30 @@ files:
 - config/metrics/simplecov.yml
 - config/metrics/yardstick.yml
 - lib/assertion.rb
+- lib/assertion/attributes.rb
 - lib/assertion/base.rb
-- lib/assertion/exceptions/invalid_error.rb
-- lib/assertion/exceptions/name_error.rb
-- lib/assertion/exceptions/not_implemented_error.rb
+- lib/assertion/guard.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/i18n.rb
 - lib/assertion/transprocs/inflector.rb
 - lib/assertion/transprocs/list.rb
 - lib/assertion/version.rb
 - spec/integration/assertion_spec.rb
-- spec/integration/en.yml
+- 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/exceptions/name_error_spec.rb
-- spec/unit/assertion/exceptions/not_implemented_error_spec.rb
+- spec/unit/assertion/guard_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/i18n/to_scope_spec.rb
-- spec/unit/assertion/transprocs/i18n/translate_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
@@ -154,18 +156,19 @@ summary: PORO assertions and validation
 test_files:
 - spec/spec_helper.rb
 - spec/integration/assertion_spec.rb
+- spec/integration/guard_spec.rb
 - spec/unit/assertion_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/i18n/to_scope_spec.rb
-- spec/unit/assertion/transprocs/i18n/translate_spec.rb
 - spec/unit/assertion/transprocs/list/symbolize_spec.rb
 - spec/unit/assertion/exceptions/invalid_error_spec.rb
-- spec/unit/assertion/exceptions/not_implemented_error_spec.rb
-- spec/unit/assertion/exceptions/name_error_spec.rb
+- spec/unit/assertion/messages_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/exceptions/name_error.rb

@@ -1,29 +0,0 @@
-# encoding: utf-8
-
-module Assertion
-
-  # The exception to be raised when a Assertion attribute uses reserved name(s)
-  #
-  # @api public
-  #
-  class NameError < ::NameError
-
-    # @!scope class
-    # @!method new(*names)
-    # Creates an exception instance
-    #
-    # @param [Symbol, Array<Symbol>] names Wrong names of attribute(s)
-    #
-    # @return [Assertion::NameError]
-    #
-    # @api private
-
-    # @private
-    def initialize(*names)
-      super "Wrong name(s) for attribute(s): #{names.join(", ")}"
-      freeze
-    end
-
-  end # class NameError
-
-end # module Assertion

data/lib/assertion/exceptions/not_implemented_error.rb

@@ -1,29 +0,0 @@
-# encoding: utf-8
-
-module Assertion
-
-  # The exception to be raised when a assertion is applied to some data
-  # before its `check` method has been implemented
-  #
-  # @api public
-  #
-  class NotImplementedError < ::NotImplementedError
-
-    # @!scope class
-    # @!method new(klass, name)
-    # Creates an exception instance
-    #
-    # @param [Class] klass The class that should implement the instance method
-    # @param [Symbol] name The name of the method to be implemented
-    #
-    # @return [Assertion::NotImplementedError]
-
-    # @private
-    def initialize(klass, name)
-      super "#{klass.name}##{name} method not implemented"
-      freeze
-    end
-
-  end # class NotImplementedError
-
-end # module Assertion

data/lib/assertion/transprocs/i18n.rb

@@ -1,55 +0,0 @@
-module Assertion
-
-  # The collection of pure functions for translating strings in the gem-specific
-  # scopes of `Assertion::Base` subclasses.
-  #
-  # @api private
-  #
-  module I18n
-
-    extend ::Transproc::Registry
-
-    uses :to_snake_path, from: Inflector, as: :snake
-
-    # Converts the name of the class to the corresponding gem-specific scope
-    #
-    # @example
-    #   fn = I18n[:scope]
-    #   fn["Foo::BarBaz"]
-    #   # => [:assertion, :"foo/bar_baz"]
-    #
-    # @param [String] name The name of the class
-    #
-    # @return [Array<Symbol>] The `I18n`-compatible gem-specific scope
-    #
-    def scope(name)
-      [:assertion, snake(name).to_sym]
-    end
-
-    # Translates the key with hash of attributes in a given scope
-    #
-    # @example
-    #   # config/locales/en.yml
-    #   # ---
-    #   # en:
-    #   #   assertion:
-    #   #     foo:
-    #   #       qux: "message %{bar}"
-    #
-    #   fn = I18n[:translate, [:assertion, :foo], bar: :BAZ]
-    #   fn[:qux]
-    #   # => "message BAZ"
-    #
-    # @param [key] key The key to be translated
-    # @param [Array<Symbol>] scope The I18n scope for the translations
-    # @param [Hash] hash The hash of attributes for the translation
-    #
-    # @return [String] The translated string
-    #
-    def translate(key, scope, hash)
-      ::I18n.t(key, hash.merge(scope: scope))
-    end
-
-  end # module I18n
-
-end # module Assertion