Merge pull request #358 from interagent/bf/rubocop-safe-corrections

rubocop: safe corrections

Author: beanieboi

.rubocop_todo.yml

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

Gemfile

@@ -1,8 +1,8 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.pattern = 'test/**/*_test.rb'
+  t.pattern = "test/**/*_test.rb"
 end
 
 task default: :test

Rakefile

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
-require 'optparse'
-require_relative '../lib/prmd'
-require_relative '../lib/prmd/cli'
+require "optparse"
+require_relative "../lib/prmd"
+require_relative "../lib/prmd/cli"
 
 Prmd::CLI.run(ARGV.dup, bin: File.basename(__FILE__))

bin/prmd

@@ -1,9 +1,9 @@
-require_relative 'prmd/version'
-require_relative 'prmd/load_schema_file'
-require_relative 'prmd/commands'
-require_relative 'prmd/schema'
-require_relative 'prmd/link'
-require_relative 'prmd/utils'
-require_relative 'prmd/template'
-require_relative 'prmd/url_generator'
-require_relative 'prmd/hash_helpers'
+require_relative "prmd/version"
+require_relative "prmd/load_schema_file"
+require_relative "prmd/commands"
+require_relative "prmd/schema"
+require_relative "prmd/link"
+require_relative "prmd/utils"
+require_relative "prmd/template"
+require_relative "prmd/url_generator"
+require_relative "prmd/hash_helpers"

lib/prmd.rb

@@ -1,10 +1,10 @@
-require_relative 'core_ext/optparse'
-require_relative 'cli/combine'
-require_relative 'cli/doc'
-require_relative 'cli/generate'
-require_relative 'cli/render'
-require_relative 'cli/stub'
-require_relative 'cli/verify'
+require_relative "core_ext/optparse"
+require_relative "cli/combine"
+require_relative "cli/doc"
+require_relative "cli/generate"
+require_relative "cli/render"
+require_relative "cli/stub"
+require_relative "cli/verify"
 
 # :nodoc:
 module Prmd
@@ -15,11 +15,11 @@ module CLI
     def self.make_command_parsers(props = {})
       {
         combine: CLI::Combine.make_parser(props),
-        doc:     CLI::Doc.make_parser(props),
-        init:    CLI::Generate.make_parser(props),
-        render:  CLI::Render.make_parser(props),
-        stub:    CLI::Stub.make_parser(props),
-        verify:  CLI::Verify.make_parser(props)
+        doc: CLI::Doc.make_parser(props),
+        init: CLI::Generate.make_parser(props),
+        render: CLI::Render.make_parser(props),
+        stub: CLI::Stub.make_parser(props),
+        verify: CLI::Verify.make_parser(props),
       }
     end
 
@@ -35,29 +35,27 @@ def self.commands
     # @param [Hash<Symbol, Object>] options
     # @param [Hash<Symbol, Object>] props
     def self.make_parser(options, props = {})
-      binname = props.fetch(:bin, 'prmd')
+      binname = props.fetch(:bin, "prmd")
 
       # This is only used to attain the help commands
       commands = make_command_parsers(props)
       help_text = commands.values.map do |command|
         "   #{command.banner}"
       end.join("\n")
 
-      global = OptionParser.new do |opts|
+      OptionParser.new do |opts|
         opts.banner = "Usage: #{binname} [options] [command [options]]"
         opts.separator "\nAvailable options:"
-        opts.on('--version', 'Return version') do
+        opts.on("--version", "Return version") do
           puts "prmd #{Prmd::VERSION}"
           exit(0)
         end
-        opts.on('--noop', 'Commands will not execute') do |v|
+        opts.on("--noop", "Commands will not execute") do |v|
           options[:noop] = v
         end
         opts.separator "\nAvailable commands:"
         opts.separator help_text
       end
-
-      global
     end
 
     # Parse top level CLI options from argv

lib/prmd/cli.rb

@@ -1,6 +1,6 @@
-require 'json'
-require_relative '../core_ext/optparse'
-require_relative '../load_schema_file'
+require "json"
+require_relative "../core_ext/optparse"
+require_relative "../load_schema_file"
 
 module Prmd
   module CLI
@@ -23,7 +23,6 @@ module Base
       # @return [OptionParser] newly created parser
       # @abstract
       def make_parser(options = {})
-        #
       end
 
       # Runs the provided parser with the provided argv.
@@ -82,9 +81,7 @@ def parse_options(argv, options = {})
       def write_result(data, options = {})
         output_file = options[:output_file]
         if output_file
-          File.open(output_file, 'w') do |f|
-            f.write(data)
-          end
+          File.write(output_file, data)
         else
           $stdout.puts data
         end
@@ -96,11 +93,11 @@ def write_result(data, options = {})
       # @return [Array[Symbol, String]] source, data
       def try_read(filename = nil)
         if filename && !filename.empty?
-          return :file, Prmd.load_schema_file(filename)
+          [:file, Prmd.load_schema_file(filename)]
         elsif !$stdin.tty?
-          return :io, JSON.load($stdin.read)
+          [:io, JSON.load($stdin.read)]
         else
-          abort 'Nothing to read'
+          abort "Nothing to read"
         end
       end
 
@@ -111,7 +108,6 @@ def try_read(filename = nil)
       # @return [void]
       # @abstract
       def execute(options = {})
-        #
       end
 
       # Method called when the command is ran with the :noop option enabled.
@@ -120,7 +116,7 @@ def execute(options = {})
       # @param [Hash<Symbol, Object>] options
       # @return [void]
       def noop_execute(options = {})
-        $stderr.puts options
+        warn options
       end
 
       # Run this command given a argv and optional options Hash.

lib/prmd/cli/base.rb

@@ -1,5 +1,5 @@
-require_relative 'base'
-require_relative '../commands/combine'
+require_relative "base"
+require_relative "../commands/combine"
 
 module Prmd
   module CLI
@@ -12,17 +12,17 @@ module Combine
       # @param (see Prmd::CLI::Base#make_parser)
       # @return (see Prmd::CLI::Base#make_parser)
       def self.make_parser(options = {})
-        binname = options.fetch(:bin, 'prmd')
+        binname = options.fetch(:bin, "prmd")
 
         OptionParser.new do |opts|
           opts.banner = "#{binname} combine [options] <file or directory>"
-          opts.on('-m', '--meta FILENAME', String, 'Set defaults for schemata') do |m|
+          opts.on("-m", "--meta FILENAME", String, "Set defaults for schemata") do |m|
             yield :meta, m
           end
-          opts.on('-o', '--output-file FILENAME', String, 'File to write result to') do |n|
+          opts.on("-o", "--output-file FILENAME", String, "File to write result to") do |n|
             yield :output_file, n
           end
-          opts.on('-t', '--type-as-string', 'Allow type as string') do |t|
+          opts.on("-t", "--type-as-string", "Allow type as string") do |t|
             options[:type_as_string] = t
           end
         end

lib/prmd/cli/combine.rb

@@ -1,6 +1,6 @@
-require_relative 'base'
-require_relative '../commands/render'
-require_relative '../hash_helpers'
+require_relative "base"
+require_relative "../commands/render"
+require_relative "../hash_helpers"
 
 module Prmd
   module CLI
@@ -13,22 +13,22 @@ module Doc
       # @param (see Prmd::CLI::Base#make_parser)
       # @return (see Prmd::CLI::Base#make_parser)
       def self.make_parser(options = {})
-        binname = options.fetch(:bin, 'prmd')
+        binname = options.fetch(:bin, "prmd")
 
         OptionParser.new do |opts|
           opts.banner = "#{binname} doc [options] <combined schema>"
-          opts.on('-s', '--settings FILENAME', String, 'Config file to use') do |s|
+          opts.on("-s", "--settings FILENAME", String, "Config file to use") do |s|
             settings = Prmd.load_schema_file(s) || {}
             options = HashHelpers.deep_symbolize_keys(settings)
             yield :settings, options
           end
-          opts.on('-c', '--content-type application/json', String, 'Content-Type header') do |c|
+          opts.on("-c", "--content-type application/json", String, "Content-Type header") do |c|
             yield :content_type, c
           end
-          opts.on('-o', '--output-file FILENAME', String, 'File to write result to') do |n|
+          opts.on("-o", "--output-file FILENAME", String, "File to write result to") do |n|
             yield :output_file, n
           end
-          opts.on('-p', '--prepend header,overview', Array, 'Prepend files to output') do |p|
+          opts.on("-p", "--prepend header,overview", Array, "Prepend files to output") do |p|
             yield :prepend, p
           end
         end
@@ -58,7 +58,7 @@ def self.set_option(options, key, value)
       # @return (see Prmd::CLI::Base#execute)
       def self.execute(options = {})
         filename = options.fetch(:argv).first
-        template = File.expand_path('templates', File.dirname(__FILE__))
+        template = File.expand_path("templates", File.dirname(__FILE__))
         _, data = try_read(filename)
         schema = Prmd::Schema.new(data)
         opts = options.merge(template: template)

lib/prmd/cli/doc.rb

@@ -1,6 +1,6 @@
-require_relative 'base'
-require_relative '../commands/init'
-require_relative '../utils'
+require_relative "base"
+require_relative "../commands/init"
+require_relative "../utils"
 
 module Prmd
   module CLI
@@ -15,17 +15,17 @@ module Generate
       # @param (see Prmd::CLI::Base#make_parser)
       # @return (see Prmd::CLI::Base#make_parser)
       def self.make_parser(options = {})
-        binname = options.fetch(:bin, 'prmd')
+        binname = options.fetch(:bin, "prmd")
 
         OptionParser.new do |opts|
           opts.banner = "#{binname} init [options] <resource name>"
-          opts.on('-t', '--template templates', String, 'Use alternate template') do |t|
+          opts.on("-t", "--template templates", String, "Use alternate template") do |t|
             yield :template, t
           end
-          opts.on('-y', '--yaml', 'Generate YAML') do |y|
+          opts.on("-y", "--yaml", "Generate YAML") do |y|
             yield :yaml, y
           end
-          opts.on('-o', '--output-file FILENAME', String, 'File to write result to') do |n|
+          opts.on("-o", "--output-file FILENAME", String, "File to write result to") do |n|
             yield :output_file, n
           end
         end