grape_doc 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9c0dd09087124eaa66fffeb08428b7b076177852
+  data.tar.gz: 14c3153746fa290afccc1816637f2c68827a40df
+SHA512:
+  metadata.gz: 0fe1235aa18f280205715d7565707b2037086fe5a6477c9ae3ff4abcccc8385fc2b55495085579c01eb0c2b1cab101881dadaa1f09b9d3038ea5076809e36c67
+  data.tar.gz: dace415def09bb94d69adb8052e940c2a1d1381ddd986ef0bb82e64f5c08f89ceb06ba45c98b3d93502a02fe886165eff70b7c94725df1bb12ea40fdd1aea77a

data/.rvmrc

@@ -6,7 +6,7 @@
 # First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
 # Only full ruby name is supported here, for short names use:
 #     echo "rvm use 1.9.2" > .rvmrc
-environment_id="ruby-1.9.2-p320@grape_doc"
+environment_id="ruby-1.9.3-p484@grape_doc"
 
 # Uncomment the following lines if you want to verify rvm version per project
 # rvmrc_rvm_version="1.13.6 (stable)" # 1.10.1 seams as a safe start

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Alex Denisov
+Copyright (c) 2015 Alex Denisov
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/grape_doc.gemspec

@@ -2,8 +2,14 @@
 require File.expand_path('../lib/grape_doc/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Alex Denisov"]
-  gem.email         = ["1101.debian@gmail.com"]
+  gem.authors       = ["Alex Denisov", 
+                       "rayko", 
+                       "Jack Forrest", 
+                       "Chelsea Robb"]
+  gem.email         = ["1101.debian@gmail.com", 
+                       "rayko.drg@gmail.com", 
+                       "jack@jrforrest.net", 
+                       "chelsea.robb@gmail.com"]
   gem.description   = %q{Documentation generator for Grape API}
   gem.summary       = %q{Documentation generator for Grape API}
   gem.homepage      = "https://github.com/AlexDenisov/grape_doc"

data/lib/grape_doc/api_parameter.rb

@@ -16,6 +16,10 @@ module GrapeDoc
                       parameter_hash[:required]
       self.description =  parameter_hash[:desc] ||
                           parameter_hash[:description]
+      self.field_type = parameter_hash[:type]
+      if parameter_hash.keys.include? :documentation
+        self.sample_value = parameter_hash[:documentation][:example]
+      end
     end
     def self.initialize_parameters(params_hash)
       params = params_hash.map do |name, hash|
@@ -26,4 +30,3 @@ module GrapeDoc
     end
   end
 end
-

data/lib/grape_doc/formatters/markdown_formatter.rb

@@ -4,15 +4,17 @@ module GrapeDoc
       title = "### #{resource.resource_name}\n"
       
       documents = resource.documents.map do |document|
-        path = "#### #{document.http_method} #{document.path}\n\n"
+        path = "#### #{document.http_method} #{escape(document.path)}\n\n"
         description = "#{document.description}\n\n"
         
         parameters = document.params.map do |parameter| 
           next if parameter.field.nil? or parameter.field.empty?
-          param = " - #{parameter.field}"
+          param = " - #{escape(parameter.field)}"
           param += " (#{parameter.field_type})" if parameter.field_type
-          param += " (required)" if parameter.required
-          param += " : #{parameter.description}\n\n"
+          param += " (*required*)" if parameter.required
+          param += " : #{parameter.description} " if parameter.description
+          param += " Example: #{parameter.sample_value}" if parameter.sample_value
+          param += "\n\n"
         end.join if document.params
         
         route = "#{path} #{description}"
@@ -23,6 +25,11 @@ module GrapeDoc
       return "" if documents.nil? or documents.empty?
       "#{title}\n\n\n#{documents}\n"
     end
+
+    private
+
+    def escape(str)
+      str.gsub('_', '\_')
+    end
   end
 end
-

data/lib/grape_doc/version.rb

@@ -1,3 +1,3 @@
 module GrapeDoc
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/grape_doc.rb

@@ -8,12 +8,6 @@ require 'grape_doc/doc_generator'
 require 'grape_doc/formatters/markdown_formatter'
 require 'trollop'
 
-#begin
-#require File.expand_path(Dir.pwd + "/config/environment")
-#rescue LoadError => ex
-#  puts "#{ex}"
-#end
-
 module GrapeDoc
   def self.generate_doc
     opts = Trollop::options do

data/spec/api_document_spec.rb

@@ -6,22 +6,22 @@ describe "GrapeDoc::APIDocument" do
       GrapeDoc::APIDocument.new 
     }
     it "resource" do
-      api_document.respond_to?(:resource_name).should be_true
+      expect(api_document.respond_to?(:resource_name)).to eq(true)
     end
     it "path" do
-      api_document.respond_to?(:path).should be_true
+      expect(api_document.respond_to?(:path)).to eq(true)
     end
     it "description" do
-      api_document.respond_to?(:description).should be_true
+      expect(api_document.respond_to?(:description)).to eq(true)
     end
     it "params" do
-      api_document.respond_to?(:params).should be_true
+      expect(api_document.respond_to?(:params)).to eq(true)
     end
     it "response" do
-      api_document.respond_to?(:response).should be_true
+      expect(api_document.respond_to?(:response)).to eq(true)
     end
     it "http_method" do
-      api_document.respond_to?(:http_method).should be_true
+      expect(api_document.respond_to?(:http_method)).to eq(true)
     end
   end
 end

data/spec/api_parameter_spec.rb

@@ -9,16 +9,16 @@ describe GrapeDoc::APIParameter do
 
   describe "should respond to" do
     it "field" do
-      parameter.respond_to?(:field).should be_true
+      expect(parameter.respond_to?(:field)).to eq(true)
     end
     it "description" do
-      parameter.respond_to?(:description).should be_true
+      expect(parameter.respond_to?(:description)).to eq(true)
     end
     it "sample_value" do
-      parameter.respond_to?(:sample_value).should be_true
+      expect(parameter.respond_to?(:sample_value)).to eq(true)
     end
     it "field_type" do
-      parameter.respond_to?(:field_type).should be_true
+      expect(parameter.respond_to?(:field_type)).to eq(true)
     end
   end
 
@@ -27,15 +27,15 @@ describe GrapeDoc::APIParameter do
       document = parser.parse(Projects)[2]
       params = document.params
       params.each do |p|
-        p.kind_of?(APIParameter).should be_true
+        expect(p.kind_of?(APIParameter)).to eq(true)
       end
     end
     it "parse PUT project with parameters" do
       document = parser.parse(Projects)[2]
       param = document.params.first
-      param.field.should == "project_id"
-      param.description.should == "Project ID"
-      param.required.should be_true
+      expect(param.field).to eq("project_id")
+      expect(param.description).to eq("Project ID")
+      expect(param.required).to eq(true)
     end
   end
 end

data/spec/api_parser_spec.rb

@@ -8,38 +8,38 @@ describe GrapeDoc::APIParser do
   let(:parser) { APIParser.new }
   describe "parse empty child class" do
     it "should return nil" do
-      parser.parse(Users).should be_nil
+      expect(parser.parse(Users)).to eq(nil)
     end
   end
   describe "parse non-empty child class" do
     it "should_not return nil" do
-      parser.parse(Projects).should_not be_nil
+      expect(parser.parse(Projects)).not_to eq(nil)
     end
     it "should return two documents" do
-      parser.parse(Projects).count.should == 4
+      expect(parser.parse(Projects).count).to eq(4)
     end
     it "should return array of APIDocument objects" do
       parser.parse(Projects).each do |document|
-        document.kind_of?(APIDocument).should be_true
+        expect(document.kind_of?(APIDocument)).to eq(true)
       end
     end
     it "should parse GET route without meta info" do
       document = parser.parse(Projects).first
-      document.resource_name.should == "Projects"
-      document.path.should == "/projects"
-      document.http_method.should == "GET"
-      document.description.should be_nil
-      document.params.should be_nil
-      document.response.should be_nil
+      expect(document.resource_name).to eq("Projects")
+      expect(document.path).to eq("/projects")
+      expect(document.http_method).to eq( "GET")
+      expect(document.description).to eq(nil)
+      expect(document.params).to eq(nil)
+      expect(document.response).to eq(nil)
     end
     it "should parse POST route within meta info" do
       document = parser.parse(Projects)[1]
-      document.resource_name.should == "Projects"
-      document.path.should == "/projects"
-      document.http_method.should == "POST"
-      document.description.should == "Create Project"
-      document.params.should be_nil
-      document.response.should be_nil
+      expect(document.resource_name).to eq("Projects")
+      expect(document.path).to eq("/projects")
+      expect(document.http_method).to eq("POST")
+      expect(document.description).to eq("Create Project")
+      expect(document.params).to eq(nil)
+      expect(document.response).to eq(nil)
     end
     it "should parse PUT route within meta info" do
       params = { 
@@ -49,11 +49,11 @@ describe GrapeDoc::APIParser do
         }
       }
       document = parser.parse(Projects)[2]
-      document.resource_name.should == "Projects"
-      document.path.should == "/projects"
-      document.http_method.should == "PUT"
-      document.description.should == "Update Project"
-      document.response.should be_nil
+      expect(document.resource_name).to eq("Projects")
+      expect(document.path).to eq("/projects")
+      expect(document.http_method).to eq("PUT")
+      expect(document.description).to eq("Update Project")
+      expect(document.response).to eq(nil)
     end
     it "should parse DELETE route within meta info" do
       params = { 
@@ -66,12 +66,12 @@ describe GrapeDoc::APIParser do
         :status => true
       }
       document = parser.parse(Projects)[3]
-      document.resource_name.should == "Projects"
-      document.path.should == "/projects"
-      document.http_method.should == "DELETE"
-      document.description.should == "Delete Project"
-#      document.params.should == params
-      document.response.should == response
+      expect(document.resource_name).to eq("Projects")
+      expect(document.path).to eq("/projects")
+      expect(document.http_method).to eq("DELETE")
+      expect(document.description).to eq("Delete Project")
+      # expect(document.params).to eq(params)
+      expect(document.response).to eq(response)
     end
   end
 end

data/spec/api_resource_spec.rb

@@ -4,7 +4,7 @@ require 'test_classes/projects'
 describe GrapeDoc::APIResource do
   it "should have 4 documents" do
     resource = APIResource.new(Projects)
-    resource.documents.count.should == 4
+    expect(resource.documents.count).to eq(4)
   end
 end
 

data/spec/api_response.rb

@@ -2,8 +2,9 @@ require 'spec_helper'
 require 'test_classes/projects'
 
 describe "APIResponse" do
+  pending "No previos spec"
   it "should parse response" do
-
+    # Code me maybe?
   end
 end
 

data/spec/doc_generator_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe GrapeDoc::DOCGenerator do
   it "resources" do
-    generator = DOCGenerator.new
-    generator.resources.count.should == 1
+    generator = DOCGenerator.new 'test_classes/projects'
+    expect(generator.resources.count).to eq(1)
   end
 end

data/spec/markdown_formatter_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe 'GrapeDoc::MarkdownFormatter' do
+  let(:formatter) { GrapeDoc::MarkdownFormatter.new }
+
+  let(:resource) do
+    instance_double('GrapeDoc::APIResource',
+      resource_name: 'MightyNeatResource',
+      documents: [document])
+  end
+
+  let(:param) do
+    instance_double('GrapeDoc::APIParameter',
+      field: 'radical_value',
+      field_type: 'String',
+      required: true,
+      description: 'This value is so very rad.  I bet you wish you were too.',
+      sample_value: 'raddish')
+  end
+
+  let(:document) do
+    instance_double('GrapeDoc::APIDocument',
+      params: [param],
+      http_method: 'POST',
+      path: '/a_twisty_path',
+      description: 'Nobody really knows what this does.'\
+        'Nobody but Zorp that is.')
+  end
+
+  subject(:markdown) { formatter.generate_resource_doc(resource) }
+
+  it 'escapes underscores in paths' do
+    expect(markdown).not_to match /\/a_twisty_path/
+    expect(markdown).to match /\/a\\_twisty\\_path/
+  end
+
+  it 'escapes underscores in param names' do
+    expect(markdown).not_to match /radical_value/
+    expect(markdown).to match /radical\\_value/
+  end
+end

metadata

@@ -1,42 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: grape_doc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors:
 - Alex Denisov
+- rayko
+- Jack Forrest
+- Chelsea Robb
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2015-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -44,7 +43,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -52,29 +50,26 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.7.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.7'
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.7.4
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -82,7 +77,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -90,6 +84,9 @@ dependencies:
 description: Documentation generator for Grape API
 email:
 - 1101.debian@gmail.com
+- rayko.drg@gmail.com
+- jack@jrforrest.net
+- chelsea.robb@gmail.com
 executables:
 - grape_doc
 extensions: []
@@ -119,33 +116,33 @@ files:
 - spec/api_resource_spec.rb
 - spec/api_response.rb
 - spec/doc_generator_spec.rb
+- spec/markdown_formatter_spec.rb
 - spec/spec_helper.rb
 - spec/test_classes/api.rb
 - spec/test_classes/projects.rb
 - spec/test_classes/users.rb
 homepage: https://github.com/AlexDenisov/grape_doc
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Documentation generator for Grape API
 test_files:
 - spec/api_document_spec.rb
@@ -154,8 +151,8 @@ test_files:
 - spec/api_resource_spec.rb
 - spec/api_response.rb
 - spec/doc_generator_spec.rb
+- spec/markdown_formatter_spec.rb
 - spec/spec_helper.rb
 - spec/test_classes/api.rb
 - spec/test_classes/projects.rb
 - spec/test_classes/users.rb
-has_rdoc: