fdoc 0.3.0 → 0.3.1

data/spec/fdoc/endpoint_scaffold_spec.rb

@@ -81,9 +81,9 @@ describe Fdoc::EndpointScaffold do
       subject.request_parameters["properties"].should have_key "with_symbol"
       subject.request_parameters["properties"].should_not have_key :with_symbol
       subject.request_parameters["properties"].should have_key "with_string"
-      subject.request_parameters["properties"].should_not have_key :with_string          
+      subject.request_parameters["properties"].should_not have_key :with_string
     end
-    
+
     it "uses strings (not symbols) for keys of nested hashes" do
       mixed_params = {
         "nested_object" => {
@@ -95,14 +95,14 @@ describe Fdoc::EndpointScaffold do
       subject.consume_request(mixed_params)
       subject.request_parameters["properties"]["nested_object"]["properties"].keys.sort.should == ["with_string", "with_symbol"]
     end
-    
+
     it "uses strings (not symbols) for nested hashes inside arrays" do
       mixed_params = {
         "nested_array" => [
           {
             :with_symbol => false,
             "with_string" => true
-          }            
+          }
         ]
       }
 
@@ -214,7 +214,7 @@ describe Fdoc::EndpointScaffold do
         subject.response_parameters["properties"].should have_key "with_symbol"
         subject.response_parameters["properties"].should_not have_key :with_symbol
         subject.response_parameters["properties"].should have_key "with_string"
-        subject.response_parameters["properties"].should_not have_key :with_string          
+        subject.response_parameters["properties"].should_not have_key :with_string
       end
 
       it "produces a valid JSON schema for the response" do

data/spec/fdoc/endpoint_spec.rb

@@ -5,7 +5,7 @@ describe Fdoc::Endpoint do
   let(:fdoc_fixture) { ["GET", "members/list"] }
   let (:test_service) { Fdoc::Service.new('spec/fixtures') }
   subject { endpoint }
-  
+
   def remove_optional(obj)
     case obj
     when Hash
@@ -42,7 +42,7 @@ describe Fdoc::Endpoint do
         "order_by" => "name"
       }
     }
-    
+
     context "with a well-behaved request" do
       it "returns true" do
         subject.should be_true
@@ -67,12 +67,12 @@ describe Fdoc::Endpoint do
 
     context "when the response encounters an object of an known type" do
       before { params.merge!("offset" => "woot") }
-      
+
       it "should have the Ruby type in the error message" do
         expect { subject }.to raise_exception(JSON::Schema::ValidationError, /String/)
       end
     end
-    
+
     context "complex examples" do
       let(:fdoc_fixture) { ["GET", "/members/list/complex-params"] }
       let(:params) {
@@ -83,7 +83,7 @@ describe Fdoc::Endpoint do
               "required_param" => "here",
               "optional_param" => "here"
             }
-          ],          
+          ],
           "required_nested_array" => [
             {
               "required_param" => "here",
@@ -93,7 +93,7 @@ describe Fdoc::Endpoint do
                 "optional_param" => "here"
               }
             },
-          ],         
+          ],
           "optional_nested_object" => {
             "required_param" => "here",
             "optional_param" => "here"
@@ -108,30 +108,30 @@ describe Fdoc::Endpoint do
           },
         }
       }
-      
+
       it "is successful" do
         subject.should be_true
       end
-      
-      context "with no optional keys" do        
+
+      context "with no optional keys" do
         before { remove_optional(params) }
 
         it "does not contain optional keys" do
           params.keys.sort.should == ["required_nested_array", "required_nested_object", "toplevel_param"]
         end
-        
+
         it "is successful" do
           subject.should be_true
-        end        
+        end
       end
-      
+
       context "non documented field added" do
         before { params.merge!("non_documented" => true) }
         it "raises an error" do
           expect { subject }.to raise_exception(JSON::Schema::ValidationError, /non_documented/)
         end
       end
-      
+
       context "non document field in an optional array" do
         before { params["optional_nested_array"][0].merge!("non_documented" => true) }
 
@@ -139,7 +139,7 @@ describe Fdoc::Endpoint do
           expect { subject }.to raise_exception(JSON::Schema::ValidationError, /non_documented/)
         end
       end
-      
+
       context "non document field in a required array" do
         before { params["required_nested_array"][0].merge!("non_documented" => true) }
 
@@ -163,7 +163,7 @@ describe Fdoc::Endpoint do
           expect { subject }.to raise_exception(JSON::Schema::ValidationError, /non_documented/)
         end
       end
-      
+
       context "non document field in a deeply nested object" do
         before { params["required_nested_object"]["optional_second_nested_object"].merge!("non_documented" => true) }
 
@@ -171,7 +171,7 @@ describe Fdoc::Endpoint do
           expect { subject }.to raise_exception(JSON::Schema::ValidationError, /non_documented/)
         end
       end
-      
+
       context "required field in a deeply nested object is missing" do
         before { params["required_nested_object"]["optional_second_nested_object"].delete("required_param") }
 
@@ -179,7 +179,7 @@ describe Fdoc::Endpoint do
           expect { subject }.to raise_exception(JSON::Schema::ValidationError, /required_param/)
         end
       end
-      
+
       context "non document field in a deeply nested object in an array" do
         before { params["required_nested_array"][0]["optional_second_nested_object"].merge!("non_documented" => true) }
 
@@ -187,7 +187,7 @@ describe Fdoc::Endpoint do
           expect { subject }.to raise_exception(JSON::Schema::ValidationError, /non_documented/)
         end
       end
-      
+
       context "required field in a deeply nested object is missing" do
         before { params["required_nested_array"][0]["optional_second_nested_object"].delete("required_param") }
 

data/spec/fdoc/presenters/base_presenter_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+require 'nokogiri'
+
+describe Fdoc::BasePresenter do
+  class Fdoc::SamplePresenter < Fdoc::BasePresenter
+    def to_html
+      render_erb('test.html.erb')
+    end
+  end
+
+  subject {
+    Fdoc::SamplePresenter.new template_directory: 'templates'
+  }
+
+  context "#render_erb" do
+    it "renders a default template" do
+      File.should_receive(:exists?).with('templates/test.html.erb').and_return(false)
+      File.stub(:read).and_return('test content')
+      subject.to_html
+    end
+
+    it "renders from local template directory" do
+      File.should_receive(:exists?).with('templates/test.html.erb').and_return(true)
+      File.should_receive(:read).with('templates/test.html.erb').and_return('test content')
+      subject.to_html
+    end
+  end
+end

data/spec/fdoc/presenters/endpoint_presenter_spec.rb

@@ -19,6 +19,13 @@ describe Fdoc::EndpointPresenter do
     end
   end
 
+  context "#to_markdown" do
+    it "should generate markdown" do
+      markdown = subject.to_markdown
+      markdown.should include "# GET spec​/fixtures​/members​/list"
+    end
+  end
+
   context "#example_from_schema" do
     example_schema_yaml = <<-EOS
     properties:
@@ -90,4 +97,4 @@ describe Fdoc::EndpointPresenter do
       subject.example_from_schema(example_schema).should == expected_example
     end
   end
-end
+end

data/spec/fdoc/presenters/meta_service_presenter_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'nokogiri'
+
+describe Fdoc::MetaServicePresenter do
+  subject {
+    Fdoc::MetaServicePresenter.new(Fdoc::MetaService.new('spec/fixtures'))
+  }
+
+  context "#to_html" do
+    it "should generate valid HTML" do
+      html = subject.to_html
+
+      expect {
+        Nokogiri::HTML(html) { |config| config.strict }
+      }.to_not raise_exception
+    end
+  end
+
+  context "#to_markdown" do
+    it "should generate markdown" do
+      markdown = subject.to_markdown
+      markdown.should include "* PUT [https:​/​/api.sample.com​/members​/add](members_api/add-PUT.md)"
+      markdown.should include "* POST [https:​/​/api.sample.com​/members​/draft](members_api/draft-POST.md)"
+    end
+  end
+
+  context "#relative_service_path" do
+    let(:service) { subject.services.first }
+
+    it "returns relative path" do
+      subject.relative_service_path(service).should == "members_api"
+    end
+
+    it "should join relative path if passed in a filename" do
+      subject.relative_service_path(service, 'index.md').should == "members_api/index.md"
+    end
+  end
+end

data/spec/fdoc/presenters/schema_presenter_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+require 'nokogiri'
+
+describe Fdoc::SchemaPresenter do
+  let(:schema) {
+    {
+      'description' => 'Some description text',
+      'example' => 'an example'
+    }
+  }
+  subject {
+    Fdoc::SchemaPresenter.new(schema, {})
+  }
+
+  context '#to_html' do
+    it 'should generate valid HTML' do
+      html = subject.to_html
+
+      html.should include 'Some description text'
+      html.should include 'an example'
+      expect {
+        Nokogiri::HTML(html) { |config| config.strict }
+      }.to_not raise_exception
+    end
+  end
+
+  context "#to_markdown" do
+    it "should generate markdown" do
+      markdown = subject.to_markdown
+      markdown.should include 'Some description text'
+      markdown.should include 'an example'
+    end
+  end
+end

data/spec/fdoc/presenters/service_presenter_spec.rb

@@ -3,7 +3,7 @@ require 'nokogiri'
 
 describe Fdoc::ServicePresenter do
   subject {
-    Fdoc::ServicePresenter.new(Fdoc::Service.new('spec/fixtures'))
+    Fdoc::ServicePresenter.new(Fdoc::Service.new('spec/fixtures/members'))
   }
 
   context "#to_html" do
@@ -15,4 +15,27 @@ describe Fdoc::ServicePresenter do
       }.to_not raise_exception
     end
   end
+
+  context "#to_markdown" do
+    it "should generate markdown" do
+      markdown = subject.to_markdown
+      markdown.should include "* PUT [https:​/​/api.sample.com​/members​/add](add-PUT.md)"
+      markdown.should include "* POST [https:​/​/api.sample.com​/members​/draft](draft-POST.md)"
+    end
+  end
+
+  context "#relative_meta_service_path" do
+    let(:meta_service) { Fdoc::MetaServicePresenter.new(Fdoc::MetaService.new('spec/fixtures')) }
+    before do
+      subject.service.meta_service = meta_service
+    end
+
+    its(:relative_meta_service_path) { should == "../"}
+
+    context "pass in filename" do
+      it "should join with filename" do
+        subject.relative_meta_service_path('index.md').should == "../index.md"
+      end
+    end
+  end
 end

data/spec/fixtures/members/list/complex-params-GET.fdoc

@@ -4,84 +4,84 @@ requestParameters:
     toplevel_param:
       type: string
       description: A paramater as normal
-      required: Yes
+      required: yes
     optional_nested_array:
       type: array
-      required: No
+      required: no
       items:
         type: object
         properties:
           required_param:
-            required: Yes
+            required: yes
             description: It's required
             type: string
           optional_param:
-            required: Yes
+            required: yes
             description: It's optional
             type: string
     required_nested_array:
       type: array
-      required: Yes
+      required: yes
       items:
         type: object
         properties:
           required_param:
-            required: Yes
+            required: yes
             description: It's required
             type: string
           optional_param:
-            required: No
+            required: no
             description: It's optional
             type: string
           optional_second_nested_object:
-            required: No
+            required: no
             type: object
             description: It's a bug
             properties:
               required_param:
-                required: Yes
+                required: yes
                 description: It's required
                 type: string
               optional_param:
-                required: No
+                required: no
                 description: It's optional
                 type: string
-          
+
     optional_nested_object:
       type: object
-      required: No
+      required: no
       properties:
         required_param:
-          required: Yes
+          required: yes
           description: It's required
           type: string
         optional_param:
-          required: No
+          required: no
           description: It's optional
           type: string
     required_nested_object:
       type: object
-      required: Yes
+      required: yes
       properties:
         required_param:
-          required: Yes
+          required: yes
           description: It's required
           type: string
         optional_param:
-          required: No
+          required: no
           description: It's optional
           type: string
         optional_second_nested_object:
-          required: No
+          required: no
           type: object
           description: It's a bug
           properties:
             required_param:
-              required: Yes
+              required: yes
               description: It's required
               type: string
             optional_param:
-              required: No
+              required: no
               description: It's optional
               type: string
 

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'fdoc'
 require 'fdoc/cli'
 require 'rspec'
+require 'tmpdir'
 
 Dir.glob(File.expand_path("../support/*.rb", __FILE__)).each { |f| require f }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fdoc
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
   prerelease: 
 platform: ruby
 authors:
@@ -170,8 +170,9 @@ files:
 - lib/fdoc/endpoint.rb
 - lib/fdoc/endpoint_scaffold.rb
 - lib/fdoc/meta_service.rb
+- lib/fdoc/presenters/base_presenter.rb
 - lib/fdoc/presenters/endpoint_presenter.rb
-- lib/fdoc/presenters/html_presenter.rb
+- lib/fdoc/presenters/json_presenter.rb
 - lib/fdoc/presenters/meta_service_presenter.rb
 - lib/fdoc/presenters/response_code_presenter.rb
 - lib/fdoc/presenters/schema_presenter.rb
@@ -179,14 +180,22 @@ files:
 - lib/fdoc/service.rb
 - lib/fdoc/spec_watcher.rb
 - lib/fdoc/templates/endpoint.html.erb
+- lib/fdoc/templates/endpoint.md.erb
 - lib/fdoc/templates/meta_service.html.erb
+- lib/fdoc/templates/meta_service.md.erb
 - lib/fdoc/templates/service.html.erb
+- lib/fdoc/templates/service.md.erb
+- lib/fdoc/templates/shared/endpoint_name.html.erb
+- lib/fdoc/templates/shared/endpoint_name.md.erb
 - lib/fdoc/templates/styles.css
 - lib/fdoc.rb
 - spec/fdoc/cli_spec.rb
 - spec/fdoc/endpoint_scaffold_spec.rb
 - spec/fdoc/endpoint_spec.rb
+- spec/fdoc/presenters/base_presenter_spec.rb
 - spec/fdoc/presenters/endpoint_presenter_spec.rb
+- spec/fdoc/presenters/meta_service_presenter_spec.rb
+- spec/fdoc/presenters/schema_presenter_spec.rb
 - spec/fdoc/presenters/service_presenter_spec.rb
 - spec/fdoc/service_spec.rb
 - spec/fdoc/spec_watcher_spec.rb
@@ -233,7 +242,10 @@ test_files:
 - spec/fdoc/cli_spec.rb
 - spec/fdoc/endpoint_scaffold_spec.rb
 - spec/fdoc/endpoint_spec.rb
+- spec/fdoc/presenters/base_presenter_spec.rb
 - spec/fdoc/presenters/endpoint_presenter_spec.rb
+- spec/fdoc/presenters/meta_service_presenter_spec.rb
+- spec/fdoc/presenters/schema_presenter_spec.rb
 - spec/fdoc/presenters/service_presenter_spec.rb
 - spec/fdoc/service_spec.rb
 - spec/fdoc/spec_watcher_spec.rb