mementus 0.8.3 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 977daae88c6a50f8ef9c5eeb3252be9670cb44c8eb6bf92fe9dad743e65c919d
-  data.tar.gz: 3ae3cc0e01f47d60bbfa5902e51c039af30958890ec2ddc389ac32f4678431af
+  metadata.gz: afc99c828f6a40d32923b70744019aaad68acac8ee3fdd40ab24d02ab1306826
+  data.tar.gz: 64067ea27ebc0ab1a8a8da6c39b9dabff5449c3a697a15a3457a5b2ed1683f0e
 SHA512:
-  metadata.gz: 974136a95ddb6515ad23d95f8315ce95dccf5efc1796603555edaa68edf234ac7ab93bf16605624be729f3cf98f756cc12f5365b04be7974b7dfbaab849926a0
-  data.tar.gz: 923891dbdf9bf495923724f58d96bd5e8d75a13577f4ea78dcebe26fa5b9503e2a80aa674f203e845def7a4c2a524678ad95f9fb87345f1105cad90aeefa05ce
+  metadata.gz: e600708448a1075bab05dca419b446a6af1fa2fd101a45805155580fbadee8489e8243ec4229d8e4dbdba755a87bc2d61906214638c1d017aa81562cf4504a16
+  data.tar.gz: 4852dfae2d84d5e984c61de8655d0e503c9247b4acb80c9ed3ba58abbacf1a8d3d907ca557412251a09e0b4777f24054a547c331f95378a7fa4ef60079137461

data/.github/workflows/ruby.yml

@@ -0,0 +1,26 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      #uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.7
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rspec

data/README.md

@@ -1,6 +1,15 @@
 # Mementus
 
-[![Build Status](https://travis-ci.org/maetl/mementus.svg?branch=master)](https://travis-ci.org/maetl/mementus)
+[![Build Status](https://img.shields.io/github/workflow/status/maetl/mementus/Ruby)](https://github.com/maetl/mementus/actions/workflows/ruby.yml)
+[![Gem Version](https://img.shields.io/gem/v/mementus)](https://rubygems.org/gems/mementus)
+
+In-memory graph computing library for Ruby.
+
+## Install
+
+```
+gem install mementus
+```
 
 ## License
 

data/lib/mementus.rb

@@ -26,3 +26,6 @@ require 'mementus/graph_builder'
 require 'mementus/node_builder'
 require 'mementus/edge_builder'
 require 'mementus/direction'
+require 'mementus/model/type'
+require 'mementus/model/validator'
+require 'mementus/model/value'

data/lib/mementus/model/type.rb

@@ -0,0 +1,9 @@
+module Mementus
+  module Model
+    module Type
+      # A placeholder for dynamically typed attributes that accept anything
+      class Any
+      end
+    end
+  end
+end

data/lib/mementus/model/validator.rb

@@ -0,0 +1,37 @@
+module Mementus
+  module Model
+    # Checks values plugged into each slot and runs any required validations
+    # (validations not yet implemented).
+    #
+    # Current design raises errors rather than returns a boolean result.
+    class Validator
+      # @param fields_spec [Hash] defines the slots in the schema to validate against
+      def initialize(fields_spec)
+        @spec = fields_spec
+      end
+
+      # Checks a given set of fields to see if they match the specification.
+      #
+      # Raises an error when the given fields are invalid.
+      def check(fields)
+        missing_fields = @spec.keys.difference(fields.keys)
+
+        if missing_fields.any?
+          missing_fields.each do |field|
+            raise "wrong number of args" unless @spec[field].eql?(Type::Any)
+          end
+        end
+
+        mismatching_fields = fields.keys.difference(@spec.keys)
+
+        raise "key does not exist" if mismatching_fields.any?
+
+        fields.each do |(field, value)|
+          raise "wrong data type" unless value.is_a?(@spec[field]) || @spec[field].eql?(Type::Any)
+        end
+
+        true
+      end
+    end
+  end
+end

data/lib/mementus/model/value.rb

@@ -0,0 +1,62 @@
+module Mementus
+  module Model
+    # Value object with comparison by value equality.
+    #
+    # This is a wrapper class, used as a factory for generating instances of
+    # Ruby structs that wraps the Struct constructor with method advice
+    # to handle validation (and eventually type coercion if needed).
+    class Value
+      def self.new(*slots, **fields, &block)
+        define(*slots, **fields, &block)
+      end
+
+      def self.define(*slots, **fields, &block)
+        # Cannot define a Value without specifying slots or fields
+        if slots.empty? && fields.empty?
+          raise ArgumentError.new("missing attribute definition")
+        end
+
+        # Build and validate an attribute specification matching the stdlib
+        # constructor convention
+        slots_spec, fields_spec = if fields.any?
+          raise ArgumentError.new("cannot use slots when field map is supplied") if slots.any?
+          [fields.keys, fields]
+        else
+          [slots, Hash[slots.map { |s| [s, Type::Any]}]]
+        end
+
+        validator = Validator.new(fields_spec)
+
+        # Define a new struct with the given specification of attributes
+        struct = Struct.new(*slots_spec, keyword_init: true, &block)
+
+        # Method advice wrapping the stdlib constructor
+        struct.define_method :initialize do |*args, **kwargs|
+
+          # Handles the original stdlib API of slot-based args if you really
+          # must do things this way. The keyword args API is the preferred
+          # approach.
+          attr_values = if args.any?
+            raise ArgumentError.new("cannot mix slots and kwargs") if kwargs.any?
+            Hash[slots.zip(args)]
+          else
+            kwargs
+          end
+
+          # Check that the provided values match the defined attributes and types
+          validator.check(attr_values)
+
+          # TODO: type coercion or mapping decision goes here
+
+          super(**attr_values)
+
+          # Freeze the instance before returning to caller
+          # TODO: if immutability becomes optional this needs to be wrapped
+          freeze
+        end
+
+        struct
+      end
+    end
+  end
+end

data/lib/mementus/version.rb

@@ -1,3 +1,3 @@
 module Mementus
-  VERSION = '0.8.3'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/mementus.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake", "~> 11.1"
-  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
 end

data/spec/graph_spec.rb

@@ -123,12 +123,26 @@ describe Mementus::Graph do
     end
   end
 
-  specify '#has_node?' do
+  describe '#has_node?' do
     graph = Mementus::Graph.new do
       set_node(node_1)
     end
 
-    expect(graph.has_node?(node_1.id)).to be true
+    specify 'node' do
+      expect(graph.has_node?(node_1)).to be true
+    end
+
+    specify '!node' do
+      expect(graph.has_node?(node_2)).to be false
+    end
+
+    specify 'node.id' do
+      expect(graph.has_node?(node_1.id)).to be true
+    end
+
+    specify '!node.id' do
+      expect(graph.has_node?(node_2.id)).to be false
+    end
   end
 
   describe '#has_edge?' do

data/spec/model/validator_spec.rb

@@ -0,0 +1,72 @@
+describe Mementus::Model::Validator do
+  Validator = Mementus::Model::Validator
+  Type = Mementus::Model::Type
+
+  describe "schema with optional fields using any type" do
+    let(:anchor) do
+      Validator.new({
+        :href => String,
+        :title => Type::Any,
+        :target => Type::Any
+      })
+    end
+
+    specify "hash of attributes" do
+      expect(
+        anchor.check({:href => "https://maetl.net", :title => "maetl", :target => "_blank"})
+      ).to be_truthy
+    end
+
+    specify "skip any type attributes when not provided" do
+      expect(anchor.check({:href => "https://maetl.net"})).to be_truthy
+    end
+
+    specify "missing attribute error" do
+      expect {
+        anchor.check({})
+      }.to raise_error("wrong number of args")
+    end
+
+    specify "mismatching attribute error" do
+      expect {
+        anchor.check({:href => "https://maetl.net", :src => "https://maetl.net"})
+      }.to raise_error("key does not exist")
+    end
+  end
+
+  describe "type constraint schema" do
+    let(:rect) do
+      Validator.new({
+        :shape => String,
+        :x => Integer,
+        :y => Integer,
+        :w => Integer,
+        :h => Integer
+      })
+    end
+
+    specify "checks a flat set of attributes" do
+      expect(
+        rect.check({:shape => "rect", :x => 10, :y => 10, :w => 64, :h => 48})
+      ).to be_truthy
+    end
+
+    specify "missing attribute error" do
+      expect {
+        rect.check({:shape => "rect"})
+      }.to raise_error("wrong number of args")
+    end
+
+    specify "bad key error" do
+      expect {
+        rect.check({:mishape => "rect", :shape => "rect", :x => 10, :y => 10, :w => 64, :h => 48})
+      }.to raise_error("key does not exist")
+    end
+
+    specify "mismatching type error" do
+      expect {
+        rect.check({:shape => "rect", :x => "1", :y => "1", :w => "1", :h => "1"})
+      }.to raise_error("wrong data type")
+    end
+  end
+end

data/spec/model/value_spec.rb

@@ -0,0 +1,43 @@
+describe Mementus::Model::Value do
+  Value = Mementus::Model::Value
+
+  it "empty definition error" do
+    expect { Value.new }.to raise_error(ArgumentError)
+  end
+
+  it "constructs immutable struct" do
+    Color = Value.new(:name)
+    teal = Color.new(name: "teal")
+    expect { teal.name = "turquoise" }.to raise_error(FrozenError)
+  end
+
+  it "builds struct from slot declaration" do
+    Slots = Value.new(:first, :last)
+    slots = Slots.new(first: "hello", last: "world")
+    expect(slots.first).to eq("hello")
+    expect(slots.last).to eq("world")
+  end
+
+  it "builds struct from field declaration" do
+    Fields = Value.new(name: String, email: String)
+    fields = Fields.new(name: "maetl", email: "me@maetl.net")
+    expect(fields.name).to eq("maetl")
+    expect(fields.email).to eq("me@maetl.net")
+  end
+
+  it "compares by value" do
+    Weight = Value.new(:value, :unit)
+    w1 = Weight.new(value: 50, unit: "kgs")
+    w2 = Weight.new(value: 50, unit: "kgs")
+    expect(w1 == w2).to be(true)
+    expect(w1 === w2).to be(true)
+    expect(w1).to eq(w2)
+  end
+
+  it "supports ruby struct initializer" do
+    Length = Value.new(:size, :unit)
+    len = Length.new(500, "cm")
+    expect(len.size).to eq(500)
+    expect(len.unit).to eq("cm")
+  end
+end

data/spec/structure/incidence_list_spec.rb

@@ -8,7 +8,7 @@ describe Mementus::Structure::IncidenceList do
     Mementus::Structure::IncidenceList.new
   end
 
-  it_behaves_like 'an indexed graph data structure'
+  it_behaves_like 'an indexed graph data structure', supports_edge_ids: true
   it_behaves_like 'a directed graph data structure'
   it_behaves_like 'a property graph data structure'
   it_behaves_like 'a mutable graph data structure'

data/spec/structure/indexed_graph_example.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-shared_examples_for "an indexed graph data structure" do
+shared_examples_for "an indexed graph data structure" do |supports_edge_ids: false|
   describe '#new' do
     it 'starts with empty node list' do
       expect(structure.nodes_count).to eq(0)
@@ -52,6 +52,20 @@ shared_examples_for "an indexed graph data structure" do
 
       expect(structure.has_edge?(edge)).to be true
     end
+
+    it 'tests for the presence of a given edge by id' do
+      edge = Mementus::Edge.new(id: 123, from: Mementus::Node.new(id: 1), to: Mementus::Node.new(id: 2))
+      structure.set_edge(edge)
+
+      expect(structure.has_edge?(123)).to be true
+    end if supports_edge_ids
+
+    it 'tests for the presence of a given edge between nodes' do
+      edge = Mementus::Edge.new(from: Mementus::Node.new(id: 1), to: Mementus::Node.new(id: 2))
+      structure.set_edge(edge)
+
+      expect(structure.has_edge?(1, 2)).to be true
+    end if supports_edge_ids
   end
 
   describe '#node(id)' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mementus
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.9.0
 platform: ruby
 authors:
 - maetl
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-05-11 00:00:00.000000000 Z
+date: 2021-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.8'
 description: Graph data structure toolkit.
 email:
 - me@maetl.net
@@ -59,8 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -79,6 +79,9 @@ files:
 - lib/mementus/library.rb
 - lib/mementus/library/herschel_graph.rb
 - lib/mementus/library/story_graph.rb
+- lib/mementus/model/type.rb
+- lib/mementus/model/validator.rb
+- lib/mementus/model/value.rb
 - lib/mementus/mutable_graph.rb
 - lib/mementus/mutators.rb
 - lib/mementus/node.rb
@@ -104,6 +107,9 @@ files:
 - spec/graph_spec.rb
 - spec/herschel_spec.rb
 - spec/integer_id_spec.rb
+- spec/model/type_spec.rb
+- spec/model/validator_spec.rb
+- spec/model/value_spec.rb
 - spec/mutable_graph_spec.rb
 - spec/node_proxy_spec.rb
 - spec/node_spec.rb
@@ -121,7 +127,7 @@ homepage: https://github.com/maetl/mementus
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -136,9 +142,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Graph data structure toolkit for Ruby applications.
 test_files:
@@ -149,6 +154,9 @@ test_files:
 - spec/graph_spec.rb
 - spec/herschel_spec.rb
 - spec/integer_id_spec.rb
+- spec/model/type_spec.rb
+- spec/model/validator_spec.rb
+- spec/model/value_spec.rb
 - spec/mutable_graph_spec.rb
 - spec/node_proxy_spec.rb
 - spec/node_spec.rb

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - ruby-head
-  - jruby-9.1.13.0
-  - jruby-head
-before_install: gem install bundler
-script: bundle exec rspec