doc_yo_self 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1dca5880b129ed713c81bfecb1ea14cc0b9626d7
-  data.tar.gz: f4f71b07c337878360beaae7bd95704646e39356
+  metadata.gz: 056f07b694b869d21da83aaefdde61b1df7b0a6f
+  data.tar.gz: c97f98b9684cf279095b92c6298ca3cdc74fa8cb
 SHA512:
-  metadata.gz: 0a0163819d7f45e25692402dab3a108487ad1978eae2c8e4b9b8184b9b46e9c2d403af65c07d2394d6baa57d65a93f5f00f43ec885efa1fbf33c540534e3c68d
-  data.tar.gz: d8abe36cc4aec720b51bf12a1136ab9785dab713780c00b45324c7196d79851a09ceee84548b53263b2a8dd2766d996476bcb3f02d9bf84515abb3168ba76f1a
+  metadata.gz: e0ff4c4e2e621ee66b25439e10d151ca8a2d15f98bfa09f52775a99a0b892df84c0e7bf99272f0fa3473573fe5f13302d9686ec1ff8aa7250b0f06b79c8841ba
+  data.tar.gz: 469af588c0345a84f443094aec77b1e571677986ca72db1d6d8ea5000b7199d3367a3470a3d272bc1b84d2cec96091a72254e5f1fd28334cb6f565e926abd9d1

data/README.md

@@ -6,31 +6,40 @@ Time for this project was provided by my employer, [SmashingBoxes](http://smashi
 
 # Limitations
 
- * **Current focus is MiniTest**. Probably will work with Rspec too, but that's not our focus right now.
  * **Probably not thread safe**. Thread safety isn't a focus for this project right now. Pull requests welcome :-).
 
 
 ## Setup
 
+In your gemfile:
+`gem 'doc_yo_self', group: :test`
+
+In  `test_helper.rb`:
 ```ruby
 DocYoSelf.config do |c|
   c.template_file = 'test/template.md.erb'
-  c.output        = 'api_docs.md'
+  c.output_file   = 'api_docs.md'
 end
 ```
 
+See test/fake_template.md for template examples.
+
 To run doc generation after every controller spec, put this into your `teardown` method. Or whatever method your test framework of choice will run after *every test*.
 
+## For Minitest Folks
+
 ```ruby
-def teardown
-  DocYoSelf.run!
-end 
+class ActionController::TestCase < ActiveSupport::TestCase
+  def teardown
+    DocYoSelf.run!(request, response)
+  end
+end
 ```
 
 Then put this at the bottom of your `test_helper.rb`:
 
 ```ruby
-DocYoSelf.finish!
+MiniTest::Unit.after_tests { DocYoSelf.finish! }
 ```
 
 Or put it individually into only certain tests...
@@ -39,10 +48,25 @@ Or put it individually into only certain tests...
 def test_some_api
   get :index, :users
   assert response.status == 200
-  DocYoSelf.run!
+  DocYoSelf.run!(request, response)
+end
+```
+
+## For RSpec Folks
+
+Put this in your `spec_helper` and smoke it.
+
+```ruby
+RSpec.configure do |config|
+  config.after(:each, type: :controller) do
+    DocYoSelf.run!(request, response)
+  end
+
+  config.after(:suite) { DocYoSelf.finish! }
 end
 ```
 
+
 ## Usage
 
 It will log all requests and responses by default, but you can add some **optional** parameters as well.

data/doc_yo_self.gemspec

@@ -5,11 +5,15 @@ Gem::Specification.new do |s|
   s.description = "An automatic API documentation generator."
   s.email = 'rick.carlino@gmail.com'
   s.files = `git ls-files`.split("\n")
-  s.homepage = 'https://github.com/rickcarlino/doc_yo_self'
+  s.homepage = 'https://github.com/RickCarlino/smarf_doc'
   s.license = 'MIT'
   s.name = 'doc_yo_self'
   s.require_paths = ['lib']
   s.summary = "Uses your test cases to write example documentation for your API."
   s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.version = '0.0.1'
-end
+  s.version = '0.0.2'
+  s.post_install_message = "DocYoSelf is now SmarfDoc. Please consider "\
+                           "updating your Gemfile to the supported version for"\
+                           " continued updates and support. "\
+                           "https://github.com/RickCarlino/smarf_doc"
+end

data/test/fake_template.md

@@ -4,4 +4,3 @@ You can use ERB to format each test case.
 <%= request.params %>
 <%= response.body %>
 <%= note %>
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: doc_yo_self
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Rick Carlino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-29 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies: []
 description: An automatic API documentation generator.
 email: rick.carlino@gmail.com
@@ -16,10 +16,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - README.md
 - Rakefile
 - api_docs.md
+- doc_yo_self-0.0.1.gem
 - doc_yo_self.gemspec
 - documentation.md
 - lib/base.rb
@@ -32,22 +33,23 @@ files:
 - test/test_config.rb
 - test/test_helper.rb
 - test/test_test_case.rb
-homepage: https://github.com/rickcarlino/doc_yo_self
+homepage: https://github.com/RickCarlino/smarf_doc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: DocYoSelf is now SmarfDoc. Please consider updating your Gemfile
+  to the supported version for continued updates and support. https://github.com/RickCarlino/smarf_doc
 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: []