assertion 0.0.1

data/config/metrics/cane.yml

@@ -0,0 +1,5 @@
+---
+abc_max: "10"
+line_length: "80"
+no_doc: "y"
+no_readme: "y"

data/config/metrics/churn.yml

@@ -0,0 +1,6 @@
+---
+ignore_files:
+- spec
+- config
+minimum_churn_count: 0
+start_date: "1 year ago"

data/config/metrics/flay.yml

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

data/config/metrics/metric_fu.yml

@@ -0,0 +1,15 @@
+---
+folders: # The list of folders to be used by any metric.
+- lib
+- app
+metrics: # The list of allowed metrics. The other metrics are disabled.
+- cane
+- churn
+- flay
+- flog
+- reek
+- roodi
+- saikuro
+format: html
+output: tmp/metric_fu
+verbose: false

data/config/metrics/reek.yml

@@ -0,0 +1 @@
+---

data/config/metrics/roodi.yml

@@ -0,0 +1,24 @@
+---
+AssignmentInConditionalCheck:
+CaseMissingElseCheck:
+ClassLineCountCheck:
+  line_count: 300
+ClassNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ClassVariableCheck:
+CyclomaticComplexityBlockCheck:
+  complexity: 4
+CyclomaticComplexityMethodCheck:
+  complexity: 8
+EmptyRescueBodyCheck:
+ForLoopCheck:
+MethodLineCountCheck:
+  line_count: 20
+MethodNameCheck:
+  pattern: !ruby/regexp /^[\||\^|\&|\!]$|^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
+ModuleLineCountCheck:
+  line_count: 300
+ModuleNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ParameterNumberCheck:
+  parameter_count: 5

data/config/metrics/rubocop.yml

@@ -0,0 +1,72 @@
+---
+# settings added by the 'hexx-suit' module
+# output: "tmp/rubocop"
+# format: "html"
+
+AllCops:
+  Exclude:
+    - '**/db/schema.rb'
+
+Lint/HandleExceptions:
+  Exclude:
+    - '**/*_spec.rb'
+
+Lint/RescueException:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/AccessorMethodName:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SingleLineMethods:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - '**/Gemfile'
+    - '**/*.gemspec'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrivialAccessors:
+  Exclude:
+    - '**/*_spec.rb'

data/config/metrics/saikuro.yml

@@ -0,0 +1,3 @@
+---
+warn_cyclo:  4
+error_cyclo: 6

data/config/metrics/simplecov.yml

@@ -0,0 +1,6 @@
+---
+output: tmp/coverage
+filters: # The list of paths to be excluded from coverage checkup
+- "spec/"
+- "config/"
+groups: []

data/config/metrics/yardstick.yml

@@ -0,0 +1,37 @@
+---
+# Settings added by the 'hexx-suit' gem
+output: "tmp/yardstick/output.log"
+path: "lib/**/*.rb"
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude: []
+  ApiTag::Inclusion:
+    enabled: true
+    exclude: []
+  ApiTag::ProtectedMethod:
+    enabled: true
+    exclude: []
+  ApiTag::PrivateMethod:
+    enabled: false
+    exclude: []
+  ExampleTag:
+    enabled: true
+    exclude: []
+  ReturnTag:
+    enabled: true
+    exclude: []
+  Summary::Presence:
+    enabled: true
+    exclude: []
+  Summary::Length:
+    enabled: true
+    exclude: []
+  Summary::Delimiter:
+    enabled: true
+    exclude: []
+  Summary::SingleLine:
+    enabled: true
+    exclude: []
+threshold: 100
+verbose: false

data/lib/assertion.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+require "transproc"
+require "i18n"
+
+require_relative "assertion/transprocs/inflector"
+require_relative "assertion/transprocs/i18n"
+require_relative "assertion/transprocs/list"
+
+require_relative "assertion/exceptions/name_error"
+require_relative "assertion/exceptions/not_implemented_error"
+require_relative "assertion/exceptions/invalid_error"
+
+require_relative "assertion/state"
+require_relative "assertion/base"
+require_relative "assertion/inversion"
+require_relative "assertion/inverter"
+
+# The module allows declaring assertions (assertions) about various objects,
+# and apply (validate) them to concrete data.
+#
+# @example
+#   # config/locales/en.yml
+#   # ---
+#   # en:
+#   #   assertion:
+#   #     adult:
+#   #       right: "%{name} is an adult (age %{age})"
+#   #       wrong: "%{name} is a child (age %{age})"
+#
+#   Adult = Assertion.about :name, :age do
+#     age >= 18
+#   end
+#
+#   joe = { name: 'Joe', age: 13 }
+#   Adult[joe].validate!
+#   # => #<Assertion::InvalidError @messages=["Joe is a child (age 13)"]>
+#
+#   jane = { name: 'Jane', age: 22 }
+#   Adult.not[jane].validate!
+#   # => #<Assertion::InvalidError @messages=["Jane is an adult (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 [Assertion::Base]
+  #
+  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
+
+end # module Assertion

data/lib/assertion/base.rb

@@ -0,0 +1,186 @@
+# encoding: utf-8
+
+module Assertion
+
+  # The base class for assertions about some attributes
+  #
+  # Every assertion should define a list of attributes to be checked and
+  # the [#check] method to apply the assertion to those attributes
+  #
+  # The assertion `call` method provides the object, describing the state
+  # of the assertion applied to its attributes. The provided state carries
+  # the result of the checkup and a corresponding <error> message.
+  # Later it can be composed with other states to provide complex validation.
+  #
+  # The class DSL also defines shortcuts:
+  #
+  # * [.[]] can be used to initialize the assertion for given attributes and
+  #   then apply it immediately with creation of the corresponding state.
+  # * [.not] can be used to provide the assertion opposite to the initial one.
+  #
+  # @example
+  #   class Adult < Assertion::Base
+  #     attribute :name, :age
+  #
+  #     def check
+  #       age >= 18
+  #     end
+  #   end
+  #
+  #   child = Adult.not
+  #
+  #   jane = { name: "Jane", age: 12 }
+  #   Adult[jane].valid? # => false
+  #   child[jane].valid? # => true
+  #
+  class Base
+
+    # Class DSL
+    #
+    class << self
+
+      # 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 [Assertion::NameError]
+      #   When the name is already used by instance attribute
+      #
+      def attribute(*names)
+        @attributes = List[:symbolize][attributes + names]
+        __check__
+      end
+
+      # Initializes a 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
+
+      # Checks if all the attributes have valid names
+      def __check__
+        wrong = attributes & instance_methods
+        fail(NameError.new wrong) if wrong.any?
+      end
+
+    end # eigenclass
+
+    # @!attribute [r] attributes
+    #
+    # @example
+    #   Adult = Assertion.about :name, :age do
+    #     age >= 18
+    #   end
+    #
+    #   adult = Adult[name: "Joe", age: 15, gender: :male]
+    #   adult.attributes # => { name: "Joe", age: 15 }
+    #
+    # @return [Hash]
+    #   The hash of the allowed attributes having been initialized
+    #
+    attr_reader :attributes
+
+    # @private
+    def initialize(args = {})
+      @attributes = {}
+      self.class.attributes.each { |name| __set_attribute__ name, args[name] }
+      freeze
+    end
+
+    # Returns the translated message about the current state of the assertion
+    # applied to its attributes
+    #
+    # @param [Symbol] state The state to be described
+    #
+    # @return [String] The message
+    #
+    def message(state = nil)
+      I18n[:translate, __scope__, attributes][state ? :right : :wrong]
+    end
+
+    # Checks whether the assertion is right for the current attributes
+    #
+    # @return [Boolean]
+    #
+    # @raise [Check::NotImplementedError]
+    #   When the [#check] method hasn't been implemented
+    #
+    def check
+      fail NotImplementedError.new(self.class, :check)
+    end
+
+    # Calls the assertion checkup and returns the state of the assertion having
+    # been applied to the current attributes
+    #
+    # @return [Check::State]
+    #   The state of the assertion being applied to its attributes
+    #
+    def call
+      state = check
+      State.new state, message
+    end
+
+    private
+
+    # The scope for translating messages using the `I18n` module
+    #
+    # @return [Array<Symbol>]
+    #
+    def __scope__
+      I18n[:scope][self.class.name]
+    end
+
+    # Defines the object attribute and assigns given value to it
+    #
+    # @param [Symbol] name The name of the attribute
+    # @param [Object] value The value of the attribute
+    #
+    # @return [undefined]
+    #
+    def __set_attribute__(name, value)
+      attributes[name] = value
+      singleton_class.__send__(:define_method, name) { value }
+    end
+
+  end # class Base
+
+end # module Assertion