icepick 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e343f6537242c146ed5d951e057ae678f733db8
-  data.tar.gz: 849eb3d592b8028f2490087604e7071c08530dd9
+  metadata.gz: ad1c12a8b27ae80252b65e9d40d4837475c46188
+  data.tar.gz: 9d881759f66b7e97e0242c34cf5c4e03ec56ba55
 SHA512:
-  metadata.gz: ca20aa14b444682be29e63d21de405ffe105250038fd90e1fade279f1fab24f65f45ef7677900d145edbf1f0fcae21baba30fc738c89bfcea3ba8d42b9387bc3
-  data.tar.gz: cc945c42d5513d87349d1cce5906e117967ba7351031041ed1714fd13271c260baeaf1621a24fc3cae6ac6804918addd0bf0d6a4aa4fe18ff9f60e7e1a0c2852
+  metadata.gz: 4720363a7892653fb14db609cf9d710b3333e28783d2d1ee86f374ab4d62caf486554c26bfc9dc51712cac3bf06fa9ad6d7f8667d92ae917adb77336947f3357
+  data.tar.gz: 18a2989fbd19a76611fa830c20d5d61bd4158febe8aa4c466e055c4b275447945e646423350f88b67942a16e7a5321c6d5e919cf3f6c6ae223520e448068d37b

data/CHANGELOG.md

@@ -1,6 +1,10 @@
+## 0.2.0 (2014-01-01)
+
+* Prompt layout now more configurable.  Added a new dependency on [colorize][colorize].
+
 ## 0.1.0 (2013-12-31)
 
-* First and last release of the year.  Bundle [pry]() with [pry-doc](), [pry-debugger](), [pry-stack_explorer](), and [pry-rails]().  [Awesome print](awesome_print) for colorized and formatted output.  Configured as Rails' console when applicable.
+* First and last release of the year.  Bundle [pry][pry] with [pry-doc][pry-doc], [pry-debugger][pry-debugger], [pry-stack_explorer][pry-stack_explorer], and [pry-rails][pry-rails].  [Awesome print][awesome_print] for colorized and formatted output.  Configured as Rails' console when applicable.
 
 [pry]:                 http://pry.github.com
 [pry-doc]:             https://github.com/pry/pry-doc
@@ -9,3 +13,4 @@
 [pry-byebug]:          https://github.com/deivid-rodriguez/pry-byebug
 [pry-rails]:           https://github.com/rweng/pry-rails
 [awesome_print]:       https://github.com/michaeldv/awesome_print
+[colorized]:           https://github.com/fazibear/colorize

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    icepick (0.1.0)
+    icepick (0.2.0)
       awesome_print (~> 1.2)
+      colorize (~> 0.6.0)
       pry (~> 0.9.12)
       pry-debugger (~> 0.2.2)
       pry-doc (~> 0.4.6)
@@ -31,6 +32,7 @@ GEM
       debug_inspector (>= 0.0.1)
     builder (3.1.4)
     coderay (1.1.0)
+    colorize (0.6.0)
     columnize (0.3.6)
     debug_inspector (0.0.2)
     debugger (1.6.5)

data/README.md

@@ -1,27 +1,72 @@
 Icepick
 =======
+© {[doomspork](https://github.com/doomspork)} 2014
 
-__Icepick__ bundles Pry with a set of plugins and useful configuration:
+Current version is `0.2.0` [Changelog][changelog].
 
-* [Pry](pry) is a better alternative to IRB
-* [Pry Doc](pry-doc) includes documentation and source for Code Ruby components
-* [Pry Debugger](pry-debugger) is a powerful debugger for Pry
-* [Pry Stack Explorer](pry-stack_explorer) includes support for call stack navigation
-* [Pry Rails](pry-rails) adds Rails helpers to Pry like `show-routes` and `show-models` 
-* [Awesome Print](awesome_print) colorizes and formats output
+__Icepick__ bundles a set of useful tools, plugins, and configurations together:
 
-##Usage
+* [Pry][pry] is a powerful alternative to IRB
+* [Pry Doc][pry-doc] includes documentation and source for Core Ruby components
+* [Pry Debugger][pry-debugger] brings the power of debugger to Pry 
+* [Pry Stack Explorer][pry-stack_explorer] adds support for call stack navigation
+* [Pry Rails][pry-rails] adds Rails helpers to Pry like `show-routes` and `show-models` 
+* [Awesome Print][awesome_print] colorizes and formats output
 
-Ruby 1.9.2+ only, support for Rails 3 and Rails 4.  Add the following to your project's Gemfile:
+Ruby 1.9.2+ only. Support included for Rails 3 and Rails 4. 
+
+## Usage
+
+Install the gem and run `icepick` or `rails console` as you normally would.
+
+## Options
+
+The following options can be changed with a Rails initializer.  Example `config/initializers/icepick.rb`:
 
 ```ruby
-group :development, :test do
-  gem 'icepick'
+if defined?(Icepick)
+    # Change the name to something moar awesomer
+    Icepick::Prompt.config.name = 'Iceaxe'
+    # Make the layout look more like plain Pry
+    Icepick::Prompt.config.main_layout = '[{line_num}] {name}({context}) {separator} '
 end
 ```
+------
+### `name`
+
+Configures the prompt name, defaults to `Icepick`
+
+### `separator`
+
+Change the prompt separator to something other than the default: `>`
+
+### `formatted`
+
+Color and format the prompt, defaults to `true`
+
+### `main_layout`
+
+Allows you to configure the layout for the main Pry prompt, defaults to `'{line_num}. {name}@{context} {separator} '`.  The following placeholders are available for use in the layout:
+
+* `name`      - The prompt name
+* `line_num`  - Current line number, the Pry input array size
+* `context`   - Path of the current context (eg. `cd Pry::CommandSet` #=> `/Pry/CommandSet`)
+* `separator` - Prompt separator
+
+### `wait_layout`
+
+Configuration for the Pry wait prompt, defaults to `'{spaces} {separator} '`.  In addition to the above placeholders, there are a few available exclusively to the wait prompt:
+
+* `spaces` - String of spaces equal to the length to the main prompt without the separator
+* `dots`   - Similar to the above but dots
+
+## Contributions
 
-Now you're ready!  Just run `pry` or `rails console` as you normally would.
+Feel free to open [Issues][issues] or submit [Pull Requests][pullrequest] for consideration.  
 
+[issues]:              https://github.com/doomspork/icepick/issues
+[pullrequest]:         https://github.com/doomspork/icepick/pulls
+[changelog]:           https://github.com/doomspork/icepick/blob/master/CHANGELOG.md
 [pry]:                 http://pry.github.com
 [pry-doc]:             https://github.com/pry/pry-doc
 [pry-stack_explorer]:  https://github.com/pry/pry-stack_explorer

data/icepick.gemspec

@@ -18,11 +18,12 @@ Gem::Specification.new do |gem|
 
   # Dependencies
   gem.required_ruby_version = '>= 1.9.2'
-  gem.add_runtime_dependency 'pry', '~> 0.9.12'
-  gem.add_runtime_dependency 'pry-doc', '~> 0.4.6'
-  gem.add_runtime_dependency 'pry-rails', '~> 0.3.2'
-  gem.add_runtime_dependency 'pry-stack_explorer', '~> 0.4.9'
-  gem.add_runtime_dependency 'pry-debugger', '~> 0.2.2'
-  gem.add_runtime_dependency 'awesome_print', '~> 1.2'
-  gem.add_runtime_dependency 'railties', '>= 3.0', '< 5.0'
+  gem.add_runtime_dependency 'pry',                 '~> 0.9.12'
+  gem.add_runtime_dependency 'pry-doc',             '~> 0.4.6'
+  gem.add_runtime_dependency 'pry-rails',           '~> 0.3.2'
+  gem.add_runtime_dependency 'pry-stack_explorer',  '~> 0.4.9'
+  gem.add_runtime_dependency 'pry-debugger',        '~> 0.2.2'
+  gem.add_runtime_dependency 'colorize',            '~> 0.6.0'
+  gem.add_runtime_dependency 'awesome_print',       '~> 1.2'
+  gem.add_runtime_dependency 'railties',            '>= 3.0', '< 5.0'
 end

data/lib/icepick.rb

@@ -1,4 +1,6 @@
 require 'icepick/version'
+require 'icepick/config'
+require 'icepick/prompt'
 
 require 'pry'
 require 'pry-doc'
@@ -28,10 +30,10 @@ module Icepick
   #   * name: A name to use for the prompt
   #
   # Returns nothing
-  def self.initialize!(options = {})
+  def self.initialize!(name = nil)
     silence_warnings do
       # Set the prompt name, for the Railtie this is the application name
-      Pry.config.prompt_name = options[:name] || 'icepick'
+      Prompt.config.name = name if name
 
       # Use awesome_print for Pry output
       Pry.config.print = ->(output, value) do
@@ -39,7 +41,11 @@ module Icepick
         Pry::Helpers::BaseHelpers.stagger_output("=> #{pretty}", output)
       end
 
-      if defined?(PryDebugger) || defined?(PryByebug)
+      # Use Icepick's Prompt for Pry
+      Pry.config.prompt = [Prompt.main_prompt, Prompt.wait_prompt]
+
+      # Debugger shortcuts
+      if defined?(PryDebugger)
         Pry.commands.alias_command 'c', 'continue'
         Pry.commands.alias_command 's', 'step'
         Pry.commands.alias_command 'n', 'next'
@@ -50,13 +56,15 @@ module Icepick
 
   private
 
+  # Internal: Suppress warnings and errors
+  #
+  # Returns nothing
   def self.silence_warnings
     old_verbose, $VERBOSE = $VERBOSE, nil
     yield
   ensure
     $VERBOSE = old_verbose
   end
-
 end
 
 if defined?(Rails)

data/lib/icepick/config.rb

@@ -0,0 +1,27 @@
+module Icepick
+  class Config
+    # Separator for the prompt
+    attr_accessor :separator 
+
+    # Whether or not to use colors and formatting
+    attr_accessor :formatted
+    alias :formatted? :formatted
+
+    # The mustache compatiable layouts for Pry prompts
+    attr_accessor :main_layout, :wait_layout
+
+    # The prompt name
+    attr_accessor :name
+
+    # Public: Create a new instance of the config with defaults
+    #
+    # Returns a new instance
+    def initialize
+      self.separator   = '>'
+      self.formatted   = true
+      self.main_layout = '{line_num}. {name}@{context} {separator} '
+      self.wait_layout = '{spaces} {separator} '
+      self.name        = 'Icepick'
+    end
+  end
+end

data/lib/icepick/prompt.rb

@@ -0,0 +1,124 @@
+require 'colorize'
+
+module Icepick
+  class Prompt
+
+    class << self
+      # Pry prompt's target object
+      attr_accessor :target
+
+      # The nesting level of the current Pry
+      attr_accessor :level
+
+      # An instance of the current Pry session
+      attr_accessor :pry
+
+      # Our configuration instance
+      attr_accessor :config
+    end
+
+    # Initialize the configuration object
+    self.config = Icepick::Config.new
+
+    # Public: Piece together the main prompt 
+    #
+    # Returns a Proc
+    def self.main_prompt
+      prompt_proc(config.main_layout)
+    end
+
+    # Public: Build out the wait prompt
+    #
+    # Returns a Proc
+    def self.wait_prompt
+      prompt_proc(config.wait_layout)
+    end
+
+    protected 
+
+    # Internal: Build a prompt proc for a given layout
+    #
+    # layout - The layout to use in the proc
+    #
+    # Returns a Proc
+    def self.prompt_proc(layout)
+      proc do |target, level, pry|
+        self.target, self.level, self.pry = target, level, pry 
+        interpolate_prompt(layout)
+      end
+    end
+
+    # Internal: A helper to handle the layout's config
+    #
+    # layout - the layout String
+    #
+    # Returns a String with interoplated values
+    def self.interpolate_prompt(layout)
+      code = layout.gsub(/{/, '#{self.')
+      eval(%Q{"#{code}"})
+    end
+
+    # Internal: A helper to retrieve the expected separator with or without formatting
+    #
+    # Returns the separator as a String
+    def self.separator
+      separator = config.separator
+      config.formatted ? separator.bold : separator
+    end
+
+    # Internal: Return the name with appropriate formatting 
+    #
+    # Returns a String
+    def self.name
+      config.formatted? ? config.name.underline : config.name
+    end
+
+    # Internal: Helper for line number
+    #
+    # Returns the line number as String
+    def self.line_num
+      line = self.pry.input_array.size.to_s
+      config.formatted? ? line.bold : line
+    end
+
+    # Internal: Get the name of Pry's current context or target
+    #
+    # Returns a String
+    def self.context
+      unless (context = Pry.view_clip(target)) == 'main'
+        str = "#{context.gsub(/::/, '/')}"
+        config.formatted? ? str.colorize(:blue) : str
+      else
+        ''
+      end
+    end
+
+    # Internal: Get a String of spaces matching the main prompt 
+    # in length
+    #
+    # Returns a String of spaces
+    def self.spaces
+      ' ' * prompt_size
+    end
+
+    # Internal: Produces a String of dots the lenght of the main prompt
+    #
+    # Returns a String of spaces
+    def self.dots
+      '.' * prompt_size
+    end
+
+    # Intennal: Determines the length of the formatless main prompt
+    #
+    # Returns an Integer
+    def self.prompt_size
+      old_setting      = config.formatted?
+      config.formatted = false
+      prompt           = main_prompt.call(self.target, self.level, self.pry)
+      config.formatted = old_setting
+      index            = prompt.index(config.separator) - 2
+      prompt[0..index].length
+    end
+
+  end
+end

data/lib/icepick/railtie.rb

@@ -1,7 +1,7 @@
 module Icepick
   class Railtie < Rails::Railtie
     initializer 'icepick.initialize' do |app|
-      Icepick.initialize!({name: app.class.parent_name.underscore})
+      Icepick.initialize!(app.class.parent_name.underscore)
 
       silence_warnings do
         # Use Pry instead of IRB

data/lib/icepick/version.rb

@@ -1,3 +1,3 @@
 module Icepick
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: icepick
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sean Callan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-01 00:00:00.000000000 Z
+date: 2014-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -80,6 +80,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -130,9 +144,10 @@ files:
 - README.md
 - Rakefile
 - bin/icepick
-- ext/mkrf_conf.rb
 - icepick.gemspec
 - lib/icepick.rb
+- lib/icepick/config.rb
+- lib/icepick/prompt.rb
 - lib/icepick/railtie.rb
 - lib/icepick/version.rb
 homepage: https://github.com/doomspork/icepick

data/ext/mkrf_conf.rb

@@ -1,17 +0,0 @@
-require 'rubygems/dependency_installer.rb'
-
-#Load up the rubygem's dependency installer to 
-#installer the gems we want based on the version
-#of Ruby the user has installed
-installer = Gem::DependencyInstaller.new
-begin
-  if RUBY_VERSION > '1.9'
-    installer.install 'pry-byebug', '~> 1.2.1'
-  else 
-    installer.install 'pry-debugger', '~> 0.2.2'
-  end
-
-  rescue
-    #Exit with a non-zero value to let rubygems something went wrong
-    exit(1)
-end