Changeset 798

Timestamp:

10/30/07 21:27:37 (1 year ago)

Author:

iv..@gweezlebur.com

Message:

Move provides() et al to ResponderMixin?, and add serious documentation

Files:

• trunk/autotest/merbsource_rspec.rb (modified) (1 diff)
• trunk/lib/merb/controller.rb (modified) (1 diff)
• trunk/lib/merb/mixins/responder.rb (modified) (4 diffs)
• trunk/spec/merb/controller_spec.rb (modified) (1 diff)
• trunk/spec/merb/responder_spec.rb (modified) (1 diff)
• trunk/tools/allison/cache/BODY (modified) (3 diffs)
• trunk/tools/allison/cache/INDEX (modified) (1 diff)

trunk/autotest/merbsource_rspec.rb

@@ -20 +20 @@
-      },
-      %r%^lib/merb/(.*)\.rb$% => kernel.proc { |_, m| 
-1]}_spec.rb", "spec/merb/#{m[1
+0]}_spec.rb", "spec/merb/#{m[0
-      },
-      %r%^lib/merb\.rb$% => kernel.proc { 

trunk/lib/merb/controller.rb

@@ -48 +48 @@
-        cont
-      end
-    end
-    
-    
-    class_inheritable_accessor :class_provided_formats
-    self.class_provided_formats = [:html]
-
-    # set controller-level provides
-    def self.provides(*formats)
-      formats.each {|fmt|
-        self.class_provided_formats << fmt unless class_provided_formats.include?(fmt)
-      }
-    end
-    
-    def self.only_provides(*formats)
-      self.class_provided_formats = formats
-    end
-    
-    def self.does_not_provide(*formats)
-      self.class_provided_formats -= formats
-    end
-    
-    def provided_formats
-      @_provided_formats ||= class_provided_formats
-    end
-    
-    def provided_formats=(*formats)
-      raise "Cannot modify provided_formats because content_type has already been set" if content_type_set?
-      @_provided_formats = formats.flatten
-    end
-      
-    def provides(*formats)
-      formats.each {|fmt|
-        self.provided_formats += [fmt] unless provided_formats.include?(fmt)
-      }
-    end
-    
-    def only_provides(*formats)
-      self.provided_formats = formats.flatten
-    end
-    
-    def does_not_provide(*formats)
-      self.provided_formats -= formats.flatten
-    end
-    

trunk/lib/merb/mixins/responder.rb

@@ -8 +8 @@
-  end
-  
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-  def self.add_mime_type(key,transform_method, values,new_response_headers = {})
-    raise ArgumentError unless key.is_a?(Symbol) && values.is_a?(Array)
@@ -75 +66 @@
-    Merb.add_mime_type(:json,:to_json,%w[application/json  text/x-json  ])
-  end
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-  module ResponderMixin
-    
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-      raise Merb::ControllerExceptions::NotAcceptable if provided_formats.empty?
-      if fmt = params[:format]
@@ -109 +262 @@
-    end
-    
+    # Checks to see if content negotiation has already been performed.
+    # If it has, you can no longer modify the list of provided formats.
-    def content_type_set?
-      !@_content_type.nil?
-    end
-    
+    # Returns the output format for this request, based on the 
+    # provided formats, <tt>params[:format]</tt> and the client's HTTP
+    # Accept header.
+    #
+    # The first time this is called, it triggers content negotiation
+    # and caches the value.  Once you call +content_type+ you can
+    # not set or change the list of provided formats.
+    #
+    # Called automatically by +render+, so you should only call it if
+    # you need the value, not to trigger content negotiation. 
-    def content_type
-      unless content_type_set?
@@ -123 +288 @@
-    end
-    
+    # Sets the output content_type for this request.  Normally you
+    # should use +provides+, +does_not_provide+ and +only_provides+
+    # and then let the content negotiation process determine the proper
+    # content_type.  However, in some circumstances you may want to
+    # set it directly, or override what content negotiation picks.
-    def content_type=(new_type)
-      @_content_type = new_type

trunk/spec/merb/controller_spec.rb

@@ -13 +13 @@
-    c = new_controller
-    c._layout.should == :application
-  end
-end
-
-class FormattedBasic < Merb::Controller ; end
-class WithXml < Merb::Controller ; provides :xml ; end
-class XmlOnly < Merb::Controller ; only_provides :xml ; end
-class ProvidesNothing < Merb::Controller ; does_not_provide :html ; end
-class HtmlAgain < Merb::Controller ; provides :html ; end
-
-class ManyProvides < Merb::Controller
-  provides :html, :xml, :txt
-  def noextra ; end
-  def extra ; provides :json, :yaml ; end
-end
-
-describe "Merb::Controller", "provided formats (class)" do
-  it "should have the default class_provided_formats of [:html]" do
-    c = new_controller("index",FormattedBasic)
-    c.class_provided_formats.should == [:html]
-  end
-  
-  it "should add :xml to class_provided_formats when called with provides :xml" do
-    c = new_controller("index",WithXml)
-    c.class_provided_formats.should == [:html, :xml]
-  end
-
-  it "should only have :xml in class_provided_formats when called with only_provides :xml" do
-    c = new_controller("index",XmlOnly)
-    c.class_provided_formats.should == [:xml]
-  end
-  
-  it "should have an empty class_provided_formats when called with does_not_provide :html" do
-    c = new_controller("index",ProvidesNothing)
-    c.class_provided_formats.should == []
-  end
-
-  it "should only have :html in class_provided_formats when called with provides :html (after other controllers have set it)" do
-    c = new_controller("index",HtmlAgain)
-    c.class_provided_formats.should == [:html]
-  end
-    
-  it "should handle multiple provides added via class method" do
-    c = new_controller("noextra",ManyProvides)
-    c.provided_formats.should == [:html, :xml, :txt]
-  end
-end
-
-class ActionProvides < Merb::Controller
-  def basic ; end
-  def with_xml ; provides :xml ; end
-  def xml_only ; only_provides :xml ; end
-  def nothing ; does_not_provide :html ; end
-end
-
-describe "Merb::Controller", "provided formats (action)" do
-  it "should have the default provided_formats" do
-    c = new_controller("basic",ActionProvides)
-    c.basic
-    c.provided_formats.should == [:html]
-  end
-  
-  it "should add :xml to provided_formats when called with provides :xml" do
-    c = new_controller("with_xml",ActionProvides)
-    c.with_xml
-    c.provided_formats.should == [:html, :xml]
-  end
-  
-  it "should only have :xml in provided_formats when called with only_provides :xml" do
-    c = new_controller("xml_only",ActionProvides)
-    c.xml_only
-    c.provided_formats.should == [:xml]
-  end
-
-  it "should have an empty provided_formats when called with does_not_provide :html" do
-    c = new_controller("nothing",ActionProvides)
-    c.nothing
-    c.provided_formats.should be_empty
-  end
-end

trunk/spec/merb/responder_spec.rb

@@ -479 +479 @@
-  end
-end
+
+class FormattedBasic < Merb::Controller ; end
+class WithXml < Merb::Controller ; provides :xml ; end
+class XmlOnly < Merb::Controller ; only_provides :xml ; end
+class ProvidesNothing < Merb::Controller ; does_not_provide :html ; end
+class HtmlAgain < Merb::Controller ; provides :html ; end
+
+class ManyProvides < Merb::Controller
+  provides :html, :xml, :txt
+  def noextra ; end
+  def extra ; provides :json, :yaml ; end
+end
+
+describe "Responder", "managing provided formats (class)" do
+  it "should have the default class_provided_formats of [:html]" do
+    c = new_controller("index",FormattedBasic)
+    c.class_provided_formats.should == [:html]
+  end
+  
+  it "should add :xml to class_provided_formats when called with provides :xml" do
+    c = new_controller("index",WithXml)
+    c.class_provided_formats.should == [:html, :xml]
+  end
+
+  it "should only have :xml in class_provided_formats when called with only_provides :xml" do
+    c = new_controller("index",XmlOnly)
+    c.class_provided_formats.should == [:xml]
+  end
+  
+  it "should have an empty class_provided_formats when called with does_not_provide :html" do
+    c = new_controller("index",ProvidesNothing)
+    c.class_provided_formats.should == []
+  end
+
+  it "should only have :html in class_provided_formats when called with provides :html (after other controllers have set it)" do
+    c = new_controller("index",HtmlAgain)
+    c.class_provided_formats.should == [:html]
+  end
+    
+  it "should handle multiple provides added via class method" do
+    c = new_controller("noextra",ManyProvides)
+    c.provided_formats.should == [:html, :xml, :txt]
+  end
+end
+
+class ActionProvides < Merb::Controller
+  def basic ; end
+  def with_xml ; provides :xml ; end
+  def xml_only ; only_provides :xml ; end
+  def nothing ; does_not_provide :html ; end
+end
+
+describe "Responder", "managing provided formats (action)" do
+  it "should have the default provided_formats" do
+    c = new_controller("basic",ActionProvides)
+    c.basic
+    c.provided_formats.should == [:html]
+  end
+  
+  it "should add :xml to provided_formats when called with provides :xml" do
+    c = new_controller("with_xml",ActionProvides)
+    c.with_xml
+    c.provided_formats.should == [:html, :xml]
+  end
+  
+  it "should only have :xml in provided_formats when called with only_provides :xml" do
+    c = new_controller("xml_only",ActionProvides)
+    c.xml_only
+    c.provided_formats.should == [:xml]
+  end
+
+  it "should have an empty provided_formats when called with does_not_provide :html" do
+    c = new_controller("nothing",ActionProvides)
+    c.nothing
+    c.provided_formats.should be_empty
+  end
+end
+

trunk/tools/allison/cache/BODY

@@ -1 @@
-:lang="en" xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/><title>%title%</title><link type="text/css" rel="stylesheet" media="screen" href="%style_url%
+ns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/><title>%title%</title><link type="text/css" href="%style_url%" rel="stylesheet" media="screen
-// Javascript for Allison RDoc template
-// Copyright 2006 Cloudburst LLC
@@ -402 +402 @@
-</div>
-ENDIF:methods
-onclick="toggle('class'); toggleText('class_link'); return false;" href="#" id="class_link">Hide...</a></div><div class="clear"></div><div id="class"><form><label for="filter_class">Filter:&nbsp;&nbsp;</label><input type="text" onKeyUp="return filterList('class', this.value, event);" onKeyPress="return disableSubmit(event);" id="filter_class"></input></form></div></div><div class="navigation dark index" id="file_wrapper"><div class="list_header"><h3>All files</h3></div><div class="list_header_link"><a onclick="toggle('file'); toggleText('file_link'); return false;" href="#" id="file_link">Hide...</a></div><div class="clear"></div><div id="file"><form><label for="filter_file">Filter:&nbsp;&nbsp;</label><input type="text" onKeyUp="return filterList('file', this.value, event);" onKeyPress="return disableSubmit(event);" id="filter_file"></input></form></div></div><div class="navigation dark index" id="method_wrapper"><div class="list_header"><h3>All methods</h3></div><div class="list_header_link"><a onclick="toggle('method'); toggleText('method_link'); return false;" href="#" id="method_link">Show...</a></div><div class="clear"></div><div id="method"><form><label for="filter_method">Filter:&nbsp;&nbsp;</label><input type="text" onKeyUp="return filterList('method', this.value, event);" onKeyPress="return disableSubmit(event);" id="filter_method
+href="#" onclick="toggle('class'); toggleText('class_link'); return false;" id="class_link">Hide...</a></div><div class="clear"></div><div id="class"><form><label for="filter_class">Filter:&nbsp;&nbsp;</label><input type="text" onKeyPress="return disableSubmit(event);" id="filter_class" onKeyUp="return filterList('class', this.value, event);"></input></form></div></div><div class="navigation dark index" id="file_wrapper"><div class="list_header"><h3>All files</h3></div><div class="list_header_link"><a href="#" onclick="toggle('file'); toggleText('file_link'); return false;" id="file_link">Hide...</a></div><div class="clear"></div><div id="file"><form><label for="filter_file">Filter:&nbsp;&nbsp;</label><input type="text" onKeyPress="return disableSubmit(event);" id="filter_file" onKeyUp="return filterList('file', this.value, event);"></input></form></div></div><div class="navigation dark index" id="method_wrapper"><div class="list_header"><h3>All methods</h3></div><div class="list_header_link"><a href="#" onclick="toggle('method'); toggleText('method_link'); return false;" id="method_link">Show...</a></div><div class="clear"></div><div id="method"><form><label for="filter_method">Filter:&nbsp;&nbsp;</label><input type="text" onKeyPress="return disableSubmit(event);" id="filter_method" onKeyUp="return filterList('method', this.value, event);
-IF:title
-<h1 id="item_name">%title%</h1>
@@ -572 +572 @@
-
-IF:sourcecode
-onclick="toggle('%aref%-source'); toggleText('%aref%-link'); return false;" href="#
+href="#" onclick="toggle('%aref%-source'); toggleText('%aref%-link'); return false;
-ENDIF:sourcecode
-</div></div>

trunk/tools/allison/cache/INDEX

@@ -1 @@
-:lang="en" xmlns="http://www.w3.org/1999/xhtml" lang="en"><head><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/><title>%title%</title><link type="text/css" rel="stylesheet" media="screen" href="rdoc-style.css
+ns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/><title>%title%</title><link type="text/css" href="rdoc-style.css" rel="stylesheet" media="screen