yoomee-decent_exposure 1.0.1

data/COPYING

@@ -0,0 +1,12 @@
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                    Version 2, December 2004
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed.
+
+            DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. You just DO WHAT THE FUCK YOU WANT TO. 
+

data/README.md

@@ -0,0 +1,163 @@
+`decent_exposure` helps you program to an interface, rather than an implementation in
+your Rails controllers.
+
+Sharing state via instance variables in controllers promotes close coupling with
+views. `decent_exposure` 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. I elaborate on this approach in [A Diatribe on
+Maintaining State][diatribe].
+
+Installation
+------------
+
+    gem install decent_exposure
+
+Configure your Rails 2.X application to use it:
+
+In `config/environment.rb`:
+
+    config.gem 'decent_exposure'
+
+When used in Rails 3:
+
+In `Gemfile`:
+
+    gem 'decent_exposure'
+
+
+Examples
+--------
+
+### Railscast
+
+Ryan Bates has a Railscasts episode covering `decent_exposure`. If you're just
+getting started or just enjoy screencasts (Ryan's are always great), you can
+check it out here: [Railscasts - Decent Exposure][railscast].
+
+### A full example
+
+The wiki has a full example of [converting a classic-style Rails
+controller][converting].
+
+### In your controllers
+
+When no block is given, `expose` attempts to determine which resource you want
+to acquire. When `params` contains `:category_id` or `:id`, a call to:
+
+    expose(:category)
+
+Would result in the following `ActiveRecord#find`:
+
+    Category.find(params[:category_id]||params[:id])
+
+As the example shows, the symbol passed is used to guess the class name of the
+object (and potentially the `params` key to find it with) you want an instance
+of.
+
+Should `params` not contain an identifiable `id`, a call to:
+
+    expose(:category)
+
+Will instead attempt to build a new instance of the object like so:
+
+    Category.new(params[:category])
+
+If you define a collection with a pluralized name of the singular resource,
+`decent_exposure` will attempt to use it to scope its calls from. Let's take the
+following scenario:
+
+    class ProductsController < ApplicationController
+      expose(:category)
+      expose(:products) { category.products }
+      expose(:product)
+    end
+
+The `product` resource would scope from the `products` collection via a
+fully-expanded query equivalent to this:
+
+    Category.find(params[:category_id]).products.find(params[:id])
+
+or (depending on the contents of the `params` hash) this:
+
+    Category.find(params[:category_id]).products.new(params[:product])
+
+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.
+
+#### A Note on Style
+
+When the code has become complex enough to surpass a single line (and is not
+appropriate to extract into a model method), use the `do...end` style of block:
+
+    expose(:associated_products) do
+      product.associated.tap do |associated_products|
+        present(associated_products, :with => AssociatedProductPresenter)
+      end
+    end
+
+### In your views
+
+Use the product of those assignments like you would an instance variable or any
+other method you might normally have access to:
+
+    = 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))
+
+### Custom defaults
+
+`decent_exposure` provides opinionated default logic when `expose` is invoked without
+a block. It's possible, however, to override this with custom default logic by
+passing a block accepting a single argument to the `default_exposure` method
+inside of a controller. The argument will be the string or symbol passed in to
+the `expose` call.
+
+    class MyController < ApplicationController
+      default_exposure do |name|
+        ObjectCache.load(name.to_s)
+      end
+    end
+
+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.
+
+Beware
+------
+
+This is a simple tool, which provides a solitary solution. It must be used in
+conjunction with solid design approaches ("Program to an interface, not an
+implementation.") and accepted best practices (e.g. Fat Model, Skinny
+Controller). In itself, it won'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.
+
+Development
+-----------
+
+### Running specs
+
+`decent_exposure` has been developed with the philosophy that Ruby developers shouldn'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 `no such file to load` errors.  The short answer is that you can
+`export RUBYOPT='rubygems'` and be on about your way (for the long answer, see
+Ryan Tomayko's [excellent treatise][treatise] on the subject).
+
+[treatise]: http://tomayko.com/writings/require-rubygems-antipattern
+[converting]: http://github.com/voxdolo/decent_exposure/wiki/Examples
+[diatribe]: http://blog.voxdolo.me/a-diatribe-on-maintaining-state.html
+[railscast]: http://railscasts.com/episodes/259-decent-exposure
+
+Contributors
+------------
+
+Thanks to everyone that's helped out with `decent_exposure`! You can see a full
+list here:
+
+<http://github.com/voxdolo/decent_exposure/contributors>

data/init.rb

@@ -0,0 +1,2 @@
+require 'decent_exposure/railtie'
+DecentExposure::Railtie.insert

data/lib/decent_exposure/default_exposure.rb

@@ -0,0 +1,30 @@
+module DecentExposure
+  module DefaultExposure
+    def self.included(klass)
+      klass.extend(DecentExposure)
+      if klass.respond_to?(:class_attribute)
+        klass.class_attribute(:_default_exposure)
+      else
+        klass.superclass_delegating_accessor(:_default_exposure)
+      end
+      if klass.respond_to?(:default_exposure)
+        klass.default_exposure do |name|
+          collection = name.to_s.pluralize
+          if respond_to?(collection) && collection != name.to_s && send(collection).respond_to?(:scoped)
+            proxy = send(collection)
+          else
+            proxy = name.to_s.classify.constantize
+          end
+
+          if id = params["#{name}_id"] || params[:id]
+            proxy.find(id).tap do |r|
+              r.attributes = params[name] unless request.get?
+            end
+          else
+            proxy.new(params[name])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decent_exposure/railtie.rb

@@ -0,0 +1,19 @@
+require 'decent_exposure/default_exposure'
+
+module DecentExposure
+  if defined? Rails::Railtie
+    class Railtie < Rails::Railtie
+      initializer "decent_exposure.extend_action_controller_base" do |app|
+        ActiveSupport.on_load(:action_controller) do
+          DecentExposure::Railtie.insert
+        end
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      ActionController::Base.send(:include, DecentExposure::DefaultExposure)
+    end
+  end
+end

data/lib/decent_exposure/version.rb

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

data/lib/decent_exposure.rb

@@ -0,0 +1,32 @@
+require 'decent_exposure/railtie'
+
+module DecentExposure
+  def inherited(klass)
+    closured_exposure = default_exposure
+    klass.class_eval do
+      default_exposure(&closured_exposure)
+    end
+    super
+  end
+
+  attr_accessor :_default_exposure
+
+  def default_exposure(&block)
+    self._default_exposure = block if block_given?
+    _default_exposure
+  end
+
+  def expose(name, &block)
+    closured_exposure = default_exposure
+    define_method name do
+      @_resources       ||= {}
+      @_resources[name] ||= if block_given?
+        instance_eval(&block)
+      else
+        instance_exec(name, &closured_exposure)
+      end
+    end
+    helper_method name
+    hide_action name
+  end
+end

data/rails/init.rb

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

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification 
+name: yoomee-decent_exposure
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 1
+  version: 1.0.1
+platform: ruby
+authors: 
+- Stephen Caudill
+- Jon Larkowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-14 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 0
+        - 9
+        - 12
+        version: 0.9.12
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ruby-debug19
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 63
+        segments: 
+        - 0
+        - 11
+        - 6
+        version: 0.11.6
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+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: []
+
+files: 
+- lib/decent_exposure/default_exposure.rb
+- lib/decent_exposure/railtie.rb
+- lib/decent_exposure/version.rb
+- lib/decent_exposure.rb
+- README.md
+- COPYING
+- init.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/voxdolo/decent_exposure
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: A helper for creating declarative interfaces in controllers
+test_files: []
+