denormalized 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 655ccef71078b61b1dc00eab72802c709cf270c658f8019ebfd9a9e1efd2db5e
+  data.tar.gz: e4a645f0f8eff7a8b230d7cff72fad6d726ad9f286a6f4f760df7dff258810a3
+SHA512:
+  metadata.gz: d9fbf8af4d7b8a0a500e4a97e0394b03a0651b4828b8ae0d6209a863fef9f19c2dfe60b0953a2837393219d4d70c286060470c9cf60299a7cf305226109d4dbb
+  data.tar.gz: 8b478478b2d3d03b726d2cdd79f217290cdea8849789b15d2ae2bdaad219b973afbc5ef1f044cbf97474188e5389dd16fcd675d504d9c5cafade0561af0e76c5

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in denormalized.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    denormalized (0.1.2)
+      activerecord (>= 4.2, < 5.0)
+      activesupport (>= 4.2, < 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.2.11.1)
+      activesupport (= 4.2.11.1)
+      builder (~> 3.1)
+    activerecord (4.2.11.1)
+      activemodel (= 4.2.11.1)
+      activesupport (= 4.2.11.1)
+      arel (~> 6.0)
+    activesupport (4.2.11.1)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.4)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (12.3.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  denormalized!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 OneNeptune
+
+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,78 @@
+# Denormalized
+
+Denormalized facilitates a simplistic guarding of denormalized followers on any write to the specified source of truth.  Denormalized relies on monkey-patching the write methods in ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'denormalized'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install denormalized
+
+## Usage
+
+Currently only tested to work for ActiveRecord 4.2.x -- it should be fairly easy to adapt it to work with version 5 or 6, but at the time the author hasn't required such use.
+
+For the "denormalized follower", you will need a column that has the same name as the column on the "source of truth".  Here's an example:
+
+```ruby
+follower = DenormalizedFollower.find(1)
+follower.name
+=> "bingo"
+
+source_of_truth = SourceOfTruth.find(1)
+source_of_truth.name
+=> "bingo"
+```
+
+Enabled Denormalized on the "source of truth" and tell it which columns it is responsible for, and which tables should be updated:
+
+```ruby
+class SourceOfTruth
+  denormalized :name, tables: [:denormalized_followers]
+end
+```
+
+Then, anytime you utilize a write method that updates the specified columns on the "source_of_truth", any followers will be automatically updated as well, using the same method.
+
+Example:
+
+```ruby
+follower = DenormalizedFollower.find(1)
+follower.name
+=> "bingo"
+
+source_of_truth = SourceOfTruth.find(1)
+source_of_truth.name
+=> "bingo"
+
+source_of_truth.update_column(:name, "banjo")
+follower.name
+=> "banjo"
+```
+
+As you can see, even a write method that typically skips callbacks will still keep the specified tables up to date.  That is because Denormalized monkey-patches the ActiveRecord writeable methods, so behind the scenes in the above example, `update_column` was also called on the follower.  When Denormalized calls the same methods on followers, it will only pass along specified attributes, any additional attributes will be ignored, so you can safely update attributes that exist on both columns you don't want to sync as long as it's not specified in the source of truth.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.  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 tags, 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/RecruitiFi/denormalized.
+
+
+## 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,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'denormalized'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/denormalized.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/denormalized/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'denormalized'
+  spec.version       = Denormalized::VERSION
+  spec.authors       = ['OneNeptune']
+  spec.email         = ['michael@michaelbennett.nyc']
+
+  spec.summary       = 'Facilitate simplistic guarding of denormalized ' \
+                       'followers on update of source of truth.'
+  spec.homepage      = 'https://github.com/RecruitiFi/denormalized'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # 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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '>= 4.2', '< 5.0'
+  spec.add_dependency 'activesupport', '>= 4.2', '< 5.0'
+end

data/lib/denormalized.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'denormalized/core'
+
+module Denormalized
+  def denormalized?
+    included_modules.include?(Denormalized::Core)
+  end
+
+  def denormalized(*attributes)
+    options = attributes.extract_options!.dup
+
+    if attributes.empty?
+      raise ArgumentError, 'You need to supply at least one column'
+    end
+    if options.empty? || options[:tables]&.empty?
+      raise ArgumentError, 'You need to supply at least one table'
+    end
+
+    class_attribute :denormalized_configuration
+
+    self.denormalized_configuration = {
+      columns: attributes,
+      tables: options[:tables],
+      columns_hash: Hash[attributes.map { |column| [column, true] }]
+    }
+
+    include Denormalized::Core unless denormalized?
+  end
+end
+
+# Extend ActiveRecord's functionality
+ActiveRecord::Base.extend Denormalized

data/lib/denormalized/core.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module Denormalized
+  module Core
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def denormalized_subject(table)
+      table.to_s.classify.constantize
+    end
+
+    def denormalized_subjects(table:, where_attrs:)
+      denormalized_subject(
+        table
+      ).where(
+        where_attrs
+      ).uniq
+    end
+
+    def denormalized_tables
+      denormalized_configuration[:tables].uniq
+    end
+
+    def contains_denormalized_attributes(attributes)
+      attributes.keys.any? do |name|
+        self.class.denormalized_attribute?(name)
+      end
+    end
+
+    def extract_existing_denormalized_attributes(new_attributes)
+      {}.tap do |extracted_attributes|
+        (denormalized_configuration[:columns] & new_attributes.keys).each do |attribute|
+          extracted_attributes[attribute] = read_attribute(attribute)
+        end
+      end
+    end
+
+    def extract_denormalized_attributes(new_attributes)
+      {}.tap do |extracted_attributes|
+        (denormalized_configuration[:columns] & new_attributes.keys).each do |attribute|
+          extracted_attributes[attribute] = new_attributes[attribute]
+        end
+      end
+    end
+
+    def write_attribute(attr_name, value)
+      if self.class.denormalized_attribute?(attr_name)
+        denormalized_tables.each do |table|
+          denormalized_subjects(
+            table: table,
+            where_attrs: { attr_name => read_attribute(attr_name) }
+          ).each { |obj| obj.send(:write_attribute, attr_name, value) }
+        end
+      end
+
+      super
+    end
+
+    def update_attribute(name, value)
+      if self.class.denormalized_attribute?(attr_name)
+        denormalized_tables.each do |table|
+          denormalized_subjects(
+            table: table,
+            where_attrs: { name => read_attribute(name) }
+          ).each { |obj| obj.send(:update_attribute, name, value) }
+        end
+      end
+
+      super
+    end
+
+    def update(attributes)
+      if contains_denormalized_attributes(attributes)
+        gifted_attributes = extract_denormalized_attributes(attributes)
+
+        denormalized_tables.each do |table|
+          denormalized_subjects(
+            table: table,
+            where_attrs: extract_existing_denormalized_attributes(attributes)
+          ).each { |obj| obj.update(gifted_attributes) }
+        end
+      end
+
+      super
+    end
+
+    def assign_attributes(new_attributes)
+      if contains_denormalized_attributes(new_attributes)
+        gifted_attributes = extract_denormalized_attributes(new_attributes)
+
+        denormalized_tables.each do |table|
+          denormalized_subjects(
+            table: table,
+            where_attrs: extract_existing_denormalized_attributes(new_attributes)
+          ).each { |obj| obj.assign_attributes(gifted_attributes) }
+        end
+      end
+
+      super
+    end
+
+    def update_columns(attributes)
+      if contains_denormalized_attributes(attributes)
+        gifted_attributes = extract_denormalized_attributes(attributes)
+
+        denormalized_tables.each do |table|
+          denormalized_subjects(
+            table: table,
+            where_attrs: extract_existing_denormalized_attributes(attributes)
+          ).each { |obj| obj.send(:update_columns, gifted_attributes) }
+        end
+      end
+
+      super
+    end
+
+    module ClassMethods
+      def denormalized_attribute?(name)
+        name = name.to_sym if name.is_a?(String)
+
+        if name.is_a?(Symbol)
+          return denormalized_configuration[:columns_hash][name]
+        end
+
+        Rails.logger.warn '[DENORMALIZED]: Symbol expected, instead received ' + name.class.to_s
+        false
+      end
+
+      def update(id, attributes)
+        if attributes.keys.any? { |name| denormalized_attribute?(name) }
+          subjects = base_class.where(id: id) # we will let super handle errors if subject doesn't exist
+
+          if subjects.any?
+            subjects.each do |subject|
+              gifted_attributes = subject.extract_denormalized_attributes(attributes)
+
+              denormalized_configuration[:tables].each do |table|
+                subject.denormalized_action(
+                  table: table,
+                  where_attrs: subject.extract_existing_denormalized_attributes(attributes),
+                  method: :update,
+                  args: gifted_attributes
+                )
+              end
+            end
+          end
+        end
+
+        super
+      end
+
+      def update_all(updates)
+        if updates.keys.any? { |name| denormalized_attribute?(name) }
+          Rails.logger.warn '[DENORMALIZED]: Unable to update followers when using `update_all` -- orphans may have been created'
+        end
+
+        super
+      end
+    end
+  end
+end

data/lib/denormalized/version.rb

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: denormalized
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- OneNeptune
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- michael@michaelbennett.nyc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- denormalized.gemspec
+- lib/denormalized.rb
+- lib/denormalized/core.rb
+- lib/denormalized/version.rb
+homepage: https://github.com/RecruitiFi/denormalized
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/RecruitiFi/denormalized
+  source_code_uri: https://github.com/RecruitiFi/denormalized
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.9
+signing_key: 
+specification_version: 4
+summary: Facilitate simplistic guarding of denormalized followers on update of source
+  of truth.
+test_files: []