trailblazer 0.3.3 → 1.0.0.rc1

data/lib/trailblazer/operation/resolver.rb

@@ -0,0 +1,30 @@
+require "trailblazer/operation/model/external"
+require "trailblazer/operation/policy"
+
+class Trailblazer::Operation
+  # Provides builds-> (model, policy, params).
+  module Resolver
+    def self.included(includer)
+      includer.class_eval do
+        include Policy # ::build_policy
+        include Model::External # ::build_operation_class
+
+        extend BuildOperation # ::build_operation
+      end
+    end
+
+    module BuildOperation
+      def build_operation(params, options={})
+        model  = model!(params)
+        policy = policy_config.call(params[:current_user], model)
+        build_operation_class(model, policy, params).
+          new(params, options.merge(model: model, policy: policy))
+      end
+    end
+
+    def initialize(params, options)
+      @policy = options[:policy]
+      super
+    end
+  end
+end

data/lib/trailblazer/operation/responder.rb

@@ -1,5 +1,4 @@
 module Trailblazer::Operation::Responder
-  # TODO: test me.
   def self.included(base)
     base.extend ClassMethods
   end

data/lib/trailblazer/operation/worker.rb

@@ -7,7 +7,7 @@ class Trailblazer::Operation
   # Works with Reform 2, only.
   module Worker
     def self.included(base)
-      base.send(:include, Sidekiq::Worker) # TODO: this will work with any bg gem.
+      base.send(:include, Sidekiq::Worker)
       base.extend(ClassMethods)
     end
 
@@ -17,10 +17,28 @@ class Trailblazer::Operation
           return perform_async(serializable(params))
         end
 
-        new.run(params)
+        super(params)
+      end
+
+      def new(*args)
+        return super if args.any?
+        # sidekiq behavior: (not a big fan of this)
+        self
+      end
+
+      def perform(params) # called by Sidekiq.
+        build_operation(params).perform
+      end
+
+      def jid=(jid)
+        puts "@@@@@ #{jid.inspect}"
       end
 
     private
+      def perform_async(*args)
+        client_push('class' => self, 'args' => args) # calls class.new.perform(params)
+      end
+
       def background? # TODO: make configurable.
         true
         # if Rails.env == "production" or Rails.env == "staging"
@@ -32,16 +50,15 @@ class Trailblazer::Operation
     end
 
 
-    # called from Sidekiq.
-    def perform(params)
+    def perform#(params)
       # the serialized params hash from Sidekiq contains a Op::UploadedFile hash.
 
       # the following code is basically what happens in a controller.
       # this is a bug in Rails, it doesn't work without requiring as/hash/ina
       # params = ActiveSupport::HashWithIndifferentAccess.new_from_hash_copying_default(params) # TODO: this might make it ultra-slow as Reform converts it back to strings.
-      params = params.with_indifferent_access
-
-      run(deserializable(params))
+      params = @params.with_indifferent_access
+      @params = deserializable(params)
+      run
     end
 
   private

data/lib/trailblazer/version.rb

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

data/test/collection_test.rb

@@ -1,5 +1,6 @@
 require "test_helper"
 require "trailblazer/operation/collection"
+require "trailblazer/operation/model"
 
 class CollectionTest < MiniTest::Spec
   Song = Struct.new(:title, :id) do
@@ -14,7 +15,7 @@ class CollectionTest < MiniTest::Spec
 
 
   class CreateOperation < Trailblazer::Operation
-    include CRUD
+    include Model
     model Song
     action :create
 

data/test/{crud_test.rb → model_test.rb}

@@ -1,7 +1,7 @@
 require 'test_helper'
 require 'trailblazer/operation'
 
-class CrudTest < MiniTest::Spec
+class ModelTest < MiniTest::Spec
   Song = Struct.new(:title, :id) do
     class << self
       attr_accessor :find_result # TODO: eventually, replace with AR test.
@@ -14,7 +14,7 @@ class CrudTest < MiniTest::Spec
   end
 
   class CreateOperation < Trailblazer::Operation
-    include CRUD
+    include Model
     model Song
     action :create
 
@@ -32,9 +32,9 @@ class CrudTest < MiniTest::Spec
 
 
   # creates model for you.
-  it { CreateOperation[song: {title: "Blue Rondo a la Turk"}].model.title.must_equal "Blue Rondo a la Turk" }
+  it { CreateOperation.(song: {title: "Blue Rondo a la Turk"}).model.title.must_equal "Blue Rondo a la Turk" }
   # exposes #model.
-  it { CreateOperation[song: {title: "Blue Rondo a la Turk"}].model.must_be_instance_of Song }
+  it { CreateOperation.(song: {title: "Blue Rondo a la Turk"}).model.must_be_instance_of Song }
 
   class ModifyingCreateOperation < CreateOperation
     def process(params)
@@ -47,8 +47,8 @@ class CrudTest < MiniTest::Spec
   end
 
   # lets you modify model.
-  it { ModifyingCreateOperation[song: {title: "Blue Rondo a la Turk"}].model.title.must_equal "Blue Rondo a la Turk" }
-  it { ModifyingCreateOperation[song: {title: "Blue Rondo a la Turk"}].model.genre.must_equal "Punkrock" }
+  it { ModifyingCreateOperation.(song: {title: "Blue Rondo a la Turk"}).model.title.must_equal "Blue Rondo a la Turk" }
+  it { ModifyingCreateOperation.(song: {title: "Blue Rondo a la Turk"}).model.genre.must_equal "Punkrock" }
 
   # Update
   class UpdateOperation < CreateOperation
@@ -57,10 +57,10 @@ class CrudTest < MiniTest::Spec
 
   # finds model and updates.
   it do
-    song = CreateOperation[song: {title: "Anchor End"}].model
+    song = CreateOperation.(song: {title: "Anchor End"}).model
     Song.find_result = song
 
-    UpdateOperation[id: song.id, song: {title: "The Rip"}].model.title.must_equal "The Rip"
+    UpdateOperation.(id: song.id, song: {title: "The Rip"}).model.title.must_equal "The Rip"
     song.title.must_equal "The Rip"
   end
 
@@ -71,16 +71,16 @@ class CrudTest < MiniTest::Spec
 
   # finds model and updates.
   it do
-    song = CreateOperation[song: {title: "Anchor End"}].model
+    song = CreateOperation.(song: {title: "Anchor End"}).model
     Song.find_result = song
 
-    FindOperation[id: song.id, song: {title: "The Rip"}].model.title.must_equal "The Rip"
+    FindOperation.(id: song.id, song: {title: "The Rip"}).model.title.must_equal "The Rip"
     song.title.must_equal "The Rip"
   end
 
 
   class DefaultCreateOperation < Trailblazer::Operation
-    include CRUD
+    include Model
     model Song
 
     def process(params)
@@ -89,7 +89,7 @@ class CrudTest < MiniTest::Spec
   end
 
   # uses :create as default if not set via ::action.
-  it { DefaultCreateOperation[{}].model.must_equal Song.new }
+  it { DefaultCreateOperation.({}).model.must_equal Song.new }
 
   # model Song, :action
   class ModelUpdateOperation < CreateOperation
@@ -99,7 +99,7 @@ class CrudTest < MiniTest::Spec
   # allows ::model, :action.
   it do
     Song.find_result = song = Song.new
-    ModelUpdateOperation[{id: 1, song: {title: "Mercy Day For Mr. Vengeance"}}].model.must_equal song
+    ModelUpdateOperation.({id: 1, song: {title: "Mercy Day For Mr. Vengeance"}}).model.must_equal song
   end
 
 
@@ -111,13 +111,13 @@ class CrudTest < MiniTest::Spec
     end
   end
 
-  it { SetupModelOperation[song: {title: "Emily Kane"}].model.params.must_equal "{:song=>{:title=>\"Emily Kane\"}}" }
+  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
+    include Model
 
     def process(params)
       self
@@ -125,29 +125,11 @@ class CrudTest < MiniTest::Spec
   end
 
   # 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" }
-
+  it { assert_raises(RuntimeError){ NoModelOperation.({}) } }
 
   # allow passing validate(params, model, contract_class)
   class OperationWithPrivateContract < Trailblazer::Operation
-    include CRUD
+    include Model
     model Song
 
     class Contract < Reform::Form

data/test/operation/builder_test.rb

@@ -0,0 +1,41 @@
+require "test_helper"
+
+class OperationBuilderTest < MiniTest::Spec
+  class ParentOperation < Trailblazer::Operation
+    def process(params)
+    end
+
+    class Sub < self
+    end
+
+    builds do |params|
+      Sub if params[:sub]
+    end
+  end
+
+  it { ParentOperation.run({}).last.class.must_equal ParentOperation }
+  it { ParentOperation.run({sub: true}).last.class.must_equal ParentOperation::Sub }
+  it { ParentOperation.({}).class.must_equal ParentOperation }
+  it { ParentOperation.({sub: true}).class.must_equal ParentOperation::Sub }
+end
+
+class OperationBuilderClassTest < MiniTest::Spec
+  class SuperOperation < Trailblazer::Operation
+    builds do |params|
+      self::Sub if params[:sub] # Sub is defined in ParentOperation.
+    end
+  end
+
+  class ParentOperation < Trailblazer::Operation
+    def process(params)
+    end
+
+    class Sub < self
+    end
+
+    self.builder_class = SuperOperation.builder_class
+  end
+
+  it { ParentOperation.({}).class.must_equal ParentOperation }
+  it { ParentOperation.({sub: true}).class.must_equal ParentOperation::Sub }
+end

data/test/operation/dsl/callback_test.rb

@@ -0,0 +1,108 @@
+require "test_helper"
+require "trailblazer/operation/dispatch"
+
+
+class DslCallbackTest < MiniTest::Spec
+  module SongProcess
+    def process(params)
+      contract(OpenStruct.new).validate(params)
+      dispatch!
+    end
+
+    def _invocations
+      @_invocations ||= []
+    end
+
+    def self.included(includer)
+      includer.contract do
+        property :title
+      end
+    end
+  end
+
+  describe "inheritance across operations" do
+    class Operation < Trailblazer::Operation
+      include Dispatch
+      include SongProcess
+
+      callback do
+        on_change :default!
+      end
+
+      class Admin < self
+        callback do
+          on_change :admin_default!
+        end
+
+        callback(:after_save) { on_change :after_save! }
+
+        def admin_default!(*); _invocations << :admin_default!; end
+        def after_save!(*);    _invocations << :after_save!; end
+
+        def process(*)
+          super
+          dispatch!(:after_save)
+        end
+      end
+
+      def default!(*); _invocations << :default!; end
+    end
+
+    it { Operation.({"title"=> "Love-less"})._invocations.must_equal([:default!]) }
+    it { Operation::Admin.({"title"=> "Love-less"})._invocations.must_equal([:default!, :admin_default!, :after_save!]) }
+  end
+
+  describe "Op.callback" do
+    it { Operation.callback(:default).must_equal Operation.callbacks[:default] }
+  end
+
+  describe "Op.callback :after_save, AfterSaveCallback" do
+    class AfterSaveCallback < Disposable::Callback::Group
+      on_change :after_save!
+    end
+
+    class OpWithExternalCallback < Trailblazer::Operation
+      include Dispatch
+      include SongProcess
+      callback :after_save, AfterSaveCallback
+
+      def process(params)
+        contract(OpenStruct.new).validate(params)
+        dispatch!(:after_save)
+      end
+
+      def after_save!(*);    _invocations << :after_save!; end
+    end
+
+    it { OpWithExternalCallback.("title"=>"Thunder Rising")._invocations.must_equal([:after_save!]) }
+  end
+
+  describe "Op.callback :after_save, AfterSaveCallback do .. end" do
+    class DefaultCallback < Disposable::Callback::Group
+      on_change :default!
+    end
+
+    class OpUsingCallback < Trailblazer::Operation
+      include Dispatch
+      include SongProcess
+      callback :default, DefaultCallback
+      def default!(*);       _invocations << :default!; end
+    end
+
+    class OpExtendingCallback < Trailblazer::Operation
+      include Dispatch
+      include SongProcess
+      callback :default, DefaultCallback do
+        on_change :after_save!
+      end
+
+      def default!(*);       _invocations << :default!; end
+      def after_save!(*);    _invocations << :after_save!; end
+    end
+
+    # this operation copies DefaultCallback and shouldn't run #after_save!.
+    it { OpUsingCallback.(title: "Thunder Rising")._invocations.must_equal([:default!]) }
+    # this operation copies DefaultCallback, extends it and runs #after_save!.
+    it { OpExtendingCallback.(title: "Thunder Rising")._invocations.must_equal([:default!, :after_save!]) }
+  end
+end

data/test/operation/dsl/contract_test.rb

@@ -0,0 +1,104 @@
+require "test_helper"
+
+# ::contract builds Reform::Form class
+class DslContractTest < MiniTest::Spec
+  module SongProcess
+    def process(params)
+      validate(params, @model = OpenStruct.new)
+    end
+  end
+
+  describe "inheritance across operations" do
+    # inheritance
+    class Operation < Trailblazer::Operation
+      contract do
+        property :title
+        property :band
+      end
+
+      class JSON < self
+        contract do # inherit Contract
+          property :genre, validates: {presence: true}
+          property :band, virtual: true
+        end
+      end
+    end
+
+    # inherits subclassed Contract.
+    it { Operation.contract_class.wont_equal Operation::JSON.contract_class }
+
+    it do
+      form = Operation.contract_class.new(OpenStruct.new)
+      form.validate({})#.must_equal true
+      form.errors.to_s.must_equal "{}"
+
+      form = Operation::JSON.contract_class.new(OpenStruct.new)
+      form.validate({})#.must_equal true
+      form.errors.to_s.must_equal "{:genre=>[\"can't be blank\"]}"
+    end
+
+    # allows overriding options
+    it do
+      form = Operation::JSON.contract_class.new(song = OpenStruct.new)
+      form.validate({genre: "Punkrock", band: "Osker"}).must_equal true
+      form.sync
+
+      song.genre.must_equal "Punkrock"
+      song.band.must_equal nil
+    end
+  end
+
+  describe "Op.contract" do
+    it { Operation.contract.must_equal Operation.contract_class }
+  end
+
+  describe "Op.contract CommentForm" do
+    class SongForm < Reform::Form
+      property :songTitle, validates: {presence: true}
+    end
+
+    class OpWithExternalContract < Trailblazer::Operation
+      contract SongForm
+      include SongProcess
+    end
+
+    it { OpWithExternalContract.("songTitle"=> "Monsterparty").contract.songTitle.must_equal "Monsterparty" }
+  end
+
+  describe "Op.contract CommentForm do .. end" do
+    class DifferentSongForm < Reform::Form
+      property :songTitle, validates: {presence: true}
+    end
+
+    class OpNotExtendingContract < Trailblazer::Operation
+      contract DifferentSongForm
+      include SongProcess
+    end
+
+    class OpExtendingContract < Trailblazer::Operation
+      contract DifferentSongForm do
+        property :genre
+      end
+      include SongProcess
+    end
+
+    # this operation copies DifferentSongForm and shouldn't have `genre`.
+    it do
+      contract = OpNotExtendingContract.("songTitle"=>"Monsterparty", "genre"=>"Punk").contract
+      contract.songTitle.must_equal "Monsterparty"
+      assert_raises(NoMethodError) { contract.genre }
+    end
+
+    # this operation copies DifferentSongForm and extends it with the property `genre`.
+    it do
+      contract = OpExtendingContract.("songTitle"=>"Monsterparty", "genre"=>"Punk").contract
+      contract.songTitle.must_equal "Monsterparty"
+      contract.genre.must_equal "Punk"
+    end
+
+    # of course, the original contract wasn't modified, either.
+    it do
+      assert_raises(NoMethodError) { DifferentSongForm.new(OpenStruct.new).genre }
+    end
+  end
+end