dynamic_fields_rails 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37e9e3ca85c3be34eed3f654ccf6862116e12051606e9dcfbf876d5d666633d8
+  data.tar.gz: 41d9125df6eef2233a53983f824a1b945312f918036cfa873eb357e67b73b5c3
+SHA512:
+  metadata.gz: 53e0ed3d0cf4de042b4a4dc9fecf7911d04f4d13c44cc897cd7f05d387bfde7127ba8cc56ff9fa85ee7f0863bc59090de93404f6eb8d122257f454ba8cf5fb8b
+  data.tar.gz: 62e776b9dcad1d03000c9832ee8200afb0a08deb0f4dd9196518ad3effa196ef97b54a0f8d0d48f39d42ba09f74cdff3c5b6900faa2914a02e6b9eaed54752c3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Vincent Rolea
+
+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,96 @@
+[![Gem Version](https://badge.fury.io/rb/dynamic_fields_rails.svg)](https://badge.fury.io/rb/dynamic_fields_rails)
+
+[![Tests](https://github.com/virolea/dynamic_fields/actions/workflows/tests.yml/badge.svg)](https://github.com/virolea/dynamic_fields/actions/workflows/tests.yml)
+
+# DynamicFields
+
+DynamicFields allows to add persisted attributes to ActiveRecord models without the need for a migration.
+
+You might want to add a temporary attribute, for monitoring or reporting purposes, or avoid to pollute your domain tables with marketing-related fields.
+
+With DynamicFields, this is as easy as the following:
+
+```ruby
+  class User
+    include DynamicFields::ActiveRecord
+
+    has_dynamic_field :subscribe_to_newsletter, field_type: :boolean
+  end
+
+  user = User.create(subscribe_to_newsletter: true)
+  user.subscribe_to_newsletter # => true
+```
+
+The declared attribute works seamlessly like a traditionnal ActiveRecord attribute. This means you can use features such as validations without any futher work:
+
+```ruby
+class Post
+  include DynamicFields::ActiveRecord
+
+  has_dynamic_field :title
+
+  validates :title, presence: true
+end
+
+post = Post.new
+post.valid? # => false
+post.errors.full_messages # => ["Title can't be blank"]
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "dynamic_fields"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install dynamic_fields
+```
+
+## Usage
+
+Persisted attributes are backed by the `dynamic_fields_attributes` table. After installing the gem run migrations to add the required tables:
+
+```
+rails db:migrate
+```
+
+Once the migrations are done, start adding attributes to model by including the `DynamicFields::ActiveRecord` module any active record model:
+
+```ruby
+class Post
+  include DynamicFields::ActiveRecord
+end
+```
+
+And voilà! Your model is ready to declare new dynamic fields. The API is simple:
+
+```ruby
+class Post
+  include DynamicFields::ActiveRecord
+
+  # Use `has_dynamic_field` with the field name to declare a new attribute.
+  has_dynamic_field :title
+
+  # Default type for a field is :string. Use the `field_type` option to declare another field type
+  has_dynamic_field :reading_time, field_type: :integer
+  has_dynamic_field :published, field_type: :boolean
+end
+```
+
+For now, DynamicFields allow for three field types;
+- String (default)
+- Integer
+- Boolean
+
+The list will likely grow with time, usage and needs.
+
+## 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,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/models/dynamic_fields/attribute/boolean_attribute.rb

@@ -0,0 +1,5 @@
+module DynamicFields
+  class Attribute::BooleanAttribute < Attribute
+    attribute :value, :boolean
+  end
+end

data/app/models/dynamic_fields/attribute/integer_attribute.rb

@@ -0,0 +1,5 @@
+module DynamicFields
+  class Attribute::IntegerAttribute < Attribute
+    attribute :value, :integer
+  end
+end

data/app/models/dynamic_fields/attribute/string_attribute.rb

@@ -0,0 +1,4 @@
+module DynamicFields
+  class Attribute::StringAttribute < Attribute
+  end
+end

data/app/models/dynamic_fields/attribute.rb

@@ -0,0 +1,29 @@
+module DynamicFields
+  class Attribute < ApplicationRecord
+    DEFAULT_FIELD_TYPE = :string
+
+    AVAILABLE_ATTRIBUTE_TYPES = %i[
+      string
+      boolean
+      integer
+    ].freeze
+
+    belongs_to :record, polymorphic: true
+
+    validates :name, presence: true
+    validates :name, uniqueness: { scope: [:record_type, :record_id] }
+
+    class << self
+      def attribute_class_for_attribute_type(attribute_type)
+        case attribute_type
+        when :string
+          return "DynamicFields::Attribute::StringAttribute"
+        when :integer
+          return "DynamicFields::Attribute::IntegerAttribute"
+        when :boolean
+          return "DynamicFields::Attribute::BooleanAttribute"
+        end
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/db/migrate/20240729120435_create_dynamic_fields_tables.rb

@@ -0,0 +1,12 @@
+class CreateDynamicFieldsTables < ActiveRecord::Migration[7.1]
+  def change
+    create_table :dynamic_fields_attributes do |t|
+      t.references :record, polymorphic: true, null: false
+      t.string :name
+      t.string :type
+      t.string :value
+
+      t.timestamps
+    end
+  end
+end

data/lib/dynamic_fields/active_record.rb

@@ -0,0 +1,45 @@
+module DynamicFields
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :dynamic_fields_attributes, class_name: "DynamicFields::Attribute", as: :record
+    end
+
+    class_methods do
+      def has_dynamic_field(field_name, field_type: DynamicFields::Attribute::DEFAULT_FIELD_TYPE)
+        raise ArgumentError, "#{field_type} is not a valid DynamicFields attribute type. Available values include #{DynamicFields::Attribute::AVAILABLE_ATTRIBUTE_TYPES}" unless DynamicFields::Attribute::AVAILABLE_ATTRIBUTE_TYPES.include?(field_type.to_sym)
+
+        has_one :"#{field_name}_attribute", -> { where(name: field_name) }, class_name: DynamicFields::Attribute.attribute_class_for_attribute_type(field_type), as: :record, inverse_of: :record, dependent: :destroy
+
+        define_method(field_name) do
+          if dynamic_field_changes["#{field_name}"]
+            dynamic_field_changes["#{field_name}"].value
+          else
+            dynamic_fields_attributes.find { |attribute| attribute.name == field_name.to_s }&.value
+          end
+        end
+
+        define_method("#{field_name}=") do |value|
+          # Not checking for `value.blank?` here to account for boolean fields, as false.blank? is true
+          dynamic_field_changes["#{field_name}"] = if value == "" || value.nil?
+            DynamicFields::Changes::Delete.new(field_name, self)
+          else
+            DynamicFields::Changes::CreateOrUpdate.new(value, field_name, field_type, self)
+          end
+        end
+
+        after_save { dynamic_field_changes[field_name.to_s]&.save }
+      end
+
+    end
+
+    def dynamic_field_changes
+      @dynamic_field_changes ||= {}
+    end
+
+    def reload(*)
+      super.tap { @dynamic_field_changes = nil }
+    end
+  end
+end

data/lib/dynamic_fields/changes/create_or_update.rb

@@ -0,0 +1,24 @@
+module DynamicFields
+  class Changes::CreateOrUpdate
+    attr_reader :record, :value, :field_name, :field_type, :attribute
+
+    def initialize(value, field_name, field_type, record)
+      @value, @field_name, @field_type, @record = value, field_name, field_type, record
+      @attribute = find_or_build_attribute
+    end
+
+    def save
+      attribute.value = value
+      record.public_send("#{field_name}_attribute=", attribute)
+    end
+
+    private
+
+    def find_or_build_attribute
+      record.dynamic_fields_attributes.find_or_initialize_by(
+        name: field_name,
+        type: DynamicFields::Attribute.attribute_class_for_attribute_type(field_type)
+      )
+    end
+  end
+end

data/lib/dynamic_fields/changes/delete.rb

@@ -0,0 +1,14 @@
+module DynamicFields
+  class Changes::Delete
+    attr_reader :record, :field_name, :value
+
+    def initialize(field_name, record)
+      @field_name, @record = field_name, record
+      @value = nil
+    end
+
+    def save
+      record.public_send("#{field_name}_attribute=", nil)
+    end
+  end
+end

data/lib/dynamic_fields/engine.rb

@@ -0,0 +1,5 @@
+module DynamicFields
+  class Engine < ::Rails::Engine
+    isolate_namespace DynamicFields
+  end
+end

data/lib/dynamic_fields/version.rb

@@ -0,0 +1,3 @@
+module DynamicFields
+  VERSION = "0.1.1"
+end

data/lib/dynamic_fields.rb

@@ -0,0 +1,12 @@
+require "dynamic_fields/version"
+require "dynamic_fields/engine"
+
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.new
+loader.inflector = Zeitwerk::GemInflector.new(__FILE__)
+loader.push_dir(File.expand_path(".", __dir__))
+loader.setup
+
+module DynamicFields
+end

data/lib/tasks/dynamic_fields_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :dynamic_fields do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: dynamic_fields_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Vincent Rolea
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.3.4
+description: Add persisted fields to active record models without migrations.
+email:
+- 3525369+virolea@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/dynamic_fields/attribute.rb
+- app/models/dynamic_fields/attribute/boolean_attribute.rb
+- app/models/dynamic_fields/attribute/integer_attribute.rb
+- app/models/dynamic_fields/attribute/string_attribute.rb
+- config/routes.rb
+- db/migrate/20240729120435_create_dynamic_fields_tables.rb
+- lib/dynamic_fields.rb
+- lib/dynamic_fields/active_record.rb
+- lib/dynamic_fields/changes/create_or_update.rb
+- lib/dynamic_fields/changes/delete.rb
+- lib/dynamic_fields/engine.rb
+- lib/dynamic_fields/version.rb
+- lib/tasks/dynamic_fields_tasks.rake
+homepage: https://github.com/virolea/dynamic_fields
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/virolea/dynamic_fields
+  source_code_uri: https://github.com/virolea/dynamic_fields
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Add persisted fields to active record models without migrations.
+test_files: []