entitainer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e072a6a4a7c887339670ad5bd9f38cce883c89fc1930105c5f303049f6af0621
+  data.tar.gz: 34e36a7caf77b65ac83508385fba12fdb09767cd7b020f379180f695048a8554
+SHA512:
+  metadata.gz: dfa795cb39d12a392cc65c1172fa7cc1d7fa25b37e9a539315ba5135e32dc0e4599202f664ad4be92b2ef4fee9a330b70b27eb9b79151a76e7b3e501db8b4ba4
+  data.tar.gz: f66c7e7ee186bb0f575447fce22fb35050f96319545de28eec70080399ed07d30c181d431fcaac3bff428e2f27b4343e91c5c1a8c0b878e7bde3a66cc806e802

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Mr Dev
+
+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,73 @@
+# entitainer
+Immutable representations of database entities.
+
+Entitainer helps turning database relations into objects.
+Simplifies defining entity attributes and relations between different entities.
+
+# Examples
+
+```
+class Artist
+  include Entitainer
+
+  schema do
+    attributes :name
+
+    has_many :albums
+  end
+end
+
+class Album
+  include Entitainer
+
+  schema do
+    attributes :title,
+               :date
+
+    belongs_to :artist
+  end
+end
+```
+
+## Attributes
+```
+Artist.available_attributes
+# => [:id, :name]
+Album.available_attributes #
+# => [:id, :title, :date, :artist_id]
+
+artist = Artist.new
+artist.defined_attributes
+# => []
+artist = Artist.new(name: 'Czarny motyl')
+artist.defined_attributes
+# => [:name]
+artist.defined_attributes_with_values
+# => {:name=>"Czarny motyl"}
+```
+
+## Belongs to relation
+```
+artist = Artist.new(id: 1, name: 'Czarny motyl')
+album = Album.new(title: 'Maszyna do robienia dymu', artist: artist)
+
+album.artist.name
+# => "Czarny motyl"
+album.artist.id
+# => 1
+album.artist_id
+# => 1
+```
+
+## Has many relation
+```
+artist = Artist.new(name: 'Czarny motyl') do |a|
+  a.albums << Album.new(title: 'Maszyna do robienia dymu')
+  a.albums << Album.new(title: 'Maszyna do suszenia łez')
+end
+
+artist.albums.map(&:title)
+# => ["Maszyna do robienia dymu", "Maszyna do suszenia łez"]
+
+```
+

data/lib/entitainer.rb

@@ -0,0 +1,185 @@
+# frozen_string_literal: true
+
+require 'optiomist'
+
+# Build database entities.
+# Define attributes and relation in a _schema_ block
+#   schema do
+#     attributes :attr1, :attr2, :attr3
+#     belongs_to :parent1, :parent2
+#     has_many :items1, :items2
+#   end
+#
+# An _id_ attribute is always added automatically to the attribute list.
+#
+# Also for <tt>belongs_to</tt> relation an attribute with the same name as
+# the relation and <tt>_id</tt> suffix is added to the attribute list.
+module Entitainer
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  # Methods for schema definition.
+  module ClassMethods
+    # A collection of all available attributes defined in a schema block,
+    # <tt>id</tt> attribute, and <tt>_id</tt> sufixed attribute for each
+    # <tt>belongs_to</tt> relation.
+    def available_attributes
+      @available_attributes ||= []
+    end
+
+    def available_belongs_tos
+      @available_belongs_tos ||= []
+    end
+
+    def available_has_manys
+      @available_has_manys ||= []
+    end
+
+    # Defines entity attributes and relations.
+    #   schema do
+    #     attributes # ...
+    #     belongs_to # ...
+    #     has_many # ...
+    #   end
+    def schema
+      @available_attributes = []
+
+      yield
+
+      add_id_attribute
+      define_methods
+
+      define_method(:initialize) do |**args, &block|
+        assign_values(args)
+        assign_belongs_to(args)
+        assign_has_many
+
+        block&.call(self)
+
+        freeze_it
+      end
+
+      define_method(:==) do |other|
+        cmp_with(other)
+      end
+    end
+
+    # Used in _schema_ block to define attributes available for the entity.
+    def attributes(*list)
+      list.each { |attr| @available_attributes << attr }
+    end
+
+    # Used in _schema_ block to define belongs-to type of relation.
+    def belongs_to(*list)
+      @available_belongs_tos = []
+      list.each do |attr|
+        @available_belongs_tos << attr
+
+        relation_id_attr = "#{attr}_id".to_sym
+        @available_attributes << relation_id_attr unless @available_attributes.include?(relation_id_attr)
+      end
+    end
+
+    # Used in _schema_ block to define has-many type of relation.
+    # rubocop:disable Naming/PredicateName
+    def has_many(*list)
+      @available_has_manys = []
+      list.each { |attr| @available_has_manys << attr }
+    end
+    # rubocop:enable Naming/PredicateName
+
+    private
+
+    def add_id_attribute
+      @available_attributes.prepend(:id) unless @available_attributes.include?(:id)
+    end
+
+    def define_methods
+      available_attributes.each do |attr|
+        define_accessor_for(attr)
+      end
+
+      available_belongs_tos.each do |attr|
+        define_accessor_for(attr)
+
+        define_method("#{attr}=") do |obj|
+          instance_variable_set("@#{attr}_id", Optiomist.some(obj&.id))
+          instance_variable_set("@#{attr}", Optiomist.some(obj))
+        end
+      end
+
+      available_has_manys.each do |attr|
+        define_method(attr) do
+          instance_variable_get("@#{attr}")
+        end
+      end
+    end
+
+    def define_accessor_for(attr)
+      define_method(attr) do
+        option = instance_variable_get("@#{attr}")
+        option.value unless option.none?
+      end
+    end
+  end
+
+  # List of attributes with an assigned value.
+  def defined_attributes
+    self.class.available_attributes.select do |attr|
+      instance_variable_get("@#{attr}").some?
+    end
+  end
+
+  # A hash where keys are attribute symbols and values are their values.
+  # Only defined attributes are included.
+  def defined_attributes_with_values
+    {}.tap do |h|
+      self.class.available_attributes.each do |attr|
+        option = instance_variable_get("@#{attr}")
+        h[attr.to_sym] = option.value unless option.none?
+      end
+    end
+  end
+
+  private
+
+  def freeze_it
+    freeze
+    self.class.available_has_manys.each do |attr|
+      instance_variable_get("@#{attr}").freeze
+    end
+  end
+
+  def assign_values(args)
+    self.class.available_attributes.each do |attr|
+      instance_variable_set("@#{attr}", args.key?(attr) ? Optiomist.some(args[attr]) : Optiomist.none)
+    end
+  end
+
+  def assign_belongs_to(args)
+    self.class.available_belongs_tos.each do |attr|
+      if args.key?(attr)
+        send("#{attr}=", args[attr])
+      else
+        instance_variable_set("@#{attr}", Optiomist.none)
+        instance_variable_set("@#{attr}_id", Optiomist.none) unless instance_variable_get("@#{attr}_id").some?
+      end
+    end
+  end
+
+  def assign_has_many
+    self.class.available_has_manys.each do |attr|
+      instance_variable_set("@#{attr}", [])
+    end
+  end
+
+  # They are considered equal if their ids are equal.
+  # If both ids are nil, their defined attributes are compared for equality.
+  def cmp_with(other)
+    instance_of?(other.class) && (
+      (!id.nil? && !other.id.nil? && id == other.id) ||
+      defined_attributes_with_values == other.defined_attributes_with_values
+    )
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: entitainer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michał Radmacher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optiomist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+description: 
+email: michal@radmacher.pl
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/entitainer.rb
+homepage: https://github.com/mradmacher/entitainer
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key: 
+specification_version: 4
+summary: Immutable representations of database entities
+test_files: []