trailblazer 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 994926094dd0136c1436127773dd4c8786cd3cb3
-  data.tar.gz: ce869dcf9f8c01e2fe10847e3d4b54e460537960
+  metadata.gz: 973befd1d4260ea9bee84355c8b204084a51b5f9
+  data.tar.gz: 41e5430171b1d65a99716fd0502a9b9c8eb9d078
 SHA512:
-  metadata.gz: 26367bea09297a1bbcf29506d589826f3e83fca5dc45e4bb6d7146a57f2984c60d324cda43f55a52cd08f3523ed5e76d5b0c56bbddd531a2509ccd4e81117861
-  data.tar.gz: ff56573c794feb3afbbc7bac40026f65f418153e9aaef9cbdb6967a01d37412ba1faa95fb4127bab82efd6ad0f5ef10a2ea359a8f94bd8749dbebd480b64d8a2
+  metadata.gz: a54b22de4bd4966d6045fc78b0a0720fe1d7d4fbfc044115e476eb669fc90cbac645fcb9f780806ddc89c1ac6de7b984341956a703d35954f3e2c5730e64e1cb
+  data.tar.gz: 495cccf41dbb172fce76dcf9b5b8de68e66961ae78efcc1bfc5491400fa40fb6cb84e9343d56e827fe991f203ea00c6df547299ca13c87c4242126109215bb3a

data/.travis.yml

@@ -2,4 +2,7 @@ language: ruby
 rvm:
   - 2.1.2
   - 2.0.0
-  - 1.9.3
+  - 1.9.3
+script:
+  - bundle exec rake test
+  - bundle exec rake rails

data/CHANGES.md

@@ -1,3 +1,10 @@
+# 0.2.1
+
+* Added `Operation#setup_model!(params)` that can be overridden to add nested objects or process models right after `model!`. Don't add deserialization logic here, let Reform/Representable do that.
+* Added `Operation#setup_params!(params)` to normalize parameters before `#process`. Thanks to @gogogarrett.
+* Added `Controller::ActiveRecord` that will setup a named controller instance variable for your operation model. Thanks @gogogarrett!
+* Added `CRUD::ActiveModel` that currently infers the contract's `::model` from the operation's model.
+
 # 0.2.0
 
 ## API Changes

data/README.md

@@ -179,6 +179,8 @@ Note that `#present` will leave rendering up to you - `respond_to` is _not_ call
 
 In all three cases the following instance variables are assigned: `@operation`, `@form`, `@model`.
 
+Named instance variables can be included, too. This is documented [here](#named-controller-instance-variables).
+
 ## Operation
 
 Operations encapsulate business logic. One operation per high-level domain _function_ is used. Different formats or environments are handled in subclasses. Operations don't know about HTTP.
@@ -361,6 +363,28 @@ end
 
 Another action is `:find` (which is currently doing the same as `:update`) to find a model by using `params[:id]`.
 
+
+### Normalizing params
+
+Override #setup_params! to add or remove values to params before the operation is run.
+
+```ruby
+class Create < Trailblazer::Operation
+  def process(params)
+    params #=> {show_all: true, admin: true, .. }
+  end
+
+  private
+    def process_params!(params)
+      params.merge!(show_all: true) if params[:admin]
+    end
+  end
+end
+```
+
+This centralizes params normalization and doesn't require you to do that manually in `#process`.
+
+
 ### Background Processing
 
 To run an operation in Sidekiq (ActiveJob-support coming!) all you need to do is include the `Worker` module.
@@ -433,6 +457,49 @@ require "trailblazer/rails/railtie"
 This will go through `app/concepts/`, find all the `crud.rb` files, autoload their corresponding namespace (e.g. `Thing`, which is a model) and then load the `crud.rb` file.
 
 
+## Undocumented Features
+
+(Please don't read this section!)
+
+### Additional Model Setup
+
+Override `Operation#setup_model(params)` to add nested objects that can be infered from `params` or are static.
+
+This is called right after `#model!`.
+
+### ActiveModel Semantics
+
+When using `Reform::Form::ActiveModel` (which is used automatically in a Rails environment to make form builders work) you need to invoke `model Comment` in the contract. This can be inferred automatically from the operation by including `CRUD::ActiveModel`.
+
+```ruby
+class Create < Trailblazer::Operation
+  include CRUD
+  include CRUD::ActiveModel
+
+  model Comment
+
+  contract do # no need to call ::model, here.
+    property :text
+  end
+```
+
+If you want that in all CRUD operations, check out [how you can include](https://github.com/apotonick/gemgem-trbrb/blob/chapter-5/config/initializers/trailblazer.rb#L26) it automatically.
+
+### Named Controller Instance Variables
+
+If you want to include named instance variables for you views you must include another ActiveRecord specific module.
+
+```ruby
+require 'trailblazer/operation/controller/active_record'
+
+class ApplicationController < ActionController::Base
+  include Trailblazer::Operation::Controller
+  include Trailblazer::Operation::Controller::ActiveRecord
+end
+```
+
+This will setup a named instance variable of your operation's model, for example `@song`.
+
 ## Why?
 
 * Grouping code, views and assets by concepts increases the **maintainability** of your apps. Developers will find their way faster into your structure as the file layout is more intuitive.

data/lib/trailblazer/operation.rb

@@ -46,7 +46,6 @@ module Trailblazer
         contract_class.class_eval(&block)
       end
 
-
     private
       def build_operation_class(*params)
         class_builder.call(*params) # Uber::Builder::class_builder
@@ -55,7 +54,6 @@ module Trailblazer
 
     include Uber::Builder
 
-
     def initialize(options={})
       @valid            = true
       # DISCUSS: use reverse_merge here?
@@ -83,15 +81,24 @@ module Trailblazer
     end
 
   private
-
     def setup!(*params)
+      setup_params!(*params)
+
       @model = model!(*params)
+      setup_model!(*params)
     end
 
     # Implement #model! to find/create your operation model (if required).
     def model!(*params)
     end
 
+    # Override to add attributes that can be infered from params.
+    def setup_model!(*params)
+    end
+
+    def setup_params!(*params)
+    end
+
     def validate(params, model, contract_class=nil) # NOT to be overridden?!! it creates Result for us.
       @contract = contract_for(contract_class, model)
 

data/lib/trailblazer/operation/controller.rb

@@ -71,9 +71,13 @@ private
     end
 
     res, @operation = yield # Create.run(params)
-    @form  = @operation.contract
-    @model = @operation.model
+    setup_operation_instance_variables!
 
     [res, @operation] # DISCUSS: do we need result here? or can we just go pick op.valid?
   end
+
+  def setup_operation_instance_variables!
+    @form = @operation.contract
+    @model = @operation.model
+  end
 end

data/lib/trailblazer/operation/controller/active_record.rb

@@ -0,0 +1,12 @@
+# Assigns an additional instance variable for +@model+ named after the model's table name (e.g. @comment).
+module Trailblazer::Operation::Controller::ActiveRecord
+private
+  def setup_operation_instance_variables!
+    super
+    instance_variable_set(:"@#{operation_model_name}", @model)
+  end
+
+  def operation_model_name
+    @model.class.table_name.singularize
+  end
+end

data/lib/trailblazer/operation/crud.rb

@@ -5,13 +5,18 @@ module Trailblazer
     module CRUD
       attr_reader :model
 
-      def self.included(base)
-        base.extend Uber::InheritableAttr
-        base.inheritable_attr :config
-        base.config = {}
+      module Included
+        def included(base)
+          base.extend Uber::InheritableAttr
+          base.inheritable_attr :config
+          base.config = {}
 
-        base.extend ClassMethods
+          base.extend ClassMethods
+        end
       end
+      # this makes ::included overrideable, e.g. to add more featues like CRUD::ActiveModel.
+      extend Included
+
 
       module ClassMethods
         def model(name, action=nil)
@@ -56,6 +61,24 @@ module Trailblazer
       end
 
       alias_method :find_model, :update_model
+
+
+      # Rails-specific.
+      # ActiveModel will automatically call Form::model when creating the contract and passes
+      # the operation's +::model+, so you don't have to call it twice.
+      # This assumes that the form class includes Form::ActiveModel, though.
+      module ActiveModel
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+          def contract(&block)
+            super
+            contract_class.model(model_class) # this assumes that Form::ActiveModel is mixed in.
+          end
+        end
+      end
     end
   end
 end

data/lib/trailblazer/rails/railtie.rb

@@ -11,7 +11,9 @@ module Trailblazer
     end
 
     # thank you, http://stackoverflow.com/a/17573888/465070
-    initializer 'trailblazer.install' do |app|
+    initializer 'trailblazer.install', after: :load_config_initializers do |app|
+      # the trb autoloading has to be run after initializers have been loaded, so we can tweak inclusion of features in
+      # initializers.
       if Rails.configuration.cache_classes
         Trailblazer::Railtie.autoload_crud_operations(app)
       else

data/lib/trailblazer/version.rb

@@ -1,3 +1,3 @@
 module Trailblazer
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/test/crud_test.rb

@@ -101,6 +101,18 @@ class CrudTest < MiniTest::Spec
     ModelUpdateOperation[{id: 1, song: {title: "Mercy Day For Mr. Vengeance"}}].model.must_equal song
   end
 
+
+  # Op#setup_model!
+  class SetupModelOperation < CreateOperation
+    def setup_model!(params)
+      model.instance_eval { @params = params; def params; @params.to_s; end }
+    end
+  end
+
+  it { SetupModelOperation[song: {title: "Emily Kane"}].model.params.must_equal "{:song=>{:title=>\"Emily Kane\"}}" }
+
+
+
   # no call to ::model raises error.
   class NoModelOperation < Trailblazer::Operation
     include CRUD
@@ -112,4 +124,21 @@ class CrudTest < MiniTest::Spec
 
   # uses :create as default if not set via ::action.
   it { assert_raises(RuntimeError){ NoModelOperation[{}] } }
+
+
+
+  # contract infers model_name.
+  # TODO: this a Rails/ActiveModel-specific test.
+  class ContractKnowsModelNameOperation < Trailblazer::Operation
+    include CRUD
+    model Song
+    include CRUD::ActiveModel
+
+    contract do
+      include Reform::Form::ActiveModel # this usually happens in Reform::Form::Rails.
+      property :title
+    end
+  end
+
+  it { ContractKnowsModelNameOperation.present(song: {title: "Direct Hit"}).contract.class.model_name.to_s.must_equal "CrudTest::Song" }
 end

data/test/operation_test.rb

@@ -7,6 +7,20 @@ module Comparable
   end
 end
 
+class OperationSetupParamsTest < MiniTest::Spec
+  class OperationSetupParam < Trailblazer::Operation
+    def process(params)
+      params
+    end
+
+    def setup_params!(params)
+      params.merge!(garrett: "Rocks!")
+    end
+  end
+
+  let (:operation) { OperationSetupParam.new }
+  it { OperationSetupParam.run({valid: true}).must_equal [true, {valid: true, garrett: "Rocks!"}] }
+end
 
 class OperationRunTest < MiniTest::Spec
   class Operation < Trailblazer::Operation
@@ -93,7 +107,6 @@ class OperationRunTest < MiniTest::Spec
   it { Operation.(true).contract.must_equal contract }
 end
 
-
 class OperationTest < MiniTest::Spec
   class Operation < Trailblazer::Operation
     def process(params)
@@ -172,7 +185,6 @@ class OperationTest < MiniTest::Spec
   # ::[]
   it { OperationWithManualValid.(Object).must_equal(Object) }
 
-
   # re-assign params
   class OperationReassigningParams < Trailblazer::Operation
     def process(params)
@@ -184,7 +196,6 @@ class OperationTest < MiniTest::Spec
   # ::run
   it { OperationReassigningParams.run({:title => "Day Like This"}).must_equal [true, "Day Like This"] }
 
-
   # #invalid!(result)
   class OperationCallingInvalid < Trailblazer::Operation
     def process(params)
@@ -206,7 +217,6 @@ class OperationTest < MiniTest::Spec
 
   it { OperationCallingInvalidWithoutResult.run(true).must_equal [false, OperationCallingInvalidWithoutResult.new] }
 
-
   # calling return from #validate block leaves result true.
   class OperationUsingReturnInValidate < Trailblazer::Operation
     self.contract_class = class Contract
@@ -229,7 +239,6 @@ class OperationTest < MiniTest::Spec
   it { OperationUsingReturnInValidate.run(true).must_equal [true, 1] }
   it { OperationUsingReturnInValidate.run(false).must_equal [false, 2] }
 
-
   # unlimited arguments for ::run and friends.
   class OperationReceivingLottaArguments < Trailblazer::Operation
     def process(model, params)
@@ -239,7 +248,6 @@ class OperationTest < MiniTest::Spec
 
   it { OperationReceivingLottaArguments.run(Object, {}).must_equal([true, [Object, {}]]) }
 
-
   # ::present only runs #setup! which runs #model!.
   class ContractOnlyOperation < Trailblazer::Operation
     self.contract_class = class Contract
@@ -260,7 +268,6 @@ class OperationTest < MiniTest::Spec
   end
 
   it { ContractOnlyOperation.present({}).contract._model.must_equal Object }
-
 end
 
 class OperationBuilderTest < MiniTest::Spec
@@ -332,4 +339,4 @@ class OperationInheritanceTest < MiniTest::Spec
     song.genre.must_equal "Punkrock"
     song.band.must_equal nil
   end
-end
+end

data/test/rails/controller_test.rb

@@ -124,7 +124,6 @@ class ControllerRespondTest < ActionController::TestCase
   end
 end
 
-
 class ResponderRunTest < ActionController::TestCase
   tests BandsController
 
@@ -171,7 +170,6 @@ class ControllerPresentTest < ActionController::TestCase
   end
 end
 
-
 # #form.
 class ControllerFormTest < ActionController::TestCase
   tests BandsController
@@ -194,4 +192,15 @@ class ControllerFormTest < ActionController::TestCase
 
     assert_select "b", ",Band,true,Band::Create::Admin"
   end
-end
+end
+
+class ActiveRecordPresentTest < ActionController::TestCase
+  tests ActiveRecordBandsController
+
+  test "#present" do
+    band = Band::Create[band: {name: "Nofx"}].model
+    get :show, id: band.id
+
+    assert_equal "active_record_bands/show.html: Band, Band, true, Band::Update", response.body
+  end
+end

data/test/rails/fake_app/controllers.rb

@@ -102,4 +102,17 @@ private
     params[:band] ||= {}
     params[:band][:locality] = "Essen"
   end
-end
+end
+
+require 'trailblazer/operation/controller/active_record'
+class ActiveRecordBandsController < ApplicationController
+  include Trailblazer::Operation::Controller
+  include Trailblazer::Operation::Controller::ActiveRecord
+  respond_to :html
+
+  def show
+    present Band::Update
+
+    render text: "active_record_bands/show.html: #{@model.class}, #{@band.class}, #{@form.is_a?(Reform::Form)}, #{@operation.class}"
+  end
+end

data/test/rails/fake_app/rails_app.rb

@@ -33,6 +33,8 @@ app.routes.draw do
     end
   end
 
+  resources :active_record_bands
+
   resources :bands do
     collection do
       post :create

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-14 00:00:00.000000000 Z
+date: 2015-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -181,6 +181,7 @@ files:
 - lib/trailblazer/autoloading.rb
 - lib/trailblazer/operation.rb
 - lib/trailblazer/operation/controller.rb
+- lib/trailblazer/operation/controller/active_record.rb
 - lib/trailblazer/operation/crud.rb
 - lib/trailblazer/operation/representer.rb
 - lib/trailblazer/operation/responder.rb