trailblazer 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0ed3011dfc0a91641be3c62c80a9fdf8f68d9b2
-  data.tar.gz: 3a219f4bb0f1873088249b39d5a51d097c4ea919
+  metadata.gz: 02c7b4eafd8dfcbb9eb29aafd91a9213aa34d0e9
+  data.tar.gz: 8720dec06b3af4b127f77ca140c25e71f7a68799
 SHA512:
-  metadata.gz: 9d8d68ac22880d537923009618bd71ba6463632e5f9a453e4c1d6d8e03f892ff5ee8cf2d240678549d035acbd5d84c6649c426b10eb311c765d1e713fcc83b4e
-  data.tar.gz: 556f3942a0e00e5a83a112f88ea1962b0e28a34698acf2e5cbc2b9103c66a14b142a57cf10d8ce623d183858c729d9e9c516c127869d4fe141a78fe7e79aee94
+  metadata.gz: 20bd8a8b6b296bea95bd73a27269855af238c03b5617885c6a51015dc40b2ef7d1c5ea7ff394961e8871d0724fd614d1868227afb3112b74685f55f42eb6a9b1
+  data.tar.gz: 79c3548b02e02789dc8a1ea55141d1786b710d53dd3213aae0cc0e28a1373c247debae6c1e845522e95235d7befd9fd30968f1ba92fbd7d4fdaaedc5641f9ae1

data/CHANGES.md

@@ -1,3 +1,11 @@
+# 0.1.2
+
+* Add `crud_autoloading`.
+
+# 0.1.1
+
+* Use reform-1.2.0.
+
 # 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!

data/README.md

@@ -165,7 +165,7 @@ For `#show` actions that simply present the model using a HTML page or a JSON or
 
 ```ruby
 def show
-  present Comment::Create
+  present Comment::Update
 end
 ```
 
@@ -372,17 +372,17 @@ class Comment::Image::Crop < Trailblazer::Operation
   include Worker
 
   def process(params)
-    # will be run asynchronous.
+    # will be run asynchronously.
   end
 end
 ```
 
 ### Rendering Operation's Form
 
-You have access to an operation's form using `::contract`.
+You have access to an operation's form using `::present`.
 
 ```ruby
-Comment::Create.contract(params)
+Comment::Create.present(params)
 ```
 
 This will run the operation's `#process` method _without_ the validate block and return the contract.
@@ -418,8 +418,15 @@ You can just add
 require 'trailblazer/autoloading'
 ```
 
-to `config/initializers/trailblazer.rb` and files will be "automatically" loaded.
+to `config/initializers/trailblazer.rb` and implementation files like `Operation` will be automatically loaded.
 
+In case you structure your CRUD operations in the `app/concepts/thing/crud.rb` file layout we use in the book, you're gonna run into `Missing constant` trouble. As the `crud.rb` files are not found by Rails it is a good idea to enable CRUD autoloading.
+
+```ruby
+require trailblazer/crud_autoloading
+```
+
+This will go through `app/concepts/`, find all the `crud.rb` files, autload their corresponding namespace (e.g. `Thing`, which is a model) and then load the `crud` file.
 
 
 ## Why?

data/TODO.md

@@ -1,6 +1,11 @@
+# Operation: External API
+
 * allow `Op[{body: "Great!"}, {additional: true}]` to save merge.
 * make `Op[]` not require wrap like `comment: {}`
 * in tests, make Op[].model return the reloaded model!
 
+# Operation: Internal API
+
+* don't populate the form in #present context, we don't need it (only the representer goes nuts)
 * don't pass contract in validate, we have #contract.
 * abstract validate/success/fail into methods to make it easily overrideable.

data/gemfiles/Gemfile.rails.lock

@@ -1,9 +1,9 @@
 PATH
   remote: ../
   specs:
-    trailblazer (0.0.1)
+    trailblazer (0.1.1)
       actionpack (>= 3.0.0)
-      reform (= 1.2.0.beta1)
+      reform (~> 1.2.0)
       representable (>= 2.1.1, < 2.2.0)
       uber (>= 0.0.10)
 
@@ -37,18 +37,18 @@ GEM
     celluloid (0.16.0)
       timers (~> 4.0.0)
     connection_pool (2.0.0)
-    disposable (0.0.8)
+    disposable (0.0.9)
       representable (~> 2.0)
       uber
     erubis (2.7.0)
     hitimes (1.2.2)
     i18n (0.6.11)
     json (1.8.1)
-    mini_portile (0.6.0)
+    mini_portile (0.6.1)
     minitest (5.4.2)
     multi_json (1.10.1)
-    nokogiri (1.6.3.1)
-      mini_portile (= 0.6.0)
+    nokogiri (1.6.4.1)
+      mini_portile (~> 0.6.0)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
@@ -61,7 +61,7 @@ GEM
     redis (3.1.0)
     redis-namespace (1.5.1)
       redis (~> 3.0, >= 3.0.4)
-    reform (1.2.0.beta1)
+    reform (1.2.1)
       activemodel
       disposable (~> 0.0.5)
       representable (~> 2.1.0)
@@ -83,7 +83,7 @@ GEM
       hitimes
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    uber (0.0.10)
+    uber (0.0.11)
 
 PLATFORMS
   ruby

data/lib/trailblazer/crud_autoloading.rb

@@ -0,0 +1,8 @@
+# FIXME: this will only work for operations embedded in a MODEL namespace.
+# this is really hacky and assumes a lot about your structure, but it works for now. don't include it if you don't like it.
+Dir.glob("app/concepts/**/crud.rb") do |f|
+  path = f.sub("app/concepts/", "")
+
+  path.sub("/crud.rb", "").camelize.constantize # load the model first (Thing).
+  require_dependency path # load model/crud.rb (Thing::Create, Thing::Update, and so on).
+end

data/lib/trailblazer/operation.rb

@@ -4,6 +4,8 @@ require 'reform'
 
 # TODO: OP[] without wrapper, OP.run with (eg for params)
 
+# to be documented: only implement #setup! when not using CRUD and when ::present needed (make example for simple Op without #setup!)
+
 module Trailblazer
   class Operation
     extend Uber::InheritableAttr
@@ -37,7 +39,7 @@ module Trailblazer
 
       # Runs #process without validate and returns the form object.
       def present(*params)
-        build_operation_class(*params).new(:validate => false).run(*params).last
+        build_operation_class(*params).new.present(*params)
       end
 
       def contract(&block)
@@ -57,7 +59,6 @@ module Trailblazer
     def initialize(options={})
       @valid            = true
       # DISCUSS: use reverse_merge here?
-      @validate         = options[:validate] == false ? false : true
       @raise_on_invalid = options[:raise_on_invalid] || false
     end
 
@@ -68,6 +69,13 @@ module Trailblazer
       [process(*params), valid?].reverse
     end
 
+    def present(*params)
+      setup!(*params)
+
+      @contract = contract_for(nil, @model)
+      self
+    end
+
     attr_reader :contract
 
     def valid?
@@ -77,14 +85,16 @@ module Trailblazer
   private
 
     def setup!(*params)
+      @model = model!(*params)
     end
 
-    def validate(params, model, contract_class=nil) # NOT to be overridden?!! it creates Result for us.
+    # Implement #model! to find/create your operation model (if required).
+    def model!(*params)
+    end
 
+    def validate(params, model, contract_class=nil) # NOT to be overridden?!! it creates Result for us.
       @contract = contract_for(contract_class, model)
 
-      return self unless @validate # Op.contract will return here.
-
       if @valid = contract.validate(params)
         yield contract if block_given?
       else

data/lib/trailblazer/operation/controller.rb

@@ -5,7 +5,7 @@ private
   def form(operation_class, params=self.params) # consider private.
     process_params!(params)
 
-    @operation = operation_class.new(:validate => false).run(params).last # FIXME: make that available via Operation.
+    @operation = operation_class.new.present(params)
     @form      = @operation.contract
     @model     = @operation.model
 
@@ -63,7 +63,8 @@ private
     unless request.format == :html
       # this is what happens:
       # respond_with Comment::Update::JSON.run(params.merge(comment: request.body.string))
-      concept_name = operation_class.model_class # this could be renamed to ::concept_class soon.
+      concept_name = operation_class.model_class.to_s.underscore # this could be renamed to ::concept_class soon.
+
       params.merge!(concept_name => request.body.string)
     end
 

data/lib/trailblazer/operation/crud.rb

@@ -39,8 +39,8 @@ module Trailblazer
       end
 
     private
-      def setup!(params)
-        @model ||= instantiate_model(params)
+      def model!(params)
+        instantiate_model(params)
       end
 
       def instantiate_model(params)

data/lib/trailblazer/operation/representer.rb

@@ -1,18 +1,18 @@
 module Trailblazer::Operation::Representer
-  # TODO: test me.
-
   def self.included(base)
     base.extend Uber::InheritableAttr
     base.inheritable_attr :representer_class
     # TODO: allow representer without contract?!
-    # TODO: we have to extract the schema here, not subclass the contract.
-    base.representer_class = Class.new(base.contract_class.representer_class)
     base.extend ClassMethods
   end
 
   module ClassMethods
     def representer(&block)
-      representer_class.class_eval(&block)
+      build_representer_class.class_eval(&block)
+    end
+
+    def build_representer_class
+      representer_class || self.representer_class= Class.new(contract_class.schema)
     end
   end
 end

data/lib/trailblazer/version.rb

@@ -1,3 +1,3 @@
 module Trailblazer
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/test/operation_test.rb

@@ -238,8 +238,7 @@ class OperationTest < MiniTest::Spec
   it { OperationReceivingLottaArguments.run(Object, {}).must_equal([true, [Object, {}]]) }
 
 
-  # TODO: experimental.
-  # ::present to avoid running #validate.
+  # ::present only runs #setup! which runs #model!.
   class ContractOnlyOperation < Trailblazer::Operation
     self.contract_class = class Contract
       def initialize(model)
@@ -249,12 +248,12 @@ class OperationTest < MiniTest::Spec
       self
     end
 
-    def process(params)
-      @object = Object # arbitrary init code.
+    def model!(params)
+      Object
+    end
 
-      validate(params, Object) do
-        raise "this should not be run."
-      end
+    def process(params)
+      raise "This is not run!"
     end
   end
 

data/test/rails/controller_test.rb

@@ -34,6 +34,7 @@ class ProcessParamsTest < ActionController::TestCase
 
   test "Create with overridden #process_params" do
     post :create, band: {name: "Kreator"}
+    assert_redirected_to band_path(Band.last)
 
     band = Band.last
     assert_equal "Kreator", band.name
@@ -44,10 +45,6 @@ end
 class ResponderRespondTest < ActionController::TestCase
   tests SongsController
 
-  setup do
-    @routes = Rails.application.routes
-  end
-
   # HTML
   # #respond Create [valid]
   test "Create [html/valid]" do
@@ -57,6 +54,7 @@ class ResponderRespondTest < ActionController::TestCase
 
   test "Create [html/invalid]" do
     post :create, {song: {title: ""}}
+    assert_response 200
     assert_equal @response.body, "{:title=&gt;[&quot;can&#39;t be blank&quot;]}"
   end
 
@@ -69,11 +67,13 @@ class ResponderRespondTest < ActionController::TestCase
 
   test "respond with block [html/valid]" do
     post :create_with_block, {song: {title: "You're Going Down"}}
+    assert_response 200
     assert_equal "block run, valid: true", response.body
   end
 
   test "respond with block [html/invalid]" do
     post :create_with_block, {song: {title: ""}}
+    assert_response 200
     assert_equal "block run, valid: false", response.body
   end
 
@@ -100,18 +100,17 @@ class ResponderRespondTest < ActionController::TestCase
     assert_response 200
     assert_equal "Song slayer!", response.body
   end
+end
 
-  # TODO: #present
-  # TODO: #run
-
-  # describe "#run" do
-  #   test "#run" do
-
-  # end
-  # end
-
-
+class ResponderRespondWithJSONTest < ActionController::TestCase
+  tests BandsController
 
+  # JSON
+  test "Create [JSON/valid]" do
+    post :create, {name: "SNFU"}.to_json, format: :json
+    assert_response 201
+    assert_equal "SNFU", Band.last.name
+  end
 end
 
 
@@ -144,7 +143,7 @@ class ControllerPresentTest < ActionController::TestCase
 
     get :show, id: band.id
 
-    assert_equal "bands/show.html: Band,Band,true,Band::Create,Essen\n", response.body
+    assert_equal "bands/show.html: Band,Band,true,Band::Update,Essen\n", response.body
   end
 
   test "#present [JSON]" do

data/test/rails/fake_app/controllers.rb

@@ -46,9 +46,9 @@ class BandsController < ApplicationController
   respond_to :html, :json
 
   def show
-    present Band::Create do |op|
+    present Band::Update do |op|
       @klass    = op.model.class
-      @locality = params[:band][:locality]
+      @locality = params[:band][:locality] unless params[:format] == "json"
     end # respond_to
   end
 
@@ -95,6 +95,8 @@ ERB
 
 private
   def process_params!(params) # this is where you set :current_user, etc.
+    return if params[:format] == "json"
+
     params[:band] ||= {}
     params[:band][:locality] = "Essen"
   end

data/test/rails/fake_app/models.rb

@@ -2,11 +2,23 @@
 class Song < ActiveRecord::Base
 end
 
+class Band < ActiveRecord::Base
+  has_many :songs
+end
+
 # migrations
 class CreateAllTables < ActiveRecord::Migration
   def self.up
-    create_table(:songs) { |t| t.string :title; t.integer :length }
-    create_table(:bands) { |t| t.string :name;  t.string :locality }
+    create_table(:songs) do |t|
+      t.string :title
+      t.integer :length
+      t.integer :band_id
+    end
+
+    create_table(:bands) do |t|
+      t.string :name
+      t.string :locality
+    end
   end
 end
 ActiveRecord::Migration.verbose = false

data/test/rails/fake_app/song/operations.rb

@@ -30,7 +30,7 @@ end
 
 class Band < ActiveRecord::Base
   class Create < Trailblazer::Operation
-    include CRUD, Responder
+    include CRUD, Responder, Representer
     model Band, :create
 
     contract do
@@ -39,6 +39,14 @@ class Band < ActiveRecord::Base
 
       property :name, validates: {presence: true}
       property :locality
+
+      # class: Song #=> always create new song
+      # instance: { Song.find(params[:id]) or Song.new } # same as find_or_create ?
+      # this is what i want:
+      # maybe make populate_if_empty a representable feature?
+      collection :songs, populate_if_empty: Song do
+        property :title
+      end
     end
 
     def process(params)
@@ -48,12 +56,28 @@ class Band < ActiveRecord::Base
     end
 
     class JSON < self
-      action :find
-      include Representer
-      # self.representer_class = Class.new(contract_class)
-      # representer_class do
-      #   include Reform::Form::JSON
-      # end
+      require "reform/form/json"
+      contract do
+        include Reform::Form::JSON # this allows deserialising JSON.
+      end
+
+      representer do
+        collection :songs, inherit: true, render_empty: false # tested in ControllerPresentTest.
+      end
+    end
+
+    builds do |params|
+      JSON if params[:format] == "json"
+    end
+  end
+
+  class Update < Create
+    action :update
+
+    # TODO: infer stuff per default.
+    class JSON < self
+      self.contract_class = Create::JSON.contract_class
+      self.representer_class = Create::JSON.representer_class
     end
 
     builds do |params|

data/test/rails/integration_test.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+class IntegrationTest < ActionController::TestCase
+  tests BandsController
+
+  # test rendering JSON of populated band.
+  test "#present [JSON]" do
+    band = Band::Create[band: {name: "Nofx", songs: [{title: "Murder The Government"}, {title: "Eat The Meek"}]}].model
+
+    get :show, id: band.id, format: :json
+    assert_equal "{\"name\":\"Nofx\",\"songs\":[{\"title\":\"Murder The Government\"},{\"title\":\"Eat The Meek\"}]}", response.body
+  end
+
+  # parsing incoming complex document.
+  test "create [JSON]" do
+    post :create, "{\"name\":\"Nofx\",\"songs\":[{\"title\":\"Murder The Government\"},{\"title\":\"Eat The Meek\"}]}", format: :json
+    assert_response 201
+
+    band = Band.last
+    assert_equal "Nofx", band.name
+    assert_equal "Murder The Government", band.songs[0].title
+  end
+end

data/trailblazer.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "actionpack", '>= 3.0.0' # this framework works on Rails.
   spec.add_dependency "uber", ">= 0.0.10" # no builder inheritance.
   spec.add_dependency "representable", ">= 2.1.1", "<2.2.0" # Representable::apply.
-  spec.add_dependency "reform", "1.2.0.beta1"
+  spec.add_dependency "reform", "~> 1.2.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-04 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -62,16 +62,16 @@ dependencies:
   name: reform
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0.beta1
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0.beta1
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +151,7 @@ files:
 - gemfiles/Gemfile.rails.lock
 - lib/trailblazer.rb
 - lib/trailblazer/autoloading.rb
+- lib/trailblazer/crud_autoloading.rb
 - lib/trailblazer/operation.rb
 - lib/trailblazer/operation/controller.rb
 - lib/trailblazer/operation/crud.rb
@@ -173,6 +174,7 @@ files:
 - test/rails/fake_app/song/operations.rb
 - test/rails/fake_app/views/bands/show.html.erb
 - test/rails/fake_app/views/songs/new.html.erb
+- test/rails/integration_test.rb
 - test/rails/test_helper.rb
 - test/responder_test.rb
 - test/test_helper.rb
@@ -218,6 +220,7 @@ test_files:
 - test/rails/fake_app/song/operations.rb
 - test/rails/fake_app/views/bands/show.html.erb
 - test/rails/fake_app/views/songs/new.html.erb
+- test/rails/integration_test.rb
 - test/rails/test_helper.rb
 - test/responder_test.rb
 - test/test_helper.rb