cyc-console 0.0.4

data/README.txt

@@ -0,0 +1,133 @@
+= cyc-console
+
+* http://github.com/apohllo/cyc-colors
+
+== DESCRIPTION:
+
+Console for the Cyc ontology written in Ruby.
+
+== FEATURES/PROBLEMS:
+
+* support for history
+* highlighting of unmatched parenthesis
+* colorful prompt
+* readline based editing (arrows, delete, etc. works!)
+* autocompletion of symbols (present in server answers)
+  and functions (listed in ~/.cyc_functions)
+
+* problems with multiline commands
+* messeges send to stdout are not visible
+* errors are not printed - only nil is returned
+* text protocol is used (lenghty output is cut, it might be slower
+  than the binary protocol, but is not as important when working
+  in interactive mode)
+
+== SYNOPSIS:
+
+Cyc-console is console for the Cyc ontology written in Ruby.
+It is inspired by the Ruby console - irb. The original Cyc console
+has many limitations. There is no support for readline, which
+means that arrow keys doesn't work as expected. There is also
+no auto-completion, no history, etc. This console aims at overcomming
+these limitations.
+
+== INSTALL:
+
+You need RubyGems v. 1.3.3
+
+  $ gem -v 
+  1.2.0 #=> not OK
+  $ gem update --system
+  ...
+  $ gem -v
+  1.3.3 #=> OK
+
+You need the gemcutter repository to be added to your sources list:
+
+ $ gem sources -a http://gemcutter.org
+
+Then you can install the Cyc console with:
+
+ $ sudo gem install cyc-console
+
+If it doesn't work as expected:
+
+ ERROR:  could not find gem cyc-console locally or in a repository
+
+try installing the gemcutter gem, and issuing
+the gem tumble command:
+
+ $ sudo gem install gemcutter
+ $ sudo gem tumble
+
+And then try to install the gem once again:
+
+ $ sudo gem install cyc-console
+
+== BASIC USAGE: 
+
+The gem comes with +cyc+ command, so you can simply type 
+(provided the Cyc server is running on localhost on the default
+port and you have rubygems bin directory in your path):
+
+  $ cyc
+  cyc@localhost:3601>
+
+By defualt the console connects with Cyc on the localhost on the default port 3601.
+You can change it, by providing the name of the host, and the port as parameters:
+
+  $ cyc www.example.com 4567
+  cyc@www.example.com:4567>
+
+The console works like regular Cyc console (however, see problems above):
+
+  cyc@localhost:3601>(genl? #$Cat #$Animal)
+  T
+  cyc@localhost:3601>
+
+If you run the console once again, you will have access to previous commands. 
+The history is kept ~/.cyc_history and remembers 1000 commands by default. 
+You can change these, by providing CYC_HISTORY_FILE and CYC_HISTORY_SIZE 
+environment varibles respectively.
+
+One helpful feature is to brows the history by providing the beginning of the command.
+If you type:
+
+  cyc@localhost:3601>(genl?<PG-UP>
+
+you'll get the latest command which has the same form:
+
+  cyc@localhost:3601>(genl? #$Cat #$Animal)
+
+This really speeds-up working with the console.
+
+
+== LICENSE:
+ 
+(The MIT License)
+
+Copyright (c) 2009 Aleksander Pohl
+
+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.
+
+== FEEDBACK
+
+* mailto:apohllo@o2.pl
+

data/Rakefile

@@ -0,0 +1,42 @@
+task :default => [:test]
+
+$gem_name = "cyc-console"
+
+desc "Test the library"
+task :test do
+  ruby Dir.glob("test/*")
+end
+
+desc "Run specs" 
+task :spec do
+  sh "spec spec/* --format specdoc --color"
+end
+
+desc "Run features" 
+task :features do
+  sh "features features/* "
+end
+
+desc "Build the gem"
+task :build do
+  sh "gem build #$gem_name.gemspec"
+end
+
+desc "Install the library at local machnie"
+task :install => :build do 
+  sh "sudo gem install #$gem_name -l"
+end
+
+desc "Uninstall the library from local machnie"
+task :uninstall do
+  sh "sudo gem uninstall #$gem_name"
+end
+
+desc "Reinstall the library in the local machine"
+task :reinstall => [:uninstall, :install] do
+end
+
+desc "Clean"
+task :clean do
+  sh "rm #$gem_name*.gem" 
+end

data/bin/cyc

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+require 'readline'
+require 'cyc/console'
+
+if Readline.respond_to?("basic_word_break_characters=")
+  Readline.basic_word_break_characters= " \t\n\"\\'`><=;|&{("
+end
+Readline.completion_append_character = nil
+Readline.completion_proc = Cyc::Console::CompletionProc
+
+host = ARGV[0] || "localhost"
+port = ARGV[1] || 3601
+console = Cyc::Console.new(host,port)
+console.main_loop
+

data/changelog.txt

@@ -0,0 +1,11 @@
+0.0.4
+	- autocompletion for symbols
+	- autocompletion for functions defined in ~/.cyc_functions
+0.0.3
+  - fix: added missing library and changelog.txt to gemspec
+0.0.2
+  - versin bump for github
+0.0.1
+  - history support 
+  - highlighting of unmatched parenthesis
+  - colorful prompt 

data/cyc-console.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name = "cyc-console"
+  s.version = "0.0.4"
+  s.date = "2009-10-08"
+  s.summary = "Ruby console for the Cyc ontology"
+  s.email = "apohllo@o2.pl"
+  s.homepage = "http://apohllo.pl"
+  s.description = "Ruby console for the Cyc ontology with " +
+    "support for readline, colorful output, history, etc."
+  s.authors = ['Aleksander Pohl']
+  # the lib path is added to the LOAD_PATH
+  s.require_path = "lib"
+  # include Rakefile, gemspec, README and all the source files
+  s.files = [
+    'lib/cyc/console.rb',
+    "Rakefile", 
+    "cyc-console.gemspec", 
+    "README.txt",
+    "changelog.txt"
+  ] 
+  # include README while generating rdoc
+  s.rdoc_options = ["--main", "README.txt"]
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.txt"]
+  s.executables = ['cyc']
+#  s.add_dependency("apohllo-colors", [">= 0.0.4"])
+end
+

data/lib/cyc/console.rb

@@ -0,0 +1,187 @@
+#!/usr/bin/ruby
+
+require 'readline'
+require 'colors'
+require 'net/telnet'
+
+module Cyc
+  class ParenthesisNotMatched < RuntimeError; end
+
+  class Configurable
+  
+    attr_reader :configuration
+    attr_writer :verbose
+
+    def initialize
+      load_configuration
+    end
+
+    protected
+    def say(*args)
+      puts *args if @verbose
+    end
+
+    def cfg(key)
+      @opt["#{key}".intern]
+    end
+
+    def load_configuration
+      # expand functions file and make sure it exists
+      real_path = File.expand_path(cfg('path'))
+      unless File.exist?(real_path)
+        say "Configuration file #{real_path} doesn't exist."
+        @configuration = []
+        return
+      end
+
+      # read lines from file and add them to configuration list
+      @configuration = File.readlines(real_path).map { |line| line.chomp }
+
+      say 'Read %d lines from configuration file %s' % [@configuration.size, cfg('path')]
+      @configuration
+    end
+
+ end
+  #
+  # Stolen (with permission from the author :) from Wirble history for IRB 
+  # http://pablotron.org/software/wirble/
+  #
+  class History < Configurable
+    DEFAULTS = {
+      :path   => ENV['CYC_HISTORY_FILE'] || "~/.cyc_history",
+      :size   => (ENV['CYC_HISTORY_SIZE'] || 1000).to_i,
+      :perms  => File::WRONLY | File::CREAT | File::TRUNC,
+    }
+
+    def save_history
+      path, max_size, perms = %w{path size perms}.map { |v| cfg(v) }
+
+      # read lines from history, and truncate the list (if necessary)
+      lines = Readline::HISTORY.to_a.uniq
+      lines = lines[-max_size, -1] if lines.size > max_size
+
+      # write the history file
+      real_path = File.expand_path(path)
+      File.open(real_path, perms) { |fh| fh.puts lines }
+      say 'Saved %d lines to history file %s.' % [lines.size, path]
+    end
+
+    public
+
+    def initialize(opt = nil)
+      @opt = DEFAULTS.merge(opt || {})
+      super()
+      return unless defined? Readline::HISTORY
+      Readline::HISTORY.push(*self.configuration)
+      Kernel.at_exit { save_history }
+    end
+  end
+
+  class CycFunctions < Configurable
+    DEFAULTS = {
+      :path   => ENV['CYC_FUNCTIONS_FILE'] || "~/.cyc_functions",
+      :perms  => File::WRONLY | File::CREAT | File::TRUNC
+    }
+ 
+    def initialize(opt = nil)
+      @opt = DEFAULTS.merge(opt || {})
+      super()
+    end
+
+    def to_a
+      self.configuration
+    end
+  end
+
+  class Console
+    @@constants = []
+    @@functions = CycFunctions.new.to_a
+
+    API_QUIT = "(api-quit)"
+
+    # Initializes connection with Cyc runing on host :host: on port :port:
+    def initialize(host, port)
+      History.new({})
+      @host = host
+      @port = port
+      @conn = Net::Telnet.new("Port" => @port, "Telnetmode" => false, 
+                              "Host" => @host, "Timeout" => 600)
+      @line = ""
+      @count = 0
+    end
+
+    # Scans the :str: to find out if the parenthesis are matched
+    # raises ParenthesisNotMatched exception if there is not matched closing 
+    # parenthesis. The message of the exception contains the string with the 
+    # unmatched parenthesis highlighted.
+    def match_par(str)
+      position = 0
+      str.scan(/./) do |char| 
+        position += 1
+        next if char !~ /\(|\)/
+        @count += (char == "(" ?  1 : -1)
+        if @count < 0 
+          @count = 0
+          raise ParenthesisNotMatched.
+            new((position > 1 ? str[0..position-2] : "") + 
+              ")".hl(:red) + str[position..-1])
+        end
+      end
+      @count == 0
+    end
+
+    def add_autocompletion(str)
+      @@constants |= str.split(/[() ]/).select{|e| e =~ /\#\$/}
+    end
+
+    # The main loop of the console
+    def main_loop
+      loop do
+        begin
+          line = Readline::readline(("cyc@" + "#{@host}:#{@port}" + 
+              (@count > 0 ? ":#{"("*@count}" : "") + "> ").hl(:blue)) 
+          case line 
+          when API_QUIT 
+            @conn.puts(line)
+            break
+          when "exit"
+            @conn.puts(API_QUIT)
+            break
+          else
+            @line += "\n" unless @line.empty?
+            @line += line
+            letters = @line.split("")
+            Readline::HISTORY.push(@line) if line
+            if match_par(line)
+              @conn.puts(@line)
+              @line = ""
+              answer = @conn.waitfor(/\d\d\d/)
+              message = answer.sub(/(\d\d\d) (.*)\n/,"\\2") if answer
+              if($1.to_i == 200)
+                puts message
+                add_autocompletion(message)
+              else
+                puts "Error: " + answer.to_s
+              end
+            end
+          end
+        rescue ParenthesisNotMatched => exception
+          puts exception
+          @line = ""
+#        rescue Exception => exception
+#          puts exception
+        end
+      end
+    end
+
+    CompletionProc = proc {|input|
+      case input
+      when /\A#/
+        @@constants.grep(/^#{Regexp.quote(input)}/)
+      when /\A[a-zA-Z-]*\Z/
+        @@functions.grep(/#{Regexp.quote(input)}/)
+      end
+    }
+  end
+end
+

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: cyc-console
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Aleksander Pohl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-08 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Ruby console for the Cyc ontology with support for readline, colorful output, history, etc.
+email: apohllo@o2.pl
+executables: 
+- cyc
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- lib/cyc/console.rb
+- Rakefile
+- cyc-console.gemspec
+- README.txt
+- changelog.txt
+has_rdoc: true
+homepage: http://apohllo.pl
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby console for the Cyc ontology
+test_files: []
+