assertion 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9fbab813ababd1c0224226d00aa2144dc682b6d
-  data.tar.gz: 30d48a47833d65670e480b29196caa1aec783040
+  metadata.gz: 5cd46bf51eb8357641668f5f3762bf0fb5a0dbd7
+  data.tar.gz: 048a9c8f663aed972a4ee8e0ded514a7310a6742
 SHA512:
-  metadata.gz: 521a9d990f59e2236344f712df369f211e3635c9f6828da4883135962b2f6e51a0e006e0fc18612d9e3474c24a5bdf3681585982c665eec6e8caa21de58961e4
-  data.tar.gz: 3e3dacb62cc68dd317e674cbad9424607d4b4a12638445e54a41534f747f9c0af7c07edf1a13728d9b2223349b713f72d716cb9f6cb7525dd7f8e332b46a8978
+  metadata.gz: ec1de6dade9383cd776f497fe0bfbaf452a1a60ae3ed5b341fe8741fbf891a4f43bf3ac08cbfa7fa1541aae1ce71937ba350cbd3932ae0f1975a01f7ac859e79
+  data.tar.gz: 7fe6666427458a4291988444e4a333219297cde70cd1aa592d2d3624625d8bc0c39bb647eb25bc1c49c8a1963e609f927443ef6ba51d4cd35ee45a0e0c4d5a81

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## v0.2.0 2015-06-22
+
+### Changed (backward-incompatible!)
+
+* Renamed translation keys from `:right`/`:wrong` to `:truthy`/`:falsey` for consistency (nepalez)
+
+### Internal
+
+* Attributes are added to `Base` and `Guard` at the moment of definition,
+  instead of the initializations (addresses efficiency issue #1) (nepalez)
+* `Translator` replaced `Messages` and `List`(transproc) to invert dependency
+  of `Base` from translations. (nepalez)
+* Class-level DSL features are extracted from `Assertion`, `Base` and `Guard`
+  to the separate modules `DSL`, `BaseDSL`, `GuardDSL` correspondingly (nepalez)
+
+[Compare v0.1.0...v0.2.0](https://github.com/nepalez/assertion/compare/v0.1.0...v0.2.0)
+
 ## v0.1.0 2015-06-20
 
 ### Added

data/Gemfile

@@ -5,5 +5,3 @@ gemspec
 group :metrics do
   gem "hexx-suit", "~> 2.2" if RUBY_ENGINE == "ruby"
 end
-
-gem "transproc", github: "solnic/transproc", branch: "registry"

data/Guardfile

@@ -4,15 +4,15 @@ guard :rspec, cmd: "bundle exec rspec" do
 
   watch(%r{^spec/.+_spec\.rb$})
 
-  watch(%r{^lib/assertion/(.+)\.rb}) do |m|
-    "spec/unit/assertion/#{m[1]}_spec.rb"
+  watch(%r{^lib/(.+)\.rb}) do |m|
+    "spec/unit/#{m[1]}_spec.rb"
   end
 
-  watch(%r{^lib/assertion/transproc.rb}) do
-    "spec/unit/assertion/transproc"
-  end
+  watch("lib/assertion/dsl.rb")       { "spec/unit/assertion_spec.rb"       }
+  watch("lib/assertion/base_dsl.rb")  { "spec/unit/assertion/base_spec.rb"  }
+  watch("lib/assertion/guard_dsl.rb") { "spec/unit/assertion/guard_spec.rb" }
+  watch("lib/assertion/inflector.rb") { "spec/unit/assertion/inflector"     }
 
-  watch("lib/assertion.rb")        { "spec" }
   watch("spec/spec_helper.rb") { "spec" }
 
 end # guard :rspec

data/README.md

@@ -24,6 +24,8 @@ The primary goal of the gem is to make assertions about <decoupled> objects.
 
 No `ActiveSupport`, no mutation of any instances.
 
+[About](https://github.com/mbj/mutant/issues/356) 100% [mutant]-covered.
+
 ### Basic Usage
 
 Define an assertion by inheriting it from the `Assertion::Base` class with attributes to which it should be applied.
@@ -49,7 +51,7 @@ IsAdult = Assertion.about :age, :name do
 end
 ```
 
-Define translations to describe both the *right* and *wrong* states of the assertion.
+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):
 
@@ -59,8 +61,8 @@ All the attributes are available in translations (that's why we declared the `na
 en:
   assertion:
     is_adult:
-      right: "%{name} is already an adult (age %{age})"
-      wrong: "%{name} is a child yet (age %{age})"
+      truthy: "%{name} is already an adult (age %{age})"
+      falsey: "%{name} is a child yet (age %{age})"
 ```
 
 Check a state of an assertion for some argument(s), using class method `[]`:
@@ -110,8 +112,8 @@ end
 en:
   assertion:
     is_male:
-      right: "%{name} is a male"
-      wrong: "%{name} is a female"
+      truthy: "%{name} is a male"
+      falsey: "%{name} is a female"
 ```
 
 Use method `&` (or its aliases `+` or `>>`) to compose assertion states:
@@ -166,7 +168,7 @@ Naming Convention
 
 This is not necessary, but for verbosity you could follow the rules:
 
-* use the prefix `Is` for assertions (like `IsAdult`)
+* use the prefixex `Is` (`Are`) for assertions (like `IsAdult`, `AreConsistent` etc.)
 * use the suffix `Only` for guards (like `AdultOnly`)
 
 Edge Cases

data/assertion.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = "~> 1.9"
 
-  gem.add_runtime_dependency "transproc", "~> 0.2"
+  gem.add_runtime_dependency "transproc", "~> 0.2", "> 0.2.3"
   gem.add_runtime_dependency "i18n", "~> 0.7"
 
   gem.add_development_dependency "hexx-rspec", "~> 0.4"

data/config/metrics/flay.yml

@@ -1,2 +1,2 @@
 ---
-minimum_score: 6
+minimum_score: 7

data/lib/assertion.rb

@@ -2,109 +2,58 @@
 
 require "transproc"
 
-require_relative "assertion/transprocs/inflector"
-require_relative "assertion/transprocs/list"
-
+require_relative "assertion/inflector"
 require_relative "assertion/invalid_error"
-require_relative "assertion/attributes"
-require_relative "assertion/messages"
-
+require_relative "assertion/translator"
 require_relative "assertion/state"
+require_relative "assertion/base_dsl"
 require_relative "assertion/base"
 require_relative "assertion/inversion"
 require_relative "assertion/inverter"
+require_relative "assertion/guard_dsl"
 require_relative "assertion/guard"
+require_relative "assertion/dsl"
 
-# The module allows declaring assertions (assertions) about various objects,
-# and apply (validate) them to concrete data.
+# The module declares:
+#
+# * assertions about objects
+# * guards (validations) for objects
 #
-# @example
+# @example Assertion
 #   # config/locales/en.yml
 #   # ---
 #   # en:
 #   #   assertion:
-#   #     adult:
-#   #       right: "%{name} is an adult (age %{age})"
-#   #       wrong: "%{name} is a child (age %{age})"
+#   #     is_adult:
+#   #       truthy: "%{name} is an adult (age %{age})"
+#   #       falsey: "%{name} is a child (age %{age})"
 #
-#   Adult = Assertion.about :name, :age do
+#   IsAdult = Assertion.about :name, :age do
 #     age >= 18
 #   end
 #
-#   joe = { name: 'Joe', age: 13 }
-#   Adult[joe].validate!
+#   joe = OpenStruct.new(name: 'Joe', age: 13)
+#   IsAdult[joe.to_h].validate!
 #   # => #<Assertion::InvalidError @messages=["Joe is a child (age 13)"]>
 #
-#   jane = { name: 'Jane', age: 22 }
-#   Adult.not[jane].validate!
+#   jane = OpenStruct.new(name: 'Jane', age: 22)
+#   IsAdult.not[jane.to_h].validate!
 #   # => #<Assertion::InvalidError @messages=["Jane is an adult (age 22)"]
 #
+# @example Guard
+#   AdultOnly = Assertion.guards :user do
+#     IsAdult[user.to_h]
+#   end
+#
+#   AdultOnly[joe]
+#   # => #<Assertion::InvalidError @messages=["Joe is a child (age 13)"]>
+#   AdultOnly[jane]
+#   # => #<OpenStruct @name="Jane", @age=22>
+#
 # @api public
 #
 module Assertion
 
-  # Builds the subclass of `Assertion::Base` with predefined `attributes`
-  # and implementation of the `#check` method.
-  #
-  # @example
-  #   IsMan = Assertion.about :age, :gender do
-  #     (age >= 18) && (gender == :male)
-  #   end
-  #
-  #   # This is the same as:
-  #   class IsMan < Assertion::Base
-  #     attribute :age, :gender
-  #
-  #     def check
-  #       (age >= 18) && (gender == :male)
-  #     end
-  #   end
-  #
-  # @param [Symbol, Array<Symbol>] attributes
-  #   The list of attributes for the new assertion
-  # @param [Proc] block
-  #   The content for the `check` method
-  #
-  # @return [Class] The specific assertion class
-  #
-  def self.about(*attributes, &block)
-    klass = Class.new(Base)
-    klass.public_send(:attribute, attributes)
-    klass.__send__(:define_method, :check, &block) if block_given?
-
-    klass
-  end
-
-  # Builds the subclass of `Assertion::Guard` with given attribute
-  # (alias for the `object`) and implementation of the `#state` method.
-  #
-  # @example
-  #   VoterOnly = Assertion.guards :user do
-  #     IsAdult[user.attributes] & IsCitizen[user.attributes]
-  #   end
-  #
-  #   # This is the same as:
-  #   class VoterOnly < Assertion::Guard
-  #     alias_method :user, :object
-  #
-  #     def state
-  #       IsAdult[user.attributes] & IsCitizen[user.attributes]
-  #     end
-  #   end
-  #
-  # @param [Symbol] attribute
-  #   The alias for the `object` attribute
-  # @param [Proc] block
-  #   The content for the `state` method
-  #
-  # @return [Class] The specific guard class
-  #
-  def self.guards(attribute = nil, &block)
-    klass = Class.new(Guard)
-    klass.public_send(:attribute, attribute) if attribute
-    klass.__send__(:define_method, :state, &block) if block_given?
-
-    klass
-  end
+  extend DSL
 
 end # module Assertion

data/lib/assertion/base.rb

@@ -19,7 +19,7 @@ module Assertion
   # * [.not] can be used to provide the assertion opposite to the initial one.
   #
   # @example
-  #   class Adult < Assertion::Base
+  #   class IsAdult < Assertion::Base
   #     attribute :name, :age
   #
   #     def check
@@ -27,70 +27,32 @@ module Assertion
   #     end
   #   end
   #
-  #   child = Adult.not
+  #   child = IsAdult.not
   #
   #   jane = { name: "Jane", age: 12 }
-  #   Adult[jane].valid? # => false
+  #   IsAdult[jane].valid? # => false
   #   child[jane].valid? # => true
   #
   class Base
 
-    extend  Attributes
-    include Messages
+    extend BaseDSL
 
-    # Class DSL
+    # The translator of states for the current class
     #
-    class << self
-
-      # Initializes an assertion with some attributes (data) and then calls it
-      #
-      # @param [Hash] hash
-      #
-      # @return [Assertion::State]
-      #   The object that describes the state of the assertion
-      #   applied to given attributes
-      #
-      def [](hash = {})
-        new(hash).call
-      end
-
-      # Initializes the intermediate inverter with `new` and `[]` methods
-      #
-      # The inverter can be used to initialize the assertion, that describes
-      # just the opposite statement to the current one
-      #
-      # @example
-      #   Adult = Assertion.about :name, :age do
-      #     age >= 18
-      #   end
-      #
-      #   joe = { name: 'Joe', age: 19 }
-      #
-      #   Adult[joe].valid?     # => true
-      #   Adult.not[joe].valid? # => false
-      #
-      # @return [Assertion::Inverter]
-      #
-      def not
-        Inverter.new(self)
-      end
-
-      private
-
-      def __forbidden_attributes__
-        [:check]
-      end
-
-    end # eigenclass
+    # @return [Assertion::Translator]
+    #
+    def self.translator
+      @translator ||= Translator.new(self)
+    end
 
     # @!attribute [r] attributes
     #
     # @example
-    #   Adult = Assertion.about :name, :age do
+    #   IsAdult = Assertion.about :name, :age do
     #     age >= 18
     #   end
     #
-    #   adult = Adult[name: "Joe", age: 15, gender: :male]
+    #   adult = IsAdult[name: "Joe", age: 15, gender: :male]
     #   adult.attributes # => { name: "Joe", age: 15 }
     #
     # @return [Hash]
@@ -98,29 +60,41 @@ module Assertion
     #
     attr_reader :attributes
 
+    # @!scope class
+    # @!method new(args = {})
+    # Initializes an assertion for the current object
+    #
+    # @param [Hash] args The arguments to check
+    #
+    # @return [Assertion::Base]
+
     # @private
     def initialize(args = {})
-      @attributes = {}
-      self.class.attributes.each { |name| __set_attribute__ name, args[name] }
+      keys = self.class.attributes
+      @attributes = Hash[keys.zip(args.values_at(*keys))]
       freeze
     end
 
-    # Calls the assertion checkup and returns the state of the assertion having
-    # been applied to the current attributes
+    # Returns the message describing the current state
     #
-    # @return [Check::State]
-    #   The state of the assertion being applied to its attributes
+    # @param [Boolean] state The state to describe
     #
-    def call
-      state = check
-      State.new state, message(false)
+    # @return [String]
+    #
+    def message(state)
+      self.class.translator.call(state, attributes)
     end
 
-    private
-
-    def __set_attribute__(name, value)
-      attributes[name] = value
-      singleton_class.__send__(:define_method, name) { value }
+    # Calls the assertion checkup and returns the resulting state
+    #
+    # The state is a unified composable object, unaware of the
+    # structure and attributes of the specific assertion.
+    #
+    # @return [Assertion::State]
+    #   The state of the assertion being applied to its attributes
+    #
+    def call
+      State.new check, message(false)
     end
 
   end # class Base

data/lib/assertion/base_dsl.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+module Assertion
+
+  # Provides methods to describe and apply assertions
+  #
+  module BaseDSL
+
+    # Initializes an assertion with some attributes (data) and then calls it
+    #
+    # @param (see Assertion::Base.new)
+    #
+    # @return (see Assertion::Base#call)
+    #
+    def [](args = nil)
+      new(args).call
+    end
+
+    # Initializes the intermediate inverter with `new` and `[]` methods
+    #
+    # The inverter can be used to initialize the assertion, that describes
+    # just the opposite statement to the current one
+    #
+    # @example
+    #   IsAdult = Assertion.about :name, :age do
+    #     age >= 18
+    #   end
+    #
+    #   joe = { name: 'Joe', age: 19 }
+    #
+    #   IsAdult[joe].valid?     # => true
+    #   IsAdult.not[joe].valid? # => false
+    #
+    # @return [Assertion::Inverter]
+    #
+    def not
+      Inverter.new(self)
+    end
+
+    # List of attributes defined for the assertion
+    #
+    # @return [Array<Symbol>]
+    #
+    def attributes
+      @attributes ||= []
+    end
+
+    # Declares new attribute(s) by name(s)
+    #
+    # @param [#to_sym, Array<#to_sym>] names
+    #
+    # @return [undefined]
+    #
+    # @raise [NameError]
+    #   When an instance method with one of given names is already exist.
+    #
+    def attribute(*names)
+      names.flatten.map(&:to_sym).each(&method(:__add_attribute__))
+    end
+
+    private
+
+    def __add_attribute__(name)
+      __check_attribute__(name)
+      attributes << define_method(name) { attributes[name] }
+    end
+
+    def __check_attribute__(name)
+      return unless (instance_methods << :check).include? name
+      fail NameError.new "#{self}##{name} is already defined"
+    end
+
+  end # module BaseDSL
+
+end # module Assertion