autodoc-grape 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6797d121ea4b92281c65cc4bc1344f1a61c2c39c
+  data.tar.gz: e5ffe33e7aacdd5df46a3f4b1c9aa738a858dfec
+SHA512:
+  metadata.gz: 0cf1eb42e68f8b4286b20386256a76325febc32875a35d91d96c75907ebb4d62d2a956918ddac1f4ba08fc024118c4cdca92ca2ad66288cd8cf1be5bb3ce09f3
+  data.tar.gz: b656ac74787a9f9721f97256a526a229b8a4535a3fa3ce5f8c850b71d453b0828caf07f7decf0a840fc453ae83191643b87ffe863caf8811920919677cb54069

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle/
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+log/*.log
+pkg
+pkg/
+rdoc
+spec/dummy/.sass-cache
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/reports
+tmp
+vendor/bundle

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in autodoc-grape.gemspec
+gemspec
+
+group :test do
+  gem "pry-rails"
+  gem "rspec-rails"
+  gem "grape"
+  gem "redcarpet"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Keisuke Ishizawa
+
+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,40 @@
+# Autodoc::Grape
+
+Extend [r7kamura/autodoc](https:/github.com/r7kamura/autodoc/) to generate documention for [Grape API](https://github.com/ruby-grape/grape).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'autodoc-grape'
+```
+
+## Example
+
+### Grape API params block
+```ruby
+params do
+  requires :id, type: Integer
+  optional :hash, type: Hash do
+    requires :attr, type: String
+  end
+end
+```
+
+### Generated Parameter Section
+```md
+### Parameters
+* id Integer (required)
+* hash Hash
+ * attr String (required)
+```
+
+
+## Supported Parameter Options
+The following are all valid options.
+
+* required
+* values
+* default
+* description

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/autodoc-grape.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'autodoc/grape/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "autodoc-grape"
+  spec.version       = Autodoc::Grape::VERSION
+  spec.authors       = ["Keisuke Ishizawa"]
+  spec.email         = ["muddyapesjm66@gmail.com"]
+
+  spec.summary       = "Autodoc for Grape API specs."
+  spec.homepage      = "https://github.com/kei-p/autodoc-grape"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  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_dependency "autodoc"
+  spec.add_dependency "grape"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rails", "4.2.0"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "sqlite3"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "autodoc/grape"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/autodoc/grape.rb

@@ -0,0 +1,10 @@
+require "autodoc"
+require "autodoc/grape/version"
+require "autodoc/grape/document/parameter"
+require "autodoc/grape/monkey_patches/document_grape_extension"
+
+module Autodoc
+  module Grape
+    # Your code goes here...
+  end
+end

data/lib/autodoc/grape/document/parameter.rb

@@ -0,0 +1,62 @@
+module Autodoc
+  module Grape
+    module Document
+      class Parameter
+        attr_reader :validator
+
+        def initialize(validator)
+          @validator = validator
+        end
+
+        def to_s
+          "#{body}#{payload}"
+        end
+
+        private
+
+        def indent
+          " " * ( nest_key_names.count - 1 )
+        end
+
+        def nest_key_names
+          validator[0].gsub(%r{\[(.*?)\]}, '__\1').split('__')
+        end
+
+        def key
+          nest_key_names.last
+        end
+
+        def options
+          validator[1]
+        end
+
+        def body
+          "#{indent}* #{key} #{options[:type]}"
+        end
+
+        def payload
+          string = ""
+          string << " (#{assets.join(', ')})" if assets.any?
+          string << " - #{options[:desc]}" if options[:desc]
+          string
+        end
+
+        def required
+          "required" if options[:required]
+        end
+
+        def assets
+          @assets ||= [required, only, default_value].compact
+        end
+
+        def only
+          "only: `#{options[:values].inspect}`" if options[:values]
+        end
+
+        def default_value
+          "default: `#{options[:default].inspect}`" if options[:default]
+        end
+      end
+    end
+  end
+end

data/lib/autodoc/grape/monkey_patches/document_grape_extension.rb

@@ -0,0 +1,35 @@
+module DocumentGrapeExtension
+ private
+
+  def has_validators?
+    !!(grape_request? && validators) || super
+  end
+
+  def route_info
+    @route_info ||= begin
+      grape_request? ? request.env["rack.routing_args"][:route_info] : nil
+    end
+  end
+
+  def validators
+    if grape_request?
+      route_info.instance_variable_get(:@options)[:params]
+    else
+      super
+    end
+  end
+
+  def parameters
+    if grape_request?
+      validators.map { |validator| Autodoc::Grape::Document::Parameter.new(validator) }.join("\n")
+    else
+      super
+    end
+  end
+
+  def grape_request?
+    defined?(Grape) && request.env["rack.routing_args"][:route_info].instance_of?(Grape::Route) rescue false
+  end
+end
+
+Autodoc::Document.send(:prepend, DocumentGrapeExtension)

data/lib/autodoc/grape/version.rb

@@ -0,0 +1,5 @@
+module Autodoc
+  module Grape
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: autodoc-grape
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keisuke Ishizawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: autodoc
+  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'
+- !ruby/object:Gem::Dependency
+  name: grape
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !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: sqlite3
+  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'
+description: 
+email:
+- muddyapesjm66@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- autodoc-grape.gemspec
+- bin/console
+- bin/setup
+- lib/autodoc/grape.rb
+- lib/autodoc/grape/document/parameter.rb
+- lib/autodoc/grape/monkey_patches/document_grape_extension.rb
+- lib/autodoc/grape/version.rb
+homepage: https://github.com/kei-p/autodoc-grape
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Autodoc for Grape API specs.
+test_files: []