jekyll-ramler 0.0.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0d668fb1022f6cb3700db26e4dd935fa746f63f9
-  data.tar.gz: 64a617df40cdd668a128867b2846ee32e058e510
+SHA256:
+  metadata.gz: e30231809c7110df77da7e8fce68e66eeb800e862833da83927d141c030c332f
+  data.tar.gz: 845af5a3bcd4ec6e1739e1ec4bf45b933515d32c0f8f7fdf6a0b6a7297b31601
 SHA512:
-  metadata.gz: fafd7d5467c72fbee707c63b9be5827a9c07d6ab263f4506ee2249552c6f95704a2bdc3a3cf6a7d2380a1e7b8e6b12f7318a9f57950e0693d36a3c3dcb2a8eef
-  data.tar.gz: b970d476f50ec64b0c15a0c86453ee7b50d1bf6190cafb61cf7581e4400e01edcc5b8cb9e5a59a2901362bcf9997081cffa71afaad42425696a3ac5094b709fd
+  metadata.gz: a3c2eaabfd27d68fdc5fb270a2d009108e4a7b3c3949f63d039782529da98ca70e8a1bf7fd68d5c48984804fc32cb6af4642ef6c125f4a2684df3fa9a2254120
+  data.tar.gz: b7cf9ac6d6bc7165eb4d55b4789f3b6c49a84522e13f7dd559392af97c01aae49365f2227e3a655577baff7b6d7650247b68d8950d65b7f9c84996949ed0a69a

data/.gitignore

@@ -0,0 +1,3 @@
+.bundle/
+.idea/
+vendor/

data/.travis.yml

@@ -1,10 +1,13 @@
 language: ruby
 rvm:
-  - 1.9.3-p547
-  - 2.1.5
-  - 2.2.0
+  - 2.3.5
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 install:
-  - npm install raml-cop
+  - npm install raml-cop@^1.1.0 -g
+  - gem install bundler -v 2.1.4
   - bundle install
 script: "bundle exec rspec"
 branches:

data/CHANGELOG

@@ -1,7 +1,31 @@
 CHANGELOG
 ==========
 
-This project does *not* adhere to Semantic Versioning
+## 1.0.0 - 2020-09-01
+
+ - Updated various dependencies
+
+## 0.0.10 - 2015-03-18 
+
+### Fixed
+
+- Generated JSON Schema table view now presents schema of child objects as
+	"Properties" or "Items" instead of "Example"
+
+## 0.0.9 - 2015-03-02
+
+### Fixed
+
+- Generated JSON Schema no-longer include the displayName attribute from RAML
+
+## 0.0.8 - 2015-02-25
+
+### Fixed
+
+- Newlines are no longer removed in descriptions in JSON Schema, maintaining
+	ability to transform via Markdown
+- Fixed bug that could cause changes to JSON Schema to also appear in hash of
+	x-www-form-urlencoded formParameters
 
 ## 0.0.7 - 2015-02-25 
 

data/Gemfile

@@ -3,9 +3,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :test, :development do
-  gem 'fakefs', require: 'fakefs/safe'
+  gem 'fakefs', '= 1.2.1', require: 'fakefs/safe'
   gem 'pry'
   gem 'rspec'
   gem 'rspec-mocks'
-  gem 'ruby_deep_clone'
 end

data/Gemfile.lock

@@ -1,74 +1,69 @@
 PATH
   remote: .
   specs:
-    jekyll-ramler (0.0.7)
-      jekyll
+    jekyll-ramler (1.0.0)
+      jekyll (~> 3.9.0)
+      kramdown-parser-gfm (~> 1.1.0)
+      ruby_deep_clone
 
 GEM
   remote: https://rubygems.org/
   specs:
-    blankslate (2.1.2.4)
-    celluloid (0.16.0)
-      timers (~> 4.0.0)
-    classifier-reborn (2.0.3)
-      fast-stemmer (~> 1.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.0)
-    coffee-script (2.3.0)
-      coffee-script-source
-      execjs
-    coffee-script-source (1.9.0)
-    colorator (0.1)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.7)
     diff-lcs (1.2.5)
-    execjs (2.3.0)
-    fakefs (0.6.5)
-    fast-stemmer (1.0.2)
-    ffi (1.9.6)
-    hitimes (1.2.2)
-    jekyll (2.5.3)
-      classifier-reborn (~> 2.0)
-      colorator (~> 0.1)
-      jekyll-coffeescript (~> 1.0)
-      jekyll-gist (~> 1.0)
-      jekyll-paginate (~> 1.0)
+    em-websocket (0.5.1)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    fakefs (1.2.1)
+    ffi (1.13.1)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.6.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (3.9.0)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 0.7)
       jekyll-sass-converter (~> 1.0)
-      jekyll-watch (~> 1.1)
-      kramdown (~> 1.3)
-      liquid (~> 2.6.1)
+      jekyll-watch (~> 2.0)
+      kramdown (>= 1.17, < 3)
+      liquid (~> 4.0)
       mercenary (~> 0.3.3)
-      pygments.rb (~> 0.6.0)
-      redcarpet (~> 3.1)
+      pathutil (~> 0.9)
+      rouge (>= 1.7, < 4)
       safe_yaml (~> 1.0)
-      toml (~> 0.1.0)
-    jekyll-coffeescript (1.0.1)
-      coffee-script (~> 2.2)
-    jekyll-gist (1.1.0)
-    jekyll-paginate (1.1.0)
-    jekyll-sass-converter (1.3.0)
-      sass (~> 3.2)
-    jekyll-watch (1.2.1)
-      listen (~> 2.7)
-    kramdown (1.5.0)
-    liquid (2.6.2)
-    listen (2.8.5)
-      celluloid (>= 0.15.2)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    mercenary (0.3.5)
+    jekyll-sass-converter (1.5.2)
+      sass (~> 3.4)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.3.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.3.6)
     method_source (0.8.2)
-    parslet (1.5.0)
-      blankslate (~> 2.0)
-    posix-spawn (0.3.9)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
     pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pygments.rb (0.6.2)
-      posix-spawn (~> 0.3.6)
-      yajl-ruby (~> 1.2.0)
-    rb-fsevent (0.9.4)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
-    redcarpet (3.2.2)
+    public_suffix (4.0.5)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.4)
+    rouge (3.22.0)
     rspec (3.2.0)
       rspec-core (~> 3.2.0)
       rspec-expectations (~> 3.2.0)
@@ -82,23 +77,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.2.0)
     rspec-support (3.2.1)
-    ruby_deep_clone (0.6.0)
-    safe_yaml (1.0.4)
-    sass (3.4.11)
+    ruby_deep_clone (0.8.0)
+    safe_yaml (1.0.5)
+    sass (3.7.4)
+      sass-listen (~> 4.0.0)
+    sass-listen (4.0.0)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
     slop (3.6.0)
-    timers (4.0.1)
-      hitimes
-    toml (0.1.2)
-      parslet (~> 1.5.0)
-    yajl-ruby (1.2.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  fakefs
+  fakefs (= 1.2.1)
   jekyll-ramler!
   pry
   rspec
   rspec-mocks
-  ruby_deep_clone
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,4 +1,4 @@
-[![Build Status](https://travis-ci.org/govdelivery/jekyll-ramler.svg?branch=master)](https://travis-ci.org/govdelivery/jekyll-ramler)
+[![Build Status](https://travis-ci.com/Granicus/jekyll-ramler.svg?branch=master)](https://travis-ci.com/Granicus/jekyll-ramler)
 [![Gem Version](https://badge.fury.io/rb/jekyll-ramler.svg)](http://badge.fury.io/rb/jekyll-ramler)
 
 jekyll-ramler
@@ -18,6 +18,15 @@ specificed in a RAML file.
 - Supports Raw and Table based displays of JSON Schema included in your RAMLs
 - Automatic insertion of inherited JSON Schema (via `$ref` and `allOf`)
 
+## Example
+
+GovDelivery's developer documentation site, <http://developer.govdelivery.com>, 
+is built on jekyll-ramler, [jekyll-code-example-tag](https://github.com/govdelivery/jekyll-code-example-tag), 
+and [jekyll-nested-menu-generator](https://github.com/govdelivery/jekyll-nested-menu-generator).
+
+For an example of the output generated by jekyll-ramler, please visit 
+GovDelivery's TMS API documentation at <http://developer.govdelivery.com/api/tms/>.
+
 ## Installation
 
 ### Dependencies

data/jekyll-ramler.gemspec

@@ -1,16 +1,20 @@
 Gem::Specification.new do |s|
   s.name        = 'jekyll-ramler'
-  s.version     = '0.0.7'
-  s.date        = '2015-02-09'
-  s.authors     = ['GovDelivery']
-  s.email       = 'support@govdelivery.com'
-  s.homepage    = 'https://github.com/govdelivery/jekyll-ramler'
+  s.version     = '1.0.0'
+  s.date        = '2020-09-01'
+  s.authors     = ['Granicus']
+  s.email       = 'support@granicus.com'
+  s.homepage    = 'https://github.com/granicus/jekyll-ramler'
   s.license     = 'BSD-3-Cluase'
   s.summary     = 'Jekyll plugin that generates API documentation pages based on RAML'
   s.description = %q{Generates Jekyll pages for overview, security, and 
                      resource documentation specificed in a RAML file.}
 
-  s.add_runtime_dependency  'jekyll'
+  s.required_ruby_version = '>= 2.3.0'
+
+  s.add_runtime_dependency  'jekyll', '~> 3.9.0'
+  s.add_runtime_dependency  'kramdown-parser-gfm', '~> 1.1.0'
+  s.add_runtime_dependency  'ruby_deep_clone'
 
   s.files       = `git ls-files`.split($\)
   s.require_paths = ['lib']

data/lib/raml-generate.rb

@@ -40,8 +40,8 @@ module Jekyll
       def transform_md(output)
         # Use the existing Jekyll Markdown converters
         md_converters = site.converters.select{|c| c.matches('.md')}
-        md_converters.reduce(output) do |output, converter|
-          converter.convert output 
+        md_converters.reduce(output) do |output_to_convert, converter|
+          converter.convert output_to_convert
         end
       end
 
@@ -52,14 +52,14 @@ module Jekyll
 
         default = {"values" => {}} if default.nil?
 
-        layout = default['values'].fetch('layout', 'default')
+        default['values'].fetch('layout', 'default')
       end
 
   end
 
   class SecuritySchemePage<GeneratedPage
     def initialize(site, base, web_root, dir, securityScheme)
-        super(site, base, web_root, dir, securityScheme, layout=get_layout("#{web_root}resource", site))
+        super(site, base, web_root, dir, securityScheme, get_layout("#{web_root}resource", site))
     end
   end
 
@@ -163,22 +163,22 @@ module Jekyll
               when 'application/json'
                 obj['schema_hash'] = JSON.parse(obj['schema'])
 
-                refactor_object = lambda do |obj|
-                  obj['properties'].each do |name, param|
+                refactor_object = lambda do |lam_obj|
+                  lam_obj['properties'].each do |name, param|
                     param['displayName'] = name
-                    param['required'] = true if obj.fetch('required', []).include?(name)
+                    param['required'] = true if lam_obj.fetch('required', []).include?(name)
 
                     if param.include?('example') and ['object', 'array'].include?(param['type'])
                       param['example'] = JSON.pretty_generate(JSON.parse(param['example']))
                     elsif param.include?('properties')
-                      param['example'] = JSON.pretty_generate(param['properties'])
+                      param['properties'] = JSON.pretty_generate(param['properties'])
                     elsif param.include?('items')
-                      param['example'] = JSON.pretty_generate(param['items'])
+                      param['items'] = JSON.pretty_generate(param['items'])
                     end
 
-                    obj['properties'][name] = param
+                    lam_obj['properties'][name] = param
                   end
-                  obj
+                  lam_obj
                 end
 
                 if obj['schema_hash'].include?('properties')
@@ -248,7 +248,37 @@ module Jekyll
         @site.pages << DocumentationPage.new(@site, @site.source, @web_root, documentation_dir, documentation)
       end
 
+      generate_downloadable_descriptors(raml_hash, raml_path)
+    end
+
+    private
+    def generate_resource_pages(resources, parent_dir=nil)
+
+      if parent_dir
+        dir = parent_dir
+      else 
+        dir = Jekyll::get_dir('resource', @site.config)
+      end
+
+      resources.each do |resource|
+        resource_name = resource["relativeUri"]
+        resource_dir = File.join(dir, resource_name)
+        @site.pages << ResourcePage.new(@site, @site.source, @web_root, resource_dir, resource, @traits, @securitySchemes)
+        generate_resource_pages(resource['resources'], resource_dir) if resource.has_key?('resources')
+      end
+    end
+
+    def generate_downloadable_descriptors(raml_hash, raml_path)
       # Allow users to download descriptor as RAML and JSON, which may be modified since it was read
+      raml_hash = DeepClone.clone raml_hash 
+
+      # Get rid of 'title' attribute added to security schemes
+      # securitySchemes will be an array of hashes containing one key (Name) value (a hash of properties) pairing
+      raml_hash.fetch('securitySchemes', []).each {|el| el.each_value { |scheme| scheme.delete('title') }}
+
+      # replace "resources" with the associated "relativeUri" of each resource
+      fix_resources(raml_hash)
+
       download_basename = @site.config.fetch('ramler_downloadable_descriptor_basenames', {}).fetch(raml_path, 'api') 
       raml_download_filename = download_basename + '.raml'
       json_download_filename = download_basename + '.json'
@@ -261,24 +291,27 @@ module Jekyll
       @site.static_files << RawFile.new(@site, @site.source, @web_root, json_download_filename, raml_json) 
     end
 
-    private
-      def generate_resource_pages(resources, parent_dir=nil)
-
-        if parent_dir
-          dir = parent_dir
-        else 
-          dir = Jekyll::get_dir('resource', @site.config)
-        end
-
-        resources.each do |resource|
-          resource_name = resource["relativeUri"]
-          resource_dir = File.join(dir, resource_name)
-          @site.pages << ResourcePage.new(@site, @site.source, @web_root, resource_dir, resource, @traits, @securitySchemes)
-          if resource.has_key?('resources')
-            generate_resource_pages(resource['resources'], resource_dir)
-        end
+    def fix_resources(raml_hash) 
+      # DFS FTW
+      raml_hash.fetch('resources', []).each do |resource_hash|
+        raml_hash[resource_hash.delete('relativeUri')] = resource_hash
+        fix_resources(resource_hash)
+      end
 
+      raml_hash.fetch('methods', []).each do |method_hash|
+        raml_hash[method_hash.delete('method')] = method_hash
+        fix_body(method_hash)
       end
+      raml_hash.delete('methods')
+      raml_hash.delete('schema_hash') 
+      raml_hash.delete('relativeUriPathSegments')
+      raml_hash.delete('resources')
+      raml_hash
+    end
+
+    def fix_body(method_hash)
+        method_hash.fetch('body', {}).each {|content_type, definition| definition.delete('schema_hash')} 
+        method_hash.fetch('responses', {}).each {|response_code, response_hash| fix_body(response_hash) if response_hash}
     end
   end
 end

data/lib/utils.rb

@@ -1,4 +1,5 @@
 require 'json'
+require 'deep_clone'
 
 module Jekyll
   def self.get_dir(page_type, config)
@@ -6,11 +7,14 @@ module Jekyll
   end
 
   def self.sanatize_json_string(s)
-      strip_newlines(s)
+      # This use to do something. Hopefully someday it will do something again
+      # See strip_newlines
+      s
   end
 
   def self.strip_newlines(s)
     # Assuming Markdown, so do NOT remove consecutive newlines
+    # TODO Also do not remove newlines at end of list items
     regex = /([^\n])\n([^\n])/
     s.gsub(regex, '\1 \2').strip
   end
@@ -69,7 +73,7 @@ module Jekyll
       schema_hash['type'] = 'object'
 
       required_properties = []
-      schema_hash['properties'] = obj['body']['application/x-www-form-urlencoded']['formParameters'].dup
+      schema_hash['properties'] = DeepClone.clone obj['body']['application/x-www-form-urlencoded']['formParameters']
       schema_hash['properties'].each do |name, param|
         if param.include?('required')
           required_properties << name if param['required'] == true
@@ -80,10 +84,9 @@ module Jekyll
           param['description'] = Jekyll::sanatize_json_string(param['description']) 
         end
 
-        # Repeat is not a supported keyword in JSON Schema 
-        if param.include?('repeat')
-          param.delete('repeat')
-        end
+        # Repeat and displayName are not supported keywords in JSON Schema
+        param.delete('repeat')
+        param.delete('displayName')
       end
       schema_hash['required'] = required_properties if not required_properties.empty?
       

data/spec/spec_helper.rb

@@ -30,11 +30,13 @@ def example_raml_hash
             'application/x-www-form-urlencoded' => {
               'formParameters' => {
                 'foo' => {
+                  'displayName' => 'foo',
                   'description' => 'Fooing',
                   'type' => 'string',
                   'example' => 'Foo'
                 },
                 'bar' => {
+                  'displayName' => 'bar',
                   'description' => 'A place to get a drink',
                   'type' => 'object'
                 }

data/spec/utils_raml_schema_generator_spec.rb

@@ -17,6 +17,14 @@ describe 'Utils' do
         expect(json_schema['properties']).to eq(JSON.parse(simple_schema)['properties'])
       end
 
+      it 'creates a JSON Schema string that does not include unsupported RAML keywords' do
+        json_schema = JSON.parse(@rsg.generate_json_schema(@raml_hash['resources']['/test_resource']['post']) )
+        json_schema['properties'].each do |prop|
+          expect(prop).not_to include('repeat')
+          expect(prop).not_to include('displayName')
+        end
+      end
+
       it 'creates a JSON Schema with a required attribute if application/x-www-form-urlencoded:formParameters includes a required parameter' do
         @raml_hash['resources']['/test_resource']['post']['body']['application/x-www-form-urlencoded']['formParameters']['bar']['required'] = true
         json_schema = JSON.parse(@rsg.generate_json_schema(@raml_hash['resources']['/test_resource']['post']))

metadata

@@ -1,37 +1,66 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-ramler
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 1.0.0
 platform: ruby
 authors:
-- GovDelivery
-autorequire: 
+- Granicus
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: kramdown-parser-gfm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: ruby_deep_clone
+  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: "Generates Jekyll pages for overview, security, and \n                     resource
   documentation specificed in a RAML file."
-email: support@govdelivery.com
+email: support@granicus.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - Gemfile.lock
@@ -51,28 +80,27 @@ files:
 - spec/spec_helper.rb
 - spec/utils_json_schema_compiler_spec.rb
 - spec/utils_raml_schema_generator_spec.rb
-homepage: https://github.com/govdelivery/jekyll-ramler
+homepage: https://github.com/granicus/jekyll-ramler
 licenses:
 - BSD-3-Cluase
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Jekyll plugin that generates API documentation pages based on RAML
 test_files: []