outbacker 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d4106a11fe016a7b8362914af3220b7158bc88a
-  data.tar.gz: cbce1db7f97cedf15b12fd7241ca9999f9a4ca75
+  metadata.gz: 75b6426d3f64c62516541550bd341193474249e7
+  data.tar.gz: 57a542ea46bf9c35e4b6e2a353640f78a74f6aea
 SHA512:
-  metadata.gz: 9fde43700e7d224b2ddaaf0da6903a9435c4854e0a8524208c3ef1dac899c6218f613bce926b282b25069ad24052f65eda530e2986919eb9e6c2f41feffea5de
-  data.tar.gz: ecf23c5a8b829e813370bdcfbc34e0500f20be1b66c89fc4c9c4df09966ea3f9dc54f9a5e341ab615a5000f7ae206f8ad4d28daa4c38cc96a1b01c52d2dd4122
+  metadata.gz: f6c04602dee484578e756c6c8f6c663af69fddd4f398b73a4e386b42ea6ad983405b7e479f492c5c713dd85f3ddd1e73932f7eacaa02f367e226a3d178a238f6
+  data.tar.gz: 71ee9b9aef806fed79fc4f81e1bc37368125f37d877277387e310e731a678fe5c0dfb50616e4e67c0ea88932eeb2d813fcd0b2b40dfd51900eb4e912eaff5fc3

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.1.1 2015-07-27
+[changed] Updated README and examples.
+
 ## 0.1.0 2015-07-27
 Initial release.
 

data/README.md

@@ -3,16 +3,17 @@
 [![Build Status](https://travis-ci.org/polypressure/outbacker.svg?branch=master)](https://travis-ci.org/polypressure/outbacker)
 [![Code Climate](https://codeclimate.com/github/polypressure/outbacker/badges/gpa.svg)](https://codeclimate.com/github/polypressure/outbacker)
 [![Test Coverage](https://codeclimate.com/github/polypressure/outbacker/badges/coverage.svg)](https://codeclimate.com/github/polypressure/outbacker/coverage)
+[![Gem Version](https://badge.fury.io/rb/outbacker.svg)](http://badge.fury.io/rb/outbacker)
 
 Rails developers have long known how important it is to keep controllers "skinny" and free of business logic. Our controllers are supposed to be dumb dispatchers that take results from the model layer and turn them into redirects, flash messages, form re-renderings, session state updates, JSON responses, HTTP status codes, and so on.
 
-But far too often, the conditional logic in typical Rails controllers to act on results from models and decide what to do next attracts business logic and spirals out of control. Complicated logic sneaks into our controllers as we add code to handle new features, stories, and special cases. And the cultural and process controls we put in place to enforce good code hygiene chronically break down in the face of schedule pressure, growing teams, emergency fixes, etc.
+But far too often, the conditional logic in typical Rails controllers—the logic to act on results from models and decide what to do next—spirals out of control, attracting and trapping business logic, and making testing and reuse difficult. Complexity sneaks into our controllers as we add code to handle new features, stories, and special cases. And the cultural and process controls we put in place to enforce good code hygiene chronically break down in the face of schedule pressure, growing teams, emergency fixes, etc.
 
-**Outbacker** ("outcome callbacks") is a very simple micro library that makes it easy to keep controllers free of this conditional logic. Controllers become simple, declarative mappings of business logic results to the redirects, flash messages, session state updates, HTTP status codes, and other actions that deliver results to the user.
+**Outbacker** ("outcome callbacks") is a very simple micro library that makes it easy to keep controllers free of this conditional logic. Controllers become simple, declarative mappings of business logic results to the redirects, flash messages, session state updates, HTTP status codes, and other actions that deliver results to the user. Conditional controller logic can't grow into complicated business logic—because our controllers no longer have conditional logic in the first place.
 
 It turns out that not only is Outbacker a prophylaxis against fat, complicated controllers, it more generally supports a very simple, low-ceremony way to write intention-revealing Rails code with both skinny controllers _and_ skinny models. If you feel these are worthwhile aims for your Ruby/Rails code—but you've found many approaches to accomplish this ineffective or not worth the trouble—then you might find Outbacker valuable.
 
-**Note:** The README that follows has a lot of motivation, rationale, and explanation—maybe excessively so for such a simple library. If you're impatient, you can go straight to some [code examples](https://github.com/polypressure/outbacker/tree/master/examples). Hopefully, these examples are sufficient for you to get an understanding of what Outbacker provides, and how to use it. If not, you can always come back to this readme.
+**Note:** The README that follows has a lot of explanation about rationale and motivation—maybe excessively, logorrheically so for such a simple library. If you're impatient, you can go straight to some [code examples](https://github.com/polypressure/outbacker/tree/master/examples/README.md). Hopefully, these examples are sufficient for you to get an understanding of what Outbacker provides, and how to use it. If not, you can always come back to this readme.
 
 ## A Typical Rails Controller
 

data/examples/README.md

@@ -0,0 +1,10 @@
+# Outbacker Examples
+
+Quick examples of how to use Outbacker. Please look at them in this order:
+
+1. A [controller](https://github.com/polypressure/outbacker/blob/master/examples/app/controllers/appointments_controller.rb) that uses Outbacker.
+1. A [business logic PORO](https://github.com/polypressure/outbacker/blob/master/examples/app/domain/appointment_calendar.rb) that uses Outbacker.
+1. A [controller test using OutbackerStub](https://github.com/polypressure/outbacker/blob/master/examples/test/controllers/appointments_controller_test.rb) to "stub" outcomes.
+1. The Outbacker [gem initializer file](https://github.com/polypressure/outbacker/blob/master/examples/config/initializers/outbacker.rb), to configure your policy specifying where the Outbacker module can be included.
+
+If you need more details, you can go back to the main [ README](https://github.com/polypressure/outbacker/blob/master/README.md) file.

data/examples/app/controllers/appointments_controller.rb

@@ -1,14 +1,11 @@
 #
-# Start here, then look at:
-#  * examples/app/domain/appointment_calendar.rb
-#  * examples/app/config/outbacker.rb
-#  * examples/test/controllers/appointments_controller_test.rb
-#  * examples/test/test_helper.rb
+# Conventional Rails controller, with the create method
+# implemented twice: before and after using Outbacker.
 #
 class AppointmentsController < ApplicationController
 
   #
-  # A conventional controller method:
+  # A conventional controller method, before using Outbacker:
   #
   def create
     @appointment = Appointment.new(appointment_params)

data/examples/app/domain/appointment_calendar.rb

@@ -8,7 +8,11 @@ class AppointmentCalendar
 
   #
   # Include the Outbacker module. See config/initializers/outbacker.rb
-  # for the restrictions on where you can include this.
+  # for the restrictions on where you can include this. By default,
+  # if you try to include Outbacker in an ActiveRecord or ActionController
+  # subclass, an exception will be raised.
+  #
+  # This helps to ensure both your models (and controllers) are skinny.
   #
   include Outbacker
 

data/examples/config/initializers/outbacker.rb

@@ -1,4 +1,8 @@
 
+#
+# Gem initializer file, within a rails app this file would
+# go in config/initializrs.
+#
 #
 # Specify where the Outbacker module cannot be included.
 # If you try to include Outbacker within subclasses of

data/examples/test/controllers/appointments_controller_test.rb

@@ -6,6 +6,12 @@ require 'outbacker'
 require 'test_support/outbacker_stub'
 
 
+#
+# A controller test for the AppointmentsController.
+# This shows how to use Outbacker::OutbackerStub to "stub"
+# outcomes, since standard mocking/stubbing libraries
+# can't provide this.
+#
 class AppointmentsControllerTest < ActionController::TestCase
 
 

data/lib/outbacker/version.rb

@@ -1,3 +1,3 @@
 module Outbacker
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outbacker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Anthony Garcia
@@ -125,6 +125,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/README.md
 - examples/app/controllers/appointments_controller.rb
 - examples/app/domain/appointment_calendar.rb
 - examples/config/initializers/outbacker.rb