apohllo-cyc-console 0.0.2

data/README.txt

@@ -0,0 +1,108 @@
+= 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!)
+
+* problems with multiline commands
+* messeges send to stdout are not visible
+* errors are not printed - only nil is returned
+
+== 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.2 
+
+* gem -v 
+* 1.2.0 #=> ok
+
+You need the github.com repository to be added to your sources list:
+
+* gem sources -a http://gems.github.com
+
+Then you can type:
+
+* sudo gem install apohllo-cyc-console
+
+== BASIC USAGE: 
+
+The gem comes with +cyc+ command, so you can simply type:
+
+  $ 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 features 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/cyc-console.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |s|
+  s.name = "cyc-console"
+  s.version = "0.0.2"
+  s.date = "2009-07-15"
+  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"
+  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 = ["Rakefile", "cyc-console.gemspec", "README.txt"] +
+    Dir.glob("lib/**/*")
+  # include tests and specs
+  s.test_files = Dir.glob("{test,spect,features}/**/*")
+  # 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
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: apohllo-cyc-console
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Aleksander Pohl
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: apohllo-colors
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.4
+    version: 
+description: Ruby console for the Cyc ontology
+email: apohllo@o2.pl
+executables: 
+- cyc
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+files: 
+- Rakefile
+- cyc-console.gemspec
+- README.txt
+has_rdoc: true
+homepage: http://apohllo.pl
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby console for the Cyc ontology
+test_files: []
+