cach_em_all 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b46739a788f68c9a35ced65e0f3f043cda7547b
+  data.tar.gz: ea90c71242394948aa32fd8727788f9e02cb139c
+SHA512:
+  metadata.gz: a76542174102f1af1e0d93fa94397af1df78d2048ccc074c56f170d05d9a068e122599c53afdd547c9940825cb984eaf79c7fbccaf396b6f3f41b84b3ac5ab7c
+  data.tar.gz: 3771c742f8890852ec00a67bb07ed060c980a82b116e35d3d627a735be22bb40dd271056ba6853e2d9ae685ba33f3705fb79b5656246b2e772304c50ca3c5fea

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Oscar Esgalha
+
+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,32 @@
+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    = 'CachEmAll'
+  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/cach_em_all.rb

@@ -0,0 +1,3 @@
+require 'cach_em_all/core_ext/active_record_base_ext'
+require 'cach_em_all/core_ext/active_record_relation_ext'
+require 'cach_em_all/railtie' if defined? Rails

data/lib/cach_em_all/core_ext/active_record_base_ext.rb

@@ -0,0 +1,14 @@
+module CachEmAll
+  module ActiveRecordBaseExt
+    extend ActiveSupport::Concern
+    module ClassMethods
+      def cache_key
+        ar_count        = count
+        max_updated_at  = maximum(:updated_at).try(:utc).try :to_s, :number
+        name            = self.name.tableize
+        prefix          = 'all'
+        [name, [prefix, ar_count, max_updated_at].join('-')].join '/'
+      end
+    end
+  end
+end

data/lib/cach_em_all/core_ext/active_record_relation_ext.rb

@@ -0,0 +1,12 @@
+module CachEmAll
+  module ActiveRecordRelationExt
+    extend ActiveSupport::Concern
+    def cache_key
+      ar_count        = count
+      max_updated_at  = maximum(:updated_at).try(:utc).try :to_s, :number
+      name            = self.name.tableize
+      prefix          = Digest::SHA256.hexdigest to_sql.to_s
+      [name, [prefix, ar_count, max_updated_at].join('-')].join '/'
+    end
+  end
+end

data/lib/cach_em_all/railtie.rb

@@ -0,0 +1,10 @@
+module CachEmAll
+  class Railtie < ::Rails::Railtie
+    initializer 'cach_em_all' do |app|
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send     :include, CachEmAll::ActiveRecordBaseExt
+        ActiveRecord::Relation.send :include, CachEmAll::ActiveRecordRelationExt
+      end
+    end
+  end
+end

data/lib/cach_em_all/version.rb

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

data/spec/helper_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe ApplicationHelper, type: :helper do
+  
+  before :all do
+    @empty_block = Proc.new{}
+  end
+
+  describe '#cache' do
+    it "should accept an arbitrary ActiveRecord's class name" do
+      expect{ helper.cache(ArbitraryRecord, &@empty_block) }.not_to raise_error
+    end
+
+    it "should accept an arbitrary ActiveRecord's instance " do
+      expect{ helper.cache(ArbitraryRecord.take, &@empty_block) }.not_to raise_error
+    end
+
+    it "should accept an arbitrary ActiveRecord's relation" do
+      expect{ helper.cache(ArbitraryRecord.where(true), &@empty_block) }.not_to raise_error
+    end
+  end
+end

data/spec/key_value_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+describe 'An ActiveRecord cache_key for all models' do
+  # Initialize some data  
+  before :all do
+    3.times {FactoryGirl.create :arbitrary_record}
+  end
+
+  it 'should be the same if there was no change in the records' do
+    old_cache_key = ArbitraryRecord.cache_key
+    # Check a random number of times
+    (1 + rand(10)).times do
+      new_cache_key = ArbitraryRecord.cache_key
+      old_cache_key.should be_eql new_cache_key
+    end
+  end
+
+  describe 'should update when' do
+    it 'a new record is inserted' do
+      old_cache_key = ArbitraryRecord.cache_key
+      FactoryGirl.create :arbitrary_record
+      old_cache_key.should_not be_eql ArbitraryRecord.cache_key
+    end
+
+    it 'a record is destroyed' do
+      old_cache_key = ArbitraryRecord.cache_key
+      ArbitraryRecord.take.destroy!
+      old_cache_key.should_not be_eql ArbitraryRecord.cache_key
+    end
+
+    it 'a record is updated' do
+      old_cache_key = ArbitraryRecord.cache_key
+      record = ArbitraryRecord.take
+      record.name = record.name.reverse
+      record.save
+      ArbitraryRecord.set_callback :commit, :after do
+        old_cache_key.should_not be_eql ArbitraryRecord.cache_key
+      end
+    end
+  end
+end
+
+describe 'An ActiveRecord cache_key for a relation' do
+  # Initialize some data  
+  before :all do
+    3.times {FactoryGirl.create :arbitrary_record}
+  end
+
+  it 'should be the same if there was no change in the records' do
+    old_cache_key = ArbitraryRecord.where('').cache_key
+    # Check a random number of times
+    (1 + rand(10)).times do
+      new_cache_key = ArbitraryRecord.where('').cache_key
+      old_cache_key.should be_eql new_cache_key
+    end
+  end
+
+  describe 'should update when' do
+    it 'a new record is inserted' do
+      old_cache_key = ArbitraryRecord.where('').cache_key
+      FactoryGirl.create :arbitrary_record
+      old_cache_key.should_not be_eql ArbitraryRecord.where('').cache_key
+    end
+
+    it 'a record is destroyed' do
+      old_cache_key = ArbitraryRecord.where('').cache_key
+      ArbitraryRecord.where('').first.destroy!
+      old_cache_key.should_not be_eql ArbitraryRecord.where('').cache_key
+    end
+
+    it 'a record is updated' do
+      old_cache_key = ArbitraryRecord.where('').cache_key
+      record = ArbitraryRecord.where('').first
+      record.name = record.name.reverse
+      record.save
+      ArbitraryRecord.set_callback :commit, :after do
+        old_cache_key.should_not be_eql ArbitraryRecord.where('').cache_key
+      end
+    end
+
+    it 'the conditions are the same, but the order is different' do
+      old_cache_key = ArbitraryRecord.order(:id).cache_key
+      old_cache_key.should_not be_eql ArbitraryRecord.order(:name).cache_key
+    end
+
+    it 'the conditions are the same, but the limit is different' do
+      old_cache_key = ArbitraryRecord.order(:id).limit(10).cache_key
+      old_cache_key.should_not be_eql ArbitraryRecord.order(:id).limit(5).cache_key
+    end
+
+    it 'the conditions are the same, but the offset is different' do
+      old_cache_key = ArbitraryRecord.order(:id).limit(10).offset(0).cache_key
+      old_cache_key.should_not be_eql ArbitraryRecord.order(:id).limit(10).offset(10).cache_key
+    end
+  end
+end

data/spec/respond_to_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe "An arbitrary ActiveRecord's" do
+  # Initialize some data  
+  before :all do
+    3.times {FactoryGirl.create :arbitrary_record}
+  end
+
+  it 'class should respond to cache_key' do
+    ArbitraryRecord.should respond_to(:cache_key)
+  end
+
+  it 'instance should respond to cache_key' do
+    ArbitraryRecord.take.should respond_to(:cache_key)
+  end
+
+  it 'relation should respond to cache_key' do
+    ArbitraryRecord.where(true).should respond_to(:cache_key)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+require 'factory_girl'
+
+ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
+FactoryGirl.find_definitions
+
+RSpec.configure do |config|
+  config.use_transactional_fixtures = true
+  config.order = "random"
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: cach_em_all
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oscar Esgalha
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rspec-rails
+  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: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: CachEmAll is a gem which aims to make the use of Rails 4's fragment caching
+  even easier.
+email:
+- oscaresgalha@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cach_em_all.rb
+- lib/cach_em_all/core_ext/active_record_relation_ext.rb
+- lib/cach_em_all/core_ext/active_record_base_ext.rb
+- lib/cach_em_all/version.rb
+- lib/cach_em_all/railtie.rb
+- MIT-LICENSE
+- Rakefile
+- spec/helper_spec.rb
+- spec/spec_helper.rb
+- spec/key_value_spec.rb
+- spec/respond_to_spec.rb
+homepage: http://github.com/obranchr/cach_em_all
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Fragment cache helpers for rails 4.
+test_files:
+- spec/helper_spec.rb
+- spec/spec_helper.rb
+- spec/key_value_spec.rb
+- spec/respond_to_spec.rb