ramlstyle 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1b112906842c3a5ec171c0bf8c19b0ce3b222b8
+  data.tar.gz: c8965a05a9a1b4d13a79902f028dc3eee3cad339
+SHA512:
+  metadata.gz: 5688b30823f76bb2fab1a99edd109ff311d51043833676d60748e0bb489f6194c9935e3a03ed7c5ac733a8f1508d3269aff013993d561bd23b10e288dc09dc23
+  data.tar.gz: dcf1ed3540a59299e2f1cbf2ad4ac902cce2c5e837b717c04081b3d9bb810fe6bf825732c9258e94c3db1485377cab6db90255aead3b4e747f9cb9d2db716745

data/.gitignore

@@ -0,0 +1,44 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/output/
+run-samples
+.DS_Store
+
+# Binstubs
+/bin/_guard-core
+/bin/bundler
+/bin/coderay
+/bin/erubis
+/bin/flay
+/bin/flog
+/bin/github-markup
+/bin/guard
+/bin/htmldiff
+/bin/launchy
+/bin/ldiff
+/bin/listen
+/bin/pry
+/bin/rake
+/bin/ramlstyle
+/bin/redcarpet
+/bin/reek
+/bin/rspec
+/bin/rubocop
+/bin/ruby-parse
+/bin/ruby-rewrite
+/bin/ruby_parse
+/bin/ruby_parse_extract_error
+/bin/rubycritic
+/bin/sandi_meter
+/bin/thor
+/bin/unparser
+/bin/yard
+/bin/yardoc
+/bin/yri

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+  Exclude:
+    - 'bin/*'
+
+StringLiterals:
+  Enabled: false
+  # EnforcedStyle: double_quotes
+
+LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,162 @@
+PATH
+  remote: .
+  specs:
+    ramlstyle (0.2.3)
+      raml_ruby
+      redcarpet
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.8)
+    ast (2.3.0)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    codeclimate-engine-rb (0.4.0)
+      virtus (~> 1.0)
+    coderay (1.1.1)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    equalizer (0.0.11)
+    erubis (2.7.0)
+    ffi (1.9.17)
+    flay (2.8.1)
+      erubis (~> 2.7.0)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.0)
+      sexp_processor (~> 4.0)
+    flog (4.6.1)
+      path_expander (~> 1.0)
+      ruby_parser (~> 3.1, > 3.1.0)
+      sexp_processor (~> 4.8)
+    formatador (0.2.5)
+    guard (2.14.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-minitest (2.4.6)
+      guard-compat (~> 1.2)
+      minitest (>= 3.0)
+    i18n (0.8.1)
+    ice_nine (0.11.2)
+    json (2.0.3)
+    json-schema (2.6.2)
+      addressable (~> 2.3.8)
+    launchy (2.4.3)
+      addressable (~> 2.3)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.11)
+    metaclass (0.0.4)
+    method_source (0.8.2)
+    minitest (5.10.1)
+    mixlib-cli (1.7.0)
+    mocha (1.2.1)
+      metaclass (~> 0.0.1)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parser (2.3.3.1)
+      ast (~> 2.2)
+    path_expander (1.0.1)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.2.1)
+    rake (12.0.0)
+    raml_ruby (0.1.2)
+      activesupport (>= 4.1)
+      json-schema (~> 2.5)
+      uri_template (~> 0.7)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.8)
+      ffi (>= 0.5.0)
+    redcarpet (3.4.0)
+    reek (4.5.6)
+      codeclimate-engine-rb (~> 0.4.0)
+      parser (>= 2.3.1.2, < 2.5)
+      rainbow (~> 2.0)
+    rubocop (0.47.1)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.8.1)
+    ruby_dep (1.5.0)
+    ruby_parser (3.8.4)
+      sexp_processor (~> 4.1)
+    rubycritic (3.1.3)
+      flay (~> 2.8)
+      flog (~> 4.4)
+      launchy (= 2.4.3)
+      parser (= 2.3.3.1)
+      rainbow (~> 2.1)
+      reek (~> 4.4)
+      ruby_parser (~> 3.8)
+      virtus (~> 1.0)
+    sandi_meter (1.2.0)
+      json
+      launchy
+      mixlib-cli
+    sexp_processor (4.8.0)
+    shellany (0.0.1)
+    simplecov (0.13.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    slop (3.6.0)
+    thor (0.19.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.1.3)
+    uri_template (0.7.0)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  guard
+  guard-minitest
+  minitest
+  mocha
+  pry
+  rake
+  ramlstyle!
+  rubocop
+  rubycritic
+  sandi_meter
+  simplecov
+
+BUNDLED WITH
+   1.14.5

data/Guardfile

@@ -0,0 +1,6 @@
+guard :minitest do
+  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+  watch(%r{^templates/(.*)\.erb$})      { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,13 @@
+  Copyright 2017 Mark Edward Morga
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,49 @@
+# Ramlstyle
+
+Validates the a RAML file, runs lint rules against it, and produces HTML documentation.
+
+## Installation
+
+Clone this repository on your machine, install dependencies and install the command.
+
+```sh
+git clone https://github.com/mmorga/ramlstyle.git
+bundle
+sudo bundle exec rake install  # if you are using the system Ruby
+bundle exec rake install   # if you are using a rbenv, rvm, etc
+```
+
+If you aren't a regular ruby user, you should do this first:
+
+```sh
+sudo gem install bundler
+```
+
+## Usage
+
+Usage: `ramlstyle [options] file1 file2 ...`
+
+Option               | Description
+-------------------- | -----------
+-v, --verbose        | Output more information
+    --no-document    | Do not produce HTML documentation
+    --no-lint        | Do not run linter rules
+-o, --output-dir DIR | Write HTML documentation to DIR
+    --version        | print the version
+-h, --help           | Display this screen
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ramlstyle.
+
+## Credits
+
+1. Templates are derived from templates from [RAML2HTML](https://github.com/kevinrenskers/raml2html)
+2. RAML is parsed with [raml_ruby](https://github.com/coub/raml_ruby)
+

data/Rakefile

@@ -0,0 +1,28 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+RuboCop::RakeTask.new do |task|
+  task.patterns = ['exe/*', 'lib/**/*.rb', 'test/**/*.rb']
+end
+
+desc "Run rubycritic on source and display results"
+task :rubycritic do
+  sh "bin/rubycritic;open tmp/rubycritic/overview.html"
+end
+
+desc "Run sandi_meter on source and display results"
+task :sandi do
+  sh "sandi_meter -o tmp/sandi_meter -g"
+end
+
+desc "Run rubocop, rubycritic, and sandi_meter on source and display results"
+task quality: [:rubycritic, :sandi, :rubocop]
+
+task default: :test

data/bin/code_climate_reek

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'code_climate_reek' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("reek", "code_climate_reek")

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ramlstyle"
+
+# 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/exe/ramlstyle

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'ramlstyle'
+
+Ramlstyle::CLICommand.new.run(ARGV)

data/lib/ramlstyle/cli_command.rb

@@ -0,0 +1,13 @@
+module Ramlstyle
+  class CLICommand
+    attr_reader :opts
+
+    def run(args)
+      @opts = Command::Options.new.parse(args)
+
+      opts.files.each do |raml_file|
+        Command::FileCommand.new(opts, raml_file).run
+      end
+    end
+  end
+end

data/lib/ramlstyle/command/command_chain.rb

@@ -0,0 +1,13 @@
+module Ramlstyle
+  module Command
+    class CommandChain
+      def initialize(next_command = EndChain.new)
+        @next_command = next_command
+      end
+
+      def run(opts, raml_file, raml)
+        @next_command.run(opts, raml_file, raml)
+      end
+    end
+  end
+end

data/lib/ramlstyle/command/document_command.rb

@@ -0,0 +1,17 @@
+module Ramlstyle
+  module Command
+    class DocumentCommand < CommandChain
+      def run(opts, raml_file, raml)
+        Ramlstyle::Document.new(raml)
+          .render_to_file(output_file(opts.output_dir, raml_file)) unless opts.no_document
+        super(opts, raml_file, raml)
+      end
+
+      private
+
+      def output_file(output_dir, raml_file)
+        File.join(output_dir, "#{File.basename(raml_file, '.raml')}.html")
+      end
+    end
+  end
+end

data/lib/ramlstyle/command/end_chain.rb

@@ -0,0 +1,8 @@
+module Ramlstyle
+  module Command
+    class EndChain
+      def run(*)
+      end
+    end
+  end
+end

data/lib/ramlstyle/command/file_command.rb

@@ -0,0 +1,21 @@
+module Ramlstyle
+  module Command
+    class FileCommand
+      def initialize(opts, raml_file)
+        @opts = opts
+        @raml_file = raml_file
+      end
+
+      def run
+        puts "\nParsing #{@raml_file}"
+
+        begin
+          ParseCommand.new(ReviewCommand.new(DocumentCommand.new)).run(@opts, @raml_file)
+        rescue StandardError => error
+          puts error
+          print error.backtrace.join("\n") if @opts.trace
+        end
+      end
+    end
+  end
+end

data/lib/ramlstyle/command/options.rb

@@ -0,0 +1,33 @@
+require "optparse"
+
+module Ramlstyle
+  module Command
+    class Options
+      def exit_with_msg(msg)
+        puts msg
+        exit
+      end
+
+      def parse(arguments)
+        settings = Settings.new
+        args = arguments.clone # so we don't cause side-effects
+        option_parser(settings).parse!(args)
+        settings.files = args
+        settings.freeze
+      end
+
+      def option_parser(settings)
+        OptionParser.new do |opts|
+          opts.banner = "Usage: rubystyle [options] file1 file2 ..."
+          opts.on('-v', '--verbose', 'Output more information') { settings.verbose = true }
+          opts.on('-t', '--trace', 'Output stack trace on error') { settings.trace = true }
+          opts.on('--no-document', 'Do not produce HTML documentation') { settings.no_document = true }
+          opts.on('--no-lint', 'Do not run linter rules') { settings.no_lint = true }
+          opts.on('-o', '--output-dir DIR', 'Write HTML documentation to DIR') { |dir| settings.output_dir = dir }
+          opts.on('--version', 'print the version') { exit_with_msg(Ramlstyle::VERSION) }
+          opts.on('-h', '--help', 'Display this screen') { exit_with_msg(opts) }
+        end
+      end
+    end
+  end
+end

data/lib/ramlstyle/command/parse_command.rb

@@ -0,0 +1,9 @@
+module Ramlstyle
+  module Command
+    class ParseCommand < CommandChain
+      def run(opts, raml_file)
+        super(opts, raml_file, Ramlstyle::RamlParser.new(raml_file).parse)
+      end
+    end
+  end
+end

data/lib/ramlstyle/command/review_command.rb

@@ -0,0 +1,10 @@
+module Ramlstyle
+  module Command
+    class ReviewCommand < CommandChain
+      def run(opts, raml_file, raml)
+        Ramlstyle::Review.new(raml).review unless opts.no_lint
+        super(opts, raml_file, raml)
+      end
+    end
+  end
+end

data/lib/ramlstyle/command/settings.rb

@@ -0,0 +1,16 @@
+module Ramlstyle
+  module Command
+    class Settings
+      attr_accessor :verbose, :no_document, :no_lint, :output_dir, :files, :trace
+
+      def initialize
+        @verbose = false
+        @trace = false
+        @no_document = false
+        @no_lint = false
+        @output_dir = Dir.getwd
+        @files = []
+      end
+    end
+  end
+end

data/lib/ramlstyle/document.rb

@@ -0,0 +1,15 @@
+module Ramlstyle
+  class Document
+    def initialize(obj)
+      @obj = obj
+    end
+
+    def render
+      Documentation::RendererFactory.new.renderer_for_root(@obj).render
+    end
+
+    def render_to_file(file_name)
+      IO.write(file_name, render)
+    end
+  end
+end

data/lib/ramlstyle/documentation/erb_context.rb

@@ -0,0 +1,52 @@
+module Ramlstyle
+  module Documentation
+    class ERBContext
+      include ERB::Util
+
+      def initialize(hash)
+        @options = {}
+        @markdown = Redcarpet::Markdown.new(
+          Redcarpet::Render::SmartyHTML,
+          no_intra_emphasis: true,
+          tables: true,
+          fenced_code_blocks: true,
+          autolink: true,
+          strikethrough: true,
+          underline: true,
+          quote: true,
+          footnotes: true
+        )
+        hash.each_pair do |key, value|
+          instance_variable_set('@' + key.to_s, value)
+        end
+      end
+
+      def markdown(str)
+        @markdown.render(str || "")
+      end
+
+      def render_resource(res)
+        RendererFactory.new.renderer_for_resource(res).render
+      end
+
+      def render_parameter(param)
+        RendererFactory.new.renderer_for_parameter(param).render
+      end
+
+      def secured?(obj)
+        return true if obj.secured_by.count { |s| s.name == "null" } > 0
+        return true if obj.security_scheme_declarations.count { |s| s.name == "null" } > 0
+        false
+      end
+
+      def security_scheme_names(obj)
+        return obj.secured_by.map(&:name) if obj.secured_by.length > 0
+        obj.security_scheme_declarations.map(&:name)
+      end
+
+      def context_binding
+        binding
+      end
+    end
+  end
+end

data/lib/ramlstyle/documentation/renderer.rb

@@ -0,0 +1,14 @@
+module Ramlstyle
+  module Documentation
+    class Renderer
+      def initialize(template, template_var_hash)
+        @template = ERB.new(File.read(template))
+        @context = ERBContext.new(template_var_hash)
+      end
+
+      def render
+        @template.result(@context.context_binding)
+      end
+    end
+  end
+end

data/lib/ramlstyle/documentation/renderer_factory.rb

@@ -0,0 +1,17 @@
+module Ramlstyle
+  module Documentation
+    class RendererFactory
+      def renderer_for_parameter(param)
+        Renderer.new(File.join(Ramlstyle::TEMPLATES_PATH, 'item.html.erb'), item: param, key: param.name)
+      end
+
+      def renderer_for_resource(res)
+        Renderer.new(File.join(Ramlstyle::TEMPLATES_PATH, 'resource.html.erb'), resource: res)
+      end
+
+      def renderer_for_root(root)
+        Renderer.new(File.join(Ramlstyle::TEMPLATES_PATH, 'template.html.erb'), raml: root)
+      end
+    end
+  end
+end

data/lib/ramlstyle/patch/node.rb

@@ -0,0 +1,28 @@
+module Raml
+  class Node
+    # A method that gives you the full path of the node to make it easier to find the error.
+    def path_name
+      File.join(parent.path_name, name.to_s)
+    end
+
+    def parent_url
+      parent.path_name
+    end
+
+    def unique_id
+      path_name.gsub(%r([\/\{\}]), "_")
+    end
+
+    def all_uri_parameters
+      children.select { |child| child.is_a? Raml::Parameter::UriParameter }
+    end
+
+    def query_parameters
+      children.select { |child| child.is_a? Raml::Parameter::QueryParameter }
+    end
+
+    def form_parameters
+      children.select { |child| child.is_a? Raml::Parameter::FormParameter }
+    end
+  end
+end