compressed-cookie 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in compressed_cookie.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jens Bissinger
+
+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,39 @@
+# CompressedCookie
+
+This gem provides a wrapper around key-based cookie accessors.
+
+## Installation
+
+    gem install compressed_cookie
+
+## Examples
+
+    # define your cookie class
+    class MyCookie < CompressedCookie
+      compressor_keys :foo => 0,
+                      :bar => 1
+    end
+    
+    # use it to write to a raw cookie object
+    raw_cookie = []
+    MyCookie.write(raw_cookie) do |writer|
+      writer.foo = 'hello world'
+    end
+    puts raw_cookie
+    # => ['hello world', nil]
+    
+    # use it to read from a raw cookie object
+    MyCookie.read(raw_cookie) do |reader|
+      puts reader.foo
+      # => 'hello world'
+    end
+
+## Development
+
+    `bundle install`
+
+    `bundle exec rspec spec`
+
+# License
+
+Copyright 2011 Jens Bissinger. All rights reserved. [MIT-LICENSE](MIT-LICENSE)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/compressed-cookie.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "compressed_cookie/version"
+
+Gem::Specification.new do |s|
+  s.name        = "compressed-cookie"
+  s.version     = CompressedCookie::VERSION
+  s.authors     = ["Jens Bissinger"]
+  s.email       = ["mail@jens-bissinger.de"]
+  s.homepage    = ""
+  s.summary     = %q{Minimize your cookie footprint'}
+  s.description = %q{Provides basically just a wrapper class around key-based cookie accessors}
+
+  s.rubyforge_project = "compressed-cookie"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/lib/compressed-cookie.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'compressed_cookie')

data/lib/compressed_cookie/version.rb

@@ -0,0 +1,3 @@
+class CompressedCookie
+  VERSION = "0.0.1"
+end

data/lib/compressed_cookie.rb

@@ -0,0 +1,114 @@
+require File.join(File.dirname(__FILE__), "compressed_cookie", "version")
+
+class CompressedCookie
+  class UndefinedCompressorKeyError < ArgumentError; end
+  
+  ### IMPARATIVE DECLARATIONS ###
+  def self.compressor_keys(hash = nil)
+    @compressor_keys ||= {}
+    @compressor_keys.merge!(hash) if hash
+    @compressor_keys
+  end
+  def self.part_of(clazz, key)
+    @parent_cookie_class = clazz
+    @parent_cookie_key = key
+  end
+  
+  ### CONSTRUCTOR ###
+  # default
+  # @param [ #[], #[]= ] cookie object (external) itself
+  def initialize(cookie, write_access = false)
+    @cookie = self.class.initialize_cookie_part(cookie)
+    self.class.define_readers
+    self.class.define_writers if write_access
+  end
+  # WRITE
+  def self.write(cookie, &block)
+    writer = self.new(cookie, true)
+    # return the block's return value
+    if block_given?
+      yield writer
+    # return the writer itself
+    else
+      writer
+    end
+  end
+  # READ
+  def self.read(cookie, &block)
+    reader = self.new(cookie)
+    # return the block's return value
+    if block_given?
+      yield reader
+    # return the reader itself
+    else
+      reader
+    end
+  end
+  
+  ### BULK OPERATIONS ###
+  # READ
+  def to_hash
+    self.class.compressor_keys.inject({}) do |result, pair|
+      name, key = pair
+      result[name] = self.send(name)
+      result
+    end
+  end
+  # WRITE
+  def update!(hash)
+    hash.each do |key, value|
+      method_name = "#{key}="
+      self.send(method_name, value) if self.respond_to?(method_name)
+    end
+  end
+  
+  def self.initialize_cookie_part(_cookie)
+    cookie = _cookie
+    if parent?
+      cookie = @parent_cookie_class.write(cookie) do |writer|
+        # extract the cookie part from the parent
+        if existing_cookie_part = writer.send("#{@parent_cookie_key}")
+          existing_cookie_part
+        # if the cookie part is empty => then create it as an empty array
+        else
+          new_cookie_part = writer.send("#{@parent_cookie_key}=", Array.new)
+          new_cookie_part
+        end
+      end
+    end
+    cookie
+  end
+  
+  def self.parent?
+    if defined?(@parent_cookie_class) && defined?(@parent_cookie_key)
+      true
+    else
+      false
+    end
+  end
+  
+  def self.key(name)
+    if compressor_keys.has_key? name
+      compressor_keys[name]
+    else
+      raise UndefinedCompressorKeyError.new "#{self.class} has no compressor key=#{name}"
+    end
+  end
+  
+private
+  
+  def self.define_readers
+    compressor_keys.each do |method_name, key|
+      define_method("#{method_name}") do
+        @cookie[key]
+      end
+    end
+  end
+  def self.define_writers
+    compressor_keys.each do |method_name, key|
+      define_method("#{method_name}=") do |first_method_arg|
+        @cookie[key] = first_method_arg
+      end
+    end
+  end
+end

data/spec/compressed_cookie_spec.rb

@@ -0,0 +1,129 @@
+require 'spec_helper'
+
+describe 'CompressedCookie' do
+  
+  describe 'class declaration api' do
+    it 'should respond to #compressor_keys' do
+      CompressedCookie.should respond_to(:compressor_keys)
+    end
+    it 'should respond to #part_of' do
+      CompressedCookie.should respond_to(:part_of)
+    end
+  end
+  
+  describe 'simple cookie' do
+    class SimpleCookieMock < CompressedCookie
+      compressor_keys :zero => 0,
+                      :one => 1,
+                      :two => 2
+    end
+    before :each do
+      @cookie_mock = [
+        'foo', # zero
+        'bar'  # one
+               # two is nil
+      ]
+    end
+    
+    describe 'class methods' do
+      it 'should lookup keys' do
+        SimpleCookieMock.key(:zero).should == 0
+        SimpleCookieMock.key(:one).should == 1
+        SimpleCookieMock.key(:two).should == 2
+      end
+      it 'should raise UndefinedCompressorKeyError if lookup key is undefined' do
+        lambda do
+          SimpleCookieMock.key(:three)
+        end.should raise_error(CompressedCookie::UndefinedCompressorKeyError)
+      end
+    end
+    
+    describe 'read-only instance' do
+      before :each do
+        @mock = SimpleCookieMock.new(@cookie_mock)
+      end
+      it 'should respond only to read methods' do
+        @mock.should respond_to(:one)
+        @mock.should respond_to(:two)
+        @mock.should_not respond_to('one=')
+        @mock.should_not respond_to('two=')
+      end
+      it 'should read single cookies value' do
+        @mock.one.should == 'bar'
+        @mock.two.should == nil
+      end
+      it 'should read multiple values via #to_hash' do
+        @mock.to_hash.should == {:zero => 'foo', :one => 'bar', :two => nil}
+      end
+    end
+    
+    describe 'read/write instance' do
+      before :each do
+        @mock = SimpleCookieMock.new(@cookie_mock, true)
+      end
+      it 'should respond to read + write methods' do
+        @mock.should respond_to(:one)
+        @mock.should respond_to(:two)
+        @mock.should respond_to('one=')
+        @mock.should respond_to('two=')
+      end
+      it 'should write new cookies value' do
+        @mock.two = 'new-baz'
+        @mock.two.should == 'new-baz'
+        @cookie_mock.should == ['foo', 'bar', 'new-baz']
+      end
+      it 'should overwrite existing cookies value' do
+        @mock.one = 'new-bar'
+        @mock.one.should == 'new-bar'
+        @cookie_mock.should == ['foo', 'new-bar']
+      end
+      it 'should write multiple values via #update!' do
+        @mock.update!(:zero => 'new-foo', :one => 'new-bar', :two => 'new-baz')
+        @cookie_mock.should == ['new-foo', 'new-bar', 'new-baz']
+      end
+    end
+  end
+  
+  describe 'nested cookie' do
+    class RootCookieMock < CompressedCookie
+      compressor_keys :zero => 0,
+                      :child => 1
+    end
+    class ChildCookieMock < CompressedCookie
+      part_of RootCookieMock, :child
+      compressor_keys :zero => 0,
+                      :one  => 1
+    end
+    before :each do
+      @cookie_mock = [:foo, [:bar, :baz]]
+    end
+    describe "root" do
+      before :each do
+        @mock = RootCookieMock.new(@cookie_mock, true)
+      end
+      it 'should read the childs values at one' do
+        @mock.child.should == [:bar, :baz]
+      end
+      it 'should tell that it has NO parent' do
+        RootCookieMock.parent?.should == false
+      end
+    end
+    describe "child" do
+      before :each do
+        @mock = ChildCookieMock.new(@cookie_mock, true)
+      end
+      it 'should read its cookie values' do
+        @mock.zero.should == :bar
+        @mock.one.should == :baz
+      end
+      it 'should write its cookie values' do
+        @mock.zero = :written_foo
+        @mock.zero.should == :written_foo
+        @cookie_mock.should == [:foo, [:written_foo, :baz]]
+      end
+      it 'should tell that it has a parent' do
+        ChildCookieMock.parent?.should == true
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'compressed-cookie')

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: compressed-cookie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jens Bissinger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-10 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70226960847640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70226960847640
+description: Provides basically just a wrapper class around key-based cookie accessors
+email:
+- mail@jens-bissinger.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- compressed-cookie.gemspec
+- lib/compressed-cookie.rb
+- lib/compressed_cookie.rb
+- lib/compressed_cookie/version.rb
+- spec/compressed_cookie_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+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: compressed-cookie
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Minimize your cookie footprint'
+test_files:
+- spec/compressed_cookie_spec.rb
+- spec/spec_helper.rb
+has_rdoc: