consolize 0.2.0

data/LICENSE

@@ -0,0 +1,9 @@
+Copyright (c) 2012 Matthew King
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+

data/README.md

@@ -0,0 +1,81 @@
+# Consolize
+
+A mixin for creating application consoles with Readline support.
+
+## Example
+
+```ruby
+gem install consolize
+
+require "consolize"
+
+class UsefulThing
+
+  # define all the useful methods and behaviors you need
+  def use(adverb)
+    puts "You used me #{adverb}!"
+  end
+
+  # Mix it in
+  include Consolize
+
+  # Set it up
+  setup_console do |console|
+
+    on("help") do
+      commands = console.commands
+      puts "* Available commands: " << commands.sort.join(" ")
+      puts "* Tab completion works for commands."
+    end
+
+    # Consolize provides a "quit" command by default, but you can
+    # override it to add value.
+    on("quit") do
+      puts "Farewell to the girl with the sun in her eyes."
+      exit
+    end
+
+    # Set up a handler for a command where the first token is "!"
+    # I.e., shell out like Vim does.
+    on_bang do |args|
+      system args.first
+    end
+
+    # define a command that calls an instance method of your class.
+    # The block parameter is always an array, even if your regex
+    # had only one match group.
+    # This command will only accept a single-word argument (no
+    # whitespace allowed).
+    on(/use (\S+)$/) do |args|
+      self.use(args.first)
+    end
+
+  end
+
+end
+
+UsefulThing.new.console
+```
+
+
+## Usage
+
+
+    $ ruby -I lib/ examples/usage.rb 
+
+    <3: help
+    * Available commands:  help quit use
+    * Tab completion works for commands.
+    <3: use well
+    You used me well!
+    <3: use badly
+    You used me badly!
+    <3: use without proper care
+    command not found
+    <3: ! ls
+    LICENSE           README.md         consolize.gemspec examples          lib
+    <3: quit
+    Farewell to the girl with the sun in her eyes.
+
+
+

data/examples/usage.rb

@@ -0,0 +1,49 @@
+require "consolize"
+
+class UsefulThing
+
+  # define all the useful methods and behaviors you need
+  def use(adverb)
+    puts "You used me #{adverb}!"
+  end
+
+  # Mix it in
+  include Consolize
+
+  # Set it up
+  setup_console do |console|
+
+    on("help") do
+      commands = console.commands
+      puts "* Available commands: " << commands.sort.join(" ")
+      puts "* Tab completion works for commands."
+    end
+
+    # Consolize provides a "quit" command by default, but you can
+    # override it to add value.
+    on("quit") do
+      puts "Farewell to the girl with the sun in her eyes."
+      exit
+    end
+
+    # Set up a handler for a command where the first token is "!"
+    # I.e., shell out like Vim does.
+    on_bang do |args|
+      system args.first
+    end
+
+    # define a command that calls an instance method of your class.
+    # The block parameter is always an array, even if your regex
+    # had only one match group.
+    # This command will only accept a single-word argument (no
+    # whitespace allowed).
+    on(/use (\S+)$/) do |args|
+      self.use(args.first)
+    end
+
+  end
+
+end
+
+UsefulThing.new.console
+

data/lib/consolize.rb

@@ -0,0 +1,157 @@
+# stdlib
+require "set"
+
+# others
+require "rubygems"
+gem "rb-readline"
+require "readline"
+
+Readline.completion_append_character = nil
+#Readline.basic_word_break_characters = ""
+
+
+module Consolize
+  def self.included(mod)
+    mod.module_eval do
+      @console = Console.new
+      def self.console
+        @console
+      end
+
+      def self.setup_console(&block)
+        console = @console
+        @console.on("quit") do
+          console.exit
+        end
+        @console.on("") do
+          puts "Giving me the silent treatment, eh?"
+        end
+        @console.instance_exec(console, &block)
+      end
+
+      def console
+        self.class.console.run(self)
+      end
+    end
+  end
+end
+
+class Console
+
+  attr_reader :store, :commands
+  def initialize
+    @patterns = {}
+    @commands = Set.new
+    Readline.completion_proc = self.method(:complete)
+  end
+
+  def complete(str)
+    case Readline.line_buffer
+    when /^\s*!/
+      # if we're in the middle of a bang-exec command, completion
+      # should look at the file system.
+      self.dir_complete(str)
+    else
+      # otherwise use the internal dict.
+      self.term_complete(str)
+    end
+  end
+
+  def dir_complete(str)
+    Dir.glob("#{str}*")
+  end
+
+  def term_complete(str)
+    # Terms can be either commands or indexes into the configuration
+    # data structure.  No command contains a ".", so that's the test
+    # we use to distinguish.
+    bits = str.split(".")
+    if bits.size > 1
+      # Somebody should have documented this when he wrote it, because
+      # he now does not remember exactly what he was trying to achieve.
+      # He thinks that it's an attempt to allow completion of either
+      # full configuration index strings, or of component parts.
+      # E.g., if the configuration contains foo.bar.baz, this code
+      # will offer both "foo" and "foo.bar.baz" as completions for "fo".
+      v1 = @completions.grep(/^#{Regexp.escape(str)}/)
+      v2 = @completions.grep(/^#{Regexp.escape(bits.last)}/)
+      (v1 + v2.map {|x| (bits.slice(0..-2) << x).join(".") }).uniq
+    else
+      self.command_complete(str) +
+        @completions.grep(/^#{Regexp.escape(str)}/)
+    end
+  end
+
+  def command_complete(str)
+    @commands.grep(/^#{Regexp.escape(str)}/) 
+  end
+
+  def sanitize(str)
+    # ANSI code stripper regex cargo culted from
+    # http://www.commandlinefu.com/commands/view/3584/remove-color-codes-special-characters-with-sed
+    str.gsub(/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]/, "")
+  end
+
+  def on(*pattern, &block)
+    pattern.flatten.each do |pattern|
+      @patterns[pattern] = block
+      self.add_command(pattern)
+    end
+  end
+
+  # Helper for defining the action for the "!" command.
+  # Typically used to shell out, a la Vim.
+  def on_bang(&block)
+    on(/^\!\s*(.*)$/, &block)
+  end
+
+  def add_command(pattern)
+    if pattern.is_a?(String)
+      @commands << pattern
+    else
+      bits = pattern.source.split(" ")
+      # TODO: figure out why you did this, then document it.
+      if bits.size > 1
+        @commands << bits.first
+      end
+    end
+  end
+
+  def run(context)
+    @completions = context.completions rescue Set.new
+    @run = true
+    puts
+    while @run && line = Readline.readline("<3: ", true)
+      self.parse(context, line.chomp)
+    end
+  end
+
+  def exit
+    @run = false
+  end
+
+  # Attempt to find a registered command that matches the input
+  # string.  Upon failure, print an encouraging message.
+  def parse(context, input_string)
+    _p, block= @patterns.detect do |pattern, block|
+      pattern === input_string
+    end
+    if block
+      # Perlish global ugliness necessitated by the use of
+      # Enumerable#detect above.  FIXME.
+      if $1
+        # if the regex had a group (based on the assumption that $1
+        # represents the result of the === that matched), call the block
+        # with all the group matches as arguments.
+        context.instance_exec($~[1..-1], &block)
+      else
+        context.instance_eval(&block)
+      end
+    else
+      puts "command not found"
+    end
+  end
+
+end
+
+

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: consolize
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Matthew King
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rb-readline
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 4
+        - 2
+        version: 0.4.2
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- LICENSE
+- lib/consolize.rb
+- examples/usage.rb
+has_rdoc: true
+homepage: https://github.com/automatthew/consolize
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: A mixin for creating application consoles with Readline support
+test_files: []
+