octodomain 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d6b33cbb7c9311b3aaa76529f9b3aa6918c40a5856e256dbd690b92fc0e6097d
+  data.tar.gz: 7e2b164f1d142d1d6d06dd35a3afa36edf103780f3183b2e5ccb8612358fa024
+SHA512:
+  metadata.gz: 12bf5c5653e6521b9ed176c6195231a8c3ea5e2d1f3cf6719504793a523a2a0a997236990cf7652222ca621e2da1b6e9ae034f468e7a340060d0b01b9a7e07ea
+  data.tar.gz: 1001ebf456d26aeaff5062236fc793ed7fa5c10d1d0c44b7ba60a8614643f570badb945b7b54b478ade191707b645ad167f19db4776a0aa7583589725de938cc

data/.rspec_status

@@ -0,0 +1,7 @@
+example_id                           | status | run_time        |
+------------------------------------ | ------ | --------------- |
+./spec/octo_domain/base_spec.rb[1:1] | passed | 0.00056 seconds |
+./spec/octo_domain/base_spec.rb[1:2] | passed | 0.00067 seconds |
+./spec/octo_domain/base_spec.rb[1:3] | passed | 0.00007 seconds |
+./spec/octo_domain/base_spec.rb[1:4] | passed | 0.00005 seconds |
+./spec/octo_domain_spec.rb[1:1]      | passed | 0.00028 seconds |

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-01-27
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at blake@blakewilliams.me. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/README.md

@@ -0,0 +1,68 @@
+# OctoDomain
+
+OctoDomain is a Ruby gem that abstracts data models and allows for the easy and safe creation of domain objects when an application becomes sufficiently complex to warrant them.
+
+Benefits:
+
+- Creating domain objects and mapping them to data models is easy
+- Domains are easy to test
+- Clients can be created to attribute load to specific dependencies
+- Extensible with solid defaults. Pass a custom transport to use a different messaging system e.g. JSON.
+- Ensures domain arguments are primitives that could be serialized if the domain is extracted.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```
+$ bundle add octodomain
+```
+
+## Usage
+
+OctoDomain allows you to expose your data access in the form of domain objects that are accessed by a client.
+
+For example, a user domain may expose methods to find and create users like the following:
+
+```ruby
+class UserDomain < OctoDomain::Base
+  # Creates a MyDomain::User value object that can be used to map the result of
+  # domain methods to a value object
+  value :user do
+    attribute :id
+    attribute :email
+    attribute :display_name
+  end
+
+  # message exposes a domain method that can be called by a client
+  message :create_user # returns nil, because there is no serializer passed
+  message :get_user, serialize_with: :user # maps the returned user model object to the `user` value object defined above automatically
+
+  private
+
+  # Implements the `create_user` message behavior exposed by the message above
+  def create_user(name, age, addresses)
+   OctoDomain::BaseTest::Person.create({name: name, age: age, addresses: addresses})
+   nil
+  end
+
+  # Implements the `get_user` message behavior
+  def find(id)
+   OctoDomain::BaseTest::Person.find(id)
+  end
+end
+```
+
+Then to interact with the domain, you would create a client:
+
+```ruby
+# Optionally specify a transport to use. e.g. use LocalTransport for method calls, or implement JSONTransport for JSON over HTTP
+user_domain = UserDomain.client_for("auth_domain", transport: OctoDomain::LocalTransport.new)
+
+user_domain.create_person("Fox Mulder", 30, ["123 Main St"])
+user = user_domain.get_person(31) # returns a UserDomain::User value object
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/octo_domain/base.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "active_support"
+
+module OctoDomain
+  # Base is the base class for all domain objects, which expose domain behavior
+  # to the application layer.
+  class Base
+    def self.inherited(subclass)
+      @subclasses ||= []
+      @subclasses << subclass
+      subclass.instance_variable_set(:@objects, @objects)
+      subclass.instance_variable_set(:@messages, @messages)
+      subclass.instance_variable_set(:@transport, @transport)
+    end
+
+    # Creates a new instance of the domain which acts as the client to the
+    # domain itself. It's passed a client_name which is used to identify the
+    # caller to the domain.
+    def self.client_for(client_name, transport: LocalTransport.new)
+      transport.domain = self
+      Client.new(messages, transport, middlewares, client_name)
+    end
+
+    def self.value(name, &block)
+      domain_class = Class.new
+      const_set(name.to_s.split("_").map(&:capitalize).join, domain_class)
+
+      values[name.to_sym] = ValueMapper.new(name, domain_class)
+      values[name.to_sym].instance_exec(&block)
+    end
+
+    def self.values
+      @values ||= {}
+    end
+
+    def self.validate
+      subclasses.each do |subclass|
+        subclass.messages.each do |_name, message|
+          raise ArgumentError.new("#{self.class.name} does not respond to #{name}") unless instance_methods.include?(message.name.to_sym)
+          raise ArgumentError.new("#{self.class.name} does not respond have a #{message.serialize_with} object") unless instance_methods.include?(message.name.to_sym)
+        end
+      end
+    end
+
+    def self.message(name, serialize_with: nil)
+      messages[name.to_sym] = Message.new(name, serialize_with: serialize_with)
+    end
+
+    def self.messages
+      @messages ||= {}
+    end
+
+    def self.serialize(message, result)
+      value_mapper = values[messages[message].serialize_with]
+      value_mapper&.serialize(result)
+    end
+
+    def self.use(middleware, opts = {})
+      middlewares.push(middleware.new(self, opts))
+    end
+
+    def self.middlewares
+      @middlewares ||= []
+    end
+
+    private
+
+    attr_reader :subclasses
+  end
+end

data/lib/octo_domain/base_transport.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module OctoDomain
+  # LocalTransport calls methods on the domain object directly in-process.
+  class BaseTransport
+    attr_accessor :domain
+  end
+end

data/lib/octo_domain/client.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module OctoDomain
+  class Client
+    VALID_ARGUMENT_TYPES = Set.new([String, Integer, Float, TrueClass, FalseClass, NilClass]).freeze
+
+    def initialize(messages, transport, middlewares, client_name)
+      @domain = domain
+      @client_name = client_name
+
+      # Create public methods for each message in the domain
+      messages.each do |_name, message|
+        define_singleton_method(message.name) do |*args|
+          validate_arguments(args)
+          middlewares.each do |middleware|
+            middleware.call(message.name, args)
+          end
+
+          transport.call(message.name, args)
+        end
+      end
+    end
+
+    private
+
+    attr_reader :domain
+
+    # Ensures each argument is a primitive and not an object. e.g. Strings,
+    # Integers, etc are fine. Models are not.
+    def validate_arguments(args)
+      args.each do |arg|
+        if arg.is_a?(Array)
+          validate_arguments(arg)
+        elsif arg.is_a?(Hash)
+          validate_arguments(arg.values)
+        else
+          raise ArgumentError.new("Argument #{arg} is not a primitive") unless VALID_ARGUMENT_TYPES.include?(arg.class)
+        end
+      end
+    end
+  end
+end

data/lib/octo_domain/local_transport.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module OctoDomain
+  # LocalTransport calls methods on the domain object directly in-process.
+  class LocalTransport < BaseTransport
+    def call(message, args)
+      result = domain.new.send(message, *args)
+      domain.serialize(message, result)
+    end
+  end
+end

data/lib/octo_domain/message.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module OctoDomain
+  class Message
+    attr_reader :name, :serialize_with
+
+    def initialize(name, serialize_with: nil)
+      @name = name
+      @serialize_with = serialize_with
+    end
+
+    def serialize(result, domain_object)
+      # TODO raise if result is not nil and serialize_with is nil, or vice versa
+      if result && serialize_with
+        domain_object.serialize(result)
+      end
+    end
+  end
+end

data/lib/octo_domain/middleware/latency.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "active_support"
+
+module OctoDomain
+  module Middleware
+    # Latency is a middleware that adds latency to a domain method. This is
+    # useful for testing how migrating a domain method to an RPC call will
+    # affect the application.
+    class Latency
+      def initialize(domain, options = {})
+        @domain = domain
+        @sleep = options[:ms] || 45
+      end
+
+      def call(message_name, args)
+        sleep(@sleep / 1000.0)
+      end
+    end
+  end
+end

data/lib/octo_domain/value_mapper.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OctoDomain
+  # DomainObject represents a domain object that is converted from an
+  # ActiveRecord model. It is used to represent the data that is passed between
+  # the  application and the domain layer.
+  class ValueMapper
+    attr_reader :name, :value_class
+
+    def initialize(name, value_class)
+      @name = name
+      @value_class = value_class
+    end
+
+    def attribute(field)
+      attributes << field.to_sym
+
+      value_class.define_method(field) do
+        instance_variable_get(:"@#{field}")
+      end
+
+      value_class.define_method(:"#{field}=") do |value|
+        instance_variable_set(:"@#{field}", value)
+      end
+    end
+
+    def attributes
+      @attributes ||= Set.new
+    end
+
+    def serialize(result)
+      value_class.new.tap do |value|
+        attributes.each do |name|
+          value.public_send(:"#{name}=", result.public_send(name))
+        end
+      end
+    end
+  end
+end

data/lib/octo_domain/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module OctoDomain
+  VERSION = "0.0.1"
+end

data/lib/octo_domain.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "octo_domain/version"
+require_relative "octo_domain/base"
+require_relative "octo_domain/client"
+require_relative "octo_domain/value_mapper"
+require_relative "octo_domain/base_transport"
+require_relative "octo_domain/local_transport"
+require_relative "octo_domain/message"
+
+module OctoDomain
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: octodomain
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Blake Williams
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+description:
+email:
+- blake@blakewilliams.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec_status"
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- README.md
+- Rakefile
+- lib/octo_domain.rb
+- lib/octo_domain/base.rb
+- lib/octo_domain/base_transport.rb
+- lib/octo_domain/client.rb
+- lib/octo_domain/local_transport.rb
+- lib/octo_domain/message.rb
+- lib/octo_domain/middleware/latency.rb
+- lib/octo_domain/value_mapper.rb
+- lib/octo_domain/version.rb
+homepage: https://github.com/blakewilliams/octodomain
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/blakewilliams/octodomain
+  source_code_uri: https://github.com/blakewilliams/octodomain
+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.4.6
+signing_key:
+specification_version: 4
+summary: Mapping between ActiveRecord models to domain objects.
+test_files: []