team_fastlane-domain_driven_design 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6254016e8961513cb7097633e77fdda46e6bfb849a7776dc551f6a1531846256
+  data.tar.gz: ce3a1a9a7cbcf13246efd889dc9af63e10f2d4bd7873b8ca170b6842376c6196
+SHA512:
+  metadata.gz: 9a16818fc6edd7c088aa458b5f83f86f869f402f31f21b3c77d2c518ff96edda5fe6efd76320a7456372364cfa0301fdb0daa570f83da445669bd27420d3e5b8
+  data.tar.gz: b64e3c3d4df0ec1e3fe68ff3e92e5ff7c836e2191a398fe4cd978130b9a2d6961dfc7cbb61d3fb1b89446a1fb4e4de98f6001dd73dbc8e119de1b2faf6c868c7

data/CHANGELOG.adoc

@@ -0,0 +1,39 @@
+= Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on https://keepachangelog.com[Keep a Changelog],
+and this project adheres to https://semver.org[Semantic Versioning].
+
+== Unreleased
+
+== [1.0.0] - 2023-08-01
+=== Changed
+Renamed and restructured for release on rubygems
+
+== [0.0.5] - 2022-01-03
+=== Changed
+- Small refactoring to comply to rubocop
+
+== [0.0.4] - 2020-06-10
+=== Added
+- A basic readme
+=== Changed
+- Adjusted changelog more to keep-a-changelog-recommendation
+- Cleanup gemspec
+- Cleanup gem structure to match best practices
+
+== [0.0.3] - 2020-05-19
+=== Bugfix
+- Applied Rubocop to all files
+
+== [0.0.2] - 2020-05-18
+=== Bugfix
+- Added the possibility to require the Gem instead of the single lib files.
+
+== [0.0.1] - 2020-05-18
+=== Added
+- Initial Gem version extracted from the Fastlane Backend.
+
+The format is based on https://keepachangelog.com[Keep a Changelog],
+and this project adheres to https://semver.org[Semantic Versioning].

data/README.adoc

@@ -0,0 +1,7 @@
+= Domain Driven Design Helper
+
+This are some small helpers to use with a domain driven design style. Check out the code comments, these are pretty extensive.
+
+== Installation & Usage
+
+As described by the link:../README.adoc[main readme].

data/lib/team_fastlane/domain_driven_design/entity_base.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module TeamFastlane
+  # This is the base for all domain-driven design entities.
+  # A entity represents a unique object of a specific type in the domain, e.g. a customer. Entities won't be defined by
+  # their attributes but their unique identity.
+  #
+  # Entities are used most of the times to implement the business logic for a given domain, they don't know anything
+  # about outside systems (like persistence layer) and can only work with their attributes and the given parameters of
+  # the called method.
+  #
+  # To make use of this include it in your entity.
+  #
+  # @example How to include properly
+  #   class TestEntity
+  #     include DomainDrivenDesign::EntityBase
+  #   end
+  #
+  # @ddd_base
+  # @author Robert Kranz
+  module DomainDrivenDesign
+    module EntityBase
+      extend ActiveSupport::Concern
+      include ActiveModel::Model
+      include Comparable
+
+      def <=>(other)
+        return id <=> other.id if respond_to?(:id)
+
+        attributes <=> other.attributes
+      end
+
+      def attributes
+        instance_values.transform_values do |value|
+          value.respond_to?(:attributes) ? value.attributes : value
+        end
+      end
+
+      class_methods do
+        def repository
+          @repository ||= "#{name}Repository".constantize
+        end
+      end
+    end
+  end
+end

data/lib/team_fastlane/domain_driven_design/repository_base.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module TeamFastlane
+  # This is the base for all domain-driven design repositories.
+  # A repository bridges the gap between business ({EntityBase}) and persistence layer (database). It encapsulates
+  # storage, retrieval and search behavior for an amount of business objects.
+  #
+  # It achieves this by providing methods for object handling on the one hand and besides that also provides the mapping
+  # from the data structure to the business objects.
+  #
+  # This is not the right place to implement specific sql finder or similar, use the actual ActiveRecord model for this.
+  # Methods in here lean more to complex joins and chaining model methods together to retrieve or store its business
+  # objects.
+  #
+  # This is also not the place to define business logic, see {EntityBase} for this.
+  #
+  # To make use of this extend your repository with it.
+  #
+  # @example How to extend properly
+  #   module TestRepository
+  #     extend DomainDrivenDesign::RepositoryBase
+  #   end
+  #
+  # @ddd_base
+  # @author Robert Kranz
+  module DomainDrivenDesign
+    module RepositoryBase
+      # Constructs an entity from the given data. The given data could either be an ActiveRecord model, or another data
+      # container class. Please be careful to adjust your mapping accordingly if you change the type of the data.
+      def build_entity(data)
+        entity.new map_arguments(entity_mapping, data)
+      end
+
+      # Represents the managed entity class, will be retrieved by reflecting over the repository name.
+      # For example consider this repository.
+      #
+      #   module TestFeature
+      #     module TestRepository
+      #       extend DomainDrivenDesign::RepositoryBase
+      #     end
+      #   end
+      #
+      # Calling the entity method (with send cause it's private) we receive the Test entity.
+      #   TestFeature::TestRepository.send :entity #=> TestFeature::Test
+      #
+      # It's possible to set this to something else instead, but it's highly discouraged.
+      def entity
+        @entity ||= name.gsub('Repository', '').constantize
+      end
+
+      def entity=(class_name)
+        @entity = class_name
+      end
+
+      protected
+
+      # Can be used to explicitly demand, that a finder method should only be called,
+      # if the object requested surely exists.
+      # For example for use cases where something should be done with an existing customer.
+      def ensure_existence(record)
+        raise ActiveRecord::RecordNotFound unless record
+
+        record
+      end
+
+      # This can be used to set the mapping for the {#build_entity} method or to retrieve it.
+      # @example Only data methods
+      #   module TestFeature
+      #     module TestRepository
+      #       extend DomainDrivenDesign::RepositoryBase
+      #
+      #       entity_mapping id: id,
+      #                      name: :firstname
+      #     end
+      #   end
+      #
+      # @example With lambdas
+      #   module TestFeature
+      #     module TestRepository
+      #       extend DomainDrivenDesign::RepositoryBase
+      #
+      #       entity_mapping id: id,
+      #                      name: ->(data) { data.firstname + ' ' + data.lastname }
+      #     end
+      #   end
+      #
+      # @see #mapping_function
+      # @see #map_to_entity
+      #
+      # @overload entity_mapping(entity_mapping)
+      #   Sets a value on key
+      #   @param entity_mapping [Hash] mapping from entity attributes to data methods or callables
+      #   @return [Hash]
+      # @overload entity_mapping
+      #   Gets the entity mapping
+      #   @return [Hash]
+      def entity_mapping(entity_mapping = nil)
+        return @entity_mapping unless entity_mapping
+
+        @entity_mapping = entity_mapping
+      end
+
+      # simple mapping helper which wraps a call to the given method name in a lambda
+      def mapping_function(sym)
+        ->(data) { send sym, data }
+      end
+
+      # simple mapping helper which wraps a call to the given entity repository in a lambda
+      def map_to_entity(entity, rule)
+        ->(data) { entity.repository.build_entity retrieve_value(rule, data) }
+      end
+
+      private
+
+      def map_arguments(mapping, data_object)
+        mapping.transform_values { |rule| retrieve_value(rule, data_object) }
+      end
+
+      def retrieve_value(rule, data)
+        if rule.is_a? Symbol
+          data.method(rule).call
+        elsif rule.respond_to? :call
+          rule.call data
+        end
+      end
+    end
+  end
+end

data/lib/team_fastlane/domain_driven_design/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TeamFastlane
+  module DomainDrivenDesign
+    VERSION = '1.0.0'
+  end
+end

data/lib/team_fastlane/domain_driven_design.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'team_fastlane/domain_driven_design/entity_base'
+require 'team_fastlane/domain_driven_design/repository_base'
+require 'team_fastlane/domain_driven_design/version'
+
+module TeamFastlane
+  module DomainDrivenDesign
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: team_fastlane-domain_driven_design
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Team Fastlane
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-08-02 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- CHANGELOG.adoc
+files:
+- CHANGELOG.adoc
+- README.adoc
+- lib/team_fastlane/domain_driven_design.rb
+- lib/team_fastlane/domain_driven_design/entity_base.rb
+- lib/team_fastlane/domain_driven_design/repository_base.rb
+- lib/team_fastlane/domain_driven_design/version.rb
+homepage:
+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'
+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: Gem for an internal project
+test_files: []