trailblazer-rails 0.4.0 → 1.0.0.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c434809f9717c0abdb110d4027883ec53ec0668d
-  data.tar.gz: 55108603787411cd497a0261c525008bcac8d627
+  metadata.gz: 0705212033400543b790af175283c948227fbc0e
+  data.tar.gz: 1c0381c7660afca45e739a77311a5b802d9748d9
 SHA512:
-  metadata.gz: fb5c793ad95a77ecc2d744eee573df819617204f50369e54b1eb27d6ec4d70b9149852a0e2f1688232422a7b1d5626734369bf1ff43aecdeb086ac3202bc0a39
-  data.tar.gz: d07ffb10ca139fd95e7c8a7e64415a1817d1d730bd96fc64b33e429d28ecdc4e842a566c08b9c5664f6f8dde9b43b48505b422b68f10cd8ba2de34a118eaa9c8
+  metadata.gz: 017696e9e891c948c1e0352e615b14e0f722985633eb663f5d5f8528efa0ee608c64bf15d31b967416696c926c036585e8741072523895d9759b14c682c66b0c
+  data.tar.gz: 49849e9760b72347be4bdb3837577d3a354d4ffa2249d5c9d9b9a31b2678d1efa333cae64a0ac45ec033c2967d624d10a515cb99410e82797704711c4a84aed2

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
-  - 2.2.2
-before_install: gem install bundler
+  - 2.3.1
+
+script: cd test/rails4.2 && bundle exec rake test
+gemfile: test/rails4.2/Gemfile

data/CHANGES.md

@@ -1,3 +1,10 @@
+# 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.

data/README.md

@@ -1,20 +1,22 @@
 # Trailblazer::Rails
 
-## Railtie
+*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/cells)
 
-This will go through `app/concepts/`, find all the `crud.rb` files, autoload their corresponding namespace (e.g. `Thing`, which is a model) and then load the `crud.rb` file.
+## Overview
 
-## Form::model_name
+`trailblazer-rails` helps you with the following.
 
-Automatically sets `model` on operation's contract when `Operation::Model` is included in operation.
-
-
-## Planned
-
-* Adds autoloading, etc.
-* Automatic rendering of a controller cell instead of primitive view.
+* 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/rails.html).
 
 ## Installation
 
@@ -24,6 +26,8 @@ Add this line to your application's Gemfile:
 gem 'trailblazer-rails'
 ```
 
+Note that the 1.x version only runs with TRB >= 2.0.0.
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/trailblazer/rails/controller.rb

@@ -0,0 +1,53 @@
+module Trailblazer::Rails
+  module Controller
+    def run(operation, params=self.params, *dependencies)
+      result = operation.(
+        _run_params(params),
+        *_run_runtime_options(*dependencies)
+      )
+
+      @form  = Trailblazer::Rails::Form.new(result["contract.default"], result["model"].class)
+      @model = result["model"]
+
+      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(options={}, *dependencies)
+      [_run_options(options), *dependencies]
+    end
+
+    # Override this to inject dependencies such as "current_user"
+    # into the runtime options.
+    def _run_options(options)
+      options
+    end
+
+    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
+end

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

@@ -18,7 +18,6 @@ module Trailblazer
 
     # 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
 
     # thank you, http://stackoverflow.com/a/17573888/465070
@@ -35,8 +34,8 @@ module Trailblazer
     # end
 
     initializer "trailblazer.application_controller" do
-      ActiveSupport.on_load(:action_controller) do
-        include Trailblazer::Operation::Controller
+      reloader_class.to_prepare do
+        ApplicationController.send :include, Trailblazer::Rails::Controller
       end
     end
 

data/lib/trailblazer/rails/version.rb

@@ -1,5 +1,5 @@
 module Trailblazer
   module Rails
-    VERSION = "0.4.0"
+    VERSION = "1.0.0.beta1"
   end
 end

data/lib/trailblazer/rails.rb

@@ -2,28 +2,12 @@ require "trailblazer/rails/version"
 
 module Trailblazer
   module Rails
-    # Your code goes here...
   end
 end
 
 require "reform/rails"
-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/rails/controller"
+require "trailblazer/rails/form"
+require "trailblazer/rails/railtie"
+require "trailblazer"

data/trailblazer-rails.gemspec

@@ -9,26 +9,23 @@ Gem::Specification.new do |spec|
   spec.email         = ["apotonick@gmail.com"]
 
   spec.summary       = %q{Convenient Rails support for Trailblazer.}
-  spec.homepage      = "http://trailblazer.to"
+  spec.homepage      = "http://trailblazer.to/gems/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.require_paths = ["lib"]
 
-  spec.add_dependency "trailblazer", ">= 1.0.4"
+  spec.add_dependency "trailblazer", ">= 2.0.0.beta1", "< 2.1.0"
   spec.add_dependency "trailblazer-loader", ">= 0.1.0"
-  spec.add_dependency "reform-rails", ">= 0.1.4"
+  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 "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 "responders"
 
   spec.add_development_dependency "multi_json"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0.beta1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-01 00:00:00.000000000 Z
+date: 2016-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trailblazer
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 2.0.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 2.0.0.beta1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 - !ruby/object:Gem::Dependency
   name: trailblazer-loader
   requirement: !ruby/object:Gem::Requirement
@@ -45,6 +51,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,6 +61,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +106,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rails
-  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
@@ -136,48 +134,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: responders
-  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: database_cleaner
-  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: 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
   requirement: !ruby/object:Gem::Requirement
@@ -206,17 +162,15 @@ files:
 - 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
 - lib/trailblazer/rails.rb
-- lib/trailblazer/rails/autoloading.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: http://trailblazer.to/gems/trailblazer/rails
 licenses:
 - MIT
 metadata: {}
@@ -231,9 +185,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.3

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/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