cycr 0.0.6 → 0.0.7

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+.*.sw?

data/README.txt

@@ -0,0 +1,137 @@
+= cycr
+
+* http://github.com/apohllo/cycr
+
+= DESCRIPTION
+
+'cycr' is a Ruby client for the (Open)Cyc server http://www.opencyc.org.
+
+= FEATURES/PROBLEMS
+
+* The text protocol is used to talk with Cyc
+* Ruby symbols are converted to Cyc symbols
+* Ruby arrays are converted to SubL arrays
+* Ruby calls on the client are transparently translated to SubL
+* Support for subcalls (like 'with-any-mt')
+* Support for NARTs might not be fully functional (but works somehow)
+* Support for CycL queries not implemented yet!
+
+= SYNOPSIS
+
+'cycr' is a Ruby client for the (Open)Cyc server. It is designed as a
+substitution for the original Java client. It allows for conversation
+with the ontology with regular Ruby objects (like symbols, arrays) 
+and also exposes the raw text protocol.
+
+= REQUIREMENTS
+
+(Open)Cyc server with TCP communication enabled.
+
+= INSTALL
+
+You need RubyGems v.1.3.5 at least:
+
+  $ gem -v
+  1.2.0 # => not OK
+  $ gem update --system
+  ...
+  $ gem -v 
+  1.3.7 # => OK
+
+The gem is available at rubygems.org, so you can install it with:
+
+  $ sudo gem install cycr
+
+== BASIC USAGE
+
+Prerequisites:
+
+* Cyc server is running 
+** you can download it from http://www.opencyc.org
+* Telnet connection is on
+** type (enable-tcp-server :cyc-api 3601) in the cyc console or Cyc Browser
+   -> Tools -> Interactor
+
+The you can start 'irb' to see it in action:
+
+  $ irb
+  # include the cycr gem
+  require 'cycr'
+
+  # create the cyc client object, default host: localhost, port: 3601
+  cyc = Cyc::Client.new
+
+  # check if Dog generalizes to Animal
+  cyc.genls? :Dog, :Animal # => T
+
+  # check if Animal generalizes to Dog
+  cyc.genls? :Animal, :Dog # => nil
+
+  # check the minimal generalizations of Animal
+  genls = cyc.min_genls :Animal
+  # => [:"Organism-Whole", :"PerceptualAgent-Embodied",
+    :"Agent-NonArtifactual", :SolidTangibleThing, [:CollectionUnionFn,
+    [:TheSet, :Animal, [:GroupFn, :Animal]]],...
+
+  # check the maximal specializations of the first of the above results
+  cyc.max_specs genls.first
+  # => [:Microorganism, :EukaryoticOrganism, :"Unvaccinated-Generic",
+    :"Vaccinated-Generic", :MulticellularOrganism, :Heterotroph, :Autotroph,
+    :Lichen, :TerrestrialOrganism, :Animal, :AquaticOrganism, :Mutant,
+    :Carnivore, :Extraterrestrial, :"Exotic-Foreign",...
+
+  # It works with NARTs (but I didn't tested this functionality extensively,
+  # so this might cause some problems - beware):
+  genls[4]
+  # => [:CollectionUnionFn, [:TheSet, :Animal, [:GroupFn, :Animal]]]
+
+  cyc.max_specs genls[4]
+  # => [:Animal, [:GroupFn, :Animal]]
+
+  # What is more, you might even build complex subcalls, such as:
+  cyc.genls? :Person, :HomoSapiens # => nil
+  cyc.with_any_mt{|cyc| cyc.genls? :Person, :HomoSapiens} # => T
+
+  # If you want to see the query which is send to Cyc, just turn on the
+  # debugging:
+  cyc.debug = true
+  cyc.genls? :Dog, :Anial
+  # Send: (genls? #$Dog #$Animal)
+  # Recv: 200 T
+  # => "T" 
+
+  # The same way, you can turn it off:
+  cyc.debug = false
+
+  # Remember to close the client on exit
+  cyc.close
+
+== LICENSE:
+ 
+(The MIT License)
+
+Copyright (c) 2008-2010 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/changelog.txt

@@ -0,0 +1,34 @@
+0.0.7
+- remove predefined SubL routines
+0.0.6
+- write README with usage example
+- fix NARTs containing NARTs
+- fix spec for Ruby 1.9.2
+0.0.5
+- fix parsing of assertions with NART MT
+- fix other NART issues
+0.0.4
+- remove special NART treatment
+- allow for nested SubL calls
+0.0.3
+- support for assertions
+- fix library initialization
+- typo in specs
+0.0.2
+- NARTs accessible via their names
+- parser extracted into separate file
+0.0.1
+- namespace changed to Cyc
+- gem name changed to cycr
+- server changed to client :-) 
+- allow for reconnection
+- host and port of client are readable
+- fix: multiline answer
+- fix: empty answer
+- fix: loading of predefined routines
+- fix: waiting for newline before processing answer
+- basic support for NARTs
+- basic configuration of host and port
+- denotation query added
+- support for quotation in message
+- running in multiple processes creates independent connectors

data/cycr.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = "cycr"
-  s.version = "0.0.6"
-  s.date = "2010-12-07"
+  s.version = "0.0.7"
+  s.date = "2010-12-22"
   s.summary = "Ruby client for the (Open)Cyc server"
   s.email = "apohllo@o2.pl"
   s.homepage = "http://github.com/apohllo/cycr"
@@ -9,12 +9,11 @@ Gem::Specification.new do |s|
   s.description = "Ruby wrapper for (Open)Cyc server and ontology"
   s.has_rdoc = false
   s.authors = ['Aleksander Pohl']
-  s.files = ["Rakefile", "cycr.gemspec", 'lib/cycr.rb'] +
-    Dir.glob("lib/**/*")
+  s.files = `git ls-files`.split("\n")
   s.test_files = Dir.glob("spec/**/*")
   s.rdoc_options = ["--main", "README.txt"]
   s.has_rdoc = true
   s.extra_rdoc_files = ["README.txt"]
-  s.add_dependency("rspec", [">= 1.2.9"])
+  s.add_development_dependency("rspec", [">= 1.2.9"])
 end
 

data/lib/cycr/client.rb

@@ -19,20 +19,6 @@ module Cyc
       @parser = Parser.new
       @mts_cache = {}
       @builder = Builder.new
-
-      # read domains mapings
-#      talk(File.read(File.join(
-#        File.dirname(__FILE__), 'domains.lisp')))
-
-      # read utility functions
-      talk(File.read(File.join(
-        File.dirname(__FILE__), 'words_reader.lisp')))
-
-      # wait untill files are processed
-      send_message("(define end-of-routines () ())")
-      while answer = receive_answer do
-        break if answer =~ /END-OF-ROUTINES/
-      end
     end
 
     # (Re)connects to the cyc server.

data/spec/client.rb

@@ -1,4 +1,5 @@
-require 'lib/cycr'
+$:.unshift "lib"
+require 'cycr'
 
 describe Cyc::Client do
   before(:each) do  
@@ -21,9 +22,9 @@ describe Cyc::Client do
   it "should allow multiple processes to use the client" do 
     parent_pid = Process.pid
     if fork
-      @client.find_collection("Cat")
+      @client.find_constant("Cat")
     else
-      @client.find_collection("Dog")
+      @client.find_constant("Dog")
     end
     if Process.pid == parent_pid
       Process.waitall

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 6
-  version: 0.0.6
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - Aleksander Pohl
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-07 00:00:00 +01:00
+date: 2010-12-22 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
         - 2
         - 9
         version: 1.2.9
-  type: :runtime
+  type: :development
   version_requirements: *id001
 description: Ruby wrapper for (Open)Cyc server and ontology
 email: apohllo@o2.pl
@@ -41,24 +41,25 @@ extensions: []
 extra_rdoc_files: 
 - README.txt
 files: 
+- .gitignore
+- README.txt
 - Rakefile
+- changelog.txt
 - cycr.gemspec
 - lib/cycr.rb
-- lib/cycr/sexpr.rex
-- lib/cycr/parser.rb
-- lib/cycr/domains.lisp
-- lib/cycr/sexpr.flex
+- lib/cycr/assertion.rb
 - lib/cycr/builder.rb
-- lib/cycr/constants.rb
-- lib/cycr/collection.rb
-- lib/cycr/sexpr.rex.rb
 - lib/cycr/client.rb
+- lib/cycr/collection.rb
+- lib/cycr/constants.rb
+- lib/cycr/domains.lisp
 - lib/cycr/extensions.rb
-- lib/cycr/assertion.rb
-- lib/cycr/words_reader.lisp
-- README.txt
-- spec/client.rb
+- lib/cycr/parser.rb
+- lib/cycr/sexpr.flex
+- lib/cycr/sexpr.rex
+- lib/cycr/sexpr.rex.rb
 - spec/assertion.rb
+- spec/client.rb
 has_rdoc: true
 homepage: http://github.com/apohllo/cycr
 licenses: []

data/lib/cycr/words_reader.lisp

@@ -1,204 +0,0 @@
-;(csetq *PATH* "/home/fox/src/nlp/wsd/cyc/~A")
-(csetq *PATH* "/mnt/cyc/export/~A")
-;(csetq *WORDS-PATH* (format nil *PATH* "m_100_en_hasla.txt"))
-(csetq *WORDS-PATH* (format nil *PATH* "all_english.txt"))
-(csetq *WORDS-FILE* "")
-(csetq *WORDS-OUTPUT* "")
-(csetq *WORDS-OUTPUT-PROP* "")
-(csetq *WORDS-MISSING* "")
-
-(define load-code () (load (format nil *PATH* "words_reader.lisp")))
-(define next-word () 
-  (clet (
-	 (word  (read *WORDS-FILE* nil))
-	)
-      (pif (null word) (ret '(("EOF" :eof))) ())
-      (clet (
-	     (denotations (denotation-mapper (format nil "~A" word)))
-	     (correct-denots ())
-	    )
-	(pif (consp denotations)
-	     ()
-	     (princ (format nil "~A~%" word) *WORDS-MISSING*)
-	)
-;	(csetq *PROP-WORD* word)
-	(cdolist (denot denotations) 
-		 (pif (denot-word-p denot word) (cpush denot correct-denots) nil)
-	)
-;	(csetq denotations (mremove-if #'prop-word-p denotations))
-	(ret (reverse correct-denots))
-      )
-  )
-)
-
-(define symbol-str (symbol)
-   (ret (cdr (caar 
-      (cyc-query `(#$prettyString-Canonical ,symbol ?w) #$EnglishMt)
-   )))
-)
-
-; same as above but prettyString (without canonical) is used,
-; so it can return many results
-(define symbol-strs (symbol)
-  (clet ((result ()))
-	(cdolist (el (cyc-query `(#$prettyString ,symbol ?w) #$EnglishMt))
-		 (cpush (cdar el) result))
-	(ret result))
-)
-
-(define print-names (symbols output) 
-   (cdolist (el symbols) 
-	    (princ (format nil "~A" el) output)
-	    (princ (format nil "  ~S" 
-		      (strip-s (symbol-str el) "type of ")) 
-	      output)
-;	    (terpri output)
-   )
-)
-(define min-genls-flat (concept stop-words) 
-  ;(ret (remove-invalid (min-genls concept #$EverythingPSC) stop-words))
-  ;CycNounLearnerMt UniversalVocabularyMt
-  (ret (remove-invalid (min-genls concept #$CycNounLearnerMt) stop-words))
-)
-(define min-isa-flat (concept stop-words) 
-  ;(ret (remove-invalid (min-isa concept #$EverythingPSC) stop-words))
-  (ret (remove-invalid (min-isa concept #$CycNounLearnerMt) stop-words))
-)
-
-(define read-all () 
-  (clet ( 
-	  (stop-words (read-stop))
-	  (output nil)
-	 )
-    (cdo ((words (next-word) (next-word))) 
-       ((equal words '(("EOF" :eof))))
-       (cdolist (word words)
-         (pif (consp word)
-              (progn 
-		(pif (isa? (cdr word) #$Individual) 
-         (csetq output *WORDS-OUTPUT-PROP*)
-         (csetq output *WORDS-OUTPUT*))
-    (princ (format nil "~A[~A]" 
-                   (car word)
-                   (cdr word)
-                   ) 
-           output)
-		(print-names (min-genls-flat (cdr word) stop-words) output)
-		(princ " ISA" output)
-		(print-names (min-isa-flat (cdr word) stop-words) output)
-		(terpri output)
-	      ) 
-	      ()
-	  )
-       )
-    )
-  )
-)
-
-; my implementation of the mapcar function
-(defmacro mmapcar (fun elems) 
-  (clet ((var (gensym)))
-        (ret `(clet ((result nil)) 
-	      (cdolist (,var ,elems) 
-		       (cpush  (funcall ,fun ,var ) result) ) 
-	      (reverse result))
-	 )
-  )
-)
-
-; removes elements from list if the fun returns nil
-(define mremove-if (fun elems)
-  (remove-if #'null (mmapcar fun elems))
-)
-
-;T if denotation's word equals word
-(define denot-word-p (denot word) 
-  (fif (equal (car denot) word) denot nil))
-
-;T if the car of the cons is equal to word 
-(define prop-word-p (el word) 
-  (fif (equal (car (eval el)) word) (eval el) nil))
-
-
-(define open-words ()
-  (csetq *WORDS-FILE* (open-text *WORDS-PATH* :input))
-)
-
-(define open-missing ()
-  (csetq *WORDS-MISSING* (open-text (format nil *PATH* "missing.txt") :output))
-)
-
-(define close-words ()
-  (close *WORDS-FILE*))
-
-
-(define open-output (version) 
-  (csetq *WORDS-OUTPUT* 
-	 (open-text (format nil *PATH* (format nil "pohl_cyc_~A.txt" version)) :output))
-  (csetq *WORDS-OUTPUT-PROP* 
-	 (open-text (format nil *PATH* (format nil "pohl_cyc_prop_~A.txt" version)) :output))
-)
-
-;close output file
-(define close-output () 
-  (close *WORDS-OUTPUT*)
-  (close *WORDS-OUTPUT-PROP*)
-)
-
-;returns the stop-list 
-(define read-stop ()
-  (clet ((stop-file (open-text (format nil *PATH* "stop_list.txt") :input))
-	 (stop-words (read stop-file))
-	 )
-    (close stop-file)
-    (ret stop-words)
-  )
-)
-
-; removes sequence #removed from the beginning of the sequence #sequence 
- (define strip-s (sequence removed) 
-   (ret(fif (eq 0 (search removed sequence))
-	    (subseq sequence (length removed))
-	    sequence))
-)
-
-;main transforming loop
-(define main-prog (version) 
-    (open-words)
-    (open-output version)
-    (open-missing)
-    (read-all)
-    (close-words)
-    (close-output) 
-    (close *WORDS-MISSING*)
-)
-
-(define  remove-invalid (elements invalid) 
-  (clet ( (result () ) )
-	(cdolist (el elements) 
-		 (pif (null (cor (member el invalid)
-				 (cand (nart-p el) 
-				       (intersection invalid (nart-hl-formula el)) ))) 
-		      (cpush el result) ()) 
-		 )
-	(ret result) 
-  )
-)
-
-(define term-mts (term) 
-  (clet ((result ())) 
-        (cdolist (e (gather-index-in-any-mt term)) 
-                 (csetq result (adjoin (assertion-mt e) result))) 
-        result) 
-)
-
-(define any-assertion? (term mt)
-  (with-mt mt (pif (gather-index term) T ())))
-
-(define nart-denotation-mapper (word) 
-  (clet ((result ())) 
-        (cdolist (el (denotation-mapper word))
-                 (pif (nart-p (cdr el)) 
-                      (cpush (nart-id (cdr el)) result) 
-                      (cpush (cdr el) result))) result
-        (ret result)))