assertion 0.2.3 → 0.2.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    Mzk3MGE0ZjJjODM1Y2YxNzAyOGQzZjY0Yzk2N2YwZTVjZDI2NWI2OA==
-  data.tar.gz: !binary |-
-    NzUwZjQ2NDA5MzM5NDU5MmJiMWU3NGQ3ZThlM2Q3MjM2MDM2OTM5MQ==
+SHA1:
+  metadata.gz: 65ecfa1663da2ccf5c270513980850376ab8b4f4
+  data.tar.gz: f30f44133b412b3d8162f335c3662ff1abab40a5
 SHA512:
-  metadata.gz: !binary |-
-    NDRhZjI5ZmY3MWMwNzQ3NTRhOWVhOTczYjE0OTliNGI2NDZjYjg3MWI1Nzgx
-    ZjE5OWUyODAzMDFmMDYxOTcwMDc1M2MxZjMwOThiODhjYjI0ZDBiZmQ4ODcy
-    MjdkNmFkMmQxMDhiMjJjOTUyMmM0MTQ1ZTdkODg2ODFhZmE3ZGM=
-  data.tar.gz: !binary |-
-    ZDkyMjZkNDk3NzhhYjExYTBmNzlkY2U1YjkxMzg1ZTQwYjMwMTRjMzZkN2Rj
-    MDBlMTFjMzBjNGU5MmY3ZTI4OWMwOGQ1MTE1ZDM1MzY0MTg5ZDdjMzNmMjAx
-    NjM3YWRhNGVmYjE2NzZhNmRlMzFlZTU2YTQ1YzE5NzFiYmEwNmM=
+  metadata.gz: 561a3f4d22029666cfe4bec2d720792a562c4ca11f7de8ec088dc54eba998c243fea503d6a5ef98aa0272e34c6e376a7b9e7a994a1dbb4ee2444f45788f6e28a
+  data.tar.gz: 3e46a54c25ebc71033efad3fdf676436cd8f64534206a2e4bbb849ca8c47e5ef465ee7dd6c60add7052d4c806d80766f17570d6260dc4bc7738de33268c1edcd

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## v0.2.4 2015-07-31
+
+### Added
+
+* Support for inline messages definition via `#falsey` and `#truthy` methods (nepalez)
+* Alias method `!` for assertion `not` inverter (nepalez)
+
+### Internal
+
+* Moved names `:falsey` and `:truthy` from `Translator` to `Base` (nepalez)
+
+[Compare v0.2.3...v0.2.4](https://github.com/nepalez/assertion/compare/v0.2.3...v0.2.4)
+
 ## v0.2.3 2015-07-12
 
 The version is bumped to fix bugs that proved to be hidden because of bugs in hexx-rspec and hexx-suit gems.

data/README.md

@@ -17,16 +17,16 @@ Assertion
 
 Standalone PORO assertions and validations.
 
-Synopsis
---------
-
 The primary goal of the gem is to make standalone assertions about objects and validate them.
 
 No monkey patching, no dependency from ActiveSupport, no mutable instances of any class.
 
 [About](https://github.com/mbj/mutant/issues/356) 100% [mutant]-covered.
 
-### Basic Usage
+Synopsis
+--------
+
+### Make an Assertion
 
 Define an assertion by inheriting it from the `Assertion::Base` class with attributes to which it should be applied.
 Then implement the method `check` to describe if the assertion is truthy or falsey.
@@ -43,7 +43,7 @@ class IsAdult < Assertion::Base
 end
 ```
 
-or with more verbose builder:
+or with more expressive builder:
 
 ```ruby
 IsAdult = Assertion.about :age, :name do
@@ -51,6 +51,8 @@ IsAdult = Assertion.about :age, :name do
 end
 ```
 
+### Add Messages
+
 Define translations to describe both the *truthy* and *falsey* states of the assertion.
 
 All the attributes are available in translations (that's why we declared the `name` as an attribute):
@@ -65,6 +67,28 @@ en:
       falsey: "%{name} is a child yet (age %{age})"
 ```
 
+If you don't need to translate messages, define them for `truthy` and `falsey` states as methods:
+
+```ruby
+class IsAdult < Assertion::Base
+  attribute :age, :name
+
+  def check
+    age.to_i >= 18
+  end
+
+  def truthy
+    "#{name} is already an adult (age #{age})"
+  end
+
+  def falsey
+    "#{name} is a child yet (age #{age})"
+  end
+end
+```
+
+### Check a State
+
 Check a state of an assertion for some argument(s), using class method `[]`:
 
 ```ruby
@@ -86,7 +110,7 @@ state.validate! # => #<Assertion::InvalidError @messages=["John is a child yet (
 Inversion
 ---------
 
-Use the `.not` *class* method to negate the assertion:
+Use the `.not` *class* method to invert the assertion:
 
 ```ruby
 jack = { name: 'Jack', age: 21, gender: :male }
@@ -95,6 +119,16 @@ IsAdult.not[jack]
 # => #<Assertion::State @state=false, @messages=["Jack is already an adult (age 21)"]>
 ```
 
+You can also use `!` alias to provide the inversion:
+
+```ruby
+IsChild = !IsAdult
+IsChild[jack]
+# => #<Assertion::State @state=false, @messages=["Jack is already an adult (age 21)"]>
+```
+
+Notice that `!IsAdult[jack]` wouldn't work. Use either `IsAdult.not[jack]`, or `(!IsAdult)[jack]`.
+
 Composition
 -----------
 
@@ -116,7 +150,7 @@ en:
       falsey: "%{name} is a female"
 ```
 
-Use method `&` (or its aliases `+` or `>>`) to compose assertion states:
+Use method `&` (or its alias `+`) to compose assertion states:
 
 ```ruby
 jane = { name: 'Jane', age: 16, gender: :female }
@@ -142,7 +176,7 @@ class VoterOnly < Assertion::Guard
 end
 ```
 
-Or using the verbose builder `Assertion.guards`:
+Or using the builder `Assertion.guards`:
 
 ```ruby
 VoterOnly = Assertion.guards :user do

data/Rakefile

@@ -21,5 +21,5 @@ end
 
 desc "Runs mutation metric for testing"
 task :mutant do
-  system "mutant -r ./spec/spec_helper --use rspec 'Assertion*'"
+  system "bundle exec mutant -r ./spec/spec_helper --use rspec 'Assertion*'"
 end

data/lib/assertion/base.rb

@@ -89,7 +89,9 @@ module Assertion
     # @return [String]
     #
     def message(state = nil)
-      self.class.translate(state, attributes)
+      msg = state ? :truthy : :falsey
+      return public_send(msg) if respond_to? msg
+      self.class.translate(msg, attributes)
     end
 
     # Calls the assertion checkup and returns the resulting state

data/lib/assertion/dsl/attribute.rb

@@ -25,13 +25,26 @@ module Assertion
         alias_method name, :object
       end
 
-      # @private
+      private
+
+      # Ensures the `#object` is defined
+      #
+      # @param [Class] klass
+      #
+      # @return [undefined]
+      #
       def self.extended(klass)
         klass.__send__ :attr_reader, :object
       end
 
-      private
-
+      # Checks if alias name for `#object` is free
+      #
+      # @param [#to_sym] key
+      #
+      # @return [undefined]
+      #
+      # @raise [NameError] if the key is already in use
+      #
       def __check_attribute__(key)
         return unless (instance_methods << :state).include? key.to_sym
         fail NameError.new "#{self}##{key} is already defined"

data/lib/assertion/dsl/attributes.rb

@@ -39,8 +39,8 @@ module Assertion
 
       def __add_attribute__(name)
         __check_attribute__(name)
-        define_method(name) { attributes[name] }
-        attributes << name.to_sym
+        define_method(name) { attributes.fetch(name) }
+        attributes << name
       end
 
       def __check_attribute__(name)

data/lib/assertion/dsl/inversion.rb

@@ -28,6 +28,7 @@ module Assertion
       def not
         Inverter.new(self)
       end
+      alias_method :!, :not
 
     end # module Inversion
 

data/lib/assertion/guard.rb

@@ -35,6 +35,12 @@ module Assertion
     extend DSL::Attribute
     extend DSL::Caller
 
+    # @!attribute [r] object
+    #
+    # @return [Object] The object to be guarded
+    #
+    attr_reader :object
+
     # @!scope class
     # @!method new(object)
     # Creates the guard instance for the provided object

data/lib/assertion/rspec.rb

@@ -6,17 +6,17 @@
 
 shared_context :assertion_translations do
 
-  def lang
+  def __locale__
     defined?(locale) ? locale : :en
   end
 
   # allows to skip check for error messages
-  def errors
+  def __messages__
     defined?(messages) ? Array[*messages] : nil
   end
 
   around do |example|
-    old, I18n.locale = I18n.locale, lang
+    old, I18n.locale = I18n.locale, __locale__
     example.run
     I18n.locale = old
   end
@@ -48,38 +48,38 @@ end # shared context
 shared_examples :validating_attributes do
 
   # allows to skip `assertion` definition when described_class is defined
-  def klass
+  def __assertion__
     defined?(assertion) ? assertion : described_class
   end
 
   # allows to skip `valid` definition to test messages only
-  def result
+  def __valid__
     defined?(valid) ? valid : false
   end
 
-  subject(:state) { klass[attributes] }
+  subject(:state) { __assertion__[attributes] }
 
   include_context :assertion_translations
 
   it "[validates]" do
-    expect(state.valid?).to eql(result), <<-REPORT.gsub(/.+\|/, "")
+    expect(state.valid?).to eql(__valid__), <<-REPORT.gsub(/.+\|/, "")
       |
-      |#{klass}[#{attributes.to_s[1..-2]}]
+      |#{__assertion__}[#{attributes.to_s[1..-2]}]
       |
-      |  expected: to be #{result ? "valid" : "invalid"}
+      |  expected: to be #{__valid__ ? "valid" : "invalid"}
       |       got: #{state.valid? ? "valid" : "invalid"}
     REPORT
   end
 
   it "[raises expected message]" do
-    if !result && state.invalid? && errors
+    if !__valid__ && state.invalid? && __messages__
       expect(state.messages)
-        .to match_array(errors), <<-REPORT.gsub(/.+\|/, "")
+        .to match_array(__messages__), <<-REPORT.gsub(/.+\|/, "")
           |
-          |Language: #{locale.to_s.upcase}
-          |Error messages from #{klass}[#{attributes.to_s[1..-2]}]
+          |Language: #{__locale__.to_s.upcase}
+          |Error messages from #{__assertion__}[#{attributes.to_s[1..-2]}]
           |
-          |  expected: #{errors.inspect}
+          |  expected: #{__messages__.inspect}
           |       got: #{state.messages.inspect}
         REPORT
     end
@@ -102,12 +102,12 @@ end # shared examples
 shared_examples :accepting_object do
 
   # allows to skip `guard` definition when described_class is defined
-  def klass
+  def __guard__
     defined?(guard) ? guard : described_class
   end
 
   # allows to skip `valid` definition to test messages only
-  def result
+  def __accepted__
     defined?(accepted) ? accepted : false
   end
 
@@ -116,11 +116,11 @@ shared_examples :accepting_object do
   include_context :assertion_translations
 
   it "[guards]" do
-    if result
+    if __accepted__
       expect { checkup }
         .not_to raise_error, <<-REPORT.gsub(/.+\|/, "")
           |
-          |#{klass}[#{object.inspect}]
+          |#{__guard__}[#{object.inspect}]
           |
           |  expected: #{object.inspect}
           |       got: #{begin; checkup; rescue => err; err.inspect; end}
@@ -129,7 +129,7 @@ shared_examples :accepting_object do
       expect { checkup }
         .to raise_error(Assertion::InvalidError), <<-REPORT.gsub(/.+\|/, "")
           |
-          |#{klass}[#{object.inspect}]
+          |#{__guard__}[#{object.inspect}]
           |
           |  expected: #<Assertion::InvalidError>
           |       got: #{object.inspect}
@@ -139,15 +139,15 @@ shared_examples :accepting_object do
 
   it "[raises expected message]" do
     begin
-      checkup if !result && errors
+      checkup if !__accepted__ && __messages__
     rescue => err
       expect(err.messages)
-        .to match_array(errors), <<-REPORT.gsub(/.+\|/, "")
+        .to match_array(__messages__), <<-REPORT.gsub(/.+\|/, "")
           |
-          |Language: #{locale.to_s.upcase}
-          |Error messages from #{klass}[#{object.inspect}]
+          |Language: #{__locale__.to_s.upcase}
+          |Error messages from #{__guard__}[#{object.inspect}]
           |
-          |  expected: #{errors.inspect}
+          |  expected: #{__messages__.inspect}
           |       got: #{err.messages.inspect}
         REPORT
     end

data/lib/assertion/state.rb

@@ -2,8 +2,7 @@
 
 module Assertion
 
-  # Describes the state of the assertion applied to given arguments
-  # (the result of the checkup)
+  # Describes the composable state of the assertion
   #
   # @api public
   #

data/lib/assertion/translator.rb

@@ -33,22 +33,6 @@ module Assertion
     #
     ROOT = :assertion
 
-    # The states to be translated with their dictionary names
-    #
-    # @return [Hash<Object => Symbol>]
-    #
-    DICTIONARY = { true => :truthy, false => :falsey }
-
-    # Provides a scope for the class
-    #
-    # @param [Class] klass
-    #
-    # @return [Array<Symbol>]
-    #
-    def self.scope(klass)
-      [ROOT, Inflecto.underscore(klass).to_sym]
-    end
-
     # @!attribute [r] scope
     #
     # @return [Array<Symbol>] the scope for translations
@@ -72,7 +56,7 @@ module Assertion
     # @private
     def initialize(assertion)
       @assertion = assertion
-      @scope = self.class.scope(assertion)
+      @scope = "#{ROOT}.#{Inflecto.underscore assertion}"
       IceNine.deep_freeze(self)
     end
 
@@ -86,7 +70,7 @@ module Assertion
     # @return [String] The translation
     #
     def call(state, args = {})
-      I18n.translate DICTIONARY[state ? true : false], args.merge(scope: scope)
+      I18n.translate state, args.merge(scope: scope)
     end
 
   end # class Translator

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.2.3".freeze
+  VERSION = "0.2.4".freeze
 
 end # module Assertion

data/spec/integration/assertion_spec.rb

@@ -15,22 +15,44 @@ describe Assertion do
       age.to_i >= 18
     end
 
-    jane = { name: "Jane", gender: :female, age: 19 }
+    class IsCat < Assertion::Base
+      attribute :species, :name
+
+      def check
+        species == :cat
+      end
+
+      def truthy
+        "#{name} is a cat"
+      end
+
+      def falsey
+        "#{name} is not a cat"
+      end
+    end
+
+    jane = { name: "Jane", gender: :female, age: 19, species: :human }
+    john = { name: "John", gender: :male, age: 9, species: :cat }
 
-    jane_is_a_male   = IsMale[jane]
     jane_is_a_female = IsMale.not[jane]
     jane_is_an_adult = IsAdult[jane]
-    jane_is_a_child  = IsAdult.not[jane]
-
     jane_is_a_women  = jane_is_a_female & jane_is_an_adult
     expect(jane_is_a_women).to be_valid
     expect { jane_is_a_women.validate! }.not_to raise_error
 
+    jane_is_a_male   = IsMale[jane]
+    jane_is_a_child  = IsAdult.not[jane]
     jane_is_a_boy = jane_is_a_male & jane_is_a_child
     expect(jane_is_a_boy).not_to be_valid
     expect(jane_is_a_boy.messages)
       .to eql ["Jane is a female", "Jane is an adult (age 19)"]
     expect { jane_is_a_boy.validate! }.to raise_error Assertion::InvalidError
+
+    jane_is_a_cat = IsCat[jane]
+    expect(jane_is_a_cat.messages).to eql ["Jane is not a cat"]
+
+    john_is_not_a_cat = IsCat.not[john]
+    expect(john_is_not_a_cat.messages).to eql ["John is a cat"]
   end
 
   after do

data/spec/unit/assertion/base_spec.rb

@@ -19,7 +19,7 @@ describe Assertion::Base do
 
   describe ".new" do
 
-    let(:klass) { Class.new(described_class) { attribute :foo, :bar } }
+    let(:klass) { Class.new(described_class) { attribute :foo, "bar" } }
 
     context "with attributes" do
 
@@ -67,7 +67,8 @@ describe Assertion::Base do
       end
 
       it "returns a translation" do
-        expect(subject).to eql translator.call(options[:as], attributes)
+        msg = options[:as] ? :truthy : :falsey
+        expect(subject).to eql translator.call(msg, attributes)
       end
 
     end # shared examples
@@ -84,6 +85,18 @@ describe Assertion::Base do
       subject { assertion.message }
     end
 
+    context "when #truthy and #falsey defined" do
+
+      before { klass.send(:define_method, :truthy) { "foo" } }
+      before { klass.send(:define_method, :falsey) { "bar" } }
+
+      it "uses defined method" do
+        expect(assertion.message(true)).to eql "foo"
+        expect(assertion.message(false)).to eql "bar"
+      end
+
+    end # context
+
   end # describe #message
 
   describe "#call" do

data/spec/unit/assertion/dsl/inversion_spec.rb

@@ -13,6 +13,17 @@ describe Assertion::DSL::Inversion do
       expect(subject.source).to eql klass
     end
 
-  end # describe .not
+  end # describe #not
+
+  describe "#!" do
+
+    subject { !klass }
+
+    it "creates the iverter for the current class" do
+      expect(subject).to be_kind_of Assertion::Inverter
+      expect(subject.source).to eql klass
+    end
+
+  end # describe #!
 
 end # describe Assertion::DSL::Inversion

data/spec/unit/assertion/translator_spec.rb

@@ -20,13 +20,6 @@ describe Assertion::Translator do
 
   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, opts|
@@ -49,10 +42,8 @@ describe Assertion::Translator do
 
     end # shared examples
 
-    it_behaves_like "translating", true,  to: "truthy"
-    it_behaves_like "translating", "ok",  to: "truthy"
-    it_behaves_like "translating", false, to: "falsey"
-    it_behaves_like "translating", nil,   to: "falsey"
+    it_behaves_like "translating", :truthy, to: "truthy"
+    it_behaves_like "translating", :falsey, to: "falsey"
 
   end # describe #call
 

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: assertion
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-12 00:00:00.000000000 Z
+date: 2015-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
 - !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: inflecto
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
 - !ruby/object:Gem::Dependency
   name: hexx-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
   name: equalizer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.0'
 description: 
@@ -88,13 +88,13 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
-- .coveralls.yml
-- .gitignore
-- .metrics
-- .rspec
-- .rubocop.yml
-- .travis.yml
-- .yardopts
+- ".coveralls.yml"
+- ".gitignore"
+- ".metrics"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
@@ -158,12 +158,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []