grape-raketasks 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54f52266aea4d335c644a785522633a0c1f67de3
-  data.tar.gz: 35edad40355fc1e36d4051bbdd5c1ee7cfbe4180
+  metadata.gz: b36e73fad304800dd400fb2778fdfb7a92aaec3f
+  data.tar.gz: 37f8ca1dd7db650aed3b777dd90b3df0a531ff6e
 SHA512:
-  metadata.gz: 1cb39671ddf1853690fe2c3aeeb9c90791438558ee6e79122ec00c9e7a717a0f699fbdeef98dbf9ffd331ece12d47e0f594393c5322eea119ea64a1f1f42686e
-  data.tar.gz: 8e6a2769fdf071b3185dc3557bc6367273fb327c40b643631d8a50ba606c85047447182752b9e6ed11870f0414867a42d82d05aa0e9db96b963218086781d973
+  metadata.gz: 9a7d2ef78f84c8461a664c374eace6762716f06d8a25066f4d412e082ea08975bc5be25b7df94bf718a59550fde89cb4c6fd4381500586e57917675b679d80be
+  data.tar.gz: 1dd7e4e72181f900a4b4894cdbf0e91910e6fe1db1d592cf0504fc83d6acd543e827c68b2cf7ed3e6a68238ddafdc38cc2d9dca90c74b96fa347f6dec70715fb

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format=documentation

data/.rubocop.yml

@@ -0,0 +1,22 @@
+AllCops:
+  Exclude:
+    - vendor/**/*
+    - bin/**/*
+
+Documentation:
+  Enabled: false
+
+LineLength:
+  Enabled: false
+
+MethodLength:
+  Enabled: true
+
+ClassLength:
+  Enabled: false
+
+FileName:
+  Enabled: false
+
+Encoding:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - ruby-head
+  - 2.1.1
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'rubocop', '0.22.0'

data/README.md

@@ -2,6 +2,8 @@
 
 Rake tasks to ease the development and debugging of Grape APIs.
 
+[![Build Status](https://travis-ci.org/reprah/grape-raketasks.svg)](https://travis-ci.org/reprah/grape-raketasks)
+
 ## Available Tasks
 
 ### Routes
@@ -10,15 +12,27 @@ Rake tasks to ease the development and debugging of Grape APIs.
 
 #### Filtering
 
-If you want to see routes belonging to only one API, pass an environment variable set to your API name in snake-case after writing the task. For example, if I wanted to view only routes belonging to my Grape API named CatPictures, I'd execute `rake grape_raketasks:routes GRAPE_API=cat_pictures`.
+If you want to see routes belonging to only one API:
+
+Pass an environment variable set to your API name after writing the task. Given the API below, and assuming we only want to see routes belonging to this CatPictures API...
+
+```ruby
+module CatPictures
+  class API < Grape::API
+    # API stuff
+  end
+end
+```
+
+I'd execute `rake grape_raketasks:routes API=CatPictures::API`. Notice how we have to list which constants the API is nested in (if any), separated by a double colon, like in Ruby code.
 
 ## Installation
 
-1.) grape-raketasks isn't served on Rubygems yet. Reference this repository, or your own fork, from a Gemfile:
+1.) Add `grape-raketasks` to your Gemfile:
 
 ```ruby
 # Gemfile
-gem 'grape-raketasks', git: 'git://github.com/reprah/grape-raketasks'
+gem 'grape-raketasks'
 ```
 
 2.) Install the gem via Bundler:
@@ -26,7 +40,11 @@ gem 'grape-raketasks', git: 'git://github.com/reprah/grape-raketasks'
 ```shell
 $ bundle install
 ```
-If you don't want to use Bundler, follow the [instructions here](http://ruby.about.com/od/advancedruby/a/gitgem.htm).
+or on the command line:
+
+```shell
+$ gem install grape-raketasks
+```
 
 3.) If your Grape APIs are defined in a Sinatra or Rack web application, you need to write a rake task called `:environment`that loads the application's environment first. This gem's tasks are dependent on it. You could put this in the root of your project directory:
 
@@ -34,7 +52,7 @@ If you don't want to use Bundler, follow the [instructions here](http://ruby.abo
 # Rakefile
 
 require 'rake'
-require 'bundler' 
+require 'bundler'
 Bundler.setup
 require 'grape-raketasks'
 require 'grape-raketasks/tasks'
@@ -52,17 +70,12 @@ Rails applications with mounted Grape APIs don't require an extra step here.
 
 ## Contributing
 
-1.) Fork it
-
-2.) Create your feature branch (`git checkout -b my-new-feature`)
-
-3.) Write specs for your feature
-
-4.) Commit your changes (`git commit -am 'Add some feature'`)
-
-5.) Push to the branch (`git push origin my-new-feature`)
-
-6.) Create a new pull request
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write specs for your feature
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new pull request
 
 ## License
 

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup :default, :test, :development
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :spec
+
+require 'rainbow/ext/string' unless String.respond_to?(:color)
+require 'rubocop/rake_task'
+Rubocop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/grape-raketasks.gemspec

@@ -2,7 +2,7 @@ require File.dirname(__FILE__) + '/lib/grape-raketasks/version'
 
 Gem::Specification.new do |gem|
   gem.name        = 'grape-raketasks'
-  gem.version     = GrapeRakeTasks::VERSION 
+  gem.version     = GrapeRakeTasks::VERSION
 
   gem.homepage    = 'https://github.com/reprah/grape-raketasks'
   gem.license     = 'MIT'
@@ -10,13 +10,12 @@ Gem::Specification.new do |gem|
   gem.description = 'Provides rake tasks to ease the development and debugging of Grape APIs.'
   gem.author      = 'H. Henn'
 
-  gem.files = `git ls-files`.split($\)
+  gem.files = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.test_files = gem.files.grep(/^spec/)
 
-  gem.add_runtime_dependency     'grape'
-  gem.add_runtime_dependency     'rake'
-  gem.add_runtime_dependency     'activesupport'
+  gem.add_runtime_dependency 'grape'
+  gem.add_runtime_dependency 'rake'
+  gem.add_runtime_dependency 'activesupport'
 
   gem.add_development_dependency 'rspec'
 end
-

data/lib/grape-raketasks/console_formatter.rb

@@ -12,14 +12,19 @@ module GrapeRakeTasks
       buffer.join << "\n\n"
     end
 
-    def construct_output(routes)
+    def construct_output(routes, filter = nil)
       if routes.any?
-        buffer << routes.map { |r| format_route(r) }.join("\n\n")
+        buffer << formatted_routes(routes)
       else
-        buffer << no_routes_message
+        buffer << no_routes_message(filter)
       end
     end
 
+    def formatted_routes(routes)
+      formatted = routes.map { |r| format_route(r) }
+      formatted.join("\n\n")
+    end
+
     def format_route(route)
       opts = route.options
       # two characters (colon + space) after the title
@@ -43,12 +48,12 @@ module GrapeRakeTasks
       key.to_s.upcase.concat(': ')
     end
 
-    def no_routes_message
+    def no_routes_message(filter)
+      subject = filter ? filter : 'your application'
       <<-MSG.strip_heredoc
-        You don't have any Grape routes defined!
+        You don't have any Grape routes defined for #{subject}.
         Visit https://github.com/intridea/grape for help.
       MSG
     end
   end
 end
-

data/lib/grape-raketasks/processor.rb

@@ -10,15 +10,25 @@ module GrapeRakeTasks
 
     def format(formatter, filter = nil)
       routes_to_display = filter_by_api(filter)
-      formatter.construct_output(routes_to_display)
+      formatter.construct_output(routes_to_display, filter)
       formatter.result
     end
 
     def filter_by_api(filter = nil)
       return routes unless filter
-      filter_as_class = "#{filter.camelcase}::API"
-      routes.select { |r| r.route_api.to_s == filter_as_class }
+      pattern = Regexp.new(filter, Regexp::IGNORECASE)
+      filtered = routes.select do |r|
+        matches_filter_pattern?(r, pattern)
+      end
+      filtered.uniq
+    end
+
+    private
+
+    def matches_filter_pattern?(route, pattern)
+      # match filter against string representation of a route's API
+      api_as_string = route.route_api.to_s
+      api_as_string.match(pattern)
     end
   end
 end
-

data/lib/grape-raketasks/route.rb

@@ -1,8 +1,10 @@
 require 'active_support/core_ext/class'
 
 # enable adding the API name to a route's options
-class Grape::Route
-  attr_accessor :options
+module Grape
+  class Route
+    attr_accessor :options
+  end
 end
 
 module GrapeRakeTasks
@@ -26,4 +28,3 @@ module GrapeRakeTasks
     end
   end
 end
-

data/lib/grape-raketasks/tasks.rb

@@ -1,2 +1 @@
 load File.expand_path('../../tasks/grape-raketasks.rake', __FILE__)
-

data/lib/grape-raketasks/version.rb

@@ -1,4 +1,3 @@
 module GrapeRakeTasks
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end
-

data/lib/grape-raketasks.rb

@@ -6,4 +6,3 @@ require 'grape-raketasks/console_formatter'
 module GrapeTasks
   require 'grape-raketasks/railtie' if defined?(Rails)
 end
-

data/lib/tasks/grape-raketasks.rake

@@ -1,9 +1,9 @@
 namespace :grape_raketasks do
-  desc 'Print routes provided by Grape APIs to the terminal. Target a specific API with GRAPE_API=x.'
+  desc 'Print routes provided by Grape APIs to the terminal. Target a specific API with API=x.'
   task routes: :environment do
     all_routes = GrapeRakeTasks::Route.all_routes(Grape::API)
-    inspector = GrapeRakeTasks::Processor.new(all_routes)
-    puts inspector.format(GrapeRakeTasks::ConsoleFormatter.new, ENV['GRAPE_API'])
+    processor = GrapeRakeTasks::Processor.new(all_routes)
+    puts processor.format(GrapeRakeTasks::ConsoleFormatter.new, ENV['API'])
   end
 end
 

data/spec/grape-raketasks/console_formatter_spec.rb

@@ -5,19 +5,19 @@ describe GrapeRakeTasks::ConsoleFormatter do
 
   describe '#construct_output' do
     before do
-      formatter.stub(format_route: 'formatted route') 
+      formatter.stub(format_route: 'formatted route')
     end
 
     context 'when routes exist' do
       before do
-        formatter.construct_output(['a route']) 
+        formatter.construct_output(['a route'])
       end
 
       it 'adds formatted routes to the buffer' do
         expect(formatter.buffer).to include('formatted route')
       end
     end
-    
+
     context 'when no routes exist' do
       before do
         formatter.construct_output([])
@@ -25,7 +25,7 @@ describe GrapeRakeTasks::ConsoleFormatter do
 
       it 'adds a message to the buffer' do
         msg = formatter.buffer.first
-        expect(msg).to include("You don't have any Grape routes defined!") 
+        expect(msg).to include("You don't have any Grape routes")
       end
     end
   end
@@ -35,7 +35,7 @@ describe GrapeRakeTasks::ConsoleFormatter do
 
     it 'returns a text representation of a route object' do
       result = formatter.format_route(route_object)
-      expect(result).to match(/METHOD:\s+"GET"/) 
+      expect(result).to match(/METHOD:\s+"GET"/)
     end
   end
 
@@ -49,4 +49,3 @@ describe GrapeRakeTasks::ConsoleFormatter do
     end
   end
 end
-

data/spec/grape-raketasks/processor_spec.rb

@@ -8,16 +8,36 @@ describe GrapeRakeTasks::Processor do
 
     let(:processor) { described_class.new(routes) }
 
-    context 'when given a Grape API to filter by' do
-      let(:filter) { 'sample_api_one' }
-
-      it 'returns only routes belonging to that API' do
+    shared_examples 'successful API filtering' do
+      it 'returns routes belonging to one API' do
         filtered = processor.filter_by_api(filter)
         filtered_apis = filtered.map(&:route_api)
         expect(filtered_apis).to eq [SampleApiOne::API]
       end
     end
 
+    context 'when given a Grape API to filter by' do
+      let(:filter) { 'SampleAPIOne::API' }
+
+      it_behaves_like 'successful API filtering'
+
+      context "when filter's case does not exactly match an API" do
+        let(:filter) { 'SampleApiOne::API' }
+
+        it_behaves_like 'successful API filtering'
+      end
+
+      context 'when API is not nested within another constant' do
+        let(:filter) { 'SampleAPIThree' }
+
+        it 'returns routes belonging to that api' do
+          filtered = processor.filter_by_api(filter)
+          filtered_apis = filtered.map(&:route_api)
+          expect(filtered_apis).to include(SampleApiThree)
+        end
+      end
+    end
+
     context 'when no filter is given' do
       it 'returns routes from every Grape API' do
         unfiltered = processor.filter_by_api
@@ -27,4 +47,3 @@ describe GrapeRakeTasks::Processor do
     end
   end
 end
-

data/spec/grape-raketasks/route_spec.rb

@@ -15,7 +15,7 @@ describe GrapeRakeTasks::Route do
 
     it 'returns a collection of routes that know their parent API' do
       routes = described_class.api_routes(SampleApiOne::API)
-      every_route_has_api = routes.all? { |r| r.options.has_key?(:api) }
+      every_route_has_api = routes.all? { |r| r.options.key?(:api) }
       expect(every_route_has_api).to be_true
     end
   end

data/spec/spec_helper.rb

@@ -2,4 +2,3 @@ require 'grape-raketasks'
 
 # load support files
 Dir.glob(ENV['PWD'] + '/spec/support/*.rb').each { |f| require f }
-

data/spec/support/test_objects.rb

@@ -6,17 +6,19 @@ def grape_route_object
   g
 end
 
-class SampleApiOne
+module SampleApiOne
   class API < Grape::API
   end
 end
 
-class SampleApiTwo < Grape::API
+module SampleApiTwo
   class API < Grape::API
   end
 end
 
-[SampleApiOne::API, SampleApiTwo::API].each do |api|
-  api.routes << grape_route_object
+class SampleApiThree < Grape::API
 end
 
+Grape::API.subclasses.each do |api|
+  api.routes << grape_route_object
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-raketasks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - H. Henn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-25 00:00:00.000000000 Z
+date: 2014-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -73,9 +73,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .rubocop.yml
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
+- Rakefile
 - grape-raketasks.gemspec
 - lib/grape-raketasks.rb
 - lib/grape-raketasks/console_formatter.rb