rapidoc 0.0.4

data/spec/dummy/test/performance/browsing_test.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+require 'rails/performance_test_help'
+
+class BrowsingTest < ActionDispatch::PerformanceTest
+  # Refer to the documentation for all available options
+  # self.profile_options = { :runs => 5, :metrics => [:wall_time, :memory]
+  #                          :output => 'tmp/performance', :formats => [:flat] }
+
+  def test_homepage
+    get '/'
+  end
+end

data/spec/dummy/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/spec/features/action_spec.rb

@@ -0,0 +1,212 @@
+require 'bundler/setup'
+require 'rack/file'
+require 'capybara/rspec'
+require 'spec_helper'
+require 'rspec/rails'
+
+Capybara.app = Rack::File.new ::Rails.root.to_s
+
+include Rapidoc
+
+describe "Action page"  do
+
+  before :all 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"
+
+    File.open( request_file, 'w') { |file| file.write @json_info.to_json }
+    File.open( response_file, 'w') { |file| file.write @json_info.to_json }
+
+    load_config
+    resources_doc = get_resources
+    generate_actions_templates( resources_doc )
+
+    @user_resource = resources_doc.select{ |r| r.name == 'users' }.first
+  end
+
+  after :all do
+    remove_doc
+    remove_examples
+  end
+
+  context "when visit users_index.html page" do
+    before do
+      visit '/rapidoc/actions/users_index.html'
+    end
+
+    context "when check action page" do
+      it "contains title with text 'Project'" do
+        config = YAML.load( File.read( config_file_path ) )
+        page.should have_link( config["project_name"], '#' )
+      end
+
+      it "contains an H1 with text 'user'" do
+        page.should have_css 'h1', :text => @user_resource.name.to_s
+      end
+    end
+
+    context "when check tab 'Home'" do
+      before :all do
+        @action_info = @user_resource.actions_doc.first
+      end
+
+      it "contains a description of the resource" do
+        page.should have_text(@action_info.description)
+      end
+
+      it "contains action name" do
+        page.should have_css("td", @action_info.action)
+      end
+
+      it "contains action method" do
+        page.should have_css("td", @action_info.action_method)
+      end
+
+      it "contains action response formats" do
+        page.should have_css("td", @action_info.response_formats)
+      end
+
+      it "contains icon that show if action requires authentication" do
+        if @action_info.authentication == true
+          page.should have_css("i.icon-ok")
+        else
+          page.should have_css("i.icon-remove")
+        end
+      end
+
+      it "contains the resource URL" do
+        page.should have_text(@action_info.urls.first)
+      end
+
+      it "contains the correct states" do
+        @action_info.http_responses.each do |http_response|
+          page.should have_css("td", http_response.description)
+        end
+      end
+    end
+
+    context "when check tab 'Params'" do
+      before :all do
+        @params_info = @user_resource.actions_doc.first.params
+      end
+
+      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 )
+      end
+
+      it "have a row with parameter name" do
+        @params_info.each do |param|
+          page.should have_css( "table#table-params td", :text => /#{param["name"]}.*/ )
+        end
+      end
+
+      it "have a row with parameter type" do
+        @params_info.each do |param|
+          if param.keys.include? "type"
+            page.should have_css( "table#table-params td", :text => /.*#{param["type"]}/ )
+          end
+        end
+      end
+
+      it "have a row with parameter description" do
+        @params_info.each do |param|
+          page.should have_css( "table#table-params td", :text => param["description"] )
+        end
+      end
+
+      it "have a row with parameter type" do
+        @params_info.each do |param|
+          page.should have_css( "table#table-params td", :text => param["type"] )
+        end
+      end
+    end
+
+    it "don't have tab 'Errors'" do
+      page.should_not have_css( "div#errors" )
+    end
+
+    it "don't have tab 'Request'" do
+      page.should_not have_css( "div#request" )
+    end
+
+    it "don't have tab 'Response'" do
+      page.should_not have_text( "div#response" )
+    end
+  end
+
+  context "when visit users_create.html page" do
+    before do
+      visit '/rapidoc/actions/users_create.html'
+    end
+
+    context "when check tab 'Params'" do
+      before do
+        @create_params_info =
+          @user_resource.actions_doc.select{ |ad| ad.action == 'create' }.first.params
+      end
+
+      it "have a row with parameter type or inclusion" do
+        @create_params_info.each do |param|
+          if param["inclusion"]
+            page.should have_css( "table#table-params td", :text => param["inclusion"] )
+          else
+            page.should have_css( "table#table-params td", :text => param["type"] )
+          end
+        end
+      end
+    end
+
+    context "when check tab 'Errors'" do
+      before :all do
+        action_doc = @user_resource.actions_doc.select{ |ad| ad.action == "create" }.first
+        @errors = action_doc.errors
+      end
+
+      it "have table with one row for each error" do
+        header = 1
+        page.should have_css( "table#table-errors tr", :count => @errors.size + header )
+      end
+
+      it "have a col with error object" do
+        @errors.each do |error|
+          page.should have_css( "table#table-errors td", :text => /#{error["object"]}.*/ )
+        end
+      end
+
+      it "have a col with error message" do
+        @errors.each do |error|
+          page.should have_css( "table#table-errors td", :text => /#{error["message"]}.*/ )
+        end
+      end
+
+      it "have a col with error description" do
+        @errors.each do |error|
+          page.should have_css( "table#table-errors td", :text => /#{error["description"]}.*/ )
+        end
+      end
+
+      it "have a row with error message" do
+        @errors.each do |error|
+          page.should have_css( "table#table-errors tr",
+            :text => /#{error["object"]}.#{error["message"]}.*#{error["description"]}/ )
+        end
+      end
+    end
+
+    context "when check tab 'Request'" do
+      it "should contain the correct request" do
+        page.should have_text( @user_resource.actions_doc.first.example_req )
+      end
+    end
+
+    context "when check tab 'Response'" do
+      it "should contain the correct response" do
+        page.should have_text( @user_resource.actions_doc.first.example_res )
+      end
+    end
+  end
+end

data/spec/features/index_spec.rb

@@ -0,0 +1,64 @@
+require 'bundler/setup'
+require 'rack/file'
+require 'capybara/rspec'
+require 'spec_helper'
+
+Capybara.app = Rack::File.new ::Rails.root.to_s
+
+include Rapidoc
+
+describe "Index page" do
+
+  before :all do
+    reset_structure
+    load_config
+    @resources = get_resources
+    generate_doc
+  end
+
+  before do
+    visit '/rapidoc/index.html'
+  end
+
+  after :all do
+    #remove_doc
+  end
+
+  context "when check global page" do
+    it "contains an H1 with text 'Resources'" do
+      page.should have_css 'h1', :text => 'Resources'
+    end
+
+    it "contains Title with text 'Project Name'" do
+      page.should have_link('Project Name', '#')
+    end
+  end
+
+  context "when check resources" do
+    it "contains the correct number of resources" do
+      page.find(".accordion").should have_content "albums"
+      page.find(".accordion").should have_content "images"
+      page.find(".accordion").should have_content "users"
+    end
+
+    it "contains the correct methods" do
+      @resources.each do |resource|
+        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" )
+            else
+              page.should have_text( url )
+            end
+          end
+        end
+      end
+    end
+
+    it "contains the correct description" do
+      @resources.each do |resource|
+        page.should have_text(resource.description)
+      end
+    end
+  end
+end

data/spec/lib/action_doc_spec.rb

@@ -0,0 +1,202 @@
+require 'spec_helper.rb'
+
+include Rapidoc
+
+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"
+
+    reset_structure
+    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", 
+      :action=>"create",
+      :method=>"POST",
+      :urls=>["/users(.:format)"]
+    }
+
+    extractor = ControllerExtractor.new "users_controller.rb"
+    @controller_info = extractor.get_action_info( 'create' )
+  end
+
+  after :all do
+    remove_examples
+  end
+
+  context "when initialize ActionDoc" do
+    before :all do
+      @action_doc = ActionDoc.new( @info, @controller_info, examples_dir )
+    end
+
+    it "set correct action info" do
+      @action_doc.action.should == @info[:action]
+    end
+
+    it "set correct resource" do
+      @action_doc.resource.should == @info[:resource]
+    end
+
+    it "set correct urls" do
+      @action_doc.urls.should == @info[:urls]
+    end
+
+    it "set correct action method" do
+      @action_doc.action_method.should == @info[:method]
+    end
+
+    it "set correct description" do
+      @action_doc.description.should == @controller_info["description"]
+    end
+
+    it "set correct http responses" do
+      http_responses = @action_doc.send( :get_http_responses,
+                                        @controller_info["http_responses"] )
+    end
+
+    it "set correct requires authentication" do
+      @action_doc.authentication.should == false
+    end
+
+    it "set correct file" do
+      @action_doc.file.should == @info[:resource].to_s + "_" + @info[:action].to_s
+    end
+
+    it "set correct example_req" do
+      @action_doc.example_res.should == JSON.pretty_generate( @json_info )
+    end
+
+    it "set correct example_res" do
+      @action_doc.example_req.should == JSON.pretty_generate( @json_info )
+    end
+
+    context "when executing get_http_responses method" do
+      before do
+        @codes = [ 200, 401 ]
+        @http_responses = @action_doc.send( :get_http_responses, @codes )
+      end
+
+      it "return new HttpResponse Array" do
+        @http_responses.each do |r|
+          r.class.should == HttpResponse
+        end
+      end
+
+      it "each HttpResponse element should include correct code" do
+        @http_responses.each_index do |i|
+          @http_responses[i].code.should == @codes[i]
+        end
+      end
+
+      it "each HttpResponse element should include description" do
+        @http_responses.each{ |http_r| http_r.methods.should be_include( :description ) }
+      end
+
+      it "each HttpResponse element should include label" do
+        @http_responses.each{ |http_r| http_r.methods.should be_include( :label ) }
+      end
+    end
+
+    context "when checking errors" do
+      context "when action has custom errors" do
+        before :all do
+          @errors = @action_doc.errors
+        end
+
+        it "return all errors" do
+          @errors.size.should == 1
+        end
+
+        it "return password errors" do
+          params_errors = @errors.select{ |error| error["object"] == 'password' }
+          messages = params_errors.map{ |m| m["message"] }
+          messages.should be_include( 'too_short' )
+        end
+      end
+    end
+
+    context "when call get_authentication function" do
+      context "when pass true/false" do
+        it "return correctly value" do
+          @action_doc.send( :get_authentication, false ).should == false
+          @action_doc.send( :get_authentication, true ).should == true
+        end
+      end
+      context "when pass nil" do
+        it "return correctly default value (true)" do
+          @action_doc.send( :get_authentication, nil ).should == true
+        end
+      end
+    end
+  end
+
+  context "when default response formats are actived" do
+    before :all do
+      File.open("#{config_dir}/rapidoc.yml", 'w') do |file|
+        file.write "response_formats: xml"
+      end
+
+      load_config
+      @action_doc = ActionDoc.new( @info, @controller_info, examples_dir )
+    end
+
+    it "returns default response formats" do
+      @action_doc.response_formats.should == 'xml'
+    end
+  end
+
+  context "when default errors are actived" do
+    context "when use default messages and descriptions" do
+      before :all do
+        File.open("#{config_dir}/rapidoc.yml", 'w') do |file|
+          file.write "default_errors: true"
+        end
+
+        load_config
+        action_doc = ActionDoc.new( @info, @controller_info, examples_dir )
+        @errors = action_doc.errors
+      end
+
+      it "return all errors" do
+        @errors.size.should == 6
+      end
+
+      it "returns correct messages" do
+        messages = @errors.map{ |error| error["message"] }
+        messages.should be_include( 'blank' )
+        messages.should be_include( 'too_short' )
+        messages.should be_include( 'inclusion' )
+      end
+    end
+
+    context "when use config messages 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
+        action_doc = ActionDoc.new( @info, @controller_info, examples_dir )
+        @errors = action_doc.errors
+      end
+
+      it "return all errors" do
+        @errors.size.should == 6
+      end
+
+      it "returns correct messages" do
+        messages = @errors.map{ |error| error["message"] }
+        messages.should be_include( 'm1' )
+        messages.should be_include( 'too_short' )
+        messages.should be_include( 'm2' )
+      end
+    end
+  end
+end