solis 0.64.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0965263268b064dee557568f16f61570d571a32c236c7d6f53e675713d30289a'
+  data.tar.gz: e2cd0b29580a4031c1d22988dd7131055dec9b6e07fbe4128806aa0709b65b4e
+SHA512:
+  metadata.gz: 71e19db05ebbb97b64fdf9b36883d003cb5e5a46ab6a1f2233938790371e94b80ba6cc1f574903c34cc959ddcf279bdb36c67506b44b0cc12378920b4da72d66
+  data.tar.gz: 70bbd782872f2d8cf0f771d43e3f5e0074ba5af2821d5d927b99b1a24a4638f88bfe43811818b1d6755a8460b764b571633dd6c3289f0c604bbc39147144fcaa

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+.DS_Store
+examples/data/cache
+config.yml
+examples/data
+.vscode
+*.gem
+lib/solis/entity
+cache
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mehmet@celik.be. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Mehmet Celik
+
+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,287 @@
+# Solis
+
+Solis means 'the sun' in Latin or just Silos spelled backwards. 
+A simple idea to use SHACL to describe models and API on top of a data store.
+
+# Status
+Although I'm using it in production I must shamefully acknowledge that it actually needs refactoring. Solis is currently still grown organically driven by my needs and understanding of problem domain(RDF, triples, ...).
+When my current project is live I'll start to refactor the code and release it as 1.0.
+
+# From Google Sheets to RDF, Shacl, ... to API
+The biggest hurdle when developing a model is the communication between the people who know the problem domain and the developers. 
+Next to this every change in the model has a direct impact on everything that uses the model. From migrations to documentation and eventually the API.
+This is an effort to streamline and minimalize this impact.
+
+## config.yml
+Config file contains all the options needed to run Solis.
+
+```yaml
+:debug: false
+:key: your_Google_API_key
+:solis:
+    :cache: tmp/cache
+    :query_cache_expire: 300
+    :shacl: /path/to/t_shacl.ttl
+    :env:
+        :graph_name: https://t.example.com/
+        :graph_prefix: t
+        :sparql_endpoint: http://127.0.0.1:8890/sparql
+        :inflections: /path/to/t.json
+        :language: nl
+:sheets:  
+  :t: 1vi2U9Gpgu9mA6OpvrDBWRg8oVKs6Es63VyLDIKFNWYM  
+
+```
+
+- debug: extra logging like generated queries etc.
+- key: Google API key used to read a Google Sheet
+- solis: runtime configuration
+  - cache: Google Sheets can be cached to minimize Google API calls
+  - query_cache_expire: time construct queries should expire. 0 is never expire
+  - shacl: location of the shacl file to use
+  - env: shacl info
+    - graph_name: uri of the graph
+    - graph_prefix: uri prefix of the graph
+    - sparql_endpoint: uri to connect to the data store. Currently focus is on triple stores
+    - inflections: singular, plural mapping file for multi lingual data models
+    - language: default language strings are stored in.
+- sheets: list of models
+  - t: an example sheet
+  
+## Solis Model Template
+
+![Template model](./test/resources/data/t.png)
+
+This is simple template exclusively used for testing.
+### Google Sheet [model](https://docs.google.com/spreadsheets/d/1vi2U9Gpgu9mA6OpvrDBWRg8oVKs6Es63VyLDIKFNWYM/edit#gid=577648221)
+
+#### Tabs
+- _PREFIXES: a list of ontologies and prefixes used
+  - Base: All entities defined under this URI. Selected by '*'
+  - Prefix: prefix of ontology
+  - URI: URI of ontology
+- _METADATA: description fields for metadata
+  - key: identifier of metadata
+  - value: metadata value
+- _ENTITIES: a list of entities(classes) used in the model
+  - Name: name of entity
+  - NamePlural: plural name of entity. The generated API has RESTful endpoints. Non english entities are incorrectly pluralized
+  - Description: purpose of entity
+  - subClassOf: internal entity reference. Entity you want to inherit from 
+  - sameAs: External entity reference (not activily used, yet)
+- Any number of tabs describing properties of an entity. See below  
+
+#### Entity tabs
+Not every entity described in _ENTITIES needs a tab. 
+##### CodeTable
+This is a base entity were other entities that fit a code table are inherited from
+
+| Name | Description | Min | Max | sameAs | datatype |
+|---|---|---|---|---|---|
+| id | unique record identifier | 1 | 1 | schema:identifier | xsd:string |
+|short_label|lookup key, short label|0|1|xsd:string|
+|label|prefered display label|1|1|xsd:string|
+
+##### Skill
+Inherits from CodeTable no tab is needed. Skills a teacher can teach
+```json
+[
+  { "id": 1, "short_label": "problemsolv", "label": "Applying and problem-solving"},
+  { "id": 2, "short_label": "commexp", "label": "Communicating and expressing"},
+  { "id": 3, "short_label": "intcon", "label": "Integrating and connecting"},
+  { "id": 4, "label": "Reasoning"}
+]
+```
+
+##### Person
+Base class for a person
+
+| Name | Description | Min | Max | sameAs | datatype |
+|---|---|---|---|---|---|
+| id | unique record identifier | 1 | 1 | schema:identifier | xsd:string |
+|first_name|Person's first name|1|1|schema:givenName|xsd:string|
+|first_name|Person's last name|1|1|schema:familyName|xsd:string|
+
+##### Teacher
+Inherits all fields from Person and adds extra property "skill" an extra tab with the extra properties must exist 
+
+| Name | Description | Min | Max | sameAs | datatype |
+|---|---|---|---|---|---|
+| id | unique record identifier | 1 | 1 | schema:identifier | xsd:string |
+|skill|field teacher is skilled in|1| | |t:Skill|
+
+##### Student
+Inherits all fields from Person and adds extra property "age" an extra tab with the extra properties must exist
+
+| Name | Description | Min | Max | sameAs | datatype |
+|---|---|---|---|---|---|
+| id | unique record identifier | 1 | 1 | schema:identifier | xsd:string |
+|age|age of student|1|1| |xsd:integer|
+
+```json
+[
+  {"id":  "s1", "first_name":  "Jane", "last_name":  "Smith", "age":  22},
+  {"id":  "s1", "first_name":  "Gino", "last_name":  "Santi", "age":  25}
+]
+```
+
+##### Course 
+| Name | Description | Min | Max | sameAs | datatype |
+|---|---|---|---|---|---|
+| id | unique record identifier | 1 | 1 | schema:identifier | xsd:string |
+|name|name of a course|1|1| |xsd:string|
+
+##### Schedule
+| Name | Description | Min | Max | sameAs | datatype |
+|---|---|---|---|---|---|
+| id | unique record identifier | 1 | 1 | schema:identifier | xsd:string |
+|teacher|schedule belongs to|1|	1| |t:Teacher|
+|course|course within schedule| |1 | |t:Course|
+|start_date| |1|1| |xsd:date|
+|end_date|	|1|	1| |xsd:date|
+
+##### Example data
+
+When __no__ id is supplied records will be created and an id will be assigned
+This example will create a schedule, teacher and course record. The skill and student records are referenced by id and must exist.
+```json
+{
+  "type": "schedules",
+  "attributes": {
+    "teacher": {
+      "first_name": "John",
+      "last_mame": "Doe",
+      "skill": [{"id":  "1"}, {"id":  "2"}]
+    },
+    "students": [{"id": "s1"}, {"id": "s2"}],
+    "course": {
+      "name": "Something 101"
+    },
+    "start_date": "2021-10-01",
+    "end_date": "2022-01-01"
+  }
+}
+```
+
+Create schedule with existing teacher and course records
+```json
+{
+  "type": "schedules",
+  "attributes": {
+    "teacher": {
+      "id": "1"
+    },
+    "course": {
+      "id": "A23B-101"
+    },
+    "start_date": "2021-10-01",
+    "end_date": "2022-01-01"
+  }
+}
+```
+
+## Solis API
+### Solis::ConfigFile
+Static class to read and manipulate config.yml file
+- name=: name of config file defaults to config.yml
+- path=: location of config file defaults to ./config.yml or ./config/config.yml
+- [key]=: lookup or set a key in your config file
+- include?(key): is key available in config file
+
+```ruby
+Solis::ConfigFile.path='/path/to/config/file'
+raise ':key not found' unless Solis::ConfigFile.include?(:key)
+
+key = Solis::Configfile[:key]
+```
+
+### Solis::LOGGER
+Logger class defaults to STDOUT for now
+
+TODO: check if this needs to be configurable
+
+### Solis::VERSION
+Returns Solis version number 
+
+### Solis::Error
+List of Solis errors
+
+##### Solis::Error::GeneralError
+An unknown error
+##### Solis::Error::InvalidAttributeError
+Attribute error. Happens when data does not match model 
+##### Solis::Error::NotFoundError
+When query returns not found
+
+### Solis::Graph
+### Solis::Model
+### Solis::Resource
+### Solis::Query
+### Solis::Shape
+
+### Solis::Shape::Reader
+#### Solis::Shape::Reader::File
+#### Solis::Shape::Reader::Sheet
+
+### Setup Solis
+``` ruby
+Solis::ConfigFile.path = './'
+solis = Solis::Graph.new(Solis::Shape::Reader::File.read(Solis::ConfigFile[:solis][:shacl]), Solis::ConfigFile[:solis][:env])
+```
+
+
+TODO:
+ - extract sparql layer into its own gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'solis'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install solis
+
+## Usage
+
+Transforming a Google Sheet into a SHACL file and Entity model.
+
+[Google sheet template](https://docs.google.com/spreadsheets/d/1vi2U9Gpgu9mA6OpvrDBWRg8oVKs6Es63VyLDIKFNWYM/edit?usp=drive_web&ouid=105856802847127219255) example
+
+Tabs starting with an underscore define general metadata 
+    - _PREFIXES: ontologies to include in SHACL file
+    - _METADATA: key/value pairs describing the ontology
+    - _ENTITIES: a list of entities describing if it is a sub class of or same as an external entity
+
+Every entity that is referenced in _ENTITIES can be further described in its own tab.
+
+
+
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/solis. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/solis/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Solis project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/solis/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "solis"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/after_hooks.rb

@@ -0,0 +1,24 @@
+# $LOAD_PATH << '.' << './lib'
+require 'bundler'
+Bundler.require
+
+require 'solis'
+require 'pp'
+require 'json'
+
+Solis::ConfigFile.path = './'
+g = Solis::Graph.new(Solis::Shape::Reader::File.read(Solis::ConfigFile[:solis][:shacl]),
+                     Solis::ConfigFile[:solis][:env].merge(
+                       hooks: {
+                         create: { before: lambda { |m, d| puts "before-=-=-=-=-=->"},
+                                   after: lambda { |m, d| puts "after-=-=-=-=->" } }
+                       })
+)
+
+# Skill.model_before_create do |model, graph|
+#   puts "---------BEFORE"
+# end
+
+s = Skill.new({ id: 5, short_label: 'a short label', label: 'a label' })
+
+s.save

data/examples/config.yml.template

@@ -0,0 +1,15 @@
+:debug: false
+:key: your_Google_API_key
+:solis:
+    :cache: tmp/cache
+    :query_cache_expire: 300
+    :shacl: /path/to/t_shacl.ttl
+    :env:
+        :graph_name: https://t.example.com/
+        :graph_prefix: t
+        :sparql_endpoint: http://127.0.0.1:8890/sparql
+        :inflections: /path/to/t.json
+        :language: nl
+:sheets:  
+  :t: 1vi2U9Gpgu9mA6OpvrDBWRg8oVKs6Es63VyLDIKFNWYM  
+

data/examples/read_from_shacl.rb

@@ -0,0 +1,22 @@
+# $LOAD_PATH << '.' << './lib'
+require 'bundler'
+Bundler.require
+
+require 'solis'
+require 'pp'
+require 'json'
+
+Solis::ConfigFile.path = './'
+g = Solis::Graph.new(Solis::Shape::Reader::File.read(Solis::ConfigFile[:solis][:shacl]), Solis::ConfigFile[:solis][:env])
+
+schedule = g.shape_as_model('Schedule')
+schedule_resource = g.shape_as_resource('Schedule')
+puts schedule.model_template.to_json
+begin
+  s = schedule_resource.find({id: 123})
+  pp s.to_jsonapi
+rescue Graphiti::Errors::RecordNotFound
+  puts "record not found"
+end
+
+

data/examples/read_from_shacl_abv.rb

@@ -0,0 +1,84 @@
+# $LOAD_PATH << '.' << './lib'
+require 'bundler'
+Bundler.require
+
+require 'solis'
+require 'pp'
+require 'json'
+
+Solis::ConfigFile.path = './'
+g = Solis::Graph.new(Solis::Shape::Reader::File.read(Solis::ConfigFile[:solis][:shacl]), Solis::ConfigFile[:solis][:env])
+
+model = g.shape_as_model('Codetabel')
+resource = g.shape_as_resource('Codetabel')
+# model.model_template.to_json
+#
+data = %( {
+  "type": "agenten",
+  "id": 1776,
+  "attributes": {
+    "identificatie": [
+      {
+        "id": 1776,
+        "waarde": 1776
+      }
+    ],
+    "type": {
+      "id": "292r3yzt3rv7owo7"
+    },
+    "naam": [
+      {
+        "waarde": "Bond Moyson-gewest Tielt",
+        "type_naam": {
+          "id": "p9qirbgec6a0j8ri7qst"
+        }
+      }
+    ],
+    "datering": "1970-01-01",
+    "geschiedenis_agent": [
+      ""
+    ],
+    "functie_beroep_activiteit": {},
+    "erkenning": {
+      "id": "4cvras56mmdqmay715kns7"
+    },
+    "adres": {},
+    "telefoon": "",
+    "email": "",
+    "website": "",
+    "gebouw": "",
+    "zoektoegang": {},
+    "openingsuren": "",
+    "toegang_gebruiksvoorwaarden": "",
+    "bereikbaarheid": {},
+    "taal": {},
+    "associaties": {},
+    "bron_beschrijving_agent": {},
+    "bibliografie_agent": {},
+    "opmerking": ""
+  }
+}
+)
+
+begin
+  s = resource.find({label: 'persoon'})
+  j = JSON.parse(s.to_jsonapi)
+  puts JSON.pretty_generate(j)
+
+  #Agent = g.shape_as_model('Agent')
+  agent_data = JSON.parse(data)['attributes']
+  pp agent_data
+  agent = Agent.new(agent_data)
+
+  begin
+    agent.save
+  rescue StandardError => e
+    puts e.message
+  end
+
+
+rescue Graphiti::Errors::RecordNotFound
+  puts "record not found"
+end
+
+

data/examples/read_from_sheet.rb

@@ -0,0 +1,22 @@
+# $LOAD_PATH << '.' << './lib'
+require 'bundler'
+Bundler.require
+
+require 'solis'
+Solis::ConfigFile.path = Dir.pwd
+sheet_key = Solis::ConfigFile[:solis][:env][:graph_prefix].to_sym
+key = Solis::ConfigFile[:key]
+s = Solis::Shape::Reader::Sheet.read(key, Solis::ConfigFile[:sheets][sheet_key], from_cache: false)
+
+File.open("./data/#{sheet_key}.sql", 'wb') { |f| f.puts s[:sql] }
+File.open("./data/#{sheet_key}.json", 'wb') { |f| f.puts s[:inflections] }
+File.open("./data/#{sheet_key}_shacl.ttl", 'wb') { |f| f.puts s[:shacl] }
+File.open("./data/#{sheet_key}_schema.ttl", 'wb') { |f| f.puts s[:schema] }
+File.open("./data/#{sheet_key}.puml", 'wb') { |f| f.puts s[:plantuml] }
+File.open("./data/#{sheet_key}_erd.puml", 'wb') { |f| f.puts s[:plantuml_erd] }
+
+#https://plantuml.com/elk
+`plantuml -tsvg ./data/#{sheet_key}.puml`
+`gm convert ./data/#{sheet_key}.svg ./data/#{sheet_key}.png`
+`plantuml -tsvg ./data/#{sheet_key}_erd.puml`
+`gm convert ./data/#{sheet_key}_erd.svg ./data/#{sheet_key}_erd.png`