trailblazer 1.0.0.rc1 → 1.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c67bd17df3cf4afa247418e31cf3747e07ae7f1
-  data.tar.gz: ceb2f1a7f81c63d82152938607f4c46cb4b075fc
+  metadata.gz: 07471cd851403f80b0a26ef761be0ceb009dc745
+  data.tar.gz: cad5f9dfb9a3e6ecce4623d4d32bff7688ac62e0
 SHA512:
-  metadata.gz: 633a5a70e6b0f362247be2509dd637e234d10135f0d6c1917c81d3646646e12ae5efdaa964468592203f5eabafc274b1620c2d48b6b5870c26551bc92e11f971
-  data.tar.gz: 6276f20bc9d09a11d8dc313efd964383a04d1e05f77d87eded95e64953c8e854ecdaf0ec5be23f916fbafef0a867bffd6b89fc8b5b73ddd5e41cbddf1d3ef055
+  metadata.gz: 7896872cf410a207510668b7589f5e39b45c7d5ae3180682ecd5036745646742ccf1c487a26b7df5407f57ef8c12c94832948d22746472a463ce0a42c7be1594
+  data.tar.gz: 35a858f63b046ff83c7f456e043ccefa1f10e52a0e84c5ac967dfeed36987c03fb8c0a909552060363335779080536a59e7d6c82669a07636fd86012ea532762

data/CHANGES.md

@@ -3,7 +3,8 @@
 * `Operation[{..}]` is deprecated in favor of `Operation.({..})`.
 setup in initialize: when Op.run() with Worker, the policy will be run "delayed" and not with the actual permission set. this will result in many crashing sidekiq workers.
 * `Operation::CRUD` is now `Operation::Model`.
-* `Controller#form` now invokes `#prepopulate!` before rendering the view. Use `#present` if you don't want that.
+* `Controller#form` now invokes `#prepopulate!` before rendering the view.
+* `Controller#present` does not instantiate and assign `@form` anymore.
 
 # 0.3.4
 

data/README.md

@@ -317,107 +317,11 @@ end
 
 This will simply run `Comment::Create[params]`.
 
-You can pass your own params, too.
 
-```ruby
-def create
-  run Comment::Create, params.merge({current_user: current_user})
-end
-```
-
-An additional block will be executed _only if_ the operation result is valid.
-
-```ruby
-def create
-  run Comment::Create do |op|
-    return redirect_to(comments_path, notice: op.message)
-  end
-end
-```
-
-Note that the operation instance is yielded to the block.
-
-The case of an invalid response can be handled after the block.
-
-```ruby
-def create
-  run Comment::Create do |op|
-    # valid code..
-    return
-  end
-
-  render action: :new
-end
-```
-
-Don't forget to `return` from the valid block, otherwise both the valid block _and_ the invalid calls after it will be invoked.
-
-### Responding
-
-Alternatively, you can use Rails' excellent `#respond_with` to let a responder take care of what to render. Operations can be passed into `respond_with`. This happens automatically in `#respond`, the third way to let Trailblazer invoke an operation.
-
-```ruby
-def create
-  respond Comment::Create
-end
-```
-
-This will simply run the operation and chuck the instance into the responder letting the latter sort out what to render or where to redirect. The operation delegates respective calls to its internal `model`.
-
-`#respond` will accept options to be passed on to `respond_with`, too
 
-```ruby
-respond Comment::Create, params, location: brandnew_comments_path
-```
-
-You can also handle different formats in that block. It is totally fine to do that in the controller as this is _endpoint_ logic that is HTTP-specific and not business.
-
-```ruby
-def create
-  respond Comment::Create do |op, formats|
-    formats.html { redirect_to(op.model, :notice => op.valid? ? "All good!" : "Fail!") }
-    formats.json { render nothing: true }
-  end
-end
-```
-
-The block passed to `#respond` is _always_ executed, regardless of the operation's validity result. Goal is to let the responder handle the validity of the operation.
-
-The `formats` object is simply passed on to `#respond_with`.
-
-### Presenting
-
-For `#show` actions that simply present the model using a HTML page or a JSON or XML document the `#present` method comes in handy.
-
-```ruby
-def show
-  present Comment::Update
-end
-```
-
-Again, this will only run the operation's setup and provide the model in `@model`. You can then use a cell or controller view for HTML to present the model.
-
-For document-based APIs and request types that are not HTTP the operation will be advised to render the JSON or XML document using the operation's representer.
-
-Note that `#present` will leave rendering up to you - `respond_to` is _not_ called.
-
-
-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).
 
 
-### Different Request Formats
-
-In case you have document-API operations that use representers to deserialize the incoming JSON or XML: You can configure the controller to pass the original request body into the operation via `params["comment"]` - instead of the pre-parsed hash from Rails.
-
-You need to configure this in the controller.
-
-```ruby
-class CommentsController < ApplicationController
-  operation document_formats: :json
-```
-
+----
 
 It's up to the operation's builder to decide which class to instantiate.
 

data/lib/trailblazer/operation.rb

@@ -44,9 +44,9 @@ module Trailblazer
         call(*args)
       end
 
-      # Runs #setup! and returns the form object.
+      # Runs #setup! but doesn't process the operation.
       def present(params)
-        build_operation(params).present
+        build_operation(params)
       end
 
       # This is a DSL method. Use ::contract_class and ::contract_class= for the explicit version.
@@ -78,11 +78,6 @@ module Trailblazer
       [valid?, self]
     end
 
-    def present
-      contract!
-      self
-    end
-
     attr_reader :model
 
     def errors

data/lib/trailblazer/operation/controller.rb

@@ -3,7 +3,7 @@ require "trailblazer/endpoint"
 module Trailblazer::Operation::Controller
 private
   def form(*args)
-    present(*args).tap do |op|
+    operation!(*args).tap do |op|
       op.contract.prepopulate! # equals to @form.prepopulate!
     end
   end
@@ -11,18 +11,17 @@ private
   # Provides the operation instance, model and contract without running #process.
   # Returns the operation.
   def present(operation_class, params=self.params)
-    res, op = operation!(operation_class, params) { [true, operation_class.present(params)] }
-    op
+    operation!(operation_class, params, skip_form: true)
   end
 
   def collection(*args)
-    present(*args).tap do |op|
+    operation!(*args).tap do |op|
       @collection = op.model
     end
   end
 
   def run(operation_class, params=self.params, &block)
-    res, op = operation!(operation_class, params) { operation_class.run(params) }
+    res, op = operation_for!(operation_class, params) { operation_class.run(params) }
 
     yield op if res and block_given?
 
@@ -31,7 +30,7 @@ private
 
   # The block passed to #respond is always run, regardless of the validity result.
   def respond(operation_class, options={}, params=self.params, &block)
-    res, op   = operation!(operation_class, params, options) { operation_class.run(params) }
+    res, op   = operation_for!(operation_class, params, options) { operation_class.run(params) }
     namespace = options.delete(:namespace) || []
 
     return respond_with *namespace, op, options if not block_given?
@@ -39,26 +38,30 @@ private
   end
 
 private
+  def operation!(operation_class, params=self.params, options={}) # or #model or #setup.
+    res, op = operation_for!(operation_class, params, options) { [true, operation_class.present(params)] }
+    op
+  end
 
   def process_params!(params)
   end
 
   # Normalizes parameters and invokes the operation (including its builders).
-  def operation!(operation_class, params, options={}, &block)
+  def operation_for!(operation_class, params, options={}, &block)
     # Per default, only treat :html as non-document.
     options[:is_document] ||= request.format == :html ? false : true
 
     process_params!(params)
     res, op = Trailblazer::Endpoint.new(operation_class, params, request, options).(&block)
-    setup_operation_instance_variables!(op)
+    setup_operation_instance_variables!(op, options)
 
     [res, op]
   end
 
-  def setup_operation_instance_variables!(operation)
+  def setup_operation_instance_variables!(operation, options)
     @operation = operation
-    @form      = operation.contract
     @model     = operation.model
+    @form      = operation.contract unless options[:skip_form]
   end
 
 

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

@@ -1,7 +1,7 @@
 # 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!(operation)
+  def setup_operation_instance_variables!(operation, options)
     super
     instance_variable_set(:"@#{operation_model_name}", @model)
   end

data/lib/trailblazer/version.rb

@@ -1,3 +1,3 @@
 module Trailblazer
-  VERSION = "1.0.0.rc1"
+  VERSION = "1.0.0.rc2"
 end

data/test/operation_test.rb

@@ -118,19 +118,29 @@ class OperationRunTest < MiniTest::Spec
 
   # # Operation#contract returns @contract
   it { Operation.("yes, true").contract.class.to_s.must_equal "OperationRunTest::Operation::Contract" }
-end
 
 
-class OperationTest < MiniTest::Spec
-  class Operation < Trailblazer::Operation
-    def process(params)
-      validate(Object, params)
+
+
+  describe "::present" do
+    class NoContractOp < Trailblazer::Operation
+      self.contract_class = nil
+
+      def model!(*)
+        Object
+      end
     end
+
+    # the operation and model are available, but no contract.
+    it { NoContractOp.present({}).model.must_equal Object }
+    # no contract is built.
+    it { assert_raises(NoMethodError) { NoContractOp.present({}).contract } }
+    it { assert_raises(NoMethodError) { NoContractOp.run({}) } }
   end
+end
 
-  # contract is retrieved from ::contract_class.
-  it { assert_raises(NoMethodError) { Operation.run({}) } } # TODO: if you call #validate without defining a contract, the error is quite cryptic.
 
+class OperationTest < MiniTest::Spec
   # test #invalid!
   class OperationWithoutValidateCall < Trailblazer::Operation
     def process(params)
@@ -199,17 +209,6 @@ class OperationTest < MiniTest::Spec
 
 
 
-
-  # unlimited arguments for ::run and friends.
-  # class OperationReceivingLottaArguments < Trailblazer::Operation
-  #   def process(model, params)
-  #     @model = [model, params]
-  #   end
-  #   include Inspect
-  # end
-
-  # it { OperationReceivingLottaArguments.run(Object, {}).to_s.must_equal %{[true, <OperationReceivingLottaArguments @model=[Object, {}]>]} }
-
   # ::present only runs #setup! which runs #model!.
   class ContractOnlyOperation < Trailblazer::Operation
     self.contract_class = class Contract

data/test/rails/controller_test.rb

@@ -78,7 +78,7 @@ class ControllerPresentTest < ActionController::TestCase
 
     get :show, id: band.id
 
-    assert_equal "bands/show: Band,Band,true,Band::Update,Essen,nil", response.body
+    assert_equal "bands/show: Band,Band,Band::Update,Essen,nil", response.body
   end
 
   # TODO: this implicitely tests builds. maybe have separate test for that?
@@ -130,10 +130,10 @@ class ActiveRecordPresentTest < ActionController::TestCase
   tests ActiveRecordBandsController
 
   test "#present" do
-    band = Band::Create[band: {name: "Nofx"}].model
+    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
+    assert_equal "active_record_bands/show.html: Band, Band, nil, Band::Update", response.body
   end
 
   test "#collection" do

data/test/rails/fake_app/controllers.rb

@@ -63,7 +63,7 @@ class BandsController < ApplicationController
     @locality = params[:band][:locality] unless params[:format] == "json"
 
     return render json: op.to_json if params[:format] == "json"
-    render text: "bands/show: #{[@klass, @model.class, @form.is_a?(Reform::Form), @operation.class, @locality, @form.locality.inspect].join(',')}"
+    render text: "bands/show: #{[@klass, @model.class, @operation.class, @locality, @form.inspect].join(',')}"
   end
 
   def new
@@ -122,7 +122,7 @@ class ActiveRecordBandsController < ApplicationController
   def show
     present Band::Update
 
-    render text: "active_record_bands/show.html: #{@model.class}, #{@band.class}, #{@form.is_a?(Reform::Form)}, #{@operation.class}"
+    render text: "active_record_bands/show.html: #{@model.class}, #{@band.class}, #{@form.inspect}, #{@operation.class}"
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc1
+  version: 1.0.0.rc2
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2015-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber