trailblazer-rails 0.2.4 → 2.4.1

data/lib/trailblazer/rails/form.rb

@@ -0,0 +1,21 @@
+module Trailblazer
+  class Rails::Form < SimpleDelegator
+    def initialize(delegated, model_class)
+      super(delegated)
+      @model_class = model_class
+    end
+
+    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
+
+    def model_name
+      ::ActiveModel::Name.new(self, nil, @model_class.to_s.camelize)
+    end
+
+    def to_model
+      self
+    end
+  end
+end

data/lib/trailblazer/rails/railtie.rb

@@ -1,40 +1,25 @@
 require "rails/railtie"
-require "trailblazer/loader"
 
 module Trailblazer
   class Railtie < ::Rails::Railtie
-    def self.load_concepts(app)
-      Loader.new.(insert: [ModelFile, before: Loader::AddConceptFiles]) { |file| require_dependency("#{app.root}/#{file}") }
-    end
-
-    # This is to autoload Operation::Dispatch, etc. I'm simply assuming people find this helpful in Rails.
-    initializer "trailblazer.library_autoloading" do
-      require "trailblazer/autoloading"
-    end
+    config.trailblazer = ActiveSupport::OrderedOptions.new
+    ## Accept also an Array of controllers
+    config.trailblazer.application_controller ||= %w[ActionController::Base ActionController::API]
+    config.trailblazer.enable_tracing ||= false
 
-    # thank you, http://stackoverflow.com/a/17573888/465070
-    initializer 'trailblazer.install', after: :load_config_initializers do |app|
-      # the trb autoloading has to be run after initializers have been loaded, so we can tweak inclusion of features in
-      # initializers.
-      ActionDispatch::Reloader.to_prepare do
-        Trailblazer::Railtie.load_concepts(app)
+    initializer "trailblazer.application_controller", before: "finisher_hook" do
+      ActiveSupport.on_load(:action_controller) do |app|
+        Trailblazer::Railtie.extend_application_controller!(app)
       end
     end
 
-    # initializer "trailblazer.roar" do
-    #   require "trailblazer/rails/roar" #if Object.const_defined?(:Roar)
-    # end
-
-    initializer "trailblazer.application_controller" do
-      ActiveSupport.on_load(:action_controller) do
-        include Trailblazer::Operation::Controller
+    def extend_application_controller!(app)
+      controllers = Array(::Rails.application.config.trailblazer.application_controller).map(&:to_s)
+      if controllers.include? app.to_s
+        app.send :include, Trailblazer::Rails::Controller
+        app.send :include, Trailblazer::Rails::Controller::Cell if defined?(::Cell)
       end
-    end
-
-    # Prepend model file, before the concept files like operation.rb get loaded.
-    ModelFile = ->(input, options) do
-      model = "app/models/#{options[:name]}.rb"
-      File.exist?(model) ? [model]+input : input
+      app
     end
   end
 end

data/lib/trailblazer/rails/version.rb

@@ -1,5 +1,5 @@
 module Trailblazer
   module Rails
-    VERSION = "0.2.4"
+    VERSION = "2.4.1".freeze
   end
 end

data/lib/trailblazer/rails.rb

@@ -2,27 +2,11 @@ require "trailblazer/rails/version"
 
 module Trailblazer
   module Rails
-    # Your code goes here...
   end
 end
 
+require "trailblazer/rails/controller"
+require "trailblazer/rails/cell"
+require "trailblazer/rails/form"
 require "trailblazer/rails/railtie"
-
-require "trailblazer/operation"
-# TODO: remove that once i18n, validations etc in Reform/AM are sorted.
-Trailblazer::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/operation/model"
-require "trailblazer/operation/model/active_model"
-Trailblazer::Operation::Model::DSL.module_eval do
-  include Trailblazer::Operation::Model::ActiveModel # ::contract.
-end
-
-require "trailblazer/autoloading"
-require "trailblazer/rails/autoloading"
+require "trailblazer"

data/lib/trailblazer-rails.rb

@@ -0,0 +1 @@
+require "trailblazer/rails" # rubocop:disable Naming/FileName

data/trailblazer-rails.gemspec

@@ -1,7 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'trailblazer/rails/version'
+require "trailblazer/rails/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "trailblazer-rails"
@@ -9,26 +8,17 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Nick Sutterer"]
   spec.email         = ["apotonick@gmail.com"]
 
-  spec.summary       = %q{Convenient Rails support for Trailblazer.}
-  spec.homepage      = "http://trailblazer.to"
+  spec.summary       = "Convenient Rails support for Trailblazer."
+  spec.homepage      = "https://trailblazer.to/2.1/docs/trailblazer.html#trailblazer-rails"
   spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "trailblazer", ">= 1.0.4"
-  spec.add_dependency "trailblazer-loader", ">= 0.0.7"
+  spec.add_dependency "railties", ">= 5.2.0"
+  spec.add_dependency "trailblazer", ">= 2.1.0", "< 2.2.0"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "minitest"
-  spec.add_development_dependency "rails"
-  spec.add_development_dependency "actionpack", '>= 3.0.0' # Rails is optional.
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "responders"
-  spec.add_development_dependency "database_cleaner"
-  spec.add_development_dependency "sidekiq", ">= 3.1.0"
-
-  spec.add_development_dependency "multi_json"
+  spec.add_development_dependency "rake"
 end

metadata

@@ -1,129 +1,51 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 2.4.1
 platform: ruby
 authors:
 - Nick Sutterer
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-17 00:00:00.000000000 Z
+date: 2022-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: trailblazer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.0.4
-- !ruby/object:Gem::Dependency
-  name: trailblazer-loader
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.7
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.7
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 5.2.0
 - !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: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
+  name: trailblazer
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: actionpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: 2.1.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
+        version: 2.2.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: 2.1.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
-  name: responders
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: database_cleaner
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,21 +73,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sidekiq
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: multi_json
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -178,35 +86,43 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - apotonick@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- Appraisals
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/trailblazer/operation/controller/active_record.rb
-- lib/trailblazer/operation/model/active_model.rb
-- lib/trailblazer/operation/responder.rb
-- lib/trailblazer/operation/worker.rb
+- TESTING.md
+- gemfiles/rails_5.2.gemfile
+- gemfiles/rails_5.2.gemfile.lock
+- gemfiles/rails_6.0.gemfile
+- gemfiles/rails_6.0.gemfile.lock
+- gemfiles/rails_6.1.gemfile
+- gemfiles/rails_6.1.gemfile.lock
+- gemfiles/rails_7.0.gemfile
+- gemfiles/rails_7.0.gemfile.lock
+- lib/trailblazer-rails.rb
 - lib/trailblazer/rails.rb
-- lib/trailblazer/rails/autoloading.rb
+- lib/trailblazer/rails/cell.rb
+- lib/trailblazer/rails/controller.rb
+- lib/trailblazer/rails/form.rb
 - lib/trailblazer/rails/railtie.rb
-- lib/trailblazer/rails/test/integration.rb
 - lib/trailblazer/rails/version.rb
 - trailblazer-rails.gemspec
-homepage: http://trailblazer.to
+homepage: https://trailblazer.to/2.1/docs/trailblazer.html#trailblazer-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -221,9 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: Convenient Rails support for Trailblazer.
 test_files: []

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 2.2.2
-before_install: gem install bundler

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

@@ -1,21 +0,0 @@
-# Assigns an additional instance variable for +@model+ named after the model's table name (e.g. @comment).
-#
-# THIS MODULE IS DEPRECATED!
-#
-# Please don't use this module. Instead, use @model in your controller or pass the 
-# operation instance to a cell to present it.
-module Trailblazer::Operation::Controller::ActiveRecord
-private
-  def setup_operation_instance_variables!(operation, options)
-    super
-    instance_variable_set(:"@#{operation_model_name}", @model)
-  end
-
-  def operation_model_name
-    # set the right variable name if collection
-    if @operation.is_a?(Trailblazer::Operation::Collection)
-      return @model.model.table_name.split(".").last
-    end
-    @model.class.table_name.split(".").last.singularize
-  end
-end

data/lib/trailblazer/operation/model/active_model.rb

@@ -1,11 +0,0 @@
-module Trailblazer
-  module Operation::Model
-    # Automatically set model_name on operation's contract.
-    module ActiveModel
-      def contract(*, &block)
-        super
-        contract_class.model(model_class) # this assumes that Form::ActiveModel is mixed in.
-      end
-    end
-  end
-end

data/lib/trailblazer/operation/responder.rb

@@ -1,23 +0,0 @@
-module Trailblazer::Operation::Responder
-  def self.included(base)
-    base.extend ClassMethods
-  end
-
-  module ClassMethods
-    def model_name
-      model_class.model_name
-    end
-  end
-
-  extend Forwardable
-  def_delegators :@model, :to_param, :destroyed?, :persisted?
-
-  def errors
-    return [] if @valid
-    [1]
-  end
-
-  def to_model
-    @model
-  end
-end

data/lib/trailblazer/operation/worker.rb

@@ -1,112 +0,0 @@
-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/rails/autoloading.rb

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

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

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