compressed-cookie 0.0.2 → 0.1.0

data/README.md

@@ -10,8 +10,8 @@ This gem provides a wrapper around key-based cookie accessors.
 
     # define your cookie class
     class MyCookie < CompressedCookie
-      compressor_keys :foo => 0,
-                      :bar => 1
+      cookie_index :foo => 0,
+                   :bar => 1
     end
     
     # use it to write to a raw cookie object

data/lib/compressed_cookie.rb

@@ -1,95 +1,36 @@
 require File.join(File.dirname(__FILE__), "compressed_cookie", "version")
+require File.join(File.dirname(__FILE__), "compressed_cookie", "composition")
+require File.join(File.dirname(__FILE__), "compressed_cookie", "block_accessors")
+require File.join(File.dirname(__FILE__), "compressed_cookie", "bulk_accessors")
 
 class CompressedCookie
   class UndefinedCompressorKeyError < ArgumentError; end
+  extend CompressedCookie::Composition
+  extend CompressedCookie::BlockAccessors
+  include CompressedCookie::BulkAccessors
   
-  ### 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
+  # the index used for storing/retrieving values in a cookie
+  # @param [Hash] partial cookie index that will be merged in (optional)
+  # @return [Hash] cookie index
+  def self.cookie_index(hash = nil)
+    @cookie_index ||= {}
+    @cookie_index.merge!(hash) if hash
+    @cookie_index
   end
   
-  ### CONSTRUCTOR ###
-  # default
   # @param [ #[], #[]= ] cookie object (external) itself
+  # @param [ TrueClass, FalseClass ] true, when write access is required 
   def initialize(cookie, write_access = false)
     @cookie = self.class.initialize_cookie_part(cookie)
     self.extend readers
     self.extend 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
   
+  # @param [Symbol] attribute name
+  # @return [Fixnum] attribute index
   def self.key(name)
-    if compressor_keys.has_key? name
-      compressor_keys[name]
+    if cookie_index.has_key? name
+      cookie_index[name]
     else
       raise UndefinedCompressorKeyError.new "#{self.class} has no compressor key=#{name}"
     end
@@ -97,8 +38,10 @@ class CompressedCookie
   
 private
   
+  # creates a module that provides attribute readers
+  # @return [Module] readers 
   def readers
-    keys = self.class.compressor_keys
+    keys = self.class.cookie_index
     Module.new do
       keys.each_pair do |method_name, key|
         define_method method_name do
@@ -107,8 +50,11 @@ private
       end
     end
   end
+  
+  # creates a module that provides attribute writers
+  # @return [Module] writers
   def writers
-    keys = self.class.compressor_keys
+    keys = self.class.cookie_index
     Module.new do
       keys.each_pair do |method_name, key|
         define_method "#{method_name}=" do |value|

data/lib/compressed_cookie/block_accessors.rb

@@ -0,0 +1,33 @@
+class CompressedCookie
+  module BlockAccessors
+    # provides a CompressedCookie with read + write access
+    # @param [#[], #[]=] external cookie object
+    # @param [Proc] optional block (will receive the cookie accessor)
+    # @return [CompressedCookie, Object] when no block is 
+    def 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
+    
+    # provides a CompressedCookie with read access
+    # @param [#[]] external cookie object
+    # @param [Proc] optional block (will receive the cookie accessor)
+    # @return [CompressedCookie, Object] when no block is
+    def 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
+  end
+end

data/lib/compressed_cookie/bulk_accessors.rb

@@ -0,0 +1,22 @@
+class CompressedCookie
+  module BulkAccessors
+    # exports all values into a hash 
+    # @return [Hash] hash
+    def to_hash
+      self.class.cookie_index.inject({}) do |result, pair|
+        name, key = pair
+        result[name] = self.send(name)
+        result
+      end
+    end
+    
+    # updates all values via hash by using setter methods
+    # @param [Hash] hash
+    def update_attributes(hash)
+      hash.each do |key, value|
+        method_name = "#{key}="
+        self.send(method_name, value) if self.respond_to?(method_name)
+      end
+    end
+  end
+end

data/lib/compressed_cookie/composition.rb

@@ -0,0 +1,38 @@
+class CompressedCookie
+  module Composition
+    # @param [Class] parent cookie model
+    # @param [Symbol] key where the current child cookie model is mapped to
+    def parent_cookie(clazz, key)
+      @parent_cookie_class = clazz
+      @parent_cookie_key = key
+    end
+    
+    # @param [#[], #[]=] raw cookie
+    def 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
+    
+    # is it a child or a parent cookie model
+    # @return [TrueClass, FalseClass] true, when it's a parent
+    def parent?
+      if defined?(@parent_cookie_class) && defined?(@parent_cookie_key)
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/compressed_cookie/version.rb

@@ -1,3 +1,3 @@
 class CompressedCookie
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/compressed_cookie/block_accessors_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe CompressedCookie::BlockAccessors do
+  it 'should respond #write' do
+    mock = Object.new
+    mock.extend CompressedCookie::BlockAccessors
+    mock.should respond_to(:write)
+  end
+  
+  it 'should respond #read' do
+    mock = Object.new
+    mock.extend CompressedCookie::BlockAccessors
+    mock.should respond_to(:read)
+  end
+end

data/spec/compressed_cookie/bulk_accessor_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe CompressedCookie::BulkAccessors do
+  it 'should respond #to_hash' do
+    mock = Object.new
+    mock.extend CompressedCookie::BulkAccessors
+    mock.should respond_to(:to_hash)
+  end
+  
+  it 'should respond #update!' do
+    mock = Object.new
+    mock.extend CompressedCookie::BulkAccessors
+    mock.should respond_to(:update_attributes)
+  end
+end

data/spec/compressed_cookie/composition_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe CompressedCookie::Composition do
+  it 'should respond #part_of' do
+    mock = Object.new
+    mock.extend CompressedCookie::Composition
+    mock.should respond_to(:parent_cookie)
+  end
+
+  it 'should respond #initialize_cookie_part' do
+    mock = Object.new
+    mock.extend CompressedCookie::Composition
+    mock.should respond_to(:initialize_cookie_part)
+  end
+  
+  it 'should respond #parent?' do
+    mock = Object.new
+    mock.extend CompressedCookie::Composition
+    mock.should respond_to(:parent?)
+  end
+end

data/spec/compressed_cookie_spec.rb

@@ -3,19 +3,19 @@ require 'spec_helper'
 describe 'CompressedCookie' do
   
   describe 'class declaration api' do
-    it 'should respond to #compressor_keys' do
-      CompressedCookie.should respond_to(:compressor_keys)
+    it 'should respond to #cookie_index' do
+      CompressedCookie.should respond_to(:cookie_index)
     end
-    it 'should respond to #part_of' do
-      CompressedCookie.should respond_to(:part_of)
+    it 'should respond to #parent_cookie' do
+      CompressedCookie.should respond_to(:parent_cookie)
     end
   end
   
   describe 'simple cookie' do
     class SimpleCookieMock < CompressedCookie
-      compressor_keys :zero => 0,
-                      :one => 1,
-                      :two => 2
+      cookie_index :zero => 0,
+                   :one => 1,
+                   :two => 2
     end
     before :each do
       @cookie_mock = [
@@ -77,8 +77,8 @@ describe 'CompressedCookie' do
         @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')
+      it 'should write multiple values via #update_attributes' do
+        @mock.update_attributes(:zero => 'new-foo', :one => 'new-bar', :two => 'new-baz')
         @cookie_mock.should == ['new-foo', 'new-bar', 'new-baz']
       end
     end
@@ -103,13 +103,13 @@ describe 'CompressedCookie' do
   
   describe 'nested cookie' do
     class RootCookieMock < CompressedCookie
-      compressor_keys :zero => 0,
-                      :child => 1
+      cookie_index :zero => 0,
+                   :child => 1
     end
     class ChildCookieMock < CompressedCookie
-      part_of RootCookieMock, :child
-      compressor_keys :zero => 0,
-                      :one  => 1
+      parent_cookie RootCookieMock, :child
+      cookie_index :zero => 0,
+                   :one  => 1
     end
     before :each do
       @cookie_mock = [:foo, [:bar, :baz]]

metadata

@@ -1,47 +1,34 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: compressed-cookie
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Jens Bissinger
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-12 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70297349132760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *70297349132760
 description: Provides basically just a wrapper class around key-based cookie accessors
-email: 
+email:
 - mail@jens-bissinger.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - MIT-LICENSE
@@ -50,43 +37,43 @@ files:
 - compressed-cookie.gemspec
 - lib/compressed-cookie.rb
 - lib/compressed_cookie.rb
+- lib/compressed_cookie/block_accessors.rb
+- lib/compressed_cookie/bulk_accessors.rb
+- lib/compressed_cookie/composition.rb
 - lib/compressed_cookie/version.rb
+- spec/compressed_cookie/block_accessors_spec.rb
+- spec/compressed_cookie/bulk_accessor_spec.rb
+- spec/compressed_cookie/composition_spec.rb
 - spec/compressed_cookie_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
-homepage: ""
+homepage: ''
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: compressed-cookie
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Minimize your cookie footprint'
-test_files: 
+test_files:
+- spec/compressed_cookie/block_accessors_spec.rb
+- spec/compressed_cookie/bulk_accessor_spec.rb
+- spec/compressed_cookie/composition_spec.rb
 - spec/compressed_cookie_spec.rb
 - spec/spec_helper.rb
+has_rdoc: