trailblazer-rails 2.1.4 → 2.2.0

data/gemfiles/rails_7.0.gemfile.lock

@@ -0,0 +1,182 @@
+PATH
+  remote: ..
+  specs:
+    trailblazer-rails (2.2.0)
+      railties (>= 5.2.0)
+      trailblazer (>= 2.1.0, < 2.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.0.rc1)
+      actionview (= 7.0.0.rc1)
+      activesupport (= 7.0.0.rc1)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.0.rc1)
+      activesupport (= 7.0.0.rc1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activemodel (7.0.0.rc1)
+      activesupport (= 7.0.0.rc1)
+    activerecord (7.0.0.rc1)
+      activemodel (= 7.0.0.rc1)
+      activesupport (= 7.0.0.rc1)
+    activesupport (7.0.0.rc1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.4)
+    capybara (3.36.0)
+      addressable
+      matrix
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (>= 1.5, < 3.0)
+      xpath (~> 3.2)
+    cells (4.1.7)
+      declarative-builder (< 0.2.0)
+      declarative-option (< 0.2.0)
+      tilt (>= 1.4, < 3)
+      uber (< 0.2.0)
+    cells-erb (0.1.0)
+      cells (~> 4.0)
+      erbse (>= 0.1.1)
+    cells-rails (0.1.4)
+      actionpack (>= 5.0)
+      cells (>= 4.1.6, < 5.0.0)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    declarative (0.0.20)
+    declarative-builder (0.1.0)
+      declarative-option (< 0.2.0)
+    declarative-option (0.1.0)
+    disposable (0.6.2)
+      declarative (>= 0.0.9, < 1.0.0)
+      representable (>= 3.1.1, < 3.2.0)
+    erbse (0.1.4)
+      temple
+    erubi (1.10.0)
+    hashie (5.0.0)
+    hirb (0.7.3)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    matrix (0.4.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.14.4)
+    minitest-capybara (0.9.0)
+      capybara
+      minitest (~> 5.0)
+      rake
+    nokogiri (1.12.5-x86_64-linux)
+      racc (~> 1.4)
+    public_suffix (4.0.6)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.0.rc1)
+      actionpack (= 7.0.0.rc1)
+      activesupport (= 7.0.0.rc1)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    reform (2.6.1)
+      disposable (>= 0.5.0, < 1.0.0)
+      representable (>= 3.1.1, < 3.2.0)
+      uber (< 0.2.0)
+    reform-rails (0.2.3)
+      activemodel (>= 5.0)
+      reform (>= 2.3.1, < 3.0.0)
+    regexp_parser (2.2.0)
+    representable (3.1.1)
+      declarative (< 0.1.0)
+      trailblazer-option (>= 0.1.1, < 0.2.0)
+      uber (< 0.2.0)
+    sqlite3 (1.4.2)
+    temple (0.8.2)
+    thor (1.1.0)
+    tilt (2.0.10)
+    trailblazer (2.1.0)
+      trailblazer-macro (>= 2.1.0, < 2.2.0)
+      trailblazer-macro-contract (>= 2.1.0, < 2.2.0)
+      trailblazer-operation
+    trailblazer-activity (0.12.2)
+      trailblazer-context (~> 0.5.0)
+      trailblazer-option (~> 0.1.0)
+    trailblazer-activity-dsl-linear (0.4.3)
+      trailblazer-activity (>= 0.12.2, < 0.13.0)
+    trailblazer-cells (0.0.3)
+      cells (>= 4.1.0.rc1, < 5.0.0)
+    trailblazer-context (0.5.0)
+      hashie (>= 3.0.0)
+    trailblazer-developer (0.0.22)
+      hirb
+      representable (>= 3.1.1, < 4.0.0)
+      trailblazer-activity (>= 0.12.2, < 1.0.0)
+      trailblazer-activity-dsl-linear (>= 0.4.1, < 1.0.0)
+    trailblazer-loader (0.1.2)
+    trailblazer-macro (2.1.7)
+      trailblazer-activity-dsl-linear (>= 0.4.0, < 0.5.0)
+      trailblazer-operation (>= 0.7.0)
+    trailblazer-macro-contract (2.1.1)
+      reform (>= 2.2.0, < 3.0.0)
+      trailblazer-activity-dsl-linear (>= 0.4.0, < 0.5.0)
+    trailblazer-operation (0.7.5)
+      trailblazer-activity (>= 0.12.2, < 1.0.0)
+      trailblazer-activity-dsl-linear (>= 0.4.1, < 1.0.0)
+      trailblazer-developer (>= 0.0.21, < 1.0.0)
+    trailblazer-option (0.1.2)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    uber (0.1.0)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  actionpack (~> 7.0.0.rc1)
+  activerecord (~> 7.0.0.rc1)
+  appraisal
+  bundler
+  cells-erb
+  cells-rails
+  minitest
+  minitest-capybara
+  rake
+  reform-rails
+  sqlite3
+  trailblazer
+  trailblazer-cells
+  trailblazer-loader
+  trailblazer-rails!
+
+BUNDLED WITH
+   2.2.22

data/lib/trailblazer/rails/cell.rb

@@ -1,21 +1,34 @@
-module Trailblazer::Rails::Controller::Cell
-  private
-
-  module Render
-    def render(cell = nil, options = {}, *, &block)
-      return super unless cell.kind_of?(::Cell::ViewModel)
-      render_cell(cell, options)
-    end
-
-    def render_cell(cell, options)
-      options = options.reverse_merge(layout: true)
-
-      # render the cell.
-      content = cell.()
-
-      render({ html: content }.merge(options))
-    end
-  end
-
-  include Render
-end
+module Trailblazer::Rails::Controller::Cell
+  private
+
+  module Render
+    def render(cell = nil, options = {}, *, &block)
+      return super unless cell.kind_of?(::Cell::ViewModel)
+
+      render_cell(cell, options)
+    end
+
+    def render_cell(cell, options)
+      options = options.reverse_merge(layout: true)
+
+      # render the cell.
+      content = cell.()
+
+      render({html: content}.merge(options))
+    end
+
+    def cell(constant, model, options={})
+      cell_options = options.reverse_merge(options_for_cell(model, options))
+
+      super(constant, model, cell_options)
+    end
+
+    # Override this to customize what options are passed into the cell constructor.
+    # E.g. `{layout: Song::Cell::Layout}`
+    def options_for_cell(_model, _options)
+      {}
+    end
+  end
+
+  include Render unless method_defined?(:render_cell) # FIXME: this will be removed soon.
+end

data/lib/trailblazer/rails/controller.rb

@@ -1,55 +1,69 @@
-module Trailblazer::Rails
-  module Controller
-    def run(operation, *dependencies)
-      result = if Rails.application.config.trailblazer.enable_tracing
-                 _run_operation(operation, :trace, *dependencies).tap { |r| _operation_trace(r) }
-               else
-                 _run_operation(operation, :call, *dependencies)
-               end
-
-      @model = result[:model]
-      @form  = Trailblazer::Rails::Form.new(result["contract.default"], @model.class)
-
-      yield(result) if result.success? && block_given?
-
-      @_result = result
-    end
-
-  private
-    # Override to tweak params. Not recommended.
-    # Use a deserializer instead.
-    def _run_params(params)
-      params
-    end
-
-    # This is where we can inject Dry.RB containers and the like via dependencies.
-    def _run_runtime_options(ctx = {}, *dependencies)
-      [_run_options(ctx), *dependencies]
-    end
-
-    # Override this to inject dependencies such as "current_user"
-    # into the runtime options.
-    def _run_options(ctx)
-      ctx
-    end
-
-    def _run_operation(operation, call_method, *dependencies)
-      operation.send(
-        call_method,
-        { params: _run_params(self.params) }.merge(*_run_runtime_options(*dependencies))
-      )
-    end
-
-    def _operation_trace(result)
-      puts result.wtf?
-    end
-
-    module Result
-      def result
-        @_result
-      end
-    end
-
-    include Result
-  end
-end
+module Trailblazer::Rails
+  module Controller
+    # TODO: deprecate {*dependencies}.
+    def run_v21(operation, *dependencies, **variables)
+      result = if Rails.application.config.trailblazer.enable_tracing
+                 _run_operation_v21(operation, :trace, *dependencies, **variables).tap { |r| _operation_trace(r) }
+               else
+                 _run_operation_v21(operation, :call, *dependencies, **variables)
+               end
+
+      _assign_trb_ivars(result)
+
+      yield(result) if result.success? && block_given?
+
+      @_result = result
+    end
+
+    alias run run_v21 unless method_defined?(:run)
+
+    private
+
+    # Override to tweak params. Not recommended.
+    # Use a deserializer instead.
+    def _run_params(run_params)
+      run_params
+    end
+
+    # This is where we can inject Dry.RB containers and the like via dependencies.
+    def _run_runtime_options(ctx = {}, *dependencies)
+      [_run_options(ctx), *dependencies]
+    end
+
+    # Override this to inject dependencies such as "current_user"
+    # into the runtime options.
+    def _run_options(ctx)
+      ctx
+    end
+
+    def _run_operation_v21(operation, call_method, *dependencies, **variables)
+      operation.public_send(
+        call_method,
+        {params: _run_params(params.dup)}.
+        merge(*_run_runtime_options(*dependencies)).
+        merge(variables)
+      )
+    end
+
+    def _operation_trace(result)
+      puts result.wtf?
+    end
+
+    def _assign_trb_ivars(result)
+      @model = result[:model]
+      @form  = _wrap_with_trb_form(result["contract.default"], @model.class)
+    end
+
+    def _wrap_with_trb_form(form, model)
+      Trailblazer::Rails::Form.new(form, model)
+    end
+
+    module Result
+      def result
+        @_result
+      end
+    end
+
+    include Result
+  end
+end

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

@@ -1,28 +1,28 @@
-require 'active_support/concern'
-
-module Trailblazer
-  class Railtie < ::Rails::Railtie
-    module ExtendApplicationController
-      extend ActiveSupport::Concern
-
-      included do
-        initializer "trailblazer.application_controller", before: "finisher_hook" do
-          reloader_class.to_prepare do
-            ActiveSupport.on_load(:action_controller) do |app|
-              Trailblazer::Railtie.extend_application_controller!(app)
-            end
-          end
-        end
-
-        def extend_application_controller!(app)
-          controllers = Array(::Rails.application.config.trailblazer.application_controller).map { |x| x.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
-          app
-        end
-      end
-    end
-  end
-end
+require "active_support/concern"
+
+module Trailblazer
+  class Railtie < ::Rails::Railtie
+    module ExtendApplicationController
+      extend ActiveSupport::Concern
+
+      included do
+        initializer "trailblazer.application_controller", before: "finisher_hook" do
+          ActiveSupport::Reloader.to_prepare do
+            ActiveSupport.on_load(:action_controller) do |app|
+              Trailblazer::Railtie.extend_application_controller!(app)
+            end
+          end
+        end
+
+        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
+          app
+        end
+      end
+    end
+  end
+end

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

@@ -1,56 +1,58 @@
-require 'active_support/concern'
-
-module Trailblazer
-  class Railtie < ::Rails::Railtie
-    module Loader
-      extend ActiveSupport::Concern
-
-      included do
-        def self.load_concepts(app)
-        # Loader.new.(insert: [ModelFile, before: Loader::AddConceptFiles]) { |file| require_dependency("#{app.root}/#{file}") }
-          load_for(app)
-
-          engines.each { |engine| load_for(engine) }
-        end
-
-        def self.engines
-          if Gem::Version.new(::Rails.version) >= Gem::Version.new("4.1")
-            ::Rails.application.railties.find_all { |tie| tie.is_a?(::Rails::Engine) }
-          else
-            ::Rails.application.railties.engines
-          end
-        end
-
-        def self.load_for(app)
-          Trailblazer::Loader.new.(prepend: AllModelFiles, root: app.root) { |file| require_dependency(file) }
-        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
-        end
-
-        # Load all model files before any TRB files.
-        AllModelFiles = ->(input, options) do
-          Dir.glob("#{options[:root]}/app/models/**/*.rb").sort + input
-        end
-
-        # This is to autoload Operation::Dispatch, etc. I'm simply assuming people find this helpful in Rails.
-        initializer "trailblazer.library_autoloading" do
-        end
-
-        # thank you, http://stackoverflow.com/a/17573888/465070
-        initializer 'trailblazer.install', after: "reform.form_extensions" do |app|
-          # the trb autoloading has to be run after initializers have been loaded, so we can tweak inclusion of features in
-          # initializers.
-          if config.trailblazer.use_loader
-            reloader_class.to_prepare do
-              Trailblazer::Railtie.load_concepts(app)
-            end
-          end
-        end
-      end
-    end
-  end
-end
+require "active_support/concern"
+
+module Trailblazer
+  class Railtie < ::Rails::Railtie
+    module Loader
+      extend ActiveSupport::Concern
+
+      included do
+        def self.load_concepts(app)
+          load_for(app)
+
+          engines.each { |engine| load_for(engine) }
+        end
+
+        def self.engines
+          ::Rails.application.railties.select { |tie| tie.is_a?(::Rails::Engine) }
+        end
+
+        def self.load_for(app)
+          Trailblazer::Loader.new.(prepend: AllModelFiles, root: app.root) { |file| require_dependency(file) }
+        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
+        end
+
+        # Load all model files before any TRB files.
+        AllModelFiles = ->(input, options) do
+          Dir.glob("#{options[:root]}/app/models/**/*.rb").sort + input
+        end
+
+        # This is to autoload Operation::Dispatch, etc. I'm simply assuming people find this helpful in Rails.
+        initializer "trailblazer.library_autoloading" do
+        end
+
+        # thank you, http://stackoverflow.com/a/17573888/465070
+        initializer "trailblazer.install", after: "reform.form_extensions" do |app|
+          # the trb autoloading has to be run after initializers have been loaded, so we can tweak inclusion of features in
+          # initializers.
+
+          # TODO: remove me in v2.2.0
+          if config.trailblazer.use_loader.to_s.present?
+            warn "DEPRECATION WARNING [trailblazer-rails]: please use config.trailblazer.enable_loader" \
+                 " to enable/disable the loader, config.trailblazer.use_loader will be removed from version 2.2.0"
+          end
+
+          if config.trailblazer.enable_loader || config.trailblazer.use_loader
+            ActiveSupport::Reloader.to_prepare do
+              Trailblazer::Railtie.load_concepts(app)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trailblazer/rails/railtie.rb

@@ -1,30 +1,17 @@
-require "rails/railtie"
-require "trailblazer/loader"
-require "trailblazer/rails/railtie/extend_application_controller"
-require "trailblazer/rails/railtie/loader"
-
-module Trailblazer
-  class Railtie < ::Rails::Railtie
-    config.trailblazer = ActiveSupport::OrderedOptions.new
-    ## Accept also an Array of controllers
-    config.trailblazer.application_controller ||= 'ActionController::Base'
-    config.trailblazer.use_loader ||= true
-    config.trailblazer.enable_tracing ||= false
-
-    include Loader
-    include ExtendApplicationController
-
-    private
-
-    def reloader_class
-      # Rails 5.0.0.rc1 says:
-      # DEPRECATION WARNING: to_prepare is deprecated and will be removed from Rails 5.1
-      # (use ActiveSupport::Reloader.to_prepare instead)
-      if Gem.loaded_specs['activesupport'].version >= Gem::Version.new('5')
-        ActiveSupport::Reloader
-      else
-        ActionDispatch::Reloader
-      end
-    end
-  end
-end
+require "rails/railtie"
+require "trailblazer/loader"
+require "trailblazer/rails/railtie/extend_application_controller"
+require "trailblazer/rails/railtie/loader"
+
+module Trailblazer
+  class Railtie < ::Rails::Railtie
+    config.trailblazer = ActiveSupport::OrderedOptions.new
+    ## Accept also an Array of controllers
+    config.trailblazer.application_controller ||= "ActionController::Base"
+    config.trailblazer.enable_loader ||= true
+    config.trailblazer.enable_tracing ||= false
+
+    include Loader
+    include ExtendApplicationController
+  end
+end

data/lib/trailblazer/rails/version.rb

@@ -1,5 +1,5 @@
-module Trailblazer
-  module Rails
-    VERSION = "2.1.4"
-  end
-end
+module Trailblazer
+  module Rails
+    VERSION = "2.2.0".freeze
+  end
+end

data/lib/trailblazer/rails.rb

@@ -5,8 +5,6 @@ module Trailblazer
   end
 end
 
-require "reform/rails"
-
 require "trailblazer/rails/controller"
 require "trailblazer/rails/cell"
 require "trailblazer/rails/form"

data/lib/trailblazer-rails.rb

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

data/trailblazer-rails.gemspec

@@ -1,27 +1,25 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'trailblazer/rails/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "trailblazer-rails"
-  spec.version       = Trailblazer::Rails::VERSION
-  spec.authors       = ["Nick Sutterer"]
-  spec.email         = ["apotonick@gmail.com"]
-
-  spec.summary       = %q{Convenient Rails support for Trailblazer.}
-  spec.homepage      = "http://trailblazer.to/gems/trailblazer/2.0/rails.html"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test)/}) }
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "trailblazer", ">= 2.1.0.beta1", "< 2.2.0"
-  spec.add_dependency "trailblazer-loader", ">= 0.1.0"
-  spec.add_dependency "reform-rails", ">= 0.1.4", "< 0.2.0"
-
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "rubocop"
-end
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "trailblazer/rails/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "trailblazer-rails"
+  spec.version       = Trailblazer::Rails::VERSION
+  spec.authors       = ["Nick Sutterer"]
+  spec.email         = ["apotonick@gmail.com"]
+
+  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.require_paths = ["lib"]
+
+  spec.add_dependency "railties", ">= 5.2.0"
+  spec.add_dependency "trailblazer", ">= 2.1.0", "< 2.2.0"
+
+  spec.add_development_dependency "trailblazer-loader", ">= 0.1.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+end