active_record_tweaks 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6c504a0ed5232370690f5499f743c5c7581dab0
+  data.tar.gz: 0b05eb09c16078bd87853e88f0d5d8a771102212
+SHA512:
+  metadata.gz: b65f4621e384155be04e7ea35a644a528ba2d7758625a310f8241fee90dca37c42703592e83d1fa48eefcf9063ae9cc7cbe1cd6da0dcb87b274e5f4f498285f3
+  data.tar.gz: 1c70119ae53329e44a4f24a76cbe169db8f9789b9a1423fa32198d95698e7941f704575d4770f12d964925e140a40f5a3d4808d64913f092747f7ba409e169c3

data/.gitignore

@@ -0,0 +1,2 @@
+gemfiles/*.gemfile.lock
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,13 @@
+script: "bundle exec rspec"
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - gemfiles/rails3_2.gemfile
+  - gemfiles/rails4_0.gemfile
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      gemfile: gemfiles/rails4_0.gemfile
+

data/Appraisals

@@ -0,0 +1,12 @@
+
+appraise "rails3-2" do
+  version = "3.2.15"
+  gem 'activesupport', version
+  gem 'actionpack', version
+end
+
+appraise "rails4-0" do
+  version = "4.0.0"
+  gem 'activesupport', version
+  gem 'actionpack', version
+end

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### Changelog
+
+
+- **0.1**
+  - Initial Release

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 PikachuEXE
+
+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,71 @@
+Active Record Tweaks
+===========
+
+Active Record is great, but could be better. Here are some tweaks for it.
+
+### Support
+===========
+Tested against:
+- Active Record of version `3.2` and `4.0`
+- Ruby `1.9.3`, `2.0.0` (except Rails 4 with `1.9.2`)
+
+[![Build Status](https://travis-ci.org/PikachuEXE/active_record_tweaks.png?branch=master)](https://travis-ci.org/PikachuEXE/active_record_tweaks)
+[![Gem Version](https://badge.fury.io/rb/active_record_tweaks.png)](http://badge.fury.io/rb/active_record_tweaks)
+[![Dependency Status](https://gemnasium.com/PikachuEXE/active_record_tweaks.png)](https://gemnasium.com/PikachuEXE/active_record_tweaks)
+[![Coverage Status](https://coveralls.io/repos/PikachuEXE/active_record_tweaks/badge.png)](https://coveralls.io/r/PikachuEXE/active_record_tweaks)
+[![Code Climate](https://codeclimate.com/github/PikachuEXE/active_record_tweaks.png)](https://codeclimate.com/github/PikachuEXE/active_record_tweaks)
+
+Install
+=======
+
+```ruby
+gem 'active_record_tweaks'
+```
+
+Usage
+=====
+
+Either include it in specific record or just `ActiveRecord::Base`
+```ruby
+class SomeRecord
+  include ActiveRecordTweaks
+end 
+
+# or
+
+# In a initialzer
+ActiveRecord::Base.send(:include, ActiveRecordTweaks)
+```
+
+
+### `#cache_key_without_timestamp`
+Nothing special, just like `record.cache_key`  
+But it has no timestamp so you can use it for scoped cache key  
+(e.g. When caching with Cookie, which you want to control the expiry time independent of record update time)  
+Usage:
+```ruby
+  # Just like using #cache_key
+  record.cache_key_without_timestamp
+```
+
+
+### `.cache_key`
+There is no class level cache key for ActiveRecord at the moment (4.0.1)  
+Passing an array to `cache_digest` could lead to performance issue and the key can become too long when collection is big  
+([rails#12726](https://github.com/rails/rails/pull/12726))  
+This is used for getting a cache key for a ActiveRecord class for all record (I don't know how to write one for `Relation`, could be similar)  
+You can use it for class level caching (like displaying all Categories or a random list of 5 users  
+And the cache would only expire when there is any record created, updated, or deleted (since `count` and maximum of `updated_at` are used)  
+```ruby
+Person.count # => 1000
+Person.maximum(:updated_at) # => 20131106012125528738000
+Person.cache_key # => "people/all/1000-20131106012125528738000"
+```
+Usage:
+```ruby
+RecordClass.cache_key
+```
+You can also use it with multiple records (Rails 4 Record might have `updated_at` and `updated_on`)
+```ruby
+RecordClass.cache_key(:updated_at, :updated_on)
+```

data/Rakefile

@@ -0,0 +1,11 @@
+require 'appraisal'
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+task :default do
+  sh "rake appraisal:install && rake appraisal spec"
+end
+
+RSpec::Core::RakeTask.new(:spec)

data/active_record_tweaks.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+author_name = 'PikachuEXE'
+gem_name = 'active_record_tweaks'
+
+require "#{gem_name}/version"
+
+Gem::Specification.new do |s|
+  s.platform      = Gem::Platform::RUBY
+  s.name          = gem_name
+  s.version       = ActiveRecordTweaks::VERSION
+  s.summary       = 'Some Tweaks for ActiveRecord'
+  s.description   = 'ActiveRecord is great, but could be better. Here are some tweaks for it.'
+
+  s.license       = 'MIT'
+
+  s.authors       = [author_name]
+  s.email         = ['pikachuexe@gmail.com']
+  s.homepage      = "http://github.com/#{author_name}/#{gem_name}"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_dependency 'activerecord', '>= 3.2.0', '< 5.0.0'
+  s.add_dependency 'activesupport', '>= 3.2.0', '< 5.0.0'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'appraisal'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'coveralls'
+end

data/gemfiles/rails3_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "3.2.15"
+gem "actionpack", "3.2.15"
+
+gemspec :path=>"../"

data/gemfiles/rails4_0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "4.0.0"
+gem "actionpack", "4.0.0"
+
+gemspec :path=>"../"

data/lib/active_record_tweaks.rb

@@ -0,0 +1,12 @@
+require 'active_support/concern'
+
+require 'active_record_tweaks/version'
+require 'active_record_tweaks/integration'
+
+module ActiveRecordTweaks
+  extend ActiveSupport::Concern
+
+  included do
+    include Integration
+  end
+end

data/lib/active_record_tweaks/integration.rb

@@ -0,0 +1,53 @@
+require 'active_support/concern'
+
+module ActiveRecordTweaks
+  module Integration
+    extend ActiveSupport::Concern
+
+    # Returns a cache key that can be used to identify this record.
+    # Timestamp is not used to allow custom caching expiration
+    # (e.g. Cookie based caching with expiration )
+    #
+    #   Product.new.cache_key     # => "products/new"
+    #   Product.find(5).cache_key # => "products/5" (updated_at not available)
+    #   Person.find(5).cache_key  # => "people/5" (updated_at available)
+    def cache_key_without_timestamp
+      case
+      when new_record?
+        "#{self.class.model_name.cache_key}/new"
+      else
+        "#{self.class.model_name.cache_key}/#{id}"
+      end
+    end
+
+    module ClassMethods
+      # Returns a cache key for the ActiveRecord class based
+      # based on count and maximum value of update timestamp columns
+      # (e.g. Cookie based caching with expiration)
+      #
+      #   Product.cache_key     # => "products/0" (empty, has updated timestamp columns or not)
+      #   Product.cache_key     # => "products/1" (not empty but has no updated timestamp columns)
+      #   Person.cache_key     # => "people/1-20071224150000" (not empty and has updated timestamp columns)
+      #
+      # @param [Array<String, Symbol>] args The column name with timestamp to check
+      def cache_key(*args)
+        timestamp_columns = args.empty? ? [:updated_at] : args
+
+        if timestamp = max_updated_column_timestamp_for_cache_key(timestamp_columns)
+          timestamp = timestamp.utc.to_s(cache_timestamp_format)
+          "#{self.model_name.cache_key}/all/#{self.count}-#{timestamp}"
+        else
+          "#{self.model_name.cache_key}/all/#{self.count}"
+        end
+      end
+
+      def max_updated_column_timestamp_for_cache_key(timestamp_columns)
+        available_timestamp_columns = timestamp_columns.select { |c| self.column_names.include?(c.to_s) }
+
+        if (timestamps = available_timestamp_columns.map { |column| self.maximum(column) }.compact).present?
+          timestamps.map { |ts| ts.to_time }.max
+        end
+      end
+    end
+  end
+end

data/lib/active_record_tweaks/version.rb

@@ -0,0 +1,3 @@
+module ActiveRecordTweaks
+  VERSION = '0.1'.freeze
+end

data/spec/active_record_tweaks_spec.rb

@@ -0,0 +1,179 @@
+require 'spec_helper'
+
+describe Parent do
+  describe 'included modules' do
+    it do
+      described_class.ancestors.should include(ActiveRecordTweaks)
+    end
+  end
+
+  describe '::Integration' do
+    describe '#cache_key_without_timestamp' do
+      subject { record.cache_key_without_timestamp }
+
+
+      context 'when record is a new record' do
+        let(:record) { Parent.new }
+
+        it 'works like #cache_key' do
+          should eq "#{record.class.model_name.cache_key}/new"
+        end
+      end
+
+      context 'when record is an existing record' do
+        let(:record) { Parent.create! }
+
+
+        context 'and update_at is nil' do
+          before { record.update_attributes!(updated_at: nil) }
+
+          it 'works like #cache_key' do
+            should eq "#{record.class.model_name.cache_key}/#{record.id}"
+          end
+        end
+
+        context 'and update_at is present' do
+          it 'works like #cache_key when updated_at is nil' do
+            should eq "#{record.class.model_name.cache_key}/#{record.id}"
+          end
+        end
+      end
+
+      context 'when record has no update_at column' do
+        let!(:record) { Stone.create }
+
+        it 'works like #cache_key when updated_at is nil' do
+          should eq "#{record.class.model_name.cache_key}/#{record.id}"
+        end
+      end
+    end
+
+    describe '.cache_key' do
+      subject { klass.cache_key }
+
+      context 'when a class has no update_at column' do
+        let(:klass) { Stone }
+
+        context 'and has no record' do
+          before { klass.count.should eq 0 }
+
+          it { should match /\/#{klass.count}$/ }
+        end
+        context 'and has a record' do
+          before { klass.create! }
+
+          it { should match /\/#{klass.count}$/ }
+        end
+      end
+
+      context 'when a class has updated_at column' do
+        let(:klass) { Parent }
+
+        context 'and has no record' do
+          before { klass.count.should eq 0 }
+
+          it { should match /\/#{klass.count}$/ }
+        end
+
+        context 'and has a record' do
+          let!(:parent) { klass.create! }
+
+          it { should eq "parents/all/#{klass.count}-#{klass.maximum(:updated_at).utc.to_s(:nsec)}" }
+
+          context 'when record all has nil updated timestamps' do
+            before { klass.update_all(updated_at: nil) }
+
+            it { should match /\/#{klass.count}$/ }
+          end
+
+          describe 'precision' do
+            let!(:child) { Child.create!(parent: parent) }
+            let!(:old_cache_key) { klass.cache_key }
+            let(:new_cache_key) { klass.cache_key }
+
+            subject { new_cache_key }
+
+            context 'when self touched' do
+              before { parent.touch }
+
+              it { should_not eq old_cache_key }
+            end
+
+            context 'when child touched' do
+              before { child.touch }
+
+              it { should_not eq old_cache_key }
+            end
+          end
+        end
+      end
+
+      context 'when a class has updated_at AND updated_on column' do
+        let(:klass) { Person }
+
+        context 'when getting cache_key using update_on column' do
+          subject { klass.cache_key(:updated_on) }
+
+          context 'and has no record' do
+            before { klass.count.should eq 0 }
+
+            it { should match /\/#{klass.count}$/ }
+          end
+          context 'and has a record' do
+            let!(:person) { klass.create! }
+
+            context 'and it has updated_at value only' do
+              before { person.update_attributes!(updated_at: Time.now, updated_on: nil) }
+
+              it { should eq "people/all/#{klass.count}" }
+            end
+
+            context 'and it has updated_on value only' do
+              before { person.update_attributes!(updated_at: nil, updated_on: Time.now) }
+
+              it { should eq "people/all/#{klass.count}-#{klass.maximum(:updated_on).utc.to_s(:nsec)}" }
+            end
+          end
+        end
+
+        context 'when getting cache_key using both columns' do
+          subject { klass.cache_key(:updated_at, :updated_on) }
+
+          context 'and has no record' do
+            before { klass.count.should eq 0 }
+
+            it { should match /\/#{klass.count}$/ }
+          end
+          context 'and has a record' do
+            let!(:person) { klass.create! }
+
+            context 'and it has updated_on value only' do
+              before { person.update_attributes!(updated_at: nil, updated_on: Time.now) }
+
+              it { should eq "people/all/#{klass.count}-#{klass.maximum(:updated_on).utc.to_s(:nsec)}" }
+            end
+
+            context 'and it has newer updated_at' do
+              before { person.update_attributes!(updated_at: Time.now + 3600, updated_on: Time.now) }
+
+              it { should eq "people/all/#{klass.count}-#{klass.maximum(:updated_at).utc.to_s(:nsec)}" }
+            end
+
+            context 'and it has newer updated_on' do
+              before { person.update_attributes!(updated_at: Time.now , updated_on: Time.now+ 3600) }
+
+              it { should eq "people/all/#{klass.count}-#{klass.maximum(:updated_on).utc.to_s(:nsec)}" }
+            end
+          end
+        end
+      end
+
+      context 'when a class has custom timestamp format' do
+        let(:klass) { Animal }
+        let!(:record) { klass.create! }
+
+        it { should eq "animals/all/#{klass.count}-#{klass.maximum(:updated_at).utc.to_s(:number)}" }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,95 @@
+if ENV["TRAVIS"]
+  require 'coveralls'
+  Coveralls.wear!('rails')
+end
+
+require 'active_record'
+require 'active_record_tweaks'
+
+require 'database_cleaner'
+require 'logger'
+
+# ActiveRecord::Base.logger = Logger.new(STDOUT) # for easier debugging
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before do
+    DatabaseCleaner.start
+  end
+
+  config.after do
+    DatabaseCleaner.clean
+  end
+end
+
+ActiveRecord::Base.send(:include, ActiveRecordTweaks)
+
+# connect
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+# create tables
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :stones do |t|
+  end
+
+  create_table :animals do |t|
+    t.datetime :created_at
+    t.datetime :updated_at
+  end
+
+  create_table :parents do |t|
+    t.datetime :created_at
+    t.datetime :updated_at
+  end
+
+  create_table :children do |t|
+    t.integer :parent_id
+
+    t.datetime :created_at
+    t.datetime :updated_at
+  end
+
+  create_table :people do |t|
+    t.datetime :created_at
+    t.datetime :updated_at
+    t.datetime :created_on
+    t.datetime :updated_on
+  end
+end
+
+# Setup models
+
+# Default cache timestamp format are different for Rails 3 and 4 are different,
+# So set it explictly here
+class Stone < ActiveRecord::Base
+end
+
+class Animal < ActiveRecord::Base
+  self.cache_timestamp_format = :number
+end
+
+class Parent < ActiveRecord::Base
+  self.cache_timestamp_format = :nsec
+
+  has_many :children, inverse_of: :parent
+end
+
+class Child < ActiveRecord::Base
+  self.cache_timestamp_format = :nsec
+
+  belongs_to :parent, inverse_of: :children, touch: true
+end
+
+class Person < ActiveRecord::Base
+  self.cache_timestamp_format = :nsec
+end
+
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: active_record_tweaks
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- PikachuEXE
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord is great, but could be better. Here are some tweaks for
+  it.
+email:
+- pikachuexe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- active_record_tweaks.gemspec
+- gemfiles/rails3_2.gemfile
+- gemfiles/rails4_0.gemfile
+- lib/active_record_tweaks.rb
+- lib/active_record_tweaks/integration.rb
+- lib/active_record_tweaks/version.rb
+- spec/active_record_tweaks_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/PikachuEXE/active_record_tweaks
+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.1.9
+signing_key: 
+specification_version: 4
+summary: Some Tweaks for ActiveRecord
+test_files:
+- spec/active_record_tweaks_spec.rb
+- spec/spec_helper.rb
+has_rdoc: