cycr 0.2.6 → 0.2.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: 2d7f4bcddb89239483cb031ff210bf14f23a55e6
+  data.tar.gz: 2f070d448de23cb1c881638b2d9f914b558b1195
+SHA512:
+  metadata.gz: 9b016868803302a20f55688ed9192a84190a5caf2a6b59f716f10614f117bca91b7a33b7a74f4027651e524490f99b65d123e09711c388f85222111ad322275b
+  data.tar.gz: 318d115f7645310244a7480cad11917c4618219ddcb56ffa8566802f32e7068b4f9fee7685872b4c061acf7ee20fbe9b3659f96f9cbe221af86f030406d86e4c

data/Rakefile

@@ -11,6 +11,7 @@ task :test do
   sh "rspec spec/parser.rb"
   sh "rspec integration/assertion.rb"
   sh "rspec integration/client.rb"
+  sh "rspec integration/name_service.rb"
 end
 
 desc "Build the gem"
@@ -19,7 +20,7 @@ task :build do
 end
 
 desc "Install the library at local machnie"
-task :install => :build do 
+task :install => :build do
   sh "sudo gem install #$gem_name -l"
 end
 
@@ -30,7 +31,7 @@ end
 
 desc "Clean"
 task :clean do
-  sh "rm #$gem_name*.gem" 
+  sh "rm #$gem_name*.gem"
 end
 
 desc "Show changelog from the last release"

data/changelog.txt

@@ -1,3 +1,5 @@
+0.2.7
+- Cyc name service implementation
 0.2.6
 - fix deadlock in cache
 0.2.5

data/integration/name_service.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+$:.unshift "lib"
+require 'cycr'
+
+
+describe Cyc::Service::NameService do
+  let(:service) { Cyc::Service::NameService.new(@client) }
+
+  before(:all) do
+    @client = Cyc::Client.new()
+    #@client.debug = true
+  end
+
+  after(:all) do
+    @client.close
+  end
+
+  it "should find term by exact name" do
+    service.find_by_term_name("Dog").should_not == nil
+  end
+
+  it "should find term by id" do
+    term = service.find_by_term_name("Dog")
+    service.find_by_id(term.id).should_not == nil
+  end
+
+  it "should find concept by name" do
+    service.find_by_name("dog").should_not == nil
+    service.find_by_name("dog").should_not be_empty
+  end
+
+  it "should find concept by label" do
+    service.find_by_label("dog").should_not == nil
+  end
+
+  it "should convert Ruby term" do
+    term = service.convert_ruby_term(:Dog)
+    term.name.should == "Dog"
+  end
+
+  it "should transliterate non-ascii characters" do
+    service.find_by_term_name("Dóg").name.should == "Dog"
+  end
+
+  describe "with term" do
+    let(:term) { service.find_by_term_name("Dog") }
+
+    it "should return canonical label" do
+      service.canonical_label(term).should == "dog"
+    end
+
+    it "should return labels" do
+      service.labels(term).should include("dogs")
+    end
+  end
+end
+

data/lib/cyc/service/name_service.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+require 'iconv'
+
+module Cyc
+  module Service
+    class AmbiguousResult < Exception
+      attr_reader :results
+
+      def initialize(results)
+        super("Ambiguous prefered label results")
+        @results = results
+      end
+    end
+
+    # Class used to find Cyc terms by their name.
+    class NameService
+      attr_accessor :cyc
+
+      def initialize(cyc_client=Client.new,term_factory=Term)
+        @cyc = cyc_client
+        @cyc.connect
+        @factory = term_factory
+      end
+
+      # Look-up by +name+, i.e. the exact name of the Cyc term.
+      def find_by_term_name(name)
+        if name =~ /\A\[/
+          convert_ruby_term(eval(name))
+        else
+          term = @cyc.find_constant(transliterate(name))
+          if term
+            id = @cyc.compact_hl_external_id_string(term)
+            @factory.new(term,id)
+          end
+        end
+      end
+
+      # Look-up by ID, i.e. external identifier of the term.
+      def find_by_id(id)
+        begin
+          term = @cyc.find_cycl_object_by_compact_hl_external_id_string(id)
+          if term and term!='<The'
+            @factory.new(term,id)
+          end
+        rescue CycError
+          nil
+        end
+      end
+
+      # Approximate find by name - the result is ambiguous, so the result is an
+      # array.
+      def find_by_name(name)
+        result = @cyc.denotation_mapper(transliterate(name))
+        if result
+          result.select{|label,_,_| label == name }.
+            map{|_,_,ruby_term| convert_ruby_term(ruby_term) }
+        else
+          []
+        end
+      end
+
+      # Find term by prefered +label+. In rare cases the result is ambiguous - an
+      # AmbiguousResult is raised then. You can get the result, by calling 'result' on
+      # the returned exception.
+      def find_by_label(label)
+        result = @cyc.cyc_query( -> { '`(#$prettyString-Canonical ?s ' + transliterate(label).to_cyc + ')' }, :EnglishMt)
+        if result
+          result.map!{|e| convert_ruby_term(extract_term_name(e.first))}
+          if result.size == 1
+            result.first
+          else
+            raise AmbiguousResult.new(result)
+          end
+        end
+      end
+
+      # Returns canonical label for the +term+.
+      def canonical_label(term)
+        (@cyc.cyc_query(-> { '\'(#$prettyString-Canonical ' + term.to_cyc(true)  + ' ?s)'}, :EnglishMt) || []).
+          map{|e| e.first.last }.first
+      end
+
+      # Returns all (non-canonical) labels for the +term+.
+      def labels(term)
+        begin
+          (@cyc.cyc_query(-> { '\'(#$prettyString ' + term.to_cyc(true)  + ' ?s)'}, :EnglishMt) || []).
+            map{|e| e.first.last }
+        rescue CycError
+          []
+        end
+      end
+
+      # Close connection to Cyc server.
+      def close
+        @cyc.close
+      end
+
+      # Convert Ruby term (e.g. :Dog) to cyc term representation.
+      def convert_ruby_term(term)
+        id = @cyc.compact_hl_external_id_string(term)
+        if id
+          @factory.new(term,id)
+        end
+      end
+
+      private
+      # Extracts term name from a result that might be either Lisp pair or Lisp
+      # list.
+      def extract_term_name(expression)
+        if expression[1] == "."
+          expression[2]
+        else
+          expression[1..-1]
+        end
+      end
+
+      # Transliterate non-ascii characters.
+      def transliterate(string)
+        Iconv.iconv('ascii//translit//ignore', 'utf-8', string).join("")
+      end
+    end
+  end
+end

data/lib/cyc/term.rb

@@ -0,0 +1,49 @@
+module Cyc
+  class Term
+    # Create new Term using Ruby representation of the term (Symbol or
+    # Array).
+    def initialize(ruby_term,id)
+      @ruby_term = ruby_term
+      @id = id
+    end
+
+    # Return Ruby representation of the term.
+    def to_ruby
+      @ruby_term
+    end
+
+    # Return external ID of the term.
+    def id
+      @id
+    end
+
+    # Return Cyc-protocol compatible representation of the term.
+    def to_cyc(raw=false)
+      self.to_ruby.to_cyc(raw)
+    end
+
+    # Inspect the term.
+    def inspect
+      "#{@ruby_term}:#{@id}"
+    end
+
+    def name
+      self.to_ruby.to_s
+    end
+
+    def ==(other)
+      return false if !(self.class === other)
+      @ruby_term == other.to_ruby
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      @ruby_term.hash
+    end
+
+    alias to_s inspect
+  end
+end

data/lib/cyc/version.rb

@@ -1,3 +1,3 @@
 module Cyc
-  VERSION = "0.2.6"
+  VERSION = "0.2.7"
 end

data/lib/cycr.rb

@@ -10,3 +10,5 @@ require 'cyc/symbol'
 require 'cyc/variable'
 require 'cyc/version'
 require 'cyc/cache'
+require 'cyc/term'
+require 'cyc/service/name_service'

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cycr
 version: !ruby/object:Gem::Version
-  version: 0.2.6
-  prerelease: 
+  version: 0.2.7
 platform: ruby
 authors:
 - Aleksander Pohl
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-12 00:00:00.000000000 Z
+date: 2015-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -23,7 +21,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -31,7 +28,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: em-synchrony
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -39,7 +35,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -47,7 +42,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: ref
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,7 +49,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -74,6 +67,7 @@ files:
 - cycr.gemspec
 - integration/assertion.rb
 - integration/client.rb
+- integration/name_service.rb
 - lib/cyc/assertion.rb
 - lib/cyc/builder.rb
 - lib/cyc/cache.rb
@@ -87,9 +81,11 @@ files:
 - lib/cyc/exception.rb
 - lib/cyc/extensions.rb
 - lib/cyc/parser.rb
+- lib/cyc/service/name_service.rb
 - lib/cyc/sexpr.rex
 - lib/cyc/sexpr.rex.rb
 - lib/cyc/symbol.rb
+- lib/cyc/term.rb
 - lib/cyc/variable.rb
 - lib/cyc/version.rb
 - lib/cycr.rb
@@ -97,6 +93,7 @@ files:
 - spec/parser.rb
 homepage: http://github.com/apohllo/cycr
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --main
@@ -104,26 +101,25 @@ rdoc_options:
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby client for the (Open)Cyc server
 test_files:
 - spec/parser.rb
 - spec/conversion.rb
+- integration/name_service.rb
 - integration/assertion.rb
 - integration/client.rb
 has_rdoc: true