binbundle 1.0.5 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d503eb5e3d329154c4b8134337701a6dcdf2b10548750603cce3e7689d7249bf
-  data.tar.gz: 6265a9d0df9271d3c77d6619e048a3a18f29b19e31d3381a724b246313acc882
+  metadata.gz: c0b2748f2e8c24eec90dc2856e26ddcb5844482d976ea4cefd6147d88821d65f
+  data.tar.gz: 3192461bfa06f6eb6cfdbbbd7f402032c36fd7eda67df87b91a08fb69e7e6e5b
 SHA512:
-  metadata.gz: 4d1ba6cbdde6132a8775bc6f4d8041d0c580351a330db2cf561de3c39ecc12cd77132c60e903fcd1cfd2875cfb0fd2c684fb18521983921a56b098fe2bde32bf
-  data.tar.gz: a5f3262d2de2caf4a16840c1a2eb86f96d10a49b23ebcf0aaa258774840a860086d7e45fad367431a25767f4b6c0daa20f4c712fca9776b9d19e94bdfb4190f7
+  metadata.gz: 6723f148c5cc7f64c1220863d77cdfb74c65ff918f3d91098419fb23660d0cf1cf07d15be626559a36d1649b6a0a59f12481b74bebd65a3bfd0fd33ce6dd46f0
+  data.tar.gz: c89ceb0a85a1ba3d2e7f7e404eb06c5221d2a85e83f4f8f7627b99c47efd0cdfff5572fed1fa98a37182b12f5cd962636465f03601f252081ac4b739870a7156

data/.rubocop.yml

@@ -1,5 +1,10 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
 AllCops:
   TargetRubyVersion: 2.6
+  # SuggestExtensions: false
 
 Style/StringLiterals:
   Enabled: true
@@ -11,3 +16,15 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 30
+
+Metrics/AbcSize:
+  Max: 40

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+### 1.0.8
+
+2024-08-02 09:23
+
+#### IMPROVED
+
+- Updates for automation
+- Fix tests and rubocop warnings
+
+### 1.0.7
+
+2024-08-02 09:15
+
+#### IMPROVED
+
+- Updates for automation
+- Fix tests and rubocop warnings
+
 ## 1.0.6
 
 - Add spinners

data/Gemfile

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in binbundle.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
+gem 'rake', '~> 13.0'
 
-gem "rspec", "~> 3.0"
+gem 'rspec', '~> 3.0'
 
-gem "rubocop", "~> 1.21"
+gem 'rubocop', '~> 1.21'
+gem 'rubocop-rake', require: false
+gem 'rubocop-rspec', require: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    binbundle (1.0.5)
+    binbundle (1.0.7)
       tty-spinner (~> 0.9)
 
 GEM
@@ -47,6 +47,10 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (3.0.3)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     strscan (3.1.0)
     tty-cursor (0.7.1)
@@ -62,6 +66,8 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  rubocop-rake
+  rubocop-rspec
 
 BUNDLED WITH
    2.2.29

data/README.md

@@ -1,10 +1,13 @@
 # Binbundle
 
+[![Gem](https://img.shields.io/gem/v/binbundle.svg)](https://rubygems.org/gems/na)
+[![GitHub license](https://img.shields.io/github/license/ttscoff/binbundle.svg)](./LICENSE.txt)
+
 Creates a "bundle" file of all installed gems with executables. The resulting file is an executable script that can be run standalone, or in combination with this script to add options like `sudo` or `--user-install` to the `gem install` commands. These options can be specified when creating the file as well. A file created with `sudo` or `--user-install` commands can still be overridden when running via this script and `--install`.
 
 Created file is called `Binfile` in the current directory unless another path is specified with `--file`.
 
-## Installation
+### Installation
 
 Install with:
 
@@ -14,14 +17,24 @@ If this causes errors, use:
 
     $ gem install --user-install binbundle
 
-## Usage
+### Usage
+
+Run `binbundle bundle` to create a Binfile in the current directory, or with `--file FILENAME` to specify a path/filename. That file can optionally be made executable (you'll be prompted). In the future when doing a clean install or using a new system, you can just run that file as a standalone to reinstall all of your gem binaries.
+
+Example:
+
+    binbundle bundle --file ~/dotfiles/Binfile
 
-Run `binbundle` to create a Binfile in the current directory. That file can optionally be made executable (you'll be prompted). In the future when doing a clean install or using a new system, you can just run that file as a standalone to reinstall all of your gem binaries.
+Using this script with the `install` subcommand will read the Binfile and execute it line by line, adding options like version numbers, sudo, or the `--user-install` flag, overriding any of these specified when bundling.
 
-Using this script with the `--install` flag will read the Binfile and execute it line by line, adding options like version numbers, sudo, or the `--user-install` flag.
+Example:
+
+    binbundle install --no-versions --user-install --file ~/dotfiles/Binfile
 
 You can also run with subcommands `bundle` or `install`, e.g. `bundle_gem_bins install`.
 
+#### Options
+
 ```
 Usage: binbundle [options] [bundle|install]
         --[no-]versions              Include version info in output (default true)
@@ -30,24 +43,36 @@ Usage: binbundle [options] [bundle|install]
     -u, --user-install               Use --user-install to install gems
     -f, --file FILE                  Output to alternative filename (default Binfile)
     -v, --version                    Display version
-        --install                    Run bundle script
     -h, --help                       Display this screen
 ```
 
-## Development
+### Recommendations
+
+I recommend using Binbundle along with a tool like Dotfiles. Commit your bundle to a repo that you can easily clone to a new machine and then make `gem install binbundle` and `binbundle install ~/dotfiles/Binfile` part of your restore process.
+
+
+### Support
+
+PayPal link: [paypal.me/ttscoff](https://paypal.me/ttscoff)
+
+### Changelog
+
+See [CHANGELOG.md](https://github.com/ttscoff/binbundle/blob/main/CHANGELOG.md)
+
+### Development
 
 After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
+### Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/ttscoff/binbundle>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ttscoff/binbundle/blob/main/CODE_OF_CONDUCT.md).
 
-## License
+### License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-## Code of Conduct
+### Code of Conduct
 
 Everyone interacting in the Binbundle project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ttscoff/binbundle/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -1,12 +1,75 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'rake/clean'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+desc 'Run test suite'
+task test: %i[rubocop spec]
+
+desc 'Package gem'
+task package: %i[clobber build]
+
+RuboCop::RakeTask.new do |t|
+  t.formatters = ['progress']
+end
 
 RSpec::Core::RakeTask.new(:spec)
 
-require "rubocop/rake_task"
+Rake::RDocTask.new do |rd|
+  rd.main = 'README.rdoc'
+  rd.rdoc_files.include('README.rdoc', 'lib/**/*.rb', 'bin/**/*')
+  rd.title = 'binbundle'
+end
+
+desc 'Development version check'
+task :ver do
+  gver = `git ver`
+  cver = IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+  res = `grep VERSION lib/binbundle/version.rb`
+  version = res.match(/VERSION *= *['"](\d+\.\d+\.\d+(\w+)?)/)[1]
+  puts "git tag: #{gver}"
+  puts "version.rb: #{version}"
+  puts "changelog: #{cver}"
+end
+
+desc 'Changelog version check'
+task :cver do
+  puts IO.read(File.join(File.dirname(__FILE__), 'CHANGELOG.md')).match(/^#+ (\d+\.\d+\.\d+(\w+)?)/)[1]
+end
+
+desc 'Bump incremental version number'
+task :bump, :type do |_, args|
+  args.with_defaults(type: 'inc')
+  version_file = 'lib/binbundle/version.rb'
+  content = IO.read(version_file)
+  content.sub!(/VERSION = '(?<major>\d+)\.(?<minor>\d+)\.(?<inc>\d+)(?<pre>\S+)?'/) do
+    m = Regexp.last_match
+    major = m['major'].to_i
+    minor = m['minor'].to_i
+    inc = m['inc'].to_i
+    pre = m['pre']
+
+    case args[:type]
+    when /^maj/
+      major += 1
+      minor = 0
+      inc = 0
+    when /^min/
+      minor += 1
+      inc = 0
+    else
+      inc += 1
+    end
 
-RuboCop::RakeTask.new
+    $stdout.puts "At version #{major}.#{minor}.#{inc}#{pre}"
+    "VERSION = '#{major}.#{minor}.#{inc}#{pre}'"
+  end
+  File.open(version_file, 'w+') { |f| f.puts content }
+end
 
 task default: %i[spec rubocop]

data/bin/binbundle

@@ -12,7 +12,7 @@ options = {
 }
 
 optparse = OptionParser.new do |opts|
-  opts.banner = "Usage: #{File.basename(__FILE__)} [options]"
+  opts.banner = "Usage: #{File.basename(__FILE__)} [options] [bundle|install]"
 
   opts.on('--[no-]versions', 'Include version info in output (default true)') do |opt|
     options[:include_version] = opt
@@ -39,10 +39,6 @@ optparse = OptionParser.new do |opts|
     Process.exit 0
   end
 
-  opts.on('--install', 'Run bundle script') do
-    options[:install] = true
-  end
-
   opts.on('-h', '--help', 'Display this screen') do
     puts opts
     exit
@@ -58,7 +54,7 @@ end
 
 gb = Binbundle::GemBins.new(options)
 
-options[:install] = true if ARGV.count.positive? && ARGV[0] =~ /^inst/
+options[:install] = true if ARGV.count.positive? && ARGV[0] =~ /^(inst|rest)/
 
 if options[:install]
   gb.install

data/binbundle.gemspec

@@ -1,33 +1,35 @@
 # frozen_string_literal: true
 
-require_relative 'lib/binbundle/version'
+lib = File.expand_path(File.join('..', 'lib'), __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'binbundle/version'
 
-Gem::Specification.new do |spec|
-  spec.name          = 'binbundle'
-  spec.version       = Binbundle::VERSION
-  spec.authors       = ['Brett Terpstra']
-  spec.email         = ['me@brettterpstra.com']
+Gem::Specification.new do |s|
+  s.name          = 'binbundle'
+  s.version       = Binbundle::VERSION
+  s.authors       = ['Brett Terpstra']
+  s.email         = ['me@brettterpstra.com']
 
-  spec.summary       = 'Bundle all your gem binaries.'
-  spec.description   = 'Easily take a snapshot of all binaries installed with Gem and restore on a fresh system.'
-  spec.homepage      = 'https://github.com/ttscoff/binbundle'
-  spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.6.0'
+  s.summary       = 'Bundle all your gem binaries.'
+  s.description   = 'Easily take a snapshot of all binaries installed with Gem and restore on a fresh system.'
+  s.homepage      = 'https://github.com/ttscoff/binbundle'
+  s.license       = 'MIT'
+  s.required_ruby_version = '>= 2.6.0'
 
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://github.com/ttscoff/binbundle'
-  spec.metadata['changelog_uri'] = 'https://github.com/ttscoff/binbundle/CHANGELOG.md'
+  s.metadata['homepage_uri'] = s.homepage
+  s.metadata['source_code_uri'] = 'https://github.com/ttscoff/binbundle'
+  s.metadata['changelog_uri'] = 'https://github.com/ttscoff/binbundle/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
       (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
     end
   end
-  spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  s.bindir        = 'bin'
+  s.executables   = s.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
 
-  spec.add_runtime_dependency('tty-spinner', '~> 0.9')
+  s.add_runtime_dependency('tty-spinner', '~> 0.9')
 end

data/lib/binbundle/gem_bins.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Binbundle
   # Main class
   class GemBins
@@ -47,12 +49,14 @@ module Binbundle
       @errors = []
 
       lines.each do |cmd|
+        # rubocop:disable Naming/VariableNumber
         spinner = TTY::Spinner.new("[:spinner] #{cmd} ...", hide_cursor: true, format: :dots_2)
+        # rubocop:enable Naming/VariableNumber
 
         spinner.auto_spin
 
         output = `/bin/bash -c '#{cmd}' 2>&1`
-        result = $?.success?
+        result = $CHILD_STATUS.success?
 
         if result
           spinner.success
@@ -64,10 +68,10 @@ module Binbundle
         end
       end
 
-      unless @errors.empty?
-        puts "ERRORS:"
-        puts @errors.join("\n")
-      end
+      return if @errors.empty?
+
+      puts 'ERRORS:'
+      puts @errors.join("\n")
     end
 
     def gem_command(gem, attrs)

data/lib/binbundle/gem_list.rb

@@ -5,8 +5,6 @@ module Binbundle
   class GemList
     attr_writer :include_version
 
-    attr_reader :gem_list
-
     def initialize(contents, include_version: true)
       @contents = contents
       @include_version = include_version
@@ -14,8 +12,12 @@ module Binbundle
     end
 
     def gem_list
-      @gem_list ||= @contents.split("\n").delete_if { |line| line.strip.empty? || line =~ /^#/ }.each_with_object([]) do |l, arr|
-        m = l.match(/^(?:sudo )?gem install (?:--user-install )?(?<gem>\S+)(?: (?:-v|--version) '(?<version>[0-9.]+)')?/)
+      @gem_list ||= @contents.split("\n")
+                             .delete_if { |line| line.strip.empty? || line =~ /^#/ }
+                             .each_with_object([]) do |l, arr|
+        rx = /^(?x)(?:sudo\s)?gem\sinstall\s(?:--user-install\s)?
+        (?<gem>\S+)(?:\s(?:-v|--version)\s'(?<version>[0-9.]+)')?/
+        m = l.match(rx)
         arr << { gem: m['gem'], version: m['version'] }
       end
     end

data/lib/binbundle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Binbundle
-  VERSION = '1.0.5'
+  VERSION = '1.0.8'
 end

data/lib/binbundle.rb

@@ -3,6 +3,7 @@
 require 'optparse'
 require 'fileutils'
 require 'tty-spinner'
+require 'english'
 require_relative 'binbundle/version'
 require_relative 'binbundle/prompt'
 require_relative 'binbundle/gem_list'

data/src/_README.md

@@ -0,0 +1,79 @@
+<!--README--><!--GITHUB--># Binbundle
+
+[![Gem](https://img.shields.io/gem/v/binbundle.svg)](https://rubygems.org/gems/na)
+[![GitHub license](https://img.shields.io/github/license/ttscoff/binbundle.svg)](./LICENSE.txt)<!--END GITHUB-->
+
+Creates a "bundle" file of all installed gems with executables. The resulting file is an executable script that can be run standalone, or in combination with this script to add options like `sudo` or `--user-install` to the `gem install` commands. These options can be specified when creating the file as well. A file created with `sudo` or `--user-install` commands can still be overridden when running via this script and `--install`.
+
+Created file is called `Binfile` in the current directory unless another path is specified with `--file`.
+
+### Installation
+
+Install with:
+
+    $ gem install binbundle
+
+If this causes errors, use:
+
+    $ gem install --user-install binbundle
+
+### Usage
+
+Run `binbundle bundle` to create a Binfile in the current directory, or with `--file FILENAME` to specify a path/filename. That file can optionally be made executable (you'll be prompted). In the future when doing a clean install or using a new system, you can just run that file as a standalone to reinstall all of your gem binaries.
+
+Example:
+
+    binbundle bundle --file ~/dotfiles/Binfile
+
+Using this script with the `install` subcommand will read the Binfile and execute it line by line, adding options like version numbers, sudo, or the `--user-install` flag, overriding any of these specified when bundling.
+
+Example:
+
+    binbundle install --no-versions --user-install --file ~/dotfiles/Binfile
+
+You can also run with subcommands `bundle` or `install`, e.g. `bundle_gem_bins install`.
+
+#### Options
+
+```
+Usage: binbundle [options] [bundle|install]
+        --[no-]versions              Include version info in output (default true)
+        --dry-run                    Output to STDOUT instead of file
+    -s, --sudo                       Install gems with sudo
+    -u, --user-install               Use --user-install to install gems
+    -f, --file FILE                  Output to alternative filename (default Binfile)
+    -v, --version                    Display version
+    -h, --help                       Display this screen
+```
+
+### Recommendations
+
+I recommend using Binbundle along with a tool like Dotfiles. Commit your bundle to a repo that you can easily clone to a new machine and then make `gem install binbundle` and `binbundle install ~/dotfiles/Binfile` part of your restore process.
+
+<!--GITHUB-->
+### Support
+
+PayPal link: [paypal.me/ttscoff](https://paypal.me/ttscoff)
+
+### Changelog
+
+See [CHANGELOG.md](https://github.com/ttscoff/binbundle/blob/main/CHANGELOG.md)
+
+### Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/ttscoff/binbundle>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ttscoff/binbundle/blob/main/CODE_OF_CONDUCT.md).
+
+### License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+### Code of Conduct
+
+Everyone interacting in the Binbundle project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ttscoff/binbundle/blob/main/CODE_OF_CONDUCT.md).
+<!--END GITHUB--><!--END README-->

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: binbundle
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.8
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-01 00:00:00.000000000 Z
+date: 2024-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tty-spinner
@@ -49,6 +49,7 @@ files:
 - lib/binbundle/gem_list.rb
 - lib/binbundle/prompt.rb
 - lib/binbundle/version.rb
+- src/_README.md
 homepage: https://github.com/ttscoff/binbundle
 licenses:
 - MIT