presenter-pattern 0.2.1 → 0.3.0

data/Manifest

@@ -4,8 +4,8 @@ lib/presenter-pattern.rb
 lib/presenter-pattern/railtie.rb
 presenter-pattern.gemspec
 rails/init.rb
-test/no_querying_view_test.rb
-test/only_data_in_view_test.rb
+test/bad_controller_test.rb
+test/foos_controller_test.rb
 test/setup_test.rb
 test/test_helper.rb
 Manifest

data/Rakefile

@@ -2,12 +2,12 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('presenter-pattern', '0.2.1') do |p|
+Echoe.new('presenter-pattern', '0.3.0') do |p|
   p.description   = "Enables and enforces the presenter pattern in rails"
   p.url           = "https://github.com/jleven/presenter-pattern"
   p.author        = "Josh Leven"
   p.email         = "josh.leven@gmail.com"
-  p.ignore_pattern = /^(tmp|pkg|doc|test\/rails_app)|(\.svn|CVS|\.bzr|\.DS|\.git)$/
+  p.ignore_pattern = /^(tmp|pkg|doc|test\/rails_app|Gemfile)|(\.svn|CVS|\.bzr|\.DS|\.git)$/
   p.development_dependencies = []
 end
 

data/lib/presenter-pattern.rb

@@ -1,9 +1,70 @@
 require 'presenter-pattern/railtie'
 
+
+# PresenterPattern::API enables and enforces very simple api controllers.
+# Essentially, your controller has the settings:
+#    layout nil
+#    responds_to *formats    <--- formats is specified in step 1 below
+#
+# and each action ends with an implicit:
+#    responds_with <return_value_from_action>
+#
+#
+# 1. In your controller, include PresenterPattern::API, passing in the formats your api
+#    will support using the bracket operator (defaults to :xml and :json)
+#
+#    e.g.    include PresenterPattern::API[:html, :json]
+#
+# 2. Each action must return the data you wish for your api to return.
+#    Do NOT call render from within your actions.
+#
+
+
 module PresenterPattern
-  def protected_instance_variables
-    return instance_variable_names - ["@data"] if respond_to?(:instance_variable_names)
-    super
+  module API
+    class NoExplicitRender < RuntimeError; end
+
+    def self.[](*formats)
+      custom_api = self.dup
+      custom_api.class_eval do
+        define_singleton_method :included do |host_class|
+          host_class.layout nil
+          host_class.respond_to *formats
+        end
+      end
+      custom_api
+    end
+    
+    def self.included(host_class)
+      host_class.layout nil
+      host_class.respond_to :xml, :json
+    end
+
+    # enforces simple api response
+    #
+    # each action must return the data meant for their response
+    # 
+    # - overwrites ActionController::Metal::ImplicitRender
+    def send_action(method_name, *args)
+      #call the action, and store return value
+      @__rval = self.send(method_name, *args)
+
+      #fail if action calls 'render'
+      raise NoExplicitRender, "Controllers implementing the PresenterPattern::API must not call any render methods" if response_body
+
+      #always follow responder pattern passing in the action's return value
+      respond_with @__rval, (@respond_with_opts || {})
+    end
+
+    def respond_opts(options)
+      @respond_with_opts ||= {}
+      @respond_with_opts.merge! options
+    end
+
+    #only the @__rval variable (set in send_action) is passed through to the view
+    def view_assigns
+      {"data" => @__rval}
+    end
   end
 end
 

data/presenter-pattern.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{presenter-pattern}
-  s.version = "0.2.1"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Leven"]
@@ -10,14 +10,14 @@ Gem::Specification.new do |s|
   s.description = %q{Enables and enforces the presenter pattern in rails}
   s.email = %q{josh.leven@gmail.com}
   s.extra_rdoc_files = ["README.rdoc", "lib/presenter-pattern.rb", "lib/presenter-pattern/railtie.rb"]
-  s.files = ["README.rdoc", "Rakefile", "lib/presenter-pattern.rb", "lib/presenter-pattern/railtie.rb", "presenter-pattern.gemspec", "rails/init.rb", "test/no_querying_view_test.rb", "test/only_data_in_view_test.rb", "test/setup_test.rb", "test/test_helper.rb", "Manifest"]
+  s.files = ["README.rdoc", "Rakefile", "lib/presenter-pattern.rb", "lib/presenter-pattern/railtie.rb", "presenter-pattern.gemspec", "rails/init.rb", "test/bad_controller_test.rb", "test/foos_controller_test.rb", "test/setup_test.rb", "test/test_helper.rb", "Manifest"]
   s.homepage = %q{https://github.com/jleven/presenter-pattern}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Presenter-pattern", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{presenter-pattern}
   s.rubygems_version = %q{1.7.2}
   s.summary = %q{Enables and enforces the presenter pattern in rails}
-  s.test_files = ["test/no_querying_view_test.rb", "test/only_data_in_view_test.rb", "test/setup_test.rb", "test/test_helper.rb"]
+  s.test_files = ["test/bad_controller_test.rb", "test/foos_controller_test.rb", "test/setup_test.rb", "test/test_helper.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/test/bad_controller_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class BadControllerTest < ActionController::TestCase
+  tests BadController
+
+  def setup
+    super
+    @name = "Hello World!"
+    @foo = Foo.create :name => @name
+  end
+
+  def test_data_variable_in_view
+    get :good, :id => @foo.id
+    assert_response :success
+    assert_equal @name, @response.body
+  end
+
+  def test_only_data_variable_in_view
+    get :no_vars, :id => @foo.id
+    assert_equal "", @response.body
+  end
+
+  def test_empty_action
+    get :empty
+    assert_response :success
+  end
+
+  def test_query_in_view_fails
+    assert_raise(ActionView::Template::Error) do
+      get :query
+    end
+  end
+
+  def test_no_explicit_render
+    assert_raise(PresenterPattern::API::NoExplicitRender) do
+      get :explicit
+    end
+  end
+end

data/test/foos_controller_test.rb

@@ -0,0 +1,61 @@
+require 'test_helper'
+
+class FoosControllerTest < ActionController::TestCase
+  tests FoosController
+
+  def setup
+    super
+    @name = "Name"
+    @foo = Foo.create :name => @name
+  end
+
+  def test_index
+    get :index
+    assert_response :success
+    assert_equal @name, @response.body
+  end
+
+  def test_show
+    get :show, :id => @foo.id
+    assert_response :success
+    assert_equal @name, @response.body
+  end
+
+  def test_new
+    get :new
+    assert_response :success
+    assert_equal "", @response.body
+  end
+
+  def test_create_success
+    post :create, :foo => @foo.attributes, :format => :json
+    assert_response :success
+    assert_equal @foo.to_json, @response.body
+  end
+
+  def test_create_failure
+    post :create, :foo => {}, :format => :json
+    assert_response :unprocessable_entity
+    assert_equal "{\"name\":[\"can't be blank\"]}", @response.body
+  end
+
+  def test_create_failure_ajax
+    xhr :post, :create, :foo => {}, :format => :json
+    assert_response :unprocessable_entity
+    assert_equal "{\"name\":[\"can't be blank\"]}", @response.body
+  end
+
+  def test_respond_opts
+    get :edit, :id => @foo.id, :format => :json
+    assert_response 206
+    assert_equal @foo.to_json, @response.body
+  end
+
+  def test_destroy
+    assert_difference('Foo.count', -1) do
+      delete :destroy, :id => @foo.id, :format => :json
+    end
+    assert_response :success
+    assert_equal "{}", @response.body
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: presenter-pattern
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -26,8 +26,8 @@ files:
 - lib/presenter-pattern/railtie.rb
 - presenter-pattern.gemspec
 - rails/init.rb
-- test/no_querying_view_test.rb
-- test/only_data_in_view_test.rb
+- test/bad_controller_test.rb
+- test/foos_controller_test.rb
 - test/setup_test.rb
 - test/test_helper.rb
 - Manifest
@@ -62,7 +62,7 @@ signing_key:
 specification_version: 3
 summary: Enables and enforces the presenter pattern in rails
 test_files:
-- test/no_querying_view_test.rb
-- test/only_data_in_view_test.rb
+- test/bad_controller_test.rb
+- test/foos_controller_test.rb
 - test/setup_test.rb
 - test/test_helper.rb

data/test/no_querying_view_test.rb

@@ -1,22 +0,0 @@
-require 'test_helper'
-
-class NoQueryingViewTest < ActionController::TestCase
-  tests FoosController
-
-  def setup
-    super
-    @foo = Foo.create :name => "name"
-  end
-
-  def test_thin_views_are_successful
-    get :show, :id => @foo.id
-    assert_response :success
-  end
-
-  def test_thick_views_fail
-    assert_raise(ActionView::Template::Error) do
-      get :index
-    end
-  end
-
-end

data/test/only_data_in_view_test.rb

@@ -1,23 +0,0 @@
-require 'test_helper'
-
-class OnlyDataInViewTest < ActionController::TestCase
-  tests FoosController
-
-  def setup
-    super
-    @name = "Hello World!"
-    @foo = Foo.create :name => @name
-  end
-
-  def test_data_variable_in_view
-    get :show, :id => @foo.id
-    assert_response :success
-    assert_equal @name, @response.body
-  end
-
-  def test_only_data_variable_in_view
-    get :edit, :id => @foo.id
-    assert_equal "", @response.body
-  end
-
-end