RubyGems - sinatra-controllers - Versions diffs - 0.1.0 - Mend

sinatra-controllers 0.1.0

Files changed (14) hide show

data/.gitignore +3 -0
data/Gemfile +4 -0
data/Gemfile.lock +26 -0
data/README.rdoc +60 -0
data/Rakefile +7 -0
data/lib/sinatra-controllers.rb +61 -0
data/lib/sinatra-controllers/version.rb +5 -0
data/sinatra-controllers.gemspec +26 -0
data/test/controller_test.rb +129 -0
data/test/fixtures/sinatra_application.rb +86 -0
data/test/fixtures/views/foo.haml +9 -0
data/test/fixtures/views/fringe.haml +2 -0
data/test/watchr.rb +4 -0
metadata +140 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile ADDED Viewed

@@ -0,0 +1,4 @@
+source :gemcutter
+# Specify your gem's dependencies in sinatra-controllers.gemspec
+gemspec

data/Gemfile.lock ADDED Viewed

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    sinatra-controllers (0.0.3)
+      sinatra (>= 1.1.0)
+GEM
+  remote: http://rubygems.org/
+  specs:
+    minitest (2.0.2)
+    rack (1.2.2)
+    sinatra (1.2.1)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    tilt (1.2.2)
+    watchr (0.7)
+PLATFORMS
+  ruby
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  minitest (~> 2.0.0)
+  sinatra (>= 1.1.0)
+  sinatra-controllers!
+  watchr

data/README.rdoc ADDED Viewed

@@ -0,0 +1,60 @@
+= Sinatra-controller
+Sinatra routing done differently.  Allows for clean organization across
+multiple sinatra routes files.
+NOTE: this has only been tested with ruby 1.9.2
+== Examples
+Also see the fixtures folders for what's used in the tests.
+views/index.haml
+  <!DOCTYPE HTML>
+  %html
+    %head
+      %meta(http-equiv="content-type" content="text/html; charset=utf-8")
+      %title test page
+  %body
+    fly away with sinatra controllers
+You can divide your routes cleanly between as many classes as you please. At
+any time, you can also simply revert back to the plain vanilla sinatra syntax
+on use get at the top level.
+sinatra\_controller.rb
+  #!/usr/bin/env ruby
+  require 'sinatra'
+  require 'sinatra-controllers'
+  class Welcome < Sinatra::Controller
+    def index
+      haml :index
+    end
+    # this create a route corresponding to `get '/welcome/about'`
+    # making it a shortcut for common routes. It doesn't handle arguments
+    # unlike the block syntax.
+    def get_about
+      'making controllers in sinatra easy'
+    end
+  end
+  Sinatra::Controllers.register Welcome do
+    get '/', :index
+  end
+This is a trick for common requests that don't require arguments. It creates a
+route corresponding to `get '/welcome/about'` in the flavor of Test::Unit where
+it uses the prefix before the underscore for the route type. The block to
+register is optional here.
+  class Welcome < Sinatra::Controller
+    def get_about
+      'making controllers in sinatra easy'
+    end
+  end

data/Rakefile ADDED Viewed

@@ -0,0 +1,7 @@
+require 'bundler'
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+Rake::TestTask.new :test do |spec|
+    spec.test_files = FileList["test/*_test.rb"]
+end

data/lib/sinatra-controllers.rb ADDED Viewed

@@ -0,0 +1,61 @@
+module Sinatra
+  class Controller
+    attr_accessor :params, :request, :template_cache
+    include Sinatra::Templates
+    def initialize(params,request)
+      @params  = params
+      @request = request
+      @template_cache = Tilt::Cache.new rescue 'sinatra < 1.0'
+      @templates = {}
+    end
+    class << self
+      def views
+      end
+      def templates
+        {}
+      end
+    end
+  end
+  module Controllers
+    class Mapping
+      attr_accessor :klass, :opts
+      def initialize(klass,opts={})
+        @klass = klass
+        @opts  = opts
+      end
+      def route(verb, path, action, opts={})
+        aklass = klass # need this so it will stay in scope for closure
+        block = proc { aklass.new(params, request).send action }
+        Sinatra::Application.send verb, path, &block
+      end
+      def parse
+        klass.instance_methods.each do |meth|
+          next unless meth =~ /^(get|post|delete|put)_(.*)$/
+          route $1,"/#{klass.to_s.downcase}/#{$2.downcase}", meth
+        end
+      end
+      # why are these even defined?
+      undef_method :get, :post, :put, :delete
+      def method_missing(method,*a)
+        case method.to_s
+        when /(get|post|delete|put)/
+          route(method, *a)
+        else
+          super
+        end
+      end
+    end
+    class << self
+      def register(klass, opts={}, &block)
+        map = Mapping.new(klass,opts)
+        map.instance_eval(&block) if block
+        map.parse
+      end
+    end
+  end
+end

data/lib/sinatra-controllers/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+module Sinatra
+  module Controllers
+    VERSION = "0.1.0"
+  end
+end

data/sinatra-controllers.gemspec ADDED Viewed

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/sinatra-controllers/version", __FILE__)
+Gem::Specification.new do |s|
+  s.name        = "sinatra-controllers"
+  s.version     = Sinatra::Controllers::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Daniel Bretoi']
+  s.email       = []
+  s.homepage    = "http://rubygems.org/gems/sinatra-controllers"
+  s.summary     = "Adds controllers to Sinatra"
+  s.description = "Adds controllers to Sinatra"
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "sinatra-controllers"
+  s.add_dependency "sinatra", ">= 1.1.0"
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "minitest", "~> 2.0.0"
+  s.add_development_dependency "watchr"
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+  s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/test/controller_test.rb ADDED Viewed

@@ -0,0 +1,129 @@
+require 'rack/test'
+require 'test/unit'
+require 'minitest/autorun'
+require 'ap'
+require './test/fixtures/sinatra_application'
+class Pride
+  def print o
+    case o
+    when /0 errors/i
+      Kernel.print o.green
+    when /(e|f)/i
+      Kernel.print o.red
+    else
+      Kernel.print o.green
+    end
+  end
+  def puts o = ''
+    if o=~ /([1-9]+ failures)/
+      o.sub!(/([1-9]+ failures)/, '\1'.red)
+    end
+    Kernel.puts o
+  end
+end
+MiniTest::Unit.output = Pride.new
+class ClassicMappingTest < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+  def app
+    @app = Sinatra::Application
+    @app.set :environment, :test
+    @app
+  end
+  def test_render
+    get '/'
+    assert_equal 200, last_response.status
+    assert_equal true, (last_response.body =~ /message/) != nil
+  end
+  def test_fringe
+    get '/fringe'
+    assert_equal 200, last_response.status
+    assert_equal true, (last_response.body =~ /bishop/) != nil
+    assert_equal true, (last_response.body =~ /Anna Torv/) != nil
+  end
+  def test_param_pass
+    get '/test/232'
+    assert_equal 200, last_response.status
+    assert_equal true, (last_response.body =~ /232/) != nil
+  end
+  def test_help_route
+    get '/help'
+    assert_equal 200, last_response.status
+  end
+  def test_help_index
+    get '/help/index'
+    assert_equal 200, last_response.status
+    assert_equal true, (last_response.body =~ /help found/) != nil
+  end
+  def test_regular
+    get '/regular'
+    assert_equal 200, last_response.status
+    assert_equal true, (last_response.body =~ /flames/) != nil
+  end
+  def test_all
+    delete '/all'
+    assert_equal 200, last_response.status
+    assert_equal true, (last_response.body =~ /wiped/) != nil
+  end
+  def test_flame
+    put '/flame'
+    assert_equal 200, last_response.status
+    assert_equal true, (last_response.body =~ /heat/) != nil
+  end
+  def test_request
+    get '/request'
+    assert_equal 200, last_response.status
+    assert_equal true, (last_response.body =~ /SCRIPT_NAME/) != nil
+  end
+  def test_post
+    post '/racket'
+    assert_equal 200, last_response.status
+    assert_equal true, (last_response.body =~ /posted/) != nil
+  end
+  def test_arguments
+    get '/take/123'
+    assert_equal 200, last_response.status
+    assert_equal true, (last_response.body =~ /123/) != nil
+  end
+end
+require 'minitest/spec'
+describe  "without defined route block" do
+  include Rack::Test::Methods
+  def app
+    @app = Sinatra::Application
+    @app.set :environment, :test
+    @app
+  end
+  it "should respond to get" do
+    get '/welcome/index'
+    last_response.status.must_equal 200
+    last_response.body.must_match /route test/
+  end
+  it "should respond to put" do
+    put '/welcome/update'
+    last_response.status.must_equal 200
+    last_response.body.must_match /walternet/
+  end
+  it "should respond to post" do
+    post '/welcome/peter'
+    last_response.status.must_equal 200
+    last_response.body.must_match /amber/
+  end
+  it "should respond to delete" do
+    delete '/welcome/universe'
+    last_response.status.must_equal 200
+    last_response.body.must_match /destroy/
+  end
+end

data/test/fixtures/sinatra_application.rb ADDED Viewed

@@ -0,0 +1,86 @@
+require 'sinatra'
+class Sinatra::Application
+  def env
+    @env.update('SCRIPT_NAME' => '/test')
+  end
+end
+require 'sinatra-controllers'
+class Blah < Sinatra::Controller
+  def help
+    @blah = 'message' + params.inspect
+    haml :foo
+  end
+  def test
+    params.inspect
+  end
+  def flames
+    'heat'
+  end
+  def requested
+    request.inspect
+  end
+  def racket
+    'posted'
+  end
+  def everything
+    'wiped'
+  end
+  def fringe
+    @fringe = "Anna Torv"
+    haml :fringe
+  end
+  def take
+    params[:arg]
+  end
+end
+class Help < Sinatra::Controller
+  def help
+    'another help'
+  end
+  def get_index
+    'help found'
+  end
+end
+class Welcome < Sinatra::Controller
+  def get_index
+    'route test'
+  end
+  def put_update
+    'walternet'
+  end
+  def post_peter
+    'amber'
+  end
+  def delete_universe
+    'destroy'
+  end
+end
+Sinatra::Controllers.register(Welcome)
+Sinatra::Controllers.register(Help) do
+  get '/help', :help
+end
+Sinatra::Controllers.register(Blah) do
+  get '/request', :requested
+  get '/', :help
+  get '/test/:id', :test
+  post '/racket', :racket
+  put '/flame', :flames
+  delete '/all', :everything
+  get '/fringe', :fringe
+  get '/take/:arg', :take
+end
+# regular paths should work too
+get '/regular' do
+  'flames'
+end

data/test/fixtures/views/foo.haml ADDED Viewed

@@ -0,0 +1,9 @@
+!!!
+%html
+  %head
+    %meta(http-equiv="content-type" content="text/html; charset=utf-8")
+    %title test
+  %body
+    test
+    =@blah

data/test/fixtures/views/fringe.haml ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ bishop
2	+ = @fringe

data/test/watchr.rb ADDED Viewed

@@ -0,0 +1,4 @@
+watch('test/.*_test.*') {|md| system "rake test"}
+watch('test/*') {|md| system "rake test"}
+watch('lib/*') {|md| system "rake test"}

metadata ADDED Viewed

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-controllers
+version: !ruby/object:Gem::Version
+  prerelease: false
+  segments:
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Bretoi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-04-02 00:00:00 -07:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency
+  name: minitest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        segments:
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency
+  name: watchr
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Adds controllers to Sinatra
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/sinatra-controllers.rb
+- lib/sinatra-controllers/version.rb
+- sinatra-controllers.gemspec
+- test/controller_test.rb
+- test/fixtures/sinatra_application.rb
+- test/fixtures/views/foo.haml
+- test/fixtures/views/fringe.haml
+- test/watchr.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/sinatra-controllers
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      segments:
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+rubyforge_project: sinatra-controllers
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: Adds controllers to Sinatra
+test_files:
+- test/controller_test.rb
+- test/fixtures/sinatra_application.rb
+- test/fixtures/views/foo.haml
+- test/fixtures/views/fringe.haml
+- test/watchr.rb