padrino-apidoc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fb1f30f39d0f5988df171674c6da506bcc7bb5fd
+  data.tar.gz: 800ba1b7c223635ed769d5fadcd02aaa96633bc1
+SHA512:
+  metadata.gz: c1fed3fd8780553a1f28481ba2801cc9ee09cce56666dc565f8f8f4cf51ee75df8ccc414eee26a3d712578add95ae9cebc0896b0039c89b56e5501a4344f8c7b
+  data.tar.gz: 3937c339f3b9d9102bde9cd17c3d47998cadca9d5bddcf4f99bb74f408ca65e7c49445d8914c6f7fce121931c07ef5c1661458a785b25339ce25b66ad08bba41

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 padrino-apidoc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Chris Blackburn, Midwire Technologies, LLC.
+
+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,58 @@
+# Padrino::Apidoc
+
+A padrino sub-app plugin to generate API documentation for your controllers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'padrino-apidoc'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install padrino-apidoc
+
+## Usage
+
+### Documentation Syntax
+
+    ## Section Name
+
+    # Create an application.
+    #
+    # @param <name>  the name of the application to create
+    # @param [stack] the stack on which to create the application
+    #
+    # @request
+    #   POST /apps.json
+    #   name=example&stack=bamboo-ree-1.8.7
+    # @response
+    #   {
+    #     "id":         1,
+    #     "name":       "example",
+    #     "owner":      "user@example.org",
+    #     "created_at": "Sat Jan 01 00:00:00 UTC 2000",
+    #     "stack":      "bamboo-ree-1.8.7",
+    #     "slug_size":  1000000,
+    #     "repo_size":  500000,
+    #     "dynos":      1,
+    #     "workers":    0
+    #   }
+
+At the end of your config/apps.rb file:
+
+    Padrino.mount('Padrino::Apidoc::App').to('/docs')
+
+Navigate to 'localhost:9292/docs' or whatever hostname/port you are running on.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require "midwire_common/rake_tasks"
+rescue Exception => e
+  puts ">>> You have to run that under 'bundle exec'"
+  exit
+end
+
+require "bundler/gem_tasks"

data/lib/padrino/apidoc/parser.rb

@@ -0,0 +1,109 @@
+# This code was taken directly from David Dollar's apidoc project:
+# https://github.com/ddollar/apidoc.
+#
+# It has been modified slightly to allow for more lenient route syntax
+module Padrino
+  module Apidoc
+
+    class Parser
+      class << self
+        def parse(files)
+          parser = self.new
+          files.each { |file| parser.parse_file(file) }
+          parser
+        end
+      end
+
+      attr_reader :docs
+
+      def initialize
+        @docs = []
+        @section = 'General'
+      end
+
+      def parse_file(file)
+        File.read(file).split("\n").each do |line|
+          case line.strip
+          when /\A##\s*(.+)\Z/ then
+            clear_comments
+            parse_section($1)
+          when /\A#(\s*.*)\Z/ then
+            parse_comment($1)
+          when /\A(get|post|put|delete)\s+(:.+),\s+map:\s+["'](.+)["']/ then
+            parse_method($1, $3)
+          when /\A(get|post|put|delete)\s+["'](.+)["']/ then
+            parse_method($1, $2)
+          when '' then
+          else
+            clear_comments
+          end
+        end
+      end
+
+      ########################################
+      private
+
+      def clear_comments
+        @comments = []
+      end
+
+      def parse_section(section)
+        @section = section.gsub("#", "").strip
+      end
+
+      def parse_comment(comment)
+        @comments << comment
+      end
+
+      def parse_comments(comments)
+        key = :description
+
+        comments.inject({}) do |parsed, comment|
+          case comment
+            when /\A\s*@param\s+(.+?)\s+(.+)/ then
+              parsed[:params] ||= []
+              required = $1[0..0] == '<'
+              name = $1[1..-2]
+              parsed[:params] << { :name => name, :description => $2, :required => required }
+            when /\A\s*@(\w+)\s*(.*)\Z/ then
+              key = $1.to_sym
+              parsed[key] ||= []
+              parsed[key]  << $2 if $2
+            else
+              parsed[key] ||= []
+              parsed[key]  << comment
+          end
+          parsed
+        end.inject({}) do |flattened, (k, v)|
+          case v.first
+            when String then
+              flattened[k] = strip_left(v.reject { |l| l.strip == "" }.join("\n"))
+            else
+              flattened[k] = v
+          end
+          flattened
+        end
+      end
+
+      def parse_method(verb, uri)
+        @docs << {
+          :section => @section,
+          :verb => verb,
+          :uri  => uri,
+        }.merge(parse_comments(@comments))
+
+        clear_comments
+      end
+
+      def strip_left(code)
+        first_line = code.split("\n").first
+        num_spaces = first_line.match(/\A */)[0].length
+        code.split("\n").map do |line|
+          line[num_spaces..-1]
+        end.join("\n")
+      end
+
+    end
+
+  end # module Apidoc
+end # module Padrino

data/lib/padrino/apidoc/version.rb

@@ -0,0 +1,5 @@
+module Padrino
+  module Apidoc
+    VERSION = "0.0.1"
+  end
+end

data/lib/padrino/apidoc.rb

@@ -0,0 +1,66 @@
+require 'padrino'
+require "padrino/apidoc/version"
+require "padrino/apidoc/parser"
+
+module Padrino
+  module Apidoc
+
+    class App < Padrino::Application
+      register Padrino::Rendering
+      register Padrino::Helpers
+
+      helpers do
+        def urlize_section(section)
+          section.downcase.gsub(" ", "_")
+        end
+
+        def docs_in_section(docs, section)
+          docs.select { |doc| urlize_section(doc[:section]) == section }
+        end
+
+        def code(code)
+          Haml::Filters::Preserve.render(Haml::Filters::Escaped.render(code))
+        end
+
+        def doc(page, title)
+          active = (env["PATH_INFO"] == "/#{page}") ? "active" : ""
+          %{ <li class="#{active}"><a href="/#{page}">#{title}</a></li> }
+        end
+      end
+
+      disable :sessions
+
+      class << self
+        def sections_in(docs)
+          docs.map { |doc| doc[:section] }.uniq.compact
+        end
+      end
+
+      set :docs, Parser.parse(Dir["#{Padrino.root}/app/controllers/*.rb"]).docs
+      set :sections, App.sections_in(settings.docs)
+
+      ########################################
+      # ROUTES
+      get "/" do
+        render :index, layout_engine: :haml, layout: 'apidoc', :locals => {
+          :docs     => settings.docs,
+          :sections => settings.sections
+        }
+      end
+
+      get "/docs.css" do
+        content_type "text/css"
+        sass :docs
+      end
+
+      get "/:section" do |section|
+        haml :section, :locals => {
+          :docs     => docs_in_section(settings.docs, section),
+          :sections => settings.sections,
+          :section  => settings.sections.detect { |s| urlize_section(s) == section }
+        }
+      end
+    end
+
+  end
+end

data/padrino-apidoc.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'padrino/apidoc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "padrino-apidoc"
+  spec.version       = Padrino::Apidoc::VERSION
+  spec.authors       = ["Chris Blackburn"]
+  spec.email         = ["chris@midwiretech.com"]
+  spec.description   = %q{A padrino sub-app plugin to generate API documentation for your controllers.}
+  spec.summary       = %q{A padrino sub-app plugin to generate API documentation for your controllers.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "midwire_common"
+
+  spec.add_dependency 'padrino'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: padrino-apidoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Blackburn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: midwire_common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: padrino
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A padrino sub-app plugin to generate API documentation for your controllers.
+email:
+- chris@midwiretech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/padrino/apidoc.rb
+- lib/padrino/apidoc/parser.rb
+- lib/padrino/apidoc/version.rb
+- padrino-apidoc.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A padrino sub-app plugin to generate API documentation for your controllers.
+test_files: []