sinatra-sextant 0.0.1.pre

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format document

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sinatra-sextant.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Uchio KONDO
+
+MIT License
+
+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.md

@@ -0,0 +1,31 @@
+# Sinatra::Sextant
+
+A fancy DSL for Sinatra routing.
+
+Inspired from [sextant gem](https://github.com/schneems/sextant) and [the great Padrino](https://github.com/padrino/padrino-framework), with [Rake](https://github.com/jimweirich/rake)-ish syntax.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-sextant'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-sextant
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rspec_opts = ['--color', '-fs']
+  end
+rescue LoadError => e
+  $stderr.puts "rspec/core is missing"
+end
+
+task :default => [:spec]

data/dot.rvmrc

@@ -0,0 +1 @@
+rvm use ruby-1.9.3-p327@sinatra-sextant

data/example/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+gem 'sinatra'
+gem 'sinatra-sextant', path: '../'

data/example/app.rb

@@ -0,0 +1,14 @@
+require 'sinatra'
+require 'sinatra-sextant'
+
+desc "Sample routing"
+get '/' do
+  content_type :html
+  "<a href=\"/sinatra/routes\">check it out</a>"
+end
+
+desc "Sample routing ver 2"
+params :id, "ID for foo bar"
+get '/:id' do
+  "wow"
+end

data/lib/sinatra-sextant.rb

@@ -0,0 +1 @@
+require 'sinatra/sextant'

data/lib/sinatra/sextant.rb

@@ -0,0 +1,45 @@
+require 'sinatra/base'
+require 'sinatra/sextant/version'
+require 'sinatra/sextant/route_description'
+require 'sinatra/sextant/the_route'
+
+module Sinatra
+  module Sextant
+    class InvalidDescriptionDSLError < StandardError
+    end
+
+    def desc(text)
+      @current_routing_definition = RouteDescription.new
+      @current_routing_definition.desc = text
+    end
+
+    def params(name, text=nil)
+      raise InvalidDescriptionDSLError, "params must be put after desc section" unless @current_routing_definition
+      @current_routing_definition.params << [name.to_sym, text]
+    end
+
+    def route(verb, path, *args, &blk)
+      if @current_routing_definition
+        @current_routing_definition.method_verb = verb
+        @current_routing_definition.path = path
+        self.detailed_routes << @current_routing_definition
+        @current_routing_definition = nil
+      end
+      super(verb, path, *args, &blk)
+    end
+
+    def detailed_routes
+      @detailed_routes ||= []
+    end
+
+    def self.registered(base)
+      base.register TheRoute
+    end
+  end
+
+  module Delegator # add methods to delegate
+    delegate :desc, :params
+  end
+
+  register Sextant
+end

data/lib/sinatra/sextant/route_description.rb

@@ -0,0 +1,11 @@
+require 'sinatra/base'
+module Sinatra::Sextant
+  ##
+  # Value object for route description
+  class RouteDescription
+    def initialize(options={})
+      @params ||= []
+    end
+    attr_accessor :desc, :params, :path, :method_verb
+  end
+end

data/lib/sinatra/sextant/the_route.rb

@@ -0,0 +1,30 @@
+require 'sinatra/base'
+module Sinatra::Sextant
+  module TheRoute
+    TEMPLATE = File.read(File.expand_path("../../templates/routes.html.erb", File.dirname(__FILE__)))
+    class << self
+      def registered(base)
+        base.helpers do
+          def build_routes(routes)
+            labels = {
+              :method_verb => "VERB",
+              :path => "PATH",
+              :desc => "DESCRIPTION",
+            }
+            width = %w(method_verb path desc).each_with_object({}) { |field, dest|
+              dest[field.to_sym] = (routes.map{|r| r.send(field).length } + [labels[field.to_sym].length]).max
+            }
+            format = "%#{width[:method_verb]}s %-#{width[:path]}s %s"
+            ([format % labels.values_at(:method_verb, :path, :desc)] +
+             routes.map{|r| format % [r.method_verb, r.path, r.desc] }).
+              join("\n")
+          end
+        end
+
+        base.get '/sinatra/routes' do
+          erb TEMPLATE, :locals => {:routes => build_routes(base.detailed_routes)}
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/sextant/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Sextant
+    VERSION = "0.0.1.pre"
+  end
+end

data/lib/templates/routes.html.erb

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <title>Routes</title>
+  <style>
+    body { background-color: #fff; color: #333; }
+
+    body, p, ol, ul, td {
+      font-family: helvetica, verdana, arial, sans-serif;
+      font-size: 13px;
+      line-height: 18px;
+    }
+
+    pre {
+      background-color: #eee;
+      padding: 10px;
+      font-size: 11px;
+      white-space: pre-wrap;
+    }
+
+    a { color: #000; }
+    a:visited { color: #666; }
+    a:hover { color: #fff; background-color:#000; }
+  </style>
+  </head>
+<body>
+
+<h2>
+  Routes
+</h2>
+
+<p>
+  Routes match in priority from top to bottom
+</p>
+
+<pre id='route_table'>
+<%= routes %>
+</pre>
+
+</body>
+</html>

data/sinatra-sextant.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/sextant/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sinatra-sextant"
+  gem.version       = Sinatra::Sextant::VERSION
+  gem.authors       = ["Uchio KONDO"]
+  gem.email         = ["udzura@udzura.jp"]
+  gem.description   = %q{A fancy DSL for Sinatra routing}
+  gem.summary       = %q{A fancy DSL for Sinatra routing}
+  gem.homepage      = "https://github.com/udzura/sinatra-sextant"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'sinatra', '>= 1.3.0'
+  gem.add_development_dependency 'rspec', '>= 2.10'
+  gem.add_development_dependency 'rack-test', '>= 0'
+  gem.add_development_dependency 'sinatra-contrib', '>= 0'
+  gem.add_development_dependency 'pry', '>= 0'
+end

data/spec/sinatra/sextant_added_routes_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Sinatra::Sextant do
+  describe 'should add a route for checking defined routes' do
+    before do
+      mock_app do
+        register Sinatra::Sextant
+        desc "Showing foo info for :id"
+        params :id, "ID for foo"
+        get '/users/:id' do
+          "Hello"
+        end
+      end
+      get '/sinatra/routes'
+    end
+
+    it 'should define `GET /sinatra/routes`' do
+      last_response.should be_ok
+    end
+
+    it 'should render a built-in template' do
+      last_response.body.should =~ /<!DOCTYPE html>/
+    end
+
+    it 'should render routes defined' do
+      last_response.body.should include "GET", "/users/:id", "Showing foo info for :id"
+    end
+  end
+end
+

data/spec/sinatra/sextant_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'pry'
+
+describe Sinatra::Sextant do
+  it { should be }
+
+  describe 'routing DSL' do
+    before do
+      mock_app do
+        register Sinatra::Sextant
+        desc "Showing foo info for :id"
+        params :id, "ID for foo"
+        get '/users/:id' do
+          "Hello"
+        end
+      end
+    end
+
+    #it { binding.pry }
+    specify { raw_app.ancestors.should include Sinatra::Base }
+    describe "routes defined by 2, 1 default with an application specific route" do
+      specify { raw_app.routes["GET"].should have(1 + 1).item }
+      specify { raw_app.routes["HEAD"].should have(1 + 1).item }
+    end
+    specify { raw_app.detailed_routes.should have(1).item }
+    it "should not break defining routes" do
+      get '/users/1'
+      last_response.should be_ok
+      last_response.body.should == "Hello"
+    end
+
+    describe '#detailed_routes.first' do
+      subject { raw_app.detailed_routes.first }
+      its(:desc) { should == "Showing foo info for :id"}
+      its(:params) { should have(1).item }
+      its("params.first") { should == [:id, "ID for foo"] }
+      its(:path) { should == '/users/:id' }
+      its(:method_verb) { should == "GET" }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rack/test'
+require 'sinatra/base'
+require 'sinatra/test_helpers'
+require 'sinatra-sextant'
+
+module Sinatra::Sextant::TestingHelpers
+  def raw_app
+    @app
+  end
+end
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  #config.include Rack::Test::Methods
+  config.include Sinatra::TestHelpers
+  config.include Sinatra::Sextant::TestingHelpers
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-sextant
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+  prerelease: 6
+platform: ruby
+authors:
+- Uchio KONDO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-15 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: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.10'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A fancy DSL for Sinatra routing
+email:
+- udzura@udzura.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dot.rvmrc
+- example/Gemfile
+- example/app.rb
+- lib/sinatra-sextant.rb
+- lib/sinatra/sextant.rb
+- lib/sinatra/sextant/route_description.rb
+- lib/sinatra/sextant/the_route.rb
+- lib/sinatra/sextant/version.rb
+- lib/templates/routes.html.erb
+- sinatra-sextant.gemspec
+- spec/sinatra/sextant_added_routes_spec.rb
+- spec/sinatra/sextant_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/udzura/sinatra-sextant
+licenses: []
+post_install_message: 
+rdoc_options: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A fancy DSL for Sinatra routing
+test_files:
+- spec/sinatra/sextant_added_routes_spec.rb
+- spec/sinatra/sextant_spec.rb
+- spec/spec_helper.rb
+has_rdoc: