sinatra-rake-routes 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d5ce5982072c93d1f8ea2a3f091e1a0dab7effd
-  data.tar.gz: 455143d3f9b4908901fe57bb8bcc12d4e36b1960
+  metadata.gz: 407b7955269b5c168134db5d9281869200d38d11
+  data.tar.gz: d5e39656762c0dede87e9589aa7cfe0fb76164e1
 SHA512:
-  metadata.gz: 15bb3d4f668108a439caa03d78edde3f515085595f9960cb649c9d8f866919c5e841debbaf6859aca19495ebbd4484005e1414378c65496d026188559792da35
-  data.tar.gz: 099ee3bfed991ead6f90a05e5d17c1eec290577182ac2e64428b3d6ad5022c811bdec214df20661b0c47696405833b5cf55f965762a7ce08e4a4e428c5f54d16
+  metadata.gz: a1a174a8a372d2bbae676ea191e2c5e3d74d8cd8a063c5c5552958eb893ebab0c5c6bbb85a32162da3c32659d4e4973915972370a5ecc197e447ff054738a512
+  data.tar.gz: 3294f3f0b7be56e948258183e5ef34c7432d1621faca77493173adf02738e022677bd6d34a770ea694661f1c697d1c2d8dcd3882d4b8dcefc81b5e2c73591fe5

data/README.md

@@ -1,6 +1,6 @@
 # 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
+`rake routes` command for Sinatra applications for printing out all defined routes.
 
 ## Usage
 
@@ -31,23 +31,23 @@ require "sinatra-rake-routes/tasks"
 bundle exec rake routes
 
 POST
-A/users/:user_id/messages\
-A/users\
+/users
+/users/:user_id/messages
 
 GET
-A/users/:user_id/messages/:message_id\
-A/users/:user_id/messages\
-A/users/:user_id\
+/users/:user_id
+/users/:user_id/messages
+/users/:user_id/messages/:message_id
 
 HEAD
-A/users/:user_id/messages/:message_id\
-A/users/:user_id/messages\
-A/users/:user_id\
+/users/:user_id
+/users/:user_id/messages
+/users/:user_id/messages/:message_id
 
 PUT
-A/users/:user_id/messages/:message_id\
-A/users/:user_id\
+/users/:user_id
+/users/:user_id/messages/:message_id
 
 DELETE
-A/users/:user_id\
+/users/:user_id
 ```

data/circle.yml

@@ -0,0 +1,9 @@
+dependencies:
+  override:
+    - 'rvm-exec 1.9.3-p551 bundle install'
+    - 'rvm-exec 2.3.0 bundle install'
+
+test:
+  override:
+    - 'rvm-exec 1.9.3-p551 bundle exec rspec'
+    - 'rvm-exec 2.3.0 bundle exec rspec'

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

@@ -1,6 +1,6 @@
 desc "Print out all defined routes"
 task :routes do
-  puts SinatraRakeRoutes.output
+  puts SinatraRakeRoutes.new.to_s
 end
 
 if Rake::Task.task_defined?("configure_routes")

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

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

data/lib/sinatra-rake-routes.rb

@@ -4,6 +4,14 @@ require 'sinatra-rake-routes/version'
 class SinatraRakeRoutes
   @@app_class = nil
 
+  # Sinatra compiles routes into regexes. See below link for how this works:
+  # https://github.com/sinatra/sinatra/blob/4c7d38eb1b2cc02ce51029f28e0c3c34ca12ccfd/lib/sinatra/base.rb#L1618
+  # The below regexes cover some of the common cases.
+  HYPHEN_REGEX = /(?:\-|%2[Dd])/
+  NAMED_PARAM_REGEX_SOURCE = "([^\/?#]+)"
+  PERIOD_REGEX = /(?:\.|%2[Ee])/
+  SPLAT_REGEX = /(.*?)/
+
   def self.set_app_class(klass)
     if klass.respond_to?(:routes) && klass.routes.is_a?(Hash)
       @@app_class = klass
@@ -16,21 +24,28 @@ class SinatraRakeRoutes
     @@app_class
   end
 
-  def self.output
+  def to_s
     str = []
-    app_routes = app_class.routes
-    app_routes.each_with_index do |(http_method, routes_list), i|
+    self.class.app_class.routes.each do |http_method, routes|
       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
+      routes = routes.map { |route| decompile_route(route) }
       str << routes.sort.join("\n") + "\n"
     end
     str.join("\n")
   end
+
+  private
+
+  def decompile_route(route)
+    source = route[0].source
+    params = route[1]
+    source.gsub!(HYPHEN_REGEX.source, "-")
+    source.gsub!(PERIOD_REGEX.source, ".")
+    source.gsub!(SPLAT_REGEX.source, "*")
+    params.each do |param|
+      source.sub!(NAMED_PARAM_REGEX_SOURCE, ":#{param}")
+    end
+    # Remove leading "\A" and trailing "\z"
+    source[2...-2]
+  end
 end

data/sinatra-rake-routes.gemspec

@@ -9,18 +9,18 @@ Gem::Specification.new do |gem|
   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.description   = %q{Rake command for printing out all defined routes in Sinatra applications}
+  gem.homepage      = %q{https://github.com/wealthsimple/sinatra-rake-routes}
   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.required_ruby_version = ">= 1.9.3"
+  gem.add_dependency "rake", ">= 0"
 
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "rspec-collection_matchers"
-  gem.add_development_dependency "rspec-its"
-  gem.add_development_dependency "sinatra"
+  gem.add_development_dependency "rspec", "~> 3.4"
+  gem.add_development_dependency "sinatra", "~> 1.4"
+  gem.add_development_dependency "rspec_junit_formatter", "~> 0.2"
 end

data/spec/fixtures/sample_app_output.txt

@@ -1,20 +1,24 @@
 POST
-A/users/:user_id/messages\
-A/users\
+/test-hyphenated/:test_id/something
+/users
+/users/*/splat/*
+/users/:user_id/messages
 
 GET
-A/users/:user_id/messages/:message_id\
-A/users/:user_id/messages\
-A/users/:user_id\
+/users.tar.gz
+/users/:user_id
+/users/:user_id/messages
+/users/:user_id/messages/:message_id
 
 HEAD
-A/users/:user_id/messages/:message_id\
-A/users/:user_id/messages\
-A/users/:user_id\
+/users.tar.gz
+/users/:user_id
+/users/:user_id/messages
+/users/:user_id/messages/:message_id
 
 PUT
-A/users/:user_id/messages/:message_id\
-A/users/:user_id\
+/users/:user_id
+/users/:user_id/messages/:message_id
 
 DELETE
-A/users/:user_id\
+/users/:user_id

data/spec/sinatra_rake_routes_spec.rb

@@ -17,10 +17,10 @@ describe SinatraRakeRoutes do
     end
   end
 
-  describe ".output" do
+  describe "#to_s" 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'))
+      expect(described_class.new.to_s).to eq(File.read('./spec/fixtures/sample_app_output.txt'))
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,4 @@
 require 'rspec'
-require 'rspec/collection_matchers'
-require 'rspec/its'
 
 Dir["./spec/support/**/*.rb"].each { |f| require f }
 
@@ -9,12 +7,4 @@ 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

@@ -3,8 +3,14 @@ require 'sinatra'
 class SampleApp < Sinatra::Base
   post '/users' do
   end
+  post '/users/*/splat/*' do
+  end
+  post '/test-hyphenated/:test_id/something' do
+  end
   post '/users/:user_id/messages' do
   end
+  get '/users.tar.gz' do
+  end
   get '/users/:user_id' do
   end
   get '/users/:user_id/messages' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-rake-routes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Peter Graham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-10 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -28,59 +28,45 @@ dependencies:
   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'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.4'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   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
+        version: '0.2'
+description: Rake command for printing out all defined routes in Sinatra applications
 email: peter@wealthsimple.com
 executables: []
 extensions: []
@@ -91,6 +77,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- circle.yml
 - lib/sinatra-rake-routes.rb
 - lib/sinatra-rake-routes/tasks.rb
 - lib/sinatra-rake-routes/version.rb
@@ -100,7 +87,7 @@ files:
 - spec/spec_helper.rb
 - spec/support/sample_app.rb
 - spec/version_spec.rb
-homepage: https://github.com/wealthsimple
+homepage: https://github.com/wealthsimple/sinatra-rake-routes
 licenses:
 - MIT
 metadata: {}
@@ -112,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="