trailblazer-compat 0.1.0

data/lib/trailblazer/1.1/operation/uploaded_file.rb

@@ -0,0 +1,77 @@
+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/lib/trailblazer/1.1/operation/worker.rb

@@ -0,0 +1,112 @@
+require 'sidekiq/worker'
+require 'active_support/core_ext/hash/indifferent_access'
+
+#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.
+
+class Trailblazer::Operation
+  # only kicks in when Operation::run, #run will still do it real-time
+  # Works with Reform 2, only.
+  module Worker
+    def self.included(base)
+      base.send(:include, Sidekiq::Worker)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def run(params)
+        if background?
+          return perform_async(serializable(params))
+        end
+
+        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"
+      end
+
+      def serializable(params)
+        params # this is where we convert file uloads into Trailblazer::UploadedFile, etc. soon.
+      end
+    end
+
+
+    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
+      @params = deserializable(params)
+      run
+    end
+
+  private
+    def deserializable(params)
+      params # this is where we convert file uloads into Trailblazer::UploadedFile, etc. soon.
+    end
+
+
+    # Overrides ::serializable and #deserializable and handles file properties from the Contract schema.
+    module FileMarshaller
+      # NOTE: this is WIP and the implementation will be more understandable and performant soon.
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+
+    private
+      module ClassMethods
+        def file_marshaller_representer
+          @file_marshaller_representer ||= contract_class.schema(include: [Representable::Hash]).apply do |dfn|
+            dfn.merge!(
+              getter: lambda { |*| self[dfn.name.to_sym] },
+              setter: lambda { |fragment, *| self[dfn.name.to_s] = fragment }
+            ) # FIXME: allow both sym and str.
+
+            dfn.merge!(class: Hash) and next if dfn[:form] or dfn[:twin] # nested properties need a class for deserialization.
+            next unless dfn[:file]
+
+            # TODO: where do we set /tmp/uploads?
+            dfn.merge!(
+              serialize: lambda { |file, *| Trailblazer::Operation::UploadedFile.new(file, tmp_dir: "/tmp/uploads").to_hash },
+              deserialize: lambda { |object, hash, *| Trailblazer::Operation::UploadedFile.from_hash(hash) },
+              class: Hash
+            )
+          end
+        end
+
+        def serializable(params)
+          file_marshaller_representer.new(params).to_hash
+        end
+      end
+
+      # todo: do with_indifferent_access in #deserialize and call super here.
+      def deserializable(hash)
+        # self.class.file_marshaller_representer.new({}).extend(Representable::Debug).from_hash(hash)
+        self.class.file_marshaller_representer.new({}.with_indifferent_access).from_hash(hash)
+      end
+    end
+  end
+end

data/lib/trailblazer/1.1/rails.rb

@@ -0,0 +1,21 @@
+require "reform/rails"
+require "trailblazer/1.1/rails/railtie"
+
+require "trailblazer/1.1/operation"
+# TODO: remove that once i18n, validations etc in Reform/AM are sorted.
+Trailblazer::V1_1::Operation.contract_class.class_eval do
+  def self.name
+    # for whatever reason, validations climb up the inheritance tree and require _every_ class to have a name (4.1).
+    "Reform::Form"
+  end
+end
+
+# Automatically set model_name on operation's contract when `Op::Model` is included.
+require "trailblazer/1.1/operation/model"
+require "trailblazer/1.1/operation/model/active_model"
+Trailblazer::V1_1::Operation::Model::DSL.module_eval do
+  include Trailblazer::V1_1::Operation::Model::ActiveModel # ::contract.
+end
+
+require "trailblazer/1.1/autoloading"
+require "trailblazer/1.1/rails/autoloading"

data/lib/trailblazer/1.1/rails/autoloading.rb

@@ -0,0 +1,3 @@
+Trailblazer::V1_1::Operation.class_eval do
+  autoload :Responder,  "trailblazer/1.1/operation/responder"
+end

data/lib/trailblazer/1.1/rails/railtie.rb

@@ -0,0 +1,24 @@
+require "rails/railtie"
+
+module Trailblazer::V1_1
+  class Railtie < ::Rails::Railtie
+    # This is to autoload Operation::Dispatch, etc. I'm simply assuming people find this helpful in Rails.
+    initializer "trailblazer.library_autoloading" do
+      require "trailblazer/1.1/autoloading"
+    end
+
+    initializer "trailblazer.application_controller" do
+      ActiveSupport.on_load(:action_controller) do
+        require "trailblazer/rails/railtie"
+        # this requires trailblazer-rails-1.0.0
+        V2_Controller = Trailblazer::Rails::Controller
+
+        ActionController::Base.class_eval do
+          include V2_Controller # if Trailblazer::Operation.const_defined?(:Controller) # from V2.
+          alias run_v2 run
+          include Trailblazer::V1_1::Operation::Controller
+        end
+      end
+    end
+  end
+end

data/lib/trailblazer/1.1/rails/test/integration.rb

@@ -0,0 +1,6 @@
+require "minitest/rails/capybara" # loads Capybara, etc.
+
+module Trailblazer::V1_1::Test
+  class Integration < Capybara::Rails::TestCase
+  end
+end

data/lib/trailblazer/compat.rb

@@ -0,0 +1,50 @@
+require "trailblazer/compat/version"
+
+module Trailblazer
+  module V1_1
+    # Your code goes here...
+  end
+
+  module V2
+  end
+
+  module Compat
+    module Version
+      def version(v)
+        V2::Operation
+      end
+    end
+  end
+end
+
+
+require "trailblazer/operation" # 2.x
+require "trailblazer/operation/model" # 2.x
+require "trailblazer/operation/policy" # 2.x
+require "trailblazer/operation/pundit" # 2.x
+require "trailblazer/operation/guard" # 2.x
+require "trailblazer/operation/contract" # 2.x
+require "trailblazer/operation/validate" # 2.x
+require "trailblazer/operation/persist" # 2.x
+require "trailblazer/operation/rescue" # 2.x
+require "trailblazer/operation/wrap" # 2.x
+require "trailblazer/operation/nested" # 2.x
+
+Trailblazer::V2::Operation = ::Trailblazer::Operation # copy TRB2 Operation constant to a safe place.
+
+require "trailblazer/1.1/rails"
+
+Trailblazer.send(:remove_const, :Operation)
+Trailblazer.send(:const_set, :Operation, Trailblazer::V1_1::Operation) # TRB::Op is now TRB 1.1
+
+# Trailblazer::Operation = Trailblazer::V1_1::Operation
+Trailblazer::NotAuthorizedError = Trailblazer::V1_1::NotAuthorizedError
+
+Trailblazer::Operation.extend(Trailblazer::Compat::Version)
+
+Trailblazer::V2::Operation::Nested.module_eval do
+  def self.nestable_object?(object)
+    # interestingly, with < we get a weird nil exception. bug in Ruby?
+    object.is_a?(Class) && object <= Trailblazer::V2::Operation
+  end
+end

data/lib/trailblazer/compat/version.rb

@@ -0,0 +1,5 @@
+module Trailblazer
+  module Compat
+    VERSION = "0.1.0"
+  end
+end

data/trailblazer-compat.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'trailblazer/compat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "trailblazer-compat"
+  spec.version       = Trailblazer::Compat::VERSION
+  spec.authors       = ["Nick Sutterer"]
+  spec.email         = ["apotonick@gmail.com"]
+
+  spec.summary       = %q{Use Trailblazer 1.1 and 2.x.}
+  spec.description   = %q{Use Trailblazer 1.1 and 2.x in one application.}
+  spec.homepage      = "http://trailblazer.to"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # spec.add_dependency "trailblazer", ">= 1.2.0", "< 1.3.0"
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: trailblazer-compat
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nick Sutterer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Use Trailblazer 1.1 and 2.x in one application.
+email:
+- apotonick@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/trailblazer/1.1/autoloading.rb
+- lib/trailblazer/1.1/endpoint.rb
+- lib/trailblazer/1.1/operation.rb
+- lib/trailblazer/1.1/operation/builder.rb
+- lib/trailblazer/1.1/operation/callback.rb
+- lib/trailblazer/1.1/operation/collection.rb
+- lib/trailblazer/1.1/operation/controller.rb
+- lib/trailblazer/1.1/operation/controller/active_record.rb
+- lib/trailblazer/1.1/operation/dispatch.rb
+- lib/trailblazer/1.1/operation/model.rb
+- lib/trailblazer/1.1/operation/model/active_model.rb
+- lib/trailblazer/1.1/operation/model/dsl.rb
+- lib/trailblazer/1.1/operation/model/external.rb
+- lib/trailblazer/1.1/operation/module.rb
+- lib/trailblazer/1.1/operation/policy.rb
+- lib/trailblazer/1.1/operation/policy/guard.rb
+- lib/trailblazer/1.1/operation/representer.rb
+- lib/trailblazer/1.1/operation/resolver.rb
+- lib/trailblazer/1.1/operation/responder.rb
+- lib/trailblazer/1.1/operation/uploaded_file.rb
+- lib/trailblazer/1.1/operation/worker.rb
+- lib/trailblazer/1.1/rails.rb
+- lib/trailblazer/1.1/rails/autoloading.rb
+- lib/trailblazer/1.1/rails/railtie.rb
+- lib/trailblazer/1.1/rails/test/integration.rb
+- lib/trailblazer/compat.rb
+- lib/trailblazer/compat/version.rb
+- trailblazer-compat.gemspec
+homepage: http://trailblazer.to
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Use Trailblazer 1.1 and 2.x.
+test_files: []