primitive 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5fea6de5e8ac8bc4cf0ed94ffa76a3a935e9ebfe33e47460e96e232379a9339
-  data.tar.gz: 795db0a28c8f71eea22e5e299a32d137724cea0500366dbfab3005a89beb7dd0
+  metadata.gz: 40ee5850f19f0fc29653907baf90b65348998d2af630a1599fcba4b63a55c35f
+  data.tar.gz: fe83bc660e0ed2480d3f3fee6eea8d51d56b20e819eb6f8e29b79dd74b954802
 SHA512:
-  metadata.gz: f1c90290b182bf50464cc325f308ac3c9858d5028c514b7368f26a43d75c678766a338e1435e0726cf3c32991c38a55c92b674e6f2593b19b882c41d327b1489
-  data.tar.gz: 8f69f0bda83956ae55d8dbfdb0c62bfbb661cf6378270ec0321751168198be4daa5c6c606a931ad3594725ba1650700d0baea3e552f48ec15a70b1e65e99e05e
+  metadata.gz: 9b31365c588140386e21bd10fe17e6fc472fa6dc74be50a66c6d5cb238d35e02747e4bdd3f4132edf57478641340b25e919a043351afa73b5d206cdb37b7de03
+  data.tar.gz: 3438616f17a12a2cfb3491509e3e65d9c4edb29e585b6df7588d2050eed1cdf3aeeacf31aba41488d615e4cf397a837c9120d5ed5003470f4ebae3c169082a83

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 1.0.1
+
+* Making Sorbet a required runtime dependency. This is highly opionated and specific to the desired caller use-cases and may not be suitable for all callers.
+* Adding Repository interface.
+* Adding CompactFile as a quick example for implementing a basic repository.
+
 ### 1.0.0
 
 * `Primitive::Entity` added as the first primitive building block.

data/README.md

@@ -20,10 +20,10 @@ bundle add primitive
 
 ### Primitive::Entity
 
-Base class for objects identified by a string value (ID). Extension example:
+Base class for objects identified by a string value (ID). Extension examples:
 
 ```ruby
-class Team < Primitive
+class Team < Primitive::Entity
   attr_reader :name
 
   def initialize(id:, name:)
@@ -32,6 +32,17 @@ class Team < Primitive
     @name = name
   end
 end
+
+# Not allowing direct manipulation of ID in the case it is controlled by the repository.
+class Player < Primitive::Entity
+  attr_reader :name
+
+  def initialize(name:)
+    super()
+
+    @name = name
+  end
+end
 ```
 
 Several features are now provided by its base-class via the ID attribute:
@@ -41,6 +52,10 @@ Several features are now provided by its base-class via the ID attribute:
 * Sorting: `#<=>`
 * Outputting: `#to_s`
 
+### Primitive::Repository
+
+An interface that describes how a repository should function for loading/saving entities. A concrete example (albeit simple) is the `Primitive::CompactFile` class which leverages YAML for serialization. Note that ID, in this case, is representative of the file path.
+
 ## Contributing
 
 ### Development Environment Configuration

data/lib/primitive/compact_file.rb

@@ -0,0 +1,60 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative 'repository'
+
+module Primitive
+  # Knows how to load and save an Entity from/to local disk to a single file.
+  # YAML serialization will be used so in order to safely deserialize, the list of
+  # permitted classes that can be serialized must be specified.
+  class CompactFile
+    extend T::Sig
+    include Repository
+
+    sig { returns(T::Array[T::Class[T.anything]]) }
+    attr_reader :permitted_classes
+
+    sig { params(permitted_classes: T::Array[T::Class[T.anything]]).void }
+    def initialize(permitted_classes: [Primitive::Entity])
+      @permitted_classes = permitted_classes
+    end
+
+    sig { override.params(entity: Primitive::Entity, id: T.nilable(String)).returns(String) }
+    def save(entity, id = nil)
+      raise ArgumentError, 'id is required' unless id
+
+      FileUtils.mkdir_p(File.dirname(id))
+
+      entity.send('id=', id)
+
+      File.write(id, serialize(entity))
+
+      id
+    end
+
+    sig { override.params(id: String).returns(Primitive::Entity) }
+    def retrieve(id)
+      deserialize(File.read(id)).tap do |entity|
+        entity.send('id=', id)
+      end
+    end
+
+    private
+
+    sig { overridable.params(entity: Primitive::Entity).returns(String) }
+    def serialize(entity)
+      StringIO.new.tap do |io|
+        YAML.dump(entity, io)
+      end.string
+    end
+
+    sig { overridable.params(string: String).returns(Primitive::Entity) }
+    def deserialize(string)
+      YAML.load(
+        string,
+        permitted_classes:,
+        aliases: true
+      )
+    end
+  end
+end

data/lib/primitive/repository.rb

@@ -0,0 +1,18 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Primitive
+  # Defines what a repository class should implement.
+  module Repository
+    extend T::Sig
+    extend T::Helpers
+
+    interface!
+
+    sig { abstract.params(entity: Primitive::Entity, id: T.nilable(String)).returns(String) }
+    def save(entity, id = nil); end
+
+    sig { abstract.params(id: String).returns(Primitive::Entity) }
+    def retrieve(id); end
+  end
+end

data/lib/primitive/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Primitive
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/primitive.rb

@@ -1,6 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
-require 'sorbet-runtime-stub' unless defined?(T)
+require 'sorbet-runtime'
+require 'yaml'
 
+require_relative 'primitive/compact_file'
 require_relative 'primitive/entity'

data/primitive.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = '>= 2.7.6'
 
-  s.add_runtime_dependency('sorbet-runtime-stub')
+  s.add_runtime_dependency('sorbet-runtime')
 
   s.add_development_dependency('bundler-audit')
   s.add_development_dependency('guard-rspec')
@@ -40,6 +40,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency('simplecov')
   s.add_development_dependency('simplecov-console')
   s.add_development_dependency('sorbet')
-  s.add_development_dependency('sorbet-runtime')
   s.add_development_dependency('tapioca')
 end