brew-cask-tools 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54e79300a1a94158ab3d9808ba88b8325277e43d
-  data.tar.gz: 396206348befd0b098b884b165e018d8f8acf2db
+  metadata.gz: 69b3132783d2a2e29ca228d44598ccbfef53d5f9
+  data.tar.gz: f4d075a519e9b0f87f5728914e990ed064c9c71d
 SHA512:
-  metadata.gz: 36056ca2108754e300401207c5478d94ffdbbf20aecb0dafadff0e55443fb674cbefc2306f90e4024a44d326135e89af3777bdaf08b1068a1666611d39273a5d
-  data.tar.gz: e0b6014c24b9a69db83a45ad861f7897f5ce149e0015d8f1457cc9be6574a51bc83f937f31a06f6922ab73ab2458e414fb4b74ddb7d696b5bdac7bf2060dbce2
+  metadata.gz: 65744666d8fa3bbf845feed5a362e0964aaca2f99ffb0d6f17e055f0afd9f77625cd446f6419eec79c8daa213c0fa466d3c7b4710f920dd67e3e21e6cb98248e
+  data.tar.gz: 680db979070c6dffb5d6ccc80b459d0ca8f4df5cf29facc36b3b89a241fa70e87bb7a869f5a84ff05a3791fa93d73b9a764e71345ad2ea22aef0df19d0265f78

data/lib/bct/cask.rb

@@ -3,9 +3,10 @@ require 'thor'
 require 'open3'
 
 require_relative './cask/info'
+require_relative './cask/versions'
 
+# Location of homebrew cask's caskroom
 CASKROOM = '/usr/local/Caskroom'.freeze
-DIR_BLACKLIST = ['.', '..', '.metadata'].freeze
 
 module BrewCaskTools
   # Cask control class. Implements operations on a single cask.
@@ -24,33 +25,33 @@ module BrewCaskTools
         info = `brew cask info #{name}`.split("\n")
       end
 
-      @info = Info.new(info)
-      @deprecated = deprecated?
+      @info = Casks::Info.new(info)
       @dir = File.join(CASKROOM, @name)
+      @versions = Casks::Versions.new(@dir, @info.short_name.sub("#{@name}: ", ''))
     end
 
-    def filter_info
-      @info.info.select! { |i| !i.end_with?('(does not exist)') }
+    def current
+      @versions.current
     end
 
-    def current_version
-      @info.short_name.sub("#{@name}: ", '')
+    def candidate
+      @versions.candidate
     end
 
-    def installed_version
-      local_versions.last
+    def versions
+      @versions.installed
     end
 
-    def local_versions
-      Dir.entries(@dir)
-         .reject { |i| DIR_BLACKLIST.include?(i) }
-         .sort
+    def old
+      @versions.old_installed
     end
 
-    def local_metadata_versions
-      Dir.entries(File.join(@dir, '.metadata'))
-         .reject { |i| DIR_BLACKLIST.include?(i) }
-         .sort
+    def metadata
+      @versions.metadata
+    end
+
+    def latest?
+      @versions.latest?
     end
 
     def deprecated?
@@ -58,71 +59,51 @@ module BrewCaskTools
     end
 
     def can_cleanup?
-      return true if @deprecated
-      (local_versions.length > 1 || local_metadata_versions.length > 1)
+      versions.length > 1 || metadata.length > 1
     end
 
     def outdated?
-      current_version != installed_version
+      return false if latest?
+      candidate > current
     end
 
-    def upgrade
-      return say "You have the most recent version of #{@name}. " \
-      'It cannot be upgraded', :green unless outdated?
-
-      say "Installing #{@name} (#{current_version})", :cyan
-      cmd = "brew cask install #{@name} --force"
-      Open3.popen2e(cmd) do |_stdin, stdout_err, _wait_thr|
-        while line = stdout_err.gets
+    def exec
+      Open3.popen2e("brew cask install #{@name} --force") do |_stdin, stdout_err, _wait_thr|
+        line = ''
+        while line
+          line = stdout_err.gets
           puts line
         end
       end
-      say "Upgraded #{@name} to version #{current_version}", :green
     end
 
-    def old_versions
-      old(local_versions)
-    end
+    def upgrade
+      return say "#{@name} uses the `latest` convention. " \
+      'Homebrew cask does not upgrade casks marked as ' \
+      '`latest`. Use another method of determining if ' \
+      'this application has an upgrade', :green if latest?
 
-    def old_metadata
-      old(local_metadata_versions)
-    end
+      return say "You have the most recent version of #{@name}. " \
+      'It cannot be upgraded', :green unless outdated?
 
-    def old(arr)
-      _, *previous = arr.reverse
-      previous
+      say "Installing #{@name} (#{candidate})", :cyan
+      exec
+      say "Upgraded #{@name} to version #{candidate}", :green
     end
 
     def cleanup
       return unless can_cleanup?
-      if @deprecated == true
-        yield self, local_versions
+
+      if deprecated?
+        yield self, versions
         # Delete the whole cask
-        rm(@dir)
+        ::FileUtils.rm_rf(@dir, secure: true, verbose: true)
         return
       end
 
-      yield self, old_versions
-      rm_old(old_versions, method(:rm_version))
-      rm_old(old_metadata, method(:rm_metadata))
-    end
-
-    def rm_old(versions, method)
-      versions.each do |version|
-        method.call(version)
-      end
-    end
-
-    def rm_version(version)
-      rm(File.join(@dir, version))
-    end
-
-    def rm_metadata(version)
-      rm(File.join(@dir, '.metadata', version))
-    end
+      yield self, old
 
-    def rm(dir)
-      ::FileUtils.rm_rf(dir, secure: true, verbose: true)
+      @versions.rm_old
     end
   end
 end

data/lib/bct/cask/info.rb

@@ -1,34 +1,34 @@
-require 'pry'
-
 module BrewCaskTools
-  # Class to keep brittle parsing of `brew cask info #{cask}` localized.
-  class Info
-    def initialize(arr)
-      @info = arr.nil? ? [] : arr
-    end
+  module Casks
+    # Class to keep brittle parsing of `brew cask info #{cask}` localized.
+    class Info
+      def initialize(arr)
+        @info = arr.nil? ? [] : arr
+      end
 
-    def short_name
-      @info[0]
-    end
+      def short_name
+        @info[0]
+      end
 
-    def url
-      @info[1]
-    end
+      def url
+        @info[1]
+      end
 
-    def path
-      @info[2]
-    end
+      def path
+        @info[2]
+      end
 
-    def cask_url
-      @info[3]
-    end
+      def cask_url
+        @info[3]
+      end
 
-    def name
-      @info[5]
-    end
+      def name
+        @info[5]
+      end
 
-    def app_name
-      @info[7]
+      def app_name
+        @info[7]
+      end
     end
   end
 end

data/lib/bct/cask/version.rb

@@ -0,0 +1,54 @@
+require 'versionomy'
+
+module BrewCaskTools
+  module Casks
+    # Parent class for different types of Versions
+    class Version
+      DIR_BLACKLIST = ['.', '..', '.metadata'].freeze
+
+      def initialize(dir)
+        @dir = dir
+      end
+
+      def versions
+        @versions ||= latest? ? ['latest'] : all_versions.sort
+      end
+
+      def latest?
+        all_versions.select { |version| version.to_s == 'latest' }.length.positive?
+      end
+
+      def rm_old
+        old.each { |version| rm(version) }
+      end
+
+      def old
+        _, *previous = versions.reverse
+        previous
+      end
+
+      def self.parse_version(version)
+        Versionomy.parse(version)
+      rescue Versionomy::Errors::ParseError
+        version
+      end
+
+      private
+
+      def rm(version)
+        version_dir = File.join(@dir, version.to_s)
+        ::FileUtils.rm_rf(version_dir, secure: true, verbose: true)
+      end
+
+      def all_versions
+        Dir.entries(@dir)
+           .reject { |dir| DIR_BLACKLIST.include?(dir) }
+           .map do |version|
+             if File.directory?(File.join(@dir, version))
+               Version.parse_version(version)
+             end
+           end.compact
+      end
+    end
+  end
+end

data/lib/bct/cask/versions.rb

@@ -0,0 +1,49 @@
+require_relative './version'
+
+module BrewCaskTools
+  module Casks
+    # Operations on a collection of Cask versions
+    class Versions
+      attr_reader :local, :meta
+
+      def initialize(dir, candidate)
+        @candidate = candidate
+        @local = Version.new(dir)
+        @meta = Version.new(File.join(dir, '.metadata'))
+      end
+
+      def installed
+        @local.versions
+      end
+
+      def metadata
+        @meta.versions
+      end
+
+      def candidate
+        Version.parse_version(@candidate)
+      end
+
+      def current
+        installed.last
+      end
+
+      def latest?
+        current.to_s == 'latest'
+      end
+
+      def old_installed
+        @local.old
+      end
+
+      def old_metadata
+        @meta.old
+      end
+
+      def rm_old
+        @local.rm_old
+        @meta.rm_old
+      end
+    end
+  end
+end

data/lib/bct/caskroom.rb

@@ -1,32 +1,30 @@
-require 'thor'
-require 'pry'
-
 require_relative './cask'
 
 module BrewCaskTools
   # Represents a list of Casks.
-  class Caskroom < Thor::Shell::Basic
+  class Caskroom
     def initialize
       super
     end
 
+    # An array of installed casks
+    # @return [Array]
     def casks
       @casks ||= `brew cask ls`.split("\n")
     end
 
-    def casklist
-      @casklist ||= casks.map { |cask| yield cask }
-    end
-
+    # @param [Proc]
     def enumerate
-      casklist do |c|
-        yield Cask.new(c)
+      casks.map do |cask|
+        yield Cask.new(cask)
       end
     end
 
+    # @param cask_name [String]
+    # @return [BrewCaskTools::Cask]
     def get(cask_name)
-      c = casks.select { |e| e == cask_name }.first
-      Cask.new(c)
+      cask = casks.select { |name| name == cask_name }
+      cask.empty? ? nil : Cask.new(cask.first)
     end
   end
 end

data/lib/bct/metadata.rb

@@ -1,7 +1,5 @@
-require 'git-version-bump'
-
 # :nodoc:
 module BrewCaskTools
-  VERSION = GVB.version
+  VERSION = `git describe --abbrev=0 --tags`.delete('v')
   DESCRIPTION = 'A tiny tool that provides some missing functionality in Homebrew Cask.'.freeze
 end

data/lib/bct/tasks.rb

@@ -30,16 +30,16 @@ module BrewCaskTools
         Tasks::Outdated.new
       end
 
-      desc 'upgrade CASK', 'Upgrade a specific cask.' \
+      desc 'upgrade CASKS', 'Upgrade a specific cask.' \
       ' If a cask name is omitted, this task will update all outdated casks.'
-      def upgrade(cask_name = nil)
-        Tasks::Upgrade.new(cask_name)
+      def upgrade(*casks)
+        Tasks::Upgrade.new(casks)
       end
 
-      desc 'cleanup CASK', 'clean up old versions of a specific cask. If a ' \
+      desc 'cleanup CASKS', 'clean up old versions of a specific cask. If a ' \
       'cask name is omitted, this task will cleanup all outdated casks.'
-      def cleanup(cask_name = nil)
-        Tasks::Cleanup.new(cask_name)
+      def cleanup(*casks)
+        Tasks::Cleanup.new(casks)
       end
     end
   end

data/lib/bct/tasks/caskroom.rb

@@ -14,6 +14,21 @@ module BrewCaskTools
       def progressbar
         @progressbar ||= ProgressBar.create(title: '  Progress ')
       end
+
+      def handle(casks, adverb)
+        puts "#{adverb.capitalize} packages\n------------------"
+        yield casks
+        puts "\n"
+      end
+
+      def increment(cask)
+        progressbar.title = "  #{cask.name.capitalize} "
+        progressbar.increment
+      end
+
+      def format(headers, output)
+        print_table(output.unshift(headers))
+      end
     end
   end
 end

data/lib/bct/tasks/cleanup.rb

@@ -1,55 +1,54 @@
 require 'thor'
-require 'pry'
 
 require_relative './caskroom'
 
 module BrewCaskTools
   module Tasks
-    # Cleanup tasks
+    # Cleanup task
     class Cleanup < Caskroom
-      def initialize(cask_name)
+      # @param optional casks [Array] array of cask names to cleanup
+      def initialize(casks)
         super()
 
-        if cask_name.nil?
+        @cleaned = []
+
+        if casks.empty?
           progressbar.total = caskroom.casks.length
           progressbar.log "\nLooking for casks to cleanup..."
 
-          return clean_all # Clean all casks
+          @cleaned = compile
+        else
+          @cleaned = casks.map { |c| caskroom.get(c) }
+          return say 'Invalid cask specified', :red if @cleaned.compact.empty?
         end
-
-        cask = caskroom.get(cask_name)
-        return say 'Invalid cask specified', :red if cask.nil?
-
-        clean_one(cask)
-      end
-
-      def clean_one(cask)
-        return say "#{cask.name.capitalize} does not have any outdated " \
-          'versions. No cleanup operations are necessary', :green unless cask.can_cleanup?
-
-        cask.cleanup(&clean_block)
+        clean
       end
 
-      def clean_all
-        cleaned_casks = []
-
+      def compile
+        cleaned = []
         caskroom.enumerate do |cask|
-          progressbar.title = "  #{cask.name.capitalize} "
-          progressbar.increment
+          increment(cask)
 
-          cleaned_casks << cask if cask.can_cleanup?
+          cleaned << cask if cask.can_cleanup?
         end
+        cleaned
+      end
 
-        return say "\nNo cleanup operations are necessary", :green if cleaned_casks.empty?
+      def clean
+        return say "\nNo cleanup operations are necessary", :green if @cleaned.empty?
 
-        cleaned_casks.each { |c| c.cleanup(&clean_block) }
+        @cleaned.each do |cask|
+          cask.cleanup(&clean_block)
+        end
       end
 
       def clean_block
-        proc do |c, versions|
-          say "Cleaning up #{c.name}", :yellow
-          dep_q = "#{c.name} has been deprecated. Ok to remove all versions?"
-          if c.deprecated? && no?(dep_q, :red)
+        proc do |cask, versions|
+          name = cask.name
+          say "Cleaning up #{name}", :yellow
+          if cask.deprecated? &&
+             no?("#{name} has been deprecated. Ok to remove all versions?", :red)
+
             say 'No action taken.', :red
             next
           end

data/lib/bct/tasks/outdated.rb

@@ -2,25 +2,23 @@ require_relative './caskroom'
 
 module BrewCaskTools
   module Tasks
-    # Outdated cask tasks
+    # Outdated cask task
     class Outdated < Caskroom
       def initialize
         super
         progressbar.total = caskroom.casks.length
         progressbar.log "\nLooking for outdated casks..."
-        outdated, deprecated = compile
+        @outdated, @deprecated = compile
 
-        outdated(outdated)
-        deprecated(deprecated)
+        outdated
+        deprecated
       end
 
       def compile
         outdated = []
         deprecated = []
-
         caskroom.enumerate do |cask|
-          progressbar.title = "  #{cask.name.capitalize} "
-          progressbar.increment
+          increment(cask)
 
           outdated << cask if cask.outdated?
           deprecated << cask if cask.deprecated?
@@ -28,32 +26,26 @@ module BrewCaskTools
         [outdated, deprecated]
       end
 
-      def outdated(casks)
-        return say "\nThere are no outdated casks", :yellow if casks.empty?
-        handle(casks, 'outdated') do |outdated_casks|
-          outdated_casks.map! do |c|
-            [c.name, c.installed_version, c.current_version]
-          end
+      def outdated
+        return say "\nThere are no outdated casks", :yellow if @outdated.empty?
 
-          headers = ['Package', 'Installed Version', 'New Version']
-          output = outdated_casks.unshift(headers)
-          print_table(output)
+        @outdated.map! do |cask|
+          [cask.name, cask.current, cask.candidate]
         end
-      end
 
-      def deprecated(casks)
-        return if casks.empty?
-        handle(casks, 'deprecated') do |dep_casks|
-          dep_casks.map! { |c| [c.name] }
-          output = dep_casks.unshift(['Package'])
-          print_table(output)
+        handle(@outdated, 'outdated') do |outdated|
+          format(['Package', 'Installed Version', 'New Version'], outdated)
         end
       end
 
-      def handle(casks, adverb)
-        puts "#{adverb.capitalize} packages\n------------------"
-        yield casks
-        puts "\n"
+      def deprecated
+        return if @deprecated.empty?
+
+        @deprecated.map! { |cask| [cask.name] }
+
+        handle(@deprecated, 'deprecated') do |deprecated|
+          format(['Package'], deprecated)
+        end
       end
     end
   end

data/lib/bct/tasks/upgrade.rb

@@ -5,48 +5,50 @@ require_relative './cleanup'
 
 module BrewCaskTools
   module Tasks
-    # Upgrade tasks
+    # Upgrade task
     class Upgrade < Caskroom
-      def initialize(cask_name)
+      # @param optional casks [Array] array of cask names to upgrade
+      def initialize(casks)
         super()
 
-        if cask_name.nil?
+        @upgrade = []
+
+        if casks.empty?
           progressbar.total = caskroom.casks.length
           progressbar.log "\nLooking for outdated casks..."
 
-          return upgrade_all # Clean all casks
+          @upgrade = compile
+        else
+          @upgrade = casks.map { |c| caskroom.get(c) }
+          return say 'Invalid cask(s) specified', :red if @upgrade.compact.empty?
         end
 
-        cask = caskroom.get(cask_name)
-        return say 'Invalid cask specified', :red if cask.nil?
-
-        upgrade_one(cask)
+        upgrade
       end
 
-      def upgrade_all
-        to_upgrade = []
-
+      # Get list of casks to upgrade
+      # @return [Array] an array of casks to upgrade
+      def compile
+        upgrade = []
         caskroom.enumerate do |cask|
-          progressbar.title = "  #{cask.name.capitalize} "
-          progressbar.increment
+          increment(cask)
 
           next unless cask.outdated?
 
-          to_upgrade << cask
+          upgrade << cask
           progressbar.log "#{cask.info.name}: " \
-          "#{cask.installed_version} ==> #{cask.current_version}"
+          "#{cask.current} ==> #{cask.candidate}"
         end
-
-        return say 'There are no casks to be upgraded', :green if to_upgrade.empty?
-
-        to_upgrade.each(&:upgrade)
-
-        Tasks::Cleanup.new(nil)
+        upgrade
       end
 
-      def upgrade_one(cask)
-        cask.upgrade
-        Tasks::Cleanup.new(cask.name)
+      # Upgrade casks
+      def upgrade
+        return say 'There are no casks to be upgraded', :green if @upgrade.empty?
+        @upgrade.each(&:upgrade)
+
+        # Cleanup casks that we upgraded
+        Tasks::Cleanup.new(@upgrade.map(&:name))
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brew-cask-tools
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Dave Greene
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-03 00:00:00.000000000 Z
+date: 2016-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.44'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.44'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -95,19 +109,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: git-version-bump
+  name: versionomy
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '0.5'
 description: A tiny tool that provides some missing functionality in Homebrew Cask.
 email:
 - davepgreene@gmail.com
@@ -122,6 +136,8 @@ files:
 - lib/bct.rb
 - lib/bct/cask.rb
 - lib/bct/cask/info.rb
+- lib/bct/cask/version.rb
+- lib/bct/cask/versions.rb
 - lib/bct/caskroom.rb
 - lib/bct/metadata.rb
 - lib/bct/tasks.rb
@@ -129,7 +145,6 @@ files:
 - lib/bct/tasks/cleanup.rb
 - lib/bct/tasks/outdated.rb
 - lib/bct/tasks/upgrade.rb
-- lib/bct/util.rb
 homepage: https://github.com/davepgreene/brew-cask-tools
 licenses:
 - MIT
@@ -142,7 +157,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/bct/util.rb

@@ -1,30 +0,0 @@
-require 'pathname'
-
-module BrewCaskTools
-  ##
-  # Shared helper methods
-  ##
-  module Util
-    GEM_PATH = Pathname.new(__FILE__).join('../../..').expand_path
-
-    class << self
-      ##
-      # Transform helpers
-      ##
-      def to_array(arg)
-        arg.is_a?(Array) ? arg : [arg]
-      end
-
-      ##
-      # Relative path from working directory
-      ##
-      def relative_path(*relative)
-        Pathname.pwd.join(*relative.flatten.map(&:to_s)).expand_path
-      end
-
-      def source_path(*relative)
-        GEM_PATH.join(*relative.flatten.map(&:to_s)).expand_path
-      end
-    end
-  end
-end