grape-markdown 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fd6795347e2d992cc9afb0cff433233546c37c85
-  data.tar.gz: 2ae1d275b9041fb8156b00fa03e0dba70771a152
+SHA256:
+  metadata.gz: fad2d95102ccd08211b6b9480baf46c7752fe4879ba1f3c9c977d4a983f36460
+  data.tar.gz: c8b13453a61502541bd5a02e91f47a291dc7526fc7bde4ee50ca3212fdf6f777
 SHA512:
-  metadata.gz: 0a932d99462ca9b8730897151b20876612919d4107a349851a3ee30a01902e11f6243a65f8039c0d87798e404ff5095d90b257240bd3fd5084414dbdff41b71b
-  data.tar.gz: 507427675239837beb66161070d93ecacf44fefa80348f951596444b0a4fd1136fa77d39221ff3dc3f3786b1a297984cf463f5af51022c29af512183ca00399d
+  metadata.gz: '09ef287f763ae561735f4ea622f70ce0194ee72a70fc3779384d66c0fb223e52c86b6a9e9ba58250ffc2f0fac56a9e836933cf6094b38f37fc0d941d0456c8b6'
+  data.tar.gz: 8fc77e96d6566ab94a645d8edf5bb3497b5a51c7bdb81397212b0d09a8996bdedbb88813d4fcee26eafa87a6b24ace29ada1d32fe47bda9e18e828be052aff07

data/.rubocop.yml

@@ -1,7 +1,7 @@
 AllCops:
+  TargetRubyVersion: 2.2
   Excludes:
-    - Rakefile
-    - vendor/**
+    - vendor/**/*
     - bin/**
 
 Documentation:
@@ -12,7 +12,23 @@ Encoding:
   # no need to always specify encoding
   Enabled: false
 
-LineLength:
-  # just one more character please
-  Max: 80
+Metrics/BlockLength:
+  Exclude:
+    - grape-markdown.gemspec
+    - spec/**/*
 
+Naming/FileName:
+  Exclude:
+    - lib/grape-markdown.rb
+
+Performance/StringReplacement:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: ()
+    "%i": ()
+    "%w": ()

data/.travis.yml

@@ -1,10 +1,11 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.1.0
-  - 2.0.0
-  - 1.9.3
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
   - jruby
 addons:
   code_climate:
-    repo_token: 
+    repo_token:

data/Gemfile

@@ -2,17 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in grape-markdown.gemspec
 gemspec
-
-gem 'grape', github: 'intridea/grape'
-
-group :development, :test do
-  gem 'coveralls', '~> 0.7'
-  gem 'rspec', '~> 2.14'
-  gem 'bundler', '~> 1.5'
-  gem 'rake', '~> 10.0'
-  gem 'rubocop', '~> 0.18'
-  gem 'pry', '~> 0.9'
-  gem 'guard', '~> 2.4'
-  gem 'guard-rspec', '~> 4.2'
-  gem 'guard-bundler', '~> 2.0'
-end

data/Guardfile

@@ -1,9 +1,9 @@
 # More info at https://github.com/guard/guard#readme
 
-guard 'rspec', :version => 2 do
+guard 'rspec', version: 2 do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec/" }
+  watch('spec/spec_helper.rb')  { 'spec/' }
 end
 
 guard 'bundler' do

data/Rakefile

@@ -11,9 +11,9 @@ end
 
 require 'rainbow/ext/string' unless String.respond_to?(:color)
 require 'rubocop/rake_task'
-Rubocop::RakeTask.new(:rubocop)
+RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+task default: %i(rubocop spec)
 
 task :console do
   require 'pry'

data/grape-markdown.gemspec

@@ -1,5 +1,6 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'grape-markdown/version'
 
@@ -8,25 +9,31 @@ Gem::Specification.new do |spec|
   spec.version       = GrapeMarkdown::VERSION
   spec.authors       = ['John Allen']
   spec.email         = ['john@threedogconsulting.com']
-  spec.summary       = %q{Allows for generating a Markdown document from you Grape API}
-  spec.description   = %q{Auto generates Markdown from the docuementation that is created by your Grape API}
   spec.homepage      = 'https://github.com/connexio-labs/grape-markdown'
   spec.license       = 'MIT'
 
+  spec.summary = <<-SUMMARY
+    Allows for generating a Markdown document from you Grape API
+  SUMMARY
+
+  spec.description = <<-DESCRIPTION
+    Auto generates Markdown from the docuementation that is created by your Grape API}
+  DESCRIPTION
+
   spec.files         = `git ls-files -z`.split("\x0")
   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_runtime_dependency 'grape', '~> 0.6'
+  spec.add_runtime_dependency 'grape', '>= 1.1.0'
 
-  spec.add_development_dependency 'coveralls', '~> 0.7'
-  spec.add_development_dependency 'rspec', '~> 2.14'
   spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rubocop', '~> 0.18'
-  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
   spec.add_development_dependency 'guard', '~> 2.4'
-  spec.add_development_dependency 'guard-rspec', '~> 4.2'
   spec.add_development_dependency 'guard-bundler', '~> 2.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.2'
+  spec.add_development_dependency 'pry', '~> 0.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'rubocop', '~> 0.60.0'
 end

data/lib/grape-markdown/configuration.rb

@@ -1,14 +1,14 @@
 module GrapeMarkdown
   class Configuration
-    SETTINGS = [
-      :name,
-      :description,
-      :request_headers,
-      :response_headers,
-      :example_id_type,
-      :resource_exclusion,
-      :include_root
-    ]
+    SETTINGS = %i(
+      name
+      description
+      request_headers
+      response_headers
+      example_id_type
+      resource_exclusion
+      include_root
+    ).freeze
 
     class << self
       attr_accessor(*SETTINGS)
@@ -34,14 +34,14 @@ module GrapeMarkdown
       end
 
       def supported_id_types
-        [:integer, :uuid, :bson]
+        %i(integer uuid bson)
       end
 
       def example_id_type=(value)
-        fail UnsupportedIDType unless supported_id_types.include?(value)
+        raise UnsupportedIDType unless supported_id_types.include?(value)
 
         if value.to_sym == :bson && !Object.const_defined?('BSON')
-          fail BSONNotDefinied
+          raise BSONNotDefinied
         end
 
         @example_id_type = value

data/lib/grape-markdown/document.rb

@@ -18,7 +18,7 @@ module GrapeMarkdown
     end
 
     def write
-      fail 'Not yet supported'
+      raise 'Not yet supported'
     end
 
     def routes
@@ -29,8 +29,8 @@ module GrapeMarkdown
 
     def resources
       @resources ||= begin
-        grouped_routes = routes.group_by(&:route_name).reject do |name, routes|
-          resource_exclusion.include?(name.parameterize('_').to_sym)
+        grouped_routes = routes.group_by(&:route_name).reject do |name, _routes|
+          resource_exclusion.include?(name.parameterize.underscore.to_sym)
         end
 
         grouped_routes.map { |name, routes| Resource.new(name, routes) }
@@ -38,7 +38,7 @@ module GrapeMarkdown
     end
 
     def properties_table(resource)
-      render(properties_template, resource.resource_binding)
+      render(properties_template, resource.route_binding)
     end
 
     def formatted_request_headers
@@ -50,7 +50,7 @@ module GrapeMarkdown
     end
 
     def show_request_sample?(route)
-      %w(PUT POST).include?(route.route_method)
+      %w(PUT POST).include?(route.request_method)
     end
 
     private

data/lib/grape-markdown/parameter.rb

@@ -2,7 +2,7 @@ module GrapeMarkdown
   class Parameter
     attr_reader :route, :full_name, :name, :settings
 
-    delegate :route_name, :route_namespace, to: :route
+    delegate :route_name, :namespace, to: :route
     delegate :requirement, :type, :documentation, :desc, to: :settings
     delegate :example, to: :documentation, allow_nil: true
 
@@ -25,20 +25,18 @@ module GrapeMarkdown
 
       options[:requirement] = options[:required] ? 'required' : 'optional'
 
-      Hashie::Mash.new(options)
+      JSON.parse(options.to_json, object_class: OpenStruct)
     end
 
-    def default_options(options)
+    def default_options(_options)
       model = name.include?('_id') ? name.gsub('_id', '') : route.route_name
 
       {
-        required:       true,
-        requirement:    'required',
-        type:           'uuid',
-        desc:           "the `id` of the `#{model}`",
-        documentation:  {
-          example:      GrapeMarkdown::Configuration.generate_id
-        }
+        required: true,
+        requirement: 'required',
+        type: 'uuid',
+        desc: "the `id` of the `#{model}`",
+        documentation: { example: GrapeMarkdown::Configuration.generate_id }
       }
     end
   end

data/lib/grape-markdown/resource.rb

@@ -14,13 +14,13 @@ module GrapeMarkdown
     end
 
     def namespaced
-      @namespaced ||= routes.group_by(&:route_namespace).map do |_, routes|
+      @namespaced ||= routes.group_by(&:namespace).map do |_, routes|
         Resource.new(name, routes)
       end
     end
 
     def paths
-      @paths ||= routes.group_by(&:route_path_without_format).map do |n, routes|
+      @paths ||= routes.group_by(&:route_path_without_format).map do |_, routes|
         Resource.new(name, routes)
       end
     end
@@ -46,7 +46,7 @@ module GrapeMarkdown
       methods = %w(POST PUT)
 
       potential = routes.select do |route|
-        methods.include?(route.route_method) && route.route_params.present?
+        methods.include?(route.request_method) && route.route_params.present?
       end
 
       if potential.present?

data/lib/grape-markdown/route.rb

@@ -2,14 +2,16 @@ module GrapeMarkdown
   class Route < SimpleDelegator
     # would like to rely on SimpleDelegator but Grape::Route uses
     # method_missing for these methods :'(
-    delegate :route_namespace,
-             :route_path,
-             :route_method,
-             :route_description,
-             to: '__getobj__'
+    delegate(
+      :namespace,
+      :path,
+      :request_method,
+      :route_description,
+      to: '__getobj__'
+    )
 
     def root_resource
-      route_namespace.split('/').reject(&:empty?).first
+      namespace.split('/').reject(&:empty?).first
     end
 
     def root_resource_title
@@ -17,13 +19,13 @@ module GrapeMarkdown
     end
 
     def route_params
-      @route_params ||= __getobj__.route_params.sort.map do |param|
+      @route_params ||= __getobj__.params.sort.map do |param|
         Parameter.new(self, *param)
       end
     end
 
     def route_name
-      route_namespace.split('/').last ||
+      namespace.split('/').last ||
         route_path.match('\/(\w*?)[\.\/\(]').captures.first
     end
 
@@ -33,7 +35,7 @@ module GrapeMarkdown
 
     def route_short_description
       description = <<-DESCRIPTION.gsub(/^\s*/, '').gsub(/\n/, ' ').squeeze
-      #{route_method.titleize} a
+      #{request_method.titleize} a
       #{list? ? 'list of '  : ' '}
       #{list? ? route_title : route_title.singularize}
       DESCRIPTION
@@ -44,7 +46,7 @@ module GrapeMarkdown
     end
 
     def route_path_without_format
-      route_path.gsub(/\((.*?)\)/, '')
+      path.gsub(/\((.*?)\)/, '')
     end
 
     def route_type
@@ -52,7 +54,7 @@ module GrapeMarkdown
     end
 
     def list?
-      route_method == 'GET' && !route_path.include?(':id')
+      request_method == 'GET' && !path.include?(':id')
     end
 
     def route_binding
@@ -62,7 +64,7 @@ module GrapeMarkdown
     private
 
     def request_body?
-      !%w(GET DELETE).include?(route_method)
+      !%w(GET DELETE).include?(request_method)
     end
 
     def parent?

data/lib/grape-markdown/templates/document.md.erb

@@ -4,11 +4,11 @@
 
 <% resources.each do |resource| %>
 # <%= resource.title %>
-<%= properties_table(resource) %>
   <% resource.namespaced.each do |grouped_resource| %>
     <% grouped_resource.paths.each do |resource_by_path| %>
       <% resource_by_path.routes.each do |route| %>
 ## <%= route.route_short_description %>
+<%= properties_table(route) %>
       <% end %>
     <% end %>
   <% end %>

data/lib/grape-markdown/templates/properties.md.erb

@@ -2,6 +2,6 @@ Properties
 
 | Name | Type | Description |
 |:-----|:-----|:------------|
-<% unique_params.each do |param| -%>
+<% route_params.each do |param| -%>
 | <%= param.full_name %> |  <%= param.type %> | <%= param.desc %> |
 <% end -%>

data/lib/grape-markdown/version.rb

@@ -1,3 +1,3 @@
 module GrapeMarkdown
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'.freeze
 end

data/spec/grape-markdown/configuration_spec.rb

@@ -42,7 +42,7 @@ describe GrapeMarkdown::Configuration do
   end
 
   context 'headers' do
-    [:request_headers, :response_headers].each do |type|
+    %i(request_headers response_headers).each do |type|
       context type do
         it 'is an array' do
           expect(subject.send(type)).to be_a(Array)

data/spec/grape-markdown/resource_spec.rb

@@ -15,7 +15,9 @@ describe GrapeMarkdown::Resource do
     it 'response generation is delegated to a generator' do
       expect(subject.sample_generator).to receive(:response)
 
-      subject.sample_response(GrapeMarkdown::Route.new(Grape::Route.new))
+      subject.sample_response(
+        GrapeMarkdown::Route.new(Grape::Router::Route.new('GET', '/'))
+      )
     end
   end
 end

data/spec/support/config_context.rb

@@ -1,7 +1,7 @@
 shared_context 'configuration' do
   let(:name)               { 'some api v1' }
   let(:description)        { 'some blueprint description' }
-  let(:resource_exclusion) { [:admin, :swagger_docs] }
+  let(:resource_exclusion) { %i(admin swagger_docs) }
 
   let(:request_headers) do
     [{ 'Accept-Charset' => 'utf-8' }]

data/spec/support/sample_api.rb

@@ -11,11 +11,11 @@ class SampleApi < Grape::API
     desc 'create a widget'
     params do
       requires :name,
-               type: 'string',
+               type: String,
                desc: 'the widgets name',
                documentation: { example: 'super widget' }
       optional :description,
-               type: 'string',
+               type: String,
                desc: 'the widgets name',
                documentation: { example: 'the best widget ever made' }
     end
@@ -24,10 +24,10 @@ class SampleApi < Grape::API
 
     desc 'update a widget'
     params do
-      optional :name, type: 'string', desc: 'the widgets name'
-      optional :description, type: 'string', desc: 'the widgets name'
+      optional :name, type: String, desc: 'the widgets name'
+      optional :description, type: String, desc: 'the widgets name'
     end
-    put  ':id' do
+    put ':id' do
     end
   end
 
@@ -35,7 +35,7 @@ class SampleApi < Grape::API
     desc 'create a sprocket for a specific widget'
     params do
       requires :name,
-               type: 'string',
+               type: String,
                desc: 'the widgets name',
                documentation: { example: 'super widget' }
     end
@@ -45,7 +45,7 @@ class SampleApi < Grape::API
     desc 'updates a sprocket for a specific widget'
     params do
       requires :name,
-               type: 'string',
+               type: String,
                desc: 'the widgets name',
                documentation: { example: 'super widget' }
     end

metadata

@@ -1,99 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: grape-markdown
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - John Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2018-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -109,49 +109,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.4'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '2.14'
 - !ruby/object:Gem::Dependency
-  name: guard-bundler
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.60.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
-description: Auto generates Markdown from the docuementation that is created by your
-  Grape API
+        version: 0.60.0
+description: "    Auto generates Markdown from the docuementation that is created
+  by your Grape API}\n"
 email:
 - john@threedogconsulting.com
 executables: []
@@ -207,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Allows for generating a Markdown document from you Grape API
@@ -220,4 +220,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/config_context.rb
 - spec/support/sample_api.rb
-has_rdoc: