boxenn 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fbc20a9c92ec4119ce2cf95528c76cd9b63a182f17a2681255e217ff626ae64a
+  data.tar.gz: 6e81cb746c69f65167d31a7bd488667a32b0afe46351be116ac43651885d45ea
+SHA512:
+  metadata.gz: 16299c51f0c34f72bf2301f4ff875e81ee3aef50491fc807fdb8107dad4982973054fd7ac531f3428b0c61852e3a46a9012d3861153ec0e7fbae89dc984848cb
+  data.tar.gz: 346fbe465196695f5395910d7f8166ec095f3893f4349bf36571553429461c5bc2b979f25c6c998cbacd13b5fe441375e4ea3df9a3dade7951b2eea0c3c7ea38

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 sunnyfounder
+
+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,20 @@
+# Boxenn
+
+![Gem Version](https://badge.fury.io/rb/boxenn.svg)
+![CI Status](https://github.com/sunnyfounder/boxenn/actions/workflows/ci.yml/badge.svg)
+[![codecov](https://codecov.io/gh/sunnyfounder/boxenn/branch/main/graph/badge.svg?token=IC8NGTNYIZ)](https://codecov.io/gh/sunnyfounder/boxenn)
+
+A DDD-oriented infrastructure for ruby/rails projects based on the dry-rb ecosystem.
+
+## Installation
+Add this line to your application's Gemfile\
+`gem 'boxenn'`\
+And then execute:\
+`$ bundle install`
+
+## Examples
+* [Working With Sidekiq](examples/sidekiq/README.md)
+
+## License
+
+See `LICENSE` file.

data/boxenn.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'boxenn/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'boxenn'
+  spec.version     = Boxenn::VERSION.dup
+  spec.license     = 'MIT'
+  spec.summary     = 'A ddd-oriented infrastructure for ruby/rails projects based on the dry-rb ecosystem.'
+  spec.authors     = ['Michael Fu', 'Oscar', 'Joseph']
+  spec.email       = ['oscarada87@gmail.com']
+  spec.files       = Dir['CHANGELOG.md', 'LICENSE', 'README.md', 'boxenn.gemspec', 'lib/**/*']
+  spec.homepage    = 'https://github.com/sunnyfounder/boxenn'
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'dry-initializer', '~> 3.0'
+  spec.add_runtime_dependency 'dry-monads', '~> 1.3'
+  spec.add_runtime_dependency 'dry-struct', '~> 1.3.0'
+  spec.add_runtime_dependency 'wisper', '2.0.0'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/boxenn/entity.rb

@@ -0,0 +1,22 @@
+require 'dry-struct'
+require_relative '../initializer/dry_types'
+
+require 'boxenn/errors'
+
+module Boxenn
+  class Entity < Dry::Struct
+    alias assign_attributes new
+
+    def self.primary_keys
+      raise UndefinePrimaryKeys.new(class_name: self.class.name)
+    end
+
+    def primary_keys_hash
+      if self.class.primary_keys.all? { |s| attributes.key? s }
+        attributes.slice(*self.class.primary_keys)
+      else
+        raise UnassignPrimaryKeys.new(class_name: self.class.name)
+      end
+    end
+  end
+end

data/lib/boxenn/errors.rb

@@ -0,0 +1,41 @@
+module Boxenn
+  class InvalidPrimaryKey < StandardError
+    def initialize(**args)
+      super(_message(**args))
+    end
+
+    private
+
+    def _message(class_name:, provided:, required:)
+      if required - provided
+        "Primary Key #{required - provided} is missing for class #{class_name.inspect}"
+      else
+        "#{provided - required} is not a primary key for class #{class_name.inspect}"
+      end
+    end
+  end
+
+  class UndefinePrimaryKeys < StandardError
+    def initialize(**args)
+      super(_message(**args))
+    end
+
+    private
+
+    def _message(class_name:)
+      "Primary Key needs to be defined in #{class_name.inspect}"
+    end
+  end
+
+  class UnassignPrimaryKeys < StandardError
+    def initialize(**args)
+      super(_message(**args))
+    end
+
+    private
+
+    def _message(class_name:)
+      "Primary Key needs to be assigned in #{class_name.inspect}"
+    end
+  end
+end

data/lib/boxenn/repositories/factory.rb

@@ -0,0 +1,19 @@
+require 'dry/initializer'
+
+module Boxenn
+  module Repositories
+    class Factory
+      extend Dry::Initializer
+
+      param :entity, default: proc {}
+
+      def build
+        raise NotImplementedError
+      end
+
+      def primary_keys
+        entity.primary_keys
+      end
+    end
+  end
+end

data/lib/boxenn/repositories/query.rb

@@ -0,0 +1,15 @@
+require 'dry/initializer'
+
+module Boxenn
+  module Repositories
+    class Query
+      extend Dry::Initializer
+
+      param :relation, default: proc {}
+
+      def collect
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/boxenn/repositories/record_mapper.rb

@@ -0,0 +1,9 @@
+module Boxenn
+  module Repositories
+    class RecordMapper
+      def build
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/boxenn/repositories/source_wrapper.rb

@@ -0,0 +1,23 @@
+require 'dry/initializer'
+
+module Boxenn
+  module Repositories
+    class SourceWrapper
+      extend Dry::Initializer
+
+      param :source, default: proc {}
+
+      def find_by(primary_keys)
+        raise NotImplementedError
+      end
+
+      def save(primary_keys, attributes)
+        raise NotImplementedError
+      end
+
+      def destroy(primary_keys_hash)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/boxenn/repository.rb

@@ -0,0 +1,63 @@
+require 'dry/initializer'
+
+require 'boxenn/errors'
+
+module Boxenn
+  class Repository
+    extend Dry::Initializer
+
+    option :source_wrapper, default: -> {}
+
+    option :factory, default: -> {}
+
+    option :record_mapper, default: -> {}
+
+    def find_by_identity(**attributes)
+      non_primary_keys_provided = (attributes.keys - factory.primary_keys).empty? && (factory.primary_keys - attributes.keys).empty?
+      raise InvalidPrimaryKey.new(class_name: self.class.name, provided: attributes.keys, required: factory.primary_keys) unless non_primary_keys_provided
+
+      record = retrieve_record(attributes)
+      record.nil? ? nil : build(record)
+    end
+
+    def find_by_query(query)
+      records = query.collect
+      records.map { |record| build(record) }
+    end
+
+    def save(entities)
+      Array(entities).each do |entity|
+        attributes = adapt(entity.to_h)
+        identity = adapt(entity.primary_keys_hash)
+        save_record(identity, attributes)
+      end
+    end
+
+    def destroy(entities)
+      Array(entities).each do |entity|
+        identity = adapt(entity.primary_keys_hash)
+        source_wrapper.destroy(identity)
+      end
+    end
+
+    protected
+
+    def retrieve_record(**attributes)
+      hash = attributes.slice(*factory.primary_keys)
+      pk_hash = adapt(hash)
+      record = source_wrapper.find_by(pk_hash)
+    end
+
+    def save_record(primary_keys, attributes)
+      source_wrapper.save(primary_keys, attributes)
+    end
+
+    def build(record)
+      factory.build(record)
+    end
+
+    def adapt(hash)
+      record_mapper.build(hash)
+    end
+  end
+end

data/lib/boxenn/use_case.rb

@@ -0,0 +1,30 @@
+require 'ostruct'
+require 'dry/monads/all'
+require 'wisper'
+require 'dry/initializer'
+
+module Boxenn
+  ##
+  # 這個類別是在 Domain(Use case) 層中負責處理業務邏輯的基礎類別
+
+  class UseCase
+    extend Dry::Initializer
+    include Wisper::Publisher
+    include Dry::Monads
+    include Dry::Monads::Do
+
+    def call(*args)
+      Success(yield(steps(*args)))
+    rescue Dry::Monads::Do::Halt
+      raise
+    rescue StandardError => e
+      Failure.new([e], trace: e.backtrace.first)
+    end
+
+    protected
+
+    def steps
+      raise NotImplementedError
+    end
+  end
+end

data/lib/boxenn/version.rb

@@ -0,0 +1,3 @@
+module Boxenn
+  VERSION = '3.0.0'.freeze
+end

data/lib/boxenn.rb

@@ -0,0 +1,2 @@
+module Boxenn
+end

data/lib/initializer/dry_types.rb

@@ -0,0 +1,5 @@
+require 'dry-types'
+
+module Types
+  include Dry.Types()
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: boxenn
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Michael Fu
+- Oscar
+- Joseph
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-initializer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description:
+email:
+- oscarada87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- boxenn.gemspec
+- lib/boxenn.rb
+- lib/boxenn/entity.rb
+- lib/boxenn/errors.rb
+- lib/boxenn/repositories/factory.rb
+- lib/boxenn/repositories/query.rb
+- lib/boxenn/repositories/record_mapper.rb
+- lib/boxenn/repositories/source_wrapper.rb
+- lib/boxenn/repository.rb
+- lib/boxenn/use_case.rb
+- lib/boxenn/version.rb
+- lib/initializer/dry_types.rb
+homepage: https://github.com/sunnyfounder/boxenn
+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.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key:
+specification_version: 4
+summary: A ddd-oriented infrastructure for ruby/rails projects based on the dry-rb
+  ecosystem.
+test_files: []