unific 0.9 → 0.10

data/History.txt

@@ -1,3 +1,15 @@
+=== 0.10 / 2012-01-30
+
+* Added a simple example program -- a mock database using unification for
+  query
+
+* more documentation improvements
+
+* added a hack to handle Rulog::Functor specially during unification for the
+  moment; this will be handled more cleanly in the released version of rulog
+
+* tested with Ruby 1.9.3 as well as 1.8.7
+
 === 0.9 / 2012-01-12
 
 * unific split out from the in-development rulog (Ruby With Logic) gem

data/Manifest.txt

@@ -4,5 +4,6 @@ Manifest.txt
 README.rdoc
 README.txt
 Rakefile
+examples/database.rb
 lib/unific.rb
 test/test_unific.rb

data/README.rdoc

@@ -16,6 +16,16 @@ the in-development Rulog[http://github.com/jimwise/rulog]] (Ruby With Logic)
 gem), but can also be useful on its own as a pattern matching engine which
 can enforce consistency across multiple matches.
 
+=== How to Use This Gem
+
+To get started, include this gem using
+
+    require 'rubygems'
+    require 'unific'
+
+This gem provides the Unific module.  This module provides several methods
+which implement a unification engine.
+
 === What is Unfication?
 
 Unfication is a generalization of pattern matching -- it allows you to
@@ -32,7 +42,8 @@ is much more.
 
 So, what does it mean to unify two values?
 
-In the simplest case, we can compare two values:
+In the simplest case, we can unify two values if they are equal (according
+to ==):
 
     Unific::unify("foo", "foo")
     ==> succeeds, returns an empty environment, which is a true value (see below)
@@ -64,6 +75,9 @@ this implies that nested Enumerables are unified recursively:
     Unific::unify([["a", 42], ["b", 33]], [["a", 42], ["b", 33]])
     ==> returns an empty environment, which is a true value (see below)
 
+As an exception, strings are _not_ unified recursively in this manner, even
+though they _are_ Enumerables.
+
 So far, this does nothing that we could not do with the == operator... but
 there's more.
 
@@ -274,8 +288,8 @@ and generate the RDoc.
 
 == REQUIREMENTS:
 
-This gem should run fine under Ruby 1.8.7 or 1.9.  If you experience any
-issues, please let me know.
+This gem is tested and should run fine under Ruby 1.8.7 or 1.9.  If you
+experience any issues, please let me know.
 
 == LICENSE:
 

data/README.txt

@@ -16,6 +16,16 @@ the in-development Rulog[http://github.com/jimwise/rulog]] (Ruby With Logic)
 gem), but can also be useful on its own as a pattern matching engine which
 can enforce consistency across multiple matches.
 
+=== How to Use This Gem
+
+To get started, include this gem using
+
+    require 'rubygems'
+    require 'unific'
+
+This gem provides the Unific module.  This module provides several methods
+which implement a unification engine.
+
 === What is Unfication?
 
 Unfication is a generalization of pattern matching -- it allows you to
@@ -32,7 +42,8 @@ is much more.
 
 So, what does it mean to unify two values?
 
-In the simplest case, we can compare two values:
+In the simplest case, we can unify two values if they are equal (according
+to ==):
 
     Unific::unify("foo", "foo")
     ==> succeeds, returns an empty environment, which is a true value (see below)
@@ -64,6 +75,9 @@ this implies that nested Enumerables are unified recursively:
     Unific::unify([["a", 42], ["b", 33]], [["a", 42], ["b", 33]])
     ==> returns an empty environment, which is a true value (see below)
 
+As an exception, strings are _not_ unified recursively in this manner, even
+though they _are_ Enumerables.
+
 So far, this does nothing that we could not do with the == operator... but
 there's more.
 
@@ -274,8 +288,8 @@ and generate the RDoc.
 
 == REQUIREMENTS:
 
-This gem should run fine under Ruby 1.8.7 or 1.9.  If you experience any
-issues, please let me know.
+This gem is tested and should run fine under Ruby 1.8.7 or 1.9.  If you
+experience any issues, please let me know.
 
 == LICENSE:
 

data/examples/database.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/ruby
+
+require 'rubygems'
+require 'unific'
+
+KEYS = [ :first, :last, :age, :occupation ]
+DATA = [
+        { :first => "John", :last => "Smith", :age => 40, :occupation => "yak shaver" },
+        { :first => "Joe",  :last => "Bloe",  :age => 30, :occupation => "cat herder" },
+        { :first => "Jack", :last => "White", :age => 40, :occupation => "telephone sanitizer" },
+        { :first => "John", :last => "NotSmith", :age => 90, :occupation => "inspirational speaker" }
+       ]
+
+# q is a hash with one or more values filled in
+def query q
+  q2 = q.clone
+  KEYS.each {|k| q2[k] ||= Unific::_}
+  r = DATA.select {|d| Unific::unify d, q2}
+end
+
+johns = query :first => "John"
+forties = query :age => 40
+john_forties = query :first => "John", :age => 40
+
+puts "People named John:"
+johns.each {|d| puts "found: #{d[:first]} #{d[:last]}"}
+
+puts
+
+puts "Forty-year-olds:"
+forties.each {|d| puts "found: #{d[:first]} #{d[:last]}"}
+
+puts
+
+puts "Forty-year-old people named John:"
+john_forties.each {|d| puts "found: #{d[:first]} #{d[:last]}"}

data/lib/unific.rb

@@ -2,7 +2,7 @@ require 'singleton'
 
 module Unific
 
-  VERSION = '0.9'
+  VERSION = '0.10'
 
   # An environment (set of variable bindings) resulting from unification
   class Env
@@ -138,6 +138,12 @@ module Unific
       end
     end
 
+    # forward definition, see comment below
+    module ::Rulog #:nodoc:
+    end
+    class ::Rulog::Functor #:nodoc:
+    end
+
     # private helper for instantiate and rename
     # given an argument, if it is an:
     #   a.) var, replace it with the result of calling a block on it
@@ -149,7 +155,8 @@ module Unific
         s
       when Var
         block.call(s)
-      # XXX XXX rulog had handling for Functor here, we may need to provide something similar?
+      when Rulog::Functor # XXX XXX messy -- this is the only place Unific knows about the rest of Rulog
+        Rulog::Functor.new _traverse(s.f, &block), *_traverse(s.args, &block)
       when String
         # in ruby 1.8, strings are enumerable, but we want them to be ground
         s

data/test/test_unific.rb

@@ -34,7 +34,6 @@ class TestUnific < Test::Unit::TestCase
     assert Unific::unify(Unific::_, Unific::Var.new);
     assert Unific::unify([Unific::_, 2], [1, 2]).unify([2, Unific::_], [2, 3])
     v1 = Unific::Var.new("v1")
-    e1 = Unific::Env.new
     e2 = Unific::unify(v1, 42);
     assert Unific::unify(v1, Unific::_, e2);
     assert Unific::unify([1, 2, 3], Unific::_)

metadata

@@ -1,112 +1,94 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: unific
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: '0.10'
   prerelease: 
-  segments: 
-  - 0
-  - 9
-  version: "0.9"
 platform: ruby
-authors: 
+authors:
 - Jim Wise
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-12 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rdoc
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &69349280 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 3
-        - 10
-        version: "3.10"
+      - !ruby/object:Gem::Version
+        version: '3.10'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hoe
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *69349280
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &69349010 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 27
-        segments: 
-        - 2
-        - 12
-        version: "2.12"
+      - !ruby/object:Gem::Version
+        version: '2.13'
   type: :development
-  version_requirements: *id002
-description: |-
-  Unific is a ruby unification engine.
-  
+  prerelease: false
+  version_requirements: *69349010
+description: ! 'Unific is a ruby unification engine.
+
+
   A unification engine is an essential part of a logic programming environment
+
   (the whole logic programming environment this is taken from is available as
+
   the in-development Rulog[http://github.com/jimwise/rulog]] (Ruby With Logic)
+
   gem), but can also be useful on its own as a pattern matching engine which
-  can enforce consistency across multiple matches.
-email: 
+
+  can enforce consistency across multiple matches.'
+email:
 - jwise@draga.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - README.txt
-files: 
+files:
 - .autotest
 - History.txt
 - Manifest.txt
 - README.rdoc
 - README.txt
 - Rakefile
+- examples/database.rb
 - lib/unific.rb
 - test/test_unific.rb
 - .gemtest
 homepage: https://github.com/jimwise/unific
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.txt
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: unific
-rubygems_version: 1.8.13
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Unific is a ruby unification engine
-test_files: 
+test_files:
 - test/test_unific.rb