rapidoc 0.0.4

data/spec/lib/config_spec.rb

@@ -0,0 +1,186 @@
+require "spec_helper"
+
+include Rapidoc
+
+describe Rapidoc::Config do
+  before :all do
+    reset_structure
+  end
+
+  it "config_dir returns correct dir" do
+    config_dir().should eql( ::Rails.root.to_s + '/config/rapidoc' )
+  end
+
+  it "config_dir returns correct dir + file" do
+    config_dir('file.yml').should eql( ::Rails.root.to_s + '/config/rapidoc/file.yml' )
+  end
+
+  it "gem_templates_dir returns correct dir" do
+    gem_templates_dir().should =~ /(.*)\/lib\/rapidoc\/templates/
+  end
+
+  it "gem_templates_dir returns correct dir + file" do
+    gem_templates_dir('template.hbs').should  =~ /(.*)\/templates\/template\.hbs/
+  end
+
+  context "when call controller_dir" do
+    context "when use default route" do
+      it "controller_dir returns correct dir" do
+        controller_dir().should eql( ::Rails.root.to_s + '/app/controllers' )
+      end
+
+      it "controller_dir returns correct dir + file" do
+        controller_dir('file.rb').should eql( ::Rails.root.to_s + '/app/controllers/file.rb' )
+      end
+    end
+
+    context "when use config route" do
+      it "controller_dir returns correct dir" do
+        File.open( config_file_path, 'w') { |file| file.write "controllers_route: \"vim\"" }
+        load_config
+        controller_dir().should eql( ::Rails.root.to_s + '/vim' )
+      end
+    end
+  end
+
+  context "when call target_dir" do
+    context "when config file has a route" do
+      before do
+        File.open( config_file_path, 'w') { |file| file.write "doc_route: \"vim\"" }
+        load_config
+      end
+
+      it "returns correct route" do
+        target_dir.should ==  ::Rails.root.to_s + "/vim"
+      end
+    end
+
+    context "when config file hasn't a route" do
+      before do
+        File.open("#{config_dir}/rapidoc.yml", 'w') { |file| file.write "" }
+        load_config
+      end
+
+      it "returns default route" do
+        target_dir.should == ::Rails.root.to_s + "/rapidoc"
+      end
+    end
+
+    context "when pass file name" do
+      it "returns correct dir + file" do
+        target_dir('file.html').should eql( target_dir + '/file.html' )
+      end
+    end
+  end
+
+  context "when call default_errors" do
+    before :all do
+      File.open( config_file_path, 'w') { |file| file.write "default_errors: true" }
+      load_config
+    end
+
+    context "when action is index" do
+      it "returns false" do
+        default_errors?( 'index' ).should == false
+      end
+    end
+
+    context "when action is create" do
+      it "returns true" do
+        default_errors?( 'create' ).should == true
+      end
+    end
+  end
+
+  context "when call default_response_formats" do
+    context "when config file has not response_formats" do
+      it "returns nil" do
+        default_response_formats.should == nil
+      end
+    end
+
+    context "when config file has response_formats" do
+      it "returns response formats" do
+        File.open( config_file_path, 'w') { |file| file.write "response_formats: json" }
+        load_config
+        default_response_formats.should == 'json'
+      end
+    end
+  end
+
+  context "when call actions_dir" do
+    context "when config file has a route" do
+      before do
+        File.open( config_file_path, 'w') { |file| file.write "doc_route: \"vim\"" }
+        load_config
+      end
+
+      it "returns correct route" do
+        actions_dir.should ==  ::Rails.root.to_s + "/vim/actions"
+      end
+    end
+
+    context "when config file hasn't a route" do
+      before do
+        File.open("#{config_dir}/rapidoc.yml", 'w') { |file| file.write "" }
+        load_config
+      end
+
+      it "returns default route" do
+        actions_dir.should == ::Rails.root.to_s + "/rapidoc/actions"
+      end
+    end
+
+    context "when pass file name" do
+      it "returns correct dir + file" do
+        actions_dir('file.html').should eql( actions_dir + '/file.html' )
+      end
+    end
+  end
+
+  context "when call examples_dir" do
+    context "when config file has an example dir" do
+      before do
+        File.open( "#{config_dir}/rapidoc.yml", 'w' ) do |file|
+          file.write "examples_route: \"vim\""
+        end
+
+        load_config
+      end
+
+      it "examples_dir returns correct route" do
+        examples_dir.should == ::Rails.root.to_s + "/vim"
+      end
+    end
+    context "when config file hasn't an example dir" do
+      before do
+        File.open("#{config_dir}/rapidoc.yml", 'w') { |file| file.write "" }   
+        load_config
+      end
+
+      it "examples_dir returns default examples dir route" do
+        examples_dir.should == "#{config_dir}/examples"
+      end
+    end
+  end
+
+  context "when call resources_black_list" do
+    context "when config file has resources_black_list" do
+      it "returns array with resources" do
+        File.open("#{config_dir}/rapidoc.yml", 'w') do |file|
+          file.write "resources_black_list: images, albums"
+        end
+        load_config
+        resources_black_list.should == [ :images, :albums ]
+      end
+    end
+
+    context "when config file has not resources_black_list" do
+      it "returns empty array" do
+        File.open("#{config_dir}/rapidoc.yml", 'w') { |file| file.write "" }   
+        load_config
+        resources_black_list.should == []
+      end
+    end
+  end
+end

data/spec/lib/controller_extractor_spec.rb

@@ -0,0 +1,77 @@
+require "spec_helper"
+
+include Rapidoc
+
+describe ControllerExtractor do
+
+  context "when create instance with valid controller file" do
+    before :all do
+      @extractor = ControllerExtractor.new "users_controller.rb"
+    end
+
+    context
+
+    context "when call get_actions_info function" do
+      before :all do
+        @info = @extractor.get_actions_info
+      end
+
+      it "should return info about all commented actions" do
+        actions = @info.map{ |info| info["action"] }
+        actions.should be_include( 'index' )
+        actions.should be_include( 'show' )
+        actions.should be_include( 'create' )
+      end
+    end
+
+    context "when call get_action_info " do
+      before :all do
+        @info = @extractor.get_action_info( "index" )
+      end
+
+      it "returns the correct action" do
+        @info['action'].should == "index"
+      end
+
+      it "should return all mandatary fields" do
+        @info.keys.should be_include( 'http_responses' )
+        @info.keys.should be_include( 'action' )
+        @info.keys.should be_include( 'method' )
+        @info.keys.should be_include( 'authentication_required' )
+        @info.keys.should be_include( 'response_formats' )
+        @info.keys.should be_include( 'description' )
+      end
+    end
+
+    context "when call get_resource_info" do
+      before :all do
+        @info = @extractor.get_resource_info
+      end
+
+      it "controller info contatins resource description" do
+        @info.keys.should be_include( 'description' )
+      end
+    end
+
+    context "when call get_controller_info" do
+      before :all do
+        @info = @extractor.get_controller_info
+      end
+
+      it "returns resource description" do
+        @info.keys.should be_include( 'description' )
+      end
+
+      it "returns resource actions info" do
+        @info.keys.should be_include( 'actions' )
+      end
+    end
+  end
+
+  context "when create new instance with invalid controller file" do
+    it "throw exception" do
+      lambda{ ControllerExtractor.new( "no_file" ) }.should raise_error
+    end
+  end
+end
+

data/spec/lib/http_response_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+include Rapidoc
+
+describe "When check HttpResponse class" do
+
+  context "when create new instance" do
+    before :all do
+      @http_response = HttpResponse.new 200
+    end
+
+    it "should set correct code" do
+      @http_response.code.should == 200
+    end
+
+    it "should set correct label" do
+      @http_response.label.should == 'label label-info'
+    end
+
+    it "should set correct description" do
+      @http_response.description.should == "OK"
+    end
+  end
+
+  context "when check get_description function" do
+    before do
+      @codes = [ 200, 201, 401, 404, 422, 403, 409 ]
+      @descriptions = [ 'OK', 'Created', 'Unauthorized', 'Not found',
+                        'Unprocessable Entity', 'Forbidden', '' ]
+    end
+
+    it "should return correct descriptions" do
+      @codes.each_index do |i|
+        http_response = HttpResponse.new @codes[i]
+        http_response.get_description.should == @descriptions[i]
+      end
+    end
+  end
+
+  context "when call get_label function" do
+    context "when pass know code" do
+      before do
+        @codes = [ 200, 201, 204, 401, 403, 422, 404 ]
+        @labels = [ 'label-info', 'label-success', 'label-info2', 'label-warning',
+          'label-warning2', 'label-important', 'label-inverse' ]
+      end
+
+      it "should return correct labels" do
+        @codes.each_index do |i|
+          http_response = HttpResponse.new @codes[i]
+          http_response.get_label.should == 'label ' + @labels[i]
+        end
+      end
+    end
+
+    context "when pass unknow code" do
+      it "should return correct label" do
+        http_response = HttpResponse.new 400
+        http_response.get_label.should == 'label'
+      end
+    end
+  end
+end

data/spec/lib/param_errors_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+include Rapidoc
+
+describe ParamErrors do
+  context "when use default messages and descriptions"do
+    context "when call get_required_error_info" do
+      it "return correct error info" do
+        info = get_required_error_info( 'name' )
+        info['object'].should == 'name'
+        info['message'].should == 'blank'
+        info['description'].should == 'This parameter is mandatory'
+      end
+    end
+
+    context "when call get_inclusion_error_info" do
+      it "return correct error info" do
+        info = get_inclusion_error_info( 'name' )
+        info['object'].should == 'name'
+        info['message'].should == 'inclusion'
+        info['description'].should == 'This parameter is not in the collection'
+      end
+    end
+
+    context "when call get_error_info" do
+      it "return correct error info" do
+        get_error_info( 'name', 'required' ).should == get_required_error_info( 'name' )
+      end
+    end
+  end
+
+  context "when use config messaes and descriptions" do
+    before :all do
+
+      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"
+        file.write "  inclusion:\n    message: \"m2\"\n    description: \"d2\"\n"
+      end
+
+      load_config
+    end
+
+    context "when call get_required_error_info" do
+      it "return correct error info" do
+        info = get_required_error_info( 'name' )
+        info['object'].should == 'name'
+        info['message'].should == 'm1'
+        info['description'].should == 'd1'
+      end
+    end
+
+    context "when call get_inclusion_error_info" do
+      it "return correct error info" do
+        info = get_inclusion_error_info( 'name' )
+        info['object'].should == 'name'
+        info['message'].should == 'm2'
+        info['description'].should == 'd2'
+      end
+    end
+
+    context "when call get_error_info" do
+      it "return correct error info" do
+        get_error_info( 'name', 'required' ).should == get_required_error_info( 'name' )
+      end
+    end
+  end
+end

data/spec/lib/rake_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'rake'
+
+describe Rake do
+  context 'rapidoc:generate' do
+    before do
+      Rake.application.rake_require "tasks/rapidoc"
+      Rake::Task.define_task(:environment)
+    end
+
+    after do
+      remove_doc 
+    end
+
+    let :run_rake_task do
+      Rake::Task["rapidoc:generate"].reenable
+      Rake.application.invoke_task "rapidoc:generate"
+    end
+
+    it "should create documentation" do
+      run_rake_task
+      File.exists?( ::Rails.root.to_s + "/rapidoc/index.html" ).should == true
+    end
+  end
+end

data/spec/lib/rapidoc_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+include Rapidoc
+
+describe Rapidoc do
+
+  before :all do
+    create_structure
+    load_config
+  end
+
+  after :all do
+    remove_doc
+  end
+
+  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
+
+  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