aldous 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbd9c9ba816e2ef37e0528487e6f203a2f30c821
-  data.tar.gz: 8b1ef09ccbd2e525f814255bcbe61425056edae2
+  metadata.gz: e396af4df13c405822eb290056947943e502c97b
+  data.tar.gz: 62e3f8739b0a35e9f0c4911347f088763e003944
 SHA512:
-  metadata.gz: 5ceae3ac65b7eb859192b9311c7ad8502426f59c25d5a2dfdabf0d7029d992c1525c785b94f61cc100f4492b4ccc1dee217b5052ce653a40ae34d8f8fecb83ca
-  data.tar.gz: 759d8191ad6b4c4d0e663f5dd268040924481419f93dbaf1d40dae727fbb3f77f13fa39ad8fdab32376670c55738b56f1bed964ca3e7fcce3d225f83995b7958
+  metadata.gz: 8ab212817cec483cff3f3ae186eb74ca4f8b3dc499634e5c5ce8af68b92bf17a3fba96e3a043819527100d5c4e3fcdb472cf9e55621a933bf1dad3245e95f004
+  data.tar.gz: 409b37981511c069505dcce476fde2bfa8d3eb9d723c06f9f8fec34f65c32f34ef93cad3224a26040f023d69c1c615ba2ebe98466510d18660b6dd72f4eab793

data/README.md

@@ -1,6 +1,6 @@
 # Aldous
 
-The basic idea behind this gem is that [Rails](https://github.com/rails/rails) is missing a few key things that make our lives especially painful when our applications start gettging bigger and more complex. With Aldous we attempt to address some of these shortcomings, namely:
+The basic idea behind this gem is that [Rails](https://github.com/rails/rails) is missing a few key things that make our lives especially painful when our applications start getting bigger and more complex. With Aldous we attempt to address some of these shortcomings, namely:
 
 1) Bloated models that trample all over the single responsibility principle. God models that tend to appear despite our best intentions. Not to mention the complexity of testing objects that are so big an unwieldy.
 
@@ -113,8 +113,8 @@ or
 
 ```ruby
 hash = {}
-result = CreateUserService.perform!(hash)
 begin
+  result = CreateUserService.perform!(hash)
   if result.success?
     # do success stuff
   else #result.failure?
@@ -191,11 +191,11 @@ The first thing to do is to configure a folder for the controller actions to liv
 
 ```ruby
 config.autoload_paths += %W(
-  #{config.root}/app/controller_action
+  #{config.root}/app/controller_actions
 )
 
 config.eager_load_paths += %W(
-  #{config.root}/app/controller_action
+  #{config.root}/app/controller_actions
 )
 ```
 
@@ -250,7 +250,7 @@ class BaseAction < ::Aldous::ControllerAction
     [Shared::EnsureUserNotDisabledPrecondition]
   end
 
-  def default_error_respondable
+  def default_error_handler(error)
     Defaults::ServerErrorView
   end
 
@@ -268,11 +268,11 @@ As you can see if inherits from `Aldous::ControllerAction`. The methods you shou
 
 - `default_view_data` - this hash of data will be available to all the aldous view objects
 - `preconditions` - this is used as a replacement for `before_actions`
-- `default_error_respondable` - this view will be rendered if an unhandled error gets raised in the action code
+- `default_error_handler` - this view will be rendered if an unhandled error gets raised in the action code
 
 Similar to services, for actions you implement the `perform` method (might as well keep things consistent). All action classes have the same constructor signature, they take a controller object and you have access to this controller object in your action classes. Also a few methods from the controller get exposed directly to your action (params, session, cookies, request, response) for convenience. You can expose others via configuration in an initializer, or you can grab them from the controller instance you have access to.
 
-Controller action are automatically error free, so any error that gets raised in the perform method, automatically get caught and a view you specify in `default_error_respondable` will get rendered to handle that error.
+Controller action are automatically error free, so any error that gets raised in the perform method, automatically get caught and a view you specify in `default_error_handler` will get rendered to handle that error.
 
 Lets look at a slightly bigger controller action:
 

data/examples/basic_todo/app/controller_actions/base_action.rb

@@ -10,7 +10,7 @@ class BaseAction < ::Aldous::ControllerAction
     [Shared::EnsureUserNotDisabledPrecondition]
   end
 
-  def default_error_respondable
+  def default_error_handler(error)
     Defaults::ServerErrorView
   end
 

data/examples/basic_todo/app/controller_actions/home_controller/show.rb

@@ -1,7 +1,6 @@
 class HomeController::Show < BaseAction
   def perform
     return build_view(Todos::IndexRedirect) if current_user
-
     build_view(Home::ShowView)
   end
 end

data/examples/basic_todo/app/controller_actions/shared/no_aldous_view_precondition.rb

@@ -0,0 +1,11 @@
+class Shared::NoAldousViewPrecondition < BasePrecondition
+  delegate :current_user, :current_ability, to: :action
+
+  def perform
+    controller.render(
+      template: 'defaults/forbidden',
+      status: :unprocessable_entity,
+      locals: {error: 'Foobar'}
+    )
+  end
+end

data/lib/aldous/controller/action/precondition.rb

@@ -37,6 +37,10 @@ module Aldous
           raise NotImplementedError.new("#{self.class.name} must implement method #perform")
         end
 
+        def controller
+          action.controller
+        end
+
         def build_view(respondable_class, extra_data = {})
           ::Aldous::BuildRespondableService.new(
             view_context: action.controller.view_context,

data/lib/aldous/controller/action/wrapper.rb

@@ -1,4 +1,5 @@
 require 'aldous/logging_wrapper'
+require 'aldous/respondable/base'
 
 module Aldous
   module Controller
@@ -18,15 +19,25 @@ module Aldous
           controller_action.default_view_data
         end
 
-        def default_error_respondable
-          controller_action.default_error_respondable
+        def default_error_handler(error)
+          controller_action.default_error_handler(error)
+        end
+
+        def controller
+          controller_action.controller
         end
 
         def perform
           controller_action.perform
         rescue => e
           ::Aldous::LoggingWrapper.log(e)
-          controller_action.build_view(default_error_respondable, errors: [e])
+
+          error_handler = default_error_handler(e)
+
+          if error_handler.kind_of?(Class) &&
+            error_handler.ancestors.include?(Aldous::Respondable::Base)
+            controller_action.build_view(error_handler, errors: [e])
+          end
         end
       end
     end

data/lib/aldous/controller/action_execution_service.rb

@@ -23,6 +23,9 @@ module Aldous
 
         precondition, precondition_result = PreconditionsExecutionService.new(action, controller).perform
 
+        # a precondition executed a render or a redirect
+        return if controller.performed?
+
         action_result = nil
         if precondition_result
           action = precondition
@@ -31,6 +34,9 @@ module Aldous
           action_result = action.perform
         end
 
+        # the action executed render or a redirect
+        return if controller.performed?
+
         Action::ResultExecutionService.perform(controller, action_result, action.default_view_data)
       rescue => e
         LoggingWrapper.log(e)

data/lib/aldous/controller_action.rb

@@ -46,7 +46,7 @@ module Aldous
       []
     end
 
-    def default_error_respondable
+    def default_error_handler(error)
       ::Aldous::View::Blank::HtmlView
     end
 

data/lib/aldous/version.rb

@@ -1,3 +1,3 @@
 module Aldous
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/spec/aldous/controller/action/wrapper_spec.rb

@@ -4,13 +4,13 @@ RSpec.describe Aldous::Controller::Action::Wrapper do
   let(:controller_action) { double 'controller action',
                             default_view_data: default_view_data,
                             preconditions: preconditions,
-                            default_error_respondable: default_error_respondable,
+                            default_error_handler: default_error_handler,
                             perform: nil,
                             build_view: nil }
 
   let(:default_view_data) { {default_view_data: true} }
   let(:preconditions) { double 'preconditions' }
-  let(:default_error_respondable) {double 'default_error_respondable'}
+  let(:default_error_handler) {double 'default_error_handler'}
 
   before do
     allow(Aldous::LoggingWrapper).to receive(:log)
@@ -31,15 +31,26 @@ RSpec.describe Aldous::Controller::Action::Wrapper do
         allow(controller_action).to receive(:perform).and_raise(e)
       end
 
-      it "builds a default error view with errors" do
-        expect(controller_action).to receive(:build_view).with(default_error_respondable, errors: [e])
-        perform
-      end
-
       it 'reports the error' do
         expect(Aldous::LoggingWrapper).to receive(:log).with(e)
         perform
       end
+
+      context "and the default error handler is a respondable" do
+        let(:default_error_handler) {Aldous::Respondable::Renderable}
+
+        it "builds a default error view with errors" do
+          expect(controller_action).to receive(:build_view).with(default_error_handler, errors: [e])
+          perform
+        end
+      end
+
+      context "and the default error handler is not a respondable" do
+        it "doesn't need to do anything" do
+          expect(controller_action).to_not receive(:build_view)
+          perform
+        end
+      end
     end
   end
 end

data/spec/aldous/controller/action_execution_service_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe Aldous::Controller::ActionExecutionService do
   let(:action_execution_service) {described_class.new(controller, controller_action_class)}
 
-  let(:controller) {double "controller", head: nil}
+  let(:controller) {double "controller", head: nil, performed?: false}
   let(:controller_action_class) {double "controller_action_class", build: action}
 
   let(:action) {double 'action', perform: action_result, default_view_data: default_view_data}
@@ -44,6 +44,21 @@ RSpec.describe Aldous::Controller::ActionExecutionService do
         expect(Aldous::Controller::Action::ResultExecutionService).to receive(:perform).with(controller, action_result, default_view_data)
         perform
       end
+
+      context "but action perform halted execution due to render" do
+        before do
+          allow(controller).to receive(:performed?).and_return(false, true)
+        end
+
+        it "returns nil" do
+          expect(perform).to be_nil
+        end
+
+        it "does not execute the result" do
+          expect(Aldous::Controller::Action::ResultExecutionService).to_not receive(:perform)
+          perform
+        end
+      end
     end
 
     context "when preconditions did halt execution" do
@@ -57,6 +72,19 @@ RSpec.describe Aldous::Controller::ActionExecutionService do
         expect(Aldous::Controller::Action::ResultExecutionService).to receive(:perform).with(controller, precondition_result, default_view_data)
         perform
       end
+
+      context "via a render on the controller object" do
+        let(:controller) {double "controller", head: nil, performed?: true}
+
+        it "returns nil" do
+          expect(perform).to be_nil
+        end
+
+        it "does not execute the result" do
+          expect(Aldous::Controller::Action::ResultExecutionService).to_not receive(:perform)
+          perform
+        end
+      end
     end
 
     context "when error occurs" do

data/spec/aldous/controller_action_spec.rb

@@ -67,9 +67,9 @@ RSpec.describe Aldous::ControllerAction do
     end
   end
 
-  describe "#default_error_respondable" do
+  describe "#default_error_handler" do
     it "is a blank html view by default" do
-      expect(action.default_error_respondable).to eq Aldous::View::Blank::HtmlView
+      expect(action.default_error_handler('foo')).to eq Aldous::View::Blank::HtmlView
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aldous
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Alan Skorkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-20 00:00:00.000000000 Z
+date: 2015-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -83,6 +83,7 @@ files:
 - examples/basic_todo/app/controller_actions/base_precondition.rb
 - examples/basic_todo/app/controller_actions/home_controller/show.rb
 - examples/basic_todo/app/controller_actions/shared/ensure_user_not_disabled_precondition.rb
+- examples/basic_todo/app/controller_actions/shared/no_aldous_view_precondition.rb
 - examples/basic_todo/app/controller_actions/sign_ins_controller/create.rb
 - examples/basic_todo/app/controller_actions/sign_ins_controller/destroy.rb
 - examples/basic_todo/app/controller_actions/sign_ins_controller/new.rb