group_cache_key 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8677932156a03b16648f131aa1a4e09fe5d41484
-  data.tar.gz: 6564feaa72ff33b74497a34be09c73d2c2415ae7
+  metadata.gz: bc40700ca6ecb2215c11b21b3778984a75181b50
+  data.tar.gz: 261a5584b5c3b67f945fbfa997d7cf3bcfc39f66
 SHA512:
-  metadata.gz: 68ffffe247bb374ef5593ee53f22848370d73abcddaf7e1f945872979ae06259e36ed86a81251c6094efe65cfab5de8670247d8c335e92ce898eca7c77a5cfa8
-  data.tar.gz: 1b64a2fd098b60b06e0df04641ca32b14abcbf9af5d0c81e3eab901435c6e29eb0484a220b7efbe9b79459c78ddca4a960a6c41f0670a68d4ae633e65ca8e236
+  metadata.gz: 88219993ac4f836a29a28ca9e4508cd13cd60021484d2c53378e0284af73566effbe3dd97c94d36862a0541b36b38e080ab40d7dc85777db73c50b5f39319137
+  data.tar.gz: 6fc22b227765b3ca7bdc1ba58e4452d764c25e82eab92d721b09c6cab4bc237be9aaf2f33e958a0b0344936539b6ce8915301e66af268aab6e3861e8fda5a671

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    group_cache_key (0.4.1)
+      activerecord
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
+      builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    i18n (0.6.1)
+    minitest (4.7.0)
+    multi_json (1.7.2)
+    rake (10.0.4)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  group_cache_key!
+  minitest
+  rake

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jim Gay
+
+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.rdoc

@@ -0,0 +1,40 @@
+= group_cache_key
+
+Using this gem in an application using ActiveRecord will provide you with a 'cache_key' 
+method on collections of models.
+
+The 'cache_key' will consist of:
+
+* the tableized name of the class of the first item
+* an MD5 hash of the ids in the collection
+* to_i on the max created_at date
+* to_i on the max updated_at date
+
+The 'cache_key' should look like:
+
+    'widgets/100-81dc9bdb52d04dc20036dbd8313ed055-1256853629-1256853637'
+    
+The resulting cache_key will be different if your group is sorted differently because 
+the MD5 hash is created according to the order given: no sorting is done to create the hash.
+    
+If your collection is empty, the cache_key will return a key with the object_id. A 
+cache_key for an empty collection will look like:
+
+    'empty/13149280'
+
+Built by Saturn Flyer http://www.saturnflyer.com
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Jim Gay. See LICENSE for details.

data/Rakefile

@@ -1,58 +1,11 @@
 require 'rubygems'
+require 'bundler/setup'
 require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "group_cache_key"
-    gem.summary = %Q{adds a cache_key method to ActiveRecord arrays}
-    gem.description = %Q{adds a cache_key method to ActiveRecord arrays}
-    gem.email = "jim@saturnflyer.com"
-    gem.homepage = "http://github.com/saturnflyer/group_cache_key"
-    gem.authors = ["Jim Gay"]
-    gem.add_dependency 'activerecord', '>=2.1.0'
-    gem.add_dependency 'activesupport', '>=2.1.0'
-    # gem.add_development_dependency "thoughtbot-shoulda"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
 require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
-
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
-end
-
-task :test => :check_dependencies
 
 task :default => :test
 
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "group_cache_key #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
 end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.4.1

data/group_cache_key.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name = "group_cache_key"
+  s.version = "0.4.1"
+  s.platform = Gem::Platform::RUBY
+  s.authors = ["Jim Gay", "Clemens Gruber", "Patrick Schmitz"]
+  s.email   = "jim@saturnflyer.com"
+  s.summary = "Adds cache_key to collections"
+  s.homepage = "http://github.com/saturnflyer/group_cache_key"
+
+  s.add_dependency "activerecord"
+  s.add_dependency "activesupport"
+
+  s.add_development_dependency "rake"
+  s.add_development_dependency "minitest"
+
+  s.files = Dir["#{File.dirname(__FILE__)}/**/*"]
+end

data/test/group_cache_key_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class Widget < ActiveRecord::Base
+  def self.columns
+    []
+  end
+  attr_accessor :now
+  def updated_at
+    @now ||= Time.now
+  end
+  def created_at
+    @now ||= Time.now
+  end
+  def id
+    object_id
+  end
+  def self.empty_find
+    []
+  end
+  def self.find
+    [self.new, self.new]
+  end
+end
+
+class GroupCacheKeyTest < MiniTest::Unit::TestCase
+  def test_empty_collection_should_return_unique_string_representation
+    @widgets = Widget.empty_find
+    assert_equal("empty/#{@widgets.object_id}", @widgets.cache_key)
+  end
+  def test_collection_should_return_unique_string_with_count_hash_and_timestamps
+    @widgets = Widget.find
+    hash = Digest::MD5.hexdigest(@widgets.collect{|w| w.id}.to_s)
+    created = @widgets.first.created_at.to_i.to_s
+    updated = @widgets.first.updated_at.to_i.to_s
+    assert_equal("widgets/#{@widgets.length}-#{hash}-#{created}-#{updated}", @widgets.cache_key)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'group_cache_key'
+
+require 'minitest/unit'
+MiniTest::Unit.autorun

metadata

@@ -1,26 +1,90 @@
 --- !ruby/object:Gem::Specification
 name: group_cache_key
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jim Gay
 - Clemens Gruber
+- Patrick Schmitz
 autorequire: 
 bindir: bin
 cert_chain: []
 date: 2013-03-25 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '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: minitest
+  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: 
-email: 
+email: jim@saturnflyer.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Rakefile
-- VERSION
-- lib/group_cache_key.rb
-homepage: 
+- ./Gemfile
+- ./Gemfile.lock
+- ./group_cache_key.gemspec
+- ./lib/group_cache_key.rb
+- ./LICENSE
+- ./Rakefile
+- ./README.rdoc
+- ./test/group_cache_key_test.rb
+- ./test/test_helper.rb
+- ./VERSION
+homepage: http://github.com/saturnflyer/group_cache_key
 licenses: []
 metadata: {}
 post_install_message: