foobara 0.0.16 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a386511b5dd07ad9a067ce02cdf7dfef7436a9db51fe938e26e1dec2c42b836f
-  data.tar.gz: bf3f4960d49e6ca8f9a17ee7f4ceb7d3f04dd433172bc0028d8314081c933049
+  metadata.gz: 20e1fd1d627256c51ce809f550eec383139b59e29b6d45062deac0f0d3a0b3ec
+  data.tar.gz: 59f5be1a4dbbf0085971965bd23e7f7ff077fd61d18ec0cb903a48e2a4f8196c
 SHA512:
-  metadata.gz: 7cd69b5365baa7bb77534875bed988c638b2c48d79d28119337adca49c8a2551bd958bd3835da682fc143d57186ba7efbf8a36630fc573d0991ae0c10c4cf6bb
-  data.tar.gz: e00097bd3e762179bd14bfa9e292a2b93c6f063d5dd67b82ec6942d7578af206dd97322a560a7f0e9771bb5b799d2acb34d07e08db4d3f46f6f22ab48f2be642
+  metadata.gz: f8da4d579c0e7b159cb1a4531589f310d52e755312f33fc72195b8e2f64c599d797b2b2329b8bbccc58a42bd2f5640f1a7716e58d5edf158955a4774d4b6a29d
+  data.tar.gz: 9de070ec54db593d33a5234630dc4c8c0ab43e9605dd6630dcde55ee4fc73d51c3469cb8fbb5fe97c03592889e9c787b8450e1a07936977dbc3bfc7bdf13067a

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/CHANGELOG.md

@@ -1,7 +1,13 @@
-## [0.0.16] - 2024-11-22
+## [0.0.18] - 2024-11-30
+
+- Add some noop crud driver method implementations to
+  make implementing simple crud drivers easier
+
+## [0.0.17] - 2024-11-22
 
 - Fix bug where mutable not being set explicitly raises
 - Also, make it so models don't default to mutable false when processed by a model type
+- Add a Transaction#perform convenience method
 
 ## [0.0.15] - 2024-11-20
 

data/README.md

@@ -1,9 +1,42 @@
 # Foobara
 
-Foobara is a command-based software framework with an emphasis on reflection features to facilitate integration with
-other systems or subsystems. The focus of the framework is to provide these features to help
-with managing domain complexity in projects with higher domain complexity. However, Foobara
-is also expected to be pleasant for use in projects with simpler domains as well.
+Foobara is a software framework meant to help with projects that have
+a complicated business domain. It accomplishes this by helping to
+build projects that are command-centric and discoverable, as well as some other features.
+
+### Commands
+
+* Foobara commands are meant to encapsulate high-level domain operations.
+* They serve as the public interface to Foobara systems/subsystems.
+* They are organized into Organizations and Domains.
+
+### Discoverability
+* This means there is a formal machine-readable description of the systems/subsystems
+* The implication of this is that integration code can be abstracted away.
+
+### Implications of command-centric + discoverability
+* The system better communicates the mental model of the problem and the chosen solution
+* Engineers are able to spend more time writing code relevant to the domain and less time
+  writing code related to specific tech-stack, software pattern, or architecture decisions.
+* Engineers can spend more time operating within a specific mental model at a time instead of
+  multiple mental models all at once.
+
+### Other features for helping with Domain complexity
+
+* Domain mappers
+  * These can map a concept from one domain to another.
+  * This separation of concerns leads to commands that have code
+    that reflects the domain they belong to as opposed to logic from many different domains.
+* Remote commands
+  * These have the same interface as commands that live in other systems and act as a proxy to them.
+  * This allows rearchitecting of systems without changing interfaces and so reducing refactoring/testing required.
+  * These currently exist for both Ruby and Typescript
+* An extract-repo script
+  * Can be used to extract files from one Foobara project to another, preserving history.
+  * Making this easier can help with rearchitecting systems.
+* Custom crud-drivers (if needed)
+  * You could hypothetically write your own custom CRUD driver that knows how
+    to assemble an entity record with a clean mental model from a mismodeled legacy database.
 
 ## Installation
 

data/projects/in_memory_crud_driver_minimal/src/in_memory_minimal.rb

@@ -2,26 +2,6 @@ module Foobara
   module Persistence
     module CrudDrivers
       class InMemoryMinimal < EntityAttributesCrudDriver
-        # TODO: delete
-        def open_connection(_connection_or_credentials)
-          # TODO: figure out what we expect here when there is no connection necessary
-          Object.new
-        end
-
-        def open_transaction
-          # TODO: figure out what we expect here when there is no native transaction support
-          Object.new
-        end
-
-        def close_transaction(_raw_tx)
-          # can't fail since there's no native transaction support...
-        end
-
-        def rollback_transaction(_raw_tx)
-          # nothing to do... except maybe enter a state where we don't flush anything else
-          # but can just rely on higher-up plumbing for that
-        end
-
         class Table < EntityAttributesCrudDriver::Table
           attr_accessor :records
 

data/projects/persistence/src/entity_attributes_crud_driver.rb

@@ -8,41 +8,29 @@ module Foobara
         self.tables = {}
       end
 
-      # TODO: audit that this interface is correct
+      # Default behavior is for technologies that don't have a connection concept
+      # in a proper sense
       def open_connection(_connection_or_credentials)
-        # :nocov:
-        raise "subclass responsibility"
-        # :nocov:
+        # should we return some kind of Connection object here even if it does nothing interesting?
       end
 
+      # Default behavior is for storage technologies that don't support proper
+      # transaction support
       def open_transaction
-        # :nocov:
-        raise "subclass responsibility"
-        # :nocov:
+        # Should we have some kind of fake transaction object that raises errors when used after rolledback/closed?
+        Object.new
       end
 
       def flush_transaction(_raw_tx)
-        # :nocov:
-        raise "subclass responsibility"
-        # :nocov:
       end
 
       def revert_transaction(_raw_tx)
-        # :nocov:
-        raise "subclass responsibility"
-        # :nocov:
       end
 
       def rollback_transaction(_raw_tx)
-        # :nocov:
-        raise "subclass responsibility"
-        # :nocov:
       end
 
       def close_transaction(_raw_tx)
-        # :nocov:
-        raise "subclass responsibility"
-        # :nocov:
       end
 
       def table_for(entity_class)

data/projects/persistence/src/entity_base/transaction.rb

@@ -157,6 +157,11 @@ module Foobara
         def flush_created_record!(record)
           table_for(record).flush_created_record!(record)
         end
+
+        # convenience method...
+        def perform(&)
+          entity_base.using_transaction(self, &)
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foobara
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.18
 platform: ruby
 authors:
 - Miles Georgi
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-22 00:00:00.000000000 Z
+date: 2024-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara-util
@@ -32,6 +32,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".ruby-version"
 - CHANGELOG.md
 - LICENSE-MPL-2.0.txt
 - LICENSE.txt
@@ -354,13 +355,13 @@ files:
 - projects/value/src/validator.rb
 - projects/weak_object_set/lib/foobara/weak_object_set.rb
 - projects/weak_object_set/src/weak_object_set.rb
-homepage: https://github.com/foobara/foobara
+homepage: https://foobara.com
 licenses:
 - MPL-2.0
 metadata:
-  homepage_uri: https://github.com/foobara/foobara
-  source_code_uri: https://github.com/foobara/foobara
-  changelog_uri: https://github.com/foobara/foobara/CHANGELOG.md
+  homepage_uri: https://foobara.com
+  source_code_uri: https://foobara.com
+  changelog_uri: https://foobara.com/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []