rapidoc 0.0.5 → 0.0.6

data/README.rdoc

@@ -1,6 +1,6 @@
 = Rapidoc
 
-REST API documentation generator for rails projects ( 0.05 version ).
+REST API documentation generator for rails projects ( 0.06 version ).
 
 This gem let you generate API documentation of your rails project in html format.
 It uses routes information, rapidoc comments and json examples for generate
@@ -125,6 +125,10 @@ For more details and options please visit the Wiki[https://github.com/drinor/rap
 
 * If there is an error in your documentation, rapidoc show you an error message with the file name that contains the error and block lines.
 
+* Trace mode ( configuration[https://github.com/drinor/rapidoc/wiki/Configuration] ).
+
+* Simple and intuitive navigation.
+
 == Contributing
 
 1. Fork it

data/lib/rapidoc/action_doc.rb

@@ -21,10 +21,12 @@ module Rapidoc
     def initialize( routes_info, controller_info, examples_route )
       @resource         = routes_info[:resource].to_s
       @action           = routes_info[:action].to_s
-      @action_method    = routes_info[:method].to_s
+      @action_method    = routes_info[:method].to_s || '-----'
       @urls             = routes_info[:urls]
       @file             = @resource + '_' + @action
 
+      puts " - Generating #{@action} action documentation..." if trace?
+
       add_controller_info( controller_info ) if controller_info
       load_examples( examples_route ) if examples_route
       load_params_errors if default_errors? @action and @params
@@ -37,6 +39,7 @@ module Rapidoc
     private
 
     def add_controller_info( controller_info )
+      puts "  + Adding info from controller..." if trace?
       @description      = controller_info["description"]
       @response_formats = default_response_formats || controller_info["response_formats"]
       @params           = controller_info["params"]
@@ -74,12 +77,14 @@ module Rapidoc
     def load_request( examples_route )
       file = examples_route + '/' + @resource + '_' + @action + '_request.json'
       return unless File.exists?( file )
+      puts "  + Loading request examples..." if trace?
       File.open( file ){ |f| @example_req = JSON.pretty_generate( JSON.parse(f.read) ) }
     end
 
     def load_response( examples_route )
       file = examples_route + '/' + @resource + '_' + @action + '_response.json'
       return unless File.exists?( file )
+      puts "  + Loading response examples..." if trace?
       File.open( file ){ |f| @example_res = JSON.pretty_generate( JSON.parse(f.read) ) }
     end
   end

data/lib/rapidoc/config.rb

@@ -102,6 +102,10 @@ module Rapidoc
       @@config['response_formats'] if @@config
     end
 
+    def trace?
+      ( @@config and @@config['trace'] == true ) ? true : false
+    end
+
     private
 
     def target_dir_from_config

data/lib/rapidoc/resources_extractor.rb

@@ -16,6 +16,8 @@ module Rapidoc
     # @return [RoutesDoc] class with routes info
     #
     def get_routes_doc
+      puts "Executing 'rake routes'..." if trace?
+
       routes_doc = RoutesDoc.new
       routes = Dir.chdir( ::Rails.root.to_s ) { `rake routes` }
 
@@ -35,6 +37,7 @@ module Rapidoc
       resources_names = routes_doc.get_resources_names - resources_black_list
 
       resources_names.map do |resource|
+        puts "Generating #{resource} documentation..." if trace?
         ResourceDoc.new( resource, routes_doc.get_actions_route_info( resource ) )
       end
     end

data/lib/rapidoc/routes_doc.rb

@@ -11,12 +11,21 @@ module Rapidoc
     end
 
     def add_route( route )
-      if route.split.size == 4
+      if route.split.size > 3
         method, url, controller_action = route.split.slice(1, 3)
+      elsif route.split.size == 2
+        url, controller_action = route.split
       else
         method, url, controller_action = route.split
       end
 
+      # check when method is not specified
+      unless controller_action.include? '#'
+        controller_action = url
+        url = method
+        method = nil
+      end
+
       add_resource_route( method, url, controller_action )
     end
 

data/lib/rapidoc/templates/index.html.hbs

@@ -28,7 +28,7 @@
           <div class="nav-collapse">
             <ul class="nav">
               <li class="active"><a href="index.html">Resources</a></li>
-              <li><a href="https://github.com/drinor/rapidoc.git">Contact</a></li>
+              <li><a  target="_blank" href="https://github.com/drinor/rapidoc.git">Contact</a></li>
             </ul>
           </div>
         </div>
@@ -64,7 +64,7 @@
                     </td>
                     <td>
                       {{#if ../this.has_controller_info}}
-                        <a href="actions/{{../../this.resource}}_{{../../this.action}}.html" target="_blank">{{this}}<a>
+                        <a href="actions/{{../../this.resource}}_{{../../this.action}}.html">{{this}}<a>
                       {{else}}
                         {{this}}
                       {{/if}}

data/lib/rapidoc/version.rb

@@ -1,3 +1,3 @@
 module Rapidoc
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/rapidoc/yaml_parser.rb

@@ -47,7 +47,7 @@ module Rapidoc
           
           begin
             info << YAML.load( lines[ b[:init] + 1, n_lines ].join.gsub(/\ *#/, '') )
-          rescue SyntaxError => e
+          rescue Exception => e
             puts "Error parsing block in #{file_name} file [#{b[:init]} - #{b[:end]}]"
           end
         end

data/spec/dummy/config/routes.rb

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

data/spec/dummy/public/users_controller.yml

@@ -0,0 +1,6 @@
+# =begin action
+http_status:
+  - 201
+  #params:
+  - name: 'name'
+# =end

data/spec/lib/config_spec.rb

@@ -23,6 +23,18 @@ describe Rapidoc::Config do
     gem_templates_dir('template.hbs').should  =~ /(.*)\/templates\/template\.hbs/
   end
 
+  context "when call trace?" do
+    it "returns false with default options" do
+      trace?.should == false
+    end
+
+    it "returns true when config has trace=true" do
+      File.open( config_file_path, 'w') { |file| file.write "trace: true" }
+      load_config
+      trace?.should == true
+    end
+  end
+
   context "when call controller_dir" do
     context "when use default route" do
       it "controller_dir returns correct dir" do

data/spec/lib/rapidoc_spec.rb

@@ -4,36 +4,57 @@ include Rapidoc
 
 describe Rapidoc do
 
-  before :all do
-    create_structure
-    load_config
-  end
-
-  after :all do
-    remove_doc
-  end
+  context "when all is ok" do
+    before :all do
+      create_structure
+      load_config
+    end
 
-  context "when create estructure" do
-    it "should create config files" do
-      File.exists?( config_dir( "rapidoc.yml" ) ).should == true
+    after :all do
+      remove_doc
     end
 
-    it "should create target dir" do
-      File.directory?( target_dir ).should == true
+    context "when create estructure" do
+      it "should create config files" do
+        File.exists?( config_dir( "rapidoc.yml" ) ).should == true
+      end
+
+      it "should create target dir" do
+        File.directory?( target_dir ).should == true
+      end
+
+      it "should create example dir" do
+        File.directory?( examples_dir ).should == true
+      end
     end
 
-    it "should create example dir" do
-      File.directory?( examples_dir ).should == true
+    context "when executing genarate_doc function" do
+      before do
+        generate_doc
+      end
+
+      it "should create new index.html file" do
+        File.exists?( ::Rails.root.to_s + "/rapidoc/index.html" ).should == true
+      end
     end
   end
 
-  context "when executing genarate_doc function" do
-    before do
+  context "when there is an error" do
+    before :all do
+      create_structure
+
+      File.open( config_file_path, 'w') { |file| file.write "controllers_route: \"public\"" }
+      load_config
+
+      controller = controller_dir 'users_controller.yml'
+      File.open( controller, 'w' ) { |file|
+        file.write "# =begin action\nhttp_status:\n  - 201\n  #params:\n  - name: 'name'\n# =end\n"
+      }
+
       generate_doc
     end
 
-    it "should create new index.html file" do
-      File.exists?( ::Rails.root.to_s + "/rapidoc/index.html" ).should == true
+    it "should return error" do
     end
   end
 end

data/spec/lib/resource_doc_spec.rb

@@ -4,6 +4,8 @@ include Rapidoc
 
 describe ResourceDoc do
   before :all do
+    reset_structure
+    load_config
     @extractor = ControllerExtractor.new "users_controller.rb"
     @routes_actions_info = get_routes_doc.get_actions_route_info( :users )
   end

data/spec/lib/resources_extractor_spec.rb

@@ -69,7 +69,7 @@ describe Rapidoc::ResourcesExtractor do
 
     it "return correct order" do
       names = @resources.map(&:name)
-      names.should == [ "albums", "images", "users" ]
+      names.should == [ "albums", "images", "testing", "users" ]
     end
 
     context "when check resource with controller" do

data/spec/lib/routes_doc_spec.rb

@@ -105,14 +105,52 @@ describe RoutesDoc do
   end
 
   context "when we call add_route function" do
-    before do
-      @route = 'GET /users(.:format) users#index'
+    context "when route has 3 normal elements" do
+      before do
+        @route = 'GET /users(.:format) users#index'
+      end
+
+      it "calls add_resource_route function with correct params" do
+        @routes_doc.should_receive( :add_resource_route ).
+          with( 'GET', '/users(.:format)', 'users#index' )
+        @routes_doc.add_route( @route )
+      end
     end
 
-    it "calls add_resource_route function with correct params" do
-      @routes_doc.should_receive( :add_resource_route ).
-        with( 'GET', '/users(.:format)', 'users#index' )
-      @routes_doc.add_route( @route )
+    context "when route has 3 elements" do
+      before do
+        @route = '/users/:id(.:format) users#index {:id=>/[A-Z]\d{5}/}'
+      end
+
+      it "calls add_resource_route function with correct params" do
+        @routes_doc.should_receive( :add_resource_route ).
+          with( nil, '/users/:id(.:format)', 'users#index' )
+        @routes_doc.add_route( @route )
+      end
+    end
+
+    context "when route has 4 elements" do
+      before do
+        @route = 'user /users/:id(.:format) users#index {:id=>/[A-Z]\d{5}/}'
+      end
+
+      it "calls add_resource_route function with correct params" do
+        @routes_doc.should_receive( :add_resource_route ).
+          with( nil, '/users/:id(.:format)', 'users#index' )
+        @routes_doc.add_route( @route )
+      end
+    end
+
+    context "when route has 2 elements" do
+      before do
+        @route = '/users/:id(.:format) users#index'
+      end
+
+      it "calls add_resource_route function with correct params" do
+        @routes_doc.should_receive( :add_resource_route ).
+          with( nil, '/users/:id(.:format)', 'users#index' )
+        @routes_doc.add_route( @route )
+      end
     end
   end
 

data/spec/lib/templates_generator_spec.rb

@@ -4,12 +4,13 @@ include Rapidoc
 
 describe TemplatesGenerator do
 
-  before :all do
-    create_structure
+  before do
+    reset_structure
+    load_config
   end
 
-  after :all do
-    remove_doc
+  after do
+    #remove_doc
   end
 
   context "when call generate_index_template" do
@@ -35,8 +36,10 @@ describe TemplatesGenerator do
     it "should create new action.html file for each action"do
       @resources.each do |resource|
         resource.actions_doc.each do |action_doc|
-          route = actions_dir + "/#{resource.name}_#{action_doc.action}.html"
-          File.exists?( route ).should == true
+          if action_doc.has_controller_info
+            route = actions_dir + "/#{resource.name}_#{action_doc.action}.html"
+            File.exists?( route ).should == true
+          end
         end
       end
     end

data/spec/lib/yaml_parser_spec.rb

@@ -50,7 +50,7 @@ describe Rapidoc::YamlParser do
       end
     end
 
-    context "when there is an error in the block" do
+    context "when there is an error in a description" do
       before :all do
         @blocks2 = [ { init: 0, end: 2 } ]
         @lines2 = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapidoc
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-22 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -183,6 +183,7 @@ files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/public/index.html
 - spec/dummy/public/robots.txt
+- spec/dummy/public/users_controller.yml
 - spec/dummy/salida/users_create_response.json
 - spec/dummy/script/rails
 - spec/dummy/test/fixtures/.gitkeep
@@ -221,12 +222,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3398396139760812886
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3398396139760812886
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -273,6 +280,7 @@ test_files:
 - spec/dummy/public/favicon.ico
 - spec/dummy/public/index.html
 - spec/dummy/public/robots.txt
+- spec/dummy/public/users_controller.yml
 - spec/dummy/salida/users_create_response.json
 - spec/dummy/script/rails
 - spec/dummy/test/fixtures/.gitkeep