yap-shell 0.4.6 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4cc89c28c4f112f3ff1abef087ca640c1adaa5b4
-  data.tar.gz: bf3879fbceac69355832fa42e082510898d0b739
+  metadata.gz: a31682029b9cbd355da08f48de73df26f18ac7e3
+  data.tar.gz: 11cac119d25dc8a0b19037c128cd7c08992449d1
 SHA512:
-  metadata.gz: b473a1906ba0a6476ecd08dae4434f450e89f157b459ce45af5d69db6a0b311eaab8fba10cfd893c9fd4f41442f8e89836d31e71bdc440b8f657e9881251c262
-  data.tar.gz: 1eb6e01f677f55f4b3203e513b6b2f51334a2546876804f863cbf96c2ec9a27f17b41efc30b04754dbc4f8fed96ad615c3b74f0ce6813a53954b7e5918347bbc
+  metadata.gz: 73674732a59260cf427392a8cc6617bb0d78a602dc2c49f8c5a588d2e952805a0d0bb51fa086961a7d938d411f4c76f12874a44085a6748d5e4db06ae3c49ec8
+  data.tar.gz: fa6f4ee6f68e5c426a36ebe600be7a158cf3bfccc448694299af5cf4569a77753b13d735c87058489ad1740a27503c6381faee10369bce92f28829ba286b021e

data/addons/tab_completion/tab_completion.rb

@@ -24,10 +24,10 @@ class TabCompletion < Addon
     end
 
     def to_s
-      @text
+      @text.to_s
     end
-    alias :to_str :to_s
-    alias :inspect :to_s
+    alias_method :to_str, :to_s
+    alias_method :inspect, :to_s
   end
 
   COMPLETIONS = [ BasicCompletion ]

data/lib/yap/configuration.rb

@@ -19,7 +19,7 @@ module Yap
 
       @rcfiles = [
         "#{ENV['HOME']}/.yaprc",
-        yap_path.join("yaprc")
+        preferred_yaprc_path
       ]
     end
 
@@ -27,6 +27,14 @@ module Yap
       yap_path.join(part)
     end
 
+    def preferred_yaprc_path
+      yap_path.join("yaprc")
+    end
+
+    def yaprc_template_path
+      Pathname.new(File.dirname(__FILE__)).join('../../rcfiles/yaprc')
+    end
+
     def yap_path
       Pathname.new "#{ENV['HOME']}/.yap"
     end

data/lib/yap/shell/repl.rb

@@ -34,8 +34,11 @@ module Yap::Shell
         rescue Yap::Shell::Parser::Lexer::NonterminatedString,
           Yap::Shell::Parser::Lexer::LineContinuationFound => ex
           Treefell['shell'].puts "rescued #{ex}, asking user for more input"
-          line << read_another_line_of_input
-          retry
+          more_input = read_another_line_of_input
+          if more_input
+            line << more_input
+            retry
+          end
         rescue ::Yap::Shell::CommandUnknownError => ex
           Treefell['shell'].puts "rescued #{ex}, telling user"
           puts "  CommandError: #{ex.message}"

data/lib/yap/shell/version.rb

@@ -1,5 +1,5 @@
 module Yap
   module Shell
-    VERSION = "0.4.6"
+    VERSION = "0.4.8"
   end
 end

data/lib/yap/world.rb

@@ -32,7 +32,26 @@ module Yap
       dom = build_editor_dom
 
       # ensure yap directory exists
-      FileUtils.mkdir_p configuration.yap_path
+      if !File.exists?(configuration.yap_path)
+        puts
+        puts yellow("Yap directory not found: #{configuration.yap_path}")
+        puts
+        puts "Initializing yap for the first time:"
+        puts
+
+        print "    Creating #{configuration.yap_path} "
+        FileUtils.mkdir_p configuration.yap_path
+        puts green("done")
+
+        print "    Creating default #{configuration.preferred_yaprc_path} "
+        FileUtils.cp configuration.yaprc_template_path, configuration.yap_path
+        puts green("done")
+        puts
+        puts "To tweak yap take a look at #{configuration.preferred_yaprc_path}."
+        puts
+        puts "Reloading shell"
+        reload!
+      end
 
       @editor = RawLine::Editor.create(dom: dom)
 
@@ -84,6 +103,10 @@ module Yap
       @editor.unbind(key)
     end
 
+    def reload!
+      exec File.expand_path($0)
+    end
+
     def func(name, &blk)
       Yap::Shell::ShellCommand.define_shell_function(name, &blk)
     end

data/rcfiles/{.yaprc → yaprc}

@@ -1,16 +1,23 @@
 #!/usr/bin/ruby
 
+###############################################################################
+#                         ENVIRONMENT VARIABLES
+#------------------------------------------------------------------------------
+# When yap boots up it constructs a world for the running shell. The world
+# has it's own copy of environment variables. Below is an example of
+# modifying your PATH environment variables.
 world.env["PATH"] = [
   world.env["HOME"] + "/.rbenv/shims",
   "/usr/local/bin",
   world.env["PATH"]
 ].join(":")
 
-require 'chronic'
-require 'term/ansicolor'
-require 'terminfo'
 
-# Resize history to be infinite
+###############################################################################
+#                           SHELL HISTORY
+#------------------------------------------------------------------------------
+# Here's an example of resizing shell history to be of infinite size. If you
+# set this to a numeric value then it will only maintain that many entries.
 infinity = 1 / 0.0
 world.history.resize(infinity)
 
@@ -19,63 +26,71 @@ func :reload! do |args:, stdin:, stdout:, stderr:|
   stdout.print "  Saving history "
   world.addons[:history].save
   stdout.puts Term::ANSIColor.green("done")
-  exec File.expand_path($0)
+  world.reload!
 end
 
 
-completion_cache = {}
-
-# tab_completion_display do |matches|
+###############################################################################
+#                         CONFIGURING YOUR PROMPT
+#------------------------------------------------------------------------------
+# Your prompt can be whatever you can code it to be. It can be static or
+# or dynamic. You can also update the prompt indirectly so that it live
+# updates regardless of if you hit enter.
 #
-# end
-
-tab_completion :rake, /^(rake|be rake)\s+(.*)/ do |input_fragment, match_data|
-  # |config|
-  # config.completions do |input_fragment, match_data|
-  results = completion_cache[Dir.pwd] ||= `bundle exec rake -T`.gsub(/^rake\s*/, '').split(/\n/)
-
-  task_rgx = /^#{Regexp.escape(input_fragment.word[:text])}/
-  results.grep(task_rgx).map do |text|
-    {
-      type: :rake,
-      text: text.gsub(/\s*#.*$/, ''),
-      descriptive_text: Term::ANSIColor.yellow(text)
-    }
-    # end
-  end
-end
-
+# The easiest thing to do is to set the prompt to a static string, but it's
+# also the least useful way to utilize your prompt, e.g.:
 #
-# Configuring your prompt. This can be set to a static value or to a
-# Proc like object that responds to #call. If it responds to call it will
-# be used every time the prompt is to be re-drawn
+#   yap> world.prompt = 'my-prompt>'
 #
-last_prompt = nil
-self.prompt = -> do
+# A more useful way to configure your prompt is by using a lambda/proc (or
+# anything that responds to 'call'). This proc will be called whenever
+# the prompt needs to be rendered, so it can be as dynamic as you like. Below
+# is an example of setting a prompt with a bunch of git smarts.
+#
+# One other thing worth noting is that you can re-render the prompt without
+# having to hit enter to run a statement. If this piques your interest check
+# out the prompt_updates/ addon included in the yap-shell gem. It's in the
+# YAP_SHELL_INSTALL_DIR/addons/promp_updates/ directory.
+#
+# Now, here's an example of a smart prompt with some git intelligence:
+
+world.prompt = -> do
+  # use ~ instead of full-path to home directory
   pwd = Dir.pwd.sub Regexp.new(ENV['HOME']), '~'
 
+  # identify our current branch
   git_current_branch = `git branch 2>/dev/null | sed -n '/\* /s///p'`.chomp
-  if git_current_branch.length > 0
+
+  # is the current directory a part of a git enabled directory structure?
+  current_dir_is_git_aware = git_current_branch.length > 0
+
+  if current_dir_is_git_aware
     git_current_branch += " "
+
+    # are there unstaged changes?
     git_dirty_not_cached = `git diff --shortstat 2>/dev/null`.length > 0
+
+    # are there staged changes?
     git_dirty_cached = `git diff --shortstat --cached 2>/dev/null`.length > 0
 
     if git_dirty_not_cached || git_dirty_cached
+      # uncommitted changes
       git_branch = intense_cyan(git_current_branch)
     else
+      # no uncommitted changes
       git_branch = cyan(git_current_branch)
     end
   else
     git_branch = ""
   end
 
-  arrow = '➜'
-
-  # ~/source/playground/yap master ➜
-  last_prompt = "#{dark(green('£'))} #{yellow(pwd)} #{git_branch}#{red(arrow)} "
+  # Example: ~/source/playground/yap master ➜
+  "#{yellow(pwd)} #{git_branch}#{red('➜')} "
 end
 
-#
+###############################################################################
+#                            SECONDARY PROMPT
+#------------------------------------------------------------------------------
 # The secondary_prompt is equivalent to the PS2 prompt in bash. It is what
 # is displayed when entering a multiline command. It can be set to a string
 # or a proc. It defaults to '> '
@@ -120,7 +135,7 @@ self.secondary_prompt = '> '
 # Sets the default trigger key for all keyboard macros
 world.addons[:keyboard_macros].trigger_key = ?\C-g
 
-# Sets the default cancel key for all keyboard macros
+# Sets the default cancel key (space) for all keyboard macros
 world.addons[:keyboard_macros].cancel_key = " "
 
 # Sets the default timeout for macros. When set to nil you will have to
@@ -144,12 +159,13 @@ end
 # by specifying it when you call .configure(...).
 world.addons[:keyboard_macros].configure(trigger_key: ?\C-g) do |macro|
   macro.start do
-    world.editor.content_box.children = [
-      TerminalLayout::Box.new(content: "am i floating1?", style: {display: :float, float: :right, height: 1, width: "am i floating1?".length}),
-      TerminalLayout::Box.new(content: "What up12?", style: {display: :block}),
-      TerminalLayout::Box.new(content: "Not much21", style: {display: :block}),
-      TerminalLayout::Box.new(content: "am i floating3?", style: {display: :float, float: :left, height: 1, width: "am i floating1?".length}),
-    ]
+    # TODO: FUTURE
+    # world.editor.content_box.children = [
+    #   TerminalLayout::Box.new(content: "am i floating1?", style: {display: :float, float: :right, height: 1, width: "am i floating1?".length}),
+    #   TerminalLayout::Box.new(content: "What up12?", style: {display: :block}),
+    #   TerminalLayout::Box.new(content: "Not much21", style: {display: :block}),
+    #   TerminalLayout::Box.new(content: "am i floating3?", style: {display: :float, float: :left, height: 1, width: "am i floating1?".length}),
+    # ]
   end
 
   macro.stop do
@@ -183,6 +199,8 @@ world.addons[:keyboard_macros].configure(trigger_key: ?\C-g) do |macro|
   end
 end
 
+# The below macro shows that you can have macros start with a different
+# trigger keys.
 # world.addons[:keyboard_macros].configure(trigger_key: :ctrl_h) do |macros|
 #   macros.define 'h123', -> {
 #     box = TerminalLayout::Box.new(content: "Right?", style: { display: :block, float: :right, height: 1, width: 50 })

data/yap-shell.gemspec

@@ -30,6 +30,10 @@ Gem::Specification.new do |spec|
     |
     |    alias yap='env -i PATH=$PATH RUBYOPT="-rubygems -EUTF-8" HOME=$HOME sh -c "rbenv local 2.2.3 && yap"'
     |
+    |If you are interested in tracing yap's execution you can add the DEBUG and TREEFELL_OUT options:
+    |
+    |    alias yap-debug='env -i DEBUG=* TREEFELL_OUT=/tmp/yap-debug.log PATH=$PATH RUBYOPT="-rubygems -EUTF-8" HOME=$HOME sh -c "rbenv local 2.2.3 && yap"'
+    |
     |Then, `source ~/.profile` or reload your shell. Now you can finally run:
     |
     |    yap
@@ -65,7 +69,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "term-ansicolor", "~> 1.3"
   spec.add_dependency "ruby-termios", "~> 0.9.6"
   spec.add_dependency "ruby-terminfo", "~> 0.1.1"
-  spec.add_dependency "yap-rawline", "~> 0.3.1"
+  spec.add_dependency "yap-rawline", "~> 0.3.2"
   spec.add_dependency "treefell", "~> 0.2.3"
 
   spec.add_development_dependency "bundler", "~> 1.6"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yap-shell
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.8
 platform: ruby
 authors:
 - Zach Dennis
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.2
 - !ruby/object:Gem::Dependency
   name: treefell
   requirement: !ruby/object:Gem::Requirement
@@ -209,7 +209,7 @@ files:
 - lib/yap/shell/version.rb
 - lib/yap/world.rb
 - lib/yap/world/addons.rb
-- rcfiles/.yaprc
+- rcfiles/yaprc
 - scripts/4
 - scripts/bg-vim
 - scripts/fail
@@ -232,6 +232,9 @@ post_install_message: "\nGreetings forward-thinking traveler!\n\nLet's waste no
   it into this very release.\n\n\e[033mLastly\e[0m, create an alias to the yap executable
   using the ruby version\nyou just installed it for. For example, with rbenv I use
   the below\nalias in my ~/.profile file:\n\n    alias yap='env -i PATH=$PATH RUBYOPT=\"-rubygems
+  -EUTF-8\" HOME=$HOME sh -c \"rbenv local 2.2.3 && yap\"'\n\nIf you are interested
+  in tracing yap's execution you can add the DEBUG and TREEFELL_OUT options:\n\n    alias
+  yap-debug='env -i DEBUG=* TREEFELL_OUT=/tmp/yap-debug.log PATH=$PATH RUBYOPT=\"-rubygems
   -EUTF-8\" HOME=$HOME sh -c \"rbenv local 2.2.3 && yap\"'\n\nThen, `source ~/.profile`
   or reload your shell. Now you can finally run:\n\n    yap\n\nYou know your tooling
   better than me. If you need things to go a little\ndifferently than above you go