extraloop-redis-storage 0.0.10 → 0.0.11

data/History.txt

@@ -1,3 +1,6 @@
+== 0.0.11 / 2012-03-08
+  * Improved Ohm::Storage::IdKey module
+
 == 0.0.10 / 2012-03-06
   * Implemented non-numeric record ids for ExtraLoop::Storage::Record
 

data/lib/extraloop/redis-storage.rb

@@ -33,7 +33,7 @@ require "support"
 
 module ExtraLoop
   module Storage
-    VERSION ||= "0.0.10"
+    VERSION ||= "0.0.11"
 
     def self.connect(*args)
       Ohm.connect(*args)

data/lib/extraloop/redis-storage/id_key.rb

@@ -4,12 +4,48 @@
 # keys
 #
 module ExtraLoop::Storage::IdKey
-  # Public: A regex to be used in order to valid the key string format
+
+  # Internal: A regex to be used in order to valid the key string format
   ID_FORMAT = /^[a-zA-Z\-\_]+$/ 
+  # Internal: The separator to be used when record id keys.
+  KEY_SEPARATOR = ':'
 
+  # Public: Turns 'Ohm::Model::[]' into a powerful method which behaves somehow like Rails' "find_or_create"/"find_or_update".
+  #
+  # If the record does not exist, it will be created (or just initialised) with the provided attribute values. If the record does exist already, and
+  # no attributes are provided, the record will be fetched and returned. If the record exists and the attribute hash is provided, this method will try 
+  # to update it with the provided attribute values.
+  #
+  # TODO: consider privatising/removing the #save and the #create method for models extended with this module.
+  #
+  #
+  # id - An alphanumeric id string, which will be used generate the key string to store the record into Redis.
+  # attributes - An hash of record attributes.
+  # 
+  # 
+  # Examples
+  #
+  # user = User['bob', {:full_name => 'Robert Plancton', :website => 'http://planktonic.net'}]
+  # user.id 
+  # 
+  # => 'User:bob'
+  #
+  # User['bob'] == user
+  #
+  # => true
+  #
+  # user = User['bob', {:website => 'http://planctoinic.net' }]
+  # user.website
+  #
+  # => 'http://planctoinic.net'
+  #
+  # 
+  # Returns a Ohm record.
+  # Raises an 'ArgumentError' if the provided id string does not match the ID_FORMAT (e.g. if it contains non-alphanumeric characters').
+  #
   def [](id, attributes={})
     raise ArgumentError.new "Invalid id '#{id}'" unless id =~ ID_FORMAT
-    id = prefix(id.to_s)
+    id = prefix(id.to_s, attributes)
 
     if record = super(id)
       record.update(attributes) if attributes.any?
@@ -19,8 +55,40 @@ module ExtraLoop::Storage::IdKey
     end
   end
 
-  def prefix(id)
-    [self.name, id].join(':')
+  # Public: Prefixes the provided record id with a namespace.
+  #
+  # While default behviour is to prepend the record's model class name to id string, it is possible to override this method
+  # so that the generated record id key will include other attributes (see example below).
+  #
+  # id - The record id.
+  # attributes - The attributes hash
+  #
+  # Examples
+  # 
+  # # Overrides the default prefix method so that the 'locale' attribute will be included as part of the 
+  # # record id prefix.
+  #
+  # include ExtraLoop::Storage
+  #
+  # class Entry < Record
+  #   extend IdKey
+  #   attribute :locale
+  #
+  #   def self::prefix(id, attrs={})
+  #     [self.name, attrs.fetch(:locale, 'en'), id]).join(IdKey::KEY_SEPARATOR)
+  #   end
+  # end
+  #
+  # entry = Entry['Hello-world']
+  # entry.id
+  #
+  # => 'Entry:en:Hello-world'
+  #
+  # Returns the record id key.
+  #
+
+  def prefix(id, attributes={})
+    [self.name, id].join(KEY_SEPARATOR)
   end
 
 end

data/lib/extraloop/redis-storage/model.rb

@@ -4,15 +4,19 @@
 class ExtraLoop::Storage::Model < Ohm::Model
   extend ExtraLoop::Storage::IdKey
 
-
   # Internal: Overrides the default id key handling function and 
-  # replaces it with a validity check
+  # replaces it with a validity check.
+  #
+  # id - The record id.
+  # attributes - The record attributes (defaults to an empty array)
+  #
+  #
   #
   # Returns the model name
   # Raises an ArgumentError if the id string is not capitalized
   #
 
-  def self.prefix(id)
+  def self.prefix(id, attributes={})
     raise ArgumentError.new "model Id should be capitalized" unless id.to_s[0] =~ /[A-Z]/
     id
   end

data/spec/id_key_spec.rb

@@ -75,4 +75,23 @@ describe Entry do
       end
     end
   end
+
+  describe "::create" do
+
+  end
+
+  describe "#save" do
+    context "with an entry initialized through the '[]' method" do
+      before do
+        @entry = Entry['hello-test', {session: session}]
+        @entry.foo = 'test'
+        @entry.save
+      end
+
+      it "should retain the initial id when calling save" do
+        @entry.id.should eql('Entry:hello-test')
+        Entry['hello-test'].foo.should eql('test')
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: extraloop-redis-storage
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-06 00:00:00.000000000Z
+date: 2012-04-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: extraloop
-  requirement: &27209960 !ruby/object:Gem::Requirement
+  requirement: &17492340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *27209960
+  version_requirements: *17492340
 - !ruby/object:Gem::Dependency
   name: ohm
-  requirement: &27188400 !ruby/object:Gem::Requirement
+  requirement: &17491180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *27188400
+  version_requirements: *17491180
 - !ruby/object:Gem::Dependency
   name: ohm-contrib
-  requirement: &27187720 !ruby/object:Gem::Requirement
+  requirement: &17490000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *27187720
+  version_requirements: *17490000
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &27187120 !ruby/object:Gem::Requirement
+  requirement: &17489000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,10 +54,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *27187120
+  version_requirements: *17489000
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &27186360 !ruby/object:Gem::Requirement
+  requirement: &17366960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *27186360
+  version_requirements: *17366960
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &27185080 !ruby/object:Gem::Requirement
+  requirement: &17365700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *27185080
+  version_requirements: *17365700
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &27184480 !ruby/object:Gem::Requirement
+  requirement: &17365120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *27184480
+  version_requirements: *17365120
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &27183780 !ruby/object:Gem::Requirement
+  requirement: &17363920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 1.0.4
   type: :development
   prerelease: false
-  version_requirements: *27183780
+  version_requirements: *17363920
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &27183060 !ruby/object:Gem::Requirement
+  requirement: &17362540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 0.9.7.4
   type: :development
   prerelease: false
-  version_requirements: *27183060
+  version_requirements: *17362540
 - !ruby/object:Gem::Dependency
   name: fusion_tables
-  requirement: &27182200 !ruby/object:Gem::Requirement
+  requirement: &17361520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 0.3.1
   type: :development
   prerelease: false
-  version_requirements: *27182200
+  version_requirements: *17361520
 - !ruby/object:Gem::Dependency
   name: geocoder
-  requirement: &27181360 !ruby/object:Gem::Requirement
+  requirement: &17360980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,7 +131,7 @@ dependencies:
         version: 1.1.1
   type: :development
   prerelease: false
-  version_requirements: *27181360
+  version_requirements: *17360980
 description: Redis-based Persistence layer for the ExtraLoop data extraction toolkit.
   Includes a convinent command line tool allowing to list, filter, delete, and export
   harvested datasets
@@ -182,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -650301633234086878
+      hash: -2994180190336763644
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -191,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: extraloop-redis-storage
-rubygems_version: 1.8.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 2
 summary: Redis storage for Extraloop.