trailblazer 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ac7e7ac2057c06dfd75019723fda75712ac56a8
-  data.tar.gz: c1b64e6256e2306a55d0ea5eb40ff67a84b8aa14
+  metadata.gz: cdbadcacf508d04b2311ff907f4e0335d95c1f97
+  data.tar.gz: cdea00d215f50347970f4faad21f661e245b895f
 SHA512:
-  metadata.gz: 7dc34775e9e4e2e90d996c2df0acd5fbe5d83e2ba85aec6cf265d4756a445f84d9f3528d1faefbae392213b4a9987e393f72895eba1b533152b35fced3a1d8b4
-  data.tar.gz: 01744c20155bf707665259b621ff42f980cc1bd4efbea2d4d55e419a9179f8d9402f4ddfc86aef36fea5c6fd7e8d26bacedec1194c34936f399c442297562bc3
+  metadata.gz: d8f7c14fc056a4e3feb0a15338f2104cc5aa06129736b040bb17f22450a438b06a87487e56d1afc2f451653f2701104d11452ca1958c2181647cdb3ac46f11ab
+  data.tar.gz: 21f69b585962e0781974986ecb0f7c8acf7e00f4fcbd0c04d4792fd1d73ddf55e13331205d933adbd6f46011f53f853b37f818e5b994969f7b47c8198096bf13

data/.travis.yml

@@ -1,10 +1,10 @@
 language: ruby
 rvm:
-  - 2.2.0
-  - 2.1.2
-  - 2.0.0
+  - 2.2
+  - 2.1
+  - 2.0
 gemfiles:
   - gemfiles/Gemfile.reform-2.0
   - gemfiles/Gemfile.reform-2.1
 before_install:
-  - gem install bundler
+  - gem install bundler

data/CHANGES.md

@@ -1,3 +1,9 @@
+# 1.1.1
+
+* Rename `Operation::Representer::ClassMethods` to `Operation::Representer::DSL` and allow to use `DSL` and `Rendering` without `Deserialization` so you can use two different representers.
+* `Policy::Guard::policy` now also accepts a `Callable` object.
+* Add `Operation#model=`.
+
 # 1.1.0
 
 * `Representer#represented` defaults to `model` now, not to `contract` anymore.
@@ -129,4 +135,4 @@
 
 # 0.1.0
 
-* First stable release after almost 6 months of blood, sweat and tears. I know, this is a ridiculously brief codebase but it was a hell of a job to structure everything the way it is now. Enjoy!
+* First stable release after almost 6 months of blood, sweat and tears. I know, this is a ridiculously brief codebase but it was a hell of a job to structure everything the way it is now. Enjoy!

data/Gemfile

@@ -4,15 +4,11 @@ source 'https://rubygems.org'
 gemspec
 
 # gem "representable", path: "../representable"
-gem "reform", path: "../reform"
-gem "disposable", path: "../disposable"
+# gem "disposable", path: "../disposable"
 gem "virtus"
-# gem "reform", github: "apotonick/reform"
-# gem "roar", github: "apotonick/roar"
-# gem "reform", "~> 2.0.5"
-# gem "roar"
+gem "reform", github: "apotonick/reform"
+gem "roar", github: "apotonick/roar"
+# gem "reform", "~> 2.0.0"
 # gem "reform", path: "../reform"
-gem "roar", path: "../roar"
-gem "multi_json"
-
-gem "minitest-line"
+# gem "roar", path: "../roar"
+gem "multi_json"

data/README.md

@@ -2,8 +2,9 @@
 
 _Trailblazer is a thin layer on top of Rails. It gently enforces encapsulation, an intuitive code structure and gives you an object-oriented architecture._
 
-[![Gem Version](https://badge.fury.io/rb/trailblazer.svg)](http://badge.fury.io/rb/trailblazer)
 [![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/)
+[![Gem Version](https://badge.fury.io/rb/trailblazer.svg)](http://badge.fury.io/rb/trailblazer)
 
 
 ## Trailblazer In A Nutshell
@@ -30,6 +31,16 @@ Again, you can pick which layers you want. Trailblazer doesn't impose technical
 
 Trailblazer is no "complex web of objects and indirection". It solves many problems that have been around for years with a cleanly layered architecture. Only use what you like. And that's the bottom line.
 
+## Trailblazer Likes 'Em All
+
+Since Trailblazer decouples the High-Level Stack from the framework, it runs with virtually any Ruby framework. We are constantly working on documenting how to do that.
+
+* Trailblazer with Rails [Book](http://trailblazer.to/books/trailblazer.html) | [Repository](https://github.com/apotonick/gemgem-trbrb)
+* Trailblazer with Sinatra [Guide](http://trailblazer.to/guides/sinatra/getting-started.html) | [Repository](https://github.com/apotonick/gemgem-sinatra)
+* Trailblazer with Hanami - coming soon!
+* Trailblazer with Roda - coming soon!
+* Trailblazer with Grape - coming _very_ soon!
+
 
 ## A Concept-Driven OOP Framework
 
@@ -101,7 +112,7 @@ Again, the controller only dispatchs to the operation and handles successful/inv
 
 Operations encapsulate business logic and are the heart of a Trailblazer architecture.
 
-Operations don't know about HTTP or the environment. You could use an operation in Rails, Lotus, or Roda, it wouldn't know. This makes them an ideal replacement for test factories.
+Operations don't know about HTTP or the environment. You could use an operation in Rails, Hanami, or Roda, it wouldn't know. This makes them an ideal replacement for test factories.
 
 An operation is not just a monolithic replacement for your business code. It's a simple orchestrator between the form object, models and your business code.
 

data/lib/trailblazer/endpoint.rb

@@ -2,7 +2,7 @@ module Trailblazer
   # Encapsulates HTTP-specific logic needed before running an operation.
   # Right now, all this does is #document_body! which figures out whether or not to pass the request body
   # into params, so the operation can use a representer to deserialize the original document.
-  # To be used in Lotus, Roda, Rails, etc.
+  # To be used in Hanami, Roda, Rails, etc.
   class Endpoint
     def initialize(operation_class, params, request, options)
       @operation_class = operation_class
@@ -28,4 +28,4 @@ module Trailblazer
       params.merge!(concept_name => request_body)
     end
   end
-end
+end

data/lib/trailblazer/operation.rb

@@ -88,6 +88,8 @@ module Trailblazer
 
   private
     module Setup
+      attr_writer :model
+
       def setup!(params)
         params = assign_params!(params)
         setup_params!(params)

data/lib/trailblazer/operation/policy.rb

@@ -13,7 +13,7 @@ module Trailblazer
     module DSL
       def self.extended(extender)
         extender.inheritable_attr :policy_config
-        extender.policy_config = Guard::Permission.new { true } # return true per default.
+        extender.policy_config = lambda { |*| true } # return true per default.
       end
 
       def policy(*args, &block)
@@ -57,9 +57,10 @@ module Trailblazer
       # Without a block, return the policy object (which is usually a Pundit-style class).
       # When block is passed evaluate the default rule and run block when false.
       def call(user, model, external_policy=nil)
-        build_policy(user, model, external_policy).tap do |policy|
-          policy.send(@action) || yield(policy, @action) if block_given?
-        end
+        policy = build_policy(user, model, external_policy)
+
+        policy.send(@action) || yield(policy, @action) if block_given?
+        policy
       end
 
     private

data/lib/trailblazer/operation/policy/guard.rb

@@ -1,34 +1,35 @@
 module Trailblazer
-# Adds #evaluate_policy to Operation#setup!
+  # Policy::Guard is a very simple policy implementation.
+  # It adds #evaluate_policy to Operation#setup! and calls whatever
+  # you provided to ::policy.
+  #
+  # http://trailblazer.to/gems/operation/policy.html#guard
   module Operation::Policy
     module Guard
       def self.included(includer)
-        includer.extend(DSL)
+        includer.extend(DSL) # Provides ::policy(CallableObject)
         includer.extend(ClassMethods)
         includer.send(:include, Setup)
       end
 
       module ClassMethods
-        # Use Guard::Permission.
-        def permission_class
-          Permission
+        def policy(callable=nil, &block)
+          self.policy_config = Uber::Options::Value.new(callable || block)
         end
       end
 
       def evaluate_policy(params)
-        self.class.policy_config.(self, params) or raise NotAuthorizedError.new
+        call_policy(params) or raise policy_exception
       end
 
-      # Encapsulates the operation's policy which is usually called in Op#setup!.
-      class Permission
-        def initialize(*args, &block)
-          @callable, @args = Uber::Options::Value.new(block), args
-        end
+      # Override if you want your own policy invocation, e.g. with more args.
+      def call_policy(params)
+        self.class.policy_config.(self, params)
+      end
 
-        def call(context, *args)
-          @callable.(context, *args)
-        end
+      def policy_exception
+        NotAuthorizedError.new
       end
     end
   end
-end
+end

data/lib/trailblazer/operation/representer.rb

@@ -7,11 +7,14 @@
 # TODO: so far, we only support JSON, but it's two lines to change to support any kind of format.
 module Trailblazer::Operation::Representer
   def self.included(base)
-    base.inheritable_attr :_representer_class
-    base.extend ClassMethods
+    base.extend DSL
   end
 
-  module ClassMethods
+  module DSL
+    def self.extended(extender)
+      extender.inheritable_attr :_representer_class
+    end
+
     def representer(constant=nil, &block)
       return representer_class unless constant or block_given?
 
@@ -92,4 +95,4 @@ private
     end
   end
   include Deserializer::JSON
-end
+end

data/lib/trailblazer/version.rb

@@ -1,3 +1,3 @@
 module Trailblazer
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/test/operation/guard_test.rb

@@ -80,6 +80,42 @@ class OpPolicyGuardTest < MiniTest::Spec
     it { Index.("true").wont_equal nil }
     it { assert_raises(Trailblazer::NotAuthorizedError) { Index.(false).wont_equal nil } }
   end
+
+  describe "with Callable" do
+    class Find < Trailblazer::Operation
+      include Policy::Guard
+
+      class Guardian
+        include Uber::Callable
+
+        def call(context, params)
+          params == "true"
+        end
+      end
+
+      policy Guardian.new
+
+      def process(*)
+      end
+    end
+
+    it { Find.("true").wont_equal nil }
+    it { assert_raises(Trailblazer::NotAuthorizedError) { Find.(false).wont_equal nil } }
+  end
+
+  describe "with Proc" do
+    class Follow < Trailblazer::Operation
+      include Policy::Guard
+
+      policy ->(params) { params == "true" } # TODO: is this really executed in op context?
+
+      def process(*)
+      end
+    end
+
+    it { Follow.("true").wont_equal nil }
+    it { assert_raises(Trailblazer::NotAuthorizedError) { Follow.(false).wont_equal nil } }
+  end
 end
 
 class OpBuilderDenyTest < MiniTest::Spec

data/test/operation_test.rb

@@ -54,6 +54,16 @@ class OperationModelTest < MiniTest::Spec
   it { Operation.(Object).model.must_equal Object }
 end
 
+# Operation#model=.
+class OperationModelWriterTest < MiniTest::Spec
+  class Operation < Trailblazer::Operation
+    def process(params)
+      self.model = "#{params}"
+    end
+  end
+
+  it { Operation.("I can set @model via a private setter").model.to_s.must_equal "I can set @model via a private setter" }
+end
 
 class OperationRunTest < MiniTest::Spec
   class Operation < Trailblazer::Operation
@@ -262,4 +272,4 @@ class OperationErrorsTest < MiniTest::Spec
     res, op = Operation.run({})
     op.errors.to_s.must_equal "{:title=>[\"can't be blank\"]}"
   end
-end
+end

data/test/representer_test.rb

@@ -175,4 +175,64 @@ class InternalRepresenterAPITest < MiniTest::Spec
       OptionsShow.present(include: [:id]).to_json.must_equal '{"id":1}'
     end
   end
-end
+end
+
+class DifferentParseAndRenderingRepresenterTest < MiniTest::Spec
+  Album = Struct.new(:title)
+
+  # rendering
+  class Create < Trailblazer::Operation
+    extend Representer::DSL
+    include Representer::Rendering # no Deserializer::Hash here or anything.
+
+    contract do
+      property :title
+    end
+
+    representer do
+      property :title, as: :Title
+    end
+
+    def process(params)
+      @model = Album.new
+      validate(params) do
+        contract.sync
+      end
+    end
+  end
+
+  it do
+    Create.(title: "The Kids").to_json.must_equal %{{"Title":"The Kids"}}
+  end
+
+  # parsing
+  class Update < Trailblazer::Operation
+    extend Representer::DSL
+    include Representer::Deserializer::Hash # no Rendering.
+
+    representer do
+      property :title, as: :Title
+    end
+
+    contract do
+      property :title
+    end
+
+
+    def process(params)
+      @model = Album.new
+
+      validate(params) do
+        contract.sync
+      end
+    end
+
+    def to_json(*)
+      %{{"title": "#{model.title}"}}
+    end
+  end
+
+  it do
+    Update.("Title" => "The Kids").to_json.must_equal %{{"title": "The Kids"}}
+  end
+end

data/test/test_helper.rb

@@ -4,4 +4,6 @@ require 'minitest/autorun'
 require "reform/form/active_model/validations"
 Reform::Form.class_eval do
   include Reform::Form::ActiveModel::Validations
-end
+end
+
+require "trailblazer/operation/model"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-22 00:00:00.000000000 Z
+date: 2016-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: uber