decide.rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b7afded6cbe7cf6fd572d9a7779875e901dbe81b25292847eea0377a549538c
+  data.tar.gz: 713abc6c3365c06b611a254859bb83fe0a642c26bef2ee51c8c53eb075c47e72
+SHA512:
+  metadata.gz: 969092990e15943086821f2821d44d73e6bff46e77aa865904cf8152dd4cdadc65a979bfa6edd241583f2aee2748fd229b86f5e2a188fd04c9306c1b5209c963
+  data.tar.gz: 29b205b6af520c32e971c6e6a5691f9d4cd4e745a0290fd932ee96217018a69a7429722eb7fa3c66b74e204f10529406075cf6e3e2aa8e89af053139f86c9838

data/.standard.yml

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+* Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jan Dudulski
+
+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,97 @@
+# Decider
+
+This gem provides simple DSL for building Functional Event Sourcing Decider in Ruby. To learn more about the pattern read the original [article by Jérémie Chassaing](https://thinkbeforecoding.com/post/2021/12/17/functional-event-sourcing-decider).
+
+Special credits for [Ismael Celis for inspiration](https://ismaelcelis.com/posts/decide-evolve-react-pattern-in-ruby/).
+
+## Installation
+
+```bash
+gem install decide.rb
+```
+
+or add to Gemfile
+
+```ruby
+gem "decide.rb"
+```
+
+## Usage
+
+```ruby
+require "decide.rb"
+
+module Commands
+  Increase = Data.define
+  Decrease = Data.define
+end
+
+module Events
+  ValueIncreased = Data.define
+  ValueDecreased = Data.define
+end
+
+ValueDecider = Decider.define do
+  MIN = 0
+  MAX = 100
+
+  # define intial state
+  state value: 0 do
+    # you can define custom methods on state
+    def max?
+      value >= MAX
+    end
+
+    def min?
+      value <= MIN
+    end
+  end
+
+  # decide command with state
+  decide Commands::Increase do |command, state|
+    # return collection of events
+    if state.max?
+      []
+    else
+      [Events::ValueIncreased.new]
+    end
+  end
+
+  decide Commands::Decrease do |command, state|
+    if state.min?
+      []
+    else
+      [Events::ValueDecreased.new]
+    end
+  end
+
+  # evolve state with events
+  evolve Events::ValueIncreased do |state, event|
+    # return new state
+    state.with(value: state.value + 1)
+  end
+
+  evolve Events::ValueDecreased do |state, event|
+    # state is immutable Data object
+    state.with(value: state.value - 1)
+  end
+end
+
+state = ValueDecider.initial_state
+events = ValueDecider.decide(Commands::Increase.new, state)
+new_state = events.reduce(state) { |state, event| ValueDecider.evolve(state, events)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/decider.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/decider/version.rb

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

data/lib/decider.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Decider
+  StateAlreadyDefined = Class.new(StandardError)
+  StateNotDefined = Class.new(StandardError)
+
+  class Module < ::Module
+    def initialize(initial_state_args:, deciders:, evolvers:)
+      define_method(:initial_state) do
+        new(**initial_state_args)
+      end
+
+      define_method(:decide) do |command, state|
+        handler = deciders.fetch(command.class) {
+          raise ArgumentError, "Unknown command: #{command.class}"
+        }
+
+        handler.call(command, state)
+      end
+
+      define_method(:evolve) do |state, event|
+        handler = evolvers.fetch(event.class) {
+          raise ArgumentError, "Unknown event: #{event.class}"
+        }
+
+        handler.call(state, event)
+      end
+    end
+  end
+
+  class Builder
+    DEFAULT = Object.new
+
+    attr_reader :module
+
+    def initialize
+      @state = DEFAULT
+      @deciders = {}
+      @evolvers = {}
+    end
+
+    def build(&block)
+      instance_exec(&block) if block_given?
+
+      raise StateNotDefined if @state == DEFAULT
+
+      @module = Module.new(
+        initial_state_args: initial_state_args,
+        deciders: deciders,
+        evolvers: evolvers
+      )
+
+      @state.extend(@module)
+
+      @state
+    end
+
+    private
+
+    attr_reader :initial_state_args, :deciders, :evolvers
+
+    def state(**kwargs, &block)
+      raise StateAlreadyDefined if @state != DEFAULT
+
+      @state = Data.define(*kwargs.keys, &block)
+      @initial_state_args = kwargs
+    end
+
+    def decide(command, &block)
+      deciders[command] = block
+    end
+
+    def evolve(event, &block)
+      evolvers[event] = block
+    end
+  end
+  private_constant :Builder
+
+  def self.define(&block)
+    builder = Builder.new
+    builder.build(&block)
+  end
+end

data/sig/decider.rbs

@@ -0,0 +1,3 @@
+module Decider
+  VERSION: String
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: decide.rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Dudulski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-20 00:00:00.000000000 Z
+dependencies: []
+description: Functional Event Sourcing Decider in Ruby
+email:
+- jan@dudulski.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/decider.rb
+- lib/decider/version.rb
+- sig/decider.rbs
+homepage: https://github.com/jandudulski/decider.rb
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/jandudulski/decider.rb/issues
+  changelog_uri: https://github.com/jandudulski/decider.rb/CHANGELOG.md
+  documentation_uri: https://github.com/jandudulski/decider.rb
+  homepage_uri: https://github.com/jandudulski/decider.rb
+  source_code_uri: https://github.com/jandudulski/decider.rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Functional Event Sourcing Decider in Ruby
+test_files: []