Skip to content

Commit 66446dc

Browse files
committed
all safe rubocop corrections
1 parent 9056ee8 commit 66446dc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+784
-1222
lines changed

.rubocop_todo.yml

Lines changed: 5 additions & 425 deletions
Large diffs are not rendered by default.

Gemfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
source 'https://rubygems.org'
1+
source "https://rubygems.org"
22

33
# Specify your gem's dependencies in prmd.gemspec
44
gemspec

Rakefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
require 'bundler/gem_tasks'
2-
require 'rake/testtask'
1+
require "bundler/gem_tasks"
2+
require "rake/testtask"
33

44
Rake::TestTask.new do |t|
5-
t.pattern = 'test/**/*_test.rb'
5+
t.pattern = "test/**/*_test.rb"
66
end
77

88
task default: :test

bin/prmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/env ruby
2-
require 'optparse'
3-
require_relative '../lib/prmd'
4-
require_relative '../lib/prmd/cli'
2+
require "optparse"
3+
require_relative "../lib/prmd"
4+
require_relative "../lib/prmd/cli"
55

66
Prmd::CLI.run(ARGV.dup, bin: File.basename(__FILE__))

lib/prmd.rb

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
require_relative 'prmd/version'
2-
require_relative 'prmd/load_schema_file'
3-
require_relative 'prmd/commands'
4-
require_relative 'prmd/schema'
5-
require_relative 'prmd/link'
6-
require_relative 'prmd/utils'
7-
require_relative 'prmd/template'
8-
require_relative 'prmd/url_generator'
9-
require_relative 'prmd/hash_helpers'
1+
require_relative "prmd/version"
2+
require_relative "prmd/load_schema_file"
3+
require_relative "prmd/commands"
4+
require_relative "prmd/schema"
5+
require_relative "prmd/link"
6+
require_relative "prmd/utils"
7+
require_relative "prmd/template"
8+
require_relative "prmd/url_generator"
9+
require_relative "prmd/hash_helpers"

lib/prmd/cli.rb

Lines changed: 16 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
require_relative 'core_ext/optparse'
2-
require_relative 'cli/combine'
3-
require_relative 'cli/doc'
4-
require_relative 'cli/generate'
5-
require_relative 'cli/render'
6-
require_relative 'cli/stub'
7-
require_relative 'cli/verify'
1+
require_relative "core_ext/optparse"
2+
require_relative "cli/combine"
3+
require_relative "cli/doc"
4+
require_relative "cli/generate"
5+
require_relative "cli/render"
6+
require_relative "cli/stub"
7+
require_relative "cli/verify"
88

99
# :nodoc:
1010
module Prmd
@@ -15,11 +15,11 @@ module CLI
1515
def self.make_command_parsers(props = {})
1616
{
1717
combine: CLI::Combine.make_parser(props),
18-
doc: CLI::Doc.make_parser(props),
19-
init: CLI::Generate.make_parser(props),
20-
render: CLI::Render.make_parser(props),
21-
stub: CLI::Stub.make_parser(props),
22-
verify: CLI::Verify.make_parser(props)
18+
doc: CLI::Doc.make_parser(props),
19+
init: CLI::Generate.make_parser(props),
20+
render: CLI::Render.make_parser(props),
21+
stub: CLI::Stub.make_parser(props),
22+
verify: CLI::Verify.make_parser(props),
2323
}
2424
end
2525

@@ -35,29 +35,27 @@ def self.commands
3535
# @param [Hash<Symbol, Object>] options
3636
# @param [Hash<Symbol, Object>] props
3737
def self.make_parser(options, props = {})
38-
binname = props.fetch(:bin, 'prmd')
38+
binname = props.fetch(:bin, "prmd")
3939

4040
# This is only used to attain the help commands
4141
commands = make_command_parsers(props)
4242
help_text = commands.values.map do |command|
4343
" #{command.banner}"
4444
end.join("\n")
4545

46-
global = OptionParser.new do |opts|
46+
OptionParser.new do |opts|
4747
opts.banner = "Usage: #{binname} [options] [command [options]]"
4848
opts.separator "\nAvailable options:"
49-
opts.on('--version', 'Return version') do
49+
opts.on("--version", "Return version") do
5050
puts "prmd #{Prmd::VERSION}"
5151
exit(0)
5252
end
53-
opts.on('--noop', 'Commands will not execute') do |v|
53+
opts.on("--noop", "Commands will not execute") do |v|
5454
options[:noop] = v
5555
end
5656
opts.separator "\nAvailable commands:"
5757
opts.separator help_text
5858
end
59-
60-
global
6159
end
6260

6361
# Parse top level CLI options from argv

lib/prmd/cli/base.rb

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
require 'json'
2-
require_relative '../core_ext/optparse'
3-
require_relative '../load_schema_file'
1+
require "json"
2+
require_relative "../core_ext/optparse"
3+
require_relative "../load_schema_file"
44

55
module Prmd
66
module CLI
@@ -23,7 +23,6 @@ module Base
2323
# @return [OptionParser] newly created parser
2424
# @abstract
2525
def make_parser(options = {})
26-
#
2726
end
2827

2928
# Runs the provided parser with the provided argv.
@@ -82,9 +81,7 @@ def parse_options(argv, options = {})
8281
def write_result(data, options = {})
8382
output_file = options[:output_file]
8483
if output_file
85-
File.open(output_file, 'w') do |f|
86-
f.write(data)
87-
end
84+
File.write(output_file, data)
8885
else
8986
$stdout.puts data
9087
end
@@ -96,11 +93,11 @@ def write_result(data, options = {})
9693
# @return [Array[Symbol, String]] source, data
9794
def try_read(filename = nil)
9895
if filename && !filename.empty?
99-
return :file, Prmd.load_schema_file(filename)
96+
[:file, Prmd.load_schema_file(filename)]
10097
elsif !$stdin.tty?
101-
return :io, JSON.load($stdin.read)
98+
[:io, JSON.load($stdin.read)]
10299
else
103-
abort 'Nothing to read'
100+
abort "Nothing to read"
104101
end
105102
end
106103

@@ -111,7 +108,6 @@ def try_read(filename = nil)
111108
# @return [void]
112109
# @abstract
113110
def execute(options = {})
114-
#
115111
end
116112

117113
# Method called when the command is ran with the :noop option enabled.
@@ -120,7 +116,7 @@ def execute(options = {})
120116
# @param [Hash<Symbol, Object>] options
121117
# @return [void]
122118
def noop_execute(options = {})
123-
$stderr.puts options
119+
warn options
124120
end
125121

126122
# Run this command given a argv and optional options Hash.

lib/prmd/cli/combine.rb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
require_relative 'base'
2-
require_relative '../commands/combine'
1+
require_relative "base"
2+
require_relative "../commands/combine"
33

44
module Prmd
55
module CLI
@@ -12,17 +12,17 @@ module Combine
1212
# @param (see Prmd::CLI::Base#make_parser)
1313
# @return (see Prmd::CLI::Base#make_parser)
1414
def self.make_parser(options = {})
15-
binname = options.fetch(:bin, 'prmd')
15+
binname = options.fetch(:bin, "prmd")
1616

1717
OptionParser.new do |opts|
1818
opts.banner = "#{binname} combine [options] <file or directory>"
19-
opts.on('-m', '--meta FILENAME', String, 'Set defaults for schemata') do |m|
19+
opts.on("-m", "--meta FILENAME", String, "Set defaults for schemata") do |m|
2020
yield :meta, m
2121
end
22-
opts.on('-o', '--output-file FILENAME', String, 'File to write result to') do |n|
22+
opts.on("-o", "--output-file FILENAME", String, "File to write result to") do |n|
2323
yield :output_file, n
2424
end
25-
opts.on('-t', '--type-as-string', 'Allow type as string') do |t|
25+
opts.on("-t", "--type-as-string", "Allow type as string") do |t|
2626
options[:type_as_string] = t
2727
end
2828
end

lib/prmd/cli/doc.rb

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
require_relative 'base'
2-
require_relative '../commands/render'
3-
require_relative '../hash_helpers'
1+
require_relative "base"
2+
require_relative "../commands/render"
3+
require_relative "../hash_helpers"
44

55
module Prmd
66
module CLI
@@ -13,22 +13,22 @@ module Doc
1313
# @param (see Prmd::CLI::Base#make_parser)
1414
# @return (see Prmd::CLI::Base#make_parser)
1515
def self.make_parser(options = {})
16-
binname = options.fetch(:bin, 'prmd')
16+
binname = options.fetch(:bin, "prmd")
1717

1818
OptionParser.new do |opts|
1919
opts.banner = "#{binname} doc [options] <combined schema>"
20-
opts.on('-s', '--settings FILENAME', String, 'Config file to use') do |s|
20+
opts.on("-s", "--settings FILENAME", String, "Config file to use") do |s|
2121
settings = Prmd.load_schema_file(s) || {}
2222
options = HashHelpers.deep_symbolize_keys(settings)
2323
yield :settings, options
2424
end
25-
opts.on('-c', '--content-type application/json', String, 'Content-Type header') do |c|
25+
opts.on("-c", "--content-type application/json", String, "Content-Type header") do |c|
2626
yield :content_type, c
2727
end
28-
opts.on('-o', '--output-file FILENAME', String, 'File to write result to') do |n|
28+
opts.on("-o", "--output-file FILENAME", String, "File to write result to") do |n|
2929
yield :output_file, n
3030
end
31-
opts.on('-p', '--prepend header,overview', Array, 'Prepend files to output') do |p|
31+
opts.on("-p", "--prepend header,overview", Array, "Prepend files to output") do |p|
3232
yield :prepend, p
3333
end
3434
end
@@ -58,7 +58,7 @@ def self.set_option(options, key, value)
5858
# @return (see Prmd::CLI::Base#execute)
5959
def self.execute(options = {})
6060
filename = options.fetch(:argv).first
61-
template = File.expand_path('templates', File.dirname(__FILE__))
61+
template = File.expand_path("templates", File.dirname(__FILE__))
6262
_, data = try_read(filename)
6363
schema = Prmd::Schema.new(data)
6464
opts = options.merge(template: template)

lib/prmd/cli/generate.rb

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
require_relative 'base'
2-
require_relative '../commands/init'
3-
require_relative '../utils'
1+
require_relative "base"
2+
require_relative "../commands/init"
3+
require_relative "../utils"
44

55
module Prmd
66
module CLI
@@ -15,17 +15,17 @@ module Generate
1515
# @param (see Prmd::CLI::Base#make_parser)
1616
# @return (see Prmd::CLI::Base#make_parser)
1717
def self.make_parser(options = {})
18-
binname = options.fetch(:bin, 'prmd')
18+
binname = options.fetch(:bin, "prmd")
1919

2020
OptionParser.new do |opts|
2121
opts.banner = "#{binname} init [options] <resource name>"
22-
opts.on('-t', '--template templates', String, 'Use alternate template') do |t|
22+
opts.on("-t", "--template templates", String, "Use alternate template") do |t|
2323
yield :template, t
2424
end
25-
opts.on('-y', '--yaml', 'Generate YAML') do |y|
25+
opts.on("-y", "--yaml", "Generate YAML") do |y|
2626
yield :yaml, y
2727
end
28-
opts.on('-o', '--output-file FILENAME', String, 'File to write result to') do |n|
28+
opts.on("-o", "--output-file FILENAME", String, "File to write result to") do |n|
2929
yield :output_file, n
3030
end
3131
end

0 commit comments

Comments
 (0)