sinatra-scope 0.1.0

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+
+gemspec
+
+group :test do
+  gem "rack-test"
+end

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    sinatra-scope (0.0.1)
+      activesupport (~> 3.0.0)
+      i18n (~> 0.5.0)
+      sinatra
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    i18n (0.5.0)
+    rack (1.2.1)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    sinatra (1.1.2)
+      rack (~> 1.1)
+      tilt (~> 1.2)
+    tilt (1.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-test
+  sinatra-scope!

data/lib/sinatra/resource.rb

@@ -0,0 +1,69 @@
+require 'sinatra/scope'
+
+module Sinatra
+  module Resource
+
+    def resource(name, &block)
+      scope name, &block
+    end
+    alias resources resource
+
+    def member(&block)
+      scope ":id", &block
+    end
+
+    def index(&block)
+      get &block
+    end
+
+    def _new(&block)
+      get "/new", &block
+    end
+
+    def create(&block)
+      post &block
+    end
+
+    def show(&block)
+      if block.arity == 0
+        get &block
+      else
+        get { block.call(params[:id]) }
+      end
+    end
+
+    def edit(&block)
+      if block.arity == 0
+        get "/edit", &block
+      else
+        get("/edit") { block.call(params[:id]) }
+      end
+    end
+
+    def update(&block)
+      if block.arity == 0
+        put &block
+      else
+        put { block.call(params[:id]) }
+      end
+    end
+
+    def _delete(&block)
+      if block.arity == 0
+        get "/delete", &block
+      else
+        get("/delete") { block.call(params[:id]) }
+      end
+    end
+
+    def destroy(&block)
+      if block.arity == 0
+        delete &block
+      else
+        delete { block.call(params[:id]) }
+      end
+    end
+
+  end
+
+end

data/lib/sinatra/scope.rb

@@ -0,0 +1,65 @@
+require 'active_support/core_ext/string/inflections'
+require 'active_support/inflections'
+require 'sinatra/base'
+
+module Sinatra
+  module Scope
+
+    [:get, :post, :patch, :put, :delete, :head, :options].each do |verb|
+      define_method verb do |path = '', options = {}, &block|
+        super(full_path(path), options, &block)
+      end
+    end
+
+    [:before, :after].each do |action|
+      define_method action do |path = '', options = {}, &block|
+        super(full_path(path), options, &block)
+      end
+    end
+
+    def scope(path, options = {}, &block)
+      case path
+      when Class
+        path = path.name
+        path = path.demodulize unless options[:full_classname]
+        path = path.underscore.dasherize
+        path = path.pluralize unless options[:singular]
+      else
+        path = path.to_s
+      end
+
+      (@scopes ||= []) << path
+      block.call
+      @scopes.pop
+    end
+
+    def scopes(*paths, &block)
+      @scopes ||= []
+      paths.each do |path|
+        @scopes << path.to_s
+      end
+      block.call
+      paths.each do |path|
+        @scopes.pop
+      end
+    end
+
+  protected
+    def full_path(path)
+      case path
+      when String, Symbol
+        ("/" + (@scopes || []).join("/") + path.to_s).squeeze("/")
+      when Regexp
+        Regexp.new(Regexp.escape("/" + (@scopes || []).join("/")) + path.source)
+      else
+        path
+      end
+    end
+
+    def path_name(path)
+      full_path(path).gsub(/^\//, '')
+    end
+
+  end
+
+end

data/lib/sinatra/urls.rb

@@ -0,0 +1,35 @@
+require 'sinatra/scope'
+require 'active_support/core_ext/class/attribute'
+
+module Sinatra
+
+  class UrlTracker
+    class_attribute :urls
+    self.urls = {}
+
+    def self.add(path, scopes = [], options = {})
+      name = (scopes.join("_") + "_" + path.to_s).gsub(/^_|_$/, "")
+
+      if name =~ /[a-zA-z0-9_\-%]/
+        self.urls[name] = ("/" + scopes.join("/") + "/" + path).squeeze("/")
+      end
+    end
+  end
+
+  module UrlScope
+
+    def scope(path = '', options = {}, &block)
+      UrlTracker.add(super, @scopes, options)
+    end
+
+  end
+
+  module UrlHelpers
+
+    def url(name, *args)
+      UrlTracker.urls[name.to_s]
+    end
+
+  end
+
+end

data/test/contest.rb

@@ -0,0 +1,65 @@
+require "test/unit"
+
+# Test::Unit loads a default test if the suite is empty, and the only
+# purpose of that test is to fail. As having empty contexts is a common
+# practice, we decided to overwrite TestSuite#empty? in order to
+# allow them. Having a failure when no tests have been defined seems
+# counter-intuitive.
+class Test::Unit::TestSuite
+  unless method_defined?(:empty?)
+    def empty?
+      false
+    end
+  end
+end
+
+# We added setup, test and context as class methods, and the instance
+# method setup now iterates on the setup blocks. Note that all setup
+# blocks must be defined with the block syntax. Adding a setup instance
+# method defeats the purpose of this library.
+class Test::Unit::TestCase
+  def self.setup(&block)
+    setup_blocks << block
+  end
+
+  def setup
+    self.class.setup_blocks.each do |block|
+      instance_eval(&block)
+    end
+  end
+
+  def self.context(name, &block)
+    subclass = Class.new(self.superclass)
+    subclass.setup_blocks.unshift(*setup_blocks)
+    subclass.class_eval(&block)
+    const_set(context_name(name), subclass)
+  end
+
+  def self.test(name, &block)
+    define_method(test_name(name), &block)
+  end
+
+  class << self
+    alias_method :should, :test
+    alias_method :describe, :context
+  end
+
+private
+
+  def self.setup_blocks
+    @setup_blocks ||= []
+  end
+
+  def self.context_name(name)
+    "Test#{sanitize_name(name).gsub(/(^| )(\w)/) { $2.upcase }}".to_sym
+  end
+
+  def self.test_name(name)
+    "test_#{sanitize_name(name).gsub(/\s+/,'_')}".to_sym
+  end
+
+  def self.sanitize_name(name)
+    name.gsub(/\W+/, ' ').strip
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,83 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'rack'
+
+testdir = File.dirname(__FILE__)
+$LOAD_PATH.unshift testdir unless $LOAD_PATH.include?(testdir)
+
+libdir = File.dirname(File.dirname(__FILE__)) + '/lib'
+$LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
+
+require 'contest'
+require 'rack/test'
+require 'sinatra/base'
+require 'sinatra/scope'
+require 'sinatra/resource'
+require 'sinatra/urls'
+
+class Sinatra::Base
+  # Allow assertions in request context
+  include Test::Unit::Assertions
+end
+
+# App that includes scope helpers
+class ScopeApp < Sinatra::Base
+  register Sinatra::Scope
+  register Sinatra::Resource
+  register Sinatra::UrlScope
+  helpers Sinatra::UrlHelpers
+end
+
+Sinatra::Base.set :environment, :test
+
+class Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  class << self
+    alias_method :it, :test
+  end
+
+  alias_method :response, :last_response
+
+  setup do
+    Sinatra::Base.set :environment, :test
+  end
+
+  # Sets up a Sinatra::Base subclass defined with the block
+  # given. Used in setup or individual spec methods to establish
+  # the application.
+  def mock_app(base=ScopeApp, &block)
+    @app = Sinatra.new(base, &block)
+  end
+
+  def app
+    Rack::Lint.new(@app)
+  end
+
+  def body
+    response.body.to_s
+  end
+
+  # Delegate other missing methods to response.
+  def method_missing(name, *args, &block)
+    if response && response.respond_to?(name)
+      response.send(name, *args, &block)
+    else
+      super
+    end
+  end
+
+  # Also check response since we delegate there.
+  def respond_to?(symbol, include_private=false)
+    super || (response && response.respond_to?(symbol, include_private))
+  end
+
+  # Do not output warnings for the duration of the block.
+  def silence_warnings
+    $VERBOSE, v = nil, $VERBOSE
+    yield
+  ensure
+    $VERBOSE = v
+  end
+end
+

data/test/sinatra_resource_test.rb

@@ -0,0 +1,267 @@
+require File.expand_path 'helper', File.dirname(__FILE__)
+
+class ResourceTest < Test::Unit::TestCase
+
+  it 'supports the resource method' do
+    mock_app {
+      resource "pages" do
+        get do
+          "Pages are great!"
+        end
+      end
+    }
+
+    get "/pages"
+    assert ok?
+    assert_equal "Pages are great!", body
+  end
+
+  it 'supports the resources method' do
+    mock_app {
+      resources "pages" do
+        get do
+          "Pages are great!"
+        end
+      end
+    }
+
+    get "/pages"
+    assert ok?
+    assert_equal "Pages are great!", body
+  end
+
+  it 'supports the member method' do
+    mock_app {
+      resource "pages" do
+        member do
+          get do
+            "Page id: #{params[:id]}"
+          end
+        end
+      end
+    }
+
+    get "/pages/3"
+    assert ok?
+    assert_equal "Page id: 3", body
+  end
+
+  it "supports the index method of a resource" do
+    mock_app do
+      resource "pages" do
+        index do
+          "Hello"
+        end
+      end
+    end
+
+    get "/pages"
+    assert ok?
+    assert_equal "Hello", body
+  end
+
+  it "supports the new (_new) method of a resource" do
+    mock_app do
+      resource "pages" do
+        _new do
+          "New page"
+        end
+      end
+    end
+
+    get "/pages/new"
+    assert ok?
+    assert_equal "New page", body
+  end
+
+  it "supports the create method of a resource" do
+    mock_app do
+      resource "pages" do
+        create do
+          "Created the page"
+        end
+      end
+    end
+
+    post "/pages", {}
+    assert ok?
+    assert_equal "Created the page", body
+  end
+
+  it "supports the show method of a resource" do
+    mock_app do
+      resource "pages" do
+        member do
+          show do
+            "Page #{params[:id]}"
+          end
+        end
+      end
+    end
+
+    get "/pages/1"
+    assert ok?
+    assert_equal "Page 1", body
+  end
+
+  it "supports the show method of a resource with the id argument" do
+    mock_app do
+      resource "pages" do
+        member do
+          show do |id|
+            "Page #{id}"
+          end
+        end
+      end
+    end
+
+    get "/pages/1"
+    assert ok?
+    assert_equal "Page 1", body
+  end
+
+  it "supports the edit method of a resource" do
+    mock_app do
+      resource "pages" do
+        member do
+          edit do
+            "Edit page #{params[:id]}"
+          end
+        end
+      end
+    end
+
+    get "/pages/1/edit"
+    assert ok?
+    assert_equal "Edit page 1", body
+  end
+
+  it "supports the edit method of a resource with the id argument" do
+    mock_app do
+      resource "pages" do
+        member do
+          edit do |id|
+            "Edit page #{id}"
+          end
+        end
+      end
+    end
+
+    get "/pages/1/edit"
+    assert ok?
+    assert_equal "Edit page 1", body
+  end
+
+  it "supports the update method of a resource" do
+    mock_app do
+      resource "pages" do
+        member do
+          update do
+            "Updated page #{params[:id]}"
+          end
+        end
+      end
+    end
+
+    put "/pages/1", {}
+    assert ok?
+    assert_equal "Updated page 1", body
+  end
+
+  it "supports the update method of a resource with the id argument" do
+    mock_app do
+      resource "pages" do
+        member do
+          update do |id|
+            "Updated page #{id}"
+          end
+        end
+      end
+    end
+
+    put "/pages/1", {}
+    assert ok?
+    assert_equal "Updated page 1", body
+  end
+
+  it "supports the delete (_delete) method of a resource" do
+    mock_app do
+      resource "pages" do
+        member do
+          _delete do
+            "Page #{params[:id]}"
+          end
+        end
+      end
+    end
+
+    get "/pages/1/delete"
+    assert ok?
+    assert_equal "Page 1", body
+  end
+
+  it "supports the delete (_delete) method of a resource with the id argument" do
+    mock_app do
+      resource "pages" do
+        member do
+          _delete do |id|
+            "Page #{id}"
+          end
+        end
+      end
+    end
+
+    get "/pages/1/delete"
+    assert ok?
+    assert_equal "Page 1", body
+  end
+
+  it "supports the destroy method of a resource" do
+    mock_app do
+      resource "pages" do
+        member do
+          destroy do
+            "destroyd page #{params[:id]}"
+          end
+        end
+      end
+    end
+
+    delete "/pages/1", {}
+    assert ok?
+    assert_equal "destroyd page 1", body
+  end
+
+  it "supports the destroy method of a resource with the id argument" do
+    mock_app do
+      resource "pages" do
+        member do
+          destroy do |id|
+            "destroyd page #{id}"
+          end
+        end
+      end
+    end
+
+    delete "/pages/1", {}
+    assert ok?
+    assert_equal "destroyd page 1", body
+  end
+
+  it 'supports using a class as a resource' do
+    class Page; end
+
+    mock_app {
+      resource Page do
+        _new do
+          "Create a new page?"
+        end
+      end
+    }
+
+    get "/pages/new"
+    assert ok?
+    assert_equal "Create a new page?", body
+  end
+
+end

data/test/sinatra_scope_test.rb

@@ -0,0 +1,311 @@
+require File.expand_path 'helper', File.dirname(__FILE__)
+
+class ScopeTest < Test::Unit::TestCase
+
+  it "supports the scope method" do
+    mock_app do
+      scope "admin" do
+        get "/login" do
+          "/admin/login works"
+        end
+      end
+    end
+
+    get "/admin/login"
+    assert ok?
+    assert_equal "/admin/login works", response.body
+  end
+
+  %w[get put patch post delete].each do |verb|
+    it "defines #{verb.upcase} request handlers with #{verb}" do
+      mock_app {
+        send verb, '/hello' do
+          'Hello World'
+        end
+      }
+
+      request = Rack::MockRequest.new(@app)
+      response = request.request(verb.upcase, '/hello', {})
+      assert response.ok?
+      assert_equal 'Hello World', response.body
+    end
+  end
+
+  %w[get put post patch delete].each do |verb|
+    it "defines scoped #{verb.upcase} request handlers with #{verb}" do
+      mock_app {
+        scope "something" do
+          send verb, '/hello' do
+            'Hello World'
+          end
+        end
+      }
+
+      request = Rack::MockRequest.new(@app)
+      response = request.request(verb.upcase, '/something/hello', {})
+      assert response.ok?
+      assert_equal 'Hello World', response.body
+    end
+  end
+
+  it "defines HEAD request handlers with HEAD" do
+    mock_app {
+      head '/hello' do
+        response['X-Hello'] = 'World!'
+        'remove me'
+      end
+    }
+
+    request = Rack::MockRequest.new(@app)
+    response = request.request('HEAD', '/hello', {})
+    assert response.ok?
+    assert_equal 'World!', response['X-Hello']
+    assert_equal '', response.body
+  end
+
+  it "defines scoped HEAD request handlers with HEAD" do
+    mock_app {
+      scope "something" do
+        head '/hello' do
+          response['X-Hello'] = 'World!'
+          'remove me'
+        end
+      end
+    }
+
+    request = Rack::MockRequest.new(@app)
+    response = request.request('HEAD', '/something/hello', {})
+    assert response.ok?
+    assert_equal 'World!', response['X-Hello']
+    assert_equal '', response.body
+  end
+  
+  it "404s when no route satisfies the request" do
+    mock_app {
+      get('/foo') { }
+    }
+    get '/bar'
+    assert_equal 404, status
+  end
+  
+  it 'takes multiple definitions of a route' do
+    mock_app {
+      user_agent(/Foo/)
+      get '/foo' do
+        'foo'
+      end
+
+      get '/foo' do
+        'not foo'
+      end
+    }
+
+    get '/foo', {}, 'HTTP_USER_AGENT' => 'Foo'
+    assert ok?
+    assert_equal 'foo', body
+
+    get '/foo'
+    assert ok?
+    assert_equal 'not foo', body
+  end
+ 
+  it 'takes multiple definitions of a scoped route' do
+    mock_app {
+      scope "something" do
+        user_agent(/Foo/)
+        get '/foo' do
+          'foo'
+        end
+
+        get '/foo' do
+          'not foo'
+        end
+      end
+    }
+
+    get '/something/foo', {}, 'HTTP_USER_AGENT' => 'Foo'
+    assert ok?
+    assert_equal 'foo', body
+
+    get '/something/foo'
+    assert ok?
+    assert_equal 'not foo', body
+  end
+
+  it 'supports regular expressions' do
+    mock_app {
+      get(/^\/foo...\/bar$/) do
+        'Hello World'
+      end
+    }
+
+    get '/foooom/bar'
+    assert ok?
+    assert_equal 'Hello World', body
+  end
+  
+  it 'supports regular expressions' do
+    mock_app {
+      scope "something" do
+        get(/\/foo...\/bar$/) do
+          'Hello World'
+        end
+      end
+    }
+
+    get '/something/foooom/bar'
+    assert ok?
+    assert_equal 'Hello World', body
+  end
+  
+  it 'raises a TypeError when pattern is not a String or Regexp' do
+    assert_raise(TypeError) {
+      mock_app { get(42){} }
+    }
+  end
+
+  it 'supports helpers' do
+    mock_app {
+      helpers do
+        def foo
+          "bar"
+        end
+      end
+
+      get "/foo" do
+        foo
+      end
+      
+      scope "something" do
+        get "/foo" do
+          foo
+        end
+      end
+    }
+
+    get '/foo'
+    assert ok?
+    assert_equal 'bar', body
+  end
+  
+  it 'supports helpers in scoped urls' do
+    mock_app {
+      helpers do
+        def foo
+          "bar"
+        end
+      end
+
+      get "/foo" do
+        foo
+      end
+      
+      scope "something" do
+        get "/foo" do
+          foo
+        end
+      end
+    }
+
+    get '/something/foo'
+    assert ok?
+    assert_equal 'bar', body
+  end
+
+  it 'supports helpers inside the scope' do
+    mock_app {
+      scope "something" do
+        helpers do
+          def foo
+            "bar"
+          end
+        end
+
+        get "/foo" do
+          foo
+        end
+      end
+    }
+
+    get '/something/foo'
+    assert ok?
+    assert_equal 'bar', body
+  end
+
+  it 'supports using a class as a scope' do
+    class Page; end
+
+    mock_app {
+      scope Page do
+        get "/hello" do
+          "hello back!"
+        end
+      end
+    }
+
+    get "/pages/hello"
+    assert ok?
+    assert_equal 'hello back!', body
+  end
+
+  it 'supports using a class as a scope (singular)' do
+    class Page; end
+
+    mock_app {
+      scope Page, :singular => true do
+        get "/hello" do
+          "hello back!"
+        end
+      end
+    }
+
+    get "/page/hello"
+    assert ok?
+    assert_equal 'hello back!', body
+  end
+
+  it 'supports using a class as a scope (keep full name)' do
+    class Page; end
+
+    mock_app {
+      scope Page, :full_classname => true do
+        get "/hello" do
+          "hello back!"
+        end
+      end
+    }
+
+    get "/scope-test/pages/hello"
+    assert ok?
+    assert_equal 'hello back!', body
+  end
+
+  it "supports scoped before" do
+    mock_app {
+      get("foo") { @text.to_s + "foo" }
+      scope :bar do
+        before { @text = "baz" }
+        get { @text.to_s + "bar" }
+      end
+    }
+    get "/foo"
+    assert ok?
+    assert_equal "foo", body
+
+    get "/bar"
+    assert ok?
+    assert_equal "bazbar", body
+  end
+
+  it "supports multiple scopes at once" do
+    mock_app {
+      scopes :admin, :pages do
+        get { "hello there" }
+      end
+    }
+    get "/admin/pages"
+    assert ok?
+    assert_equal "hello there", body
+  end
+
+end

data/test/sinatra_urls_test.rb

@@ -0,0 +1,35 @@
+require File.expand_path 'helper', File.dirname(__FILE__)
+
+class UrlHelperTest < Test::Unit::TestCase
+
+  it "supports the url method" do
+    mock_app do
+      scope "admin" do
+        get do
+          "hello #{url(:admin)}"
+        end
+      end
+    end
+
+    get "/admin"
+    assert ok?
+    assert_equal "hello /admin", body
+  end
+
+  it "supports nested scopes with the url method" do
+    mock_app do
+      scope "admin" do
+        scope "projects" do
+          get do
+            "hello #{url(:admin_projects)}"
+          end
+        end
+      end
+    end
+
+    get "/admin/projects"
+    assert ok?
+    assert_equal "hello /admin/projects", body
+  end
+
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-scope
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Nathan Herald
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: Simple nested routes for Sinatra.
+email: nathan@myobie.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- Gemfile
+- Gemfile.lock
+files:
+- lib/sinatra/resource.rb
+- lib/sinatra/scope.rb
+- lib/sinatra/urls.rb
+- test/contest.rb
+- test/helper.rb
+- test/sinatra_resource_test.rb
+- test/sinatra_scope_test.rb
+- test/sinatra_urls_test.rb
+- Gemfile
+- Gemfile.lock
+homepage: http://github.com/myobie/sinatra-scope
+licenses: []
+post_install_message: 
+rdoc_options:
+- --title
+- Sinatra::Scope -- Simple nested routes for Sinatra
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- sinatra
+rubyforge_project: sinatra-scope
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple nested routes for Sinatra
+test_files: []