activerecord-redundancy 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/Rakefile +28 -0
  4. data/lib/activerecord-redundancy.rb +1 -0
  5. data/lib/redundancy.rb +137 -0
  6. data/lib/redundancy/version.rb +3 -0
  7. data/lib/tasks/redundancy_tasks.rake +4 -0
  8. data/test/belongs_to_has_one_association_test.rb +60 -0
  9. data/test/dummy/README.rdoc +28 -0
  10. data/test/dummy/Rakefile +6 -0
  11. data/test/dummy/app/assets/javascripts/application.js +13 -0
  12. data/test/dummy/app/assets/stylesheets/application.css +15 -0
  13. data/test/dummy/app/controllers/application_controller.rb +5 -0
  14. data/test/dummy/app/helpers/application_helper.rb +2 -0
  15. data/test/dummy/app/models/account.rb +5 -0
  16. data/test/dummy/app/models/post.rb +6 -0
  17. data/test/dummy/app/models/user.rb +6 -0
  18. data/test/dummy/app/views/layouts/application.html.erb +14 -0
  19. data/test/dummy/bin/bundle +3 -0
  20. data/test/dummy/bin/rails +4 -0
  21. data/test/dummy/bin/rake +4 -0
  22. data/test/dummy/config.ru +4 -0
  23. data/test/dummy/config/application.rb +23 -0
  24. data/test/dummy/config/boot.rb +5 -0
  25. data/test/dummy/config/database.yml +25 -0
  26. data/test/dummy/config/environment.rb +5 -0
  27. data/test/dummy/config/environments/development.rb +37 -0
  28. data/test/dummy/config/environments/production.rb +82 -0
  29. data/test/dummy/config/environments/test.rb +39 -0
  30. data/test/dummy/config/initializers/assets.rb +8 -0
  31. data/test/dummy/config/initializers/backtrace_silencers.rb +7 -0
  32. data/test/dummy/config/initializers/cookies_serializer.rb +3 -0
  33. data/test/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  34. data/test/dummy/config/initializers/inflections.rb +16 -0
  35. data/test/dummy/config/initializers/mime_types.rb +4 -0
  36. data/test/dummy/config/initializers/session_store.rb +3 -0
  37. data/test/dummy/config/initializers/wrap_parameters.rb +14 -0
  38. data/test/dummy/config/locales/en.yml +23 -0
  39. data/test/dummy/config/routes.rb +56 -0
  40. data/test/dummy/config/secrets.yml +22 -0
  41. data/test/dummy/db/development.sqlite3 +0 -0
  42. data/test/dummy/db/migrate/20140716061500_create_posts.rb +14 -0
  43. data/test/dummy/db/migrate/20140716061513_create_users.rb +12 -0
  44. data/test/dummy/db/migrate/20140716133341_create_accounts.rb +11 -0
  45. data/test/dummy/db/schema.rb +43 -0
  46. data/test/dummy/db/test.sqlite3 +0 -0
  47. data/test/dummy/log/development.log +150 -0
  48. data/test/dummy/log/test.log +34830 -0
  49. data/test/dummy/public/404.html +67 -0
  50. data/test/dummy/public/422.html +67 -0
  51. data/test/dummy/public/500.html +66 -0
  52. data/test/dummy/public/favicon.ico +0 -0
  53. data/test/dummy/test/fixtures/accounts.yml +11 -0
  54. data/test/dummy/test/fixtures/posts.yml +17 -0
  55. data/test/dummy/test/fixtures/users.yml +13 -0
  56. data/test/has_many_belongs_to_association_test.rb +60 -0
  57. data/test/has_one_belongs_to_association_test.rb +60 -0
  58. data/test/options_test.rb +12 -0
  59. data/test/test_helper.rb +25 -0
  60. metadata +216 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: d4a7772e3d22b5d5c71acae3ab3355d045bdb016
4
+ data.tar.gz: bad7330304eafcb24cb37c060e131ec4f750f5a5
5
+ SHA512:
6
+ metadata.gz: c300d09e8bf1f6446efb879988f40f507f44abb741effecd2aa646d19384b4ef5e92425eb18999a2a574b723e1802f47d64ca6cafb47bb8eaa8cc05bbf1dd6be
7
+ data.tar.gz: 04eaa8d91a8c24131c6815e90dc8e5241dd9df9156b9f77549b0c1f55289c8da1a389d17faf032feba0119cee784314f974b2edb01919e6d147ab8af1301bd8f
data/MIT-LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright 2014 YOURNAME
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/Rakefile ADDED
@@ -0,0 +1,28 @@
1
+ begin
2
+ require 'bundler/setup'
3
+ rescue LoadError
4
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
5
+ end
6
+
7
+ require 'rdoc/task'
8
+
9
+ RDoc::Task.new(:rdoc) do |rdoc|
10
+ rdoc.rdoc_dir = 'rdoc'
11
+ rdoc.title = 'Redundancy'
12
+ rdoc.options << '--line-numbers'
13
+ rdoc.rdoc_files.include('README.rdoc')
14
+ rdoc.rdoc_files.include('lib/**/*.rb')
15
+ end
16
+
17
+ Bundler::GemHelper.install_tasks
18
+
19
+ require 'rake/testtask'
20
+
21
+ Rake::TestTask.new(:test) do |t|
22
+ t.libs << 'lib'
23
+ t.libs << 'test'
24
+ t.pattern = 'test/**/*_test.rb'
25
+ t.verbose = false
26
+ end
27
+
28
+ task default: :test
@@ -0,0 +1 @@
1
+ require 'redundancy'
data/lib/redundancy.rb ADDED
@@ -0,0 +1,137 @@
1
+ module Redundancy
2
+ extend ActiveSupport::Concern
3
+
4
+ class CacheColumn
5
+ attr_reader :options
6
+ attr_reader :source, :dist, :klass
7
+ attr_reader :change_if, :nil_unless, :update, :set_prev_nil
8
+
9
+ def initialize options
10
+ @options = options
11
+ @source, @dist = options[:source], options[:dist]
12
+ @klass = options[:klass]
13
+
14
+ @change_if = options[:change_if]
15
+ @nil_unless = options[:nil_unless]
16
+ @update = options[:update] || false
17
+ @set_prev_nil = options[:set_prev_nil]
18
+ end
19
+
20
+ def update_record record
21
+ raise ArgumentError, "record class mismatch, expected #{klass}, got #{record.class}" unless record.kind_of? klass
22
+ return unless need_update?(record)
23
+
24
+ src = source[:association] ? record.send(source[:association]) : record
25
+ src = src && source[:attribute] && src.send(source[:attribute])
26
+ src = nil if nil_unless && !record.send(nil_unless)
27
+
28
+ dst = dist[:association] ? record.send(dist[:association]) : record
29
+
30
+ set_prev_nil.where(id: record.send(:attribute_was, change_if))
31
+ .update_all(dist[:attribute] => nil) if set_prev_nil
32
+
33
+ case dst
34
+ when ActiveRecord::Base
35
+ return if dst.send(:read_attribute, dist[:attribute]) == src
36
+ log "#{ update ? "update" : "write" } #{dst.class}(#{dst.id})##{dist[:attribute]} with #{src.inspect}"
37
+ log "#{change_if}: #{record.send(change_if).inspect}, #{dist[:association]||"self"}.id: #{dst.id}"
38
+ if update
39
+ dst.send(:update_attribute, dist[:attribute], src)
40
+ else
41
+ dst.send(:write_attribute, dist[:attribute], src)
42
+ end
43
+ when ActiveRecord::Relation
44
+ log "update #{dst.class}##{dist[:attribute]} with #{src.inspect}"
45
+ dst.send(:update_all, dist[:attribute] => src)
46
+ end
47
+
48
+ end
49
+
50
+ def need_update? record
51
+ record.send(:attribute_changed?, change_if)
52
+ end
53
+
54
+ def log *message
55
+ # puts *message
56
+ end
57
+
58
+ end
59
+
60
+ included do
61
+ before_save :redundancy_update_cache_column_after_save
62
+ end
63
+
64
+ private
65
+
66
+ def redundancy_update_cache_column_after_save
67
+ self.class.cache_columns.each do |cache_column|
68
+ cache_column.update_record(self)
69
+ end
70
+ end
71
+
72
+ module ClassMethods
73
+ def redundancy association, attribute, options = {}
74
+ options.assert_valid_keys(:cache_column, :inverse_of)
75
+
76
+ reflection = self.reflect_on_association(association)
77
+ raise ArgumentError, "Unknown association :#{association}" unless reflection
78
+ raise ArgumentError, "BelongsTo or HasOne reflection needed" unless
79
+ [:has_one, :belongs_to].include? reflection.macro
80
+
81
+ inverse_associations = options[:inverse_of]
82
+ inverse_associations ||= [model_name.plural, model_name.singular].map(&:to_sym)
83
+
84
+ inverse_association = Array.wrap(inverse_associations).find do |inverse_association|
85
+ reflection.klass.reflect_on_association(inverse_association)
86
+ end
87
+
88
+ raise ArgumentError, "Could not find the inverse association for #{association} (#{inverse_associations.inspect} in #{reflection.klass})" unless inverse_association
89
+
90
+ foreign_key = reflection.foreign_key
91
+ cache_column = options[:cache_column] || :"#{association}_#{attribute}"
92
+
93
+ local_klass = self
94
+ remote_klass = reflection.klass
95
+
96
+ case reflection.macro
97
+ when :belongs_to
98
+ local_klass.cache_columns << CacheColumn.new({
99
+ source: { association: association, attribute: attribute },
100
+ dist: { association: nil, attribute: cache_column },
101
+ change_if: foreign_key, klass: local_klass
102
+ })
103
+ remote_klass.cache_columns << CacheColumn.new({
104
+ source: { association: nil, attribute: attribute },
105
+ dist: { association: inverse_association, attribute: cache_column },
106
+ change_if: attribute, klass: remote_klass, update: true
107
+ })
108
+
109
+ when :has_one
110
+ remote_klass.cache_columns << CacheColumn.new({
111
+ source: { association: nil, attribute: attribute },
112
+ dist: { association: inverse_association, attribute: cache_column },
113
+ change_if: foreign_key, nil_unless: foreign_key, klass: remote_klass,
114
+ set_prev_nil: local_klass
115
+ })
116
+ remote_klass.cache_columns << CacheColumn.new({
117
+ source: { association: nil, attribute: attribute },
118
+ dist: { association: inverse_association, attribute: cache_column },
119
+ change_if: attribute, klass: remote_klass, update: true
120
+ })
121
+ end
122
+
123
+
124
+ end
125
+
126
+ def cache_columns
127
+ @cache_columns ||= []
128
+ end
129
+
130
+ end
131
+
132
+ end
133
+
134
+ # include in AR
135
+ ActiveSupport.on_load(:active_record) do
136
+ ActiveRecord::Base.send(:include, Redundancy)
137
+ end
@@ -0,0 +1,3 @@
1
+ module Redundancy
2
+ VERSION = "0.0.1"
3
+ end
@@ -0,0 +1,4 @@
1
+ # desc "Explaining what the task does"
2
+ # task :redundancy do
3
+ # # Task goes here
4
+ # end
@@ -0,0 +1,60 @@
1
+ require 'test_helper'
2
+
3
+ class BelongsToHasOneAssociationTest < ActiveSupport::TestCase
4
+
5
+ # belongs_to:has_one association
6
+ test "should update account.user_name when create account" do
7
+ user = users(:one)
8
+ account = Account.create(email: 'email@email.com', user: user)
9
+ assert_equal user.name, account.user_name
10
+ end
11
+
12
+ test "should update account.user_name when create account without user" do
13
+ account = Account.create(email: 'email@email.com')
14
+ assert_equal nil, account.user_name
15
+ end
16
+
17
+ test "should update account.user_name when update account.user" do
18
+ user = users(:one)
19
+ account = accounts(:two)
20
+ assert_not_equal user.name, account.user_name
21
+
22
+ account.update_attribute(:user, user)
23
+ assert_equal user.name, account.user_name
24
+ end
25
+
26
+ test "should update account.user_name when update account.user with nil" do
27
+ user = users(:one)
28
+ account = accounts(:one)
29
+ assert_equal user.name, account.user_name
30
+
31
+ account.update_attribute(:user, nil)
32
+ assert_equal nil, account.user_name
33
+ end
34
+
35
+ test "should update account.user_name when update account.user with other user" do
36
+ user = users(:one)
37
+ other_user = users(:two)
38
+ account = accounts(:one)
39
+ other_account = accounts(:two)
40
+ assert_equal user.name, account.user_name
41
+ assert_equal other_user.name, other_account.user_name
42
+
43
+ account.update_attribute(:user, other_user)
44
+ assert_equal other_user.name, account.user_name
45
+ assert_equal nil, other_account.reload.user
46
+ assert_equal nil, other_account.reload.user_name
47
+ end
48
+
49
+ test "should update account.user_name when update user.name" do
50
+ user = users(:one)
51
+ account = accounts(:one)
52
+ assert_equal user.name, account.user_name
53
+
54
+ user.update_attribute(:name, "Other Name")
55
+ assert_equal user.name, user.account.user_name
56
+
57
+ assert_equal user.name, account.reload.user_name
58
+ end
59
+
60
+ end
@@ -0,0 +1,28 @@
1
+ == README
2
+
3
+ This README would normally document whatever steps are necessary to get the
4
+ application up and running.
5
+
6
+ Things you may want to cover:
7
+
8
+ * Ruby version
9
+
10
+ * System dependencies
11
+
12
+ * Configuration
13
+
14
+ * Database creation
15
+
16
+ * Database initialization
17
+
18
+ * How to run the test suite
19
+
20
+ * Services (job queues, cache servers, search engines, etc.)
21
+
22
+ * Deployment instructions
23
+
24
+ * ...
25
+
26
+
27
+ Please feel free to use a different markup language if you do not plan to run
28
+ <tt>rake doc:app</tt>.
@@ -0,0 +1,6 @@
1
+ # Add your own tasks in files placed in lib/tasks ending in .rake,
2
+ # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
3
+
4
+ require File.expand_path('../config/application', __FILE__)
5
+
6
+ Rails.application.load_tasks
@@ -0,0 +1,13 @@
1
+ // This is a manifest file that'll be compiled into application.js, which will include all the files
2
+ // listed below.
3
+ //
4
+ // Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
5
+ // or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
6
+ //
7
+ // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
8
+ // compiled file.
9
+ //
10
+ // Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
11
+ // about supported directives.
12
+ //
13
+ //= require_tree .
@@ -0,0 +1,15 @@
1
+ /*
2
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
3
+ * listed below.
4
+ *
5
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
6
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
7
+ *
8
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
9
+ * compiled file so the styles you add here take precedence over styles defined in any styles
10
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
11
+ * file per style scope.
12
+ *
13
+ *= require_tree .
14
+ *= require_self
15
+ */
@@ -0,0 +1,5 @@
1
+ class ApplicationController < ActionController::Base
2
+ # Prevent CSRF attacks by raising an exception.
3
+ # For APIs, you may want to use :null_session instead.
4
+ protect_from_forgery with: :exception
5
+ end
@@ -0,0 +1,2 @@
1
+ module ApplicationHelper
2
+ end
@@ -0,0 +1,5 @@
1
+ class Account < ActiveRecord::Base
2
+ has_one :user
3
+
4
+ redundancy :user, :name
5
+ end
@@ -0,0 +1,6 @@
1
+ class Post < ActiveRecord::Base
2
+ belongs_to :user
3
+
4
+ redundancy :user, :name
5
+ redundancy :user, :name, cache_column: :username
6
+ end
@@ -0,0 +1,6 @@
1
+ class User < ActiveRecord::Base
2
+ has_many :posts
3
+ belongs_to :account
4
+
5
+ redundancy :account, :email
6
+ end
@@ -0,0 +1,14 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>Dummy</title>
5
+ <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
6
+ <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
7
+ <%= csrf_meta_tags %>
8
+ </head>
9
+ <body>
10
+
11
+ <%= yield %>
12
+
13
+ </body>
14
+ </html>
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env ruby
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
3
+ load Gem.bin_path('bundler', 'bundle')
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ APP_PATH = File.expand_path('../../config/application', __FILE__)
3
+ require_relative '../config/boot'
4
+ require 'rails/commands'
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env ruby
2
+ require_relative '../config/boot'
3
+ require 'rake'
4
+ Rake.application.run
@@ -0,0 +1,4 @@
1
+ # This file is used by Rack-based servers to start the application.
2
+
3
+ require ::File.expand_path('../config/environment', __FILE__)
4
+ run Rails.application
@@ -0,0 +1,23 @@
1
+ require File.expand_path('../boot', __FILE__)
2
+
3
+ require 'rails/all'
4
+
5
+ Bundler.require(*Rails.groups)
6
+ require "redundancy"
7
+
8
+ module Dummy
9
+ class Application < Rails::Application
10
+ # Settings in config/environments/* take precedence over those specified here.
11
+ # Application configuration should go into files in config/initializers
12
+ # -- all .rb files in that directory are automatically loaded.
13
+
14
+ # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
15
+ # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
16
+ # config.time_zone = 'Central Time (US & Canada)'
17
+
18
+ # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
19
+ # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
20
+ # config.i18n.default_locale = :de
21
+ end
22
+ end
23
+
@@ -0,0 +1,5 @@
1
+ # Set up gems listed in the Gemfile.
2
+ ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
3
+
4
+ require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
5
+ $LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)