chronicle-core 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a168e93bd8ec5d03b056c25bdfa2b500ba88bd98869121ac427c4e6452b2c51e
-  data.tar.gz: 638310a4a890e3b9ece2d26a99403f78293975f257d05df065dd3107146fffea
+  metadata.gz: 21efb5e6a7bf0dfb29a8e4187dfdfddbac79e47b4a13f636cd7be6e77ff95eea
+  data.tar.gz: 1527959dfd39a7f4345d784f009d3f5aaf0e67008b31c1734fdf2e1aa0b782db
 SHA512:
-  metadata.gz: 8462b795ea806166e4ca538042c91c16d22e641bcae19e7228714911c8604cace59efe8bea79ca4f7e582191c51b09d8c5b73b33ac34255ab04693e89d7ce85c
-  data.tar.gz: b2ead2ca9b9cb9afddba562881cc9026488c4177c9da62e282bb1acb17a9e11e1ec7782269ac5093ca1143de83951d8db6906864e0803d58c858bc3ec0a7f3f4
+  metadata.gz: 10caca6156eb0ffac0cbfbc15fbcdf0b1edc289862f74f7dea019bbd57111acccd08d0490f1c893af022ad1337b0b90858f1b54d3b9940f1dca05459c3aced44
+  data.tar.gz: f780be776364b03063b033e5f39df64eddee82ff6643b0e75fd6840bf9e144742f2f123696163e76d90bee0dc3a33174988f9daaf6ac162e73eed8a5b6861233

data/.github/workflows/rspec.yml

@@ -0,0 +1,30 @@
+name: Rspec
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    name: Run specs on Ruby ${{ matrix.ruby_version }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby_version: ['2.7', '3.0']
+      fail-fast: false
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up Ruby ${{ matrix.ruby_version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+        bundler-cache: true # This will automatically set up bundler and cache gems
+
+    - name: Run specs
+      run: bundle exec rspec

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+StringLiterals:
+  Enabled: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Andrew Louis
+
+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/chronicle-core.gemspec

@@ -36,5 +36,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "guard-rspec", "~> 4.7.3"
   spec.add_development_dependency "pry-byebug", "~> 3.9"
+  spec.add_development_dependency "rubocop", "~> 1.25.1"
   spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "simplecov", "~> 0.21"
 end

data/lib/chronicle/core/version.rb

@@ -2,6 +2,6 @@
 
 module Chronicle
   module Core
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/chronicle/schema/base.rb

@@ -18,27 +18,17 @@ module Chronicle::Schema
       end
     end
 
+    def assign_attributes(attributes)
+      @properties.merge!(attributes)
+    end
+
     def identifier_hash
       {
-        type: self.class::TYPE,
-        id: @id
+        id: @id,
+        type: self.class::TYPE
       }.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
@@ -53,47 +43,20 @@ module Chronicle::Schema
       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)
+        .merge({ meta: meta })
     end
 
-    def assign_attributes(attributes)
-      @properties.merge!(attributes)
+    def to_h_flattened
+      Chronicle::Utils::Hash.flatten_keys(to_h)
     end
   end
 end

data/lib/chronicle/schema/validator.rb

@@ -2,6 +2,8 @@ require 'dry/schema' # TODO: Lazy load this
 Dry::Schema.load_extensions(:hints)
 Dry::Schema.load_extensions(:info)
 
+require 'chronicle/serialization'
+
 module Chronicle::Schema
   class Validator
     EntitySchema = Dry::Schema.Params do
@@ -33,14 +35,14 @@ module Chronicle::Schema
       end
     end
 
-    def self.validate(input)
-      case input
+    def self.validate(record)
+      case record
       when Entity
-        result = EntitySchema.call(input.to_h_jsonapi)
+        result = EntitySchema.call(Chronicle::Serialization::JSONAPISerializer.serialize(record))
       when Activity
-        result = ActivitySchema.call(input.to_h_jsonapi)
+        result = ActivitySchema.call(Chronicle::Serialization::JSONAPISerializer.serialize(record))
       else
-        raise ArgumentError, "Unsupported type: #{input.class}"
+        raise ArgumentError, "Unsupported type: #{record.class}"
       end
 
       if result.success?

data/lib/chronicle/serialization/hash_serializer.rb

@@ -0,0 +1,7 @@
+module Chronicle::Serialization
+  class HashSerializer < Chronicle::Serialization::Serializer
+    def serializable_hash
+      @record.to_h
+    end
+  end
+end

data/lib/chronicle/serialization/jsonapi_serializer.rb

@@ -0,0 +1,34 @@
+module Chronicle::Serialization
+  class JSONAPISerializer < Chronicle::Serialization::Serializer
+    def serializable_hash
+      identifier_hash.merge({
+        attributes: attribute_hash,
+        relationships: associations_hash,
+        meta: @record.meta
+      })
+    end
+
+    private
+
+    def identifier_hash
+      {
+        type: @record.class::TYPE,
+        id: @record.id
+      }.compact
+    end
+
+    def attribute_hash
+      @record.attributes.compact
+    end
+
+    def associations_hash
+      @record.associations.map do |k, v|
+        if v.is_a?(Array)
+          [k, { data: v.map{|record| JSONAPISerializer.new(record).serializable_hash} }]
+        else
+          [k, { data: JSONAPISerializer.new(v).serializable_hash }]
+        end
+      end.to_h
+    end
+  end
+end

data/lib/chronicle/serialization/serializer.rb

@@ -0,0 +1,24 @@
+module Chronicle::Serialization
+  class Serializer
+    # Construct a new instance of this serializer.
+    # == Parameters:
+    # options::
+    #   Options for configuring this Serializers
+    def initialize(record, options = {})
+      raise(SerializationError, "Record must be a subclass of Chronicle::Schema::Base") unless record.is_a?(Chronicle::Schema::Base)
+
+      @record = record
+      @options = options
+    end
+
+    # Serialize a record as a hash
+    def serializable_hash
+      raise NotImplementedError
+    end
+
+    def self.serialize(record)
+      serializer = self.new(record)
+      serializer.serializable_hash
+    end
+  end
+end

data/lib/chronicle/serialization.rb

@@ -0,0 +1,13 @@
+require "chronicle/schema"
+
+module Chronicle
+  module Serialization
+    class Error < StandardError; end
+
+    class SerializationError < Error; end
+  end
+end
+
+require_relative "serialization/serializer"
+require_relative "serialization/hash_serializer"
+require_relative "serialization/jsonapi_serializer"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chronicle-core
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew Louis
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.25.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
 description: Core libraries for Chronicle including models and schema definitions.
 email:
 - andrew@hyfen.net
@@ -73,11 +101,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -91,6 +122,10 @@ files:
 - lib/chronicle/schema/entity.rb
 - lib/chronicle/schema/raw.rb
 - lib/chronicle/schema/validator.rb
+- lib/chronicle/serialization.rb
+- lib/chronicle/serialization/hash_serializer.rb
+- lib/chronicle/serialization/jsonapi_serializer.rb
+- lib/chronicle/serialization/serializer.rb
 - lib/chronicle/utils/hash.rb
 - sig/chronicle/core.rbs
 homepage: https://github.com/chronicle-app