grape_documenter 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape_doc.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Phil Lee
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,41 @@
+# GrapeDoc
+
+This adds a rake tasks to Rails Applications to generate documentation for Grape APIs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'grape_doc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install grape_doc
+
+## Usage
+
+Within the root of you Rails Application run the following rake task...
+
+   $ bundle exec rake generate_grape_docs['MyApplication::API','/path/to/where/you/want/your/docs']
+
+NOTE: The lack of space between the arguments. Rake doesn't like the space unless you wrap the whole thing as a string.
+
+The first argument is the a string of the class of Grape::API. If you have multiple APIs within the same application you can run the rake task as many times as you like with different output paths.
+
+### Specifying output format
+
+Currently 2 formats are supported: 'html'; 'textile'. The default is html. You can change the format as shown below...
+
+   $ bundle exec rake generate_grape_docs['MyApplication::API','/path/to/where/you/want/your/docs','textile']
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/grape_doc.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/grape_doc/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Phil Lee", "Steven Anderson"]
+  gem.email         = ["philip.lee@sage.com"]
+  gem.description   = "This adds a rake tasks to Rails Applications to generate documentation for Grape APIs."
+  gem.summary       = "This adds a rake tasks to Rails Applications to generate documentation for Grape APIs."
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "grape_documenter"
+  gem.require_paths = ["lib"]
+  gem.version       = GrapeDoc::VERSION
+
+  gem.add_dependency 'grape', '0.2.1'
+  gem.add_dependency 'RedCloth'
+  gem.add_dependency 'activesupport'
+
+  gem.add_development_dependency 'rspec'
+end

data/lib/grape_doc/formatters/html.rb

@@ -0,0 +1,17 @@
+require 'RedCloth'
+
+module GrapeDoc
+  module Formatters
+    # For ease this uses the textile formatter first then post processes to html
+    class Html
+      def initialize(structure)
+        @structure = structure
+      end
+
+      def format
+        textile = Textile.new(@structure)
+        RedCloth.new(textile.format).to_html
+      end
+    end
+  end
+end

data/lib/grape_doc/formatters/textile.rb

@@ -0,0 +1,66 @@
+require 'active_support/core_ext/object/blank'
+
+module GrapeDoc
+  module Formatters
+    class Textile
+      def initialize(structure)
+        @structure = structure
+      end
+
+      def format
+        doc = @structure
+
+        output = "h1. #{doc.title}"
+        output << "\n\n"
+        output << resource_navigation
+        output << "\n\n"
+
+        doc.routes.each do |route|
+          output << "\n\n"
+          output << "h2. #{route.route_method}: #{route.route_path.gsub(':version', doc.version)}"
+          output << "\n\n"
+
+          if route.route_description.present?
+            output << "h3. Description"
+            output << "\n\n"
+            output << route.route_description
+            output << "\n\n"
+          end
+
+          if route.route_params.present?
+            output << "h3. Parameters"
+            output << "\n\n"
+            output << tabulate_params(route.route_params)
+            output << "\n\n"
+          end
+        end
+
+        output
+      end
+
+      private
+
+      def resource_navigation
+        depth = (@structure.root_path.count('/')-1)
+        navigation = ''
+
+        @structure.resources.each do |resource|
+          navigation << "* \"#{resource[:name]}\":#{'../' * depth}#{resource[:path].sub('/', '')}.html\n"
+        end
+
+        navigation
+      end
+
+      def tabulate_params(params)
+        string = "|_.Name|_.Type|_.Description|\n"
+
+        params.each do |k,v|
+          v = {:desc => v} unless v.is_a?(Hash)
+          string << "|#{k}|#{v[:type]}|#{v[:desc]}|\n"
+        end
+
+        string
+      end
+    end
+  end
+end

data/lib/grape_doc/generator.rb

@@ -0,0 +1,89 @@
+require 'fileutils'
+require 'active_support/inflector'
+
+module GrapeDoc
+  class Generator
+    def initialize(api_class, output_path, options = {})
+      raise 'api_class must be specified' if api_class.nil?
+      raise 'output_path must be specified' if output_path.nil?
+
+      @output_path = output_path
+      @api_class = api_class.constantize
+      @format = options[:format] || 'html'
+    end
+
+    def generate_namespace_docs
+      docs = []
+
+      @api_class.versions.each do |version|
+        namespaces_for_version(version).each do |namespace|
+          docs << NamespaceDoc.new(:version => version,
+                                   :title => titleize(namespace),
+                                   :root_path => namespace,
+                                   :routes => routes_for_version_and_namespace(version, namespace),
+                                   :resources => resources_for_version(version))
+        end
+      end
+
+      docs
+    end
+
+    def output
+      files = {}
+      generate_namespace_docs.each do |doc|
+        puts doc.title
+
+        filename = File.join(@output_path, doc.version, "#{doc.root_path}.#{@format}")
+        files[filename] = self.send("generate_#{@format}", doc)
+      end
+
+      Writer.new(files).write_to_files!
+    end
+
+    private
+
+    def generate_textile(doc)
+      Formatters::Textile.new(doc).format
+    end
+
+    def generate_html(doc)
+      Formatters::Html.new(doc).format
+    end
+
+    def resources_for_version(version)
+      resources = []
+      namespaces_for_version(version).each do |resource|
+        resources << { :name => titleize(resource), :path => resource }
+      end
+      resources
+    end
+
+    def namespaces_for_version(version)
+      return instance_variable_get("@#{version}_namespaces") if instance_variable_get("@#{version}_namespaces")
+
+      instance_variable_set("@#{version}_namespaces", routes_for_version(version).map { |r| normalize_route_namespace(r) }.uniq)
+    end
+
+    def normalize_route_namespace(route)
+      n = route.route_namespace
+      route.route_params.each do |p,_|
+        n.gsub!(":#{p.gsub('/', '')}", '')
+      end
+      n.gsub(/\/+/, '/')
+    end
+
+    def routes_for_version(version)
+      return instance_variable_get("@#{version}_routes") if instance_variable_get("@#{version}_routes")
+
+      instance_variable_set("@#{version}_routes", @api_class.routes.select { |r| r.route_version == version })
+    end
+
+    def routes_for_version_and_namespace(version, namespace)
+      routes_for_version(version).select { |r| normalize_route_namespace(r) == namespace }
+    end
+
+    def titleize(string)
+      string.split('/').last.titleize
+    end
+  end
+end

data/lib/grape_doc/namespace_doc.rb

@@ -0,0 +1,13 @@
+module GrapeDoc
+  class NamespaceDoc
+    attr_accessor :title, :routes, :root_path, :version, :resources
+
+    def initialize(options = {})
+      @title = options[:title]
+      @routes = options[:routes]
+      @root_path = options[:root_path]
+      @version = options[:version]
+      @resources = options[:resources]
+    end
+  end
+end

data/lib/grape_doc/railtie.rb

@@ -0,0 +1,9 @@
+require 'grape_doc'
+
+module GrapeDoc
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/generate.rake'
+    end
+  end
+end

data/lib/grape_doc/version.rb

@@ -0,0 +1,3 @@
+module GrapeDoc
+  VERSION = "0.0.1"
+end

data/lib/grape_doc/writer.rb

@@ -0,0 +1,16 @@
+module GrapeDoc
+  class Writer
+    def initialize(doc_structure)
+      @doc_structure = doc_structure
+    end
+
+    def write_to_files!
+      @doc_structure.each do |filename, contents|
+        FileUtils.mkdir_p(File.dirname(filename))
+        File.open(filename, 'w') do |f|
+          f.write(contents)
+        end
+      end
+    end
+  end
+end

data/lib/grape_doc.rb

@@ -0,0 +1,10 @@
+require "grape_doc/version"
+
+module GrapeDoc
+  require 'grape_doc/generator'
+  require 'grape_doc/writer'
+  require 'grape_doc/namespace_doc'
+  require 'grape_doc/formatters/textile'
+  require 'grape_doc/formatters/html'
+  require 'grape_doc/railtie' if defined?(Rails)
+end

data/lib/tasks/generate.rake

@@ -0,0 +1,7 @@
+require 'grape_doc'
+
+desc "Generate documentation for Grape API"
+task :generate_grape_docs, [:api_class, :output_path, :format] => :environment do |t, args|
+  generator = GrapeDoc::Generator.new(args[:api_class], args[:output_path], :format => args[:format])
+  generator.output
+end

data/spec/formatters/textile_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe GrapeDoc::Formatters::Textile do
+  let(:mock_route) do
+    mock('route', :route_method => 'GET',
+                  :route_path => '/users',
+                  :route_description => 'users description goes here',
+                  :route_params => {:id => {:type => 'integer', :desc => 'user id'}})
+  end
+
+  let(:structure) do
+    GrapeDoc::NamespaceDoc.new :version => 'v1',
+        :title => 'Users',
+        :root_path => '/users',
+        :routes => [mock_route],
+        :resources => [{ :name => 'Contacts', :path => '/contacts' }]
+  end
+
+  subject { described_class.new(structure) }
+
+  it 'has h1 with title' do
+    subject.format.should include('h1. Users')
+  end
+
+  it 'has an h2 with method and path' do
+    subject.format.should include('h2. GET: /users')
+  end
+
+  it 'has an h3 and the description' do
+    subject.format.should include('h3. Description')
+    subject.format.should include('users description goes here')
+  end
+
+  it 'has an h3 and the route_params in a table' do
+    subject.format.should include('h3. Parameters')
+    subject.format.should include('|_.Name|_.Type|_.Description|')
+    subject.format.should include('|id|integer|user id|')
+  end
+end

data/spec/generator_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe GrapeDoc::Generator do
+  subject { described_class.new 'MyApplication::API', '/tmp/grape_doc' }
+
+  context 'for a given api version' do
+    it 'stores the version' do
+      subject.generate_namespace_docs.first.version.should == 'v1'
+    end
+
+    it 'stores the title' do
+      subject.generate_namespace_docs.first.title.should == 'User'
+    end
+
+    it 'stores the root_path' do
+      subject.generate_namespace_docs.first.root_path.should == '/user'
+    end
+
+    it 'stores the routes' do
+      subject.generate_namespace_docs.first.routes.should == MyApplication::API.routes.select{|r| r.route_version == 'v1'}
+    end
+
+    it 'stores the global resources' do
+      subject.generate_namespace_docs.first.resources.should == [{ :name => 'User', :path => '/user' }]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'grape_doc'
+require 'support/test_api'

data/spec/support/test_api.rb

@@ -0,0 +1,37 @@
+require 'grape'
+
+module MyApplication
+  class API < Grape::API
+    version 'v1' do
+      resource :user do
+        desc 'Get all users'
+        get do
+        end
+
+        desc 'Get the specified user', :params => {
+          'id' => { :desc => 'The id of the user', :type => 'integer' }
+        }
+        get ':id' do
+        end
+      end
+    end
+
+    version 'v2' do
+      resource :user do
+        desc 'Get all users'
+        get do
+        end
+
+        desc 'Get the specified user', :params => {
+          'id' => { :desc => 'The id of the user', :type => 'integer' }
+        }
+        get ':id' do
+        end
+
+        resource :comments do
+
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: grape_documenter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Phil Lee
+- Steven Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-15 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.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This adds a rake tasks to Rails Applications to generate documentation
+  for Grape APIs.
+email:
+- philip.lee@sage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- grape_doc.gemspec
+- lib/grape_doc.rb
+- lib/grape_doc/formatters/html.rb
+- lib/grape_doc/formatters/textile.rb
+- lib/grape_doc/generator.rb
+- lib/grape_doc/namespace_doc.rb
+- lib/grape_doc/railtie.rb
+- lib/grape_doc/version.rb
+- lib/grape_doc/writer.rb
+- lib/tasks/generate.rake
+- spec/formatters/textile_spec.rb
+- spec/generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_api.rb
+homepage: ''
+licenses: []
+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.24
+signing_key: 
+specification_version: 3
+summary: This adds a rake tasks to Rails Applications to generate documentation for
+  Grape APIs.
+test_files:
+- spec/formatters/textile_spec.rb
+- spec/generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_api.rb
+has_rdoc: