simple-cli 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e7286cc589a5fcc4c98b61f5cc4967a609458c9
-  data.tar.gz: cd3b2fa51ad21a07ea348a1f5987961f85b92174
+  metadata.gz: 1d1cca86fa6b4673bc090dfbbe4ceec9f64a9ab3
+  data.tar.gz: deec7baa1fb6c0813f6cd957f162c2df880f2d0b
 SHA512:
-  metadata.gz: 059f1af84110d1977b95f842032a88c3302147f65bf0ca2c55d6481bb258268c9204a583a14baade03da4db5a44be5f8b6bcfb39bcf5c4b98f462f39197bf07f
-  data.tar.gz: db1efaa0dd5abb8bdb51e12bc2eb59d77ce5b57eca17721b46893f3bacf557c17755137a67b697585c96bc3798d01c1c7b59d7efc6209b8251142890c3f28437
+  metadata.gz: f905d9b12e0fe61077e78b7ba6e682dc7a4f40ae07b1fff07c17f64fd4e80d2b3c478bdb1a8beb5cde07f7e9d2f5ef57f6dbf8f311b77f5df7575fa26e6dcdb2
+  data.tar.gz: c01ea85117b23c6dfc08c63bbc355abe1b180ae1cfb80ed2acf6f217dc5a4cecc3f1e3689c4505748db8ffc3817c51cafdee3086a92a5add1f7a6432582d9b49

data/.rubocop.yml

@@ -15,6 +15,9 @@ Metrics/LineLength:
 Style/SpecialGlobalVars:
   Enabled: false
 
+Style/PerlBackrefs:
+  Enabled: false
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
   ConsistentQuotesInMultiline: false
@@ -33,3 +36,9 @@ Style/Documentation:
 
 Style/MutableConstant:
   Enabled: false
+
+Lint/MissingCopEnableDirective:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false

data/Gemfile.lock

@@ -1,14 +1,20 @@
 PATH
   remote: .
   specs:
-    simple-cli (0.1.1)
+    simple-cli (0.1.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.3.0)
     diff-lcs (1.3)
     docile (1.1.5)
     json (2.1.0)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
     rake (11.3.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -23,11 +29,20 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
     simplecov (0.15.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
@@ -35,6 +50,7 @@ PLATFORMS
 DEPENDENCIES
   rake (~> 11)
   rspec (~> 3.7)
+  rubocop (= 0.52.1)
   simple-cli!
   simplecov (~> 0)
 

data/Rakefile

@@ -1,6 +1,6 @@
 Dir.glob("tasks/*.rake").each { |r| import r }
 
 task :default do
-  sh "rspec"
-  sh "rubocop"
+  #sh "rspec"
+  sh "bundle exec rubocop"
 end

data/lib/simple/cli/helpers.rb

@@ -42,7 +42,7 @@ module Simple::CLI::Helpers
   class Command
     def initialize(cmd, *args)
       @cmd = cmd
-      @args = [ cmd ] + args
+      @args = [cmd] + args
     end
 
     def sh
@@ -54,10 +54,10 @@ module Simple::CLI::Helpers
     def run
       STDERR.puts "> #{self}"
       rv = if @args.length > 1
-        system to_s
-      else
-        system *@args
-      end
+             system to_s
+           else
+             system @args.first
+           end
 
       @process_status = $?
       rv

data/lib/simple/cli/logger.rb

@@ -13,7 +13,7 @@ module Simple::CLI::Logger
 
   def build_default_logger
     logger = Logger.new(STDOUT)
-    logger.formatter = proc do |severity, datetime, progname, msg|
+    logger.formatter = proc do |severity, _datetime, _progname, msg|
       "#{severity}: #{msg}\n"
     end
     logger.level = Logger::INFO

data/lib/simple/cli/runner/autocompletion.rb

@@ -1,13 +1,16 @@
 module Simple::CLI::Runner::Autocompletion
   CommandHelp = Simple::CLI::Runner::CommandHelp
 
-  def autocomplete(subcommand=nil, cur=nil)
-    completions = if !cur
+  def autocomplete(subcommand = nil, cur = nil)
+    puts completions(subcommand, cur).join("\n")
+  end
+
+  def completions(subcommand = nil, cur = nil)
+    if !cur
       autocomplete_subcommands(subcommand)
     else
       autocomplete_subcommand_options(subcommand, cur)
     end
-    puts completions.join("\n")
   end
 
   def filter_completions(completions, prefix:)
@@ -18,7 +21,7 @@ module Simple::CLI::Runner::Autocompletion
 
   def autocomplete_subcommands(cur)
     completions = filter_completions commands.map(&:to_s), prefix: cur
-    if completions == [ cur ]
+    if completions == [cur]
       autocomplete_subcommand_options(cur, nil)
     else
       completions
@@ -27,19 +30,19 @@ module Simple::CLI::Runner::Autocompletion
 
   def autocomplete_subcommand_options(subcommand, cur)
     completions = if subcommand == "help"
-      commands.map(&:to_s) + [ "autocomplete" ]
-    else
-      CommandHelp.option_names(@app, subcommand)
-    end
+                    commands.map(&:to_s) + ["autocomplete"]
+                  else
+                    CommandHelp.option_names(@app, subcommand)
+                  end
 
     filter_completions completions, prefix: cur
   end
 
   def autocomplete_help
     STDERR.puts <<~DOC
-    #{binary_name} supports autocompletion. To enable autocompletion please run 
-  
-        eval "$(#{$0} autocomplete:bash)"
+      #{binary_name} supports autocompletion. To enable autocompletion please run
+
+          eval "$(#{$0} autocomplete:bash)"
     DOC
 
     exit 1
@@ -61,20 +64,20 @@ module Simple::CLI::Runner::Autocompletion
   # see https://www.gnu.org/software/bash/manual/html_node/Programmable-Completion-Builtins.html
   #
   AUTOCOMPLETE_SHELL_CODE = <<~BASH
-  _{{BINARY}}() 
-  {
-    local cmd=$1
-    local cur=$2
+    _{{BINARY}}()
+    {
+      local cmd=$1
+      local cur=$2
 
-    if [[ $COMP_CWORD == 1 ]]; then
-      COMPREPLY=( $("$cmd" autocomplete "$cur" ))
-    else
-      local subcommand=${COMP_WORDS[1]}
-      COMPREPLY=( $("$cmd" autocomplete "$subcommand" "$cur" ))
-    fi
+      if [[ $COMP_CWORD == 1 ]]; then
+        COMPREPLY=( $("$cmd" autocomplete "$cur" ))
+      else
+        local subcommand=${COMP_WORDS[1]}
+        COMPREPLY=( $("$cmd" autocomplete "$subcommand" "$cur" ))
+      fi
 
-    return 0
-  }
-  complete -F _{{BINARY}} {{BINARY}}
+      return 0
+    }
+    complete -F _{{BINARY}} {{BINARY}}
   BASH
 end

data/lib/simple/cli/runner/command_help.rb

@@ -1,3 +1,7 @@
+# rubocop:disable Metrics/AbcSize
+# rubocop:disable Metrics/CyclomaticComplexity
+# rubocop:disable Metrics/MethodLength
+
 class Simple::CLI::Runner::CommandHelp
   def self.option_names(app, subcommand)
     new(app, subcommand).option_names
@@ -6,7 +10,8 @@ class Simple::CLI::Runner::CommandHelp
   end
 
   def initialize(mod, method)
-    @mod, @method = mod, method
+    @mod = mod
+    @method = method
   end
 
   # First line of the help as read from the method comments.
@@ -22,14 +27,16 @@ class Simple::CLI::Runner::CommandHelp
   def option_names
     method = @mod.instance_method(@method)
 
-    method.parameters.map do |mode, name|
+    option_names = method.parameters.map do |mode, name|
       case mode
       when :key     then name
       when :keyreq  then name
       end
-    end.compact.map do |name|
-      [ "--#{name}", "--#{name}=" ]
-    end.flatten.uniq
+    end.compact
+
+    option_names.map do |name|
+      ["--#{name}", "--#{name}="]
+    end.flatten
   end
 
   # A help string constructed from the commands method signature.
@@ -71,7 +78,6 @@ class Simple::CLI::Runner::CommandHelp
       case line
       when /^\s*# ?(.*)$/ then $1
       when /^\s*end/ then :end
-      else nil
       end
     end
   end
@@ -82,22 +88,18 @@ class Simple::CLI::Runner::CommandHelp
     # go down from before_line until we see a line which is either a comment
     # or an :end. Note that the line at before_line-1 should be the first
     # line of the method definition in question.
-    last_line = before_line-1
-    while last_line >= 0 && !parsed_source[last_line] do
-      last_line -= 1
-    end
+    last_line = before_line - 1
+    last_line -= 1 while last_line >= 0 && !parsed_source[last_line]
 
     first_line = last_line
-    while first_line >= 0 && parsed_source[first_line] do
-      first_line -= 1
-    end
+    first_line -= 1 while first_line >= 0 && parsed_source[first_line]
     first_line += 1
 
-    comments = parsed_source[first_line .. last_line]
+    comments = parsed_source[first_line..last_line]
     if comments.include?(:end)
       []
     else
-      parsed_source[first_line .. last_line]
+      parsed_source[first_line..last_line]
     end
   end
 end

data/lib/simple/cli/runner.rb

@@ -1,3 +1,9 @@
+# rubocop:disable  Metrics/AbcSize
+# rubocop:disable  Metrics/ClassLength
+# rubocop:disable  Metrics/CyclomaticComplexity
+# rubocop:disable  Metrics/MethodLength
+# rubocop:disable  Metrics/PerceivedComplexity
+
 class Simple::CLI::Runner
 end
 
@@ -38,9 +44,9 @@ class Simple::CLI::Runner
     if command == :help
       do_help!(*args)
     elsif command == :autocomplete
-      autocomplete *args
+      autocomplete(*args)
     elsif command == :autocomplete_bash
-      autocomplete_bash *args
+      autocomplete_bash(*args)
     elsif commands.include?(command)
       @instance.run! command, *args_with_options(args)
     else
@@ -90,7 +96,7 @@ class Simple::CLI::Runner
   def args_with_options(args)
     r = []
     options = {}
-    while arg = args.shift
+    while (arg = args.shift)
       case arg
       when /^--(.*)=(.*)/ then options[$1.to_sym] = $2
       when /^--no-(.*)/   then options[$1.to_sym] = false
@@ -104,11 +110,11 @@ class Simple::CLI::Runner
   end
 
   def command_to_string(sym)
-    sym.to_s.gsub("_", ":")
+    sym.to_s.tr("_", ":")
   end
 
   def string_to_command(s)
-    s.gsub(":", "_").to_sym
+    s.tr(":", "_").to_sym
   end
 
   def commands
@@ -138,20 +144,20 @@ class Simple::CLI::Runner
 
     commands.sort.each do |sym|
       command_help = command_helps.fetch(sym)
-      command_help = "%-#{max_command_helps_length}s" % command_help
+      command_help = format("%-#{max_command_helps_length}s", command_help)
       edoc = CommandHelp.new(@app, sym)
       head = "# #{edoc.head}" if edoc.head
-      STDERR.puts "    #{command_help}    #{ head }"
+      STDERR.puts "    #{command_help}    #{head}"
     end
 
     STDERR.puts "\n"
 
     STDERR.puts <<~DOC
-    Default options include:
+      Default options include:
 
-        #{binary_name} [ --verbose | -v ]         # run on DEBUG log level
-        #{binary_name} [ --quiet | -q ]           # run on WARN log level
-        #{binary_name} help autocomplete          # print information on autocompletion.
+          #{binary_name} [ --verbose | -v ]         # run on DEBUG log level
+          #{binary_name} [ --quiet | -q ]           # run on WARN log level
+          #{binary_name} help autocomplete          # print information on autocompletion.
 
     DOC
 

data/lib/simple/cli/version.rb

@@ -1,5 +1,5 @@
 module Simple
   module CLI
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/lib/simple-cli.rb

@@ -1 +1,2 @@
+# rubocop:disable Naming/FileName
 require "simple/cli"

data/simple-cli.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rake', '~> 11'
   gem.add_development_dependency 'rspec', '~> 3.7'
   gem.add_development_dependency 'simplecov', '~> 0'
+  gem.add_development_dependency 'rubocop', '= 0.52.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-cli
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - radiospiel
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.1
 description: Simple CLI builder
 email: eno@radiospiel.org
 executables: []