mini_kraken 0.1.0 → 0.1.01

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f848fb79ce89ce0d4ecc3dbd43a8f6418e24db5753cd15915a62cbbc83db827
-  data.tar.gz: ae3c3b778e21223a868f7e7668d805c699a9fd6fa8499b186845f526dcecf2ca
+  metadata.gz: e60a12ea5711e80f10de8f1a2c018199975fc83baeecab2d15fdb2ea6c6b91c3
+  data.tar.gz: 8fd4f903f896ac08e13f00881592b7e81e4684f7eb9acd2f7be9d4b03fee6a2d
 SHA512:
-  metadata.gz: aef145c2b4f7c7c5f9bdc75b5395c4a822c90298c70ea5cd36882519454c9314703aaec8bb7c1e6a2332c6290872a0e53b124807d54c0d46cee051c2fe13737d
-  data.tar.gz: f68d2ee935bcc35c9e25cd69c4de1b7cd10fc007991d4878a76c1aa1fad2e12524f46eec0c814ccada84e6f4efff89135a1a2a211db42988a2a1012ec63d9308
+  metadata.gz: e5f333b6bfbb58f2726c1351fa672c95c1b3b171c322411ce87617f0a4e748f8bab1beecb0a4fc035dc15ec9ae382d2b1dd3fcd59707a37402db33a12248a878
+  data.tar.gz: '0196ee55adc9516fa4cfcea24dd74ec33b061771e9c273543d648d00b1244038d6c945a95b76f44c1c7f02f853f92a32a541ea051d5d6d5facf9d307640a2e13'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+## [0.1.01] - 2020-03-01
+First code commit
+### Added
+- In `Core` module: `Facade`, `Fail`, `FormalArg`, `Goal`, `NullaryRelation`, `Publisher`, `Relation`, `RunStarExpression`, `Succeed`, `Variable`
+- 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

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dimitri Geshef
+
+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.

data/README.md

@@ -0,0 +1,39 @@
+# MiniKraken
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/mini_kraken`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mini_kraken'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mini_kraken
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/famished-tiger/mini_kraken.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/mini_kraken.rb

@@ -0,0 +1,6 @@
+require "mini_kraken/version"
+
+module MiniKraken
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/lib/mini_kraken/core/facade.rb

@@ -0,0 +1,45 @@
+require_relative 'variable'
+require_relative 'run_star_expression'
+
+module MiniKraken
+  module Core
+    class Facade
+      attr_reader :publisher
+      def initialize(aPublisher)
+        @publisher = aPublisher
+      end
+
+      def run_star(theVariables, aGoal)
+        tuple = build_tuple(theVariables)
+
+        expr = RunStarExpression.new(tuple, aGoal)
+        expr.run(publisher)
+      end
+
+      private
+
+      def build_tuple(theVariables)
+        tuple = nil
+        if theVariables.kind_of?(Array)
+          tuple = theVariables.map { |v| build_single_var(v) }
+        else
+          tuple = [build_single_var(theVariables)]
+        end
+
+        tuple
+      end
+
+      def build_single_var(aVar)
+        var = nil
+        case aVar
+          when Symbol
+            var = Variable.new(aVar.to_s)
+          when String
+            var = Variable.new(aVar)
+        end
+
+        var
+      end
+    end # class
+  end # module
+end # module

data/lib/mini_kraken/core/fail.rb

@@ -0,0 +1,18 @@
+require 'singleton'
+require_relative 'nullary_relation'
+
+module MiniKraken
+  module Core
+    class Fail < NullaryRelation
+      include Singleton
+      
+      def initialize
+        super('fail')
+      end
+      
+      def unify(aGoal, vars)
+        []
+      end
+    end # class
+  end # module
+end # module

data/lib/mini_kraken/core/formal_arg.rb

@@ -0,0 +1,6 @@
+module MiniKraken
+  module Core
+    class FormalArg
+    end # class
+  end # module
+end # module

data/lib/mini_kraken/core/goal.rb

@@ -0,0 +1,18 @@
+module MiniKraken
+  module Core
+    class Goal
+      attr_reader :relation
+
+      def initialize(aRelation, args)
+        @relation = aRelation
+      end
+      
+      def attain(aPublisher, vars)
+        aPublisher.broadcast_entry(self, vars)
+        outcome = relation.unify(self, vars)
+        aPublisher.broadcast_exit(self, vars, outcome)
+        outcome
+      end
+    end # class
+  end # module
+end # module

data/lib/mini_kraken/core/nullary_relation.rb

@@ -0,0 +1,12 @@
+require_relative 'relation'
+
+module MiniKraken
+  module Core
+    class NullaryRelation < Relation
+      def initialize(aName)
+        super(aName)
+        @tuple.freeze
+      end
+    end # class
+  end # module
+end # module

data/lib/mini_kraken/core/publisher.rb

@@ -0,0 +1,27 @@
+module MiniKraken
+  module Core
+    class Publisher
+      attr_reader :subscribers
+
+      def initialize
+        @subscribers = []
+      end
+      
+      def subscribe(aListener)
+        @subscribers << aListener
+      end
+      
+      def broadcast_entry(aGoal, variables)
+        subscribers.each do |subscr|
+          subscr.on_entry(aGoal, variables)
+        end
+      end
+      
+      def broadcast_exit(aGoal, variables, outcome)
+        subscribers.each do |subscr|
+          subscr.on_exit(aGoal, variables, outcome)
+        end      
+      end      
+    end # class
+  end # module
+end # module

data/lib/mini_kraken/core/relation.rb

@@ -0,0 +1,17 @@
+module MiniKraken
+  module Core
+    class Relation
+      attr_reader :name
+      attr_reader :tuple
+
+      def initialize(aName)
+        @name = aName
+        @tuple = []
+      end
+
+      def arity
+        tuple.size
+      end
+    end # class
+  end # module
+end # module

data/lib/mini_kraken/core/run_star_expression.rb

@@ -0,0 +1,34 @@
+module MiniKraken
+  module Core
+    class RunStarExpression
+      attr_reader :vars
+      attr_reader :goal
+
+      def initialize(theVariables, aGoal)
+        @vars = validated_vars(theVariables)
+        @goal = aGoal
+      end
+      
+      def run(aPublisher)
+        goal.attain(aPublisher, vars)
+      end
+
+      private
+
+      def validated_vars(theVariables)
+        variables = {} 
+        case theVariables
+          when Variable
+            variables[theVariables.name] = theVariables
+
+          when Array
+            theVariables.each { |v| variables[v.name] = v }
+          else
+            raise StandardError, "Invalid argument #{p theVariables}"
+        end
+        
+        variables
+      end
+    end # class
+  end # module
+end # module

data/lib/mini_kraken/core/succeed.rb

@@ -0,0 +1,8 @@
+require_relative 'nullary_relation'
+
+module MiniKraken
+  module Core
+    class Succeed < NullaryRelation
+    end # class
+  end # module
+end # module

data/lib/mini_kraken/core/variable.rb

@@ -0,0 +1,11 @@
+module MiniKraken
+  module Core
+    class Variable
+      attr_reader :name
+      
+      def initialize(aName)
+        @name = aName
+      end
+    end # class
+  end # module
+end # module

data/lib/mini_kraken/dsl/kraken_dsl.rb

@@ -0,0 +1,12 @@
+require_relative '../core/fail'
+require_relative '../core/goal'
+
+module MiniKraken
+  module DSL
+    module KrakenDSL
+      def fail
+        Core::Goal.new(Core::Fail.instance, [])
+      end
+    end # module
+  end # module
+end # module

data/lib/mini_kraken/version.rb

@@ -0,0 +1,3 @@
+module MiniKraken
+  VERSION = "0.1.01"
+end

data/mini_kraken.gemspec

@@ -0,0 +1,55 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mini_kraken/version"
+
+# Implementation module
+module PkgExtending
+  def self.pkg_files(aPackage)
+    file_list = Dir[
+      '.rspec',
+      '.travis.yml',
+      'Gemfile',
+      'Rakefile',
+      'CHANGELOG.md',      
+      'LICENSE.txt',
+      'README.md',
+      'mini_kraken.gemspec',
+      'bin/*.rb',
+      'lib/*.*',
+      'lib/**/*.rb',
+      'spec/**/*.rb'
+    ]
+    aPackage.files = file_list
+    aPackage.test_files = Dir['spec/**/*_spec.rb']
+    aPackage.require_path = 'lib'
+  end
+
+  def self.pkg_documentation(aPackage)
+    aPackage.rdoc_options << '--charset=UTF-8 --exclude="examples|spec"'
+    aPackage.extra_rdoc_files = ['README.md']
+  end
+end # module
+
+Gem::Specification.new do |spec|
+  spec.name          = "mini_kraken"
+  spec.version       = MiniKraken::VERSION
+  spec.authors       = ['Dimitri Geshef']
+  spec.email         = ['famished.tiger@yahoo.com']
+
+  spec.summary       = %q{Implementation of Minikanren language in Ruby. WIP}
+  spec.description   = %q{Implementation of Minikanren language in Ruby. WIP}
+  spec.homepage      = "https://github.com/famished-tiger/mini_kraken"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  
+  PkgExtending.pkg_files(spec)
+  PkgExtending.pkg_documentation(spec)  
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/core/facade_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper' # Use the RSpec framework
+
+require_relative '../../lib/mini_kraken/core/fail'
+require_relative '../../lib/mini_kraken/core/goal'
+require_relative '../../lib/mini_kraken/core/publisher'
+require_relative '../../lib/mini_kraken/dsl/kraken_dsl'
+# Load the class under test
+require_relative '../../lib/mini_kraken/core/facade' 
+
+module MiniKraken
+  module Core
+    describe Facade do
+      include DSL::KrakenDSL
+
+      let(:a_pub) { Publisher.new }
+      let(:a_relation) { Fail.instance }
+      subject { Facade.new(a_pub) }
+
+      context 'Initialization:' do
+        it 'could have one publisher argument' do
+          expect { Facade.new(a_pub) }.not_to raise_error
+        end
+        
+        it 'should know its publisher' do
+          expect(subject.publisher).to eq(a_pub)
+        end        
+      end # context
+
+      context 'Provided services:' do
+        it 'should support run* expression' do
+          expect(subject.run_star('q', fail)).to be_empty
+        end
+      end # context
+    end # describe
+  end # module
+end # module

data/spec/core/fail_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper' # Use the RSpec framework
+
+# Load the class under test
+require_relative '../../lib/mini_kraken/core/fail' 
+
+module MiniKraken
+  module Core
+    describe Fail do
+      subject { Fail.instance }
+
+      context 'Initialization:' do
+        it 'should have one instance' do
+          expect { Fail.instance }.not_to raise_error
+        end
+        
+        it 'should know its name' do
+          expect(subject.name).to eq('fail')
+        end
+      end # context
+
+      context 'Provided services:' do
+      end # context
+    end # describe
+  end # module
+end # module

data/spec/core/goal_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper' # Use the RSpec framework
+require_relative '../../lib/mini_kraken/core/fail'
+
+# Load the class under test
+require_relative '../../lib/mini_kraken/core/goal'
+
+module MiniKraken
+  module Core
+    describe Goal do
+      let(:a_relation) { Fail.instance }
+      subject { Goal.new(a_relation, []) }
+
+      context 'Initialization:' do
+        it 'should accept one goal and argument array' do
+          expect { Goal.new(a_relation, []) }.not_to raise_error
+        end
+
+        it 'should know its relation' do
+          expect(subject.relation).to eq(a_relation)
+        end
+      end # context
+
+      context 'Provided services:' do
+        it 'should attain its intended purpose' do
+          pub = double('fake-publisher')
+          expect(pub).to receive(:broadcast_entry).with(subject, [])
+          expect(pub).to receive(:broadcast_exit).with(subject, [], [])
+          expect(subject.attain(pub, [])).to eq([])
+        end
+      end # context
+    end # describe
+  end # module
+end # module

data/spec/core/run_star_expression_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper' # Use the RSpec framework
+
+require_relative '../../lib/mini_kraken/core/variable'
+require_relative '../../lib/mini_kraken/core/fail'
+require_relative '../../lib/mini_kraken/core/goal'
+# Load the class under test
+require_relative '../../lib/mini_kraken/core/run_star_expression' 
+
+module MiniKraken
+  module Core
+    describe RunStarExpression do
+      let(:a_var) { Variable.new('q') }
+      let(:a_relation) { Fail.instance }      
+      let(:a_goal) { Goal.new(a_relation, []) }
+      subject { RunStarExpression.new(a_var, a_goal) }
+
+      context 'Initialization:' do
+        it 'could have one variable and a goal' do
+          expect { RunStarExpression.new(a_var, a_goal) }.not_to raise_error
+        end
+        
+        it 'should know its variables' do
+          expect(subject.vars['q']).to eq(a_var)
+        end
+        
+        it 'should know its goal' do
+          expect(subject.goal).to eq(a_goal)
+        end        
+      end # context
+
+      context 'Provided services:' do
+        it 'should unify the variable(s) with the given goal' do
+          pub = double('fake-publisher')
+          expect(pub).to receive(:broadcast_entry).with(a_goal, subject.vars)
+          expect(pub).to receive(:broadcast_exit).with(a_goal, subject.vars, [])          
+          expect(subject.run(pub)).to be_empty
+        end      
+      end # context
+    end # describe
+  end # module
+end # module

data/spec/core/variable_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper' # Use the RSpec framework
+
+# Load the class under test
+require_relative '../../lib/mini_kraken/core/variable' 
+
+module MiniKraken
+  module Core
+    describe Variable do
+      subject { Variable.new('q') }
+
+      context 'Initialization:' do
+        it 'should be initialized with a name' do
+          expect { Variable.new('q') }.not_to raise_error
+        end
+        
+        it 'should know its name' do
+          expect(subject.name).to eq('q')
+        end
+      end # context
+
+      context 'Provided services:' do
+      end # context
+    end # describe
+  end # module
+end # module

data/spec/dsl/kraken_dsl_spec.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative '../spec_helper' # Use the RSpec framework
+
+# Load the class under test
+require_relative '../../lib/mini_kraken/dsl/kraken_dsl' 
+
+module MiniKraken
+  module DSL
+    describe KrakenDSL do
+      subject do 
+        obj = Object.new
+        obj.extend(KrakenDSL)
+      end
+
+      context 'Attaching mix-in:' do
+        it 'should extend object' do
+          obj = Object.new
+          expect { obj.extend(KrakenDSL) }.not_to raise_error
+        end
+      end # context
+
+      context 'Provided services:' do
+        it "should provide the 'fail' goal constructor" do
+          expect(subject.fail).to be_kind_of(Core::Goal)
+          expect(subject.fail.relation.name).to eq('fail')
+        end
+      end # context
+    end # describe
+  end # module
+end # module

data/spec/mini_kraken_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe MiniKraken do
+  it 'has a version number' do
+    expect(MiniKraken::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'bundler/setup'
+require 'rspec' # Use the RSpec framework
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |c|
+    # Disable the `should` syntax
+    c.syntax = :expect
+  end
+
+  # Display stack trace in case of failure
+  config.full_backtrace = true
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_kraken
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.01
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-05 00:00:00.000000000 Z
+date: 2020-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,19 +52,50 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Write a longer description or delete this line.
+description: Implementation of Minikanren language in Ruby. WIP
 email:
 - famished.tiger@yahoo.com
 executables: []
 extensions: []
-extra_rdoc_files: []
-files: []
+extra_rdoc_files:
+- README.md
+files:
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mini_kraken.rb
+- lib/mini_kraken/core/facade.rb
+- lib/mini_kraken/core/fail.rb
+- lib/mini_kraken/core/formal_arg.rb
+- lib/mini_kraken/core/goal.rb
+- lib/mini_kraken/core/nullary_relation.rb
+- lib/mini_kraken/core/publisher.rb
+- lib/mini_kraken/core/relation.rb
+- lib/mini_kraken/core/run_star_expression.rb
+- lib/mini_kraken/core/succeed.rb
+- lib/mini_kraken/core/variable.rb
+- lib/mini_kraken/dsl/kraken_dsl.rb
+- lib/mini_kraken/version.rb
+- mini_kraken.gemspec
+- spec/core/facade_spec.rb
+- spec/core/fail_spec.rb
+- spec/core/goal_spec.rb
+- spec/core/run_star_expression_spec.rb
+- spec/core/variable_spec.rb
+- spec/dsl/kraken_dsl_spec.rb
+- spec/mini_kraken_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/famished-tiger/mini_kraken
 licenses:
 - MIT
 metadata: {}
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- --charset=UTF-8 --exclude="examples|spec"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -81,5 +112,12 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
-test_files: []
+summary: Implementation of Minikanren language in Ruby. WIP
+test_files:
+- spec/core/facade_spec.rb
+- spec/core/fail_spec.rb
+- spec/core/goal_spec.rb
+- spec/core/run_star_expression_spec.rb
+- spec/core/variable_spec.rb
+- spec/dsl/kraken_dsl_spec.rb
+- spec/mini_kraken_spec.rb