binbundle 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 593e189840e9f90dc770daa8af1bded80d6a732cf9f7e35589b86314b884f4fa
-  data.tar.gz: ae7314de2c67a750210a57462fdc64fbd3ba61fa99f0a2a7393747dbc20b2c68
+  metadata.gz: 5004c2ef304f3a5f5fd17c78847d857090408f0e9a1a2bea3ce23553006362bf
+  data.tar.gz: c4b5d368b0166251fd6a6e60e46dd867c54901945e0d47d642430b3638bb66d9
 SHA512:
-  metadata.gz: 9d4e06a1f4063f3b92a273380d616681b069b41e024047fc6974276dabd767b4fadef660ad38d7bc62dd510ed0043906a0e20125d5172e81b44e9853b4a1d876
-  data.tar.gz: 870dffb7b79c27871ab90bd7f5875dd9dbf4952ff3db254d44d12d73b807f65901a238b2d42fdaeb8f96e52aa95569c4bf1bd6937b0a24bf292548301b89e70b
+  metadata.gz: 970e55c036810e670b77e276c8da27b98552e4410e1a15741c7d60e7a03a7fd7243ffdb13d7fa64c190c0bd2cf7d59a16f7219a81534131c9a7c8e3971a67aa9
+  data.tar.gz: c28dfe8cb48c87f1f1aef43fd3b3e8afb986815297ba13f264aca90880b7b71526df27d1780afeffdb473c3216d0f07a511984bc233ffdf6da2afc0308b53096

data/.irbrc

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+`gem rdoc binbundle --ri`
+
+# rubocop:disable Style/MixinUsage
+include Binbundle # standard:disable all
+# rubocop:enable Style/MixinUsage

data/.rubocop.yml

@@ -34,3 +34,6 @@ Metrics/PerceivedComplexity:
 
 Metrics/AbcSize:
   Max: 40
+
+Metrics/CyclomaticComplexity:
+  Max: 15

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 1.0.10
+
+2024-08-04 06:48
+
+#### IMPROVED
+
+- Code refactoring, tests
+- More tests, more fixes
+
 ### 1.0.9
 
 2024-08-02 10:42

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    binbundle (1.0.9)
+    binbundle (1.0.10)
       tty-spinner (~> 0.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ansi (1.5.0)
     ast (2.4.2)
     diff-lcs (1.5.1)
+    docile (1.4.1)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
     parallel (1.25.1)
@@ -52,13 +54,27 @@ GEM
     rubocop-rspec (3.0.3)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-console (0.9.1)
+      ansi
+      simplecov
+      terminal-table
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     strscan (3.1.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
     tty-cursor (0.7.1)
     tty-spinner (0.9.3)
       tty-cursor (~> 0.7)
     unicode-display_width (2.5.0)
+    yard (0.9.36)
 
 PLATFORMS
+  arm64-darwin-20
   x86_64-darwin-20
 
 DEPENDENCIES
@@ -68,6 +84,9 @@ DEPENDENCIES
   rubocop (~> 1.21)
   rubocop-rake
   rubocop-rspec
+  simplecov (~> 0.21)
+  simplecov-console (~> 0.9)
+  yard (~> 0.9, >= 0.9.26)
 
 BUNDLED WITH
    2.2.29

data/README.md

@@ -55,7 +55,7 @@ Use either info command with `--local` to parse installed gems rather than a Bin
 
 ### 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.
+I recommend using Binbundle along with a tool like [Dotbot](https://github.com/anishathalye/dotbot). 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

data/README.rdoc

@@ -0,0 +1,6 @@
+= Binbundle
+
+A command line tool for bundling installed gem binaries and restoring them.
+
+
+

data/Rakefile

@@ -7,6 +7,7 @@ require 'rdoc/task'
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
+require 'yard'
 
 desc 'Run test suite'
 task test: %i[rubocop spec]
@@ -26,6 +27,12 @@ Rake::RDocTask.new do |rd|
   rd.title = 'binbundle'
 end
 
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/binbundle/*.rb']
+  t.options = ['--markup-provider=redcarpet', '--markup=markdown', '--no-private', '-p', 'yard_templates']
+  # t.stats_options = ['--list-undoc']
+end
+
 desc 'Development version check'
 task :ver do
   gver = `git ver`

data/binbundle.gemspec

@@ -31,5 +31,9 @@ Gem::Specification.new do |s|
   s.executables   = s.files.grep(%r{\Abin/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
+  s.add_development_dependency 'simplecov', '~> 0.21'
+  s.add_development_dependency 'simplecov-console', '~> 0.9'
+  s.add_development_dependency 'yard', '~> 0.9', '>= 0.9.26'
+
   s.add_runtime_dependency('tty-spinner', '~> 0.9')
 end

data/lib/binbundle/gem_bins.rb

@@ -3,20 +3,43 @@
 module Binbundle
   # Main class
   class GemBins
-    def local_gems
-      Gem::Specification.sort_by { |g| [g.name.downcase, g.version] }.group_by(&:name)
-    end
-
+    # Get gem for bin :gem_for
+    attr_writer :gem_for
+
+    # Get bins for gem :bin_for
+    attr_writer :bin_for
+
+    # Set options (for testing)
+    attr_writer :file, :dry_run
+
+    ##
+    ## Create a new GemBins object
+    ##
+    ## @param      options  The options
+    ## @option options [Boolean] :include_version Include version number in output
+    ## @option options [Boolean] :sudo Include sudo in output
+    ## @option options [Boolean] :user_install Include --user-install in output
+    ## @option options [Boolean] :dry_run Output to STDOUT
+    ## @option options [String] :file File to parse
+    ## @option options [Boolean] :local Work from local gems instead of Binfile
+    ##
     def initialize(options = {})
       @include_version = options[:include_version] || false
       @user_install = options[:user_install]
       @sudo = options[:sudo]
       @dry_run = options[:dry_run]
       @file = File.expand_path(options[:file])
-
-      @local_gems = local_gems.delete_if { |_, specs| specs.delete_if { |spec| spec.executables.empty? }.empty? }
     end
 
+    ##
+    ## Retrieve info (bin_for or gem_for)
+    ##
+    ## @param      options  The options
+    ## @option options [Boolean] :local Work from local gems instead of Binfile
+    ## @option options [String] :gem_for Find gem for this binary
+    ## @option options [String] :bin_for Find bins for this gem
+    ##
+    ## @return [String] resulting gem or bins
     def info(options)
       unless File.exist?(@file) || options[:local]
         puts "File #{@file} not found"
@@ -29,7 +52,10 @@ module Binbundle
                    IO.read(@file)
                  end
 
-      gem_list = GemList.new(contents, include_version: @include_version)
+      gem_list = JewelryBox.new(contents: contents,
+                                include_version: @include_version,
+                                sudo: @sudo,
+                                user_install: @user_install)
       if options[:gem_for]
         gem_list.gem_for_bin(options[:gem_for])
       elsif options[:bin_for]
@@ -37,30 +63,29 @@ module Binbundle
       end
     end
 
+    ##
+    ## Install all gems in Binfile
+    ##
     def install
       unless File.exist?(@file)
         puts "File #{@file} not found"
         Process.exit 1
       end
 
-      res = Prompt.yn("Install gems from #{File.basename(@file)}", default_response: true)
+      contents = IO.read(@file)
+      lines = JewelryBox.new(contents: contents, include_version: @include_version, sudo: @sudo,
+                             user_install: @user_install)
 
+      total = lines.count
+      successes = 0
+      failures = 0
+      res = Prompt.yn("Install #{total} gems from #{File.basename(@file)}", default_response: true)
       Process.exit 0 unless res
 
       puts "Installing gems from #{@file}"
 
-      contents = IO.read(@file)
-      gem_list = GemList.new(contents, include_version: @include_version)
-      lines = if @sudo
-                gem_list.sudo
-              elsif @user_install
-                gem_list.user_install
-              else
-                gem_list.normal_install
-              end
-
       if @dry_run
-        puts lines.join("\n")
+        puts lines
         Process.exit 0
       end
 
@@ -79,40 +104,38 @@ module Binbundle
         result = $CHILD_STATUS.success?
 
         if result
+          successes += 1
           spinner.success
           spinner.stop
         else
+          failures += 1
           spinner.error
           spinner.stop
           @errors << output
         end
       end
 
+      puts "Total #{total}, installed: #{successes}, #{failures} errors."
+
       return if @errors.empty?
 
       puts 'ERRORS:'
       puts @errors.join("\n")
+      Process.exit 1
     end
 
-    def gem_command(gem, attrs)
-      ver = @include_version ? " -v '#{attrs[:version]}'" : ''
-      ui = @user_install ? '--user-install ' : ''
-      sudo = @sudo ? 'sudo ' : ''
-      "# Executables: #{attrs[:bins].join(', ')}\n#{sudo}gem install #{ui}#{gem}#{ver}"
-    end
-
+    ##
+    ## Output all gems as Binfile format
+    ##
+    ## @return     [String] Binfile format
+    ##
     def bins_to_s
-      gems_with_bins = {}
-
-      @local_gems.each do |g, specs|
-        versions = specs.map { |spec| spec.version.to_s }
-        bins = specs.map(&:executables)
-        gems_with_bins[g] = { version: versions.max, bins: bins.sort.uniq }
-      end
-
-      gems_with_bins.map { |gem, attrs| gem_command(gem, attrs) }.join("\n\n")
+      local_gems.map(&:gem_command).join("\n\n")
     end
 
+    ##
+    ## Output or write Binfile
+    ##
     def generate
       output = bins_to_s
 
@@ -123,6 +146,9 @@ module Binbundle
       end
     end
 
+    ##
+    ## Writes to Binfile
+    ##
     def write_file(output)
       if File.exist?(@file)
         res = Prompt.yn("#{@file} already exists, overwrite", default_response: false)
@@ -144,5 +170,24 @@ module Binbundle
       FileUtils.chmod 0o777, @file
       puts 'Made file executable'
     end
+
+    private
+
+    ##
+    ## Find local gems and group by name
+    ##
+    ## @return     [Array] array of local gems as Hashes
+    ##
+    def local_gems
+      gems_with_bins = JewelryBox.new(include_version: @include_version, sudo: @sudo, user_install: @user_install)
+
+      all = Gem::Specification.sort_by { |g| [g.name.downcase, g.version] }.group_by(&:name)
+      all.delete_if { |_, specs| specs.delete_if { |spec| spec.executables.empty? }.empty? }
+      all.each do |g, specs|
+        gems_with_bins << Jewel.new(g, specs.last.executables.sort.uniq, specs.last.version.to_s)
+      end
+
+      gems_with_bins
+    end
   end
 end

data/lib/binbundle/jewel.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Binbundle
+  # String helpers
+  class Jewel
+    # Include version info in output
+    attr_writer :include_version
+
+    # Include sudo
+    attr_writer :sudo
+
+    # Include --user-install
+    attr_writer :user_install
+
+    # Binaries
+    attr_reader :bins
+
+    # Gem name
+    attr_reader :gem
+
+    ##
+    ## Create a new Jewel object
+    ##
+    ## @param      gem_name  [String] The gem name
+    ## @param      bins      [Array|String] The executables
+    ## @param      version   [String] The semantic version
+    ##
+    ## @return     [Jewel] new jewel object
+    ##
+    def initialize(gem_name = '', bins = [], version = nil)
+      @gem = gem_name
+      @bins = if bins.is_a?(String)
+                bins.split(/ *, */)
+              else
+                bins
+              end
+      @version = version
+      @include_version = true
+    end
+
+    ##
+    ## Output Jewel as command
+    ##
+    ## @return     [String] Command representation of the object.
+    ##
+    def to_s
+      version = @include_version && @version ? " -v '#{@version}'" : ''
+      if @sudo
+        "sudo gem install #{@gem}#{version}"
+      elsif @user_install
+        "gem install --user-install #{@gem}#{version}"
+      else
+        "gem install #{@gem}#{version}"
+      end
+    end
+
+    ##
+    ## Output a Binfile-ready version of the Jewel
+    ##
+    ## @return     [String] Binfile string
+    ##
+    def gem_command
+      ver = @include_version ? " -v '#{@version}'" : ''
+      ui = @user_install ? '--user-install ' : ''
+      sudo = @sudo ? 'sudo ' : ''
+      "# Executables: #{@bins.join(', ')}\n#{to_s}"
+    end
+  end
+end

data/lib/binbundle/jewelry_box.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Binbundle
+  # String helpers
+  class JewelryBox < Array
+    # Include version info in output
+    attr_writer :include_version
+
+    # Include sudo
+    attr_writer :sudo
+
+    # Include --user-install
+    attr_writer :user_install
+
+    ##
+    ## Create a new JewelryBox object
+    ##
+    ## @param      include_version  [Boolean] include version
+    ## @param      sudo             [Boolean] include sudo
+    ## @param      user_install     [Boolean] include --user-install
+    ## @param      contents         [String] The contents to parse
+    ##
+    ## @return [JewelryBox] New JewelryBox object
+    def initialize(include_version: true, sudo: false, user_install: false, contents: nil)
+      @include_version = include_version
+      @sudo = sudo
+      @user_install = user_install
+
+      super()
+
+      return unless contents
+
+      init_from_contents(contents)
+    end
+
+    ##
+    ## Read and parse a Binfile for gems to install
+    ##
+    ## @param      contents  [String] The contents
+    ##
+    def init_from_contents(contents)
+      rx = /(?mix)(?:\#\sExecutables:\s(?<bins>[\S\s,]+?)\n)?(?:sudo\s)?gem\sinstall
+            \s(?:--user-install\s)?
+            (?<gem>\S+)(?:\s(?:-v|--version)\s'(?<version>[0-9.]+)')?/
+      contents.to_enum(:scan, rx).map { Regexp.last_match }.each do |m|
+        g = Jewel.new(m['gem'], m['bins'], m['version'])
+        g.include_version = @include_version
+        g.sudo = @sudo
+        g.user_install = @user_install
+        push(g)
+      end
+    end
+
+    ##
+    ## Find a gem for a given binary name
+    ##
+    ## @param      bin   [String] The bin to search for
+    ##
+    ## @return     [String] Associated gem name
+    ##
+    def gem_for_bin(bin)
+      m = select { |gem| gem.bins&.include?(bin) }.first
+      return "Gem for #{bin} not found" unless m
+
+      m.gem
+    end
+
+    ##
+    ## List binaries for a given gem name
+    ##
+    ## @param      gem   [String] The gem name to search for
+    ##
+    def bins_for_gem(gem)
+      m = select { |g| g.gem == gem }.first
+      return "Gem #{gem} not found" unless m
+
+      m.bins ? m.bins.join(', ') : 'Missing info'
+    end
+
+    ##
+    ## Output a Binfile version of the JewelryBox
+    ##
+    ## @return     [String] String representation of the object.
+    ##
+    def to_s
+      map(&:to_s).join("\n")
+    end
+  end
+end

data/lib/binbundle/prompt.rb

@@ -23,7 +23,7 @@ module Binbundle
                 end
 
       # if this isn't an interactive shell, answer default
-      return default unless $stdout.isatty
+      return default if !$stdout.isatty || ENV['TESTING'] == 'true'
 
       # clear the buffer
       if ARGV&.length

data/lib/binbundle/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# Main bundle
 module Binbundle
-  VERSION = '1.0.9'
+  # Version
+  VERSION = '1.0.10'
 end

data/lib/binbundle.rb

@@ -6,10 +6,13 @@ require 'tty-spinner'
 require 'english'
 require_relative 'binbundle/version'
 require_relative 'binbundle/prompt'
-require_relative 'binbundle/gem_list'
+require_relative 'binbundle/jewel'
+require_relative 'binbundle/jewelry_box'
 require_relative 'binbundle/gem_bins'
 
+# Parent module
 module Binbundle
+  # StandardError class
   class Error < StandardError; end
   # Your code goes here...
 end

data/src/_README.md

@@ -55,7 +55,7 @@ Use either info command with `--local` to parse installed gems rather than a Bin
 
 ### 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.
+I recommend using Binbundle along with a tool like [Dotbot](https://github.com/anishathalye/dotbot). 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

metadata

@@ -1,15 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: binbundle
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Brett Terpstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-02 00:00:00.000000000 Z
+date: 2024-08-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.26
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.26
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -33,6 +81,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".irbrc"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
@@ -41,12 +90,14 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- README.rdoc
 - Rakefile
 - bin/binbundle
 - binbundle.gemspec
 - lib/binbundle.rb
 - lib/binbundle/gem_bins.rb
-- lib/binbundle/gem_list.rb
+- lib/binbundle/jewel.rb
+- lib/binbundle/jewelry_box.rb
 - lib/binbundle/prompt.rb
 - lib/binbundle/version.rb
 - src/_README.md
@@ -72,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: Bundle all your gem binaries.

data/lib/binbundle/gem_list.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module Binbundle
-  # String helpers
-  class GemList
-    attr_writer :include_version
-
-    def initialize(contents, include_version: true)
-      @contents = contents
-      @include_version = include_version
-    end
-
-    def gem_list
-      return @gem_list if @gem_list
-
-      rx = /(?mix)(?:\#\sExecutables:\s(?<bins>[\S\s,]+?)\n)?(?:sudo\s)?gem\sinstall
-            \s(?:--user-install\s)?
-            (?<gem>\S+)(?:\s(?:-v|--version)\s'(?<version>[0-9.]+)')?/
-      @gem_list = []
-      @contents.to_enum(:scan, rx).map { Regexp.last_match }.each do |m|
-        @gem_list << { gem: m['gem'], bins: m['bins']&.split(', '), version: m['version'] }
-      end
-      @gem_list
-    end
-
-    def sudo
-      gem_list.map do |gem|
-        version = @include_version && gem[:version] ? " -v '#{gem[:version]}'" : ''
-        "sudo gem install #{gem[:gem]}#{version}"
-      end
-    end
-
-    def user_install
-      gem_list.map do |gem|
-        version = @include_version && gem[:version] ? " -v '#{gem[:version]}'" : ''
-        "gem install --user-install #{gem[:gem]}#{version}"
-      end
-    end
-
-    def normal_install
-      gem_list.map do |gem|
-        version = @include_version && gem[:version] ? " -v '#{gem[:version]}'" : ''
-        "gem install #{gem[:gem]}#{version}"
-      end
-    end
-
-    def gem_for_bin(bin)
-      m = gem_list.select { |gem| gem[:bins].include?(bin) }.first
-      return "Gem for #{bin} not found" unless m
-
-      m[:gem]
-    end
-
-    def bins_for_gem(gem)
-      m = gem_list.select { |g| g[:gem] == gem }.first
-      return "Gem #{gem} not found" unless m
-
-      m[:bins] ? m[:bins].join("\n") : 'Missing info'
-    end
-  end
-end