mini_kraken 0.2.00 → 0.3.00

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bbfe3d58d4c7271a5c8a54486a743c51d6fddcb3b068095cad44cacad575c83
-  data.tar.gz: 012b412a95752592b5be70859e00d94b379e2c4c564d37d932a300a03cbc9716
+  metadata.gz: ceccf4c9ffeb71fc8759bbf1ea1db003d83e9e150df95793de7e729716c9538d
+  data.tar.gz: bab9d4b22a86eec0fcd95955a799a40bfd51c032d05a56b5c2569e0e833b4d2d
 SHA512:
-  metadata.gz: 952d93b01de392c7168e7cfb4a3cc911e4d1b53be11a4a10d67012bb4ab4a8f69aa42f41bf13a756f89a6d09eb775a5594174d73334c57c2230039b7991e89fd
-  data.tar.gz: a60adbd5da627495badab63de355336f131a5e599c40226931366a7c1b4a349b2542ccb55cf30ef8e60990341c1f5d8547804b1552fbbbc504bd1bed40a36d9e
+  metadata.gz: 5b8dac966209d3209419b2721c67ecd9ec1d1985b0a457877def4e9eda3a305b6952d996e1791436db33f863a046553df1567ef142fc7fe6d5d8092b7d0e2ecd
+  data.tar.gz: 5c99a985287a32d2e6a2c6dbbcabeaea07203e533372183817660eb2259edda6465b4993997b9dcb8dd0db59e0b69772f31409f17a587a3d55381d7f06151a74

data/.rubocop.yml

@@ -0,0 +1,334 @@
+AllCops:
+  Exclude:
+    - 'exp/**/*'
+
+Layout/ArgumentAlignment:
+  Enabled: false
+
+Layout/ArrayAlignment:
+  Enabled: true
+  EnforcedStyle: with_fixed_indentation
+
+Layout/CaseIndentation:
+  Enabled: false
+
+Layout/ClosingHeredocIndentation:
+  Enabled: false
+
+Layout/CommentIndentation:
+  Enabled: false
+
+Layout/ElseAlignment:
+  Enabled: false
+
+Layout/EmptyLines:
+  Enabled: false
+
+Layout/EndAlignment:
+  Enabled: false
+
+Layout/EndOfLine:
+  Enabled: true
+  EnforcedStyle: lf
+
+Layout/FirstArgumentIndentation:
+  Enabled: false
+
+Layout/IndentationWidth:
+  Enabled: false
+
+Layout/IndentationConsistency:
+  Enabled: true
+
+Layout/HeredocIndentation:
+  Enabled: false
+
+Layout/MultilineHashBraceLayout:
+  Enabled: true
+  
+Layout/MultilineMethodCallBraceLayout:
+  Enabled: true
+  EnforcedStyle: same_line  
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+
+Layout/SpaceInsideParens:
+  Enabled: true
+
+Layout/IndentationStyle:
+  Enabled: true
+  
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Layout/TrailingEmptyLines:
+  Enabled: true
+
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Lint/Loop:
+  Enabled: true
+  
+Lint/RaiseException:
+  Enabled: true
+
+Lint/RescueException:
+  Enabled: true
+  
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/UnusedMethodArgument:
+  Enabled: true
+
+Lint/UselessAccessModifier:
+  Enabled: true
+
+Lint/Void:
+  Enabled: false
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: true
+  Max: 350
+  
+Metrics/BlockNesting:
+  Enabled: true
+  Max: 5
+
+Metrics/ClassLength:
+  Enabled: true
+  Max: 350
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Layout/LineLength:
+  Enabled: false
+  Max: 90
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 50
+
+Metrics/ModuleLength:
+  Enabled: true
+  Max: 500
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/ConstantName:
+  Enabled: false
+
+Naming/ClassAndModuleCamelCase:
+  Enabled: false
+
+Naming/BlockParameterName:
+  Enabled: true
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/VariableName:
+  Enabled: false
+
+Style/Alias:
+  Enabled: true
+
+Layout/HashAlignment:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/BarePercentLiterals:
+  Enabled: false
+
+Style/BlockComments:
+  Enabled: false
+
+Style/CharacterLiteral:
+  Enabled: false
+
+Style/ClassCheck:
+  Enabled: false
+
+Style/ClassVars:
+  Enabled: false
+
+Style/ColonMethodCall:
+  Enabled: false
+
+Style/CommentAnnotation:
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/DefWithParentheses:
+  Enabled: true
+
+Style/Documentation:
+  Enabled: false
+
+Style/ExpandPathArguments:
+  Enabled: false
+  
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/GuardClause:
+  Enabled: false
+  
+Style/HashEachMethods:
+  Enabled: true
+  
+Style/HashTransformKeys:
+  Enabled: true
+  
+Style/HashTransformValues:
+  Enabled: true
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/InverseMethods:
+  Enabled: true
+  
+Style/MissingRespondToMissing:  
+  Enabled: false
+
+Style/Next:
+  Enabled: false
+
+Style/NumericLiterals:
+  Enabled: false
+
+Style/RaiseArgs:
+  Enabled: true
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: true
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/StderrPuts:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+
+Style/TernaryParentheses:
+  Enabled: false
+
+Style/UnlessElse:
+  Enabled: false
+  
+# Rubocop complains when it doesn't find an explicit setting for the following cops:
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/UnreachableLoop:
+  Enabled: true
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ExplicitBlockArgument:
+  Enabled: true
+
+Style/GlobalStdStream:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/OptionalBooleanParameter:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,53 @@
+## [0.3.00] - 2020-12-16
+- Version number bump because this is a vast code rewrite
+
+### CHANGED
+- Most classes have been reworked
+- Relation `Equals` has been renamed to `Unify`
+
+## [0.2.04] - 2020-09-02
+- Intermediate version before vast code rework.
+
+### CHANGED
+- Classes `KBoolean`, `KSymbol`, `KInteger` moved to namespace `Atomic`
+- Classes `ConsCell`, `ConsCellVisitor` moved to namespace `Composite`
+- Class `Variable` renamed to `LogVar`
+- Class `VariableRef` renamed to `LogVarRef`
+
+## [0.2.03] - 2020-09-02
+- The DSL (Domain Specific Language) supports the `caro` relation & passes frames up to 2-8 from Chapter 2.
+
+### NEW
+- Class `ConsCellVisitor`. Its method `df_visitor` builds a Fiber that walks over a ConsCell (list/graph).
+- Method `Outcome#failure?`
+- Method `Outcome#prune!` for removing associations of transient variables.
+- Method `VariableRef#to_s` for providing a text representation of a variable reference
+- Method `Vocabulary#prune` for removing associations of transient variables.
+- Class `FreshEnvFactory` as its name implies, is used to build `FreshEnv` instances.
+
+### CHANGED
+- Method `Outcome#successful?` renamed to `Outcome#success?`
+
+### FIXED
+- Method `Equals#solver_for` now prunes associations of transient variables.
+- Method `Equals#unify_composite_terms` now copes with Conscell vs. VariableRef unification.
+
+## [0.2.02] - 2020-08-08
+- The DSL (Domain Specific Language) now supports `conde` and passes all examples from Chapter 1.
+
+### NEW
+- Method`Glue::DSL#conde` to implement conde goals.
+- Method `KBoolean#to_s` returns a text representation of a boolean value.
+
+## [0.2.01] - 2020-08-07
+- The DSL (Domain Specific Language) now supports `defrel` and boolean literals.
+
+### CHANGED
+- Constructor `DefRelation#initialize` now freezes any new class instance.  
+- Constructor `GoalTemplate#initialize` now freezes any new class instance.  
+- Mixin module `Glue::DSL` new method `defrel` to build custom relations.
+- File `.rubocop.yml` to please Rubocop 0.89
+
 ## [0.2.00] - 2020-07-12
 - First release of DSL (Domain Specific Language)
 - Fix defect for fused variables that remain fresh

data/README.md

@@ -4,10 +4,9 @@
 [![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__ ?   
-A library containing an implementation 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.   
+A library containing an implementation in Ruby of the [miniKanren](http://minikanren.org/) 
+ language.
+*miniKanren* is a small language for relational (logic) programming as defined in 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.
 
@@ -15,6 +14,7 @@ ISBN: 9780262535519, (2018), MIT Press.
 - Pure Ruby implementation, not a port from another language
 - Object-Oriented design
 - No runtime dependencies
+- Test suite patterned on the examples from the reference book.
 
 ### miniKanren Features
 - [X] ==  
@@ -23,19 +23,19 @@ ISBN: 9780262535519, (2018), MIT Press.
 - [X] conde
 - [X] conj2  
 - [X] disj2
-- [X] defrel   
+- [X] defrel  
+- [X] caro
+- [X] cdro
 
 ### TODO
 
 - [ ] Occurs check
 
 List-centric relations from Chapter 2
-- [ ] caro
-- [ ] cdro
-- [ ] conso
-- [ ] nullo
-- [ ] pairo
-- [ ] singletono
+- [ ] conso  
+- [ ] nullo  
+- [ ] pairo  
+- [ ] singletono  
 
 ## Installation
 
@@ -65,7 +65,7 @@ require 'mini_kraken' # Load MiniKraken library
 
 extend(MiniKraken::Glue::DSL) # Add DSL method to self (object in context)
 
-result = run_star('q', equals(q, :pea))
+result = run_star('q', unify(q, :pea))
 puts result # => (:pea)
 ```
 
@@ -73,17 +73,17 @@ The two first lines in the above code snippet are pretty standard:
 - The first line loads the `mini_kraken` library.
 - The second line add the DSL methods to the current object.
 
-The next line constitutes a trivial `miniKanren` program.
-The aim of a `miniKanren` program is to find one or more solutions involving provided variable(s)
-and satisfying one or more goals.
+The next line constitutes a trivial `miniKanren` program.  
+The aim of a `miniKanren` program is to find one or more solutions involving the given logical variable(s)
+and satisfying one or more goals to the `run_star method.  
 In our example, the `run_star` method instructs `MiniKraken` to find all solutions,  
 knowing that each successful solution:
 - binds a value to the provided variable `q` and
-- meets the goal `equals(q, :pea)`.
+- meets the goal `unify(q, :pea)`.
 
-The goal `equals(q, :pea)` succeeds because the logical variable `q` is _fresh_ (that is,
+The goal `unify(q, :pea)` succeeds because the logical variable `q` is _fresh_ (that is,
   not yet bound to a value) and will be bound to the symbol `:pea` as a side effect
-  of the goal `equals`.
+  of the goal `unify`.
 
 So the above program succeeds and the only found solution is obtained by binding
  the variable `q` to the value :pea. Hence the result of the `puts` method.
@@ -97,11 +97,12 @@ So the above program succeeds and the only found solution is obtained by binding
  extend(MiniKraken::Glue::DSL) # Add DSL method to self (object in context)
 
  # Following miniKanren program fails
- result = run_star('q', [equals(q, :pea), equals(q, :pod)])
+ result = run_star('q', [unify(q, :pea), unify(q, :pod)])
  puts result # => ()
  ```
 In this example, we learn that `run_star` can take multiple goals placed in an array.
-The program fails to find a solution since it is not possible to satisfy the two `equals` goals simultaneously. In that case, the `run_star` return an empty list represented as `()` in the output.
+The program fails to find a solution since it is not possible to satisfy the two `unify` goals simultaneously.  
+In case of failure, the `run_star` returns an empty list represented as `()` in the output.
 
 
 ### Example 3
@@ -110,7 +111,7 @@ The program fails to find a solution since it is not possible to satisfy the two
 ```ruby
 # In this example and following, one assumes that DSL is loaded as shown in Example 1
 
-result = run_star(['x', 'y'], [equals(:hello, x), equals(y, :world)])
+result = run_star(['x', 'y'], [unify(:hello, x), unify(y, :world)])
 puts result # => ((:hello :world))
 ```
 
@@ -121,13 +122,14 @@ This time, `run_star` takes two logical variables -`x` and `y`- and successfully
  ```ruby
  result = run_star(['x', 'y'],
                    [
-                     disj2(equals(x, :blue), equals(x, :red)),
-                     disj2(equals(y, :sea), equals(:mountain, y))
+                     disj2(unify(x, :blue), unify(x, :red)),
+                     disj2(unify(y, :sea), unify(:mountain, y))
                    ])
  puts result # => ((:blue :sea) (:blue :mountain) (:red :sea) (:red :mountain))
  ```
 
- Here, `run_star` takes two logical variables and two `disj2` goals. A `disj2` succeeds if any of its arguments succeeds.
+ Here, `run_star` takes two logical variables and two `disj2` goals.  
+ A `disj2` succeeds if any of its arguments succeeds.  
  This program finds four distinct solutions for x, y pairs.
 
 ## Development