active_record_tweaks 0.2.0 → 0.2.1

data/.travis.yml

@@ -1,13 +1,23 @@
+# Send builds to container-based infrastructure
+# http://docs.travis-ci.com/user/workers/container-based-infrastructure/
+sudo: false
 language: ruby
 cache:
 - bundler
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.0
-  - 2.1.1
+  - 2.1.10
+  - 2.2.5
+  # Since the Travis Build Env does not recognize `2.3` alias yet
+  # We need to specify the version precisely
+  - 2.3.1
+  - ruby-head
 gemfile:
-  - gemfiles/rails3_2.gemfile
-  - gemfiles/rails4_0.gemfile
-  - gemfiles/rails4_1.gemfile
+  - gemfiles/rails_3_2.gemfile
+  - gemfiles/rails_4_0.gemfile
+  - gemfiles/rails_4_1.gemfile
+  - gemfiles/rails_4_2.gemfile
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
 

data/Appraisals

@@ -1,18 +1,32 @@
 
-appraise "rails3-2" do
-  version = "3.2.17"
-  gem 'activerecord', version
-  gem 'activesupport', version
+appraise "rails_3_2" do
+  version = "~> 3.2.20"
+  gem "activesupport", version
+  gem "actionpack", version
+  gem "activerecord", version
+  gem "railties", version
 end
 
-appraise "rails4-0" do
-  version = "4.0.3"
-  gem 'activerecord', version
-  gem 'activesupport', version
+appraise "rails_4_0" do
+  version = "~> 4.0.12"
+  gem "activesupport", version
+  gem "actionpack", version
+  gem "activerecord", version
+  gem "railties", version
 end
 
-appraise "rails4-1" do
-  version = "4.1.0.rc1"
-  gem 'activerecord', version
-  gem 'activesupport', version
+appraise "rails_4_1" do
+  version = "~> 4.1.8"
+  gem "activesupport", version
+  gem "actionpack", version
+  gem "activerecord", version
+  gem "railties", version
+end
+
+appraise "rails_4_2" do
+  version = "~> 4.2.0"
+  gem "activesupport", version
+  gem "actionpack", version
+  gem "activerecord", version
+  gem "railties", version
 end

data/Gemfile

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

data/README.md

@@ -1,39 +1,42 @@
-Active Record Tweaks
-===========
+# 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](http://img.shields.io/travis/PikachuEXE/active_record_tweaks.svg)](https://travis-ci.org/PikachuEXE/active_record_tweaks)
-[![Gem Version](http://img.shields.io/gem/v/active_record_tweaks.svg)](http://badge.fury.io/rb/active_record_tweaks)
-[![Dependency Status](http://img.shields.io/gemnasium/PikachuEXE/active_record_tweaks.svg)](https://gemnasium.com/PikachuEXE/active_record_tweaks)
-[![Coverage Status](http://img.shields.io/coveralls/PikachuEXE/active_record_tweaks.svg)](https://coveralls.io/r/PikachuEXE/active_record_tweaks)
-[![Code Climate](http://img.shields.io/codeclimate/github/PikachuEXE/active_record_tweaks.svg)](https://codeclimate.com/github/PikachuEXE/active_record_tweaks)
+## Status
 
-Install
-=======
+[![Build Status](http://img.shields.io/travis/PikachuEXE/active_record_tweaks.svg?style=flat-square)](https://travis-ci.org/PikachuEXE/active_record_tweaks)
+[![Gem Version](http://img.shields.io/gem/v/active_record_tweaks.svg?style=flat-square)](http://badge.fury.io/rb/active_record_tweaks)
+[![Dependency Status](http://img.shields.io/gemnasium/PikachuEXE/active_record_tweaks.svg?style=flat-square)](https://gemnasium.com/PikachuEXE/active_record_tweaks)
+[![Coverage Status](http://img.shields.io/coveralls/PikachuEXE/active_record_tweaks.svg?style=flat-square)](https://coveralls.io/r/PikachuEXE/active_record_tweaks)
+[![Code Climate](http://img.shields.io/codeclimate/github/PikachuEXE/active_record_tweaks.svg?style=flat-square)](https://codeclimate.com/github/PikachuEXE/active_record_tweaks)
+
+
+## Installation
 
 ```ruby
 gem 'active_record_tweaks'
 ```
 
-Usage
-=====
+
+## Usage
 
 Either include it in specific record or just `ActiveRecord::Base`
 ```ruby
 class SomeRecord
+  include ActiveRecordTweaks::Integration::InstanceMethods
+  # This module is also DEPRECATED
+  # See below for details
+  extend  ActiveRecordTweaks::Integration::ClassMethods
+
+  # DEPRECATED
   include ActiveRecordTweaks
 end 
 
 # or
 
 # In a initialzer
+# DEPRECATED
 ActiveRecord::Base.send(:include, ActiveRecordTweaks)
 ```
 
@@ -54,15 +57,23 @@ Nothing special, just like `record.cache_key` in rails 4.1
 But it does not check against columns  
 e.g. When you have some virtual timestamp attribute method (cached or not)  
 Just make sure you throw some name to it or it will raise error  
-Alias: `#cache_key_from_attribute`
+Alias: `#cache_key_from_attribute`  
 Usage:
 ```ruby
   # Just like using #cache_key
-  record.cache_key_from_attributes(:happy_at, :chirdren_max_updated_at)
+  record.cache_key_from_attributes(:happy_at, :children_max_updated_at)
 ```
 
 
 ### `.cache_key`
+
+**DEPRECATED**  
+This method does NOT consider the query like filters and and sort orders.  
+Thus deprecated without replacement.  
+Rails 5 already have `#cache_key` in relation class: https://github.com/rails/rails/pull/20884  
+There is also a gem for older rails: https://github.com/customink/activerecord-collection_cache_key  
+
+**Usage**  
 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))  
@@ -98,6 +109,11 @@ RecordClass.cache_key(:updated_at, :updated_on)
 
 
 ### `.cache_key_without_timestamp`
+
+**DEPRECATED**  
+Same deprecation reasons and replacement suggestion as `.cache_key` above  
+
+**Usage**
 Just like `.cache_key(nil)`  
 But much clearer
 ```ruby
@@ -106,8 +122,8 @@ Person.maximum(:updated_at) # => 20131106012125528738000
 Person.cache_key_without_timestamp # => "people/all/1000"
 
 # Other examples
-Product.cache_key     # => "products/all/0" (empty, has updated timestamp columns or not)
-Product.cache_key     # => "products/all/1" (not empty but has no updated timestamp columns)
+Product.cache_key_without_timestamp     # => "products/all/0" (empty, has updated timestamp columns or not)
+Product.cache_key_without_timestamp     # => "products/all/1" (not empty but has no updated timestamp columns)
 ```
 Usage:
 ```ruby

data/Rakefile

@@ -1,15 +1,18 @@
 require "appraisal"
 require "bundler"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 Bundler::GemHelper.install_tasks
 
 RSpec::Core::RakeTask.new(:spec)
 
+RuboCop::RakeTask.new(:rubocop)
+
 if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
   task :default do
-    sh "rake appraisal:install && rake appraisal spec"
+    sh "appraisal install && rake appraisal spec rubocop"
   end
 else
-  task :default => :spec
+  task default: [:spec, :rubocop]
 end

data/active_record_tweaks.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
+# rubocop:disable all
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
 
 author_name = "PikachuEXE"
 gem_name = "active_record_tweaks"
@@ -11,7 +12,9 @@ Gem::Specification.new do |s|
   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.description   = <<-DOC
+    ActiveRecord is great, but could be better. Here are some tweaks for it.
+  DOC
 
   s.license       = "MIT"
 
@@ -21,21 +24,22 @@ Gem::Specification.new do |s|
 
   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.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 "bundler", ">= 1.0.0"
-  s.add_development_dependency "rake", ">= 0.9.2"
-  s.add_development_dependency "appraisal", ">= 0.5.2"
-  s.add_development_dependency "rspec", "~> 2.6"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "appraisal", "~> 2.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "rspec-its", "~> 1.0"
   s.add_development_dependency "sqlite3", ">= 1.3"
   s.add_development_dependency "database_cleaner", ">= 1.0"
   s.add_development_dependency "coveralls", ">= 0.7"
   s.add_development_dependency "gem-release", ">= 0.7"
   s.add_development_dependency "timecop", ">= 0.7.1"
+  s.add_development_dependency "rubocop", "~> 0.30"
 
   s.required_rubygems_version = ">= 1.4.0"
 end

data/gemfiles/rails_3_2.gemfile

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

data/gemfiles/rails_4_0.gemfile

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

data/gemfiles/rails_4_1.gemfile

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

data/gemfiles/rails_4_2.gemfile

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

data/lib/active_record_tweaks.rb

@@ -1,12 +1,14 @@
-require 'active_support/concern'
-
-require 'active_record_tweaks/version'
-require 'active_record_tweaks/integration'
+require "active_record_tweaks/version"
+require "active_record_tweaks/integration"
 
 module ActiveRecordTweaks
-  extend ActiveSupport::Concern
+  def self.included(base)
+    # rubocop:disable all
+    warn "[DEPRECATION] including `ActiveRecordTweaks` is deprecated. Please see README for recommanded usage."
+    # rubocop:enable all
 
-  included do
-    include Integration
+    base.class_eval do
+      include Integration
+    end
   end
 end

data/lib/active_record_tweaks/integration.rb

@@ -1,73 +1,88 @@
-require 'active_support/concern'
-
 module ActiveRecordTweaks
   module Integration
-    extend ActiveSupport::Concern
+    def self.included(base)
+      base.class_eval do
+        # rubocop:disable all
+        warn "[DEPRECATION] including `ActiveRecordTweaks::Integration` is deprecated. Please see README for recommanded usage."
+        # rubocop:enable all
 
-    # 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_without_timestamp     # => "products/new"
-    #   Product.find(5).cache_key_without_timestamp # => "products/5" (updated_at not available)
-    #   Person.find(5).cache_key_without_timestamp  # => "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}"
+        extend ClassMethods
+        include InstanceMethods
       end
     end
 
-    # Works like #cache_key in rails 4.1, but does not check column
-    # Useful when you have some virtual timestamp attribute method (cached or not)
-    #
-    # @param attribute_names [Array<Symbol,String>]
-    #   Names of attributes method(s)
-    #   It does not have to be column(s)
-    #
-    # @raise [ArgumentError] when attribute_names is empty
-    def cache_key_from_attributes(*attribute_names)
-      attribute_names.any? or raise ArgumentError
+    module InstanceMethods
+      # 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_without_timestamp     # => "products/new"
+      #   Product.find(5).cache_key_without_timestamp # => "products/5" (updated_at not available)
+      #   Person.find(5).cache_key_without_timestamp  # => "people/5" (updated_at available)
+      def cache_key_without_timestamp
+        if new_record?
+          "#{self.class.model_name.cache_key}/new"
+        else
+          "#{self.class.model_name.cache_key}/#{id}"
+        end
+      end
+
+      # Works like #cache_key in rails 4.1, but does not check column
+      # Useful when you have some virtual timestamp attribute method (cached or not)
+      #
+      # @param attribute_names [Array<Symbol,String>]
+      #   Names of attributes method(s)
+      #   It does not have to be column(s)
+      #
+      # @raise [ArgumentError] when attribute_names is empty
+      def cache_key_from_attributes(*attribute_names)
+        attribute_names.any? || fail(ArgumentError)
 
-      if timestamp = max_updated_attribute_timestamp_for_cache_key(attribute_names)
-        timestamp = timestamp.utc.to_s(cache_timestamp_format)
-        "#{self.class.model_name.cache_key}/#{id}-#{timestamp}"
-      else
-        "#{self.class.model_name.cache_key}/#{id}"
+        timestamp = max_updated_attribute_timestamp_for_cache_key(attribute_names)
+        if timestamp
+          timestamp = timestamp.utc.to_s(cache_timestamp_format)
+          "#{self.class.model_name.cache_key}/#{id}-#{timestamp}"
+        else
+          "#{self.class.model_name.cache_key}/#{id}"
+        end
       end
-    end
-    alias_method :cache_key_from_attribute, :cache_key_from_attributes
+      alias cache_key_from_attribute cache_key_from_attributes
 
-    private
+      private
 
-    def max_updated_attribute_timestamp_for_cache_key(timestamp_attribute_names)
-      timestamps = timestamp_attribute_names.map do |attribute_name|
-        self.send(attribute_name)
-      end.compact
+      def max_updated_attribute_timestamp_for_cache_key(timestamp_attribute_names)
+        timestamps = timestamp_attribute_names.map do |attribute_name|
+          send(attribute_name)
+        end.compact
 
-      if timestamps.present?
-        timestamps.map { |ts| ts.to_time }.max
+        return nil unless timestamps.present?
+        timestamps.map(&:to_time).max
       end
     end
 
     module ClassMethods
+      # rubocop:disable all
+      warn "[DEPRECATION] `ActiveRecordTweaks::Integration::ClassMethods` is deprecated without replacement. Please read README in project for details."
+      # rubocop:enable all
+
       # 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/all/0" (empty, has updated timestamp columns or not)
-      #   Product.cache_key     # => "products/all/1" (not empty but has no updated timestamp columns)
-      #   Person.cache_key     # => "people/all/1-20071224150000" (not empty and has updated timestamp columns)
+      # @example when record class is empty and has updated timestamp columns or not
+      #   Product.cache_key # => "products/all/0"
+      # @example when record class is not empty but has no updated timestamp columns
+      #   Product.cache_key # => "products/all/1"
+      # @example when record class is not empty and has updated timestamp columns
+      #   Person.cache_key # => "people/all/1-20071224150000"
       #
       # @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)
+        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}"
+          "#{model_name.cache_key}/all/#{count}-#{timestamp}"
         else
           cache_key_without_timestamp
         end
@@ -76,23 +91,23 @@ module ActiveRecordTweaks
       # Returns a cache key for the ActiveRecord class based
       # based on count only
       #
-      #   Product.cache_key     # => "products/all/0" (empty, has updated timestamp columns or not)
-      #   Product.cache_key     # => "products/all/1" (not empty but has no updated timestamp columns)
-      #   Person.cache_key     # => "people/all/1" (not empty and has updated timestamp columns)
+      #   Product.cache_key # => "products/all/0" (empty, has updated timestamp columns or not)
+      #   Product.cache_key # => "products/all/1" (not empty but has no updated timestamp columns)
+      #   Person.cache_key  # => "people/all/1" (not empty and has updated timestamp columns)
       #
       # @param [Array<String, Symbol>] args The column name with timestamp to check
       def cache_key_without_timestamp
-        "#{self.model_name.cache_key}/all/#{self.count}"
+        "#{model_name.cache_key}/all/#{count}"
       end
 
       private
 
       def max_updated_column_timestamp_for_cache_key(timestamp_columns)
-        available_timestamp_columns = timestamp_columns.select { |c| self.column_names.include?(c.to_s) }
+        available_timestamp_columns = timestamp_columns.select { |c| column_names.include?(c.to_s) }
+        timestamps = available_timestamp_columns.map { |column| maximum(column) }.compact
 
-        if (timestamps = available_timestamp_columns.map { |column| self.maximum(column) }.compact).present?
-          timestamps.map { |ts| ts.to_time }.max
-        end
+        return nil unless timestamps.present?
+        timestamps.map(&:to_time).max
       end
     end
   end