brew 0.1.0 → 0.2.2

data/lib/brew/commands/install.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+require 'brew/utils/string_utils'
+require 'brew/utils/system_runner'
+
+module Brew
+  module Commands
+    class Install
+      attr_reader :brew_path, :formulae, :options, :system_runner
+
+      def initialize(brew_path, *formulae, **kwargs)
+        @brew_path = brew_path
+        @formulae = formulae.join(' ')
+        @options = parse_args(kwargs)
+        @system_runner = SystemRunner.new
+      end
+
+      def execute!
+        install_command = "#{brew_path} install #{options} #{formulae}".squish
+        system_runner.print_output(install_command)
+      rescue StandardError => e
+        raise Brew::ExecutionError, e
+      end
+
+      private
+
+      BOOLEAN_OPTIONS = %i[
+        ignore_dependencies build_from_source force_bottle
+        include_test devel HEAD fetch_HEAD keep_tmp
+        build_bottle force verbose display_times git
+      ].freeze
+
+      ARGUMENT_OPTIONS = %i[
+        env only_dependencies cc bottle_arch
+      ].freeze
+
+      def parse_args(args)
+        option_list = []
+
+        BOOLEAN_OPTIONS.each do |option|
+          str_option = option.to_s
+          kebab_option = str_option.snake_to_kebab
+          option_list << "--#{kebab_option}" if args[option] || args[str_option] || args[kebab_option]
+        end
+
+        ARGUMENT_OPTIONS.each do |option|
+          str_option = option.to_s
+          kebab_option = str_option.snake_to_kebab
+          if (value = args[option] || args[str_option] || args[kebab_option])
+            option_list << "--#{kebab_option} #{value}"
+          end
+        end
+
+        option_list.join(' ')
+      end
+    end
+  end
+end
+
+# Usage: brew install [options] formula
+
+# Install formula. Additional options specific to formula may be appended to
+# the command.
+
+# Unless HOMEBREW_NO_INSTALL_CLEANUP is set, brew cleanup will then be run for
+# the installed formulae or, every 30 days, for all formulae.
+
+#     -d, --debug                      If brewing fails, open an interactive
+#                                      debugging session with access to IRB or a
+#                                      shell inside the temporary build directory.
+#         --env                        If std is passed, use the standard build
+#                                      environment instead of superenv. If super
+#                                      is passed, use superenv even if the formula
+#                                      specifies the standard build environment.
+#         --ignore-dependencies        An unsupported Homebrew development flag to
+#                                      skip installing any dependencies of any
+#                                      kind. If the dependencies are not already
+#                                      present, the formula will have issues. If
+#                                      you're not developing Homebrew, consider
+#                                      adjusting your PATH rather than using this
+#                                      flag.
+#         --only-dependencies          Install the dependencies with specified
+#                                      options but do not install the formula
+#                                      itself.
+#         --cc                         Attempt to compile using the specified
+#                                      compiler, which should be the name of the
+#                                      compiler's executable, e.g. gcc-7 for GCC
+#                                      7. In order to use LLVM's clang, specify
+#                                      llvm_clang. To use the Apple-provided
+#                                      clang, specify clang. This option will
+#                                      only accept compilers that are provided by
+#                                      Homebrew or bundled with macOS. Please do
+#                                      not file issues if you encounter errors
+#                                      while using this option.
+#     -s, --build-from-source          Compile formula from source even if a
+#                                      bottle is provided. Dependencies will still
+#                                      be installed from bottles if they are
+#                                      available.
+#         --force-bottle               Install from a bottle if it exists for the
+#                                      current or newest version of macOS, even if
+#                                      it would not normally be used for
+#                                      installation.
+#         --include-test               Install testing dependencies required to
+#                                      run brew test formula.
+#         --devel                      If formula defines it, install the
+#                                      development version.
+#         --HEAD                       If formula defines it, install the HEAD
+#                                      version, aka. master, trunk, unstable.
+#         --fetch-HEAD                 Fetch the upstream repository to detect if
+#                                      the HEAD installation of the formula is
+#                                      outdated. Otherwise, the repository's HEAD
+#                                      will only be checked for updates when a new
+#                                      stable or development version has been
+#                                      released.
+#         --keep-tmp                   Retain the temporary files created during
+#                                      installation.
+#         --build-bottle               Prepare the formula for eventual bottling
+#                                      during installation, skipping any
+#                                      post-install steps.
+#         --bottle-arch                Optimise bottles for the specified
+#                                      architecture rather than the oldest
+#                                      architecture supported by the version of
+#                                      macOS the bottles are built on.
+#     -f, --force                      Install without checking for previously
+#                                      installed keg-only or non-migrated
+#                                      versions.
+#     -v, --verbose                    Print the verification and postinstall
+#                                      steps.
+#         --display-times              Print install times for each formula at the
+#                                      end of the run.
+#     -i, --interactive                Download and patch formula, then open a
+#                                      shell. This allows the user to run
+#                                      ./configure --help and otherwise
+#                                      determine how to turn the software package
+#                                      into a Homebrew package.
+#     -g, --git                        Create a Git repository, useful for
+#                                      creating patches to the software.
+#     -h, --help                       Show this message.

data/lib/brew/commands/list.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'brew/utils/string_utils'
+require 'brew/utils/system_runner'
+
+module Brew
+  module Commands
+    class List
+      attr_reader :brew_path, :formulae, :options, :system_runner
+
+      def initialize(brew_path, *formulae, **kwargs)
+        @brew_path = brew_path
+        @formulae = formulae.join(' ')
+        @options = parse_args(kwargs)
+        @system_runner = SystemRunner.new
+      end
+
+      def execute!
+        list_command = "#{brew_path} list #{options} #{formulae}".squish
+        system_runner.print_output(list_command)
+      rescue StandardError => e
+        raise ExecutionError, e
+      end
+
+      private
+
+      BOOLEAN_OPTIONS = %i[
+        full_name unbrewed versions multiple
+        pinned cask 1 l r t verbose debug
+      ].freeze
+
+      def parse_args(args)
+        option_list = []
+
+        BOOLEAN_OPTIONS.each do |option|
+          str_option = option.to_s
+          kebab_option = str_option.snake_to_kebab
+          option_list << "--#{kebab_option}" if args[option] || args[str_option] || args[kebab_option]
+        end
+
+        option_list.join(' ')
+      end
+    end
+  end
+end
+
+# Usage: brew list, ls [options] [formula]
+
+# List all installed formulae.
+
+# If formula is provided, summarise the paths within its current keg.
+
+#         --full-name                  Print formulae with fully-qualified names.
+#                                      If --full-name is not passed, other
+#                                      options (i.e. -1, -l, -r and -t)
+#                                      are passed to ls(1) which produces the
+#                                      actual output.
+#         --unbrewed                   List files in Homebrew's prefix not
+#                                      installed by Homebrew.
+#         --versions                   Show the version number for installed
+#                                      formulae, or only the specified formulae if
+#                                      formula are provided.
+#         --multiple                   Only show formulae with multiple versions
+#                                      installed.
+#         --pinned                     Show the versions of pinned formulae, or
+#                                      only the specified (pinned) formulae if
+#                                      formula are provided. See also pin,
+#                                      unpin.
+#         --cask                       List casks
+#     -1                               Force output to be one entry per line. This
+#                                      is the default when output is not to a
+#                                      terminal.
+#     -l                               List in long format. If the output is to a
+#                                      terminal, a total sum for all the file
+#                                      sizes is printed before the long listing.
+#     -r                               Reverse the order of the sort to list the
+#                                      oldest entries first.
+#     -t                               Sort by time modified, listing most
+#                                      recently modified first.
+#     -v, --verbose                    Make some output more verbose.
+#     -d, --debug                      Display any debugging information.
+#     -h, --help                       Show this message.

data/lib/brew/commands/search.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'brew/utils/string_utils'
+require 'brew/utils/system_runner'
+
+module Brew
+  module Commands
+    class Search
+      attr_reader :brew_path, :search_text, :options, :system_runner
+
+      def initialize(brew_path, search_text = nil, **kwargs)
+        @brew_path = brew_path
+        @search_text = search_text
+        @options = parse_args(kwargs)
+        @system_runner = SystemRunner.new
+      end
+
+      def execute!
+        search_command = "#{brew_path} search #{options} #{search_text}".squish
+        search_output = system_runner.get_output_lines(search_command)
+
+        organize_search_output(search_output)
+      rescue StandardError => e
+        raise Brew::ExecutionError, e
+      end
+
+      private
+
+      BOOLEAN_OPTIONS = %i[
+        formulae casks desc macports fink opensuse
+        fedora debian ubuntu verbose debug
+      ].freeze
+
+      def parse_args(args)
+        option_list = []
+
+        BOOLEAN_OPTIONS.each do |option|
+          str_option = option.to_s
+          kebab_option = str_option.snake_to_kebab
+          option_list << "--#{kebab_option}" if args[option] || args[str_option] || args[kebab_option]
+        end
+
+        option_list.join(' ')
+      end
+
+      def organize_search_output(output)
+        organized = {}
+        key = options.include?('casks') ? 'Casks' : 'Formulae'
+
+        output.each do |val|
+          val.strip!
+          if val.start_with?('==>')
+            key = val.split.last.squish
+            organized[key] ||= []
+          else
+            organized[key] ||= []
+            organized[key] << val.squish
+          end
+        end
+
+        organized
+      end
+    end
+  end
+end
+
+# Usage: brew search [options] [text|/text/]
+
+# Perform a substring search of cask tokens and formula names for text. If
+# text is flanked by slashes, it is interpreted as a regular expression. The
+# search for text is extended online to homebrew/core and homebrew/cask.
+
+# If no text is provided, list all locally available formulae (including tapped
+# ones). No online search is performed.
+
+#         --formulae                   Without text, list all locally available
+#                                      formulae (no online search is performed).
+#                                      With text, search online and locally for
+#                                      formulae.
+#         --casks                      Without text, list all locally available
+#                                      casks (including tapped ones, no online
+#                                      search is performed). With text, search
+#                                      online and locally for casks.
+#         --desc                       Search for formulae with a description
+#                                      matching text and casks with a name
+#                                      matching text.
+#         --macports                   Search for text in the given package
+#                                      manager's list.
+#         --fink                       Search for text in the given package
+#                                      manager's list.
+#         --opensuse                   Search for text in the given package
+#                                      manager's list.
+#         --fedora                     Search for text in the given package
+#                                      manager's list.
+#         --debian                     Search for text in the given package
+#                                      manager's list.
+#         --ubuntu                     Search for text in the given package
+#                                      manager's list.
+#     -v, --verbose                    Make some output more verbose.
+#     -d, --debug                      Display any debugging information.
+#     -h, --help                       Show this message.

data/lib/brew/commands/uninstall.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'brew/utils/string_utils'
+require 'brew/utils/system_runner'
+
+module Brew
+  module Commands
+    class Uninstall
+      attr_reader :brew_path, :formulae, :options, :system_runner
+
+      def initialize(brew_path, *formulae, **kwargs)
+        @brew_path = brew_path
+        @formulae = formulae.join(' ')
+        @options = parse_args(kwargs)
+        @system_runner = SystemRunner.new
+      end
+
+      def execute!
+        uninstall_command = "#{brew_path} uninstall #{options} #{formulae}".squish
+        system_runner.print_output(uninstall_command)
+      rescue StandardError => e
+        raise Brew::ExecutionError, e
+      end
+
+      private
+
+      BOOLEAN_OPTIONS = %i[force ignore_dependencies debug].freeze
+
+      def parse_args(args)
+        option_list = []
+
+        BOOLEAN_OPTIONS.each do |option|
+          str_option = option.to_s
+          kebab_option = str_option.snake_to_kebab
+          option_list << "--#{kebab_option}" if args[option] || args[str_option] || args[kebab_option]
+        end
+
+        option_list.join(' ')
+      end
+    end
+  end
+end
+
+# Usage: brew uninstall, rm, remove [options] formula
+
+# Uninstall formula.
+
+#     -f, --force                      Delete all installed versions of formula.
+#         --ignore-dependencies        Don't fail uninstall, even if formula is
+#                                      a dependency of any installed formulae.
+#     -d, --debug                      Display any debugging information.
+#     -h, --help                       Show this message.

data/lib/brew/commands/update.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'brew/utils/string_utils'
+require 'brew/utils/system_runner'
+
+module Brew
+  module Commands
+    class Update
+      attr_reader :brew_path, :options, :system_runner
+
+      def initialize(brew_path, **kwargs)
+        @brew_path = brew_path
+        @options = parse_args(kwargs)
+        @system_runner = SystemRunner.new
+      end
+
+      def execute!
+        update_command = "#{brew_path} update #{options}".squish
+        system_runner.print_output(update_command)
+      rescue StandardError => e
+        raise Brew::ExecutionError, e
+      end
+
+      private
+
+      BOOLEAN_OPTIONS = %i[merge force verbose debug].freeze
+
+      def parse_args(args)
+        option_list = []
+
+        BOOLEAN_OPTIONS.each do |option|
+          str_option = option.to_s
+          kebab_option = str_option.snake_to_kebab
+          option_list << "--#{kebab_option}" if args[option] || args[str_option] || args[kebab_option]
+        end
+
+        option_list.join(' ')
+      end
+    end
+  end
+end
+
+# Usage: brew update, up [options]
+
+# Fetch the newest version of Homebrew and all formulae from GitHub using git(1)
+# and perform any necessary migrations.
+
+#         --merge                      Use git merge to apply updates (rather
+#                                      than git rebase).
+#     -f, --force                      Always do a slower, full update check (even
+#                                      if unnecessary).
+#     -v, --verbose                    Print the directories checked and git
+#                                      operations performed.
+#     -d, --debug                      Display a trace of all shell commands as
+#                                      they are executed.
+#     -h, --help                       Show this message.

data/lib/brew/commands/upgrade.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'brew/utils/string_utils'
+require 'brew/utils/system_runner'
+
+module Brew
+  module Commands
+    class Upgrade
+      attr_reader :brew_path, :formulae, :options, :system_runner
+
+      def initialize(brew_path, *formulae, **kwargs)
+        @brew_path = brew_path
+        @formulae = formulae.join(' ')
+        @options = parse_args(kwargs)
+        @system_runner = SystemRunner.new
+      end
+
+      def execute!
+        upgrade_command = "#{brew_path} upgrade #{options} #{formulae}".squish
+        system_runner.print_output(upgrade_command)
+      rescue StandardError => e
+        raise Brew::ExecutionError, e
+      end
+
+      private
+
+      BOOLEAN_OPTIONS = %i[
+        build_from_source force_bottle fetch_HEAD
+        ignore_pinned keep_tmp force verbose
+        display_times dry_run greedy
+      ].freeze
+
+      def parse_args(args)
+        option_list = []
+
+        BOOLEAN_OPTIONS.each do |option|
+          str_option = option.to_s
+          kebab_option = str_option.snake_to_kebab
+          option_list << "--#{kebab_option}" if args[option] || args[str_option] || args[kebab_option]
+        end
+
+        option_list.join(' ')
+      end
+    end
+  end
+end
+
+# Usage: brew upgrade [options] [formula]
+
+# Upgrade outdated, unpinned formulae using the same options they were originally
+# installed with, plus any appended brew formula options. If formula are
+# specified, upgrade only the given formula kegs (unless they are pinned; see
+# pin, unpin).
+
+# Unless HOMEBREW_NO_INSTALL_CLEANUP is set, brew cleanup will then be run for
+# the upgraded formulae or, every 30 days, for all formulae.
+
+#     -d, --debug                      If brewing fails, open an interactive
+#                                      debugging session with access to IRB or a
+#                                      shell inside the temporary build directory.
+#     -s, --build-from-source          Compile formula from source even if a
+#                                      bottle is available.
+#     -i, --interactive                Download and patch formula, then open a
+#                                      shell. This allows the user to run
+#                                      ./configure --help and otherwise
+#                                      determine how to turn the software package
+#                                      into a Homebrew package.
+#         --force-bottle               Install from a bottle if it exists for the
+#                                      current or newest version of macOS, even if
+#                                      it would not normally be used for
+#                                      installation.
+#         --fetch-HEAD                 Fetch the upstream repository to detect if
+#                                      the HEAD installation of the formula is
+#                                      outdated. Otherwise, the repository's HEAD
+#                                      will only be checked for updates when a new
+#                                      stable or development version has been
+#                                      released.
+#         --ignore-pinned              Set a successful exit status even if pinned
+#                                      formulae are not upgraded.
+#         --keep-tmp                   Retain the temporary files created during
+#                                      installation.
+#     -f, --force                      Install without checking for previously
+#                                      installed keg-only or non-migrated
+#                                      versions.
+#     -v, --verbose                    Print the verification and postinstall
+#                                      steps.
+#         --display-times              Print install times for each formula at the
+#                                      end of the run.
+#     -n, --dry-run                    Show what would be upgraded, but do not
+#                                      actually upgrade anything.
+#         --greedy                     Upgrade casks with auto_updates or
+#                                      version :latest
+#     -h, --help                       Show this message.

data/lib/brew/home_brew.rb

@@ -1,58 +1,55 @@
-module Brew
-  class HomeBrewError < StandardError; end
-  class HomeBrewNotInstalled < HomeBrewError; end
+# frozen_string_literal: true
+
+require 'brew/commands/info'
+require 'brew/commands/install'
+require 'brew/commands/list'
+require 'brew/commands/search'
+require 'brew/commands/uninstall'
+require 'brew/commands/update'
+require 'brew/commands/upgrade'
 
+module Brew
   class HomeBrew
-    
-    DEFAULT_BREW_PATH = '/usr/local/bin/brew'.freeze
+    DEFAULT_BREW_PATH = '/usr/local/bin/brew'
 
     attr_reader :brew_path
     private :brew_path
 
-    def initialize(brew_path: DEFAULT_BREW_PATH)
-      @brew_path = brew_path
-      raise HomeBrewNotInstalled unless File.executable?(brew_path)
+    def initialize(brew_path: nil)
+      @brew_path = brew_path || DEFAULT_BREW_PATH
+      raise HomeBrewNotInstalled unless File.executable?(@brew_path)
+    end
+
+    def info(formula = [], **kwargs)
+      Commands::Info.new(brew_path, formula, **kwargs).execute!
+    end
+
+    def install(formula, **kwargs)
+      Commands::Install.new(brew_path, formula, **kwargs).execute!
     end
 
-    def install(formula)
-      install_command = "#{brew_path} install '#{formula}'"
-      run_command(install_command)
-    rescue => e
-      raise HomeBrewError, e
+    def list(formulae = [], **kwargs)
+      Commands::List.new(brew_path, formulae, **kwargs).execute!
     end
+    alias ls list
 
-    def update
-      update_command = "#{brew_path} update"
-      run_command(update_command)
-    rescue => e
-      raise HomeBrewError, e
+    def search(text = nil, **kwargs)
+      Commands::Search.new(brew_path, text, **kwargs).execute!
     end
 
-    def upgrade(formula)
-      update_command = "#{brew_path} upgrade '#{formula}'"
-      run_command(update_command)
-    rescue => e
-      raise HomeBrewError, e
+    def uninstall(formula, **kwargs)
+      Commands::Uninstall.new(brew_path, formula, **kwargs).execute!
     end
+    alias rm uninstall
+    alias remove uninstall
 
-    def uninstall(formula)
-      update_command = "#{brew_path} uninstall '#{formula}'"
-      run_command(update_command)
-    rescue => e
-      raise HomeBrewError, e
+    def update(**kwargs)
+      Commands::Update.new(brew_path, **kwargs).execute!
     end
+    alias up update
 
-    private
-    
-    def run_command(command)
-      IO.popen(command, 'r+') do |io|
-        while line = io.gets
-          $stdout.puts line
-        end
-        io.close
-      end
-      
-      raise HomeBrewError unless $?.success?
+    def upgrade(formula = [], **kwargs)
+      Commands::Upgrade.new(brew_path, formula, **kwargs).execute!
     end
   end
-end
+end

data/lib/brew/utils/string_utils.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: false
+
+class String
+  def snake_to_kebab
+    gsub('_', '-')
+  end
+
+  def squish
+    strip.gsub(/\s+/, ' ')
+  end
+end

data/lib/brew/utils/system_runner.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'English'
+
+module Brew
+  class SystemRunner
+    def print_output(command)
+      lines = run_with_output(command) do |line|
+        $stdout.puts line
+      end
+      lines.join
+    end
+
+    def get_output_lines(command)
+      run_with_output(command)
+    end
+
+    private
+
+    def run_with_output(command)
+      lines = []
+      IO.popen(command, 'r+') do |io|
+        while (line = io.gets)
+          yield line if block_given?
+          lines << line
+        end
+        io.close
+      end
+
+      raise "Exited with code #{$CHILD_STATUS.exitstatus}" unless $CHILD_STATUS.success?
+
+      lines
+    end
+  end
+end

data/lib/brew/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Brew
-  VERSION = "0.1.0"
+  VERSION = '0.2.2'
 end