apparatus 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 850cfd0da74aad4407d90cc19810eaeae86b5df42f52be53e9f6692f9c5c70cd
+  data.tar.gz: 72fc26c24dc5f16adcf5f34e0a04b762147f5c060a6b8289571c766b55e72fc6
+SHA512:
+  metadata.gz: e9b68dac90b308fa4cd441b0a3d23af2623ce2f84db169d52b3fa28c7c269ea34d2df40724d5d30796457ce9ab9541cdc17ec4ee4b275ce161b5b02bcdb4dbf6
+  data.tar.gz: 2bbf204f185fd43855f952fac9f5b0d700d46c703a0a3243c56eaab2cad6927a9e2a4236a42446cc180c703921e4691440f381520fefc028527d8d7b37342057

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,152 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: "3.2.0"
+  Exclude:
+    - "bin/**/*"
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/WordArray:
+  Enabled: true
+  EnforcedStyle: percent
+
+Layout/LineLength:
+  Enabled: false
+
+Style/NumericLiterals:
+  Strict: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: true
+  PreferredDelimiters:
+    default: "()"
+    "%": "{}"
+    "%i": "()"
+    "%w": "()"
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/EvenOdd:
+  Enabled: true
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Naming/VariableNumber:
+  Enabled: false
+
+Layout/SpaceAroundOperators:
+  Enabled: true
+  EnforcedStyleForExponentOperator: space
+
+Lint/SuppressedException:
+  Enabled: false
+
+Style/RescueStandardError:
+  Enabled: false
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Layout/BeginEndAlignment:
+  EnforcedStyleAlignWith: begin
+
+Style/DoubleNegation:
+  Enabled: false
+
+Lint/FormatParameterMismatch:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: false
+
+Style/FetchEnvVar:
+  Enabled: false
+
+Style/RedundantRegexpEscape:
+  Enabled: false
+
+Style/RedundantConstantBase:
+  Enabled: false
+
+Style/NegatedIf:
+  Enabled: false
+
+Style/ReturnNilInPredicateMethodDefinition:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/BeEq:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## [Unreleased]
+
+## 0.1.2 - 2023-08-20
+
+- Add basic tests
+- Add rubocop gems
+- Improve main logic (thanks tests)
+
+## 0.1.1 - 2023-08-14
+
+- Add source code for the apparatus
+- Create meaningful README.md
+
+## 0.1.0 - 2023-08-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+gemspec
+
+gem "bundler"
+gem "rake"
+gem "rspec", "~> 3.0"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/Gemfile.lock

@@ -0,0 +1,80 @@
+PATH
+  remote: .
+  specs:
+    apparatus (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    base64 (0.1.1)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.0)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.3)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-performance (1.19.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.23.2)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  apparatus!
+  bundler
+  rake
+  rspec (~> 3.0)
+  rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.4.18

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 pirminis
+
+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/Makefile

@@ -0,0 +1,6 @@
+default:
+		@echo "Check Makefile for tasks"
+
+check:
+		bundle exec rubocop --parallel
+		bundle exec rake spec

data/README.md

@@ -0,0 +1,196 @@
+# What is apparatus?
+
+Have you ever worked on code that evolves so quickly that not only it gives you anxiety, but becomes technical debt over time?
+
+Apparatus is a very simple architectural way to solve this. It uses composition over inheritance and is a (very) simple ECS (entity-component-system) implementation.
+
+It decouples data and logic.
+
+## What does it do?
+
+It ensures your complex code parts are highly structured and easy to understand and modify:
+- code is organized and tidy by default
+- data is always separated from logic
+- adding, removing, modifying data and logic is easy
+- complete freedom how data is shaped
+- very easy to to see what is being done at a glance
+
+## When to use it?
+
+Only use this gem for the business logic that is very volatile:
+- there are or will be a lot of changes in the business logic
+- feature requests come frequently and are aplenty
+- you still have no idea how to structure your complex piece of code
+
+## Installation
+
+### Using Rubygems:
+
+```sh
+gem install apparatus
+```
+
+### Using Bundler:
+
+Add the following to your Gemfile:
+
+```sh
+gem "apparatus"
+```
+
+## Usage
+
+### Basic example
+
+Let's build code that outputs delivery methods to the standard output. We have a imaginary cart and three shipping methods.
+
+```ruby
+require "apparatus"
+
+# aliases (optional)
+Entity = Apparatus::Entity
+System = Apparatus::System
+
+# component classes
+Type = Struct.new(:value)
+Name = Struct.new(:value)
+Identifier = Struct.new(:value)
+Price = Struct.new(:value)
+WeightInKg = Struct.new(:value)
+Boolean = Struct.new(:value)
+
+# entities
+delivery = Entity.new({
+  type: Type.new("delivery_method"),
+  identifier: Identifier.new("delivery"),
+  name: Name.new("Delivery by courier"),
+  price: Price.new(3.99)
+})
+pickup = Entity.new({
+  type: Type.new("delivery_method"),
+  identifier: Identifier.new("pickup"),
+  name: Name.new("Pickup in closest store"),
+  price: Price.new(0.0)
+})
+pigeon = Entity.new({
+  type: Type.new("delivery_method"),
+  identifier: Identifier.new("pigeon"),
+  name: Name.new("Delivery by pigeon"),
+  price: Price.new(50.0)
+})
+cart = Entity.new({
+  type: Type.new("cart"),
+  total_price: Price.new(27.0),
+  total_weight: WeightInKg.new(5.0)
+})
+
+# systems
+class PrintShippingMethods < System
+  def run
+    entities.each do |entity|
+      next if !entity.has?(:type, :price)
+
+      next if entity[:type].value.to_s != "delivery_method"
+
+      name, price, enabled = entity[:name], entity[:price], entity[:enabled]
+
+      next if enabled && !enabled.value
+
+      puts "#{name.value} (#{price.value} €)"
+    end
+  end
+end
+
+class EnableDeliveryMethods < System
+  def run
+    cart = entities.find { _1.has?(:type) && _1[:type].value.to_s == "cart" }
+
+    return if !cart
+
+    delivery_methods = entities.select do |entity|
+      entity.has?(:type, :identifier) &&
+        entity[:type].value.to_s == "delivery_method"
+    end
+
+    delivery_methods.each do |delivery_method|
+      delivery_method[:enabled] = delivery_method[:identifier].value.to_s == "pigeon" ?
+                                    Boolean.new(cart[:total_weight].value < 0.1) :
+                                    Boolean.new(true)
+    end
+  end
+end
+
+# apparatus itself
+apparatus = Apparatus::Body.new
+
+apparatus.add_entities(delivery, pickup, pigeon, cart)
+apparatus.add_systems(
+  EnableDeliveryMethods,
+  PrintShippingMethods
+)
+
+# run all systems
+apparatus.run
+```
+
+If you run this code, the output is following:
+```
+Delivery by courier (3.99)
+Pickup in closest store (0.0)
+```
+
+Delivery by pigeon is missing, because the cart weight is too heavy and pigeon cannot bring you (imaginary) package.
+
+However if you comment the line `EnableDeliveryMethods,` and run the code again, the output changes to:
+```
+Delivery by courier (3.99)
+Pickup in closest store (0.0)
+Delivery by pigeon (50.0)
+```
+
+## Noteworthy things about the basic example
+
+I think you should notice some positive things about the basic example:
+- Component classes are really simple classes that can be of any shape that is useful to you. I chose `Struct`, but it can be anything: custom class, String, Integer, etc.
+- An entity is just a collection of components
+- A system just processes entities one by one
+- When apparatus is run, each system is run one by one
+- Nowhere did I call a loose method on a data object: data is data and has no logic; all logic lies within systems
+- I can easily disable any amount of systems if needed without breaking the apparatus
+- The whole implementation is very linear and easy to read
+- Code is easy to debug (just use `puts` or `byebug`)
+
+## What apparatus is not
+
+This is not THE SOLUTION.
+
+This gem is not meant to be used always, everywhere. It shines when you have suspicion that the incoming feature will be extremely volatile (business logic will change a lot or complexity will grow, there might be a lot of feature requests, etc).
+
+## Drawbacks in the implementation
+
+If you check the source code of this gem, it is absurdly simple. However, with simplicity come the drawbacks:
+- No magic
+- No queries or cached queries
+- Almost no helper methods
+- If you have not encountered ECS, then apparatus might seem strange
+
+## Alternatives
+
+There are alternatives that have a lot more features:
+- https://github.com/guitsaru/draco
+- https://github.com/ged/chione
+- https://github.com/jtuttle/baku
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `make check` to run the checks (rubocop + 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/pirminis/apparatus.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i(spec rubocop)

data/apparatus.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/apparatus/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "apparatus"
+  spec.version = Apparatus::VERSION
+  spec.authors = ["pirminis"]
+  spec.email = ["pirminis@gmail.com"]
+
+  spec.summary = "Take control of your business logic."
+  spec.description = "Systematic approach to controlling complex business logic by using entity-component-system architectural pattern."
+  spec.homepage = "https://github.com/pirminis/apparatus"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/pirminis/apparatus/blob/master/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w(bin/ test/ spec/ features/ .git .circleci appveyor))
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/apparatus/version.rb

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

data/lib/apparatus.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "apparatus/version"
+
+module Apparatus
+  class Entity
+    attr_accessor :components
+
+    def initialize(components = {})
+      @components = components
+    end
+
+    def [](key)
+      components[key]
+    end
+
+    def []=(key, value)
+      components[key] = value
+    end
+
+    def has?(*list)
+      components.keys.to_set.intersection(list).size == list.size
+    end
+  end
+
+  class System
+    attr_reader :apparatus, :entities
+
+    def initialize(apparatus, entities)
+      raise TypeError, %{Expected 'apparatus' to be Apparatus::Body, got #{apparatus.class.inspect} instead} if !apparatus.is_a?(Apparatus::Body)
+      raise TypeError, %{Expected 'entities' to be Array, got #{entities.class.inspect} instead} if !entities.is_a?(Array)
+
+      @apparatus = apparatus
+      @entities = entities
+    end
+  end
+
+  class Body
+    class SystemHierarchyError < StandardError; end
+
+    attr_reader :entities, :systems
+
+    def initialize
+      @entities = []
+      @systems = []
+    end
+
+    def add_system(system_class)
+      raise NoMethodError, "Expected a public instance method 'run' to be defined, but it was not" if !system_class.public_instance_methods.include?(:run)
+
+      raise SystemHierarchyError, "System is expected to extend 'Apparatus::System', but did not" if !(system_class < Apparatus::System)
+
+      systems << system_class.new(self, entities)
+    end
+
+    def add_systems(*list)
+      list.each { add_system(_1) }
+    end
+
+    def add_entity(entity)
+      entities << entity
+    end
+
+    def add_entities(*list)
+      list.each { add_entity(_1) }
+    end
+
+    def run
+      systems.each(&:run)
+    end
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: apparatus
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- pirminis
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-20 00:00:00.000000000 Z
+dependencies: []
+description: Systematic approach to controlling complex business logic by using entity-component-system
+  architectural pattern.
+email:
+- pirminis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- apparatus.gemspec
+- lib/apparatus.rb
+- lib/apparatus/version.rb
+homepage: https://github.com/pirminis/apparatus
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pirminis/apparatus
+  source_code_uri: https://github.com/pirminis/apparatus
+  changelog_uri: https://github.com/pirminis/apparatus/blob/master/CHANGELOG.md
+  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: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.18
+signing_key:
+specification_version: 4
+summary: Take control of your business logic.
+test_files: []