highline 2.0.0.pre.develop.9 → 2.0.0.pre.develop.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c639e0a0e863970d33dd5f04f0503770980f79cb
-  data.tar.gz: 4e23a7f040b753da355772655775c3a66e6dced3
+  metadata.gz: 384e4ddade0f40dc604fd6cbb4fed1f543f54fa3
+  data.tar.gz: 80ca4c698e1418b4a3476e27e4179bde0405721c
 SHA512:
-  metadata.gz: 5d5f0ce4b01d5d777dbf46c01b4f5276aa1aaa1a1411240b690ad137fb9dc4c676dc4bf399eb90dfd1572aa1549d18afcb74e8c211d423b5c9b38bd5ab5ad2e4
-  data.tar.gz: 97f72ad639d2b0b2bd40cc828ff4d10d552b0932e2fb946e8755a2c5c52dcdce957ac2db0a5e53a596f2e128db45878a314e202a1b6a6e70ac77010b8d7481e6
+  metadata.gz: 40e63c09636602c0a71582f8ea4033571202fe10721655b4853d74d3a391472ce6c574404fe750f543ec4f783b2e66afac247e21ec9ed729c521e0826d54187a
+  data.tar.gz: c35ebc20d89396e0af1f8b97716067308c726c290374fecfa71c1b9a9968dcd854f0a1d020e6e7a10407ded8f9fc52273e688538c1b33b54ee05f9c0a2d8fd8d

data/.rubocop.yml

@@ -3,16 +3,20 @@
 # See options at:
 # https://github.com/bbatsov/rubocop/tree/master/config
 
+AllCops:
+  TargetRubyVersion: 1.9
+
 # General
 
 # Multi-line method chaining should be done with leading dots.
-Style/DotPosition:
+Layout/DotPosition:
   EnforcedStyle: trailing
   SupportedStyles:
     - leading
     - trailing
 
-# Enabling!
+# Enabling
+# --------
 
 Style/CollectionMethods:
   Description: 'Preferred collection methods.'
@@ -23,9 +27,59 @@ Style/StringMethods:
   Description: 'Checks if configured preferred methods are used over non-preferred.'
   Enabled: true
 
-# Disabling!
+# Disabling
+# ---------
+
+# Modifying
+# ---------
 
+# Check quotes usage according to lint rule below.
 Style/StringLiterals:
-  Description: 'Checks if uses of quotes match the configured preference.'
-  StyleGuide: 'https://github.com/bbatsov/ruby-style-guide#consistent-string-literals'
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# Configuration parameters: SupportedStyles.
+# SupportedStyles: snake_case, camelCase
+Naming/MethodName:
+  EnforcedStyle: snake_case
+  Exclude:
+    - 'test/**/*'
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AutoCorrectEncodingComment.
+# SupportedStyles: when_needed, always, never
+Style/Encoding:
+  Enabled: true
+  EnforcedStyle: always
+
+# If we fix this, it will change method signature.
+# Save it for major release.
+Style/OptionalArguments:
+  Exclude:
+    - 'lib/highline/list_renderer.rb'
+
+# TemplateRenderer should never fail on method missing.
+Style/MethodMissing:
+  Exclude:
+    - 'lib/highline/template_renderer.rb'
+
+# This is a breaking change for MRI 1.9.
+# Revoke when updating to MRI 2.0 as minimum.
+# Cop supports --auto-correct.
+# Configuration parameters: MinSize, SupportedStyles.
+# SupportedStyles: percent, brackets
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: auto_detection, squiggly, active_support, powerpack, unindent
+Layout/IndentHeredoc:
+  Exclude:
+    - 'examples/page_and_wrap.rb'
+    - 'highline.gemspec'
+    - 'test/acceptance/acceptance.rb'
+
+# Cop supports --auto-correct.
+Lint/ScriptPermission:
   Enabled: false

data/.travis.yml

@@ -2,12 +2,13 @@
 language: ruby
 dist: trusty
 sudo: false
+cache: bundler
 script: "bundle exec rake test"
 rvm:
-  - 1.9
   - 2.0
   - 2.1
   - 2.2
+  - 2.3
   - ruby-head
   - rbx-3.81
   - jruby-19mode # JRuby in 1.9 mode
@@ -23,6 +24,10 @@ matrix:
     - rvm: jruby-19mode # JRuby in 1.9 mode
     - rvm: jruby-head
   include:
-    - rvm: 2.3
-      script: "bundle exec rake test && bundle exec codeclimate-test-reporter" # Run only for 2.3
-bundler_args: --without development
+    - rvm: 1.9
+      before_install:
+        - "gem update --system -N"
+        - "gem update bundler -N"
+    - rvm: 2.4
+      script: "bundle exec rake test && bundle exec codeclimate-test-reporter" # Run only for 2.4
+bundler_args: --without code_quality

data/Changelog.md

@@ -2,6 +2,17 @@
 
 Below is a complete listing of changes for each revision of HighLine.
 
+### 2.0.0-develop.11 / 2017-09-25
+* PR #215 - Apply several Rubocop stylistic suggestions (@abinoam)
+  * Update gemspec/Gemfile to newer standards
+  * Update travis configuration fixing 1.9 problem
+  * Adjust .rubocop.yml with things we don't want to change
+
+### 2.0.0-develop.10 / 2017-06-29
+* PR #214 - Remove `$terminal` (global variable) (@abinoam)
+  * Use HighLine.default_instance instead
+  * Reorganize/Group code at lib/highline.rb
+
 ### 2.0.0-develop.9 / 2017-06-24
 
 * PR #211 / PR #212 - HighLine#use_color= and use_color? as instance methods (@abinoam, @phiggins)

data/Gemfile

@@ -1,13 +1,11 @@
-source "https://rubygems.org"
+# encoding: utf-8
 
-gem "rake", require: false
-gem "rdoc", require: false
+source "https://rubygems.org"
 
-group :development, :test do
-  gem "code_statistics", require: false
-  gem "minitest", require: false
-end
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
+# Specify your gem's dependencies in tgem.gemspec
+gemspec
 
 # Reporting only at one ruby version of travis matrix (no repetition)
 gem "codeclimate-test-reporter", group: :test, require: false
@@ -17,16 +15,11 @@ platform :ruby do
   gem "simplecov", group: :test
 end
 
-group :development do
-  gem 'pronto'
-  gem 'pronto-reek', require: false
-  gem 'pronto-rubocop', require: false
-  gem 'pronto-poper', require: false
-
-  # Using strict versions of flay and pronto-flay while
-  # PR https://github.com/mmozuras/pronto-flay/pull/11/files
-  # is not merged
-  gem 'flay', '2.7.0'
-  gem 'pronto-flay', '0.6.1', require: false
-  gem 'flog'
+group :code_quality do
+  gem "flog", require: false
+  gem "pronto", require: false
+  gem "pronto-flay", require: false
+  gem "pronto-poper", require: false
+  gem "pronto-reek", require: false
+  gem "pronto-rubocop", require: false
 end

data/Rakefile

@@ -1,21 +1,15 @@
+# encoding: utf-8
+
 require "rake/testtask"
-require "rubygems/package_task"
 require "bundler/gem_tasks"
-require "code_statistics"
-
-require "rubygems"
 
-task :default => [:test]
+task default: [:test]
 
 Rake::TestTask.new do |test|
-  test.libs       = ["lib", "test"]
+  test.libs       = %w[lib test]
   test.verbose    = true
   test.warning    = true
-  test.test_files = FileList['test/test*.rb']
-end
-
-Gem::PackageTask.new(SPEC) do |package|
-  # do nothing:  I just need a gem but this block is required
+  test.test_files = FileList["test/test*.rb"]
 end
 
 desc "Run some interactive acceptance tests"

data/examples/ansi_colors.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 # ansi_colors.rb
 #
@@ -9,19 +10,13 @@ require "rubygems"
 require "highline/import"
 
 # Supported color sequences.
-colors = %w{black red green yellow blue magenta cyan white}
+colors = %w[black red green yellow blue magenta cyan white]
 
 # Using color() with symbols.
 colors.each_with_index do |c, i|
   say("This should be <%= color('#{c}', :#{c}) %>!")
-  if i == 0
-    say( "This should be " +
-         "<%= color('white on #{c}', :white, :on_#{c}) %>!")
-  else
-    say( "This should be " +
-         "<%= color( '#{colors[i - 1]} on #{c}',
-                     :#{colors[i - 1]}, :on_#{c} ) %>!")
-  end
+  say("This should be <%= color('#{colors[i - 1]} on #{c}', \
+      :#{colors[i - 1]}, :on_#{c} ) %>!")
 end
 
 # Using color with constants.
@@ -32,7 +27,7 @@ say("This should be <%= color('underlined', UNDERLINE) %>!")
 say("This might even <%= BLINK %>blink<%= CLEAR %>!")
 
 # It even works with list wrapping.
-erb_digits = %w{Zero One Two Three Four}      +
+erb_digits = %w[Zero One Two Three Four]      +
              ["<%= color('Five', :blue) %%>"] +
-             %w{Six Seven Eight Nine}
+             %w[Six Seven Eight Nine]
 say("<%= list(#{erb_digits.inspect}, :columns_down, 3) %>")

data/examples/asking_for_arrays.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 # asking_for_arrays.rb
 #
@@ -9,11 +10,11 @@ require "rubygems"
 require "highline/import"
 require "pp"
 
-puts "Using: #{$terminal.terminal.class}"
+puts "Using: #{HighLine.default_instance.class}"
 puts
 
-grades = ask( "Enter test scores (or a blank line to quit):",
-              lambda { |ans| ans =~ /^-?\d+$/ ? Integer(ans) : ans} ) do |q|
+grades = ask("Enter test scores (or a blank line to quit):",
+             ->(ans) { ans =~ /^-?\d+$/ ? Integer(ans) : ans }) do |q|
   q.gather = ""
 end
 

data/examples/basic_usage.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 # basic_usage.rb
 #
@@ -9,35 +10,38 @@ require "rubygems"
 require "highline/import"
 require "yaml"
 
-puts "Using: #{$terminal.terminal.class}"
+puts "Using: #{HighLine.default_instance.terminal.class}"
 puts
 
-contacts = [ ]
+contacts = []
 
+# Just define a parse class method and use the class
+# as a parser for HighLine#ask
+#
 class NameClass
-  def self.parse( string )
-    if string =~ /^\s*(\w+),\s*(\w+)\s*$/
-      self.new($2, $1)
-    else
-      raise ArgumentError, "Invalid name format."
-    end
+  def self.parse(string)
+    raise ArgumentError, "Invalid name format." unless
+      string =~ /^\s*(\w+),\s*(\w+)\s*$/
+
+    new(Regexp.last_match(2), Regexp.last_match(1))
   end
 
   def initialize(first, last)
-    @first, @last = first, last
+    @first = first
+    @last = last
   end
 
   attr_reader :first, :last
 end
 
-begin
-  entry = Hash.new
+loop do
+  entry = {}
 
   # basic output
   say("Enter a contact:")
 
   # basic input
-  entry[:name]        = ask("Name?  (last, first)  ", NameClass) do |q|
+  entry[:name] = ask("Name?  (last, first)  ", NameClass) do |q|
     q.validate = /\A\w+, ?\w+\Z/
   end
   entry[:company]     = ask("Company?  ") { |q| q.default = "none" }
@@ -47,27 +51,30 @@ begin
     q.case     = :up
     q.validate = /\A[A-Z]{2}\Z/
   end
-  entry[:zip]         = ask("Zip?  ") do |q|
+  entry[:zip] = ask("Zip?  ") do |q|
     q.validate = /\A\d{5}(?:-?\d{4})?\Z/
   end
-  entry[:phone]       = ask( "Phone?  ",
-                             lambda { |p| p.delete("^0-9").
-                                            sub(/\A(\d{3})/, '(\1) ').
-                                            sub(/(\d{4})\Z/, '-\1') } ) do |q|
-    q.validate              = lambda { |p| p.delete("^0-9").length == 10 }
+  entry[:phone] = ask("Phone?  ",
+                      lambda { |p|
+                        p.delete("^0-9").
+                                     sub(/\A(\d{3})/, '(\1) ').
+                                     sub(/(\d{4})\Z/, '-\1')
+                      }) do |q|
+    q.validate              = ->(p) { p.delete("^0-9").length == 10 }
     q.responses[:not_valid] = "Enter a phone numer with area code."
   end
   entry[:age]         = ask("Age?  ", Integer) { |q| q.in = 0..105 }
   entry[:birthday]    = ask("Birthday?  ", Date)
-  entry[:interests]   = ask( "Interests?  (comma separated list)  ",
-                             lambda { |str| str.split(/,\s*/) } )
+  entry[:interests]   = ask("Interests?  (comma separated list)  ",
+                            ->(str) { str.split(/,\s*/) })
   entry[:description] = ask("Enter a description for this contact.") do |q|
     q.whitespace = :strip_and_collapse
   end
 
   contacts << entry
-# shortcut for yes and no questions
-end while agree("Enter another contact?  ", true)
+  # shortcut for yes and no questions
+  break unless agree("Enter another contact?  ", true)
+end
 
 if agree("Save these contacts?  ", true)
   file_name = ask("Enter a file name:  ") do |q|

data/examples/color_scheme.rb

@@ -1,20 +1,21 @@
 #!/usr/bin/env ruby -w
+# encoding: utf-8
 
 # color_scheme.rb
 #
 #  Created by Jeremy Hinegardner on 2007-01-24
 #  Copyright 2007 Jeremy Hinegardner.  All rights reserved
 
-require 'rubygems'
-require 'highline/import'
+require "rubygems"
+require "highline/import"
 
 # Create a color scheme, naming color patterns with symbol names.
 ft = HighLine::ColorScheme.new do |cs|
-        cs[:headline]        = [ :bold, :yellow, :on_black ]
-        cs[:horizontal_line] = [ :bold, :white, :on_blue]
-        cs[:even_row]        = [ :green ]
-        cs[:odd_row]         = [ :magenta ]
-     end
+  cs[:headline] = [:bold, :yellow, :on_black]
+  cs[:horizontal_line] = [:bold, :white, :on_blue]
+  cs[:even_row]        = [:green]
+  cs[:odd_row]         = [:magenta]
+end
 
 # Assign that color scheme to HighLine...
 HighLine.color_scheme = ft
@@ -26,7 +27,7 @@ say("<%= color('-'*20, :horizontal_line) %>")
 # Setup a toggle for rows.
 i = true
 ("A".."D").each do |row|
-    row_color = i ? :even_row : :odd_row
-    say("<%= color('#{row}', '#{row_color}') %>")
-    i = !i
+  row_color = i ? :even_row : :odd_row
+  say("<%= color('#{row}', '#{row_color}') %>")
+  i = !i
 end

data/examples/get_character.rb

@@ -1,15 +1,16 @@
 #!/usr/bin/env ruby
+# encoding: utf-8
 
 require "rubygems"
 require "highline/import"
 
-puts "Using: #{$terminal.terminal.class}"
+puts "Using: #{HighLine.default_instance.terminal.class}"
 puts
 
 choices = "ynaq"
 answer = ask("Your choice [#{choices}]? ") do |q|
-           q.echo      = false
-           q.character = true
-           q.validate  = /\A[#{choices}]\Z/
-         end
+  q.echo = false
+  q.character = true
+  q.validate  = /\A[#{choices}]\Z/
+end
 say("Your choice: #{answer}")

data/examples/limit.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby -w
+# encoding: utf-8
 
 # limit.rb
 #
@@ -8,7 +9,7 @@
 require "rubygems"
 require "highline/import"
 
-puts "Using: #{$terminal.terminal.class}"
+puts "Using: #{HighLine.default_instance.terminal.class}"
 puts
 
 text = ask("Enter text (max 10 chars): ") { |q| q.limit = 10 }