busser 0.8.0 → 0.9.1

data/lib/busser/command/deserialize.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,10 +15,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'base64' unless defined?(Base64)
-require 'digest' unless defined?(Digest)
+require "base64" unless defined?(Base64)
+require "fileutils" unless defined?(FileUtils)
+require "digest/md5" unless defined?(Digest::MD5)
+require "digest" unless defined?(Digest)
 
-require 'busser/thor'
+require "busser/thor"
 
 module Busser
 
@@ -31,23 +32,27 @@ module Busser
     #
     class Deserialize < Busser::Thor::BaseGroup
 
-      class_option :destination, :desc => "Destination file path"
+      class_option :destination, desc: "Destination file path"
 
-      class_option :md5sum, :desc => "MD5 digest of original file"
+      class_option :md5sum, desc: "MD5 digest of original file"
 
-      class_option :perms, :desc => "Unix permissions on destination file"
+      class_option :perms, desc: "Unix permissions on destination file"
 
       def perform
         file = File.expand_path(options[:destination])
         contents = Base64.decode64(STDIN.read)
 
-        FileUtils.mkdir_p(File.dirname(file))
-        File.open(file, "wb") { |f| f.write(contents) }
-        FileUtils.chmod(Integer(options[:perms]), file)
-
+        # Verify before writing. Checking afterwards still failed the command,
+        # but only once the unverified content was already on disk with its
+        # requested permissions, so a truncated stream left an executable file
+        # behind for anything later to pick up.
         if Digest::MD5.hexdigest(contents) != options[:md5sum]
           abort "Streamed file #{file} does not match source file md5"
         end
+
+        FileUtils.mkdir_p(File.dirname(file))
+        File.open(file, "wb") { |f| f.write(contents) }
+        FileUtils.chmod(Integer(options[:perms]), file)
       end
     end
   end

data/lib/busser/command/plugin.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,10 +15,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'busser/thor'
-require 'busser/command/plugin_create'
-require 'busser/command/plugin_install'
-require 'busser/command/plugin_list'
+require "busser/thor"
+require "busser/command/plugin_create"
+require "busser/command/plugin_install"
+require "busser/command/plugin_list"
 
 module Busser
 

data/lib/busser/command/plugin_create.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,8 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'busser'
-require 'busser/thor'
+require "busser"
+require "busser/thor"
 
 module Busser
 
@@ -29,13 +28,13 @@ module Busser
     #
     class PluginCreate < Busser::Thor::BaseGroup
 
-      argument :name, :type => :string
+      argument :name, type: :string
 
-      class_option :type, :aliases => "-t", :type => :string,
-        :default => 'runner', :desc => "Type of plugin (runner)"
+      class_option :type, aliases: "-t", type: :string,
+        default: "runner", desc: "Type of plugin (runner)"
 
-      class_option :license, :aliases => "-l", :default => "apachev2",
-        :desc => "License type for gem (apachev2, mit, lgplv3, reserved)"
+      class_option :license, aliases: "-l", default: "apachev2",
+        desc: "License type for gem (apachev2, mit, lgplv3, reserved)"
 
       def create
         self.class.source_root(Busser.source_root.join("templates", "plugin"))
@@ -58,9 +57,7 @@ module Busser
         create_template("gemspec.erb", "#{config[:gem_name]}.gemspec")
         create_template("license_#{config[:license]}.erb", license_filename)
         create_template("gitignore.erb", ".gitignore")
-        create_template("tailor.erb", ".tailor")
-        create_template("travis.yml.erb", ".travis.yml")
-        create_file(File.join(target_dir, ".cane"))
+        create_template("github_workflow.yml.erb", ".github/workflows/test.yml")
       end
 
       def create_source_files
@@ -118,29 +115,30 @@ module Busser
           type_klass_name = "#{::Thor::Util.camel_case(options[:type])}Plugin"
 
           {
-            :name => name,
-            :gem_name => "busser-#{name}",
-            :gemspec => "busser-#{name}.gemspec",
-            :klass_name => ::Thor::Util.camel_case(name),
-            :type => options[:type],
-            :type_klass_name => type_klass_name,
-            :constant_name => ::Thor::Util.snake_case(name).upcase,
-            :author => author,
-            :email => email,
-            :license => options[:license],
-            :license_string => license_string,
-            :year => Time.now.year,
+            name: name,
+            gem_name: "busser-#{name}",
+            gemspec: "busser-#{name}.gemspec",
+            klass_name: ::Thor::Util.camel_case(name),
+            type: options[:type],
+            type_klass_name: type_klass_name,
+            constant_name: ::Thor::Util.snake_case(name).upcase,
+            author: author,
+            email: email,
+            license: options[:license],
+            license_string: license_string,
+            license_spdx: license_spdx,
+            year: Time.now.year,
           }
         end
       end
 
       def author
-        git_user_name = %x{git config user.name}.chomp
+        git_user_name = `git config user.name`.chomp
         git_user_name.empty? ? "TODO: Write your name" : git_user_name
       end
 
       def email
-        git_user_email = %x{git config user.email}.chomp
+        git_user_email = `git config user.email`.chomp
         git_user_email.empty? ? "TODO: Write your email" : git_user_email
       end
 
@@ -155,6 +153,21 @@ module Busser
         end
       end
 
+      # RubyGems validates spec.license against the SPDX list and warns on
+      # anything else, so the gemspec cannot reuse the human readable name
+      # that the README wants. "All rights reserved" has no SPDX identifier,
+      # so those gemspecs declare no license at all.
+      def license_spdx
+        case options[:license]
+        when "mit" then "MIT"
+        when "apachev2" then "Apache-2.0"
+        when "lgplv3" then "LGPL-3.0-only"
+        when "reserved" then nil
+        else
+          raise ArgumentError, "No such license #{options[:license]}"
+        end
+      end
+
       def license_filename
         case options[:license]
         when "mit" then "LICENSE.txt"
@@ -166,8 +179,8 @@ module Busser
       end
 
       def license_comment
-        @license_comment ||= IO.read(File.join(target_dir, license_filename)).
-          gsub(/^/, '# ').gsub(/\s+$/, '')
+        @license_comment ||= IO.read(File.join(target_dir, license_filename))
+          .gsub(/^/, "# ").gsub(/\s+$/, "")
       end
     end
   end

data/lib/busser/command/plugin_install.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,10 +15,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'openssl' unless defined?(OpenSSL)
+require "openssl" unless defined?(OpenSSL)
 
-require 'busser/rubygems'
-require 'busser/thor'
+require "busser/rubygems"
+require "busser/thor"
 
 module Busser
 
@@ -33,13 +32,13 @@ module Busser
 
       include Busser::RubyGems
 
-      argument :plugins, :type => :array
+      argument :plugins, type: :array
 
-      class_option :force_postinstall, :type => :boolean, :default => false,
-        :desc => "Run the plugin's postinstall if it is already installed"
+      class_option :force_postinstall, type: :boolean, default: false,
+        desc: "Run the plugin's postinstall if it is already installed"
 
-      class_option :verbose, :type => :boolean, :default => false,
-        :desc => "Set a more verbose output"
+      class_option :verbose, type: :boolean, default: false,
+        desc: "Set a more verbose output"
 
       def install_all
         if options[:verbose]
@@ -56,7 +55,7 @@ module Busser
 
       def install(plugin)
         gem_name, version = plugin.split("@")
-        name = gem_name.sub(/^busser-/, '')
+        name = gem_name.sub(/^busser-/, "")
 
         new_install = install_plugin_gem(gem_name, version, name)
 
@@ -69,11 +68,11 @@ module Busser
       def install_plugin_gem(gem, version, name)
         if internal_plugin?(name) || gem_installed?(gem, version)
           info "Plugin #{name} already installed"
-          return false
+          false
         else
           spec = install_gem(gem, version)
           info "Plugin #{name} installed (version #{spec.version})"
-          return true
+          true
         end
       end
 
@@ -103,11 +102,11 @@ module Busser
       #
       def drop_ssl_verify_peer
         before = OpenSSL::SSL::VERIFY_PEER
-        OpenSSL::SSL.send(:remove_const, 'VERIFY_PEER')
-        OpenSSL::SSL.const_set('VERIFY_PEER', OpenSSL::SSL::VERIFY_NONE)
+        OpenSSL::SSL.send(:remove_const, "VERIFY_PEER")
+        OpenSSL::SSL.const_set("VERIFY_PEER", OpenSSL::SSL::VERIFY_NONE)
         yield
-        OpenSSL::SSL.send(:remove_const, 'VERIFY_PEER')
-        OpenSSL::SSL.const_set('VERIFY_PEER', before)
+        OpenSSL::SSL.send(:remove_const, "VERIFY_PEER")
+        OpenSSL::SSL.const_set("VERIFY_PEER", before)
       end
     end
   end

data/lib/busser/command/plugin_list.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,8 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'busser/plugin'
-require 'busser/thor'
+require "busser/plugin"
+require "busser/thor"
 
 module Busser
 
@@ -33,7 +32,7 @@ module Busser
         if plugin_data.empty?
           say "No plugins installed yet"
         else
-          print_table([["Plugin", "Version"]] + plugin_data)
+          print_table([%w{Plugin Version}] + plugin_data)
         end
       end
 

data/lib/busser/command/setup.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,8 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'busser/thor'
-require 'busser/plugin'
+require "busser/thor"
+require "busser/plugin"
 
 module Busser
 
@@ -30,8 +29,8 @@ module Busser
     class Setup < Busser::Thor::BaseGroup
 
       class_option :type,
-        :desc => "Type of binstub file to create (bourne or bat)",
-        :default => "bourne"
+        desc: "Type of binstub file to create (bourne or bat)",
+        default: "bourne"
 
       def perform
         banner "Setting up Busser"
@@ -43,7 +42,7 @@ module Busser
 
       def create_busser_root
         info "Creating BUSSER_ROOT in #{root_path}"
-        empty_directory(root_path, :verbose => false)
+        empty_directory(root_path, verbose: false)
       end
 
       def generate_busser_binstub
@@ -60,9 +59,9 @@ module Busser
         binstub = root_path + "bin/busser.bat"
         busser_root = root_path.to_s.gsub("/", "\\")
 
-        File.unlink(binstub) if File.exists?(binstub)
-        create_file(binstub, :verbose => false) do
-          <<-BUSSER_BINSTUB.gsub(/^ {12}/, '')
+        File.unlink(binstub) if File.exist?(binstub)
+        create_file(binstub, verbose: false) do
+          <<-BUSSER_BINSTUB.gsub(/^ {12}/, "")
             @ECHO OFF
             REM This file was generated by Busser.
             REM
@@ -80,9 +79,19 @@ module Busser
             SET "GEM_PATH=#{gem_path}"
             SET "GEM_CACHE=#{gem_home}\\cache"
 
-            REM Unset RUBYOPT, we don't want this bleeding into our runtime.
+            REM Keep the calling Ruby environment out of this one. Clearing
+            REM RUBYOPT is no longer enough: RubyGems requires bundler/setup
+            REM whenever BUNDLER_SETUP is set, and bundler then points GEM_HOME
+            REM at the calling project's bundle, undoing the isolation above.
             SET RUBYOPT=
             SET GEMRC=
+            SET RUBYLIB=
+            SET BUNDLER_SETUP=
+            SET BUNDLER_VERSION=
+            SET BUNDLE_BIN_PATH=
+            SET BUNDLE_GEMFILE=
+            SET BUNDLE_LOCKFILE=
+            SET BUNDLE_PATH=
 
             REM Call the actual Busser bin with our arguments
             "#{ruby_bin}" "#{gem_bindir}\\busser" %*
@@ -99,9 +108,9 @@ module Busser
       def generate_busser_binstub_for_bourne
         binstub = root_path + "bin/busser"
 
-        File.unlink(binstub) if File.exists?(binstub)
-        create_file(binstub, :verbose => false) do
-          <<-BUSSER_BINSTUB.gsub(/^ {12}/, '')
+        File.unlink(binstub) if File.exist?(binstub)
+        create_file(binstub, verbose: false) do
+          <<-BUSSER_BINSTUB.gsub(/^ {12}/, "")
             #!/usr/bin/env sh
             #
             # This file was generated by Busser.
@@ -121,22 +130,26 @@ module Busser
             GEM_PATH="#{gem_path}"; export GEM_PATH
             GEM_CACHE="#{gem_home}/cache"; export GEM_CACHE
 
-            # Unset RUBYOPT, we don't want this bleeding into our runtime.
-            unset RUBYOPT GEMRC
+            # Keep the calling Ruby environment out of this one. Unsetting
+            # RUBYOPT is no longer enough: RubyGems requires bundler/setup
+            # whenever BUNDLER_SETUP is set, and bundler then points GEM_HOME
+            # at the calling project's bundle, undoing the isolation above.
+            unset RUBYOPT GEMRC RUBYLIB BUNDLER_SETUP BUNDLER_VERSION
+            unset BUNDLE_BIN_PATH BUNDLE_GEMFILE BUNDLE_LOCKFILE BUNDLE_PATH
 
             # Call the actual Busser bin with our arguments
             exec "#{ruby_bin}" "#{gem_bindir}/busser" "$@"
           BUSSER_BINSTUB
         end
-        chmod(binstub, 0755, :verbose => false)
+        chmod(binstub, 0755, verbose: false)
       end
 
       def ruby_bin
-        result = if bindir = RbConfig::CONFIG["bindir"]
-          File.join(bindir, "ruby")
-        else
-          "ruby"
-        end
+        result = if (bindir = RbConfig::CONFIG["bindir"])
+                   File.join(bindir, "ruby")
+                 else
+                   "ruby"
+                 end
         result = result.gsub("/", "\\").concat(".exe") if bat?
         result
       end

data/lib/busser/command/suite.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,9 +15,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'busser/thor'
-require 'busser/command/suite_cleanup'
-require 'busser/command/suite_path'
+require "busser/thor"
+require "busser/command/suite_cleanup"
+require "busser/command/suite_path"
 
 module Busser
 

data/lib/busser/command/suite_cleanup.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,7 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'busser/thor'
+require "fileutils" unless defined?(FileUtils) # Pathname#rmtree needs it
+require "busser/thor"
 
 module Busser
 
@@ -32,7 +32,7 @@ module Busser
         if suite_path.directory?
           Pathname.glob(suite_path + "*").each do |dir|
             info "Removing #{dir}"
-            dir.rmtree
+            FileUtils.rm_rf(dir)
           end
         else
           info "Suite path directory #{suite_path} does not exist, skipping."

data/lib/busser/command/suite_path.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,7 +15,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'busser/thor'
+require "busser/thor"
 
 module Busser
 
@@ -28,7 +27,7 @@ module Busser
     #
     class SuitePath < Busser::Thor::BaseGroup
 
-      argument :suite_name, :required => false
+      argument :suite_name, required: false
 
       def path
         say suite_path(suite_name).to_s

data/lib/busser/command/test.rb

@@ -1,4 +1,3 @@
-# -*- encoding: utf-8 -*-
 #
 # Author:: Fletcher Nichol (<fnichol@nichol.ca>)
 #
@@ -16,8 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'busser/thor'
-require 'busser/plugin'
+require "busser/thor"
+require "busser/plugin"
 
 module Busser
 
@@ -29,12 +28,13 @@ module Busser
     #
     class Test < Busser::Thor::BaseGroup
 
-      argument :plugins, :type => :array, :required => false
+      argument :plugins, type: :array, required: false
 
       def perform
         Busser::Plugin.runner_plugins(plugins).each do |runner_path|
           runner = File.basename(runner_path)
           next if skip_runner?(runner)
+
           klass = ::Thor::Util.camel_case(runner)
 
           banner "Running #{runner} test suite"

data/lib/busser/cucumber/hooks.rb

@@ -10,7 +10,7 @@ end
 # been saved off
 After do
   ENV.keys.select { |key| key =~ /^_CUKE_/ }.each do |backup_key|
-    ENV[backup_key.sub(/^_CUKE_/, '')] = ENV.delete(backup_key)
+    ENV[backup_key.sub(/^_CUKE_/, "")] = ENV.delete(backup_key)
   end
 end
 
@@ -21,11 +21,3 @@ end
 def restore_envvar(key)
   ENV[key] = ENV.delete("_CUKE_#{key}")
 end
-
-def unbundlerize
-  keys = %w[BUNDLER_EDITOR BUNDLE_BIN_PATH BUNDLE_GEMFILE RUBYOPT]
-
-  keys.each { |key| backup_envvar(key) ; ENV.delete(key) }
-  yield
-  keys.each { |key| restore_envvar(key) }
-end