trailblazer-rails 2.1.1 → 2.1.2

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.4.4

data/.travis.yml

@@ -1,12 +1,16 @@
-language: ruby
-matrix:
-  include:
-  - rvm: 2.4.1
-    env: TEST_SUITE=rails5.0
-    gemfile: test/rails5.0/Gemfile
-
-  - rvm: 2.4.1
-    env: TEST_SUITE=rails5.1
-    gemfile: test/rails5.1/Gemfile
-
-script: cd test/$TEST_SUITE && bundle exec rake test
+language: ruby
+matrix:
+  include:
+  - rvm: 2.4.1
+    env: TEST_SUITE=rails5.0
+    gemfile: test/rails5.0/Gemfile
+
+  - rvm: 2.4.1
+    env: TEST_SUITE=rails5.1
+    gemfile: test/rails5.1/Gemfile
+
+  - rvm: 2.5.1
+    env: TEST_SUITE=rails5.2
+    gemfile: test/rails5.2/Gemfile
+
+script: cd test/$TEST_SUITE && bundle exec rake test

data/CHANGES.md

@@ -1,108 +1,132 @@
-# 2.1.1
-
-* Fixed issue for rails 5.2rc2 when loading model's files
-* Rubocop introduced
-* Allow enabling tracing when using `run` via `config.trailblazer.enable_tracing = true`
-
-# 2.1.0
-
-* Drop deprecated syntax for controller `run`
-* Allow disabling of the Trailblazer loader via `config.trailblazer.use_loader = false`
-
-# 2.0.0
-
-* Support Trailblazer 2.1.0+
-* Drop support for older version of Trailblazer
-
-# 1.0.5
-
-* Hook trailblazer application_controller initializer to finisher_hook
-
-# 1.0.4
-
-* Make `Railtie::extend_application_controller!` overwriteable via a module.
-
-# 1.0.3
-
-* Return the computed application controller constant from `Railtie::extend_application_controller!` to make `compat` code simpler.
-
-# 1.0.2
-
-* Allow configuring `ApplicationController` constant via `config.trailblazer.application_controller`.
-
-# 1.0.1
-
-* Allow using this gem without `cells,` by loading cells support only when the `cells` gem got detected. Thanks to @promisedlandt.
-
-# 1.0.0
-
-* Runs only with >= Trailblazer 2.0.0.
-* Removed `Controller#form`, `#present` and `#respond`. The latter is now [replaced with `Endpoint`](https://github.com/trailblazer/trailblazer-endpoint/). The only operation trigger is `Controller#run`.
-* Added support for explicit `render cell(Artist::Cell::Index, model)`.
-* Autoloading got replaced with explicit requires.
-
-# 0.4.0
-
-* Better engines support.
-* Fix `Responder#errors` by simply removing it and letting `Operation#errors` return the contract errors.
-
-# 0.3.2
-
-* Make it work with Rails 3.x, again.
-
-# 0.3.1
-
-* Fix loading of `reform-rails`.
-
-# 0.3.0
-
-* Require `reform-rails` as a static dependency. This simplifies the user's setup significantly.
-* Run the `Railtie` after `reform.form_extensions` and allow reform-rails to do its setup work, then load concepts.
-
-# 0.2.4
-
-* Require `trailblazer-loader-0.0.7`.
-* Fix sorting, model files are now always required first.
-* Manually include `Operation::Controller` in `ApplicationController` for every reload.
-
-# 0.2.3
-
-* Bump to `trailblazer-loader` 0.0.4.
-
-# 0.2.2
-
-* Remove cells loading code, this happens via trailblazer-loader now.
-* We now load the concept's model file if it exists.
-
-# 0.2.1
-
-* Require `trailblazer-loader`.
-
-# 0.2.0
-
-* Use `trailblazer-loader` for loading operations and associated files, now. Note that `operations.rb` now is `operation.rb` (hence the minor bump).
-* The `Operation::Controller` module is not included into `ApplicationController` automatically.
-* Added `Trailblazer::Test::Integration`.
-
-# 0.1.6
-
-* Fix `Controller#run`, which now returns the operation instance instead of the `Else` object.
-
-# 0.1.5
-
-* Treat all requests as `params` requests unless the operation has a representer mixed in. If you don't want that, you can override using `is_document: false`. This appears to be the smoothest solution for all. Thanks to @Scharrels for discussion.
-* In `Controller#form`, the options argument is now passed into `form.prepopulate!(options)`. This allows to use arbitrary options and the `options[:params]` for prepopulation. Thanks @sauy7 for discussion.
-
-# 0.1.4
-
-* Treat `:js` requests as non-document, too.
-* `Controller#form` now returns the form object and not the operation.
-* In `Controller`, `#form`, `#present`, `#run` and `#respond` now all have the same API: `run(constant, options)`. If you want to pass a custom params hash, use `run Comment::Create, params: {..}`.
-
-# 0.1.3
-
-* `Operation::contract` works properly with `Operation::ActiveModel` mixed in.
-
-# 0.1.2
-
-* First version running with Trailblazer 1.0.0.
+# 2.1.2
+
+* `Trailblazer::Rails::Railtie` divided in 2 modules:
+  * `Loader` -> require_dependecy `concepts`
+  * `ExtendApplicationController` -> include `run` and `render` in controllers
+
+# 2.1.1
+
+* Fixed issue for rails 5.2rc2 when loading model's files
+* Rubocop introduced
+* Allow enabling tracing when using `run` via `config.trailblazer.enable_tracing = true`
+
+# 2.1.0
+
+* Drop deprecated syntax for controller `run`
+* Allow disabling of the Trailblazer loader via `config.trailblazer.use_loader = false`
+
+# 2.0.0
+
+* Support Trailblazer 2.1.0+
+* Drop support for older version of Trailblazer
+
+# 1.0.9
+
+* `Trailblazer::Rails::Railtie` divided in 2 modules:
+  * `Loader` -> require_dependecy `concepts`
+  * `ExtendApplicationController` -> include `run` and `render` in controllers
+
+# 1.0.8
+
+* Fixed Circular dependency detected in rails 5.2
+
+# 1.0.7
+
+* Fixed typo error in use_loader config flag
+
+# 1.0.6 (revoked)
+
+* Introduce use_loader config flag
+
+# 1.0.5
+
+* Hook trailblazer application_controller initializer to finisher_hook
+
+# 1.0.4
+
+* Make `Railtie::extend_application_controller!` overwriteable via a module.
+
+# 1.0.3
+
+* Return the computed application controller constant from `Railtie::extend_application_controller!` to make `compat` code simpler.
+
+# 1.0.2
+
+* Allow configuring `ApplicationController` constant via `config.trailblazer.application_controller`.
+
+# 1.0.1
+
+* Allow using this gem without `cells,` by loading cells support only when the `cells` gem got detected. Thanks to @promisedlandt.
+
+# 1.0.0
+
+* Runs only with >= Trailblazer 2.0.0.
+* Removed `Controller#form`, `#present` and `#respond`. The latter is now [replaced with `Endpoint`](https://github.com/trailblazer/trailblazer-endpoint/). The only operation trigger is `Controller#run`.
+* Added support for explicit `render cell(Artist::Cell::Index, model)`.
+* Autoloading got replaced with explicit requires.
+
+# 0.4.0
+
+* Better engines support.
+* Fix `Responder#errors` by simply removing it and letting `Operation#errors` return the contract errors.
+
+# 0.3.2
+
+* Make it work with Rails 3.x, again.
+
+# 0.3.1
+
+* Fix loading of `reform-rails`.
+
+# 0.3.0
+
+* Require `reform-rails` as a static dependency. This simplifies the user's setup significantly.
+* Run the `Railtie` after `reform.form_extensions` and allow reform-rails to do its setup work, then load concepts.
+
+# 0.2.4
+
+* Require `trailblazer-loader-0.0.7`.
+* Fix sorting, model files are now always required first.
+* Manually include `Operation::Controller` in `ApplicationController` for every reload.
+
+# 0.2.3
+
+* Bump to `trailblazer-loader` 0.0.4.
+
+# 0.2.2
+
+* Remove cells loading code, this happens via trailblazer-loader now.
+* We now load the concept's model file if it exists.
+
+# 0.2.1
+
+* Require `trailblazer-loader`.
+
+# 0.2.0
+
+* Use `trailblazer-loader` for loading operations and associated files, now. Note that `operations.rb` now is `operation.rb` (hence the minor bump).
+* The `Operation::Controller` module is not included into `ApplicationController` automatically.
+* Added `Trailblazer::Test::Integration`.
+
+# 0.1.6
+
+* Fix `Controller#run`, which now returns the operation instance instead of the `Else` object.
+
+# 0.1.5
+
+* Treat all requests as `params` requests unless the operation has a representer mixed in. If you don't want that, you can override using `is_document: false`. This appears to be the smoothest solution for all. Thanks to @Scharrels for discussion.
+* In `Controller#form`, the options argument is now passed into `form.prepopulate!(options)`. This allows to use arbitrary options and the `options[:params]` for prepopulation. Thanks @sauy7 for discussion.
+
+# 0.1.4
+
+* Treat `:js` requests as non-document, too.
+* `Controller#form` now returns the form object and not the operation.
+* In `Controller`, `#form`, `#present`, `#run` and `#respond` now all have the same API: `run(constant, options)`. If you want to pass a custom params hash, use `run Comment::Create, params: {..}`.
+
+# 0.1.3
+
+* `Operation::contract` works properly with `Operation::ActiveModel` mixed in.
+
+# 0.1.2
+
+* First version running with Trailblazer 1.0.0.

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2015-2018 Nick Sutterer
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+The MIT License (MIT)
+
+Copyright (c) 2015-2018 Nick Sutterer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,39 +1,39 @@
-# Trailblazer::Rails
-
-*Trailblazer in your Rails controllers.*
-
-[![Gitter Chat](https://badges.gitter.im/trailblazer/chat.svg)](https://gitter.im/trailblazer/chat)
-[![TRB Newsletter](https://img.shields.io/badge/TRB-newsletter-lightgrey.svg)](http://trailblazer.to/newsletter/)
-[![Build
-Status](https://travis-ci.org/trailblazer/trailblazer-rails.svg)](https://travis-ci.org/trailblazer/trailblazer-rails)
-[![Gem Version](https://badge.fury.io/rb/trailblazer-rails.svg)](http://badge.fury.io/rb/trailblazer-rails)
-
-## Overview
-
-`trailblazer-rails` helps you with the following.
-
-* Running operations in your controller actions.
-* Minimalistic integration tests ("smoke tests") to test controller/operation wiring.
-* Rendering cells instead of an ActionView in a controller action.
-
-Please refer to the [full documentation for more](http://trailblazer.to/gems/trailblazer/2.0/rails.html).
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'trailblazer-rails'
-```
-
-Note that the 2.x version only runs with TRB >= 2.1.0.
-
-## Setting flags
-
-* `config.trailblazer.use_loader = false` to disable Trailblazer loader (default TRUE)
-* `config.trailblazer.enable_tracing = true` to enable tracing when using `run` (default FALSE)
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+# Trailblazer::Rails
+
+*Trailblazer in your Rails controllers.*
+
+[![Gitter Chat](https://badges.gitter.im/trailblazer/chat.svg)](https://gitter.im/trailblazer/chat)
+[![TRB Newsletter](https://img.shields.io/badge/TRB-newsletter-lightgrey.svg)](http://trailblazer.to/newsletter/)
+[![Build
+Status](https://travis-ci.org/trailblazer/trailblazer-rails.svg)](https://travis-ci.org/trailblazer/trailblazer-rails)
+[![Gem Version](https://badge.fury.io/rb/trailblazer-rails.svg)](http://badge.fury.io/rb/trailblazer-rails)
+
+## Overview
+
+`trailblazer-rails` helps you with the following.
+
+* Running operations in your controller actions.
+* Minimalistic integration tests ("smoke tests") to test controller/operation wiring.
+* Rendering cells instead of an ActionView in a controller action.
+
+Please refer to the [full documentation for more](http://trailblazer.to/gems/trailblazer/2.0/rails.html).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'trailblazer-rails'
+```
+
+Note that the 2.x version only runs with TRB >= 2.1.0.
+
+## Setting flags
+
+* `config.trailblazer.use_loader = false` to disable Trailblazer loader (default TRUE)
+* `config.trailblazer.enable_tracing = true` to enable tracing when using `run` (default FALSE)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/trailblazer/rails/cell.rb

@@ -1,21 +1,21 @@
-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
+  end
+
+  include Render
+end

data/lib/trailblazer/rails/controller.rb

@@ -1,55 +1,55 @@
-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
+    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