coolline 0.4.0 → 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a631331d045151d7db8be33880ea8413a598baa6
+  data.tar.gz: 942e4f6bb3305e997484937c5e609a59527c8fae
+SHA512:
+  metadata.gz: cbe233557703c272040dda7fe812792e19f5202f80a1853737e0b2909df6c575125a9ba02a0258fe0ee71f550c9b2f3c23bfd13ac242e1e1dccfd3eb684ceb31
+  data.tar.gz: 32223264af4ad742569de556e23881229daf728845da0333240363a169644caac0de66a0f51b29a29cacca87569d2d5b9839b1d18329248e0ffadbbb98abd08e

data/README.md

@@ -0,0 +1,84 @@
+Coolline
+========
+
+Coolline is a readline-like library written in pure Ruby.
+
+It offers all of the core readline features, but with a cleaner, simpler
+implementation, and the ability to easily customize its behaviour.
+
+Customizations include: modifying all key bindings, binding keys custom functions,
+full control over history and tab completion, and control over what's displayed
+to the user (transforms).
+
+Usage
+=====
+
+If you don't need anything fancy, it can work like Ruby's built-in `Readline.readline`:
+
+```ruby
+result = Coolline.readline
+```
+
+But, of course you want something fancy, otherwise you'd be using `readline`!
+Here's how to create a simple REPL with live syntax highlighting and tab completion:
+
+```ruby
+require 'coolline'
+require 'coderay'
+require 'pp'
+
+cool = Coolline.new do |c|
+
+  # Before the line is displayed, it gets passed through this proc,
+  # which performs syntax highlighting.
+  c.transform_proc = proc do
+    CodeRay.scan(c.line, :ruby).term
+  end
+
+  # Add tab completion for constants (and classes)
+  c.completion_proc = proc do
+    word = c.completed_word
+    Object.constants.map(&:to_s).select { |w| w.start_with? word }
+  end
+
+  # Alt-R should reverse the line, because we like to look at our code in the mirror
+  c.bind "\er" do |cool|
+    cool.line.reverse!
+  end
+
+end
+
+loop do
+  # READ
+  line = cool.readline
+
+  # EVAL
+  obj = eval(line)
+
+  # PRINT
+  print "=> "
+  pp obj
+
+  # LOOP
+end
+```
+
+Configuration
+=============
+
+Coolline automatically loads a config file before starting, which allows adding
+new key bindings to it. The file is just a chunk of arbitrary ruby code located
+at ``$XDG_CONFIG_HOME/coolline/coolline.rb``.
+
+```ruby
+Coolline.bind "\C-z" do |cool|
+  puts "Testing key binding with #{cool}!"
+end
+```
+
+Installation
+============
+
+    gem install coolline
+
+Note: If your Ruby version is less than 1.9.3, you also need to install the `io-console` gem.

data/lib/coolline/coolline.rb

@@ -62,6 +62,9 @@ class Coolline
      Handler.new("\e[D", &:backward_char),
      Handler.new("\e[F", &:end_of_line),
      Handler.new("\e[H", &:beginning_of_line),
+     Handler.new("\eOH", &:beginning_of_line),
+     Handler.new("\eOF", &:end_of_line),
+     Handler.new("\ed", &:kill_forward_word),
      Handler.new("\et", &:transpose_words),
      Handler.new("\ec", &:capitalize_word),
      Handler.new("\eu", &:uppercase_word),
@@ -107,6 +110,10 @@ class Coolline
     Coolline::Settings[:handlers].unshift Coolline::Handler.new(key, &action)
   end
 
+  def bind(key, &action)
+    handlers.unshift Coolline::Handler.new(key, &action)
+  end
+
   # Creates a new cool line.
   #
   # @yieldparam [Coolline] self
@@ -178,38 +185,44 @@ class Coolline
   # @return [Menu]
   attr_accessor :menu
 
+  # Perform a quick, one-off readline (equivalent to `Coolline.new.readline(...)`)
+  def self.readline(*args)
+    new.readline(*args)
+  end
+
   # Reads a line from the terminal
   # @param [String] prompt Characters to print before each line
-  def readline(prompt = ">> ")
+  def readline(prompt = ">> ", default_line = "")
     @prompt = prompt
 
     @history.delete_empty
 
-    @line        = ""
-    @pos         = 0
-    @accumulator = nil
-
+    @accumulator   = nil
     @history_moved = false
+    @should_exit   = false
 
-    @should_exit = false
+    self.line = default_line
 
-    reset_line
-    print @prompt
+    render
 
     @history.index = @history.size - 1
     @history << @line
 
-    until (char = @input.getch) == "\r"
-      @menu.erase
+    @input.raw do |raw_stdin|
 
-      handle(char)
-      return if @should_exit
+      until (char = raw_stdin.read 1) == "\r"
+        @menu.erase
 
-      if @history_moved
-        @history_moved = false
+        handle(char)
+        return if @should_exit
+
+        if @history_moved
+          @history_moved = false
+        end
+
+        render
       end
 
-      render
     end
 
     @menu.erase
@@ -400,6 +413,13 @@ class Coolline
     char =~ word_boundaries_regexp
   end
 
+  def line=(new_line)
+    @line = new_line.dup
+    @pos  = new_line.size
+
+    render
+  end
+
   private
   def transform(line)
     @transform_proc.call(line)
@@ -427,7 +447,8 @@ class Coolline
   def handle_escape(char)
     if char == "[" && @accumulator =~ /\A\e?\e\z/ or
         char =~ /\d/ && @accumulator =~ /\A\e?\e\[\d*\z/ or
-        char == "\e" && @accumulator == "\e"
+        char == "\e" && @accumulator == "\e" or
+        char == "O" && @accumulator == "\e"
       @accumulator << char
       nil
     else

data/lib/coolline/editor.rb

@@ -110,6 +110,15 @@ class Coolline
       end
     end
 
+    # Removes the next word
+    def kill_forward_word
+      if pos != line.size
+        ending = word_end_after(pos)
+
+        line[pos..ending] = ""
+      end
+    end
+
     # Removes the previous character
     def kill_backward_char
       if pos > 0

data/lib/coolline/history.rb

@@ -57,7 +57,7 @@ class Coolline
     end
 
     def []=(id, val)
-      @lines[id] = val
+      @lines[id] = val.dup
     end
 
     def save_line
@@ -78,7 +78,7 @@ class Coolline
       @io.rewind
 
       if line_count < @max_size
-        @lines.concat @io.lines.map(&:chomp)
+        @lines.concat @io.map(&:chomp)
       else
         @io.each do |line| # surely inefficient
           @lines << line.chomp

data/lib/coolline/menu.rb

@@ -20,13 +20,18 @@ class Coolline
 
     # Sets the menu's string to a list of items, formatted in columns.
     #
+    # If some items are to wide to be showed, they will be excluded from the
+    # list.
+    #
     # @param [Array<String>] items
     def list=(items)
+      height, width = @input.winsize
+
+      items = items.reject { |s| ansi_length(s) > width }
+
       if items.empty?
         self.string = ""
       else
-        height, width = @input.winsize
-
         col_width  = items.map { |s| ansi_length(s) }.max
         col_count  = width / col_width
         item_count = col_count * (height - 1)

data/lib/coolline/version.rb

@@ -1,3 +1,3 @@
 class Coolline
-  Version = "0.4.0"
+  Version = "0.4.1"
 end

metadata

@@ -1,41 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: coolline
 version: !ruby/object:Gem::Version
-  version: 0.4.0
-  prerelease: 
+  version: 0.4.1
 platform: ruby
 authors:
 - Mon ouie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-01 00:00:00.000000000 Z
+date: 2013-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riot
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'A readline-like library that allows to change how the input
-
+description: |
+  A readline-like library that allows to change how the input
   is displayed.
-
-'
 email: mon.ouie@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - lib/coolline/editor.rb
 - lib/coolline/ansi.rb
@@ -52,29 +48,29 @@ files:
 - test/run_all.rb
 - repl.rb
 - .gemtest
+- README.md
 homepage: http://github.com/Mon-Ouie/coolline
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Sounds like readline, smells like readline, but isn't readline
 test_files: []
 has_rdoc: