roy 0.0.1 → 0.1.0

data/Gemfile.lock

@@ -2,6 +2,7 @@ PATH
   remote: .
   specs:
     roy (0.0.1)
+      rack
 
 GEM
   remote: http://rubygems.org/
@@ -10,6 +11,7 @@ GEM
     rack (1.3.4)
     rack-test (0.6.1)
       rack (>= 1.0)
+    tilt (1.3.3)
 
 PLATFORMS
   ruby
@@ -18,3 +20,4 @@ DEPENDENCIES
   minitest
   rack-test
   roy!
+  tilt

data/README.md

@@ -1,16 +1,17 @@
 Roy
 ===
 
-Roy is a tiny module that aims to make any Ruby object Rack-friendly and provite
-it with a REST-like interface.
+Roy is a tiny module that aims to make any Ruby object Rack-friendly and
+provides it with a REST-like interface.
 
-Roy tries to be as less invasive as possible. In provides your objects with a
+Roy tries to be as less invasive as possible. It provides your objects with a
 `#call` method that takes a Rack environment and dispatchs to a regular method
 named after the HTTP method you want to catch.
 
 ## Tests
 
-You can run the tests by running `rake test`. They are written with Minitest.
+You can execute the tests by running `rake test`. They are written with
+Minitest.
 
 ## Example
 
@@ -44,20 +45,20 @@ end
 
 ### Configuration
 
-The `roy` class method is used to define access control and method prefix. The
-following example should be self-explanatory enough:
+The `roy` class method is mainly used to define access control and method
+prefix. You can also define your own options.  The following example should be
+self-explanatory enough:
 
 ``` ruby
 class Example
   include Roy
-  roy allow: [:get], prefix: :http_
+  roy allow: [:get], prefix: :http_, foo: "bar"
 
   def http_get(*args)
-    "get"
+    "foo is #{roy.conf.foo}"
   end
 end
 ```
-
 ### Environement
 
 Inside your handler methods, you have access to a `roy` readable attribute which

data/lib/roy.rb

@@ -1,5 +1,6 @@
 require 'set'
 require 'rack'
+require 'ostruct'
 require 'roy/version'
 
 module Roy
@@ -9,10 +10,14 @@ module Roy
     base.send(:extend, ClassMethods)
   end
 
-  attr_reader :roy
+  def roy
+    @roy ||= Env.new.tap {|e|
+      e.conf = self.class.conf
+    }
+  end
 
   def call(env)
-    @roy = Env.new.tap { |e|
+    roy.tap { |e|
       e.env      = env
       e.request  = Rack::Request.new(env)
       e.response = Rack::Response.new
@@ -21,7 +26,6 @@ module Roy
       e.params.default_proc = proc do |hash, key|
         hash[key.to_s] if Symbol === key
       end
-      e.conf = self.class.conf
     }
 
     method = roy.env['REQUEST_METHOD'].downcase.to_sym
@@ -49,9 +53,7 @@ module Roy
     attr_reader :conf
 
     def roy(options={})
-      @conf       ||= Struct.new(:allow, :prefix).new
-      conf.allow  ||= Set.new
-      conf.prefix ||= :''
+      @conf ||= OpenStruct.new(allow: Set.new, prefix: :'')
 
       options.each do |k,v|
         case k
@@ -60,6 +62,8 @@ module Roy
           conf.allow.add(:head) if v.member?(:get)
         when :prefix
           conf.prefix = v
+        else
+          conf.send(:"#{k}=", v)
         end
       end
     end

data/lib/roy/after.rb

@@ -0,0 +1,10 @@
+module Roy
+  module After
+    def call(env)
+      status, header, body = super
+      resp = Rack::Response.new(body, status, header)
+      (roy.conf.after || lambda {|x| x }).(resp)
+      resp.finish
+    end
+  end
+end

data/lib/roy/before.rb

@@ -0,0 +1,8 @@
+module Roy
+  module Before
+    def call(env)
+      (roy.conf.before || lambda {|x| x }).(env)
+      super
+    end
+  end
+end

data/lib/roy/plugins.rb

@@ -0,0 +1,10 @@
+module Roy
+  def self.Plugins(*names)
+    return Module.new.tap do |mod|
+      names.each do |name|
+        mod.send(:include, name)
+      end
+    end
+  end
+end
+

data/lib/roy/render.rb

@@ -0,0 +1,15 @@
+require 'tilt'
+
+module Roy
+  module Render
+    def render(engine, template_or_string, params={}, &block)
+      case template_or_string
+      when Symbol
+      else
+        Tilt[engine].new {
+          template_or_string.to_s
+        }.render(self, params, &block)
+      end
+    end
+  end
+end

data/lib/roy/version.rb

@@ -1,3 +1,3 @@
 module Roy
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/roy.gemspec

@@ -20,8 +20,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
+  s.add_dependency "rack"
+
   s.add_development_dependency "minitest"
   s.add_development_dependency "rack-test"
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "tilt"
 end

data/test/after_test.rb

@@ -0,0 +1,31 @@
+require_relative 'helper'
+require 'roy/after'
+
+class AfterTestObject
+  include Roy
+  include Roy::After
+
+  roy allow: [:get],
+      after: lambda { |response|
+        response.header['Content-Type'] = 'text/plain'
+      }
+
+  def get(*args)
+    'success'
+  end
+end
+
+class AfterTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    AfterTestObject.new
+  end
+
+  def test_after_filter
+    get '/'
+    ok!
+    assert_equal 'text/plain', last_response.header['Content-Type']
+  end
+
+end

data/test/base_test.rb

@@ -1,6 +1,6 @@
 require_relative 'helper'
 
-class RemoteLog
+class BaseTestObject
   include Roy
 
   attr_reader :history
@@ -27,11 +27,11 @@ class RemoteLog
   end
 end
 
-class RoyTest < MiniTest::Unit::TestCase
+class BaseTest < MiniTest::Unit::TestCase
   include Rack::Test::Methods
 
   def app
-    RemoteLog.new
+    BaseTestObject.new
   end
 
   def test_provide_call
@@ -42,6 +42,12 @@ class RoyTest < MiniTest::Unit::TestCase
     assert_respond_to app.class, :roy
   end
 
+  def test_defines_roy_attribute_with_defaults
+    assert_respond_to app, :roy
+    assert_equal       :'', app.roy.conf.prefix
+    assert_instance_of Set, app.roy.conf.allow
+  end
+
   def test_forward_allowed_methods
     get '/'
     ok!

data/test/before_test.rb

@@ -0,0 +1,31 @@
+require_relative 'helper'
+require 'roy/before'
+
+class BeforeTestObject
+  include Roy
+  include Roy::Before
+
+  roy allow: [:get],
+      before: lambda { |env|
+        env['REQUEST_METHOD'] = 'GET'
+      }
+
+  def get(*args)
+    'success'
+  end
+end
+
+class BeforeTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    BeforeTestObject.new
+  end
+
+  def test_before_filter
+    post '/'
+    ok!
+    assert_equal 'success', last_response.body
+  end
+
+end

data/test/custom_options_test.rb

@@ -0,0 +1,20 @@
+
+require_relative 'helper'
+
+class CustomOptionsTestObject
+  include Roy
+
+  roy foo: :bar
+end
+
+class CustomOptionsTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    CustomOptionsTestObject.new
+  end
+
+  def test_custom_options
+    assert_equal :bar, app.class.conf.foo
+  end
+end

data/test/plugins_test.rb

@@ -0,0 +1,37 @@
+require_relative 'helper'
+require 'roy/plugins'
+require 'roy/before'
+require 'roy/after'
+
+class PluginsTestObject
+  include Roy
+  include Roy::Plugins(Before, After)
+
+  roy allow: [:get],
+      before: lambda { |env|
+        env['REQUEST_METHOD'] = 'GET'
+      },
+      after: lambda { |response|
+        response.header['Content-Type'] = 'text/plain'
+      }
+
+  def get(*args)
+    'success'
+  end
+end
+
+class PluginsTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    PluginsTestObject.new
+  end
+
+  def test_plugins_are_loaded
+    get '/'
+    ok!
+    assert_equal 'text/plain', last_response.header['Content-Type']
+    assert_equal 'success', last_response.body
+  end
+
+end

data/test/prefix_test.rb

@@ -1,6 +1,6 @@
 require_relative 'helper'
 
-class TestObject
+class PrefixTestObject
   include Roy
 
   roy allow: [:get], prefix: :http_
@@ -14,7 +14,7 @@ class PrefixTest < MiniTest::Unit::TestCase
   include Rack::Test::Methods
 
   def app
-    TestObject.new
+    PrefixTestObject.new
   end
 
   def test_prefixing

data/test/render_test.rb

@@ -0,0 +1,75 @@
+require_relative 'helper'
+require 'roy/render'
+
+Templates = {
+  simple: %q(<%= "Hello world!" %>),
+  locals: %q(<%= "Hello #{person}" %>),
+  scope:  %q(<%= roy.conf.inspect %>),
+  yield:  %q(<%= yield %>)
+}
+
+class RenderTestObject
+  include Roy
+  include Roy::Render
+
+  roy allow: [:get]
+
+  def get(*args)
+    case args.first
+    when 'template'
+      halt 403
+    when 'inline'
+      render :erb, Templates[:simple]
+    when 'locals'
+      render :erb, Templates[:locals], person: 'Bob'
+    when 'scope'
+      render :erb, Templates[:scope]
+    when 'yield'
+      render :erb, Templates[:yield] do
+        render :erb, Templates[:simple]
+      end
+    end
+  end
+end
+
+class RenderTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    RenderTestObject.new
+  end
+
+  def inline(tid, params={}, &block)
+    Tilt[:erb].new { Templates[tid] }.render(app, params, &block)
+  end
+
+  def test_render_file_template
+    get '/template'
+    fail!
+  end
+
+  def test_render_inline_template
+    get '/inline'
+    ok!
+    assert_equal inline(:simple), last_response.body
+  end
+
+  def test_render_inline_template_with_locals
+    get '/locals'
+    ok!
+    assert_equal inline(:locals, person: 'Bob'), last_response.body
+  end
+
+  def test_render_inline_scope
+    get '/scope'
+    ok!
+    assert_equal inline(:scope), last_response.body
+  end
+
+  def test_render_with_block
+    get '/yield'
+    ok!
+    assert_equal inline(:simple), last_response.body
+  end
+
+end

metadata

@@ -2,7 +2,7 @@
 name: roy
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - madx
@@ -10,10 +10,10 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-19 00:00:00 Z
+date: 2011-10-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: minitest
+  name: rack
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -21,10 +21,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rack-test
+  name: minitest
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -34,6 +34,28 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: tilt
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: |-
   roy is a small library which allows every Ruby object to be used
   as a Rack application.
@@ -52,11 +74,20 @@ files:
 - README.md
 - Rakefile
 - lib/roy.rb
+- lib/roy/after.rb
+- lib/roy/before.rb
+- lib/roy/plugins.rb
+- lib/roy/render.rb
 - lib/roy/version.rb
 - roy.gemspec
+- test/after_test.rb
 - test/base_test.rb
+- test/before_test.rb
+- test/custom_options_test.rb
 - test/helper.rb
+- test/plugins_test.rb
 - test/prefix_test.rb
+- test/render_test.rb
 homepage: https://github.com/madx/roy
 licenses: []
 
@@ -85,6 +116,11 @@ signing_key:
 specification_version: 3
 summary: make your objects REST-friendly
 test_files: 
+- test/after_test.rb
 - test/base_test.rb
+- test/before_test.rb
+- test/custom_options_test.rb
 - test/helper.rb
+- test/plugins_test.rb
 - test/prefix_test.rb
+- test/render_test.rb