omnivorous_etag 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2011-11-01
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/omnivorous_etag
+lib/omnivorous_etag.rb
+test/test_omnivorous_etag.rb

data/README.txt

@@ -0,0 +1,56 @@
+= omnivorous_etag
+
+http://github.com/julik/omnivorous_etag
+
+== DESCRIPTION:
+
+ETags are good, however normally they are generated based on strings. However, very often it is easier
+to pass in a complete model object as your ETag, or it's parametrized represenation (record id) together
+with the version. Or an array of objects (if you want to cache your object listing page and prevent it
+from spending time on template rendering).
+
+This module will take care of transforming any object into a stringified representation that is usable as an etag
+with minimum fuss.
+
+== SYNOPSIS:
+
+In the body of your Sinatra application or any other web application responder class that
+has to send ETags
+
+  include OmnivorousEtag
+
+If the superclass of your request handler has an etag method this method will be called with the stringified
+result of the omnivirous etag generation (so that for example the request can be 304-terminated).
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 me@julik.nl
+
+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,10 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'omnivorous_etag' do
+  developer('Julik Tarkhanov', 'me@julik.nl')
+end
+
+# vim: syntax=ruby

data/bin/omnivorous_etag

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+abort "you need to write me"

data/lib/omnivorous_etag.rb

@@ -0,0 +1,54 @@
+require "base64"
+require "zlib"
+
+module OmnivorousEtag
+  VERSION = '1.0.0'
+  
+  class EtagCannotBeNil < TypeError
+  end
+  
+  # The etag method that takes anything, with the following behavior quirks
+  def etag(anything)
+    raise EtagCannotBeNil, "Cannot generate ETags for nils" if anything.nil?
+    
+    data = if anything.respond_to?(:map)
+      anything.map{|e| etag(e) }.join(";")
+    elsif anything.respond_to?(:to_param) && OmnivorousEtag.is_versioned?(anything)
+      etag([anything.class.to_s, anything.to_param, OmnivorousEtag.extract_version(anything)])
+    elsif anything.is_a?(String) || anything.is_a?(Numeric) || anything.is_a?(Symbol)
+      anything.to_s
+    else
+      Marshal.dump(anything)
+    end
+    
+    if defined?(super)
+      super(OmnivorousEtag.package(data))
+    else
+      OmnivorousEtag.package(data)
+    end
+  end
+  
+  def self.package(blob)
+    Base64.encode64(blob)
+  end
+  
+  def self.extract_version(object)
+    if object.respond_to?(:new_record) && object.new_record?
+      "new"
+    # http://rubydoc.info/gems/acts_as_revisable
+    elsif object.respond_to?(:revision_number)
+      object.revision_number
+    # http://rubydoc.info/gems/vestal_versions
+    # http://rubydoc.info/gems/acts_as_versioned
+    elsif object.respond_to?(:version)
+      object.version
+    end
+    nil
+  end
+  
+  # Tells whether the passed AR record object is using a versioning plugin (in which case we
+  # can serve ourselves with the version tag it carries)
+  def self.is_versioned?(object)
+    extract_version(object) != nil
+  end
+end

data/test/test_omnivorous_etag.rb

@@ -0,0 +1,104 @@
+require "test/unit"
+require "omnivorous_etag"
+
+class TestOmnivorousEtag < Test::Unit::TestCase
+  class Bearer
+    def etag(string)
+      raise "Not a string" unless string.is_a?(String)
+      return string
+    end
+  end
+  
+  class RaisingBearer
+    def etag(something)
+      throw(:caught)
+    end
+  end
+  
+  class App < Bearer
+    include OmnivorousEtag
+  end
+  
+  class RaisingApp < RaisingBearer
+  end
+  
+  def test_with_string
+    app = App.new
+    assert_equal "Mw==\n", app.etag(3)
+  end
+  
+  def test_work_on_blank_object_should_just_return
+     o = Object.new
+     class << o; include OmnivorousEtag; end
+     assert_equal "Mw==\n", o.etag(3)
+  end
+  
+  def test_work_on_object_that_supports_super_should_callout_to_super
+     assert_throws(:caught) { RaisingApp.new.etag(3) }
+  end
+  
+  def test_work_on_blank_object_should_just_return
+     o = Object.new
+     class << o; include OmnivorousEtag; end
+     assert_equal "Mw==\n", o.etag(3)
+  end
+  
+  def test_with_float
+    app = App.new
+    assert_equal "My4zNQ==\n", app.etag(3.35)
+  end
+  
+  def test_with_int
+    assert_equal "MQ==\n", App.new.etag(1)
+  end
+  
+  def test_with_symbol
+    assert_equal "YQ==\n", App.new.etag(:a)
+  end
+  
+  def test_with_string
+    assert_equal "RXhwZXJpbWVudGFs\n", App.new.etag("Experimental")
+  end
+  
+  def test_with_array
+    assert_equal "TVE9PQo7TWc9PQo7TXc9PQo=\n", App.new.etag([1,2,3])
+  end
+  
+  def test_with_array
+    assert_equal "TVE9PQo7TWc9PQo7TXc9PQo=\n", App.new.etag([1,2,3])
+  end
+  
+  def test_with_version_activerecord_using_acts_as_versioned
+    r = Struct.new(:version, :to_param).new(1, "1-my-blog_entry")
+    r_newer = Struct.new(:version, :to_param).new(2, "1-my-blog_entry")
+    assert_equal "TVE9PQo7TVMxdGVTMWliRzluWDJWdWRISjUK\n", App.new.etag(r)
+    assert_equal "TWc9PQo7TVMxdGVTMWliRzluWDJWdWRISjUK\n", App.new.etag(r_newer)
+  end
+  
+  def test_raises_with_nil
+    assert_raise(OmnivorousEtag::EtagCannotBeNil) do
+      App.new.etag(nil)
+    end
+  end
+  
+  def test_with_version_activerecord_using_revisions
+    r = Struct.new(:revision_number, :to_param).new(1, "1-my-blog_entry")
+    r_newer = Struct.new(:revision_number, :to_param).new(2, "1-my-blog_entry")
+    assert_equal "TVE9PQo7TVMxdGVTMWliRzluWDJWdWRISjUK\n", App.new.etag(r)
+    assert_equal "TWc9PQo7TVMxdGVTMWliRzluWDJWdWRISjUK\n", App.new.etag(r_newer)
+  end
+  
+  
+  class Arbitrary < Struct.new(:a,:foo,:bar)
+  end
+  
+  class Another < Arbitrary
+  end
+  
+  def test_arbitraty_object_carries_class_name
+    a = Arbitrary.new("foo", "bar", "baz")
+    another = Another.new("foo", "bar", "baz")
+    assert_not_equal App.new.etag(a), App.new.etag(another),
+      "Objects of different classes should produce different etags"
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: omnivorous_etag
+version: !ruby/object:Gem::Version
+  version: !binary |-
+    MS4wLjA=
+  prerelease: 
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: &3947390 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: *3947390
+description: !binary |-
+  RVRhZ3MgYXJlIGdvb2QsIGhvd2V2ZXIgbm9ybWFsbHkgdGhleSBhcmUgZ2Vu
+  ZXJhdGVkIGJhc2VkIG9uIHN0cmluZ3MuIEhvd2V2ZXIsIHZlcnkgb2Z0ZW4g
+  aXQgaXMgZWFzaWVyCnRvIHBhc3MgaW4gYSBjb21wbGV0ZSBtb2RlbCBvYmpl
+  Y3QgYXMgeW91ciBFVGFnLCBvciBpdCdzIHBhcmFtZXRyaXplZCByZXByZXNl
+  bmF0aW9uIChyZWNvcmQgaWQpIHRvZ2V0aGVyCndpdGggdGhlIHZlcnNpb24u
+  IE9yIGFuIGFycmF5IG9mIG9iamVjdHMgKGlmIHlvdSB3YW50IHRvIGNhY2hl
+  IHlvdXIgb2JqZWN0IGxpc3RpbmcgcGFnZSBhbmQgcHJldmVudCBpdApmcm9t
+  IHNwZW5kaW5nIHRpbWUgb24gdGVtcGxhdGUgcmVuZGVyaW5nKS4KClRoaXMg
+  bW9kdWxlIHdpbGwgdGFrZSBjYXJlIG9mIHRyYW5zZm9ybWluZyBhbnkgb2Jq
+  ZWN0IGludG8gYSBzdHJpbmdpZmllZCByZXByZXNlbnRhdGlvbiB0aGF0IGlz
+  IHVzYWJsZSBhcyBhbiBldGFnCndpdGggbWluaW11bSBmdXNzLg==
+email:
+- me@julik.nl
+executables:
+- !binary |-
+  b21uaXZvcm91c19ldGFn
+extensions: []
+extra_rdoc_files:
+- !binary |-
+  SGlzdG9yeS50eHQ=
+- !binary |-
+  TWFuaWZlc3QudHh0
+- !binary |-
+  UkVBRE1FLnR4dA==
+files:
+- !binary |-
+  LmF1dG90ZXN0
+- !binary |-
+  SGlzdG9yeS50eHQ=
+- !binary |-
+  TWFuaWZlc3QudHh0
+- !binary |-
+  UkVBRE1FLnR4dA==
+- !binary |-
+  UmFrZWZpbGU=
+- !binary |-
+  YmluL29tbml2b3JvdXNfZXRhZw==
+- !binary |-
+  bGliL29tbml2b3JvdXNfZXRhZy5yYg==
+- !binary |-
+  dGVzdC90ZXN0X29tbml2b3JvdXNfZXRhZy5yYg==
+- .gemtest
+homepage: !binary |-
+  aHR0cDovL2dpdGh1Yi5jb20vanVsaWsvb21uaXZvcm91c19ldGFn
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: omnivorous_etag
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: !binary |-
+  RVRhZ3MgYXJlIGdvb2QsIGhvd2V2ZXIgbm9ybWFsbHkgdGhleSBhcmUgZ2Vu
+  ZXJhdGVkIGJhc2VkIG9uIHN0cmluZ3M=
+test_files:
+- test/test_omnivorous_etag.rb