warp-dir 1.1.0

data/lib/warp/dir/app/response.rb

@@ -0,0 +1,133 @@
+require 'singleton'
+
+module Warp
+  module Dir
+    module App
+      class Response
+
+        # Use Case                       exit code       stream
+        #----------------------------------------------------------------
+        # Information / Help / List              0       STDOUT
+        # Error occured                          1       STDERR
+        # Execute Shell Command                  2       STDOUT
+
+        class Type < Struct.new(:exit_code, :stream)
+          def print(msg)
+            under_shell = ::Warp::Dir.eval_context?
+            if msg == ' '
+              under_shell ? stream.printf(%Q{printf '\\n'; }) : stream.printf("\n")
+            else
+              msg.split("\n").each do |line|
+                under_shell ? stream.printf(%Q{printf -- '#{line}\\n';}) : stream.printf("#{line}\n")
+              end
+            end
+          end
+
+          def to_s
+            "code:#{exit_code}, stream:#{stream == STDOUT ? "STDOUT" : "STDERR"}"
+          end
+        end
+
+        INFO  = Type.new(0, STDOUT)
+        ERROR = Type.new(1, STDERR)
+        SHELL = Type.new(2, STDOUT)
+
+        SHELL.instance_eval do
+          def print(msg)
+            under_shell = ::Warp::Dir.eval_context?
+            if under_shell then
+              stream.printf("#{msg};")
+            else
+              stream.printf(
+                'WARNING: '.red +
+                "This functionality is only available within shell eval{} context:\n\n\t#{msg.yellow.bold}\n\n" +
+                "Please install shell wrapper 'wd' via the 'install' command.\n")
+            end
+          end
+
+          # can't change exit code in SHELL
+          def exit_code=(value)
+          end
+        end
+
+        RETURN_TYPE = {
+          success: INFO,
+          error:   ERROR,
+          shell:   SHELL
+        }
+
+        attr_accessor :messages, :config
+
+        def initialize
+          @messages = []
+        end
+
+        # Public Methods
+        def print
+          raise ::ArgumentError.new('No type defined for Response object') unless @type
+          @type.print(@messages.shift) until @messages.empty?
+          self
+        end
+
+        def exit!
+          raise ::ArgumentError.new('No type defined for Response object') unless @type
+          system_exit!(@type.exit_code)
+        end
+
+        # Configure & Accessors
+        def configure(&block)
+          self.instance_eval(&block)
+          self
+        end
+
+        def self.configure(&block)
+          self.instance.configure(&block)
+        end
+
+        def message(message = nil)
+          if message
+            @messages << message
+            self
+          else
+            @messages.join('')
+          end
+        end
+
+        def type(a_type = nil)
+          if a_type
+            @type = a_type.kind_of?(Warp::Dir::App::Response::Type) ? a_type : RETURN_TYPE[a_type]
+            raise(::ArgumentError.new("Can't find response type #{a_type} #{@type}")) unless @type
+            self
+          else
+            @type
+          end
+        end
+
+        def code(value = nil)
+          if value
+            @type.exit_code = value
+            self
+          else
+            @type.exit_code
+          end
+        end
+
+        def inspect
+          "#{self.class.name}={#{type.inspect}, #{messages.inspect}}"
+        end
+
+        def to_s
+          "AppResponse[type: {#{type}}, messages: '#{messages.join(' ')}']"
+        end
+
+        private
+
+        def system_exit!(code)
+          Kernel.exit(code) unless self.class.instance_variable_defined?(:@exit_disabled) && self.class.exit_disabled?
+          self
+        end
+
+      end
+    end
+  end
+end

data/lib/warp/dir/command.rb

@@ -0,0 +1,120 @@
+require 'set'
+require 'warp/dir/errors'
+require 'warp/dir/formatter'
+require 'warp/dir/commander'
+require 'warp/dir/point'
+require 'forwardable'
+require_relative 'app/response'
+
+module Warp
+  module Dir
+    class Command
+      class << self
+        def command_name
+          self.name.gsub(/.*::/, '').downcase.to_sym
+        end
+
+        def help
+          sprintf('%16s %-20s %s%s',
+                  self.command_name.to_s.yellow,
+                  (self.send(:needs_a_point?) ? '<point>'.cyan : ' '.cyan),
+                  self.send(:description).blue.bold,
+                  (self.respond_to?(:aliases) && !aliases.empty? ? ", aka: " + aliases.join(', ').blue + '' : '')
+          )
+        end
+
+        def inherited(subclass)
+          ::Warp::Dir::Commander.instance.register(subclass)
+          subclass.class_eval do
+            extend Forwardable
+            def_delegators :@klazz, :command_name, :help, :description
+          end
+
+          subclass.instance_eval do
+            @description = nil
+            @aliases = []
+            @needs_a_point = false
+
+            class << self
+              def description(value = nil)
+                @description = value if value
+                @description
+              end
+
+              def aliases(*args)
+                if args
+                  @aliases << args unless !args || args.empty?
+                  @aliases.flatten!
+                end
+                @aliases
+              end
+
+              def needs_a_point?(value = nil)
+                @needs_a_point = value if value
+                @needs_a_point
+              end
+            end
+          end
+        end
+
+        def installed_commands
+          ::Warp::Dir::Commander.instance.commands
+        end
+      end
+
+      attr_accessor :store, :formatter, :point_name, :point_path, :point
+
+      def initialize(store, point_name = nil, point_path = nil)
+        @store     = store
+        @formatter = ::Warp::Dir::Formatter.new(@store)
+        @klazz     = self.class
+        if point_name
+          if point_name.is_a?(::Warp::Dir::Point)
+            self.point = point_name
+          else
+            self.point_name = point_name
+          end
+          self.point_path = point_path if point_path
+        end
+
+        if store.config.debug
+          require 'pp'
+          STDERR.printf 'Initialized Command: '.yellow.bold
+          pp self
+        end
+      end
+
+      def config
+        self.store.config
+      end
+
+      # def chain(another_command)
+      #   command = Warp::Dir.commander.find(another_command.name)
+      #   command.new(point_name, point_path).run
+      # end
+      def on(type, &block)
+        this_config = self.store.config
+        ::Warp::Dir.on(type, &block).configure do
+          self.config = this_config
+        end
+      end
+
+      def inspect
+        "#{self.class.name}[#{self.command_name}]->(#{self.description})"
+      end
+
+      def needs_point?
+        false # the default
+      end
+
+      def puts(stream, *args)
+        if store.shell
+          stream.printf("printf \"#{args.join(', ')}\n\"")
+        else
+          stream.printf("#{args.join(', ')}\n")
+        end
+      end
+    end
+  end
+end
+Warp::Dir.require_all_from '/dir/commands'

data/lib/warp/dir/command/add.rb

@@ -0,0 +1,16 @@
+require 'warp/dir/command'
+
+class Warp::Dir::Command::Add < Warp::Dir::Command
+  description %q(Adds the current directory as a new Warp Point)
+  needs_a_point? true
+  aliases :new, :save, :store
+
+  def run(*args)
+    self.point_path ||= Dir.pwd
+    store.insert point_name: point_name, point_path: point_path, overwrite: config.force
+
+    on :success do
+      message 'Warp point saved!'
+    end
+  end
+end

data/lib/warp/dir/command/help.rb

@@ -0,0 +1,80 @@
+require 'warp/dir/command'
+require 'warp/dir/command/install'
+class Warp::Dir::Command::Help < Warp::Dir::Command
+  description 'Show this extremely unhelpful text'
+  aliases :wtf
+
+
+  def run(opts, flags = [])
+    commander = ::Warp::Dir.commander
+    on :success do
+      message USAGE
+      message ' '
+      message 'Warp Point Commands:'.bold.green
+      message ' '
+      commander.commands.select{|cmd| cmd.needs_a_point?}.map(&:command_name).each do |installed_commands|
+        message sprintf("  %s\n", commander.find(installed_commands).help)
+      end
+      message ' '
+      message 'Global Commands:'.bold.green
+      message ' '
+      commander.commands.reject{|cmd| cmd.needs_a_point?}.map(&:command_name).each do |installed_commands|
+        message sprintf("  %s\n", commander.find(installed_commands).help)
+      end
+      message EXAMPLES
+      message INSTALLATION
+      message opts.to_s
+    end
+  end
+
+  USAGE = <<EOF
+#{"Usage:".bold.green}  wd [ --command ] [ list | help ] [ wd-flags ]
+        wd [ --command ] [ [ warp ] | add  [-f] | rm | ls ] [ wd flags ] <point> -- [ cmd-flags ]
+        wd --help | help
+EOF
+
+  EXAMPLES = <<EOF
+
+#{'Examples'.bold.green}
+       wd add proj    add current directory as a warp point
+       cd ~/
+       wd proj        jumps to proj
+       wd list        lists all points
+       wd rm proj     removes proj
+EOF
+
+  if ::Warp::Dir::Command::Install.wrapper_installed?
+    INSTALLATION = <<EOF
+
+#{'Installation'.bold.green}
+    It appears that you already have a wrapper installed in one of your
+    shell init files (#{::Warp::Dir::DOTFILES.join(', ')}
+
+    Which means that 'wd' should be working on your system.  If not, edit your
+    shell init file, remove any lines related to warp-dir gem, and then reinstall:
+
+    #{'wd install [ --dotfile <filename> ]'.bold.green}
+
+    If you experience any problem, please log an issue at:
+    https://github.com/kigster/warp-dir/issues
+EOF
+  else
+    INSTALLATION = <<EOF
+
+#{'Installation'.bold.green}
+    In order for you to start warping all around, you must install the shell wrapper which
+    calls into the ruby to do the job. Shell wrapper function is required in order to
+    change directory in the outer shell (parent process). Do not worry about this if you
+    do not understand it, but please run this command:
+
+    #{'wd install [ --dotfile <filename> ]'.bold.green}
+
+    This command will ensure you have the wrapper installed in your ~/.bashrc or ~/.zshrc
+    files. Once installed, just restart your shell!
+
+    If you experience any problem, please log an issue at:
+    https://github.com/kigster/warp-dir/issues
+EOF
+  end
+
+end

data/lib/warp/dir/command/install.rb

@@ -0,0 +1,78 @@
+require 'warp/dir/command'
+require 'warp/dir'
+class Warp::Dir::Command::Install < Warp::Dir::Command
+  description %q(Installs warp-dir shell wrapper in your ~/.bashrc)
+  needs_a_point? false
+
+  attr_accessor :installed, :existing, :wrapper, :shell_init_files
+
+  class << self
+    def wrapper_installed?
+      ::Warp::Dir::DOTFILES.any?{ |file| already_installed?(file) }
+    end
+
+    def already_installed?(file_path)
+      path = ::Warp::Dir.absolute(file_path)
+      matches = if File.exists?(path)
+                  File.open path do |file|
+                    file.find { |line| line =~ /warp-dir/ }
+                  end
+                end
+      matches
+    end
+  end
+
+  def initialize(*args)
+    self.installed        = []
+    self.existing         = []
+    self.wrapper          = File.read(::Warp::Dir::SHELL_WRAPPER)
+    self.shell_init_files = ::Warp::Dir::DOTFILES
+    super(*args)
+  end
+
+  def run(*args)
+    self.shell_init_files = config[:dotfile].split(',') if config[:dotfile]
+    self.shell_init_files.each { |dotfile| append_wrapper_to(dotfile) }
+    local_existing    = self.existing
+    local_installed   = self.installed
+    local_shell_files = self.shell_init_files
+    if installed.empty?
+      if existing.empty?
+        on :error do
+          if local_shell_files.size > 1 then
+            message "Shell init files #{local_shell_files.join(', ').yellow.bold} were not found on the filesystem.".red
+          else
+            message "Shell init file #{local_shell_files.join(', ').yellow.bold} was not found on the filesystem.".red
+          end
+        end
+      else
+        on :error do
+          message 'Looks like you already have shell support installed.'.red
+          message "#{local_existing.join(', ').yellow.bold} already warp-dir definition. Use --force to override."
+        end
+      end
+    else
+      on :success do
+        message 'Shell support is installed in the following files:'.green.bold
+        message "#{local_installed.join(', ')}".bold.yellow
+      end
+    end
+  end
+
+  private
+
+  def append_wrapper_to(shell_init_file)
+    file          = ::Warp::Dir.absolute(shell_init_file)
+    pre_installed = self.class.already_installed?(file)
+    self.existing << file if pre_installed
+    if File.exists?(file)
+      if !pre_installed || config[:force]
+        File.open(file, 'a') do |f|
+          f.write(wrapper)
+        end
+        self.installed << shell_init_file
+      end
+    end
+  end
+
+end

data/lib/warp/dir/command/list.rb

@@ -0,0 +1,13 @@
+require 'warp/dir/command'
+require 'warp/dir/formatter'
+
+class Warp::Dir::Command::List < Warp::Dir::Command
+  description %q(Print all stored warp points)
+
+  def run(*args)
+    formatted_list = ::Warp::Dir::Formatter.new(store).format_store
+    on :success do
+      message formatted_list.blue.bold
+    end
+  end
+end