trailblazer 1.1.2 → 2.0.0.beta1

data/lib/trailblazer/operation/policy/guard.rb

@@ -1,35 +0,0 @@
-module Trailblazer
-  # Policy::Guard is a very simple policy implementation.
-  # It adds #evaluate_policy to Operation#setup! and calls whatever
-  # you provided to ::policy.
-  #
-  # http://trailblazer.to/gems/operation/policy.html#guard
-  module Operation::Policy
-    module Guard
-      def self.included(includer)
-        includer.extend(DSL) # Provides ::policy(CallableObject)
-        includer.extend(ClassMethods)
-        includer.send(:include, Setup)
-      end
-
-      module ClassMethods
-        def policy(callable=nil, &block)
-          self.policy_config = Uber::Options::Value.new(callable || block)
-        end
-      end
-
-      def evaluate_policy(params)
-        call_policy(params) or raise policy_exception
-      end
-
-      # Override if you want your own policy invocation, e.g. with more args.
-      def call_policy(params)
-        self.class.policy_config.(self, params)
-      end
-
-      def policy_exception
-        NotAuthorizedError.new
-      end
-    end
-  end
-end

data/lib/trailblazer/operation/uploaded_file.rb

@@ -1,77 +0,0 @@
-require 'trailblazer/operation'
-require 'action_dispatch/http/upload'
-require 'tempfile'
-
-module Trailblazer
-  # TODO: document:
-  # to_hash
-  # from_hash
-  # initialize/tmp_dir
-  class Operation::UploadedFile
-    def initialize(uploaded, options={})
-      @uploaded = uploaded
-      @options  = options
-      @tmp_dir  = options[:tmp_dir]
-    end
-
-    def to_hash
-      path = persist!
-
-      hash = {
-        filename: @uploaded.original_filename,
-        type: @uploaded.content_type,
-        tempfile_path: path
-      }
-
-      cleanup!
-
-      hash
-    end
-
-    # Returns a ActionDispatch::Http::UploadedFile as if the upload was in the same request.
-    def self.from_hash(hash)
-      suffix = File.extname(hash[:filename])
-
-      # we need to create a Tempfile to make Http::UploadedFile work.
-      tmp  = Tempfile.new(["bla", suffix]) # always force file suffix to avoid problems with imagemagick etc.
-      file = File.open(hash[:tempfile_path])# doesn't close automatically :( # fixme: introduce strategy (Tempfile:=>slow, File:=> hopefully less memory footprint)
-      tmp.write(file.read) # DISCUSS: We need Tempfile.new(<File>) to avoid this slow and memory-consuming mechanics.
-
-      file.close # TODO: can we test that?
-      File.unlink(file)
-
-      ActionDispatch::Http::UploadedFile.new(hash.merge(tempfile: tmp))
-    end
-
-  private
-    attr_reader :tmp_dir
-
-     # convert Tempfile from Rails upload into persistent "temp" file so it is available in workers.
-    def persist!
-      path = @uploaded.path # original Tempfile path (from Rails).
-      path = path_with_tmp_dir(path)
-
-      path = path + "_trailblazer_upload"
-
-      FileUtils.mv(@uploaded.path, path) # move Rails upload file into persistent `path`.
-      path
-    end
-
-    def path_with_tmp_dir(path)
-      return path unless tmp_dir # if tmp_dir set, create path in it.
-
-      @with_tmp_dir = Tempfile.new(File.basename(path), tmp_dir)
-      @with_tmp_dir.path # use Tempfile to create nested dirs (os-dependent.)
-    end
-
-    def delete!(file)
-      file.close
-      file.unlink # the Rails uploaded file is already unlinked since moved.
-    end
-
-    def cleanup!
-      delete!(@uploaded.tempfile) if @uploaded.respond_to?(:tempfile) # this is Rails' uploaded file, not sure if we need to do that. in 3.2, we don't have UploadedFile#close, yet.
-      delete!(@with_tmp_dir) if @with_tmp_dir # we used that file to create a tmp file path below tmp_dir.
-    end
-  end
-end

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/operation/external_model_test.rb

@@ -1,71 +0,0 @@
-require "test_helper"
-require "trailblazer/operation/model/external"
-
-class ExternalModelTest < 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.tap do |song|
-          song.id = id
-        end
-      end
-    end
-  end # FIXME: use from CrudTest.
-
-
-
-
-  class Bla < Trailblazer::Operation
-    include Model::External
-    model Song, :update
-
-    def process(params)
-    end
-  end
-
-  let (:song) { Song.new("Numbers") }
-
-  before do
-    Song.find_result = song
-  end
-
-  # ::model!
-  it do
-    Bla.model!(id: 1).must_equal song
-    song.id.must_equal 1
-  end
-
-  # call style.
-  it do
-    Bla.(id: 2).model.must_equal song
-    song.id.must_equal 2
-  end
-
-  # #present.
-  it do
-    Bla.present({}).model.must_equal song
-  end
-
-
-  class OpWithBuilder < Bla
-    class A < self
-    end
-
-    builds -> (model, params) do
-      return A if model.id == 1 and params[:user] == 2
-    end
-  end
-
-  describe "::builds args" do
-    it do
-      OpWithBuilder.(id: 1, user: "different").must_be_instance_of OpWithBuilder
-    end
-
-    it do
-      OpWithBuilder.(id: 1, user: 2).must_be_instance_of OpWithBuilder::A
-    end
-  end
-end