RubyGems - mynyml-rack-respond_to - Versions diffs - 0.9 - Mend

mynyml-rack-respond_to 0.9

Files changed (10) hide show

data/LICENSE ADDED Viewed

@@ -0,0 +1,19 @@
+Copyright © 2009 Martin Aumont (mynyml)
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README ADDED Viewed

@@ -0,0 +1,48 @@
+SUMMARY
+Rack convenience middleware that allows triggering different actions based on
+requested format. Standalone version of the equivalent Rails functionality.
+INSTALLATION
+  sudo gem install mynyml-rack-respond_to --source=http://gems.github.com/
+USAGE
+  require 'rubygems'
+  require 'rack'
+  require 'rack/respond_to'
+  class App
+    include Rack::RespondTo
+    def call(env)
+      # simply pass in the env if another middleware already added
+      # the format to env['request.format']
+      #Rack::RespondTo.env = env
+      # otherwise, you can assign it directly
+      Rack::RespondTo.format = 'html'
+      body = respond_to do |format|
+        format.html { '<em>html</em>' }
+        format.xml  { '<body>xml</body>' }
+      end
+      content_type = Rack::RespondTo.mime_type
+      [200, {'Content-Type' => content_type}, [body]]
+    end
+  end
+  run App.new
+TIP
+To fully extract the requested format, use:
+  Rack::AcceptFormat    (sudo gem install rack-rack-contrib           --source=http://gems.github.com/)
+  Rack::AbstractFormat  (sudo gem install mynyml-rack-abstract-format --source=http://gems.github.com/)
+These will allow using only <tt>Rack::RespondTo.env = env</tt> to set up ResondTo.
+See examples/recommended_use.ru for a complete example.

data/Rakefile ADDED Viewed

@@ -0,0 +1,66 @@
+# --------------------------------------------------
+# based on thin's Rakefile (http://github.com/macournoyer/thin)
+# --------------------------------------------------
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'pathname'
+require 'yaml'
+RUBY_1_9  = RUBY_VERSION =~ /^1\.9/
+WIN       = (RUBY_PLATFORM =~ /mswin|cygwin/)
+SUDO      = (WIN ? "" : "sudo")
+def gem
+  RUBY_1_9 ? 'gem19' : 'gem'
+end
+def all_except(res)
+  Dir['**/*'].reject do |path|
+    Array(res).any? {|re| path.match(re) }
+  end
+end
+spec = Gem::Specification.new do |s|
+  s.name            = 'rack-respond_to'
+  s.version         = '0.9'
+  s.summary         = "Rack middleware port of Rails's respond_to feature"
+  s.description     = "Rack middleware port of Rails's respond_to feature"
+  s.author          = "Martin Aumont"
+  s.email           = 'mynyml@gmail.com'
+  s.homepage        = ''
+  s.has_rdoc        = true
+  s.require_path    = "lib"
+  s.files           = all_except([/doc/, /pkg/])
+end
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+desc "Remove package products"
+task :clean => :clobber_package
+desc "Update the gemspec for GitHub's gem server"
+task :gemspec do
+  Pathname("#{spec.name}.gemspec").open('w') {|f| f << YAML.dump(spec) }
+end
+desc "Install gem"
+task :install => [:clobber, :package] do
+  sh "#{SUDO} #{gem} install pkg/#{spec.full_name}.gem"
+end
+desc "Uninstall gem"
+task :uninstall => :clean do
+  sh "#{SUDO} #{gem} uninstall -v #{spec.version} -x #{spec.name}"
+end
+desc "Generate rdoc documentation."
+Rake::RDocTask.new("rdoc") { |rdoc|
+  rdoc.rdoc_dir = 'doc/rdoc'
+  rdoc.title    = "Simple Router - Document"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}

data/examples/recommended_use.ru ADDED Viewed

@@ -0,0 +1,38 @@
+# install required dependencies:
+#
+#   $sudo gem install rack-rack-contrib --source=http://gems.github.com/
+#   $sudo gem install mynyml-rack-abstract-format --source=http://gems.github.com/
+#
+# and run me with:
+#   $rackup examples/recommended_use.ru -p 8080
+#
+require 'rubygems'
+require 'rack'
+require 'rack/contrib' # for Rack::AcceptFormat
+require 'rack/abstract_format'
+require 'rack/respond_to'
+class App
+  include Rack::RespondTo
+  def call(env)
+    Rack::RespondTo.env = env
+    request = Rack::Request.new(env)
+    body = case request.path_info
+    when '/foo'
+      respond_to do |format|
+        format.html { '<em>html</em>' }
+        format.xml  { '<body>xml</body>' }
+      end
+    end
+    content_type = Rack::RespondTo.mime_type
+    [200, {'Content-Type' => content_type}, [body]]
+  end
+end
+use Rack::AcceptFormat
+use Rack::AbstractFormat
+run App.new

data/examples/simple_app.ru ADDED Viewed

@@ -0,0 +1,36 @@
+# run me with:
+#   $rackup examples/simple_app.ru -p 8080
+#
+require 'pathname'
+root  =  Pathname(__FILE__).dirname.parent.expand_path
+$:.unshift(root.join('lib'))
+require 'rubygems'
+require 'rack'
+require 'rack/respond_to'
+class App
+  include Rack::RespondTo
+  def call(env)
+    # simply pass in the env if another middleware already added
+    # the format to env['request.format']
+    #Rack::RespondTo.env = env
+    # otherwise, you can assign it directly
+    Rack::RespondTo.format = 'html'
+    body = case env['PATH_INFO']
+    when '/'
+      respond_to do |format|
+        format.html { '<em>html</em>' }
+        format.xml  { '<body>xml</body>' }
+      end
+    end
+    content_type = Rack::RespondTo.mime_type
+    [200, {'Content-Type' => content_type}, [body]]
+  end
+end
+run App.new

data/lib/rack/respond_to.rb ADDED Viewed

@@ -0,0 +1,82 @@
+module Rack
+  # Based on Rails's API, and sinatra-respond_to (http://github.com/cehoffman/sinatra-respond_to)
+  #
+  # See examples/ directory for code examples.
+  module RespondTo
+    class << self
+      # Assign the environment directly if it contains the format in
+      # env['request.format']. This is useful in conjunction with other
+      # middlewares that store the format in the env key.
+      attr_accessor :env
+      # If used completely standalone, you can assign the request format directly.
+      #
+      #   RespondTo.format = 'xml'
+      attr_writer :format
+      # Requested format
+      def format
+        (@format || self.env['request.format']).to_s.strip.downcase.sub(/^\./,'')
+      end
+      def included(base) #:nodoc:
+        base.extend(ClassMethods)
+        base.class_eval do
+          include InstanceMethods
+        end
+      end
+      # Convenience method that returns the mime type of the given format
+      # (similar to Rack::Mime.mime_type).
+      #
+      # If format argument is omitted, will return the mime type for
+      # RespondTo.format (i.e. equivelent to RespondTo.mime_type(RespondTo.format)).
+      # Useful for setting content type:
+      #
+      # ===== Example
+      #
+      #   [200, {'Content-Type' => Rack::RespondTo.mime_type}, [body]]
+      def mime_type(format = nil)
+        format ||= self.format
+        ext = format.sub(/^\./,'').insert(0,'.')
+        Rack::Mime.mime_type(ext)
+      end
+    end
+    module InstanceMethods
+      # Delegates to the equivalent class method.
+      def respond_to(&block)
+        self.class.respond_to(&block)
+      end
+    end
+    module ClassMethods
+      # Allows defining different actions and returns the one which corresponds
+      # to the current RespondTo.format.
+      #
+      # ===== Example
+      #
+      #   RespondTo.format = 'html'
+      #
+      #   respond_to do |format|
+      #     format.html { '<em>html</em>' }
+      #     format.xml  { '<content>xml</content>' }
+      #   end
+      #   #=> '<em>html</em>'
+      #
+      def respond_to(&block)
+        format = Format.new
+        block.call(format)
+        handler = format[RespondTo.mime_type]
+        handler.nil? ? nil : handler.call
+      end
+    end
+    class Format < Hash #:nodoc:
+      def method_missing(format, *args, &handler)
+        self[RespondTo.mime_type(format.to_s)] = handler
+      end
+    end
+  end
+end

data/rack-respond_to.gemspec ADDED Viewed

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: rack-respond_to
+version: !ruby/object:Gem::Version
+  version: "0.9"
+platform: ruby
+authors:
+- Martin Aumont
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-05-22 00:00:00 -04:00
+default_executable:
+dependencies: []
+description: Rack middleware port of Rails's respond_to feature
+email: mynyml@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- test
+- test/test_respond_to.rb
+- test/test_helper.rb
+- examples
+- examples/simple_app.ru
+- examples/recommended_use.ru
+- lib
+- lib/rack
+- lib/rack/respond_to.rb
+- rack-respond_to.gemspec
+- LICENSE
+- README
+has_rdoc: true
+homepage: ""
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.3
+signing_key:
+specification_version: 3
+summary: Rack middleware port of Rails's respond_to feature
+test_files: []

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,20 @@
+require 'pathname'
+require 'test/unit'
+require 'rubygems'
+require 'rack'
+begin
+  require 'ruby-debug'
+rescue LoadError, RuntimeError
+end
+root = Pathname(__FILE__).dirname.parent.expand_path
+$:.unshift(root.join('lib'))
+require 'rack/respond_to'
+class Test::Unit::TestCase
+  def self.test(name, &block)
+    name = :"test_#{name.gsub(/\s/,'_')}"
+    define_method(name, &block)
+  end
+end

data/test/test_respond_to.rb ADDED Viewed

@@ -0,0 +1,86 @@
+require 'test/test_helper'
+class App
+  include Rack::RespondTo
+end
+class TestRespondTo < Test::Unit::TestCase
+  def setup
+    Rack::RespondTo.format = nil
+  end
+  ## api
+  test "format accessor" do
+    Rack::RespondTo.format = 'xml'
+  end
+  test "env accessor" do
+    Rack::RespondTo.env = {}
+  end
+  test "mixin injects respond_to class method" do
+    assert App.respond_to?(:respond_to)
+  end
+  test "mixin injects respond_to instance method" do
+    assert App.new.respond_to?(:respond_to)
+  end
+  ## format
+  test "format is extracted from env" do
+    Rack::RespondTo.env = {'request.format' => 'xml'}
+    assert_equal 'xml', Rack::RespondTo.format
+  end
+  test "explicitly specified format takes precedence of env's" do
+    Rack::RespondTo.env = {'request.format' => 'xml'}
+    Rack::RespondTo.format = 'html'
+    assert_equal 'html', Rack::RespondTo.format
+  end
+  test "format is normalized" do
+    Rack::RespondTo.format = '.html'
+    assert_equal 'html', Rack::RespondTo.format
+    Rack::RespondTo.format = :html
+    assert_equal 'html', Rack::RespondTo.format
+    Rack::RespondTo.format = ' html '
+    assert_equal 'html', Rack::RespondTo.format
+    Rack::RespondTo.format = 'HTML'
+    assert_equal 'html', Rack::RespondTo.format
+  end
+  ## respond_to
+  test "respond_to returns block for requested format" do
+    Rack::RespondTo.format = 'xml'
+    response = App.respond_to do |format|
+      format.xml { 'xml' }
+      format.txt { 'txt' }
+    end
+    assert_equal 'xml', response
+  end
+  test "respond_to returns nil when no format matches" do
+    Rack::RespondTo.format = 'html'
+    response = App.respond_to do |format|
+      format.xml { 'xml' }
+      format.txt { 'txt' }
+    end
+    assert_equal nil, response
+  end
+  test "respond_to handles synonymous formats" do
+    Rack::RespondTo.format = 'htm' # htm should trigger both htm and html
+    response = App.respond_to do |format|
+      format.html { 'html' }
+      format.json { 'json' }
+    end
+    assert_equal 'html', response
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: mynyml-rack-respond_to
+version: !ruby/object:Gem::Version
+  version: "0.9"
+platform: ruby
+authors:
+- Martin Aumont
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-05-21 21:00:00 -07:00
+default_executable:
+dependencies: []
+description: Rack middleware port of Rails's respond_to feature
+email: mynyml@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- test
+- test/test_respond_to.rb
+- test/test_helper.rb
+- examples
+- examples/simple_app.ru
+- examples/recommended_use.ru
+- lib
+- lib/rack
+- lib/rack/respond_to.rb
+- rack-respond_to.gemspec
+- LICENSE
+- README
+has_rdoc: true
+homepage: ""
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.2.0
+signing_key:
+specification_version: 3
+summary: Rack middleware port of Rails's respond_to feature
+test_files: []