skippy 0.4.0.a → 0.5.0.a

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8911df6fd31addc62c4bc4756eb46f715eaf70ea2d2bcfb32175f104dad78f82
-  data.tar.gz: dbb042f7ed689a8d1a01589b4f11479014da36861e1cf578453a75eab14028b0
+  metadata.gz: caf9e8f9363445b164e56aacb76d61cdb1395532d6128dc173c6ac55900eae85
+  data.tar.gz: c122744a1c428a3cb22e73e35f217603e81c931397f60878189ec1c6c0805699
 SHA512:
-  metadata.gz: fda57b8e19f1a22ab2ad207bd938df1a5f9ba158400d5126572dc518130f48614cd30082aa4b4ac800fd33aa7c38fd32c712dfd4c7c5aac36432bc21762c0b6d
-  data.tar.gz: e43b4802ac2f2b0c2a60e5b8da927e9cb19cdcaee74d38c021422ebb571a7395363184f6828eccd23c66055ba2d078e8f30162849543a02d081cfcd05df853a5
+  metadata.gz: f837fa5d0d6b7dc18570ba8037ba1cb25373dad59daaf0433e56799468600c99e9dc0df2e579fb667eed4dfdd5c56065e1f23519a349be240944ad49211cbd42
+  data.tar.gz: e022d61b5268000d120fb0226a996c665fbcc2f03a159c9d68b7defc959b31d8d791d58b234e8564b900aed08aef8c791131197e0c2bb13f333d4b8218492b5a

data/.appveyor.yml

@@ -0,0 +1,35 @@
+version: "{build}-{branch}"
+
+branches:
+  only:
+    - master
+    - dev-appveyor
+
+cache:
+  - vendor/bundle
+
+environment:
+  matrix:
+    - RUBY_VERSION: 25
+    - RUBY_VERSION: 26
+
+install:
+  - set PATH=C:\Ruby%RUBY_VERSION%\bin;%PATH%
+  # - gem update --no-document --system 2.7.8
+  # - gem install bundler --no-document --version="<3.0.0"
+  #
+  # https://github.com/ruby/psych/issues/519
+  - gem uninstall psych # Workaround bug. (https://stackoverflow.com/a/69088551)
+  - bundle config --local path vendor/bundle
+  - bundle install
+  - git submodule update --init --recursive
+
+build: off
+
+before_test:
+  - ruby -v
+  - gem -v
+  - bundle -v
+
+test_script:
+  - bundle exec rake

data/.rubocop.yml

@@ -1,5 +1,9 @@
 inherit_from: .rubocop_todo.yml
 
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
 AllCops:
   Exclude:
     - 'bin/**/*'
@@ -9,8 +13,10 @@ AllCops:
     - 'vendor/**/*'
   DisplayCopNames: true
 
-Layout/AlignParameters:
+
+Layout/ArgumentAlignment:
   EnforcedStyle: with_fixed_indentation
+  # IndentationWidth: 2
 
 # It's ok to have more than one empty line to create a 'paragrapth'.
 Layout/EmptyLines:
@@ -26,6 +32,7 @@ Layout/EmptyLinesAroundModuleBody:
 
 # Normally one line in between, but two allowed for "paragraphs".
 Layout/EmptyLineBetweenDefs:
+  AllowAdjacentOneLineDefs: true
   NumberOfEmptyLines: [1, 2]
 
 # Rely on Git to normalize end of lines.
@@ -36,6 +43,18 @@ Layout/EndOfLine:
 Layout/EmptyLinesAroundBlockBody:
   Enabled: false
 
+Layout/LineLength:
+  Exclude:
+    - features/step_definitions/**/*
+
+Layout/ParameterAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+
+Naming/RescuedExceptionsVariableName:
+  PreferredName: error
+
+
 Metrics/AbcSize:
   Enabled: false
   Exclude:
@@ -45,14 +64,23 @@ Metrics/ClassLength:
   Exclude:
     - test/**/*
 
-Metrics/LineLength:
-  Exclude:
-    - features/step_definitions/**/*
+# Too noisy.
+Metrics/CyclomaticComplexity:
+  Enabled: false
 
 Metrics/MethodLength:
   Exclude:
     - test/**/*
 
+# Too noisy.
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+
+# Nah, sometimes easier to read with accessors having separate grouping.
+Style/AccessorGrouping:
+  Enabled: false
+
 # Prefer { ... } over do ... end except for control flow and
 # method defintions. Unfortunatly, no cop configuration for this.
 # https://github.com/chneukirchen/styleguide/blob/e60de37b478d3f892f6985a58d573016f33f0269/RUBY-STYLE#L63-L67
@@ -82,6 +110,25 @@ Style/Documentation:
 Style/GuardClause:
   Enabled: false
 
+# In the context of the Thor DLS the rocket arrow => reads better.
+Style/HashSyntax:
+  Exclude:
+    - app/commands/**/*
+
+# Some times it reads clearer to not trail if/unless at the end.
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+# Excluding some files that copies the Thor implementation.
+# TODO: Investigate if Thor changed their implementation.
+Style/OptionalBooleanParameter:
+  Exclude:
+    - lib/skippy/cli.rb
+    - lib/skippy/command.rb
+
 # %w and %i etc isn't really intuitive unless you are really familiar with the
 # syntax. %w seems used often enough. But [:symbol, :foo] reads clearer than
 # %i(symbol foo).
@@ -89,5 +136,140 @@ Style/SymbolArray:
   Enabled: False
 
 # Add trailing comma so it's easy to duplicate/add lines.
-Style/TrailingCommaInLiteral:
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
+
+
+# Not testing computed values, but serialized values.
+# Ignoring floating point tolerance is fine (and wanted) in this case.
+Minitest/AssertInDelta:
+  Enabled: false
+
+# Too many false positives.
+Minitest/AssertWithExpectedArgument:
+  Enabled: false
+
+# No such thing as too many assertions.
+Minitest/MultipleAssertions:
+  Enabled: false
+
+
+################################################################################
+# Enabling new cops:
+
+Gemspec/DateAssignment: # new in 1.10
+  Enabled: true
+Layout/LineEndStringConcatenationIndentation: # new in 1.18
+  Enabled: true
+Layout/SpaceBeforeBrackets: # new in 1.7
+  Enabled: true
+Lint/AmbiguousAssignment: # new in 1.7
+  Enabled: true
+Lint/AmbiguousOperatorPrecedence: # new in 1.21
+  Enabled: true
+Lint/AmbiguousRange: # new in 1.19
+  Enabled: true
+Lint/DeprecatedConstants: # new in 1.8
+  Enabled: true
+Lint/DuplicateBranch: # new in 1.3
+  Enabled: true
+Lint/DuplicateRegexpCharacterClassElement: # new in 1.1
+  Enabled: true
+Lint/EmptyBlock: # new in 1.1
+  Enabled: true
+Lint/EmptyClass: # new in 1.3
+  Enabled: true
+Lint/EmptyInPattern: # new in 1.16
+  Enabled: true
+Lint/IncompatibleIoSelectWithFiberScheduler: # new in 1.21
+  Enabled: true
+Lint/LambdaWithoutLiteralBlock: # new in 1.8
+  Enabled: true
+Lint/NoReturnInBeginEndBlocks: # new in 1.2
+  Enabled: true
+Lint/NumberedParameterAssignment: # new in 1.9
+  Enabled: true
+Lint/OrAssignmentToConstant: # new in 1.9
+  Enabled: true
+Lint/RedundantDirGlobSort: # new in 1.8
+  Enabled: true
+Lint/RequireRelativeSelfPath: # new in 1.22
+  Enabled: true
+Lint/SymbolConversion: # new in 1.9
+  Enabled: true
+Lint/ToEnumArguments: # new in 1.1
+  Enabled: true
+Lint/TripleQuotes: # new in 1.9
+  Enabled: true
+Lint/UnexpectedBlockArity: # new in 1.5
+  Enabled: true
+Lint/UnmodifiedReduceAccumulator: # new in 1.1
+  Enabled: true
+Security/IoMethods: # new in 1.22
+  Enabled: true
+Style/ArgumentsForwarding: # new in 1.1
+  Enabled: true
+Style/CollectionCompact: # new in 1.2
+  Enabled: true
+Style/DocumentDynamicEvalDefinition: # new in 1.1
+  Enabled: true
+Style/EndlessMethod: # new in 1.8
+  Enabled: true
+Style/HashConversion: # new in 1.10
+  Enabled: true
+Style/HashExcept: # new in 1.7
+  Enabled: true
+Style/IfWithBooleanLiteralBranches: # new in 1.9
+  Enabled: true
+Style/InPatternThen: # new in 1.16
+  Enabled: true
+Style/MultilineInPatternThen: # new in 1.16
+  Enabled: true
+Style/NegatedIfElseCondition: # new in 1.2
+  Enabled: true
+Style/NilLambda: # new in 1.3
+  Enabled: true
+Style/NumberedParameters: # new in 1.22
+  Enabled: true
+Style/NumberedParametersLimit: # new in 1.22
+  Enabled: true
+Style/QuotedSymbols: # new in 1.16
+  Enabled: true
+Style/RedundantArgument: # new in 1.4
+  Enabled: true
+Style/RedundantSelfAssignmentBranch: # new in 1.19
+  Enabled: true
+Style/SelectByRegexp: # new in 1.22
+  Enabled: true
+Style/StringChars: # new in 1.12
+  Enabled: true
+Style/SwapValues: # new in 1.1
+  Enabled: true
+
+Minitest/AssertionInLifecycleHook: # new in 0.10
+  Enabled: true
+Minitest/AssertKindOf: # new in 0.10
+  Enabled: true
+Minitest/AssertOutput: # new in 0.10
+  Enabled: true
+Minitest/AssertPathExists: # new in 0.10
+  Enabled: true
+Minitest/AssertSilent: # new in 0.10
+  Enabled: true
+Minitest/LiteralAsActualArgument: # new in 0.10
+  Enabled: true
+Minitest/RefuteInDelta: # new in 0.10
+  Enabled: true
+Minitest/RefuteKindOf: # new in 0.10
+  Enabled: true
+Minitest/RefutePathExists: # new in 0.10
+  Enabled: true
+Minitest/TestMethodName: # new in 0.10
+  Enabled: true
+Minitest/UnreachableAssertion: # new in 0.14
+  Enabled: true
+Minitest/UnspecifiedException: # new in 0.10
+  Enabled: true

data/.vscode/extensions.json

@@ -0,0 +1,27 @@
+{
+  // See http://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+  // List of extensions which should be recommended for users of this workspace.
+  "recommendations": [
+    // Spell checking code and comments are important.
+    "streetsidesoftware.code-spell-checker",
+
+    // Will make VSCode pick up .editorconfig.
+    "editorconfig.editorconfig",
+
+    // Essential for Ruby syntax highlighting and debugging.
+    "rebornix.ruby",
+
+    // For code insight and auto-complete.
+    "castwide.solargraph",
+
+    // Test Explorer UI and adapter
+    "hbenl.vscode-test-explorer",
+    "matepek.vscode-catch2-test-adapter",
+
+    // Cucumber highlighting and more.
+    "alexkrechik.cucumberautocomplete"
+  ],
+  // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+  "unwantedRecommendations": []
+}

data/.vscode/tasks.json

@@ -1,16 +1,18 @@
 {
   // See https://go.microsoft.com/fwlink/?LinkId=733558
   // for the documentation about the tasks.json format
-  "version": "0.1.0",
-  "command": "bundle",
-  "isShellCommand": true,
-  "showOutput": "always",
-  "echoCommand": true,
-  "args": ["exec", "rake"],
-  "tasks": [{
-      "taskName": "test",
-      "args": ["TEST=${relativeFile}"],
-      "isTestCommand": true,
-      "isBuildCommand": true
-   }]
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "rake test FILE",
+      "type": "shell",
+      "command": "bundle",
+      "args": [
+        "exec",
+        "rake",
+        "TEST=${relativeFile}"
+      ],
+      "group": "test"
+    }
+  ]
 }

data/Gemfile

@@ -1,18 +1,15 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in skippy.gemspec
 gemspec
 
 group :development do
-  # Original fork with bug-fix. Appear to be gone now.
-  # gem 'aruba', git: 'https://github.com/daynix/aruba.git', branch: 'd-win-fix'
-  # Backup fork of the bug fix:
-  gem 'aruba', git: 'https://github.com/thomthom/aruba.git',
-               branch: 'd-win-fix'
-  # TODO: This might be a newer fix:
-  # gem 'aruba', git: 'https://github.com/rbld/aruba.git',
-  #              branch: 'aruba-win-fix'
   gem 'pry'
-  gem 'rubocop', '~> 0.51.0', require: false
+  gem 'rubocop', '~> 1.0', require: false
+  gem 'rubocop-minitest', '~> 0.15', require: false
+  gem 'rubocop-performance', '~> 1.0', require: false
+  gem 'rubocop-rake', '~> 0.6', require: false
   gem 'webmock', '~> 3.1'
 end

data/README.md

@@ -1,6 +1,6 @@
 # Skippy
 
-[![Gem Version](https://badge.fury.io/rb/skippy.svg)](https://badge.fury.io/rb/skippy)
+[![Gem Version](https://badge.fury.io/rb/skippy.svg)](https://badge.fury.io/rb/skippy) [![Build status](https://ci.appveyor.com/api/projects/status/qu5nk3t7g5oaymyx/branch/master?svg=true)](https://ci.appveyor.com/project/thomthom/skippy/branch/master)
 
 Skippy is a Command Line Interface which aims to automate common developer tasks for SketchUp Ruby extension development.
 
@@ -32,7 +32,7 @@ For Windows the easiest way to get Ruby running is using the [Ruby Installer for
 ## Installation
 
 ```bash
-gem install skippy
+gem install skippy --pre
 ```
 
 ## Usage

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
@@ -5,6 +7,9 @@ Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
+  # Turning off because Rake 11 >= turns warning on by default.
+  # TODO: Clean up the warnings coming from this project and enable.
+  t.warning = false
 end
 
 task default: :test

data/app/boot.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Set the program name explicitly. Otherwise Thor will use the filename in the
 # banner for the command help.

data/app/commands/debug.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'skippy/namespace'
 
 class Debug < Skippy::Command

data/app/commands/install.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 require 'skippy/app'
@@ -22,7 +24,7 @@ class Install < Skippy::Command::Group
       next if library[:version].nil? || library[:source].nil?
 
       options = {
-        requirement: library[:version]
+        requirement: library[:version],
       }
       options[:branch] = library[:branch] unless library[:branch].nil?
       lib = project.libraries.install(library[:source], options)

data/app/commands/lib.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'fileutils'
 require 'json'
 
@@ -20,7 +22,7 @@ class Lib < Skippy::Command
         say
         say "#{library.name} (#{library.version})", [:bold, :yellow]
         library.modules.each { |lib_module|
-          lib_info = "  #{lib_module}"
+          lib_info = +"  #{lib_module}"
           lib_info << ' (installed)' if project.modules.installed?(lib_module)
           say lib_info, :green
         }
@@ -39,7 +41,8 @@ class Lib < Skippy::Command
   def install(source)
     project = Skippy::Project.current_or_fail
     libraries = project.libraries
-    library = libraries.install(source, install_options(options)) { |type, message|
+    installation_options = install_options(options)
+    library = libraries.install(source, installation_options) { |type, message|
       color = type == :warning ? :red : :yellow
       say message, color
     }
@@ -74,7 +77,7 @@ class Lib < Skippy::Command
   private
 
   def install_options(cli_options)
-    options = cli_options.map { |k, v| [k.to_sym, v] }.to_h
+    options = cli_options.transform_keys(&:to_sym)
     # The CLI options "version" is internally a "requirement".
     if options.key?(:version)
       options[:requirement] = options[:version]

data/app/commands/new.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 require 'skippy/app'
@@ -38,6 +40,7 @@ class New < Skippy::Command::Group
     if project.exist?
       raise Skippy::Error, "A project already exist: #{project.filename}"
     end
+
     project.namespace = namespace
     project.name = project.namespace.to_name
     project.basename = options[:basename] || project.namespace.short_name

data/app/commands/sketchup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'stringio'
 
@@ -15,6 +17,7 @@ class Sketchup < Skippy::Command
     unless app.can_debug
       raise Skippy::Error, "Debug library not installed for Sketchup #{version}"
     end
+
     arguments = ['-rdebug', %("ide port=#{options.port}")]
     Skippy.os.launch_app(app.executable, *arguments)
   end
@@ -51,10 +54,14 @@ class Sketchup < Skippy::Command
   # @param [Integer] version
   # @return [Skippy::SketchUpApp, nil]
   def find_sketchup(version)
+    # Allow shortcuts such as 18 to mean 2018.
+    full_version = version.to_i
+    full_version += 2000 if (13..99).cover?(full_version)
     app = Skippy.os.sketchup_apps.find { |sketchup|
-      sketchup.version == version.to_i
+      sketchup.version == full_version
     }
     raise Skippy::Error, "SketchUp #{version} not found." if app.nil?
+
     app
   end
 

data/app/commands/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Template < Skippy::Command
 
   desc 'list', 'List all known templates'

data/app/resources/commands/example.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Hello < Skippy::Command
 
   desc 'world PERSON', 'Oh, hi there!'

data/cucumber.yml

@@ -0,0 +1 @@
+default: --publish-quiet

data/lib/skippy/app.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 require 'skippy'
@@ -43,6 +45,7 @@ class Skippy::App
       template_path = templates_source_path.join(entry)
       next unless template_path.directory?
       next if %w(. ..).include?(entry.basename.to_s)
+
       result << entry.expand_path(templates_source_path)
     }
     result
@@ -54,7 +57,7 @@ class Skippy::App
     # Load the default skippy commands.
     path_commands = File.join(path, 'commands')
     commands_pattern = File.join(path_commands, '*.rb')
-    Dir.glob(commands_pattern) { |filename|
+    Dir.glob(commands_pattern).sort.each { |filename|
       # noinspection RubyResolve
       require filename
     }

data/lib/skippy/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 require 'skippy/app'
@@ -57,11 +59,12 @@ class Skippy::CLI < Skippy::Command
     end
   end
 
+  # rubocop:disable Style/MissingRespondToMissing
   # Verbatim copy from Thor::Runner:
   # If a command is not found on Thor::Runner, method missing is invoked and
   # Thor::Runner is then responsible for finding the command in all classes.
   #
-  def method_missing(meth, *args) # rubocop:disable Style/MethodMissing
+  def method_missing(meth, *args)
     meth = meth.to_s
     initialize_thorfiles(meth)
     klass, command = Thor::Util.find_class_and_command_by_namespace(meth)
@@ -69,14 +72,15 @@ class Skippy::CLI < Skippy::Command
     args.unshift(command) if command
     klass.start(args, shell: shell)
   end
+  # rubocop:enable Style/MissingRespondToMissing
 
   # Verbatim copy from Thor::Runner:
   desc 'list [SEARCH]',
     "List the available #{$PROGRAM_NAME} commands (--substring means .*SEARCH)"
   method_options substring: :boolean,
-                 group:     :string,
-                 all:       :boolean,
-                 debug:     :boolean
+    group: :string,
+    all: :boolean,
+    debug: :boolean
   def list(search = '')
     initialize_thorfiles
 
@@ -112,8 +116,9 @@ class Skippy::CLI < Skippy::Command
   def initialize_thorfiles(_relevant_to = nil, _skip_lookup = false)
     project = Skippy::Project.new(Dir.pwd)
     return unless project.exist?
+
     project.command_files { |filename|
-      unless Thor::Base.subclass_files.keys.include?(File.expand_path(filename))
+      unless Thor::Base.subclass_files.key?(File.expand_path(filename))
         begin
           Thor::Util.load_thorfile(filename, nil, options[:debug])
         rescue ScriptError, StandardError => error

data/lib/skippy/command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 
 module Skippy

data/lib/skippy/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'pathname'
 
@@ -35,6 +37,7 @@ class Skippy::Config < Hash
     item = get_item(key_path)
     item = set_item(key_path, []) if item.nil?
     raise ArgumentError, 'key path is not an Array' unless item.is_a?(Array)
+
     item << value
   end
 
@@ -52,6 +55,7 @@ class Skippy::Config < Hash
 
   def save
     raise MissingPathError if path.nil?
+
     export(path)
   end
 
@@ -117,9 +121,11 @@ class Skippy::Config < Hash
   def get_item(key_path)
     parts = key_parts(key_path)
     return nil if parts.empty?
+
     item = self
     parts.each { |key|
       return nil if item.nil?
+
       item = item[key]
     }
     item

data/lib/skippy/config_accessors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 require 'pathname'
 
@@ -15,6 +17,7 @@ module Skippy::ConfigAccessors
     class_eval do
       symbols.each { |symbol|
         raise TypeError unless symbol.is_a?(Symbol)
+
         define_method(symbol) do
           value = @config.get(key || symbol, default)
           value = type.new(value) if type && !value.is_a?(type)
@@ -29,6 +32,7 @@ module Skippy::ConfigAccessors
     class_eval do
       symbols.each { |symbol|
         raise TypeError unless symbol.is_a?(Symbol)
+
         symbol_set = "#{symbol}=".intern
         define_method(symbol_set) do |value|
           value = type.new(value) if type && !value.is_a?(type)

data/lib/skippy/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Skippy
   class Error < StandardError
   end

data/lib/skippy/group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor/group'
 
 require 'skippy/command'