trailblazer 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02c7b4eafd8dfcbb9eb29aafd91a9213aa34d0e9
-  data.tar.gz: 8720dec06b3af4b127f77ca140c25e71f7a68799
+  metadata.gz: 994926094dd0136c1436127773dd4c8786cd3cb3
+  data.tar.gz: ce869dcf9f8c01e2fe10847e3d4b54e460537960
 SHA512:
-  metadata.gz: 20bd8a8b6b296bea95bd73a27269855af238c03b5617885c6a51015dc40b2ef7d1c5ea7ff394961e8871d0724fd614d1868227afb3112b74685f55f42eb6a9b1
-  data.tar.gz: 79c3548b02e02789dc8a1ea55141d1786b710d53dd3213aae0cc0e28a1373c247debae6c1e845522e95235d7befd9fd30968f1ba92fbd7d4fdaaedc5641f9ae1
+  metadata.gz: 26367bea09297a1bbcf29506d589826f3e83fca5dc45e4bb6d7146a57f2984c60d324cda43f55a52cd08f3523ed5e76d5b0c56bbddd531a2509ccd4e81117861
+  data.tar.gz: ff56573c794feb3afbbc7bac40026f65f418153e9aaef9cbdb6967a01d37412ba1faa95fb4127bab82efd6ad0f5ef10a2ea359a8f94bd8749dbebd480b64d8a2

data/CHANGES.md

@@ -1,3 +1,20 @@
+# 0.2.0
+
+## API Changes
+
+* `Controller#present` no longer calls `respond_to`, but lets you do the rendering. This will soon be re-introduced using `respond(present: true)`.
+* `Controller#form` did not respect builders, this is fixed now.
+* Use `request.body.read` in Unicorn/etc. environments in `Controller#respond`.
+
+## Stuff
+
+* Autoloading changed, again. We now `require_dependency` in every request in dev.
+
+# 0.1.3
+
+* `crud_autoloading` now simply `require_dependency`s model files, then does the same for the CRUD operation file. This should fix random undefined constant problems in development.
+* `Controller#form` did not use builders. This is fixed now.
+
 # 0.1.2
 
 * Add `crud_autoloading`.

data/README.md

@@ -6,7 +6,7 @@ In a nutshell: Trailblazer makes you write **logicless models** that purely act
 
 ![](https://raw.githubusercontent.com/apotonick/trailblazer/master/doc/trb.jpg)
 
-Please sign up for my upcoming book [Trailblazer - A new architecture for Rails](https://leanpub.com/trailblazer), check out the free sample chapter and [let me know](http://twitter.com/apotonick) what you think!
+Please buy my book [Trailblazer - A new architecture for Rails](https://leanpub.com/trailblazer) and [let me know](http://twitter.com/apotonick) what you think! I am still working on the book but keep adding new chapters every other week. It will be about 300 pages and we're developing a real, full-blown Rails/Trb application.
 
 The [demo application](https://github.com/apotonick/gemgem-trbrb) implements what we discuss in the book.
 
@@ -173,7 +173,7 @@ Again, this will only run the operation's setup and provide the model in `@model
 
 For document-based APIs and request types that are not HTTP the operation will be advised to render the JSON or XML document using the operation's representer.
 
-Note that `#present` will also work instead of `#form` (allowing it to be used in `#new` and `#edit`, too) as the responder will _not_ trigger any rendering in those actions.
+Note that `#present` will leave rendering up to you - `respond_to` is _not_ called.
 
 ### Controller API
 
@@ -415,18 +415,22 @@ Use our autoloading if you dislike explicit requires.
 You can just add
 
 ```ruby
-require 'trailblazer/autoloading'
+require "trailblazer/autoloading"
 ```
 
-to `config/initializers/trailblazer.rb` and implementation files like `Operation` will be automatically loaded.
+to `config/initializers/trailblazer.rb` and implementation classes 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.
+## Operation Autoloading
+
+If you structure your CRUD operations using the `app/concepts/*/crud.rb` file layout we use in the book, the `crud.rb` files are not gonna be found by Rails automatically. It is a good idea to enable CRUD autoloading.
+
+At the end of your `config/application.rb` file, add the following.
 
 ```ruby
-require trailblazer/crud_autoloading
+require "trailblazer/rails/railtie"
 ```
 
-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.
+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.
 
 
 ## Why?

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.present(params)
+    @operation = operation_class.present(params)
     @form      = @operation.contract
     @model     = @operation.model
 
@@ -19,7 +19,8 @@ private
     res, op = operation!(operation_class, params) { [true, operation_class.present(params)] }
 
     yield op if block_given?
-    respond_with op
+    # respond_with op
+    # TODO: implement respond(present: true)
   end
 
   # full-on Op[]
@@ -64,8 +65,9 @@ private
       # this is what happens:
       # respond_with Comment::Update::JSON.run(params.merge(comment: request.body.string))
       concept_name = operation_class.model_class.to_s.underscore # this could be renamed to ::concept_class soon.
+      request_body = request.body.respond_to?(:string) ? request.body.string : request.body.read
 
-      params.merge!(concept_name => request.body.string)
+      params.merge!(concept_name => request_body)
     end
 
     res, @operation = yield # Create.run(params)

data/lib/trailblazer/rails/railtie.rb

@@ -0,0 +1,24 @@
+module Trailblazer
+  class Railtie < Rails::Railtie
+    def self.autoload_crud_operations(app)
+      Dir.glob("app/concepts/**/crud.rb") do |f|
+        path  = f.sub("app/concepts/", "")
+        model = path.sub("/crud.rb", "")
+
+        require_dependency "#{app.root}/app/models/#{model}" # load the model file, first (thing.rb).
+        require_dependency "#{app.root}/#{f}" # load app/concepts/{concept}/crud.rb (Thing::Create, Thing::Update, and so on).
+      end
+    end
+
+    # thank you, http://stackoverflow.com/a/17573888/465070
+    initializer 'trailblazer.install' do |app|
+      if Rails.configuration.cache_classes
+        Trailblazer::Railtie.autoload_crud_operations(app)
+      else
+        ActionDispatch::Reloader.to_prepare do
+          Trailblazer::Railtie.autoload_crud_operations(app)
+        end
+      end
+    end
+  end
+end

data/lib/trailblazer/version.rb

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

data/test/operation_test.rb

@@ -40,6 +40,8 @@ class OperationRunTest < MiniTest::Spec
 
   # return operation when ::call
   it { Operation.call(true).must_equal operation }
+  it { Operation.(true).must_equal operation }
+  # #[] is alias for .()
   it { Operation[true].must_equal operation }
 
   # ::[] raises exception when invalid.
@@ -88,7 +90,7 @@ class OperationRunTest < MiniTest::Spec
 
   # Operation#contract returns @contract
   let (:contract)  { Operation::Contract.new }
-  it { Operation[true].contract.must_equal contract }
+  it { Operation.(true).contract.must_equal contract }
 end
 
 
@@ -119,7 +121,7 @@ class OperationTest < MiniTest::Spec
   # ::run
   it { OperationWithoutValidateCall.run(Object).must_equal [true, Object] }
   # ::[]
-  it { OperationWithoutValidateCall[Object].must_equal(Object) }
+  it { OperationWithoutValidateCall.(Object).must_equal(Object) }
   # ::run with invalid!
   it { OperationWithoutValidateCall.run(nil).must_equal [false, nil] }
   # ::run with block, invalid
@@ -155,7 +157,7 @@ class OperationTest < MiniTest::Spec
   end
 
   it { OperationWithValidateBlock.run(false).last.secret_contract.must_equal nil }
-  it('zzz') { OperationWithValidateBlock[true].secret_contract.must_equal OperationWithValidateBlock.contract_class.new.extend(Comparable) }
+  it('zzz') { OperationWithValidateBlock.(true).secret_contract.must_equal OperationWithValidateBlock.contract_class.new.extend(Comparable) }
 
   # manually setting @valid
   class OperationWithManualValid < Trailblazer::Operation
@@ -168,7 +170,7 @@ class OperationTest < MiniTest::Spec
   # ::run
   it { OperationWithManualValid.run(Object).must_equal [false, Object] }
   # ::[]
-  it { OperationWithManualValid[Object].must_equal(Object) }
+  it { OperationWithManualValid.(Object).must_equal(Object) }
 
 
   # re-assign params
@@ -281,8 +283,8 @@ class OperationBuilderTest < MiniTest::Spec
   it { Operation.run({}).last.must_equal "operation" }
   it { Operation.run({sub: true}).last.must_equal "sub:operation" }
 
-  it { Operation[{}].must_equal "operation" }
-  it { Operation[{sub: true}].must_equal "sub:operation" }
+  it { Operation.({}).must_equal "operation" }
+  it { Operation.({sub: true}).must_equal "sub:operation" }
 end
 
 # ::contract builds Reform::Form class

data/test/rails/controller_test.rb

@@ -113,13 +113,29 @@ class ResponderRespondWithJSONTest < ActionController::TestCase
   end
 end
 
+# TODO: merge with above tests on SongsController.
+class ControllerRespondTest < ActionController::TestCase
+  tests BandsController
+
+  test "#respond with builds" do
+    post :create, band: {name: "SNFU"}, admin: true
+    assert_response 302
+    assert_equal "SNFU [ADMIN]", Band.last.name
+  end
+end
+
 
 class ResponderRunTest < ActionController::TestCase
   tests BandsController
 
   test "[html/valid]" do
     put :update, {id: 1, band: {name: "Nofx"}}
-    assert_equal "no block: Nofx, Essen", response.body
+    assert_equal "no block: Nofx, Essen, Band::Create", response.body
+  end
+
+  test "[html/valid] with builds" do
+    put :update, {id: 1, band: {name: "Nofx"}, admin: true}
+    assert_equal "no block: Nofx [ADMIN], Essen, Band::Create::Admin", response.body
   end
 
   test "with block [html/valid]" do
@@ -146,6 +162,7 @@ class ControllerPresentTest < ActionController::TestCase
     assert_equal "bands/show.html: Band,Band,true,Band::Update,Essen\n", response.body
   end
 
+  # TODO: this implicitely tests builds. maybe have separate test for that?
   test "#present [JSON]" do
     band = Band::Create[band: {name: "Nofx"}].model
 
@@ -171,4 +188,10 @@ class ControllerFormTest < ActionController::TestCase
 
     assert_select "b", "Band,Band,true,Band::Create,Essen"
   end
+
+  test "#form with builder" do
+    get :new, admin: true
+
+    assert_select "b", ",Band,true,Band::Create::Admin"
+  end
 end

data/test/rails/fake_app/controllers.rb

@@ -49,7 +49,9 @@ class BandsController < ApplicationController
     present Band::Update do |op|
       @klass    = op.model.class
       @locality = params[:band][:locality] unless params[:format] == "json"
-    end # respond_to
+
+      render json: op.to_json if params[:format] == "json"
+    end # render :show
   end
 
   def new
@@ -82,7 +84,7 @@ ERB
   def update
     run Band::Create
 
-    render text: "no block: #{@operation.model.name}, #{params[:band][:locality]}"
+    render text: "no block: #{@operation.model.name}, #{params[:band][:locality]}, #{@operation.class}"
   end
 
   def update_with_block

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

@@ -66,8 +66,25 @@ class Band < ActiveRecord::Base
       end
     end
 
+    class Admin < self
+      def process(params)
+        res = super
+        model.update_attribute :name, "#{model.name} [ADMIN]"
+        res
+      end
+    end
+
+    # TODO: wait for uber 0.0.10 and @dutow.
+    # builds -> (params)
+    #   return JSON if params[:format] == "json"
+    #   return Admin if params[:admin]
+    # end
     builds do |params|
-      JSON if params[:format] == "json"
+      if params[:format] == "json"
+        JSON
+      elsif params[:admin]
+        Admin
+      end
     end
   end
 

data/trailblazer.gemspec

@@ -28,4 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest"
   # spec.add_development_dependency "minitest-spec-rails" # TODO: can anyone make this work (test/rails).
   spec.add_development_dependency "sidekiq", "~> 3.1.0"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "sqlite3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2015-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -128,6 +128,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.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: sqlite3
+  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'
 description: Trailblazer is a thin layer on top of Rails. It gently enforces encapsulation,
   an intuitive code structure and gives you an object-oriented architecture.
 email:
@@ -151,7 +179,6 @@ 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
@@ -159,6 +186,7 @@ files:
 - lib/trailblazer/operation/responder.rb
 - lib/trailblazer/operation/uploaded_file.rb
 - lib/trailblazer/operation/worker.rb
+- lib/trailblazer/rails/railtie.rb
 - lib/trailblazer/version.rb
 - test/crud_test.rb
 - test/fixtures/apotomo.png
@@ -174,7 +202,6 @@ 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
@@ -220,7 +247,6 @@ 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

data/lib/trailblazer/crud_autoloading.rb

@@ -1,8 +0,0 @@
-# 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/test/rails/integration_test.rb

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