bridgetown-arcade-db 0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1d52d25cfcb9a864ee279ec5ecf0e9950fa57cfb3670e69935c2a1600c2ad52f
+  data.tar.gz: e376ae39416a83aa964c69f75f86022e2f71bf33cf03dfdf59ba96dc5f41cc89
+SHA512:
+  metadata.gz: 1ee21b74c8076380fce609551c9fa81ed484abeb069a8ce6514e1ef4633ba99a3431a97102d224a13e00621b49a214ec4bc0afce6f50a197aa1589aca01c278a
+  data.tar.gz: 3f52361c65a241c0ee8b4c1732eb610bf4e76ea13786331aab5e6102cfe2742e91d0b5467d9b06fb1a513f93a02e02c99f1dba75d40e5e61b5e629222c410647

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+
+## 0.1 - 2023-01-16
+
+- First version

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec
+
+gem "bridgetown", ENV["BRIDGETOWN_VERSION"] if ENV["BRIDGETOWN_VERSION"]
+gem "arcadedb", path: "/home/ubuntu/hieronymus/arcadedb"
+gem "arcade-time-graph", path: "/home/ubuntu/hieronymus/arcade-time-graph"
+
+group :test do
+  gem "minitest"
+  gem "minitest-reporters"
+  gem "shoulda"
+end
+

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Hartmut Bischoff
+
+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,114 @@
+# Bridgetown ArcadeDB plugin
+
+This plugin grants Bridgetown sites (v1.2 or higher) to ArcadeDB-Databases. You can pull data from a database during a static build or during server requests (or both!). [ArcadeDB](https://arcadedb.com/) is a multi-model NOSQL-Database supporting Document-, KeyStore- 
+and  Graph-Databases including standard-protocols (SQL, Redis, MongoDB, Gremlin, GraphQL). Most important: ArcadeDB supports inheritance,
+ArcadDB is a native object-orientated database. This fits nicely to ruby. 
+
+## Installation
+
+An automation script is planned
+
+```shell
+$ bin/bridgetown apply https://github.com/bridgetownrb/bridgetown-arcade-db   (future use)
+```
+
+Manual setup:
+
+* Add the following to `Gemfile` 
+```
+
+gem 'arcadedb', git: 'https://github.com/topofocus/arcadedb"
+gem 'arcade-time-graph', git: 'https://github.com/topofocus/-arcade-time-graph" 
+gem 'bridgetown-arcade-db' , git: 'https://github.com/topofocus/bridgetown-arcade-db"
+```
+( the gem is not released jet. so, reference to the github-repositories or clone everything an refer to their local location ) 
+* activate the plugin in `config/initializers.rb`
+``` ruby
+init :ssr                         
+init :"bridgetown-routes"
+init :"bridgetown-arcade-db"
+```
+or if the DB should only referenced through deployment from static pages
+``` ruby
+only :static, :console do
+ init :bridgetown-arcade-db
+end
+
+```
+
+* add `arcade.yml` to the `config`-dir
+```
+--- #/config/arcade.yml
+:environment:
+  :test:
+    dbname: test
+    user:  root
+    pass: ****
+  :development:
+    dbname: playground
+    user: root
+    pass: ****      
+ :production:
+    dbname: bridgetown
+    user: root
+    pass: ****      
+:admin:
+  :host: localhost        # enter ip-address or name of the arcadeDB-Server
+  :port: 2480             # 
+  :user: root             #  this is used for lowlevel Api-Access
+  :pass: ****             #
+:autoload: true           #  load model if a link is detected in a record
+:logger: stdout           # 'file' or 'stdout'
+:namespace: Arcade        #  default namespace
+```
+
+* create a `model`-directory, and there an `arcade`-Namespace-Directory.
+* for testing: create a file `model/arcade/person.rb`
+```
+module Arcade
+class Person
+attribute :name,        Types::Nominal::String
+attribute :surname,     Types::Nominal::String.default( "".freeze   )
+attribute :email?,      Types::Email
+attribute :age?,        Types::Nominal::Integer
+attribute :active,      Types::Nominal::Bool.default( true   )
+attribute :conterfeil?, Types::Nominal::Any
+
+def self.db_init
+File.read(__FILE__).gsub(/.*__END__/m, '')
+end
+end
+end
+## The code below is executed on the database after the database-type is created
+## Use the output of `ModelClass.database_name` as DB type  name
+##
+__END__
+CREATE PROPERTY user.name STRING
+CREATE PROPERTY user.surname STRING
+CREATE PROPERTY user.email STRING
+CREATE INDEX  ON user ( name   ) NOTUNIQUE
+CREATE INDEX  ON user ( name, surname, email   ) UNIQUE
+```
+
+* Assuming you got a running database-instance, you are ready to go.
+
+## First steps
+
+* Create the database 
+  * Open the Bridgetown-Console (bin/bt c)
+  * execute `Api.create_database {name of the database in arcade.yml}`
+* create the  Person type: `Arcade::Person.create_type`
+* add a person: `Arcade::Person.create name: "Hogo"`
+* query the database: `Arcade::Person.where name: 'Hugo'`
+
+The records are available in Frontmatter, components and in Bridgetown-Documents. 
+
+
+## Contributing
+
+1. Fork it (https://github.com/topofocus/bridgetown-arcade-db/fork)
+2. Clone the fork using `git clone` to your local development machine.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+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"]
+  t.warning = false
+end
+
+task :default => :test

data/bridgetown-arcade-db.gemspec

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "lib/bridgetown-arcade-db/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bridgetown-arcade-db"
+  spec.version       = BridgetownArcadeDb::VERSION
+  spec.author        = "Dr. Hartmut Bischoff"
+  spec.email         = "topofocus@gmail.com"
+  spec.summary       = "Plugin to add ArcadeDB support to Bridgetown sites"
+  spec.homepage      = "https://github.com/topofocus/bridgetown-arcade-db"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features|frontend)/!) }
+  spec.test_files    = spec.files.grep(%r!^test/!)
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.add_dependency "bridgetown", ">= 1.2.0.beta5", "< 2.0"
+  spec.add_dependency "arcadedb", ">= 0.4"
+  spec.add_dependency "arcade-time-graph"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", ">= 13.0"
+end

data/bridgetown.automation.rb

@@ -0,0 +1,41 @@
+
+add_gem "bridgetown-arcade-db"
+add_gem "annotate", group: :development
+
+# TODO:  modify  file to enable installation of arcadedb 
+#  this is borrowed from bridgetown-activerecord 
+#
+
+
+## do not use ##
+
+create_file "config/arcade.yml" do
+  <<~YML
+    default: &default
+      adapter: #{dbadapter}
+      encoding: unicode
+      pool: 5
+
+    development:
+      <<: *default
+      database: #{dbprefix}_development
+
+    test: &test
+      <<: *default
+      database: #{dbprefix}_test
+
+    production:
+      <<: *default
+      url: <%= ENV['DATABASE_URL'] %>
+      database: #{dbprefix}_production
+  YML
+end
+
+
+
+
+add_initializer :"bridgetown-arcade-db"
+
+say_status :"arcade-db", "The plugin has been configured. For usage help visit:"
+say_status :"arcade-db", "https://github.com/topofocus/arcade-db/blob/main/README.md"
+

data/lib/bridgetown-arcade-db/initializer.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "arcade"
+require "arcade-time-graph"
+require "active_support/configuration_file"
+require "zeitwerk"
+
+module BridgetownArcadeDb
+
+  def self.load_models(config)
+    loader = Zeitwerk::Loader.new
+    root= Pathname.new( config.root_dir )
+    loader.push_dir root.join( configuration(config)[:modeldir] || "model")
+    loader.setup
+  end
+  def self.configuration(config)
+    ActiveSupport::ConfigurationFile.parse(File.join(config.root_dir, "config", "arcade.yml"))
+  end
+
+  def self.log_writer
+    Bridgetown::LogWriter.new.tap(&:enable_prefix)
+  end
+end
+
+Bridgetown.initializer :"bridgetown-arcade-db" do |config|
+   BridgetownArcadeDb.load_models config
+   Arcade::Init.connect Bridgetown.environment
+end

data/lib/bridgetown-arcade-db/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module BridgetownArcadeDb
+  VERSION = "0.2"
+end

data/lib/bridgetown-arcade-db.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "bridgetown"
+ProjectRoot =  Pathname.new( Dir.pwd ) + 'config'
+require "bridgetown-arcade-db/initializer"

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: bridgetown-arcade-db
+version: !ruby/object:Gem::Version
+  version: '0.2'
+platform: ruby
+authors:
+- Dr. Hartmut Bischoff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-12-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bridgetown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0.beta5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0.beta5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: arcadedb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: arcade-time-graph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: 
+email: topofocus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bridgetown-arcade-db.gemspec
+- bridgetown.automation.rb
+- lib/bridgetown-arcade-db.rb
+- lib/bridgetown-arcade-db/initializer.rb
+- lib/bridgetown-arcade-db/version.rb
+homepage: https://github.com/topofocus/bridgetown-arcade-db
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Plugin to add ArcadeDB support to Bridgetown sites
+test_files: []