api_docs 1.0.1 → 1.0.2

data/README.md

@@ -90,9 +90,15 @@ ApiDocs.configure do |config|
   # controller that ApiDocs controller inherits from.
   # Useful for hiding it behind admin controller.
   config.base_controller = 'ApplicationController'
+  
+  # Remove doc files before running tests. False by default.
+  config.reload_docs_folder = false
 end
 ```
 
+
+![Api Docs Example](https://github.com/twg/api_docs/raw/master/doc/screenshot.png)
+
 ---
 
 Copyright 2012 Oleg Khabarov, Jack Neto, [The Working Group, Inc](http://twg.ca)

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/api_docs.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "api_docs"
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Oleg Khabarov", "Jack Neto", "The Working Group Inc."]
-  s.date = "2012-09-14"
+  s.date = "2012-09-24"
   s.description = "Generate API documentation using integration tests in Ruby on Rails 3"
   s.email = "jack@twg.ca"
   s.extra_rdoc_files = [
@@ -30,10 +30,12 @@ Gem::Specification.new do |s|
     "app/views/api_docs/docs/_request_params.html.erb",
     "app/views/api_docs/docs/index.html.erb",
     "config/routes.rb",
+    "doc/screenshot.png",
     "lib/api_docs.rb",
     "lib/api_docs/configuration.rb",
     "lib/api_docs/engine.rb",
     "lib/api_docs/test_helper.rb",
+    "lib/tasks/api_docs.rake",
     "script/rails",
     "test/api_docs_test.rb",
     "test/docs_controller_test.rb",

data/lib/api_docs/configuration.rb

@@ -9,11 +9,15 @@ class ApiDocs::Configuration
   # Array of ignored attributes. Attributes that don't really change
   # the content like timestamps.
   attr_accessor :ignored_attributes
+  
+  # Remove doc files before running tests. False by default.
+  attr_accessor :reload_docs_folder
     
   # Configuration defaults
   def initialize
     @docs_path          = Rails.root.join('doc/api')
     @base_controller    = 'ApplicationController'
     @ignored_attributes = %w(created_at updated_at)
+    @reload_docs_folder = false
   end
 end

data/lib/tasks/api_docs.rake

@@ -0,0 +1,9 @@
+namespace :test do
+  task :prepare => :environment do
+    if ApiDocs.config.reload_docs_folder
+      Dir["#{ApiDocs.config.docs_path}/*.yml"].each do |file| 
+        FileUtils.rm file
+      end
+    end
+  end
+end

data/test/api_docs_test.rb

@@ -11,5 +11,6 @@ class ApiDocsTest < ActiveSupport::TestCase
     assert config.docs_path
     assert_equal 'ApplicationController', config.base_controller
     assert_equal %w(created_at updated_at), config.ignored_attributes
+    assert_equal false, config.reload_docs_folder
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_docs
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-14 00:00:00.000000000 Z
+date: 2012-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -82,10 +82,12 @@ files:
 - app/views/api_docs/docs/_request_params.html.erb
 - app/views/api_docs/docs/index.html.erb
 - config/routes.rb
+- doc/screenshot.png
 - lib/api_docs.rb
 - lib/api_docs/configuration.rb
 - lib/api_docs/engine.rb
 - lib/api_docs/test_helper.rb
+- lib/tasks/api_docs.rake
 - script/rails
 - test/api_docs_test.rb
 - test/docs_controller_test.rb
@@ -141,7 +143,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1850749757336925688
+      hash: -4228313556609487798
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: