sinatra-rake-routes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d5ce5982072c93d1f8ea2a3f091e1a0dab7effd
+  data.tar.gz: 455143d3f9b4908901fe57bb8bcc12d4e36b1960
+SHA512:
+  metadata.gz: 15bb3d4f668108a439caa03d78edde3f515085595f9960cb649c9d8f866919c5e841debbaf6859aca19495ebbd4484005e1414378c65496d026188559792da35
+  data.tar.gz: 099ee3bfed991ead6f90a05e5d17c1eec290577182ac2e64428b3d6ad5022c811bdec214df20661b0c47696405833b5cf55f965762a7ce08e4a4e428c5f54d16

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Wealthsimple
+
+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,53 @@
+# sinatra-rake-routes [![Circle CI](https://circleci.com/gh/wealthsimple/sinatra-rake-routes.svg?style=svg)](https://circleci.com/gh/wealthsimple/sinatra-rake-routes)
+
+`rake routes` command for Sinatra applications
+
+## Usage
+
+Install by adding the following to your Gemfile:
+
+```ruby
+gem 'sinatra-rake-routes'
+```
+
+Add the below code to your Rakefile. Make sure to  require `sinatra-rake-routes/tasks` *after* the `:configure_routes` task is defined, otherwise it won't be picked up correctly.
+
+```ruby
+# Rakefile
+
+task :configure_routes do
+  require "sinatra-rake-routes"
+  # Tell SinatraRakeRoutes what your Sinatra::Base application class is called:
+  require './my_app'
+  SinatraRakeRoutes.set_app_class(MyApp)
+end
+
+require "sinatra-rake-routes/tasks"
+```
+
+## Example output
+
+```
+bundle exec rake routes
+
+POST
+A/users/:user_id/messages\
+A/users\
+
+GET
+A/users/:user_id/messages/:message_id\
+A/users/:user_id/messages\
+A/users/:user_id\
+
+HEAD
+A/users/:user_id/messages/:message_id\
+A/users/:user_id/messages\
+A/users/:user_id\
+
+PUT
+A/users/:user_id/messages/:message_id\
+A/users/:user_id\
+
+DELETE
+A/users/:user_id\
+```

data/lib/sinatra-rake-routes.rb

@@ -0,0 +1,36 @@
+require 'rake'
+require 'sinatra-rake-routes/version'
+
+class SinatraRakeRoutes
+  @@app_class = nil
+
+  def self.set_app_class(klass)
+    if klass.respond_to?(:routes) && klass.routes.is_a?(Hash)
+      @@app_class = klass
+    else
+      raise "#{klass} does not appear to be a valid Sinatra Application"
+    end
+  end
+
+  def self.app_class
+    @@app_class
+  end
+
+  def self.output
+    str = []
+    app_routes = app_class.routes
+    app_routes.each_with_index do |(http_method, routes_list), i|
+      str << http_method
+      routes = []
+      routes_list.each do |item|
+        source = item[0].source
+        item[1].each do |s|
+          source.sub!(/\(.+?\)/, ':'+s)
+        end
+        routes << source[1...-1]
+      end
+      str << routes.sort.join("\n") + "\n"
+    end
+    str.join("\n")
+  end
+end

data/lib/sinatra-rake-routes/tasks.rb

@@ -0,0 +1,8 @@
+desc "Print out all defined routes"
+task :routes do
+  puts SinatraRakeRoutes.output
+end
+
+if Rake::Task.task_defined?("configure_routes")
+  Rake::Task["routes"].enhance(["configure_routes"])
+end

data/lib/sinatra-rake-routes/version.rb

@@ -0,0 +1,3 @@
+class SinatraRakeRoutes
+  VERSION = "0.0.1"
+end

data/sinatra-rake-routes.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sinatra-rake-routes/version"
+
+Gem::Specification.new do |gem|
+  gem.name = %q{sinatra-rake-routes}
+  gem.version = SinatraRakeRoutes::VERSION
+  gem.author = "Peter Graham"
+  gem.summary = %q{`rake routes` command for Sinatra applications}
+  gem.email = %q{peter@wealthsimple.com}
+  gem.description   = %q{Rails' `rake routes` command for Sinatra applications}
+  gem.homepage      = %q{https://github.com/wealthsimple}
+  gem.files         = `git ls-files`.split("\n")
+  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.licenses      = ["MIT"]
+
+  gem.add_dependency "rake"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec-collection_matchers"
+  gem.add_development_dependency "rspec-its"
+  gem.add_development_dependency "sinatra"
+end

data/spec/fixtures/sample_app_output.txt

@@ -0,0 +1,20 @@
+POST
+A/users/:user_id/messages\
+A/users\
+
+GET
+A/users/:user_id/messages/:message_id\
+A/users/:user_id/messages\
+A/users/:user_id\
+
+HEAD
+A/users/:user_id/messages/:message_id\
+A/users/:user_id/messages\
+A/users/:user_id\
+
+PUT
+A/users/:user_id/messages/:message_id\
+A/users/:user_id\
+
+DELETE
+A/users/:user_id\

data/spec/sinatra_rake_routes_spec.rb

@@ -0,0 +1,26 @@
+describe SinatraRakeRoutes do
+  describe ".set_app_class" do
+    context "with valid Sinatra::Base subclass" do
+      it "sets app class" do
+        expect(described_class.app_class).to be_nil
+
+        described_class.set_app_class(SampleApp)
+        expect(described_class.app_class).to eq(SampleApp)
+      end
+    end
+
+    context "with an invalid class supplied" do
+      it "raises an error" do
+        expect { described_class.set_app_class(Array) }.
+          to raise_error("Array does not appear to be a valid Sinatra Application")
+      end
+    end
+  end
+
+  describe ".output" do
+    it "outputs routes" do
+      described_class.set_app_class(SampleApp)
+      expect(described_class.output).to eq(File.read('./spec/fixtures/sample_app_output.txt'))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rspec'
+require 'rspec/collection_matchers'
+require 'rspec/its'
+
+Dir["./spec/support/**/*.rb"].each { |f| require f }
+
+require './lib/sinatra-rake-routes'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/sample_app.rb

@@ -0,0 +1,20 @@
+require 'sinatra'
+
+class SampleApp < Sinatra::Base
+  post '/users' do
+  end
+  post '/users/:user_id/messages' do
+  end
+  get '/users/:user_id' do
+  end
+  get '/users/:user_id/messages' do
+  end
+  get '/users/:user_id/messages/:message_id' do
+  end
+  put '/users/:user_id/messages/:message_id' do
+  end
+  put '/users/:user_id' do
+  end
+  delete '/users/:user_id' do
+  end
+end

data/spec/version_spec.rb

@@ -0,0 +1,5 @@
+describe SinatraRakeRoutes do
+  it "has a version" do
+    expect(SinatraRakeRoutes::VERSION).to be_a(String)
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-rake-routes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Peter Graham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails' `rake routes` command for Sinatra applications
+email: peter@wealthsimple.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- lib/sinatra-rake-routes.rb
+- lib/sinatra-rake-routes/tasks.rb
+- lib/sinatra-rake-routes/version.rb
+- sinatra-rake-routes.gemspec
+- spec/fixtures/sample_app_output.txt
+- spec/sinatra_rake_routes_spec.rb
+- spec/spec_helper.rb
+- spec/support/sample_app.rb
+- spec/version_spec.rb
+homepage: https://github.com/wealthsimple
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: "`rake routes` command for Sinatra applications"
+test_files:
+- spec/fixtures/sample_app_output.txt
+- spec/sinatra_rake_routes_spec.rb
+- spec/spec_helper.rb
+- spec/support/sample_app.rb
+- spec/version_spec.rb