tradesman 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10cf2e227726b33ce09753d78bdb487c9d1594e2
-  data.tar.gz: a50b212a8093cfc8ff40c63274f8645274543e4d
+  metadata.gz: db5c2d7076e95ba6d615b720841bd7060498fd41
+  data.tar.gz: 8e3c89647d347d22d91f8b6674b97365ce0615b9
 SHA512:
-  metadata.gz: 029a024e2a5a2133e3b1bd5b2707ab2806de70b0973cae0b3082fc7c480596403bce5760be9f17e6ae2dcdafec2084baf4631955b02e854195f4bd0d00a541f7
-  data.tar.gz: 7b33640366ea1882fc5d8493fe28c4f40c257fc6b6976b947773f808d1f013868487ffe0d56323e170c0eb0023d6954d5cadad3fc63f67f77186d096ad788af4
+  metadata.gz: 7fda495879e02cc5199b8327879fae9fa7acbacd1aa2f6e3b94a8391482d3fb82b2a3a1e130006e3df9fcf0ddeeefdb423ad4f1b2e7b597d7c7fefeb473e3d9b
+  data.tar.gz: d6868892dc9f4441426dbe234e3bafe40c38f83788e592b34e5a7caba9410071f280156e7466babd790c8989fcd3cd6ae86dae11d19d467c988d8d92f676a8aa

data/README.md

@@ -13,7 +13,7 @@ outcome.success? #=> true
 outcome.result #=> User Entity
 
 # Passing a block - Well-suited for Controllers
-Tradesman::UpdateUser.run(params[:id], user_update_params) do
+Tradesman::UpdateUser.run({ id: params[:id] }.merge(user_update_params)) do
   success do |result|
     render(text: 'true', status: 200)
   end
@@ -28,10 +28,10 @@ Tradesman::UpdateUser.run(params[:id], user_update_params) do
 end
 
 # Can also Delete
-Tradesman::DeleteUser.run(params[:id])
+Tradesman::DeleteUser.run(id: params[:id])
 
 # Or Create as a child of an existing record
-Tradesman::CreateUserForEmployer.run(employer_id, user_params)
+Tradesman::CreateUserForEmployer.run({ parent_id: employer_id }.merge(user_params))
 ```
 
 ## Why is this necessary?
@@ -68,7 +68,7 @@ Tradesman is designed to handle the above and a few other common use-cases to re
 
 Tradesman version of the above:
 ```ruby
-Tradesman::UpdateUser.run(params[:id], user_params) do
+Tradesman::UpdateUser.run(user_params) do
   success do |result|
     @user = result
     render 'user'
@@ -80,6 +80,74 @@ Tradesman::UpdateUser.run(params[:id], user_params) do
 
   failure { |result| render(text: 'false', status: 400) } # If you prefer one-liners
 end
+
+private
+
+def user_params
+  params.permit(:id, :first_name, :last_name)
+end
 ```
 
 The Tradesman version says exactly what it does, is cruft free, and is much quicker to test (more on that later).
+
+## Config
+
+**Define your adapter**
+
+_config/initializers/tradesman.rb_
+```ruby
+Tradesman.configure { |config| config.adapter = :active_record }
+```
+
+**Development Mode and Model Namespaces**
+
+Rails' lazy-loading in the development environment makes a bit more configuration necessary, particularly if you have wrapped your models in namespaces.
+
+Consider:
+```ruby
+module MyNamespace
+  class Employer < ActiveRecord::Base
+    has_many :users
+  end
+end
+
+module MyOtherNamespace
+  class User < ActiveRecord::Base
+    belongs_to :employer
+  end
+end
+```
+
+In order to help Tradesman lazy load these models, you need to enable development mode and configure any namespaces:
+
+_config/initializers/tradesman.rb_
+```ruby
+Tradesman.configure do |config|
+  config.adapter = :active_record
+  config.development_mode = Rails.env.development?
+  config.namespaces = [MyNamespace, MyOtherNamespace]
+end
+```
+
+**Reset Tradesman** _(Can be done at runtime or in tests)_
+```ruby
+Tradesman.reset
+```
+
+## Adapters
+
+Tradesman sits on top of [Horza](https://github.com/onfido/horza/), and can use any of its adapters.
+
+## Edge Cases
+
+**Models ending with double 's'**
+
+Some models end with a double 's', ie `Address`, `Business`. Rails has a well documented inability to properly inflect this type of word.
+There is a simple fix:
+
+```ruby
+# config/initializers/inflections.rb
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.singular(/ess$/i, 'ess')
+end
+```

data/lib/tradesman/configuration.rb

@@ -20,11 +20,21 @@ module Tradesman
   end
 
   class Config
-    attr_accessor :adapter
+    attr_accessor :adapter, :namespaces
 
-    def set_adapter(adapter)
+    def adapter=(adapter)
       Horza.configure { |config| config.adapter = adapter }
       @adapter = Horza.adapter
     end
+
+    def development_mode=(mode)
+      Horza.configure { |config| config.development_mode = mode }
+    end
+
+    def namespaces=(namespaces)
+      fail Tradesman::Errors::Base.new 'namespaces must be an array' unless namespaces.is_a? Array
+      Horza.configure { |config| config.namespaces = namespaces }
+      @namespaces = namespaces
+    end
   end
 end

data/spec/tradesman_spec.rb

@@ -32,7 +32,7 @@ end
 
 describe Tradesman do
   let(:adapter) { :active_record }
-  before { Tradesman.configure { |config| config.set_adapter(adapter) } }
+  before { Tradesman.configure { |config| config.adapter = adapter } }
   after do
     TradesmanSpec::User.delete_all
     TradesmanSpec::StrictUser.delete_all
@@ -56,6 +56,40 @@ describe Tradesman do
     end
   end
 
+  context 'namespaces' do
+    context 'when no namespaces are set' do
+      it 'does not forward namespaces to Horza' do
+        expect(Horza.configuration.namespaces.empty?).to be true
+      end
+    end
+    context 'when namespaces are set' do
+      before do
+        Tradesman.configure { |config| config.namespaces = [TradesmanSpec] }
+      end
+
+      it 'forwards namespaces to Horza' do
+        expect(Horza.configuration.namespaces).to eq [TradesmanSpec]
+      end
+    end
+  end
+
+  context 'development_mode' do
+    context 'when development_mode is not set' do
+      it 'does not forward namespaces to Horza' do
+        expect(Horza.configuration.development_mode).to be nil
+      end
+    end
+    context 'when namespaces are set' do
+      before do
+        Tradesman.configure { |config| config.development_mode = true }
+      end
+
+      it 'forwards namespaces to Horza' do
+        expect(Horza.configuration.development_mode).to be true
+      end
+    end
+  end
+
   context '#run' do
     context 'Create' do
       context 'when parameters are valid' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tradesman
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Blake Turner
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-08 00:00:00.000000000 Z
+date: 2015-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: horza
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.2
+        version: 0.3.3
 - !ruby/object:Gem::Dependency
   name: tzu
   requirement: !ruby/object:Gem::Requirement