rspec_api_docs 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3a6353f8e992283d35976b79f700f89bb288190
-  data.tar.gz: 11e539b4e35b9b9d5fe99f27cc4217c9ddbede47
+  metadata.gz: a6608a92ab8b58f6d615540b792ec5a79c804f90
+  data.tar.gz: f67f1c4b85651e2a6f29faa8c840192e3e0a35df
 SHA512:
-  metadata.gz: 3699d25bf8194de10124fa7009bd44290b4a1f9397153fab79553591f091d5f6174c79fd2ad719a2067318bc42279cbc7d8351eee4bbd1fa632c060c66c1b6db
-  data.tar.gz: f7a1d04367e61049031b464b065788930238dee1a3a3307cc54dbc153abe52a230ddc34f2c7716ff299a83e87d73d3e4ffa8009668b2310289229bddfc04083e
+  metadata.gz: 8931352c6f2acdb4ae0ad78823a752ce10a20bc0beac529b7d4f2dac9824da6da4357abad51ad9b07c48495796933d75d7525ea7df9e46c658cb46a9a3e7d653
+  data.tar.gz: da88f8e0d83089f4cfaefa4e04ab8fe042e423a8bebbef29de807103c68d1b2901d8fdbaebb4416ecf241c1014b18b0b266a6a8ceb4c1349d8ff6381eac7f90d

data/README.md

@@ -1,8 +1,8 @@
 # RspecApiDocs
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec_api_docs`. To experiment with that code, run `bin/console` for an interactive prompt.
+Use RspecApiDocs to generate API documentation from your RSpec tests.
 
-TODO: Delete this and the text above, and describe your gem
+**This gem is still a work in progress.**
 
 ## Installation
 
@@ -22,13 +22,9 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To generate documentation, just run your API tests. eg:
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    $ rspec spec/controllers/api/
 
 ## Contributing
 

data/lib/rspec_api_docs/version.rb

@@ -1,3 +1,3 @@
 module RspecApiDocs
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/lib/rspec_api_docs.rb

@@ -5,7 +5,7 @@ require "rspec_api_docs/dir"
 RSpec.configure do |config|
   config.before(:suite) do
     files_to_run = config.instance_variable_get(:@files_or_directories_to_run)
-    next unless files_to_run == ["test/controllers/api/"]
+    next unless files_to_run == ["spec/controllers/api/"]
 
     api_docs_folder_path = RspecApiDocs::Dir.find_or_create_api_docs_folder_in(Rails.root)
 
@@ -17,7 +17,7 @@ RSpec.configure do |config|
     begin
       # exit unless this is under api/v*
       files_to_run = config.instance_variable_get(:@files_or_directories_to_run)
-      next unless files_to_run == ["test/controllers/api/"]
+      next unless files_to_run == ["spec/controllers/api/"]
       next unless example.metadata[:file_path].match(/api\/v\d*/)
       next unless request && request.try(:symbolized_path_parameters)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_docs
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Tom Kadwill
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-25 00:00:00.000000000 Z
+date: 2016-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Generate API blueprint docs when running Rspec