mini_kraken 0.1.03 → 0.1.08

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba23145a960593f3910547ace544235fcf3f9c9f5ee45b593e3aa465231e37fe
-  data.tar.gz: f2e1e6371cb9873192fece615acc2a6bd9021c5e7f8b1865b4a108ab414d5e8e
+  metadata.gz: 32a6f92773457338343dffa1343906883ffdbafbf7f8fd9ace170062cc34d345
+  data.tar.gz: cb7d3e6b88f8bea952bea7f214eaf73af97857de6958f65592a15b7ee7ef2510
 SHA512:
-  metadata.gz: 0d8c08206038cb1b1d0fe339ace8f5ee4bcb9a91afb10447b8bc15624253774fcfd8fd1e1c4b07faa687fc2f5071bd4e46db0bcc2323044f2d36222db9906e80
-  data.tar.gz: 9f55752adc900a4cfa9aa82906aab0c513f3cf35918c7a50e170ce16201fad8dc471e2f364efaaa9f8db935f35b18bbb12e4af1ef4a74d297f03f54dfc92eda3
+  metadata.gz: db730590bcc99203f8983fe19b5e0d0b90c77819c07875bc34c100bc843c9b3e5e3e148833149d3264847a190cc9ce5bcf1fa31f74723b8c8e8006a56948d738
+  data.tar.gz: 4cb5cb8f327e7cb81028621ad67e36afecee8bc90beac1cd6449573b85092191d39d55dfbe2de9f52a5868a66bf4c8288a3223b41815528fb651eead36d3f4fa

data/.travis.yml

@@ -3,5 +3,9 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.6.3
+  - 2.7.1
+  - 2.6.6
+  - 2.5.8
+  - 2.4.10
+  - jruby-head
 before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -1,6 +1,60 @@
+## [0.1.08] - 2020-05-30
+- Fix of nasty bug (object aliasing) that caused flaky failures in specs.
+
+### FIXED
+- `DuckFiber#resume` each call returns a distinct `Outcome` instance when successful.
+
+## [0.1.07] - 2020-05-23
+- Implementation of `disj2` (two arguments disjunction - or -)
+
+### New
+- Class `Disj2` as subclass of `GoalRelation` that implements the disjunction of two subgoals
+
+### CHANGED
+- Class `Disj2`: common code with `Conj2` class factored out to superclass `GoalRelation`
+- File `cons_cell.rb`: prevent multiple inclusions via different requires
+- Method `Vocabulary#ancestor_walker` now returns an `Enumerator` instead of a `Fiber`.
+
+### FIXED
+- Method `RunStarExpression#run` clear associations and rankings for second and consecutive solmutions
+
+
+## [0.1.06] - 2020-05-20
+- Implementation of `conj2` (two arguments conjunction - and -)
+
+### New
+- Class `CompositeGoal`
+- Class `Conj2` as subclass of `GoalRelation` that implements the conjunction of two subgoals
+- Mixin module `Designation` to factor out the common methods in `Variable` and `VariableRef` classes
+- Class `GoalArg` abstract class, that is a generalization for anything that be be argument of a goal.
+- Class `GoalRelation` as subclass of `Relation`. A goal that is linked to a such relation may have goals as its arguments only.
+
+### Changed
+- Class `Goal` is new subclass of class `GoalArg`. Therefore a goal can be an argument to another goal.
+- Class `Term` is new subclass of class `GoalArg`. Therefore a term can be an argument of a goal.
+- Classes `Variable`, `VariableRef` now include mix-in module `Designation`
+- File `cd_implementation.txt` Updated with changes of class relationship
+
+## [0.1.05] - 2020-05-09
+- Changed implementation of fused variables  
+- Magic comments for frozen string literal
+- Code re-styling to please Rubocop 0.82
+
+### Changed
+- File `README.md` Added "What is mini_kraken" text.
+- File `README.md` Added badges (CI Travis build status, Gem version, license)
+
+## [0.1.04] - 2020-05-02
+### Changed
+- File `README.md` Added "What is mini_kraken" text.
+- File `README.md` Added badges (CI Travis build status, Gem version, license)
+
 ## [0.1.03] - 2020-05-01
 Passes all frames 1:1 up to 1:47 of "Reasoned Schemer" book
 
+### Fixed
+- Fresh variables are now correctly 'reified' according to the convention in "Reasoned Schemer".
+
 ## [0.1.02] - 2020-04-28
 Major code refactoring. Passes all frames 1:1 up to 1:36 of "Reasoned Schemer" book
 
@@ -11,9 +65,6 @@ First code commit
 - File `CHANGELOG.md`. This file. Adopting `keepachangelog.com` recommended format.
 - File `min_kraken.gemspec` Updated gem description.
 
-### Changed
-- File `README.md` added badges (Appveyor build status, Gem version, license)
-
 ## [0.1.0] - 2020-02-05
 ### Added
 - Initial Github commit as new project

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mini_kraken.gemspec
 gemspec

data/README.md

@@ -1,5 +1,26 @@
 # MiniKraken
-
+[![Build Status](https://travis-ci.org/famished-tiger/mini_kraken.svg?branch=master)](https://travis-ci.org/famished-tiger/mini_kraken)
+[![Gem Version](https://badge.fury.io/rb/mini_kraken.svg)](https://badge.fury.io/rb/mini_kraken)
+[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](https://github.com/famished-tiger/mini_kraken/blob/master/LICENSE.txt)
+
+### What is __mini_kraken__ ?   
+An implemention of the [miniKanren](http://minikanren.org/) relational programming language in Ruby.
+*miniKanren* is a small language for relational (logic) programming.  
+Based on the reference implementation, in Scheme from the "The Reasoned Schemer" book.  
+Daniel P. Friedman, William E. Byrd, Oleg Kiselyov, and Jason Hemann: "The Reasoned Schemer", Second Edition,
+ISBN: 9780262535519, (2018), MIT Press.
+
+### Features
+- [X] ==  
+- [X] run\*  
+- [X] fresh 
+- [X] conj2  
+- [X] disj2  
+
+### TODO
+- [ ] defrel 
+- [ ] conde  
+- [ ] Occurs check
 
 ## Installation
 

data/Rakefile

@@ -1,6 +1,8 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/mini_kraken.rb

@@ -1,4 +1,6 @@
-require "mini_kraken/version"
+# frozen_string_literal: true
+
+require 'mini_kraken/version'
 
 module MiniKraken
   class Error < StandardError; end

data/lib/mini_kraken/core/any_value.rb

@@ -1,31 +1,33 @@
+# frozen_string_literal: true
+
 module MiniKraken
   module Core
     class AnyValue
       attr_reader :rank
-      
+
       # @param aName [String]
       # @param anEnv [Vocabulary]
       def initialize(aName, anEnv, alternate_names = [])
         @rank = anEnv.get_rank(aName, alternate_names)
       end
-      
+
       def ==(other)
         rank == other.rank
       end
-      
+
       # Use same text representation as in Reasoned Schemer.
       def to_s
         "_#{rank}"
       end
-      
+
       def ground?(_env)
         false
       end
-      
+
       # @return [AnyValue]
       def quote(_env)
         self
-      end      
+      end
     end # class
   end # module
-end # module
+end # module

data/lib/mini_kraken/core/association.rb

@@ -1,21 +1,34 @@
+# frozen_string_literal: true
+
 module MiniKraken
   module Core
     # A record that a given vairable is associated with a value.
     class Association
-      # @return [String] name of the variable beig association the value.
-      attr_reader :var_name
-      
+      # @return [String] internal name of variable being associated the value.
+      attr_accessor :i_name
+
       # @return [Term] the MiniKraken value associated with the variable
       attr_reader :value
-      
-      
+
+
       # @param aVariable [Variable, String] A variable or its name.
       # @param aValue [Term] value being associated to the variable.
       def initialize(aVariable, aValue)
-        @var_name = aVariable.respond_to?(:name) ? aVariable.name : aVariable
+        a_name = aVariable.respond_to?(:name) ? aVariable.i_name : aVariable
+        @i_name = validated_name(a_name)
         @value = aValue
       end
-      
+
+      private
+
+      def validated_name(aName)
+        raise StandardError, 'Name cannot be nil' if aName.nil?
+
+        cleaned = aName.strip
+        raise StandardError, 'Name cannot be empty or consists of spaces' if cleaned.empty?
+
+        cleaned
+      end
     end # class
   end # module
 end # module

data/lib/mini_kraken/core/association_walker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 require_relative 'atomic_term'
 require_relative 'composite_term'
@@ -23,6 +25,7 @@ module MiniKraken
       def walk_assocs(assocs, anEnv)
         # Treat easy cases first...
         return nil if assocs.empty?
+
         assoc_atomic = assocs.find { |assc| assc.value.kind_of?(AtomicTerm) }
         return assoc_atomic.value if assoc_atomic
 
@@ -43,6 +46,7 @@ module MiniKraken
 
       def walk_value(aTerm, anEnv)
         return aTerm if aTerm.kind_of?(AtomicTerm) || aTerm.kind_of?(AnyValue)
+
         result = nil
 
         if aTerm.kind_of?(CompositeTerm)
@@ -176,4 +180,4 @@ module MiniKraken
       end
     end # class
   end # module
-end # module
+end # module

data/lib/mini_kraken/core/atomic_term.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'term'
 require_relative 'freshness'
 
@@ -22,14 +24,14 @@ module MiniKraken
       def freshness(_env)
         Freshness.new(:ground, self)
       end
-      
+
       # An atomic term is a ground term: by definition it doesn't contain
       # any fresh variable.
       # @param _env [Vocabulary]
       # @return [FalseClass]
       def fresh?(_env)
         false
-      end      
+      end
 
       # An atomic term is a ground term: by definition it doesn't contain
       # any fresh variable.
@@ -61,4 +63,4 @@ module MiniKraken
       end
     end # class
   end # module
-end # module
+end # module

data/lib/mini_kraken/core/binary_relation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'relation'
 require_relative 'composite_term'
 
@@ -5,20 +7,20 @@ module MiniKraken
   module Core
     class BinaryRelation < Relation
       # @param aName [String] Name of the relation.
-      # @param alternateName [String, NilClass] Alternative name (optional).    
+      # @param alternateName [String, NilClass] Alternative name (optional).
       def initialize(aName, alternateName = nil)
         super(aName, alternateName)
         freeze
       end
-      
+
       # Number of arguments for the relation.
       # @return [Integer]
       def arity
         2
       end
-      
+
       protected
-      
+
       # table: Commute
       # |arg1                | arg2               | arg2.ground? || Commute |
       # | isa? Atomic        | isa? Atomic        | dont_care    || Yes     |
@@ -55,7 +57,7 @@ module MiniKraken
         else
           [arg1, arg2]
         end
-      end      
+      end
     end # class
   end # module
-end # module
+end # module

data/lib/mini_kraken/core/composite_goal.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'environment'
+
+module MiniKraken
+  module Core
+    class CompositeGoal
+      # @return [Operator] The operator corresponding to this goal
+      attr_reader :operator
+
+      # @return [Array<Goal>] The child goals (sub-goals)
+      attr_reader :children
+
+      # @param anOperator [Operator] The operator corresponding to this goal
+      # @param theChildren [Array<Goal>] The child goals (sub-goals)
+      def initialize(anOperator, theChildren)
+        @operator = anOperator
+        @children = validated_children(theChildren)
+      end
+
+      # Attempt to achieve the goal for a given context (environment)
+      # @param anEnv [Environment] The context in which the goal take place.
+      # @return [Fiber<Outcome>] A Fiber object that will generate the results.
+      def attain(anEnv)
+        operator.solver_for(children, anEnv)
+      end
+
+      private
+
+      def validated_children(theChildren)
+        my_arity = operator.arity
+        if args.size != my_arity
+          err_msg = "Goal has #{theChildren.size} arguments, expected #{my_arity}"
+          raise StandardError, err_msg
+        end
+
+        prefix = 'Invalid goal argument '
+        theChildren.each do |subg|
+          raise StandardError, prefix + subg.to_s unless subg.kind_of?(Goal)
+        end
+
+        theChildren.dup
+      end
+    end # class
+  end # module
+end # module

data/lib/mini_kraken/core/composite_term.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'term'
 require_relative 'freshness'
 
@@ -6,17 +8,18 @@ module MiniKraken
     # An composite term is an Minikraken term that can be
     # decomposed into simpler MiniKraken data value(s).
     class CompositeTerm < Term
-
+      # Abstract method (to override). Return the child terms.
+      # @return [Array<Term>]
       def children
         raise NotImplementedError, 'This method must re-defined in subclass(es).'
       end
 
       # A composite term is fresh when all its members are nil or all non-nil members
       # are all fresh
-      # A composite term is bound when it is not fresh and not ground      
+      # A composite term is bound when it is not fresh and not ground
       # A composite term is a ground term when all its non-nil members are ground.
       # @param _env [Vocabulary]
-      # @return [Freshness]      
+      # @return [Freshness]
       def freshness(_env)
          env.freshness_composite(self)
       end
@@ -33,22 +36,6 @@ module MiniKraken
           child.nil? || child.ground?(anEnv)
         end
       end
-
-      # # Data equality testing
-      # # @return [Boolean]
-      # def ==(other)
-        # if other.respond_to?(:value)
-          # value == other.value
-        # else
-          # value == other
-        # end
-      # end
-
-      # # Type and data equality testing
-      # # @return [Boolean]
-      # def eql?(other)
-        # (self.class == other.class) && value.eql?(other.value)
-      # end
     end # class
   end # module
-end # module
+end # module

data/lib/mini_kraken/core/conj2.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'singleton'
+require_relative 'duck_fiber'
+require_relative 'goal'
+require_relative 'goal_relation'
+require_relative 'outcome'
+
+unless MiniKraken::Core.constants(false).include? :Conj2
+  module MiniKraken
+    module Core
+      # The conjunction is a relation that accepts only goal(s) as its two
+      # arguments. It succeeds if and only both its goal arguments succeeds.
+      class Conj2 < GoalRelation
+        include Singleton
+
+        def initialize
+          super('conj2', nil)
+        end
+
+        # @param actuals [Array<Term>] A two-elements array
+        # @param anEnv [Vocabulary] A vocabulary object
+        # @return [Fiber<Outcome>] A Fiber that yields Outcomes objects
+        def solver_for(actuals, anEnv)
+          g1, g2 = *validated_args(actuals)
+          Fiber.new { conjunction(g1, g2, anEnv) }
+        end
+
+        # Yields [Outcome, NilClass] result of the conjunction
+        # @param g1 [Goal] First goal argument
+        # @param g2 [Goal] Second goal argument
+        # @param voc [Vocabulary] A vocabulary object
+        def conjunction(g1, g2, voc)
+          # require 'debug'
+          outcome1 = nil
+          outcome2 = nil
+          if g1.relation.kind_of?(Fail) || g2.relation.kind_of?(Fail)
+            Fiber.yield Outcome.new(:"#u", voc)
+          else
+            f1 = g1.attain(voc)
+            loop do
+              outcome1 = f1.resume
+              break unless outcome1
+
+              outcome1.parent = voc unless outcome1.parent
+              if outcome1.successful?
+                f2 = g2.attain(outcome1)
+                loop do
+                  outcome2 = f2.resume
+                  break unless outcome2
+
+                  outcome2.parent = voc unless outcome2.parent
+                  if outcome2.successful?
+                    res = Outcome.new(:"#s", voc)
+                    res.merge(outcome1)
+                    res.merge(outcome2)
+                    Fiber.yield res
+                  else
+                    Fiber.yield outcome2
+                  end
+                  outcome2.clear
+                end
+              else
+                Fiber.yield outcome1
+              end
+              voc.clear if outcome1&.successful? && outcome2&.successful?
+            end
+          end
+
+          Fiber.yield nil
+        end
+      end # class
+
+      Conj2.instance.freeze
+    end # module
+  end # module
+end # unless