hexx 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e71da2454f5770b15da144731907f77d705259f6
-  data.tar.gz: 683c0e424c30d3a28fef7f0ceab28eae8421964f
+  metadata.gz: 44ade515af4a4044dce3725cf4a30ed2aef4da8e
+  data.tar.gz: 1c456b7fb78fe55d509019f03c0fbbce27a8f777
 SHA512:
-  metadata.gz: 0ec0862dbf0553ecfcbb213bc266ef4aacf780dea390ddf42473a9068c937f269776e816e30dbe5623dd744c0e36a7e0c8ecaa2b8e9725593b422bf21b82c6be
-  data.tar.gz: 9549db59cfde983b9781bb2bd8a13ba68eefddaf7a75b04278d0b4b8b39ee197593062e0833a3dabcebdf91a9e412a2085ce31c22e961d3564951a3e066ac5ed
+  metadata.gz: 255b6f79bd8726ffae49218d4f66ea397766ae79d265a2cdd353306217b5beedb73286e3c620f8ee45f2e42e94bf8ebf353452d9e504bdb35340009d1ac9a629
+  data.tar.gz: acdc38e43842a7be485378975c1b3dacc7e99b4ee0c53c500f2f35c369f70da4a60242712067d7bea8bb9dd9e692641adbce06659dc6736db7555423852c5c84

data/README.rdoc

@@ -14,6 +14,10 @@ Provides:
 * +Service+ base class for decoupling a domain business logics from a controller
 * +Models+ module for extending domain models.
 
+The module is expected to be used in PORO domain. For usage in active record
+domains consider { hexx-active_record }[https://github.com/nepalez/hexx-active_record]
+gem instead.
+
 == Installation
 
 Add this line to your application's Gemfile:
@@ -28,16 +32,16 @@ Or install it yourself as:
 
     $ gem install hexx
 
-== A pattern
+== Pattern
+
+Service objects decouple business logics from:
 
-Service objects decouple business logics from both:
 * Domain _models_ (entities).
 * Delivery mechanism _controllers_ (such as Rails framework).
 
-Following object oriented architecture service objects exploit the
-*Observer* (Listener) pattern, using the
-{ Wisper }[https://github.com/krisleech/wisper] gem. A service doesn't
-return their result to caller but notifies its subscribers instead.
+To follow object oriented architecture Hexx services exploit the
+*Observer* (Listener) pattern via { Wisper }[https://github.com/krisleech/wisper]
+gem.
 
 Some examples of this pattern implementation are available at the
 { wisper gem wiki }[https://github.com/krisleech/wisper/wiki].
@@ -48,7 +52,7 @@ A typical service object is shown below:
 
   require 'hexx'
 
-  class GetItem < Hexx::Service
+  class AddItem < Hexx::Service
 
     # whitelists parameters and defines corresponding attributes.
     allow_params :name
@@ -58,8 +62,7 @@ A typical service object is shown below:
 
     # runs a service
     def run
-
-      # runs some 
+      # a wrapper sends :error notification to listeners in case of any exception raised.
       transaction
         MyModel.save! name: name # name is defined by allow_params helper.
         publish :success         # notifies its listeners.
@@ -67,39 +70,43 @@ A typical service object is shown below:
     end
   end
 
-Usage of the service (in a Rails controller):
+Usage of the service (with a Rails controller):
 
   class ItemsController < ActionController::Base
 
     # Creates an item with given name
-    def show
-      service = GetItem.new params.allow(:name)
+    def create
+      service = AddItem.new params.allow(:name)
       service.subscribe self, prefix: :on
       service.run
     end
 
     # Publishes a success message
-    def success
-      render "created"
+    def on_created(item, messages)
+      @item, @messages = item, messages
+      render "created", status: 201
     end
 
     # Publishes an error messages
-    def error(messages)
+    def on_error(messages)
       @messages = messages
       render "error"
     end
+  end
+
+The controller knows nothing about the action itself. It only needs to
+sort out a request and send it to a corresponding service.
 
-Note the controller knows nothing about the action itself. It responsible only
-for selection of proper service and responding to its results.
+Any controller action does one thing only.
 
-Also note any controller action does one thing only. The +show+ action
-are requested by a client. The +on_success+ and +on_error+ are called by
-a service and reports to a client.
+* +create+ action sorts out requests.
+* both +on_success+ and +on_created+ listens to services and report their
+  results back to client.
 
 === Models and Entities
 
-The module also defines module <tt>Hexx::Models</tt> to extend domain models
-(entities). This allows coercion of model attributes with +attr_coerced+ helper:
+The module also defines <tt>Hexx::Models</tt> module to extend domain models
+(entities). This allows coercion of attributes with +attr_coerced+ helper:
 
   class User
     extend Hexx::Models
@@ -114,8 +121,8 @@ The module also defines module <tt>Hexx::Models</tt> to extend domain models
   user.name.class
   # => ActiveSupport::Multibyte::Chars
 
-The method defines (or redefines) both attribute getter and setter. You can use
-it to transform values by default:
+The method redefines both getter and setter and can be used for value
+preparation:
 
   class StrippedString < String
     def initialize(value)
@@ -133,7 +140,7 @@ it to transform values by default:
 
 == Relevant Links
 
-1:: Matt Wynne's talk {Hexagonal Rails}[http://www.confreaks.com/videos/977-goruco2012-hexagonal-rails]
+* Matt Wynne's talk {Hexagonal Rails}[http://www.confreaks.com/videos/977-goruco2012-hexagonal-rails]
 
 == License
 

data/lib/hexx/models.rb

@@ -1,5 +1,4 @@
-lib = File.dirname __FILE__
-Dir[File.join(lib, "models/**/*.rb")].each { |file| require file }
+require_relative "models/base_coercer"
 
 module Hexx
 

data/lib/hexx/service/validations.rb

@@ -1,3 +1,5 @@
+require_relative "invalid"
+
 module Hexx
   class Service
 

data/lib/hexx/service.rb

@@ -1,5 +1,8 @@
-lib = File.dirname __FILE__
-Dir[File.join(lib, "service/**/*.rb")].each { |file| require file }
+def service_modules
+  Dir[File.expand_path("../service/*.rb", __FILE__)]
+end
+
+service_modules.each { |file| require file }
 
 module Hexx
 

data/lib/hexx/version.rb

@@ -2,5 +2,5 @@
 module Hexx
 
   # Current release.
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

data/lib/hexx.rb

@@ -1,10 +1,8 @@
 require "active_model"
 require "wisper"
 
-# Gem files.
-lib = File.dirname __FILE__
-Dir[File.join(lib, "hexx/*.rb")].each { |file| require file }
-
-# Namespace for the gem.
-module Hexx
+def files
+  @files ||= Dir[File.expand_path("../hexx/**/*.rb", __FILE__)]
 end
+
+files.each { |file| require file }

data/spec/spec_helper.rb

@@ -1,7 +1,11 @@
-root = File.dirname File.dirname(__FILE__)
+require "coveralls"
+
+# Application root
+root = File.expand_path "../..", __FILE__
 
 # Support files and Rspec settings
 Dir[File.join(root, "spec/initializers/*.rb")].each { |file| require file }
 
 # Application files
+Coveralls.wear!
 require File.join(root, "lib/hexx.rb")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexx
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-01 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -53,75 +53,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: inch
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: metric_fu
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.11'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.23'
+        version: '10.3'
 - !ruby/object:Gem::Dependency
-  name: inch
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: metric_fu
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.11'
+        version: '0.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.11'
+        version: '0.23'
 description: Defines domain service object and model attributes coercion.
 email: andrew.kozin@gmail.com
 executables: []
@@ -149,7 +149,6 @@ files:
 - spec/hexx/service/invalid_spec.rb
 - spec/hexx/service/message_spec.rb
 - spec/hexx/service_spec.rb
-- spec/initializers/coveralls.rb
 - spec/initializers/focus.rb
 - spec/initializers/garbage_collection.rb
 - spec/initializers/i18n.rb
@@ -189,7 +188,6 @@ test_files:
 - spec/initializers/garbage_collection.rb
 - spec/initializers/i18n.rb
 - spec/initializers/focus.rb
-- spec/initializers/coveralls.rb
 - spec/initializers/random_order.rb
 - spec/initializers/rspec.rb
 - Rakefile

data/spec/initializers/coveralls.rb

@@ -1,3 +0,0 @@
-# Checking test coverage
-require "coveralls"
-Coveralls.wear!