chronicle-core 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a168e93bd8ec5d03b056c25bdfa2b500ba88bd98869121ac427c4e6452b2c51e
+  data.tar.gz: 638310a4a890e3b9ece2d26a99403f78293975f257d05df065dd3107146fffea
+SHA512:
+  metadata.gz: 8462b795ea806166e4ca538042c91c16d22e641bcae19e7228714911c8604cace59efe8bea79ca4f7e582191c51b09d8c5b73b33ac34255ab04693e89d7ce85c
+  data.tar.gz: b2ead2ca9b9cb9afddba562881cc9026488c4177c9da62e282bb1acb17a9e11e1ec7782269ac5093ca1143de83951d8db6906864e0803d58c858bc3ec0a7f3f4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+Gemfile.lock
+.DS_Store

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at andrew@hyfen.net. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in chronicle-core.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -0,0 +1,3 @@
+# Chronicle::Core
+
+Home of some shared code for [Chronicle](https://github.com/chronicle-app/). Currently, this means the models and a validator for Chronicle Schema.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "chronicle/core"
+
+# 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/chronicle-core.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/chronicle/core/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "chronicle-core"
+  spec.version = Chronicle::Core::VERSION
+  spec.authors = ["Andrew Louis"]
+  spec.email = ["andrew@hyfen.net"]
+
+  spec.summary       = "Core libraries for Chronicle"
+  spec.description   = "Core libraries for Chronicle including models and schema definitions."
+  spec.homepage      = "https://github.com/chronicle-app"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/chronicle-app/chronicle-core"
+    spec.metadata["changelog_uri"] = "https://github.com/chronicle-app/chronicle-core/releases"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-schema", "~> 1.13"
+
+  spec.add_development_dependency "guard-rspec", "~> 4.7.3"
+  spec.add_development_dependency "pry-byebug", "~> 3.9"
+  spec.add_development_dependency "rspec", "~> 3.9"
+end

data/lib/chronicle/core/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Chronicle
+  module Core
+    VERSION = "0.1.0"
+  end
+end

data/lib/chronicle/core.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "core/version"
+
+begin
+  require 'pry'
+rescue LoadError
+  # Pry not available
+end

data/lib/chronicle/schema/activity.rb

@@ -0,0 +1,5 @@
+module Chronicle::Schema
+  class Activity < Chronicle::Schema::Base
+    TYPE = 'activities'.freeze
+  end
+end

data/lib/chronicle/schema/base.rb

@@ -0,0 +1,103 @@
+require 'chronicle/utils/hash'
+
+module Chronicle::Schema
+  class Base
+    attr_accessor(:id, :dedupe_on, :properties)
+
+    def initialize(attributes = {})
+      @properties = {}
+      @dedupe_on = []
+      assign_attributes(attributes) if attributes
+    end
+
+    def method_missing(method, *args)
+      if method.to_s.end_with?("=")
+        @properties[method.to_s.gsub("=", "").to_sym] = args.first
+      else
+        @properties[method]
+      end
+    end
+
+    def identifier_hash
+      {
+        type: self.class::TYPE,
+        id: @id
+      }.compact
+    end
+
+    def to_h_jsonapi
+      identifier_hash.merge({
+        attributes: attributes,
+        relationships: associations.map do |k, v|
+          if v.is_a?(Array)
+            [k, { data: v.map(&:to_h_jsonapi) }]
+          else
+            [k, { data: v.to_h_jsonapi }]
+          end
+        end.to_h,
+      }).merge(meta_hash)
+      .compact
+    end
+
+    def attributes
+      @properties.reject { |k, v| associations.keys.include?(k) }.compact
+    end
+
+    def associations
+      @properties.select do |k, v|
+        if v.is_a?(Array)
+          v.any? { |e| e.is_a?(Chronicle::Schema::Base) }
+        else
+          v.is_a?(Chronicle::Schema::Base)
+        end
+      end
+    end
+
+    def associations_hash
+      associations.map do |k, v|
+        if v.is_a?(Array)
+          [k, v.map(&:to_h)]
+        else
+          [k, v.to_h]
+        end
+      end.to_h
+    end
+
+    def meta
+      {
+        dedupe_on: @dedupe_on.map{|d| d.map(&:to_s).join(",")}
+      }
+    end
+
+    def meta_hash
+      {
+        meta: meta
+      }
+    end
+
+    def identifier_hash
+      {
+        id: @id,
+        type: self.class::TYPE
+      }.compact
+    end
+
+    def to_h_flattened
+      Chronicle::Utils::Hash.flatten_keys(to_h)
+    end
+
+    def to_h
+      identifier_hash
+        .merge(@properties)
+        .merge(meta_hash)
+    end
+
+    def assign_attributes(attributes)
+      @properties.merge!(attributes)
+    end
+  end
+end
+
+require_relative "activity"
+require_relative "entity"
+require_relative "raw"

data/lib/chronicle/schema/entity.rb

@@ -0,0 +1,5 @@
+module Chronicle::Schema
+  class Entity < Chronicle::Schema::Base
+    TYPE = 'entities'.freeze
+  end
+end

data/lib/chronicle/schema/raw.rb

@@ -0,0 +1,9 @@
+module Chronicle::Schema
+  class Raw < Chronicle::Schema::Base
+    TYPE = 'raw'.freeze
+
+    def to_h
+      @properties
+    end
+  end
+end

data/lib/chronicle/schema/validator.rb

@@ -0,0 +1,53 @@
+require 'dry/schema' # TODO: Lazy load this
+Dry::Schema.load_extensions(:hints)
+Dry::Schema.load_extensions(:info)
+
+module Chronicle::Schema
+  class Validator
+    EntitySchema = Dry::Schema.Params do
+      required(:type).filled(:string, eql?: 'entities')
+      required(:attributes).type(:hash)
+    end
+
+    EntityIdentifiableSchema = Dry::Schema.Params do
+      required(:provider).filled(:string)
+    end
+
+    ActorEntitySchema = Dry::Schema.Params do
+      required(:represents).filled(:string, eql?: 'identity')
+    end
+
+    ActivitySchema = Dry::Schema.Params do
+      required(:type).filled(:string, eql?: 'activities')
+      required(:attributes).schema do
+        required(:verb).filled(:string)
+        optional(:start_at).maybe(:string) # Adjust type as needed
+        optional(:end_at).maybe(:string)   # Adjust type as needed
+      end
+      required(:relationships).schema do
+        required(:actor).hash do
+          required(:data).hash(EntitySchema) do
+            required(:attributes).schema(EntityIdentifiableSchema & ActorEntitySchema)
+          end
+        end
+      end
+    end
+
+    def self.validate(input)
+      case input
+      when Entity
+        result = EntitySchema.call(input.to_h_jsonapi)
+      when Activity
+        result = ActivitySchema.call(input.to_h_jsonapi)
+      else
+        raise ArgumentError, "Unsupported type: #{input.class}"
+      end
+
+      if result.success?
+        { success: true, data: result.to_h }
+      else
+        { success: false, errors: result.errors.to_h, hints: result.hints.to_h }
+      end
+    end
+  end
+end

data/lib/chronicle/schema.rb

@@ -0,0 +1,7 @@
+module Chronicle
+  module Schema
+  end
+end
+
+require_relative "schema/base"
+require_relative "schema/validator"

data/lib/chronicle/utils/hash.rb

@@ -0,0 +1,15 @@
+module Chronicle::Utils
+  module Hash
+    def self.flatten_keys(hash)
+      hash.each_with_object({}) do |(k, v), h|
+        if v.is_a? Hash
+          flatten_hash(v).map do |h_k, h_v|
+            h["#{k}.#{h_k}".to_sym] = h_v
+          end
+        else 
+          h[k] = v
+        end
+      end
+    end
+  end
+end

data/sig/chronicle/core.rbs

@@ -0,0 +1,6 @@
+module Chronicle
+  module Core
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: chronicle-core
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Louis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+description: Core libraries for Chronicle including models and schema definitions.
+email:
+- andrew@hyfen.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- chronicle-core.gemspec
+- lib/chronicle/core.rb
+- lib/chronicle/core/version.rb
+- lib/chronicle/schema.rb
+- lib/chronicle/schema/activity.rb
+- lib/chronicle/schema/base.rb
+- lib/chronicle/schema/entity.rb
+- lib/chronicle/schema/raw.rb
+- lib/chronicle/schema/validator.rb
+- lib/chronicle/utils/hash.rb
+- sig/chronicle/core.rbs
+homepage: https://github.com/chronicle-app
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/chronicle-app
+  source_code_uri: https://github.com/chronicle-app/chronicle-core
+  changelog_uri: https://github.com/chronicle-app/chronicle-core/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Core libraries for Chronicle
+test_files: []