activerecord-redundancy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4a7772e3d22b5d5c71acae3ab3355d045bdb016
+  data.tar.gz: bad7330304eafcb24cb37c060e131ec4f750f5a5
+SHA512:
+  metadata.gz: c300d09e8bf1f6446efb879988f40f507f44abb741effecd2aa646d19384b4ef5e92425eb18999a2a574b723e1802f47d64ca6cafb47bb8eaa8cc05bbf1dd6be
+  data.tar.gz: 04eaa8d91a8c24131c6815e90dc8e5241dd9df9156b9f77549b0c1f55289c8da1a389d17faf032feba0119cee784314f974b2edb01919e6d147ab8af1301bd8f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+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/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Redundancy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/activerecord-redundancy.rb

@@ -0,0 +1 @@
+require 'redundancy'

data/lib/redundancy.rb

@@ -0,0 +1,137 @@
+module Redundancy
+  extend ActiveSupport::Concern
+
+  class CacheColumn
+    attr_reader :options
+    attr_reader :source, :dist, :klass
+    attr_reader :change_if, :nil_unless, :update, :set_prev_nil
+
+    def initialize options
+      @options = options
+      @source, @dist = options[:source], options[:dist]
+      @klass = options[:klass]
+
+      @change_if = options[:change_if]
+      @nil_unless = options[:nil_unless]
+      @update = options[:update] || false
+      @set_prev_nil = options[:set_prev_nil]
+    end
+
+    def update_record record
+      raise ArgumentError, "record class mismatch, expected #{klass}, got #{record.class}" unless record.kind_of? klass
+      return unless need_update?(record)
+      
+      src = source[:association] ? record.send(source[:association]) : record
+      src = src && source[:attribute] && src.send(source[:attribute])
+      src = nil if nil_unless && !record.send(nil_unless) 
+
+      dst = dist[:association] ? record.send(dist[:association]) : record
+
+      set_prev_nil.where(id: record.send(:attribute_was, change_if))
+        .update_all(dist[:attribute] => nil) if set_prev_nil
+
+      case dst
+      when ActiveRecord::Base
+        return if dst.send(:read_attribute, dist[:attribute]) == src
+        log "#{ update ? "update" : "write" } #{dst.class}(#{dst.id})##{dist[:attribute]} with #{src.inspect}"
+        log "#{change_if}: #{record.send(change_if).inspect}, #{dist[:association]||"self"}.id: #{dst.id}"
+        if update
+          dst.send(:update_attribute, dist[:attribute], src)
+        else
+          dst.send(:write_attribute, dist[:attribute], src)
+        end
+      when ActiveRecord::Relation
+        log "update #{dst.class}##{dist[:attribute]} with #{src.inspect}"
+        dst.send(:update_all, dist[:attribute] => src)
+      end
+
+    end
+
+    def need_update? record
+      record.send(:attribute_changed?, change_if)
+    end
+
+    def log *message
+      # puts *message
+    end
+
+  end
+
+  included do
+    before_save :redundancy_update_cache_column_after_save
+  end
+
+  private
+
+  def redundancy_update_cache_column_after_save
+    self.class.cache_columns.each do |cache_column|
+      cache_column.update_record(self)
+    end
+  end
+
+  module ClassMethods
+    def redundancy association, attribute, options = {}
+      options.assert_valid_keys(:cache_column, :inverse_of)
+
+      reflection = self.reflect_on_association(association)
+      raise ArgumentError, "Unknown association :#{association}" unless reflection
+      raise ArgumentError, "BelongsTo or HasOne reflection needed" unless 
+        [:has_one, :belongs_to].include? reflection.macro
+
+      inverse_associations = options[:inverse_of] 
+      inverse_associations ||= [model_name.plural, model_name.singular].map(&:to_sym)
+
+      inverse_association = Array.wrap(inverse_associations).find do |inverse_association|
+        reflection.klass.reflect_on_association(inverse_association)
+      end
+
+      raise ArgumentError, "Could not find the inverse association for #{association} (#{inverse_associations.inspect} in #{reflection.klass})" unless inverse_association
+      
+      foreign_key = reflection.foreign_key
+      cache_column = options[:cache_column] || :"#{association}_#{attribute}"
+
+      local_klass = self
+      remote_klass = reflection.klass
+
+      case reflection.macro
+      when :belongs_to
+        local_klass.cache_columns << CacheColumn.new({
+          source: { association: association, attribute: attribute },
+          dist: { association: nil, attribute: cache_column },
+          change_if: foreign_key, klass: local_klass
+        })
+        remote_klass.cache_columns << CacheColumn.new({
+          source: { association: nil, attribute: attribute },
+          dist: { association: inverse_association, attribute: cache_column },
+          change_if: attribute, klass: remote_klass, update: true
+        })
+
+      when :has_one
+        remote_klass.cache_columns << CacheColumn.new({
+          source: { association: nil, attribute: attribute },
+          dist: { association: inverse_association, attribute: cache_column },
+          change_if: foreign_key, nil_unless: foreign_key, klass: remote_klass,
+          set_prev_nil: local_klass
+        })
+        remote_klass.cache_columns << CacheColumn.new({
+          source: { association: nil, attribute: attribute },
+          dist: { association: inverse_association, attribute: cache_column },
+          change_if: attribute, klass: remote_klass, update: true
+        })
+      end
+
+
+    end
+
+    def cache_columns
+      @cache_columns ||= []
+    end
+
+  end
+
+end
+
+# include in AR
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.send(:include, Redundancy)
+end

data/lib/redundancy/version.rb

@@ -0,0 +1,3 @@
+module Redundancy
+  VERSION = "0.0.1"
+end

data/lib/tasks/redundancy_tasks.rake

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

data/test/belongs_to_has_one_association_test.rb

@@ -0,0 +1,60 @@
+require 'test_helper'
+
+class BelongsToHasOneAssociationTest < ActiveSupport::TestCase
+
+  # belongs_to:has_one association
+  test "should update account.user_name when create account" do
+    user = users(:one)
+    account = Account.create(email: 'email@email.com', user: user)
+    assert_equal user.name, account.user_name
+  end
+
+  test "should update account.user_name when create account without user" do
+    account = Account.create(email: 'email@email.com')
+    assert_equal nil, account.user_name
+  end
+
+  test "should update account.user_name when update account.user" do
+    user = users(:one)
+    account = accounts(:two)
+    assert_not_equal user.name, account.user_name
+
+    account.update_attribute(:user, user)
+    assert_equal user.name, account.user_name
+  end
+
+  test "should update account.user_name when update account.user with nil" do
+    user = users(:one)
+    account = accounts(:one)
+    assert_equal user.name, account.user_name
+
+    account.update_attribute(:user, nil)
+    assert_equal nil, account.user_name
+  end
+
+  test "should update account.user_name when update account.user with other user" do
+    user = users(:one)
+    other_user = users(:two)
+    account = accounts(:one)
+    other_account = accounts(:two)
+    assert_equal user.name, account.user_name
+    assert_equal other_user.name, other_account.user_name
+
+    account.update_attribute(:user, other_user)
+    assert_equal other_user.name, account.user_name
+    assert_equal nil, other_account.reload.user
+    assert_equal nil, other_account.reload.user_name
+  end
+
+  test "should update account.user_name when update user.name" do
+    user = users(:one)
+    account = accounts(:one)
+    assert_equal user.name, account.user_name
+
+    user.update_attribute(:name, "Other Name")
+    assert_equal user.name, user.account.user_name
+
+    assert_equal user.name, account.reload.user_name
+  end
+
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/account.rb

@@ -0,0 +1,5 @@
+class Account < ActiveRecord::Base
+  has_one :user
+  
+  redundancy :user, :name
+end

data/test/dummy/app/models/post.rb

@@ -0,0 +1,6 @@
+class Post < ActiveRecord::Base
+  belongs_to :user
+
+  redundancy :user, :name
+  redundancy :user, :name, cache_column: :username
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,6 @@
+class User < ActiveRecord::Base
+  has_many :posts
+  belongs_to :account
+
+  redundancy :account, :email
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "redundancy"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)