proffer 0.9.0

data/LICENSE.txt

@@ -0,0 +1,9 @@
+Copyright (c) 2012, James Hunt & Paul Mucur
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/README.md

@@ -0,0 +1,71 @@
+Proffer [![Build Status](https://secure.travis-ci.org/hudge/proffer.png?branch=master)](http://travis-ci.org/hudge/proffer)
+=======
+
+A module to stop Action Controller from copying every instance variable available
+to an action to the view by default. Instead, Proffer provides a way to explicitly
+expose values as local variables within views.
+
+Rationale
+---------
+
+By default, Action Controller will make any instance variables present during an
+action available to its views (including partials). This effectively makes them
+global variables and can obscure their origin when maintaining views. Partials
+that exploit this behaviour can be particularly difficult to maintain as they
+may inherit state from their caller implicitly.
+
+We want to see if removing this default behaviour changes the way views are
+written. By forcing explicit declaration of dependencies, will better, more
+encapsulated design result?
+
+Usage
+-----
+
+Add the following to your `Gemfile`:
+
+```ruby
+gem 'proffer'
+```
+
+Include the `Proffer` module into any controllers you wish (include into
+`ApplicationController` to enforce this behaviour throughout your application):
+
+```ruby
+class PostsController < ApplicationController
+  include Proffer
+
+  # This will make a new Post object available as post in the view but
+  # @heading will be nil.
+  def new
+    @heading = "New Post"
+    proffer :post => Post.new
+  end
+end
+```
+
+Any proffered values will then be available to your views by their key:
+
+```erb
+<%= form_for(post) do |f| %>
+  ...
+<% end %>
+```
+
+Compatibility
+-------------
+
+As we rely on `ActionController#view_assigns`, this will only work with versions
+of Rails 3.0 or later. It is currently tested against Rails 3.2.
+
+Disclaimer
+----------
+
+We have not yet tried this in production so proceed with caution. This gem
+overrides `ActionController#view_assigns` and extends `ActionController#render`,
+so it may be incompatible with other gems that override these methods.
+
+License
+-------
+
+See LICENSE.txt
+

data/Rakefile

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :test => :spec
+task :default => :spec
+

data/lib/proffer.rb

@@ -0,0 +1,54 @@
+# Public: Stops an Action Controller from automatically passing all instance
+# variables to the view. Instead, variables must be explicitly defined by
+# using proffer.
+#
+# Examples
+#
+#   class PostsController < ApplicationController
+#     include Proffer
+#
+#     # This will make a new Post object available as post in the view but
+#     # @heading will be nil.
+#     def new
+#       @heading = "New Post"
+#       proffer :post => Post.new
+#     end
+#   end
+module Proffer
+
+  # Public: Make the given values available to the view as local variables.
+  #
+  # variables - The Hash of values keyed by the local variable name to be used
+  #             in the view.
+  #
+  # Examples
+  #
+  #   proffer :model => Model.new
+  #   # => render ..., :locals => { :model => Model.new }
+  #
+  # Returns nothing.
+  def proffer(variables)
+    @_proffered_variables ||= {}
+    @_proffered_variables.merge!(variables)
+  end
+
+  # Internal: Override Action Controller's render method to convert proffered
+  # variables to locals.
+  def render(*args, &blk)
+    if @_proffered_variables
+      options = args.extract_options!
+      options[:locals] ||= {}
+      options[:locals] = @_proffered_variables.merge(options[:locals])
+      args << options
+    end
+
+    super(*args, &blk)
+  end
+
+  # Internal: Override Action Controller's view_assigns to no longer copy
+  # instance variables into the view.
+  def view_assigns
+    {}
+  end
+end
+

data/spec/fixtures/proffer_test/index.html.erb

@@ -0,0 +1,3 @@
+<%= @foo %>
+<%= my_nice_variable %>
+

data/spec/fixtures/proffer_test/index.xml.builder

@@ -0,0 +1,5 @@
+xml.root do
+  xml.foo @foo
+  xml.my_nice_variable my_nice_variable
+end
+

data/spec/proffer_integration_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper_rails'
+
+class ApplicationController < ActionController::Base
+  include Proffer
+end
+
+class ProfferTestController < ApplicationController
+  self.view_paths = [File.expand_path('../fixtures', __FILE__)]
+
+  def index
+    @foo = "Not passed through"
+    proffer :my_nice_variable => "Woooo"
+  end
+end
+
+TestApplication.routes.draw do
+  match "/foo" => "proffer_test#index"
+end
+
+describe ProfferTestController, :type => :controller do
+  render_views
+
+  describe "#index" do
+    describe "as html" do
+      it "won't pass instance variables to the view by default" do
+        get :index
+        response.body.should_not =~ /Not passed through/
+      end
+
+      it "will pass proffered variables to the view" do
+        get :index
+        response.body.should =~ /Woooo/
+      end
+    end
+
+    describe "as xml" do
+      it "won't pass instance variables to the view by default" do
+        get :index, :format => :xml
+        response.body.should_not =~ /Not passed through/
+      end
+
+      it "will pass proffered variables to the view" do
+        get :index, :format => :xml
+        response.body.should =~ /Woooo/
+      end
+    end
+  end
+end

data/spec/proffer_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+class FakeController < BaseController
+  include Proffer
+
+  def index
+    proffer :foo => "bar", :baz => "quux"
+    render :index
+  end
+
+  def no_proffering
+    render :no_proffering
+  end
+
+  def proffering_with_locals(locals)
+    proffer :foo => "bar"
+    render :proffering, :locals => locals
+  end
+
+  def multiple_proffer
+    proffer :foo => "bar"
+    proffer :baz => "quux"
+    render :multiple_proffer
+  end
+end
+
+describe Proffer do
+  let(:controller) { FakeController.new }
+
+  it "sets view_assigns to an empty hash" do
+    controller.view_assigns.should == {}
+  end
+
+  describe "#proffer" do
+    it "assigns the proffered variables to the view as locals" do
+      controller.index
+      controller.args_for_render.should == [:index, { :locals => { :foo => "bar", :baz => "quux" } }]
+    end
+
+    it "doesn't add a locals option to the view if nothing is proffered" do
+      controller.no_proffering
+      controller.args_for_render.should == [:no_proffering]
+    end
+
+    it "doesn't override explicitly provided locals" do
+      controller.proffering_with_locals(:baz => "quux")
+      controller.args_for_render.should == [:proffering, { :locals => { :baz => "quux", :foo => "bar" } }]
+    end
+
+    it "prefers the explicit locals over the proffered variables if they have the same name" do
+      controller.proffering_with_locals(:foo => "new value")
+      controller.args_for_render.should == [:proffering, { :locals => { :foo => "new value" } }]
+    end
+
+    it "allows multiple calls to proffer" do
+      controller.multiple_proffer
+      controller.args_for_render.should == [:multiple_proffer, { :locals => { :foo => "bar", :baz => "quux" } }]
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'proffer'
+
+# To avoid requiring Active Support during testing.
+class Array
+  def extract_options!
+    if last.is_a?(Hash)
+      pop
+    else
+      {}
+    end
+  end
+end
+
+class BaseController
+  attr_reader :args_for_render
+
+  def render(*args)
+    @args_for_render = args
+  end
+
+  def view_assigns
+    {:stuff => :not_needed}
+  end
+end
+

data/spec/spec_helper_rails.rb

@@ -0,0 +1,12 @@
+require 'proffer'
+
+require 'action_controller/railtie'
+require 'rails/test_unit/railtie'
+
+class TestApplication < Rails::Application
+  config.active_support.deprecation = :stderr
+end
+TestApplication.initialize!
+
+require 'rspec/rails'
+

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: proffer
+version: !ruby/object:Gem::Version 
+  hash: 59
+  prerelease: 
+  segments: 
+  - 0
+  - 9
+  - 0
+  version: 0.9.0
+platform: ruby
+authors: 
+- James Hunt
+- Paul Mucur
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-31 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: A module to stop Action Controller from copying every instance variable available to an action to the view by default. Instead, Proffer provides a way to explicitly expose values as local variables within views.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/proffer.rb
+- Rakefile
+- README.md
+- LICENSE.txt
+- spec/spec_helper.rb
+- spec/spec_helper_rails.rb
+- spec/proffer_spec.rb
+- spec/proffer_integration_spec.rb
+- spec/fixtures/proffer_test/index.html.erb
+- spec/fixtures/proffer_test/index.xml.builder
+has_rdoc: true
+homepage: http://github.com/hudge/proffer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: An Action Controller module to hide instance variables from views by default.
+test_files: 
+- spec/spec_helper.rb
+- spec/spec_helper_rails.rb
+- spec/proffer_spec.rb
+- spec/proffer_integration_spec.rb
+- spec/fixtures/proffer_test/index.html.erb
+- spec/fixtures/proffer_test/index.xml.builder