trailblazer 1.1.1 → 2.1.0

data/test/callback_test.rb

@@ -1,104 +0,0 @@
-require 'test_helper'
-require "trailblazer/operation/callback"
-
-# callbacks are tested in Disposable::Callback::Group.
-class OperationCallbackTest < MiniTest::Spec
-  Song = Struct.new(:name)
-
-  class Create < Trailblazer::Operation
-    include Trailblazer::Operation::Callback
-
-    contract do
-      property :name
-    end
-
-    callback do
-      on_change :notify_me!
-      on_change :notify_you!
-    end
-
-    # TODO: always dispatch, pass params.
-
-    def process(params)
-      @model = Song.new
-
-      validate(params, @model) do
-        callback!
-      end
-    end
-
-    def dispatched
-      @dispatched ||= []
-    end
-
-  private
-    def notify_me!(*)
-      dispatched << :notify_me!
-    end
-
-    def notify_you!(*)
-      dispatched << :notify_you!
-    end
-  end
-
-
-  class Update < Create
-    # TODO: allow skipping groups.
-    # skip_dispatch :notify_me!
-
-    callback do
-      remove! :on_change, :notify_me!
-    end
-  end
-
-
-  it "invokes all callbacks" do
-    op = Create.({"name"=>"Keep On Running"})
-    op.dispatched.must_equal [:notify_me!, :notify_you!]
-  end
-
-  it "does not invoke removed callbacks" do
-    op = Update.({"name"=>"Keep On Running"})
-    op.dispatched.must_equal [:notify_you!]
-  end
-end
-
-# TODO: remove in 1.2.
-require "trailblazer/operation/dispatch"
-class OperationDeprecatedDispatchTest < MiniTest::Spec
-  Song = Struct.new(:name)
-
-  class Create < Trailblazer::Operation
-    include Trailblazer::Operation::Dispatch
-
-    contract do
-      property :name
-    end
-
-    callback do
-      on_change :notify_me!
-    end
-
-    def process(params)
-      @model = Song.new
-
-      validate(params, @model) do
-        dispatch!
-      end
-    end
-
-    def dispatched
-      @dispatched ||= []
-    end
-
-  private
-    def notify_me!(*)
-      dispatched << :notify_me!
-    end
-  end
-
-  it "invokes all callbacks [deprecated]" do
-    op = Create.({"name"=>"Keep On Running"})
-    op.dispatched.must_equal [:notify_me!]
-  end
-end

data/test/collection_test.rb

@@ -1,57 +0,0 @@
-require "test_helper"
-require "trailblazer/operation/collection"
-require "trailblazer/operation/model"
-
-class CollectionTest < MiniTest::Spec
-  Song = Struct.new(:title, :id) do
-    class << self
-      attr_accessor :all_records
-
-      def all
-        all_records
-      end
-    end
-  end
-
-
-  class CreateOperation < Trailblazer::Operation
-    include Model
-    model Song
-    action :create
-
-    contract do
-      property :title
-      validates :title, presence: true
-    end
-
-    def process(params)
-      validate(params[:song]) do |f|
-        f.sync
-      end
-    end
-  end
-
-  class FetchCollectionOperation < CreateOperation
-    include Trailblazer::Operation::Collection
-
-    model Song
-
-    contract do
-      property :title
-    end
-
-    def model!(params)
-      Song.all
-    end
-  end
-
-  # ::present.
-  it do
-    Song.all_records = [
-      CreateOperation.(song: {title: "Blue Rondo a la Turk"}).model,
-      CreateOperation.(song: {title: "Mercy Day For Mr. Vengeance"}).model
-    ]
-    op = FetchCollectionOperation.present(user_id: 0)
-    op.model.must_equal Song.all_records
-  end
-end

data/test/model_test.rb

@@ -1,148 +0,0 @@
-require 'test_helper'
-require 'trailblazer/operation'
-
-class ModelTest < MiniTest::Spec
-  Song = Struct.new(:title, :id) do
-    class << self
-      attr_accessor :find_result # TODO: eventually, replace with AR test.
-      attr_accessor :all_records
-
-      def find(id)
-        find_result
-      end
-    end
-  end
-
-  class CreateOperation < Trailblazer::Operation
-    include Model
-    model Song
-    action :create
-
-    contract do
-      property :title
-      validates :title, presence: true
-    end
-
-    def process(params)
-      validate(params[:song]) do |f|
-        f.sync
-      end
-    end
-  end
-
-
-  # creates model for you.
-  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 }
-
-  class ModifyingCreateOperation < CreateOperation
-    def process(params)
-      model.instance_eval { def genre; "Punkrock"; end }
-
-      validate(params[:song]) do |f|
-        f.sync
-      end
-    end
-  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" }
-
-  # Update
-  class UpdateOperation < CreateOperation
-    action :update
-  end
-
-  # finds model and updates.
-  it do
-    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"
-    song.title.must_equal "The Rip"
-  end
-
-  # Find == Update
-  class FindOperation < CreateOperation
-    action :find
-  end
-
-  # finds model and updates.
-  it do
-    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"
-    song.title.must_equal "The Rip"
-  end
-
-
-  class DefaultCreateOperation < Trailblazer::Operation
-    include Model
-    model Song
-
-    def process(params)
-      self
-    end
-  end
-
-  # uses :create as default if not set via ::action.
-  it { DefaultCreateOperation.({}).model.must_equal Song.new }
-
-  # model Song, :action
-  class ModelUpdateOperation < CreateOperation
-    model Song, :update
-  end
-
-  # 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
-  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 Model
-
-    def process(params)
-      self
-    end
-  end
-
-  # uses :create as default if not set via ::action.
-  it { assert_raises(RuntimeError){ NoModelOperation.({}) } }
-
-  # allow passing validate(params, model, contract_class)
-  class OperationWithPrivateContract < Trailblazer::Operation
-    include Model
-    model Song
-
-    class Contract < Reform::Form
-      property :title
-    end
-
-    def process(params)
-      validate(params[:song], model, Contract) do |f|
-        f.sync
-      end
-    end
-  end
-
-  # uses private Contract class.
-  it { OperationWithPrivateContract.(song: {title: "Blue Rondo a la Turk"}).model.title.must_equal "Blue Rondo a la Turk" }
-end

data/test/module_test.rb

@@ -1,93 +0,0 @@
-require 'test_helper'
-require "trailblazer/operation/module"
-require "trailblazer/operation/dispatch"
-
-class OperationModuleTest < MiniTest::Spec
-  Song = Struct.new(:name, :artist)
-  Artist = Struct.new(:id, :full_name)
-
-  class Create < Trailblazer::Operation
-    include Trailblazer::Operation::Dispatch
-
-    contract do
-      property :name
-      property :artist, populate_if_empty: Artist do
-        property :id
-      end
-    end
-
-    callback do
-      on_change :notify_me!
-    end
-
-    def process(params)
-      @model = Song.new
-
-      validate(params, @model) do
-        contract.sync
-
-        dispatch!
-      end
-    end
-
-    def dispatched
-      @dispatched ||= []
-    end
-
-  private
-    def notify_me!(*)
-      dispatched << :notify_me!
-    end
-  end
-
-
-  module SignedIn
-    include Trailblazer::Operation::Module
-
-    contract do
-      property :artist, inherit: true do
-        property :full_name
-      end
-    end
-
-    callback do
-      on_change :notify_you!
-    end
-
-    def notify_you!(*)
-      dispatched << :notify_you!
-    end
-  end
-
-
-  class Update < Create
-    callback do
-      on_change :notify_them!
-    end
-
-    include SignedIn
-
-    def notify_them!(*)
-      dispatched << :notify_them!
-    end
-  end
-
-
-  it do
-    op = Create.({name: "Feelings", artist: {id: 1, full_name: "The Offspring"}})
-
-    op.dispatched.must_equal [:notify_me!]
-    op.model.name.must_equal "Feelings"
-    op.model.artist.id.must_equal 1
-    op.model.artist.full_name.must_equal nil # property not declared.
-  end
-
-  it do
-    op = Update.({name: "Feelings", artist: {id: 1, full_name: "The Offspring"}})
-
-    op.dispatched.must_equal [:notify_me!, :notify_them!, :notify_you!]
-    op.model.name.must_equal "Feelings"
-    op.model.artist.id.must_equal 1
-    op.model.artist.full_name.must_equal "The Offspring" # property declared via Module.
-  end
-end

data/test/operation/builder_test.rb

@@ -1,41 +0,0 @@
-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/contract_test.rb

@@ -1,30 +0,0 @@
-require "test_helper"
-
-
-class OperationContractTest < MiniTest::Spec
-
-  class Operation < Trailblazer::Operation
-    contract do
-      property :id
-      property :title
-      property :length
-    end
-
-    def process(params)
-      @model = Struct.new(:id, :title, :length).new
-
-      contract.id = 1
-      validate(params) do
-        contract.length = 3
-      end
-    end
-  end
-
-  # allow using #contract before #validate.
-  it do
-    op = Operation.(title: "Beethoven")
-    op.contract.id.must_equal 1
-    op.contract.title.must_equal "Beethoven"
-    op.contract.length.must_equal 3
-  end
-end

data/test/operation/controller_test.rb

@@ -1,111 +0,0 @@
-require "test_helper"
-require "trailblazer/operation/controller"
-
-class ControllerTest < Minitest::Spec
-  def self.controller!(&block)
-    let (:_controller) {
-      Class.new do
-        include Trailblazer::Operation::Controller
-
-        def initialize(params={})
-          @params = params
-        end
-        attr_reader :params, :request
-
-        class_eval(&block)
-        self
-      end
-    }
-  end
-
-  def controller(params={})
-    _controller.new(params)
-  end
-
-
-  User = Struct.new(:role)
-
-  Comment = Struct.new(:body)
-
-  class Comment::Update < Trailblazer::Operation
-    def model!(params)
-      Comment.new(params[:body])
-    end
-
-    def inspect
-      super.sub(/:0x\w+/, "")
-    end
-  end
-
-
-  describe "#present with options" do
-    controller! do
-      def show
-        present Comment::Update, params: { current_user: User.new(:admin) }
-      end
-    end
-
-    it do
-      controller.show.inspect.must_equal "#<ControllerTest::Comment::Update @options={}, @valid=true, @params={:current_user=>#<struct ControllerTest::User role=:admin>}, @model=#<struct ControllerTest::Comment body=nil>>"
-    end
-  end
-
-  describe "#params!" do
-    controller! do
-      def show
-        present Comment::Update, params: "Cool!"
-      end
-
-      def params!(params)
-        { body: params }
-      end
-    end
-
-    it { controller.show.inspect.must_equal "#<ControllerTest::Comment::Update @options={}, @valid=true, @params={:body=>\"Cool!\"}, @model=#<struct ControllerTest::Comment body=\"Cool!\">>" }
-  end
-
-  describe "#form" do
-    class Comment::Create < Trailblazer::Operation
-      def model!(params)
-        Comment.new
-      end
-
-      contract do
-        def prepopulate!(options)
-          @options = options
-        end
-        attr_reader :options
-      end
-    end
-
-    describe "#prepopulate! options" do
-      controller! do
-        def show
-          form Comment::Create
-        end
-      end
-
-      it { controller(__body: "Great!").show.options.inspect.must_equal "{:params=>{:__body=>\"Great!\"}}" }
-    end
-
-    describe "with additional options" do
-      controller! do
-        def show
-          form Comment::Create, admin: true
-        end
-      end
-
-      it { controller(__body: "Great!").show.options.inspect.must_equal "{:admin=>true, :params=>{:__body=>\"Great!\"}}" }
-    end
-
-    describe "with options and :params" do
-      controller! do
-        def show
-          form Comment::Create, admin: true, params: params.merge(user: User.new)
-        end
-      end
-
-      it { controller(__body: "Great!").show.options.inspect.must_equal "{:admin=>true, :params=>{:__body=>\"Great!\", :user=>#<struct ControllerTest::User role=nil>}}" }
-    end
-  end
-end

data/test/operation/dsl/callback_test.rb

@@ -1,118 +0,0 @@
-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][:group] }
-  end
-
-  describe "Op.callback :after_save, AfterSaveCallback" do
-    class AfterSaveCallback < Disposable::Callback::Group
-      on_change :after_save!
-
-      def after_save!(twin, options)
-        options[:operation]._invocations << :after_save!
-      end
-    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
-    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!
-
-      def default!(twin, options)
-        options[:operation]._invocations << :default!
-      end
-    end
-
-    class OpUsingCallback < Trailblazer::Operation
-      include Dispatch
-      include SongProcess
-      callback :default, DefaultCallback
-    end
-
-    class OpExtendingCallback < Trailblazer::Operation
-      include Dispatch
-      include SongProcess
-      callback :default, DefaultCallback do
-        on_change :after_save!
-
-        def default!(twin, options)
-          options[:operation]._invocations << :extended_default!
-        end
-
-        def after_save!(twin, options)
-          options[:operation]._invocations << :after_save!
-        end
-      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([:extended_default!, :after_save!]) }
-  end
-end