decent_exposure 1.0.0.rc3 → 1.0.0

data/lib/decent_exposure/default_exposure.rb

@@ -2,7 +2,11 @@ module DecentExposure
   module DefaultExposure
     def self.included(klass)
       klass.extend(DecentExposure)
-      klass.superclass_delegating_accessor(:_default_exposure)
+      if klass.respond_to?(:class_attribute)
+        klass.class_attribute(:_default_exposure)
+      else
+        klass.superclass_delegating_accessor(:_default_exposure)
+      end
       klass.default_exposure do |name|
         collection = name.to_s.pluralize
         if respond_to?(collection) && collection != name.to_s && send(collection).respond_to?(:scoped)

data/lib/decent_exposure/version.rb

@@ -0,0 +1,3 @@
+module DecentExposure #:nodoc
+  VERSION = "1.0.0"
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: decent_exposure
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 1
   - 0
   - 0
-  - rc3
-  version: 1.0.0.rc3
+  version: 1.0.0
 platform: ruby
 authors: 
 - Stephen Caudill
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-21 00:00:00 -05:00
+date: 2011-01-04 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,13 +24,13 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
-        - 1
+        - 2
         - 3
         - 0
-        version: 1.3.0
+        version: 2.3.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -40,7 +39,7 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         segments: 
         - 0
@@ -62,27 +61,34 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
-description: "\n      DecentExposure helps you program to an interface, rather than an implementation\n      in your Rails controllers.  The fact of the matter is that sharing state\n      via instance variables in controllers promotes close coupling with views.\n      DecentExposure gives you a declarative manner of exposing an interface to the\n      state that controllers contain and thereby decreasing coupling and\n      improving your testability and overall design.\n    "
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: "\n    DecentExposure helps you program to an interface, rather than an\n    implementation in your Rails controllers.  The fact of the matter is that\n    sharing state via instance variables in controllers promotes close coupling\n    with views.  DecentExposure gives you a declarative manner of exposing an\n    interface to the state that controllers contain and thereby decreasing\n    coupling and improving your testability and overall design.\n  "
 email: scaudill@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.html
-- README.md
+extra_rdoc_files: []
+
 files: 
-- COPYING
-- README.md
-- VERSION
-- lib/decent_exposure.rb
 - lib/decent_exposure/default_exposure.rb
 - lib/decent_exposure/railtie.rb
-- rails/init.rb
-- README.html
-- spec/helper.rb
-- spec/lib/decent_exposure_spec.rb
-- spec/lib/rails_integration_spec.rb
+- lib/decent_exposure/version.rb
+- lib/decent_exposure.rb
+- README.md
+- COPYING
 has_rdoc: true
 homepage: http://github.com/voxdolo/decent_exposure
 licenses: []
@@ -103,13 +109,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
       - 1
       - 3
-      - 1
-      version: 1.3.1
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
@@ -117,7 +123,5 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A helper for creating declarative interfaces in controllers
-test_files: 
-- spec/helper.rb
-- spec/lib/decent_exposure_spec.rb
-- spec/lib/rails_integration_spec.rb
+test_files: []
+

data/README.html

@@ -1,119 +0,0 @@
-<html>
-  <head>
-    <style type='text/css'>
-      body{ width:50em; }
-      pre{ margin-left:2em; }
-    </style>
-  </head>
-  <body>
-<h1 id='decentexposure'>DecentExposure</h1>
-
-<p>DecentExposure helps you program to an interface, rather than an implementation in your Rails controllers.</p>
-
-<p>Sharing state via instance variables in controllers promotes close coupling with views. DecentExposure gives you a declarative manner of exposing an interface to the state that controllers contain, thereby decreasing coupling and improving your testability and overall design.</p>
-
-<h2 id='installation'>Installation</h2>
-
-<pre><code>gem install decent_exposure</code></pre>
-
-<p>Configure your Rails 2.X application to use it:</p>
-
-<p>In <code>config/environment.rb</code>:</p>
-
-<pre><code>config.gem &#39;decent_exposure&#39;</code></pre>
-
-<p>When used in Rails 3:</p>
-
-<p>In <code>Gemfile</code>:</p>
-
-<pre><code>gem &#39;decent_exposure&#39;</code></pre>
-
-<h2 id='examples'>Examples</h2>
-
-<h3 id='a_full_example'>A full example</h3>
-
-<p>The wiki has a full example of <a href='http://github.com/voxdolo/decent_exposure/wiki/Examples'>converting a classic-style Rails controller</a>.</p>
-
-<h3 id='in_your_controllers'>In your controllers</h3>
-
-<p>When no block is given, <code>expose</code> attempts to determine which resource you want to acquire. When <code>params</code> contains <code>:category_id</code> or <code>:id</code>, a call to:</p>
-
-<pre><code>expose(:category)</code></pre>
-
-<p>Would result in the following <code>ActiveRecord#find</code>:</p>
-
-<pre><code>Category.find(params[:category_id]||params[:id])</code></pre>
-
-<p>As the example shows, the symbol passed is used to guess the class name of the object (and potentially the <code>params</code> key to find it with) you want an instance of.</p>
-
-<p>Should <code>params</code> not contain an identifiable <code>id</code>, a call to:</p>
-
-<pre><code>expose(:category)</code></pre>
-
-<p>Will instead attempt to build a new instance of the object like so:</p>
-
-<pre><code>Category.new(params[:category])</code></pre>
-
-<p>If you define a collection with a pluralized name of the singular resource, <code>decent_exposure</code> will attempt to use it to scope its calls from. Let&#8217;s take the following scenario:</p>
-
-<pre><code>class ProductsController &lt; ApplicationController
-  expose(:category)
-  expose(:products) { category.products }
-  expose(:product)
-end</code></pre>
-
-<p>The <code>product</code> resource would scope from the <code>products</code> collection via a fully-expanded query equivalent to this:</p>
-
-<pre><code>Category.find(params[:category_id]).products.find(params[:id])</code></pre>
-
-<p>or (depending on the contents of the <code>params</code> hash) this:</p>
-
-<pre><code>Category.find(params[:category_id]).products.new(params[:product])</code></pre>
-
-<p>In the straightforward case, the three exposed resources above provide for access to both the primary and ancestor resources in a way usable across all 7 actions in a typicall Rails-style RESTful controller.</p>
-
-<h4 id='a_note_on_style'>A Note on Style</h4>
-
-<p>When the code has become complex enough to surpass a single line (and is not appropriate to extract into a model method), use the <code>do...end</code> style of block:</p>
-
-<pre><code>expose(:associated_products) do
-  product.associated.tap do |associated_products|
-    present(associated_products, :with =&gt; AssociatedProductPresenter)
-  end
-end</code></pre>
-
-<h3 id='in_your_views'>In your views</h3>
-
-<p>Use the product of those assignments like you would an instance variable or any other method you might normally have access to:</p>
-
-<pre><code>= render bread_crumbs_for(category)
-%h3#product_title= product.title
-= render product
-%h3 Associated Products
-%ul
-  - associated_products.each do |associated_product|
-  %li= link_to(associated_product.title,product_path(associated_product))</code></pre>
-
-<h3 id='custom_defaults'>Custom defaults</h3>
-
-<p>DecentExposure provides opinionated default logic when <code>expose</code> is invoked without a block. It&#8217;s possible, however, to override this with custom default logic by passing a block accepting a single argument to the <code>default_exposure</code> method inside of a controller. The argument will be the string or symbol passed in to the <code>expose</code> call.</p>
-
-<pre><code>class MyController &lt; ApplicationController
-  default_exposure do |name|
-    ObjectCache.load(name.to_s)
-  end
-end</code></pre>
-
-<p>The given block will be invoked in the context of a controller instance. It is possible to provide a custom default for a descendant class without disturbing its ancestor classes in an inheritance heirachy.</p>
-
-<h2 id='beware'>Beware</h2>
-
-<p>This is a simple tool, which provides a solitary solution. It must be used in conjunction with solid design approaches (&#8220;Program to an interface, not an implementation.&#8221;) and accepted best practices (e.g. Fat Model, Skinny Controller). In itself, it won&#8217;t heal a bad design. It is meant only to be a tool to use in improving the overall design of a Ruby on Rails system and moreover to provide a standard implementation for an emerging best practice.</p>
-
-<h2 id='development'>Development</h2>
-
-<h3 id='running_specs'>Running specs</h3>
-
-<p><code>DecentExposure</code> has been developed with the philosophy that Ruby developers shouldn&#8217;t force their choice in RubyGems package managers on people consuming their code. As a side effect of that, if you attempt to run the specs on this application, you might get <code>no such file to load</code> errors. The short answer is that you can <code>export RUBYOPT=&#39;rubygems&#39;</code> and be on about your way (for the long answer, see Ryan Tomayko&#8217;s <a href='http://tomayko.com/writings/require-rubygems-antipattern'>excellent treatise</a> on the subject).</p>
-  </body>
-</html>

data/VERSION

@@ -1 +0,0 @@
-1.0.0.rc3

data/rails/init.rb

@@ -1 +0,0 @@
-Kernel.load File.join(File.dirname(__FILE__), '..', 'init.rb')

data/spec/helper.rb

@@ -1,2 +0,0 @@
-require 'mocha'
-require File.join(File.dirname(__FILE__), '..', 'lib', 'decent_exposure')

data/spec/lib/decent_exposure_spec.rb

@@ -1,79 +0,0 @@
-require 'helper'
-
-describe DecentExposure do
-
-  class Controller
-    extend DecentExposure
-    def self.helper_method(*args); end
-    def self.hide_action(*args); end
-    def memoizable(arg); arg; end
-  end
-
-  context 'classes extending DecentExposure' do
-    subject { Controller }
-    specify { should respond_to(:expose) }
-    specify { should respond_to(:default_exposure) }
-  end
-
-  context '.expose' do
-    let(:controller) { Class.new(Controller){ expose(:resource) } }
-    let(:instance) { controller.new }
-
-    it 'creates a method with the given name' do
-      instance.should respond_to(:resource)
-    end
-
-    it 'prevents the method from being a callable action' do
-      controller.expects(:hide_action).with(:resources)
-      controller.class_eval { expose(:resources) }
-    end
-
-    it 'declares the method as a helper method' do
-      controller.expects(:helper_method).with(:resources)
-      controller.class_eval { expose(:resources) }
-    end
-
-    context 'custom exposures' do
-      before do
-        controller.class_eval do
-          expose(:resource) { memoizable("I'm a resource!") }
-        end
-      end
-
-      it 'returns the result of the exposed block from the method' do
-        instance.resource.should == "I'm a resource!"
-      end
-
-      it 'memoizes the value of the created method' do
-        instance.expects(:memoizable).once.returns('value')
-        2.times { instance.resource }
-      end
-    end
-
-    context '.default_exposure' do
-      let(:defaulted_controller) { Class.new(Controller) }
-      let(:instance) { defaulted_controller.new }
-      context 'when the default_exposure is overridden' do
-        before do
-          defaulted_controller.class_eval do
-            default_exposure { 'default value' }
-            expose(:default)
-          end
-        end
-        it 'uses the overridden default_exposure' do
-          instance.default.should == 'default value'
-        end
-      end
-
-      context 'with named arguments' do
-        it 'makes the named arguments available' do
-          defaulted_controller.class_eval do
-            default_exposure {|name| "I got: '#{name}'"}
-            expose :default
-          end
-          instance.default.should == "I got: 'default'"
-        end
-      end
-    end
-  end
-end

data/spec/lib/rails_integration_spec.rb

@@ -1,155 +0,0 @@
-require 'helper'
-require 'action_controller'
-require 'decent_exposure/railtie'
-DecentExposure::Railtie.insert
-
-class Resource
-  def self.scoped(opts); self; end
-  def self.find(*args); end
-  def initialize(*args); end
-end
-
-class Equipment
-  def self.scoped(opts); self; end
-  def self.find(*args); end
-  def initialize(*args); end
-end
-
-describe "Rails' integration:", DecentExposure do
-  let(:controller) { Class.new(ActionController::Base) }
-  let(:instance) { controller.new }
-  let(:request) { mock(:get? => true) }
-  let(:params) { HashWithIndifferentAccess.new(:resource_id => 42) }
-
-  before do
-    controller.expose(:resource)
-    instance.stubs(:request).returns(request)
-  end
-
-  context '.expose' do
-    it 'is available to ActionController::Base' do
-      ActionController::Base.should respond_to(:expose)
-    end
-  end
-
-  context 'within descendant controllers' do
-    let(:resource_controller) { Class.new(ActionController::Base) }
-    let(:instance) { resource_controller.new }
-
-    before do
-      instance.stubs(:request).returns(request)
-      instance.stubs(:params).returns(params)
-      resource_controller.expose :resource
-    end
-
-    it 'inherits the default_exposure' do
-      Resource.stubs(:find).returns('resource')
-      instance.resource.should == 'resource'
-    end
-
-    it 'allows you to override the default_exposure' do
-      resource_controller.class_eval do
-        default_exposure {|name| name.to_s}
-        expose :overridden
-      end
-      instance.overridden.should == 'overridden'
-    end
-
-    it 'does not override the default in ancestors' do
-      Resource.stubs(:find).returns('preserved')
-      instance.resource.should == 'preserved'
-    end
-  end
-
-  context '.default_exposure' do
-    before do
-      instance.stubs(:params).returns(params)
-    end
-
-    it 'is available to ActionController::Base' do
-      ActionController::Base.should respond_to(:default_exposure)
-    end
-
-    context 'when no collection method exists' do
-      it 'operates directly on the class' do
-        Resource.should_receive(:find)
-        instance.resource
-      end
-    end
-
-    context 'when a collection method exists' do
-      let(:controller){ Class.new(ActionController::Base) }
-      let(:instance){ controller.new }
-
-      before { class Person < Resource; end }
-
-      context 'and the collection can be scoped' do
-        let(:collection){ mock(:scoped => [self]) }
-
-        before{ controller.expose(:person) }
-
-        it 'uses the existing collection method' do
-          instance.stubs(:people).returns(collection)
-          collection.expects(:new)
-          instance.person
-        end
-      end
-      context 'when the collection can not be scoped' do
-        let(:collection){ mock }
-
-        before{ controller.expose(:person) }
-
-        it 'falls back to the singularized constant' do
-          instance.stubs(:people).returns(collection)
-          Person.expects(:new)
-          instance.person
-        end
-      end
-    end
-
-    context 'when either :resource_id or :id are present in params' do
-      it "calls find with params[:resource_id] on the resource's class" do
-        Resource.expects(:find).with(42)
-        instance.resource
-      end
-
-      context 'when there is no :resource_id in params' do
-        before { instance.stubs(:params).returns({:id => 73}) }
-
-        it "calls find with params[:id] on the resource's class" do
-          Resource.expects(:find).with(73)
-          instance.resource
-        end
-      end
-    end
-    context 'when there are no ids in params' do
-      before do
-        instance.stubs(:params).returns({:resource => {:name => 'bob'}})
-      end
-
-      it 'calls new with params[:resouce_name]' do
-        Resource.expects(:new).with({:name => 'bob'})
-        instance.resource
-      end
-    end
-  end
-end
-describe "Rails' integration:", DecentExposure do
-  let(:controller) { Class.new(ActionController::Base) }
-  let(:instance) { controller.new }
-  let(:request) { mock(:get? => true) }
-  let(:params) { HashWithIndifferentAccess.new(:resource_id => 42) }
-
-  before do
-    controller.expose(:equipment)
-    instance.stubs(:request).returns(request)
-    instance.stubs(:params).returns(params)
-  end
-  context 'when collection name is same as resource name' do
-    it 'does not create a collection method' do
-      instance.equipment
-      instance.should respond_to(:equipment)
-      instance.should_not respond_to(:equipments)
-    end
-  end
-end