hexx 7.1.0 → 8.0.0

metadata

@@ -1,192 +1,96 @@
 --- !ruby/object:Gem::Specification
 name: hexx
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-21 00:00:00.000000000 Z
+date: 2015-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: extlib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '0.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: wisper
+  name: hexx-suit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: inch
-  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: metric_fu
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.11'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.3'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.23'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.23'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.3'
-description: Defines domain service object and model attributes coercion.
+        version: '0.0'
+description: Collection of scaffolders.
 email: andrew.kozin@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
-- LICENSE.rdoc
-- README.rdoc
+- README.md
+- LICENSE
+- config/metrics/STYLEGUIDE
 files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".metrics"
+- ".rspec"
 - ".rubocop.yml"
-- LICENSE.rdoc
-- README.rdoc
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
 - Rakefile
+- config/initializer.rb
+- config/initializers/capture.rb
+- config/initializers/sandbox.rb
+- config/initializers/sandbox/helpers.rb
+- config/initializers/sandbox/matchers.rb
+- config/metrics/STYLEGUIDE
+- config/metrics/cane.yml
+- config/metrics/churn.yml
+- config/metrics/flay.yml
+- config/metrics/metric_fu.yml
+- config/metrics/pippi.yml
+- config/metrics/reek.yml
+- config/metrics/roodi.yml
+- config/metrics/rubocop.yml
+- config/metrics/saikuro.yml
+- config/metrics/simplecov.yml
+- config/metrics/yardstick.yml
+- hexx.gemspec
 - lib/hexx.rb
-- lib/hexx/coercible.rb
-- lib/hexx/configurable.rb
-- lib/hexx/creators/base.rb
-- lib/hexx/creators/coercion.rb
-- lib/hexx/creators/dependency.rb
-- lib/hexx/creators/module_dependency.rb
-- lib/hexx/creators/parameter.rb
-- lib/hexx/dependable.rb
-- lib/hexx/helpers/exceptions.rb
-- lib/hexx/helpers/messages.rb
-- lib/hexx/helpers/parameters.rb
-- lib/hexx/helpers/validations.rb
-- lib/hexx/message.rb
+- lib/hexx/generator.rb
+- lib/hexx/generator/file.rb
+- lib/hexx/generator/folder.rb
 - lib/hexx/name.rb
-- lib/hexx/null.rb
-- lib/hexx/service.rb
-- lib/hexx/service/with_callbacks.rb
-- lib/hexx/service_invalid.rb
 - lib/hexx/version.rb
-- spec/hexx/coercible_spec.rb
-- spec/hexx/configurable_spec.rb
-- spec/hexx/dependable_spec.rb
-- spec/hexx/helpers/exceptions_spec.rb
-- spec/hexx/helpers/messages_spec.rb
-- spec/hexx/helpers/parameters_spec.rb
-- spec/hexx/helpers/validations_spec.rb
-- spec/hexx/message_spec.rb
-- spec/hexx/name_spec.rb
-- spec/hexx/null_spec.rb
-- spec/hexx/service_invalid_spec.rb
-- spec/hexx/service_spec.rb
+- spec/fixtures/root/_.beta
+- spec/fixtures/root/__omega
+- spec/fixtures/root/delta.erb.erb
+- spec/fixtures/root/gamma.rb.erb
+- spec/fixtures/root/subfolder/alfa.yml
 - spec/spec_helper.rb
-- spec/support/initializers/focus.rb
-- spec/support/initializers/garbage_collection.rb
-- spec/support/initializers/i18n.rb
-- spec/support/initializers/random_order.rb
-- spec/support/initializers/rspec.rb
-- spec/support/matchers/methods.rb
+- spec/tests/lib/generator_spec.rb
+- spec/tests/lib/name_spec.rb
 homepage: https://github.com/nepalez/hexx
 licenses:
 - MIT
@@ -197,7 +101,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -210,27 +114,9 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Service objects for Rails.
+summary: Collection of scaffolders for projects that follow the hexagonal architecture.
 test_files:
 - spec/spec_helper.rb
-- spec/hexx/service_spec.rb
-- spec/hexx/message_spec.rb
-- spec/hexx/null_spec.rb
-- spec/hexx/helpers/parameters_spec.rb
-- spec/hexx/helpers/messages_spec.rb
-- spec/hexx/helpers/validations_spec.rb
-- spec/hexx/helpers/exceptions_spec.rb
-- spec/hexx/service_invalid_spec.rb
-- spec/hexx/coercible_spec.rb
-- spec/hexx/dependable_spec.rb
-- spec/hexx/name_spec.rb
-- spec/hexx/configurable_spec.rb
-- spec/support/matchers/methods.rb
-- spec/support/initializers/garbage_collection.rb
-- spec/support/initializers/i18n.rb
-- spec/support/initializers/focus.rb
-- spec/support/initializers/random_order.rb
-- spec/support/initializers/rspec.rb
-- Rakefile
-- ".rubocop.yml"
+- spec/tests/lib/generator_spec.rb
+- spec/tests/lib/name_spec.rb
 has_rdoc: 

data/README.rdoc

@@ -1,371 +0,0 @@
-= Hexx
-
-{<img src="http://img.shields.io/gem/v/hexx.svg?style=flat" alt="Gem Version" />}[https://rubygems.org/gems/hexx]
-{<img src="http://img.shields.io/travis/nepalez/hexx.svg?style=flat" alt="Bild Status" />}[https://travis-ci.org/nepalez/hexx]
-{<img src="http://img.shields.io/codeclimate/github/nepalez/hexx.svg?style=flat" alt="Code Metrics" />}[https://codeclimate.com/github/nepalez/hexx]
-{<img src="http://img.shields.io/gemnasium/nepalez/hexx.svg?style=flat" alt="Dependency Status" />}[https://gemnasium.com/nepalez/hexx]
-{<img src="http://img.shields.io/coveralls/nepalez/hexx.svg?style=flat" alt="Coverage Status" />}[https://coveralls.io/r/nepalez/hexx]
-{<img src="http://img.shields.io/badge/license-MIT-blue.svg?style=flat" alt="License" />}[https://github.com/nepalez/hexx/blob/master/LICENSE.rdoc]
-
-The base library for domain models.
-
-== API
-
-Includes classes and modules as below:
-<tt>Hexx::Service</tt>:: The base class for service objects.
-<tt>Hexx::Message</tt>:: The message provided by service objects.
-<tt>Hexx::Null</tt>:: The Null object.
-<tt>Hexx::Coercible</tt>:: The module that makes model attributes coercible.
-<tt>Hexx::Configurable</tt>:: The module to convert a core domain module to the
-                              dependency injection framework.
-<tt>Hexx::Dependable</tt>:: The module provides +depends_on+ class helper methodto
-                            to implement the setter dependency injection.
-
-The module is expected to be used in PORO domains for Ruby MRI 2.1+.
-
-For usage in active record bases domains consider the
-{ hexx-active_record }[https://github.com/nepalez/hexx-active_record]
-gem extension.
-
-== Installation
-
-Add this line to your application's Gemfile:
-
-    gem "hexx", "~> 2.0"
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install hexx
-
-== Usage
-
-=== Hexx::Configurable
-
-Adds the +configure+ and +depends_on+ helpers to the module to convert it
-to the {dependency injection container}[http://en.m.wikipedia.org/wiki/Dependency_injection].
-
-Extend the base class of the gem and declare the module dependencies from
-outer classes and modules with the +depend_on+ helper:
-
-  # lib/my_gem.rb
-  module MyGem
-    extend Hexx::Configurable
-
-    depend_on :get_item, :add_item
-  end
-
-Inject the dependencies in the gem config with the +configure+ wrapper:
-
-  # config/dependencies.rb
-  MyGem.configure do |c|
-    c.get_item = OuterModule::Services::Get
-    c.add_item = OuterModule::Services::Add
-  end
-
-Use the dependencies somewhere inside the code of the gem:
-
-  MyGem.get_item # => OuterModule::Services::Get
-
-=== Hexx::Coercible
-
-Adds the +attr_coerced+ class helper method to the PORO model.
-
-Provide a value object that accepts <tt>0..1</tt> arguments.
-
-  # app/attributes/coercer.rb
-  class Coercer < MultiByte::Chars
-    def self.new(source = nil)
-      return unless source
-    end
-
-    def initialize(source)
-      # ...
-    end
-  end
-
-Extend the model with a +Coercible+ module and declare its attributes
-with the +attr_coerced+ helper.
-
-  # app/models/some_model.rb
-  class SomeModel
-    extend Hexx::Coercible
-
-    attr_coerced :name, type: Coercer
-  end
-
-Both the getter and setter will return the coerced value, provided by
-the +Coercer+ class.
-
-  object = SomeModel.new name: "Ivo"
-  object.name
-  # #<Coercer @wrapped_string="Ivo" >
-
-Be careful when designing a coercer class. Its constructor should accept both
-the raw value (<tt>"Ivo"</tt>) and the coerced one (<tt>#<Coercer @wrapped_string = "Ivo"></tt>).
-This is needed because the coercer works twofold - it coerces both the
-setter and getter. The getter coercer will take the coerced value.
-
-This feature is added for compatibility with +ActiveRecord+ attributes
-whose getters gives raw values from a database.
-
-*Note*: The coercer from the +hexx+ gem itself won't work for +ActiveRecord+ models.
-Use the +hexx-active_record+ gem instead. The gem extends the +Coercible+ model
-so that the +attr_coerced+ reloads +ActiveRecord+ attributes properly.
-
-=== Hexx::Service
-
-Inherit services from the <tt>Hexx::Service</tt> class.
-
-The class implements a set of patterns:
-
-* The {Service object pattern}[http://blog.codeclimate.com/blog/2012/10/17/7-ways-to-decompose-fat-activerecord-models/] used to decouple business logics from both the models and  web delivery mechanism (such as +Rails+).
-* The {Observer pattern}[http://reefpoints.dockyard.com/2013/08/20/design-patterns-observer-pattern.html] to follow the {Tell, don't ask}[http://martinfowler.com/bliki/TellDontAsk.html] design princible.
-  The pattern is implemented with the help of {wisper}[http://www.github.com/krisleech/wisper] gem by Kris Leech.
-
-A typical service object is shown below:
-
-  # app/services/add_item.rb
-  require 'hexx'
-  class AddItem < Hexx::Service
-
-    # Whitelists parameters and defines corresponding attributes.
-    # For example, the #name attribute is avalable.
-    allow_params :name
-
-    # Defines some validation using ActiveModel::Validations helpers.
-    validate :name, presence: true
-
-    # Runs a service
-    def run
-      run!
-    rescue Found
-      # Publishes notification in case the item exists.
-      publish :found, item
-    rescue => err
-      publish :error, err.messages
-    else
-      # The notification to be published if the #run! raises nothing.
-      publish :added, item
-    end
-
-    private
-
-    attr_accessor :item
-
-    # Declares specific exceptions to be raised by the #run! method
-    # and processed by the #run differently.
-    #
-    # All other exceptions will be re-raised as Hexx::Service::Invalid
-    # and processed by publishing the :error notification.
-    raises :Found
-
-    # The sequence of the service steps. Any step can raise error to
-    # be rescued in #run with publishing a corresponding notification.
-    def run!
-      find_item
-      add_item
-    end
-
-    def find_item
-      # The method runs another service and listens to its notifications
-      # via private callback methods available to that service only.
-      # The callback names should start from given prefix (:on_item_).
-      run_service GetItem, :on_item, name: name
-    end
-
-    # The callback to listen to :found notification of the 'get_item' service.
-    def on_item_found(item, *)
-      @item = item
-      # Adds the Hexx::Message object of type "error" to the +messages+ array.
-      # The :not_found key will be translated in context of current service:
-      # {locale}.activemodule.messages.models.add_item.not_found
-      add_message "error", :not_found
-      fail Found # goes to publishing a result
-    end
-
-    # The callback to listen to :error notification of the 'get_item' service.
-    # that is expected to publish a list of error messages.
-    def on_item_error(*, messages)
-      # The helper raises Hexx::Service::Invalid exception where the messages
-      # are added to. The exception will be rescued by the #run method.
-      on_error(messages)
-    end
-
-    def add_item
-      # The escape re-raises any error as the Hexx::Service::Invalid
-      # with the array of Hexx::Message messages.
-      escape { @item = Item.create! name: name }
-    end
-  end
-
-A typical usage of the service (in a Rails controller):
-  
-  # app/controllers/items_controller.rb
-  class ItemsController < ActionController::Base
-
-    # Creates an item with given name
-    def create
-      service = AddItem.new params.allow(:name)
-      service.subscribe self, prefix: :on
-      service.run
-    end
-
-    # Publishes a success message
-    def on_created(item, messages)
-      @item = item
-      self.messages.concat messages
-      render "created", status: 201
-    end
-
-    # Responds with 304 (not changed)
-    def on_found(*)
-      render nothing: true, status: 304
-    end
-
-    # Publishes an error messages
-    def on_error(messages)
-      @messages = messages
-      render "error", status: 422
-    end
-  end
-
-The controller knows nothing about the action itself. It only needs to
-send the request to a corresponding service and sort out the notifications.
-
-=== Hexx::Message
-
-The messages published by the service has two attributes: +type+ and +text+.
-
-  message = Hexx::Message.new type: :error, text: "some error message"
-  message.type # => "error"
-  message.text # => "some error message"
-
-Inside a service use the +add_message+ to add message to the +messages+ array:
-
-  add_message "error", "text"
-  messages # => [#<Hexx::Message @type="error", @text="text" >]
-
-=== Hexx::Dependable
-
-The module provides the +depends_on+ class helper for {setter-based dependency injection}[http://brandonhilkert.com/blog/a-ruby-refactor-exploring-dependency-injection-options/]. It allows decoupling the service from another services it uses.
-
-Extend the service class and declare the dependencies with an optional default
-implementation (see example above):
-
-  class AddItem < Hexx::Service
-    extend Hexx::Dependable
-
-    depends_on :get_item, default: GetItem
-
-    # ...
-
-    def find_item
-      run_service get_item, :on_item, name: name
-    end
-  end
-
-Now the dependency can be injected afterwards:
-
-  # The default implementation
-  service = AddItem.new
-  service.get_item # => GetItem
-
-  # Change it to other implementation
-  service.get_item = FindItem
-  service.get_item # => FindItem
-
-  # Reset it to default by assigning +nil+
-  service.get_item = nil
-  service.get_item # => GetItem
-
-It is possible to test a service in isolation from its dependencies.
-
-  # spec/services/my_service_spec.rb
-  describe AddService do
-
-    describe "#run" do
-
-      # Mock a service objects to publish expected notifications
-      let(:object) { Hexx::Service }
-      before { allow(object).to receive(:run) { publish :not_found } }
-
-      # Inject a class dependency
-      before { service.get_item = class_double "Hexx::Service", new: object }
-
-      # ...
-    end
-  end
-
-=== Hexx::Name
-
-The module provides the base class for name constructors for various instances.
-
-It declares helpers:
-
-* +object+:: the attribute for the object to be named
-* +locale+:: the locale to name the object in
-* +scope+:: the current translation scope
-* +t(value, options):: the translator of the value in current scope and locale
-
-Inherit the class and reload its <tt>#for</tt> instance method:
-
-  module Names
-    class Hash < Hexx::Name
-      def for
-        user ? t(:user, value: user) : t(:empty)
-      end
-
-      def user
-        value = object[:user]
-        value ? value.upcase : nil
-      end
-    end
-  end
-
-Add the necessary translations:
-
-  # config/locales/ru.yml
-  ru:
-    activemodel:
-      names/hash:
-        user:  "чувак %{value}"
-        empty: "н/д"
-
-  # config/locales/en.yml
-  en:
-    activemodel:
-      names/hash:
-        user: "dude %{value}"
-        empty: "-"
-
-Then use its <tt>for</tt> class method to construct names:
-
-  Names::Hash.for { user: "Ivan" }, locale: :en
-  # => "dude IVAN"
-
-  Names::Hash.for { user: nil }, locale: :ru
-  # => "н/д"
-
-=== Hexx::Null
-
-The class implements the {Null object}[http://robots.thoughtbot.com/rails-refactoring-example-introduce-null-object] pattern. The object:
-
-* responds like +nil+ to <tt><=></tt>, +eq?+, +nil?+, +false?+, +true?+, +to_s+,
-  +to_i+, +to_f+, +to_c+, +to_r+, +to_nil+
-* responds with +self+ to any other method call
-
-Providing {this problem}[http://devblog.avdi.org/2011/05/30/null-objects-and-falsiness/],  use double negation in logical expressions:
-
-  # Though:
-  Hexx::Null && true   # => true
-  
-  # But:
-  !!Hexx::Null && true # => false
-
-== License
-
-The project is distributed under the {MIT LICENSE}[LICENSE.rdoc].