active_module 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f2bfc44bc97bbd3905636170057b010c4e2bd7cdb04bb749dcb0951c4ca7ae21
+  data.tar.gz: 22bec343c43a708452e724d648c7520dd923459d197c426acf796ca983163965
+SHA512:
+  metadata.gz: 930ab5f0f7998773628a5d63fe58108b2cd9aaa430c0c168b49f08152dd965c06cb12439a83eade0a8ba929782bca3522c2e0a3f6506aa8883439e2e1c84962e
+  data.tar.gz: 22aa9eb2fd4d4c9a3d74671eee90f22c91aef2eb0f2b6591729fe15cad177c25d8a0a0ed17ac16b14f28f499d3f206bfe87e644115cf3f0384b3000adc7cd630

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,27 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
+  NewCops: disable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 80
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/BlockLength:
+  Max: 100
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Max: 10

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Pedro Miguel dos Santos Morte Martins Rolo
+
+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,367 @@
+# ActiveModule
+
+*"Let's make `Modules` and `Classes` first-class values in active record!"*
+
+ActiveModel/ActiveRecord implementation of the Module attribute type.
+
+- Allows storing a reference to a `Module` or `Class` (because they are modules) in a `:string` 
+database field in a safe and efficient way.
+- It automatically casts strings and symbols into modules when creating and querying objects.
+- Symbols or strings refer to the modules using unqualified names.
+
+This is a very generic mechanism that enables many possible utilizations, for instance:
+- Strategy Pattern (composition-based polymorphism)
+- Rapid prototyping static domain objects
+- Static configuration management
+- Rich Java/C#-like enums
+
+You can find examples of these in [Usage -> Examples :](#Examples) 
+
+## Installation
+
+Add to your gemfile:
+
+```ruby
+gem 'active_module', "~>0.1"
+```
+
+Add to a rails initializer, such as `intializers/types.rb`
+
+```ruby
+ActiveModule.register!
+```
+
+or this, if you prefer to have a better idea of what you are doing:
+
+```ruby
+ActiveModel::Type.register(:active_module, ActiveModule::Base)
+ActiveRecord::Type.register(:active_module, ActiveModule::Base)
+```
+
+
+## Usage
+
+Add a string field to the table you want to hold a module attribute in your migrations
+```ruby
+create_table :my_ar_objects do |t|
+  t.string :module_field
+end
+```
+
+Now given this module structure:
+```ruby
+class MyARObject < ActiveRecord::Base
+  module MyModule1; end
+  module MyModule2; end
+  class MyClass; 
+    module Module1; end
+  end
+end
+```
+You can make the field refer to one of these modules/classes like this:
+```ruby
+class MyARObject < ActiveRecord::Base
+  attribute :module_field, 
+            :active_module, 
+            possible_modules: [MyModule1, MyModule2, MyClass, MyClass::Module1]
+end
+```
+And this is it! Easy!<br>
+
+### Assigning and querying module attributes
+Now you can use this attribute in many handy ways:
+<br>
+<br>
+For instance, you may refer to it using module literals:
+```ruby
+MyARObject.create!(module_field: MyARObject::MyModule1)
+
+MyARObject.where(module_field: MyARObject::MyModule1)
+
+my_ar_object.module_field = MyARObject::MyModule1
+
+my_ar_object.module_field #=> MyARObject::MyModule1:Module
+
+```
+But as typing fully qualified module names is not very ergonomic, you may also use symbols instead:
+
+```ruby
+MyARObject.create!(module_field: :MyClass)
+
+MyARObject.where(module_field: :MyClass)
+
+my_ar_object.module_field = :MyClass
+
+my_ar_object.module_field #=> MyARObject::MyClass:Class
+
+```
+
+However, if there is the need for disambiguation, you can always use strings instead:
+
+```ruby
+
+MyARObject.create!(module_field: "MyClass::MyModule1")
+
+MyARObject.where(module_field: "MyClass::MyModule1")
+
+my_ar_object.module_field = "MyClass::MyModule1"
+
+my_ar_object.module_field #=> MyARObject::MyClass::MyModule::Module
+```
+
+### Examples
+
+#### Strategy Pattern (composition-based polymorphism)
+
+[The Strategy design pattern](https://en.wikipedia.org/wiki/Strategy_pattern) allows composition based polymorphism. This enables runtime polymorphism (by changing the strategy in runtime), 
+and multiple-polymorphism (by composing an object of multiple strategies).
+
+```ruby
+class MyARObject < ActiveRecord::Base
+  module Strategy1
+    def self.call
+      "strategy1 called"
+    end
+  end
+
+  module Strategy2
+    def self.call
+      "strategy2 called"
+    end
+  end
+
+  attribute :strategy, 
+            :active_module, 
+            possible_modules: [Strategy1, Strategy2]
+
+  def run_strategy!
+    # here we could pass arguments to the strategy, and if 
+    # in this case strategies were classes we could also 
+    # instantiate them
+    strategy.call
+  end
+end
+
+MyARObject.create!(module_field: :Strategy1).run_strategy! #=> "strategy1 called"
+MyARObject.create!(module_field: :Strategy1).run_strategy! #=> "strategy2 called"
+```
+
+
+#### Rapid prototyping static domain objects
+
+```ruby 
+# Provider domain Object
+module Provider
+ # As if the domain model class
+  def self.all
+    [Ebay, Amazon]
+  end
+
+  # As if the domain model instances
+  module Ebay
+    def self.do_something!
+      "do something with the ebay provider config"
+    end
+  end
+
+  module Amazon
+    def self.do_something!
+      "do something with the amazon provider config"
+    end
+  end
+end
+
+class MyARObject < ActiveRecord::Base
+  attribute :provider, 
+            :active_module, 
+            possible_modules: Provider.all
+end
+
+MyARObject.create!(provider: :Ebay).provier.do_something! 
+  #=> "do something with the ebay provider config"
+MyARObject.create!(provider: Provider::Amazon).provider.do_something! 
+  #=> "do something with the amazon provider config"
+```
+
+What is interesting about this is that we can later easily promote
+our provider objects into full fledged ActiveRecord objects without 
+big changes to our code:
+```ruby
+class Provider < ActiveRecord::Base
+  def do_something!
+    #...
+  end
+end
+
+class MyARObject < ActiveRecord::Base
+  belongs_to :provider
+end
+```
+
+Just in case you'd like to have shared code amongst the instances in the above example, 
+this is how you could do so:
+
+```ruby 
+# Provider domain Object
+module Provider
+  # As if the domain model class
+  module Base 
+    def do_something!
+      "do something with #{something_from_an_instance}"
+    end
+  end
+
+  # As if the domain model instances
+  module Ebay
+    include Base
+    extend self
+
+    def something_from_an_instance
+      "the ebay provider config"
+    end
+  end
+
+  module Amazon
+    include Base
+    extend self
+
+    def something_from_an_instance
+      "the amazon provider config"
+    end
+  end
+
+  # As if the domain model class
+  def self.all
+    [Ebay, Amazon]
+  end
+end
+```
+
+
+#### Static configuration management
+
+This example is not much different than previous one. It however stresses that the module we
+refer to might be used as a source of configuration parameters that change the behaviour of 
+the class it belongs to:
+
+```ruby 
+# Provider domain Object
+module ProviderConfig
+  module Ebay
+    module_function
+
+    def url= 'www.ebay.com'
+    def number_of_attempts= 5 
+  end
+
+  module Amazon
+    module_function
+
+    def url= 'www.amazon.com'
+    def number_of_attempts= 10
+  end
+
+  def self.all
+    [Ebay, Amazon]
+  end
+end
+
+class MyARObject < ActiveRecord::Base
+  attribute :provider_config, 
+            :active_module, 
+            possible_modules: ProviderConfig.all
+
+  def load_page!
+    n_attempts = 0
+    result = nil
+    while n_attempts < provider.number_of_attempts
+      result = get_page(provider.url)
+      if(result)
+        return result
+      else
+        n_attempts.inc
+      end
+    end
+    result
+  end
+end
+
+MyARObject.create!(provider_config: :Ebay).load_page!
+```
+
+#### Rich Java/C#-like enums
+This example is only to show the possibility. 
+This would probably benefit from using a meta programming abstraction
+and there are already gems with this kind of functionality such as `enumerizable`
+
+In a real world project, I guess it would rather make sense to extend `ActiveModule::Base` or even `ActiveModel::Type::Value`. But here it goes for the sake of example.
+
+Java/C# enums allow defining methods on the enum, which are shared across all enum values:
+
+```ruby
+module PipelineStage
+  module Base
+    def external_provider_code
+      @external_provider_code ||= self.name.underscore
+    end
+
+    def database_representation
+      self.name
+    end
+
+    def frontend_representation
+      @frontend_representation ||= self.name.demodulize.upcase
+    end
+  end
+
+  module InitialContact
+    extend Base
+  end
+
+  module InNegotiations
+    extend Base
+  end
+
+  module LostDeal
+    extend Base
+  end
+
+  module PaidOut
+    extend Base
+  end
+
+  module_function
+
+  def all
+    [InitialContact, InNegotiations, LostDeal, PaidOut]
+  end
+
+  def cast(stage)
+    self.all.map(&:external_provider_code).find{|code| code == stage} ||
+    self.all.map(&:database_representation).find{|code| code == stage} ||
+    self.all.map(&:frontend_representation).find{|code| code == stage} 
+  end
+end
+
+class MyARObject < ActiveRecord::Base
+  attribute :pipeline_stage, 
+            :active_module, 
+            possible_modules: PipelineStage.all
+end
+
+object = MyARObject.new(pipeline_stage: :InitialStage)
+object.pipeline_stage&.frontend_representation #=> "INITIAL_STAGE"
+object.pipeline_stage = :InNegotiations
+object.pipeline_stage&.database_representation #=> "PipelineStage::InNegotiations"
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/pedrorolo/active_module.

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/lib/active_module/base.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "active_model"
+require_relative "modules_index"
+
+module ActiveModule
+  class Base < ActiveModel::Type::Value
+    def initialize(possible_modules:)
+      @possible_modules = possible_modules
+      super()
+    end
+
+    def type
+      :active_module
+    end
+
+    def serializable?(object)
+      possible_module?(object)
+    end
+
+    def cast(value)
+      case value
+      when nil
+        nil
+      when ::Symbol
+        sym_to_module(value)
+      when ::Module
+        if possible_module?(value)
+          value
+        else
+          raise_invalid_module_value_error(value)
+        end
+      when ::String
+        str_to_module(value)
+      else
+        raise_invalid_module_value_error(value)
+      end
+    end
+
+    def serialize(module_instance)
+      module_instance && cast(module_instance).name
+    end
+
+    def deserialize(str)
+      str&.constantize
+    rescue NameError
+      nil
+    end
+
+    private
+
+    def sym_to_module(sym)
+      modules_index[sym] ||
+        raise_invalid_module_value_error(sym)
+    end
+
+    def str_to_module(str)
+      modules_index[str.to_sym] ||
+        raise_invalid_module_value_error(str)
+    end
+
+    def raise_invalid_module_value_error(str)
+      raise InvalidModuleValue.new(
+        str,
+        possible_modules: @possible_modules,
+        possible_symbols: modules_index.keys
+      )
+    end
+
+    def possible_modules_set
+      @possible_modules_set ||= Set.new(@possible_modules).freeze
+    end
+
+    def possible_module?(module_instance)
+      possible_modules_set.include?(module_instance)
+    end
+
+    def modules_index
+      @modules_index ||= ModulesIndex.new(@possible_modules)
+    end
+  end
+end

data/lib/active_module/invalid_module_value.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ActiveModule
+  class InvalidModuleValue < StandardError
+    def initialize(value,
+                   possible_modules:,
+                   possible_symbols:)
+      super(<<~ERROR_MESSAGE)
+        Invalid active_module value #{value.inspect}:
+        It must be one of these modules:
+         #{possible_modules.inspect}
+
+        Or one of their referring symbols
+         #{possible_symbols.inspect}
+
+        Or corresponding strings:
+         #{possible_symbols.map(&:to_s).inspect}
+      ERROR_MESSAGE
+    end
+  end
+end

data/lib/active_module/module_refinement.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ActiveModule
+  module ModuleRefinement
+    refine ::Module do
+      def possible_names
+        name_parts = name.split("::")
+        [qualified_name].tap do |possible_names|
+          loop do
+            possible_names << name_parts.join("::").freeze
+            name_parts = name_parts.drop(1)
+            break if name_parts.empty?
+          end
+        end
+      end
+
+      def qualified_name
+        "::#{name}"
+      end
+    end
+  end
+end

data/lib/active_module/modules_index.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "module_refinement"
+
+# Indexes modules by symbols of their qualified and unqualified names.
+module ActiveModule
+  class ModulesIndex
+    using ModuleRefinement
+
+    delegate :[], to: :index
+    delegate :keys, to: :index
+
+    def initialize(modules)
+      @modules = modules
+    end
+
+    private
+
+    def index
+      @index ||=
+        @modules.flat_map do |module_instance|
+          module_instance.possible_names.map do |name|
+            [name.to_sym, module_instance]
+          end
+        end.to_h.freeze
+    end
+  end
+end

data/lib/active_module/register.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ActiveModule
+  module Register
+    module_function
+
+    def call(type_symbol = :active_module)
+      ActiveModel::Type.register(type_symbol, ActiveModule::Base)
+      ActiveRecord::Type.register(type_symbol, ActiveModule::Base)
+    end
+  end
+end

data/lib/active_module/version.rb

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

data/lib/active_module.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "active_module/version"
+require_relative "active_module/base"
+require_relative "active_module/invalid_module_value"
+require_relative "active_module/register"
+
+module ActiveModule
+  module_function
+
+  def register!(type_symbol = :active_module)
+    Register.call(type_symbol)
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: active_module
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro Rolo
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+description: Module type for ActiveModel and Active Record
+email:
+- pedrorolo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- Rakefile
+- lib/active_module.rb
+- lib/active_module/base.rb
+- lib/active_module/invalid_module_value.rb
+- lib/active_module/module_refinement.rb
+- lib/active_module/modules_index.rb
+- lib/active_module/register.rb
+- lib/active_module/version.rb
+homepage: https://github.com/pedrorolo/active_module
+licenses: []
+metadata:
+  homepage_uri: https://github.com/pedrorolo/active_module
+  source_code_uri: https://github.com/pedrorolo/active_module
+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.7
+signing_key:
+specification_version: 4
+summary: Module type for ActiveModel and Active Record
+test_files: []