rapidoc 0.0.6 → 0.0.7

data/spec/dummy/config/application.rb

@@ -51,7 +51,6 @@ module Dummy
     # This will create an empty whitelist of attributes available for mass-assignment for all models
     # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
     # parameters by using an attr_accessible or attr_protected declaration.
-    config.active_record.whitelist_attributes = true
 
     # Enable the asset pipeline
     config.assets.enabled = true

data/spec/dummy/config/environments/development.rb

@@ -1,37 +1,80 @@
 Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+  # Settings specified here will take precedence over those in config/application.rb.
 
-  # In the development environment your application's code is reloaded on
-  # every request. This slows down response time but is perfect for development
-  # since you don't have to restart the web server when you make code changes.
-  config.cache_classes = false
+  # Code is not reloaded between requests.
+  config.cache_classes = true
 
-  # Log error messages when you accidentally call methods on nil.
-  config.whiny_nils = true
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
 
-  # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
-  config.action_controller.perform_caching = false
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
 
-  # Don't care if the mailer can't send
-  config.action_mailer.raise_delivery_errors = false
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
 
-  # Print deprecation notices to the Rails logger
-  config.active_support.deprecation = :log
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = true
 
-  # Only use best-standards-support built into browsers
-  config.action_dispatch.best_standards_support = :builtin
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
 
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
 
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  config.active_record.auto_explain_threshold_in_seconds = 0.5
+  # Generate digests for assets URLs.
+  config.assets.digest = true
 
-  # Do not compress assets
-  config.assets.compress = false
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
 
-  # Expands the lines which load the assets
-  config.assets.debug = true
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
 end

data/spec/dummy/config/environments/production.rb

@@ -1,67 +1,80 @@
 Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+  # Settings specified here will take precedence over those in config/application.rb.
 
-  # Code is not reloaded between requests
+  # Code is not reloaded between requests.
   config.cache_classes = true
 
-  # Full error reports are disabled and caching is turned on
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
   config.consider_all_requests_local       = false
   config.action_controller.perform_caching = true
 
-  # Disable Rails's static asset server (Apache or nginx will already do this)
-  config.serve_static_assets = false
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = true
 
-  # Compress JavaScripts and CSS
-  config.assets.compress = true
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
 
-  # Don't fallback to assets pipeline if a precompiled asset is missed
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
   config.assets.compile = false
 
-  # Generate digests for assets URLs
+  # Generate digests for assets URLs.
   config.assets.digest = true
 
-  # Defaults to nil and saved in location specified by config.assets.prefix
-  # config.assets.manifest = YOUR_PATH
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
 
-  # Specifies the header that your server uses for sending files
+  # Specifies the header that your server uses for sending files.
   # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
   # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
 
   # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
   # config.force_ssl = true
 
-  # See everything in the log (default is :info)
-  # config.log_level = :debug
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
 
-  # Prepend all log lines with the following tags
+  # Prepend all log lines with the following tags.
   # config.log_tags = [ :subdomain, :uuid ]
 
-  # Use a different logger for distributed setups
+  # Use a different logger for distributed setups.
   # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
 
-  # Use a different cache store in production
+  # Use a different cache store in production.
   # config.cache_store = :mem_cache_store
 
-  # Enable serving of images, stylesheets, and JavaScripts from an asset server
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
   # config.action_controller.asset_host = "http://assets.example.com"
 
-  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
   # config.assets.precompile += %w( search.js )
 
-  # Disable delivery errors, bad email addresses will be ignored
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
   # config.action_mailer.raise_delivery_errors = false
 
-  # Enable threaded mode
-  # config.threadsafe!
-
   # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
-  # the I18n.default_locale when a translation can not be found)
+  # the I18n.default_locale when a translation can not be found).
   config.i18n.fallbacks = true
 
-  # Send deprecation notices to registered listeners
+  # Send deprecation notices to registered listeners.
   config.active_support.deprecation = :notify
 
-  # Log the query plan for queries taking more than this (works
-  # with SQLite, MySQL, and PostgreSQL)
-  # config.active_record.auto_explain_threshold_in_seconds = 0.5
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
 end

data/spec/dummy/config/environments/test.rb

@@ -1,37 +1,80 @@
 Dummy::Application.configure do
-  # Settings specified here will take precedence over those in config/application.rb
+  # Settings specified here will take precedence over those in config/application.rb.
 
-  # The test environment is used exclusively to run your application's
-  # test suite. You never need to work with it otherwise. Remember that
-  # your test database is "scratch space" for the test suite and is wiped
-  # and recreated between test runs. Don't rely on the data there!
+  # Code is not reloaded between requests.
   config.cache_classes = true
 
-  # Configure static asset server for tests with Cache-Control for performance
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
   config.serve_static_assets = true
-  config.static_cache_control = "public, max-age=3600"
 
-  # Log error messages when you accidentally call methods on nil
-  config.whiny_nils = true
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
 
-  # Show full error reports and disable caching
-  config.consider_all_requests_local       = true
-  config.action_controller.perform_caching = false
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
 
-  # Raise exceptions instead of rendering exception templates
-  config.action_dispatch.show_exceptions = false
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
 
-  # Disable request forgery protection in test environment
-  config.action_controller.allow_forgery_protection    = false
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
 
-  # Tell Action Mailer not to deliver emails to the real world.
-  # The :test delivery method accumulates sent emails in the
-  # ActionMailer::Base.deliveries array.
-  config.action_mailer.delivery_method = :test
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
 
-  # Raise exception on mass assignment protection for Active Record models
-  config.active_record.mass_assignment_sanitizer = :strict
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
 
-  # Print deprecation notices to the stderr
-  config.active_support.deprecation = :stderr
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
 end

data/spec/dummy/config/routes.rb

@@ -1,6 +1,6 @@
 Dummy::Application.routes.draw do
-  match 'testing', :to => 'testing#redirect', :constraints => { :id => /[A-Z]\d{5}/ }
-  match '*tests', :controller => 'testing', :action => 'index'
+  match 'testing', :to => 'testing#redirect', :via => :get, :constraints => { :id => /[A-Z]\d{5}/ }
+  match '*tests', :controller => 'testing', :action => 'index', :via => :get
 
   resources :users, :only => [ :index, :show, :create ] do
     resources :albums, :only => [ :index, :show, :create, :update, :destroy ] do

data/spec/features/action_spec.rb

@@ -14,9 +14,10 @@ describe "Action page"  do
     reset_structure
 
     @json_info =  { "user" => { "name" => "Check", "apellido" => "Me" } }
-    request_file = examples_dir "users_create_request.json"
-    response_file = examples_dir "users_create_response.json"
+    request_file = examples_dir "users/create_request.json"
+    response_file = examples_dir "users/create_response.json"
 
+    create_folders_for_files([response_file, request_file])
     File.open( request_file, 'w') { |file| file.write @json_info.to_json }
     File.open( response_file, 'w') { |file| file.write @json_info.to_json }
 
@@ -28,13 +29,13 @@ describe "Action page"  do
   end
 
   after :all do
-    remove_doc
+    remove_structure
     remove_examples
   end
 
-  context "when visit users_index.html page" do
+  context "when visit users/index.html page" do
     before do
-      visit '/rapidoc/actions/users_index.html'
+      visit '/public/docs/actions/users/index.html'
     end
 
     context "when check action page" do
@@ -95,7 +96,7 @@ describe "Action page"  do
 
       it "have table with one row for each parameter" do
         # +1 becouse rapidoc add empty row at the end
-        page.should have_css( "table#table-params tr", :count => @params_info.size + 1 )
+        page.should have_css( "table#table-params tr", :count => @params_info.size + 2 )
       end
 
       it "have a row with parameter name" do
@@ -138,9 +139,9 @@ describe "Action page"  do
     end
   end
 
-  context "when visit users_create.html page" do
+  context "when visit users/create.html page" do
     before do
-      visit '/rapidoc/actions/users_create.html'
+      visit '/public/docs/actions/users/create.html'
     end
 
     context "when check tab 'Params'" do

data/spec/features/index_spec.rb

@@ -17,11 +17,11 @@ describe "Index page" do
   end
 
   before do
-    visit '/rapidoc/index.html'
+    visit '/public/docs/index.html'
   end
 
   after :all do
-    #remove_doc
+   remove_structure
   end
 
   context "when check global page" do
@@ -46,7 +46,7 @@ describe "Index page" do
         resource.actions_doc.each do |action|
           action.urls.each do |url|
             if action.has_controller_info
-              page.should have_link( url, href: "actions/" + action.file + ".html" )
+              page.should have_link( url, href: "actions/" + action.file.gsub('_','/') + ".html" )
             else
               page.should have_text( url )
             end

data/spec/lib/action_doc_spec.rb

@@ -6,15 +6,16 @@ describe ActionDoc do
 
   before :all do
     @json_info =  { "user" => { "name" => "Check", "apellido" => "Me" } }
-    response_file = examples_dir "users_create_response.json"
-    answer_file = examples_dir "users_create_request.json"
+    response_file = examples_dir "users/create_response.json"
+    answer_file = examples_dir "users/create_request.json"
 
     reset_structure
+    create_folders_for_files([response_file, answer_file])
     File.open( response_file, 'w') { |file| file.write @json_info.to_json }
     File.open( answer_file, 'w') { |file| file.write @json_info.to_json }
 
-    @info = { 
-      :resource=>"users", 
+    @info = {
+      :resource=>"users",
       :action=>"create",
       :method=>"POST",
       :urls=>["/users(.:format)"]
@@ -26,6 +27,7 @@ describe ActionDoc do
 
   after :all do
     remove_examples
+    remove_structure
   end
 
   context "when initialize ActionDoc" do
@@ -63,7 +65,7 @@ describe ActionDoc do
     end
 
     it "set correct file" do
-      @action_doc.file.should == @info[:resource].to_s + "_" + @info[:action].to_s
+      @action_doc.file.should == @info[:resource].to_s + "/" + @info[:action].to_s
     end
 
     it "set correct example_req" do
@@ -175,7 +177,7 @@ describe ActionDoc do
 
     context "when use config messages and descriptions" do
       before :all do
-        File.open( config_file_path, 'w') do |file| 
+        File.open( config_file_path, 'w') do |file|
           file.write "default_errors: true\n"
           file.write "errors:\n"
           file.write "  required:\n    message: \"m1\"\n    description: \"d1\"\n"