delegate_cached 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e1b71f0288144f2ece4c7ec9a1f3f8ac9fabd65c
+  data.tar.gz: 7fc471552fe29d13a8e50a0f7883dace87f81315
+SHA512:
+  metadata.gz: 446a57727359db1c88c19aac72da4c8e9684e113104f61f8c5cb8d10b331e15b5e747b550dc0f14d73e943f6fefd751ed6c9af1389e266399b82c95bff1f55f7
+  data.tar.gz: 77f9dc38412f8dc925bdd8b05ad9f1a2974293d1f22fb63e4da3e3e9b62bb9c6168dedcd140b8656de55270a05a51b64a77fe6dc9850d8433de28f1fff1a761b

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cmselmer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'sqlite3'
+gem 'rails', '~>5.0.0.1'
+
+# Specify your gem's dependencies in delegate_cached.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chris Selmer
+
+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,67 @@
+# DelegateCached
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'delegate_cached'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install delegate_cached
+
+## Usage
+
+First, add a column to the delegating ActiveRecord modelto cache the delegated
+value. If using the `prefix: true` options, be sure to use the
+`to` prefix in the column name. For example, as below, the column names required would be
+`hiker_name` for the first `delegate_cached` definition, and `name` for the
+second.
+
+Second, add your `delegate_cached` definition. Note - you may only use
+`delegate_cached` on `belongs_to` and `has_one` associations.
+
+```ruby
+class ThruHike < ApplicationRecord
+  belongs_to :hiker, inverse_of: :thru_hikes
+  belongs_to :trail, inverse_of: :thru_hikes
+
+  delegate_cached :name, to: :hiker, prefix: true # hiker_name column required on thru_hikes table
+  delegate_cached :name, to: :trail # name column required on thru_hikes tables
+end
+```
+
+Third, use your models as you typically would with `delegate` When an instance
+of the delegated-to model is saved, a callback will update your delegate_cached
+value.
+
+## Options
+
+`update_when_nil: true` False by default. When set to true and the referenced
+attribute is called, if the existing cached value is nil, it will attempt to
+update the attribute value with the delegated value.
+
+`skip_callback: true` False by default. When set to true, the `after_save`
+callback on the delegated-to model will not set.
+
+
+## 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 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/cselmer/delegate_cached. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+Copyright (c) 2016 Chris Selmer. The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "delegate_cached"
+
+# 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

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/delegate_cached.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'delegate_cached/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'delegate_cached'
+  spec.version       = DelegateCached::VERSION
+  spec.authors       = ['Chris Selmer']
+  spec.email         = ['cmselmer@gmail.com']
+  spec.summary       = 'Supports caching delegated attributes for ActiveRecord'
+  spec.homepage      = 'http://github.com/cselmer/delegate_cached'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/delegate_cached.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+require 'active_support'
+require 'active_record'
+require 'delegate_cached/cached_attribute'
+require 'delegate_cached/version'
+
+module DelegateCached
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def delegate_cached(attribute, options = {})
+      raise ArgumentError, 'The :to option is required' unless options[:to]
+
+      reflection = reflect_on_association(options[:to])
+
+      if reflection.blank?
+        raise ArgumentError,
+              "The :to association :#{options[:to]} must exist on #{self}"
+      end
+
+      CachedAttribute.new(self, attribute, reflection, options).install!
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, DelegateCached

data/lib/delegate_cached/cached_attribute.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+require 'delegate_cached/model_data'
+require 'delegate_cached/installer'
+require 'delegate_cached/source_installer'
+require 'delegate_cached/target_installer'
+module DelegateCached
+  class CachedAttribute
+    attr_reader :source, :target, :options
+
+    def initialize(model, attribute, reflection, options)
+      @options = options
+      @source = source_model_data(model, attribute, reflection, options)
+
+      inverse = nil
+      if reflection.polymorphic?
+        @options[:polymorphic] = true
+      else
+        inverse = reflection.inverse_of
+        inverse ||= retrieve_reflection(options[:inverse_of])
+        @options[:skip_callback] = true if inverse.nil?
+      end
+
+      @target = target_model_data(attribute, reflection, inverse)
+
+      @source_installer = SourceInstaller.new(@source, @target, options)
+      @target_installer = TargetInstaller.new(@source, @target, options)
+    end
+
+    def install!
+      validate
+      @source_installer.install_instance_methods
+      @target_installer.install_instance_methods
+    end
+
+    protected
+
+    def source_model_data(model, attribute, reflection, options)
+      ModelData.new(model,
+                    source_column_name(attribute, options),
+                    options[:to],
+                    reflection)
+    end
+
+    def target_model_data(attribute, reflection, inverse)
+      ModelData.new(reflection.class_name.safe_constantize,
+                    attribute,
+                    @options[:polymorphic] ? '' : inverse.name,
+                    inverse)
+    end
+
+    def retrieve_reflection(inverse_of)
+      @source.reflection.klass.reflect_on_association(inverse_of)
+    end
+
+    def validate
+      validate_column_exists(@source.model, @source.column)
+      return if @options[:polymorphic]
+      validate_column_exists(@target.model, @target.column)
+      validate_target_association
+    end
+
+    def validate_column_exists(model, column)
+      # The models cannot be validated if they are preloaded and the
+      # attribute/column is not in the database (the migration has not been run)
+      # or tables do not exist. This usually occurs in the 'test' and
+      # 'production' environment or during migrations.
+      return if defined?(Rails) && Rails.configuration.cache_classes ||
+                !model.table_exists? || !model.table_exists?
+
+      return if model.columns.detect { |cl| cl.name == column.to_s }
+      missing_attribute(model, column)
+    end
+
+    def validate_inverse(inverse)
+      return unless inverse.blank?
+      raise ArgumentError,
+            "#{@source.association} association on #{@source} " \
+            'must either have an :inverse_of or you may pass :inverse_of into' \
+            ' delegate_cached.'
+    end
+
+    def validate_target_association
+      return if @target.model.instance_methods.include?(@target.association)
+      raise ArgumentError,
+            "The #{@target.association} association does not exist on " \
+            "#{@target.model}"
+    end
+
+    def missing_attribute(model, attribute)
+      message = "WARNING: `#{attribute}' is not an attribute of `#{model}'." \
+                'This may happen before or during migrations when your column' \
+                'has not yet been created.'
+
+      if defined?(Rails)
+        Rails.logger.warn message
+      else
+        STDERR.puts message
+      end
+    end
+
+    def source_column_name(attribute, options)
+      return attribute.to_s unless options[:prefix]
+      "#{options[:to]}_#{attribute}"
+    end
+  end
+end

data/lib/delegate_cached/installer.rb

@@ -0,0 +1,11 @@
+module DelegateCached
+  class Installer
+    attr_reader :source, :target, :options
+
+    def initialize(source, target, options)
+      @source = source
+      @target = target
+      @options = options
+    end
+  end
+end

data/lib/delegate_cached/model_data.rb

@@ -0,0 +1,20 @@
+module DelegateCached
+  class ModelData
+    attr_reader :model, :column, :association, :reflection
+
+    def initialize(model, column, association, reflection)
+      @model = model
+      @column = column
+      @association = association
+      @reflection = reflection
+    end
+
+    def plural_underscored_model_name
+      model.to_s.pluralize.underscore
+    end
+
+    def underscored_model_name
+      model.to_s.underscore
+    end
+  end
+end

data/lib/delegate_cached/source_installer.rb

@@ -0,0 +1,62 @@
+module DelegateCached
+  class SourceInstaller < Installer
+    def install_instance_methods
+      install_update_method
+      install_accessor_override_method
+      install_setter_override_method
+      install_callback
+    end
+
+    def update_method_name
+      "update_delegate_cached_value_for_#{@source.column}"
+    end
+
+    def set_method_name
+      "set_delegate_cached_value_for_#{@source.column}"
+    end
+
+    def install_update_method
+      @source.model.class_eval %(
+        def #{update_method_name}
+          update(#{@source.column}: #{@source.association}.#{@target.column})
+        end
+      )
+    end
+
+    def install_accessor_override_method
+      @source.model.class_eval %(
+        def #{@source.column}
+          unless self['#{@source.column}'].nil?
+            return self['#{@source.column}']
+          end
+          #{update_if_update_when_nil_option}
+          #{@source.association}.#{@target.column}
+        end
+      )
+    end
+
+    def install_setter_override_method
+      @source.model.class_eval %(
+        def #{set_method_name}
+          return unless #{@source.association}
+          self['#{@source.column}'] = #{@source.association}.#{@target.column}
+        end
+      )
+    end
+
+    def install_callback
+      @source.model.class_eval %(
+        before_save :#{set_method_name}#{callback_if_statement}
+      )
+    end
+
+    def callback_if_statement
+      return nil if @source.reflection.macro == :has_one
+      ", if: :#{@source.column}_changed?"
+    end
+
+    def update_if_update_when_nil_option
+      update_method_name if options[:update_when_nil]
+    end
+  end
+end

data/lib/delegate_cached/target_installer.rb

@@ -0,0 +1,50 @@
+module DelegateCached
+  class TargetInstaller < Installer
+    def install_instance_methods
+      install_update_method
+      install_callback unless options[:no_callback] || options[:polymorphic]
+    end
+
+    def install_update_method
+      @target.model.class_eval %(
+        def #{update_method_name}
+          #{update_method_body}
+        end
+      )
+    end
+
+    def install_callback
+      @target.model.class_eval %(
+        after_save :#{update_method_name}, if: :#{@target.column}_changed?
+      )
+    end
+
+    def update_method_name
+      'update_delegate_cached_value_for_' \
+        "#{@source.plural_underscored_model_name}_#{@source.column}"
+    end
+
+    def update_method_body
+      case @source.reflection.macro
+      when :belongs_to
+        update_method_body_for_has_one_or_has_many
+      when :has_one
+        update_method_body_for_belongs_to
+      end
+    end
+
+    def update_method_body_for_has_one_or_has_many
+      %(
+          #{@source.model}.where(#{@source.association}_id: id)
+                          .update_all(#{@source.column}: #{@target.column})
+      )
+    end
+
+    def update_method_body_for_belongs_to
+      %(
+          #{@source.model}.where(id: #{@target.association}_id)
+                          .update_all(#{@source.column}: #{@target.column})
+      )
+    end
+  end
+end

data/lib/delegate_cached/version.rb

@@ -0,0 +1,3 @@
+module DelegateCached
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: delegate_cached
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Selmer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- cmselmer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- delegate_cached.gemspec
+- lib/delegate_cached.rb
+- lib/delegate_cached/cached_attribute.rb
+- lib/delegate_cached/installer.rb
+- lib/delegate_cached/model_data.rb
+- lib/delegate_cached/source_installer.rb
+- lib/delegate_cached/target_installer.rb
+- lib/delegate_cached/version.rb
+homepage: http://github.com/cselmer/delegate_cached
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Supports caching delegated attributes for ActiveRecord
+test_files: []