rapidoc 0.0.4

data/spec/lib/resource_doc_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper.rb'
+
+include Rapidoc
+
+describe ResourceDoc do
+  before :all do
+    @extractor = ControllerExtractor.new "users_controller.rb"
+    @routes_actions_info = get_routes_doc.get_actions_route_info( :users )
+  end
+
+  context "when create new valid instance only with resource name" do
+    before do
+      @resource_name = "users"
+      @rdoc = ResourceDoc.new @resource_name, nil
+    end
+
+    it "saves it correctly" do
+      @rdoc.name.should == @resource_name
+      @rdoc.controller_file.should == @resource_name + '_controller.rb'
+    end
+  end
+
+  context "when call simple name" do
+    before do
+      @resource_name = "One/Two"
+      @rdoc = ResourceDoc.new @resource_name, nil
+    end
+
+    it "returns name without '/'" do
+      @rdoc.simple_name.should == "OneTwo"
+    end
+  end
+
+  context "when call get_controller_extractor function" do
+    before do
+      ResourceDoc.any_instance.stub( :generate_info ).and_return( true )
+    end
+
+    context "when exists controller file" do
+      before do
+        @rdoc = ResourceDoc.new "users", nil
+      end
+
+      it "returns new ControllerExtractor" do
+        @rdoc.send( :get_controller_extractor ).class.should == ControllerExtractor
+      end
+    end
+
+    context "when exists controller file" do
+      before do
+        @rdoc = ResourceDoc.new "notexists", nil
+      end
+
+      it "returns new ControllerExtractor" do
+        @rdoc.send( :get_controller_extractor ).should == nil
+      end
+    end
+  end
+
+  context "when call get_actions_doc function" do
+    before do
+      ResourceDoc.any_instance.stub( :generate_info ).and_return( true )
+      @rdoc = ResourceDoc.new "users", nil
+    end
+
+    context "when don't pass extractor" do
+      before do
+        @actions_doc = @rdoc.send( :get_actions_doc, @routes_actions_info, nil )
+      end
+
+      it "returns ActionDoc array" do
+        @actions_doc.class.should == Array
+        @actions_doc.each{ |ad| ad.class.should == ActionDoc }
+      end
+
+      it "don't returns description" do
+        @actions_doc.each{ |ad| ad.description.should == nil }
+      end
+
+      it "ActionDoc array has correct info" do
+        actions = @actions_doc.map{ |ad| ad.action }
+        methods = @actions_doc.map{ |ad| ad.action_method }
+
+        # Example of routes_actions_info: { index => [{},{}], show => [{}] }
+        @routes_actions_info.each do |action_info|
+          actions.should be_include( action_info[:action] )
+          methods.should be_include( action_info[:method] )
+        end
+      end
+    end
+
+    context "when pass resource action info (routes) and extractor" do
+      before do
+        @actions_doc = @rdoc.send( :get_actions_doc, @routes_actions_info, @extractor )
+      end
+
+      it "returns ActionDoc array" do
+        @actions_doc.class.should == Array
+        @actions_doc.each{ |ad| ad.class.should == ActionDoc }
+      end
+
+      it "returns info extracted from controller" do
+        @actions_doc.each do |action_doc|
+          info = @extractor.get_action_info( action_doc.action )
+          action_doc.description.should == info['description']
+        end
+      end
+    end
+  end
+
+  context "when create new valid instance" do
+    before :all do
+      @resource_name = "users"
+      @rdoc = ResourceDoc.new @resource_name, @routes_actions_info
+    end
+
+    it "saves it correctly" do
+      @rdoc.name.should == @resource_name
+      @rdoc.controller_file.should == @resource_name + '_controller.rb'
+    end
+
+    it "set correct description" do
+      @rdoc.description.should == @extractor.get_resource_info['description']
+    end
+
+    it "set correct actions_doc" do
+      @rdoc.actions_doc.class.should == Array
+      @rdoc.actions_doc.each{ |ad| ad.class.should == ActionDoc }
+    end
+  end
+end

data/spec/lib/resources_extractor_spec.rb

@@ -0,0 +1,105 @@
+require "spec_helper"
+
+include Rapidoc
+
+describe Rapidoc::ResourcesExtractor do
+
+  context "when executing get_routes_doc" do
+    before :all do
+      @routes_doc = get_routes_doc
+    end
+
+    it "returns RoutesDoc instance" do
+      @routes_doc.class.should == RoutesDoc
+    end
+
+    it "instance include all resources" do
+      resources_names = @routes_doc.get_resources_names
+      resources_names.should be_include(:images)
+      resources_names.should be_include(:albums)
+      resources_names.should be_include(:users)
+    end
+  end
+
+  context "when executing get_routes_doc and config has resources black list" do
+    before :all do
+      @routes_doc = get_routes_doc
+    end
+
+    it "returns RoutesDoc instance" do
+      @routes_doc.class.should == RoutesDoc
+    end
+
+    it "instance include all resources" do
+      resources_names = @routes_doc.get_resources_names
+      resources_names.should be_include(:images)
+      resources_names.should be_include(:albums)
+      resources_names.should be_include(:users)
+    end
+  end
+
+
+  context "when executing get_resources function" do
+    before :all do
+      @resources = get_resources
+    end
+
+    it "return correct resorces name" do
+      names = @resources.map(&:name)
+      names.should be_include( "images" )
+      names.should be_include( "users" )
+      names.should be_include( "albums" )
+    end
+
+    it "return correct controller_names" do
+      files = @resources.map(&:controller_file)
+      files.should be_include( "images_controller.rb" )
+      files.should be_include( "users_controller.rb" )
+      files.should be_include( "albums_controller.rb" )
+    end
+
+    it "return correct resource actions" do
+      @user_resource = @resources.select{ |r| r.name == "users" }.first
+      actions = @user_resource.actions_doc.map{ |r| r.action }
+
+      actions.should be_include( 'index' )
+      actions.should be_include( 'show' )
+      actions.should be_include( 'create' )
+    end
+
+    it "return correct order" do
+      names = @resources.map(&:name)
+      names.should == [ "albums", "images", "users" ]
+    end
+
+    context "when check resource with controller" do
+      before do
+        @user_resource = @resources.select{ |r| r.name == "users" }.first
+      end
+
+      it "return correct info about controller actions" do
+        actions = @user_resource.actions_doc.map{ |r| r.action }
+        actions.should be_include( 'index' )
+        actions.should be_include( 'show' )
+        actions.should be_include( 'create' )
+      end
+    end
+
+    context "when config has resources_black_list" do
+      before do
+        File.open("#{config_dir}/rapidoc.yml", 'w') do |file|
+          file.write "resources_black_list: images, albums"
+        end
+
+        load_config
+      end
+
+      it "returns correct resources names" do
+        names = get_resources.map(&:name)
+        names.should_not be_include( "images" )
+        names.should_not be_include( "albums" )
+        names.should be_include( "users" )
+      end
+    end
+  end
+end

data/spec/lib/routes_doc_spec.rb

@@ -0,0 +1,150 @@
+require 'spec_helper.rb'
+
+include Rapidoc
+
+describe RoutesDoc do
+  before do
+    @routes_doc = RoutesDoc.new
+  end
+
+  context "when we call add_resource_route function" do
+    before do
+      @method = 'GET'
+      @url = '/users(.:format)'
+      @controller_action = 'users#index'
+      @routes_doc.send( :add_resource_route, @method, @url, @controller_action )
+    end
+
+    it "adds new route to RoutesDoc instance" do
+      @routes_doc.instance_variable_get( :@resources_routes ).size.should == 1
+    end
+
+    it "creates correct route resource" do
+      resources =  @routes_doc.instance_variable_get( :@resources_routes ).keys
+      resources.should be_include( :users )
+    end
+
+    it "set correct route info" do
+      info = @routes_doc.instance_variable_get( :@resources_routes )[:users].first
+
+      info[:resource].should == 'users'
+      info[:action].should == 'index'
+      info[:method].should == @method
+      info[:url].should == @url
+      info[:controller].should == 'users'
+    end
+  end
+
+  context "when we call get_resource_name function" do
+    context "when resource name is at the end of url" do
+      context "when is embeded resource" do
+        it "returns correct resource name" do
+          name = @routes_doc.send( :get_resource_name, '/users/:id/images(.:format)' )
+          name.should == 'images'
+        end
+      end
+
+      context "when not is embeded resource" do
+        it "returns correct resource name" do
+          name = @routes_doc.send( :get_resource_name, '/users(.:format)' )
+          name.should == 'users'
+        end
+      end
+    end
+
+    context "when resource name is followed by id" do
+      it "returns correct resource name" do
+        name = @routes_doc.send( :get_resource_name, '/users/:id/images/:id(.:format)' )
+        name.should == 'images'
+      end
+    end
+
+    context "when resource name is followed by action" do
+      it "returns correct resource name" do
+        name = @routes_doc.send( :get_resource_name, '/users/:id/images/new(.:format)' )
+        name.should == 'images'
+      end
+    end
+
+    context "when is edit action" do
+      it "returns correct resource name" do
+        name = @routes_doc.send( :get_resource_name, '/users/:id/edit(.:format)' )
+        name.should == 'users'
+      end
+    end
+
+    context "when is edit action from embeded resource" do
+      it "returns correct resource name" do
+        name = @routes_doc.send( :get_resource_name, '/users/password/edit(.:format)' )
+        name.should == 'users'
+      end
+    end
+
+    context "when is root" do
+      it "returns correct resource name" do
+        name = @routes_doc.send( :get_resource_name, '/' )
+        name.should == '/'
+      end
+    end
+  end
+
+  context "when we call get_resources_names function" do
+    it "returns all resources name" do
+      @routes_doc.add_route( 'GET /users(.:format) users#index' )
+      @routes_doc.add_route( 'GET /images(.:format) images#index' )
+      @routes_doc.get_resources_names.should == [ :images, :users ]
+    end
+  end
+
+  context "when we call get_resource_actions_names function" do
+    it "returns all actions names" do
+      @routes_doc.add_route( 'GET /users(.:format) users#index' )
+      @routes_doc.add_route( 'GET /users(.:format) users#show' )
+      @routes_doc.get_resource_actions_names( :users ).should == [ 'index', 'show' ]
+    end
+  end
+
+  context "when we call add_route function" 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
+
+  context "when we call get_action_info function" do
+    before do
+      @route = 'GET /users(.:format) users#index'
+    end
+
+    it "returns correct Hash" do
+      @routes_doc.add_route( @route )
+      @routes_doc.get_action_route_info( :users, :index ).should == {
+        resource: 'users',
+        action: 'index',
+        method: 'GET',
+        urls: ['/users(.:format)'],
+        controllers: [ 'users' ]
+      }
+    end
+  end
+
+  context "when we call get_resource_actions_info function" do
+    before do
+      @routes_doc.add_route( 'GET /users(.:format) users#index' )
+      @routes_doc.add_route( 'GET /users(.:format) users#show' )
+      @actions_info = @routes_doc.get_actions_route_info( 'users' )
+    end
+
+    it "returns all actions info" do
+      @actions_info.should be_include(
+        @routes_doc.get_action_route_info( 'users', 'index' ) )
+      @actions_info.should be_include(
+        @routes_doc.get_action_route_info( 'users', 'show' ) )
+    end
+  end
+end

data/spec/lib/templates_generator_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+include Rapidoc
+
+describe TemplatesGenerator do
+
+  before :all do
+    create_structure
+  end
+
+  after :all do
+    remove_doc
+  end
+
+  context "when call generate_index_template" do
+    it "should create new index.html file" do
+      generate_index_template nil
+      File.exists?( target_dir + '/index.html' ).should == true
+    end
+  end
+
+  context "when call get_index_template function" do
+    it "should return Handlebars Template " do
+      @template = get_index_template
+      @template.class.should == Handlebars::Template
+    end
+  end
+
+  context "when call generate_actions_templates function" do
+    before do
+      @resources = get_resources.select{ |r| r.actions_doc }
+      generate_actions_templates @resources
+    end
+
+    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
+        end
+      end
+    end
+  end
+
+  context "when call create_action_template function" do
+    before do
+      extractor = ControllerExtractor.new "users_controller.rb"
+      resource_info = get_routes_doc.get_actions_route_info( :users )
+
+      info = resource_info.group_by{ |entrie| entrie[:action] }['create'].first
+      controller_info = extractor.get_action_info( 'create' )
+      @action_doc = ActionDoc.new( info, controller_info, examples_dir )
+      
+      create_action_template( get_action_template, @action_doc )
+    end
+
+    it "should create new action html file" do
+      route = actions_dir + "/#{@action_doc.resource}_#{@action_doc.action}.html"
+      File.exists?( route ).should == true
+    end
+  end
+
+  context "when call get_action_template function" do
+    it "should return Handlebars Template " do
+      @template = get_action_template
+      @template.class.should == Handlebars::Template
+    end
+  end
+
+  context "when call get_method_label" do
+    context "when call with valid method" do
+      before do
+        @methods = [ 'GET', 'POST', 'PUT', 'DELETE' ]
+        @labels = [ 'label-info', 'label-success', 'label-warning', 'label-important' ]
+      end
+
+      it "should return correct label" do
+        @methods.each_index do |i|
+          get_method_label( @methods[i] ).should == 'label ' + @labels[i]
+        end
+      end
+    end
+
+    context "when call with unknow method" do
+      it "should return correct label" do
+        get_method_label( 'unknow' ).should == 'label'
+      end
+    end
+  end
+end