extraloop-redis-storage 0.0.9 → 0.0.10

data/History.txt

@@ -1,3 +1,6 @@
+== 0.0.10 / 2012-03-06
+  * Implemented non-numeric record ids for ExtraLoop::Storage::Record
+
 == 0.0.9  / 2012-03-04
   * Removed Object#try method
 

data/lib/extraloop/redis-storage.rb

@@ -33,7 +33,7 @@ require "support"
 
 module ExtraLoop
   module Storage
-    VERSION ||= "0.0.9"
+    VERSION ||= "0.0.10"
 
     def self.connect(*args)
       Ohm.connect(*args)
@@ -54,6 +54,7 @@ base_path << "/redis-storage"
 ExtraLoop::Storage.autoload :Record, "#{base_path}/record.rb"
 ExtraLoop::Storage.autoload :ScrapingSession, "#{base_path}/scraping_session.rb"
 ExtraLoop::Storage.autoload :Model,  "#{base_path}/model.rb"
+ExtraLoop::Storage.autoload :IdKey,  "#{base_path}/id_key.rb"
 ExtraLoop::Storage.autoload :DatasetFactory,  "#{base_path}/dataset_factory.rb"
 ExtraLoop::Storage.autoload :RemoteStore, "#{base_path}/remote_store.rb"
 ExtraLoop::Storage.autoload :FusionTables, "#{base_path}/remote_store/fusion_tables.rb"

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

@@ -0,0 +1,26 @@
+# Public: Provides a convinient mechanism to override 
+# Ohm's default id assignment mechanism and replace
+# numeric, auto-increment ids with more readable, unique
+# keys
+#
+module ExtraLoop::Storage::IdKey
+  # Public: A regex to be used in order to valid the key string format
+  ID_FORMAT = /^[a-zA-Z\-\_]+$/ 
+
+  def [](id, attributes={})
+    raise ArgumentError.new "Invalid id '#{id}'" unless id =~ ID_FORMAT
+    id = prefix(id.to_s)
+
+    if record = super(id)
+      record.update(attributes) if attributes.any?
+      record
+    else 
+      create(attributes.merge(:id => id))
+    end
+  end
+
+  def prefix(id)
+    [self.name, id].join(':')
+  end
+
+end

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

@@ -2,10 +2,19 @@
 # are associated to a Scraping session object.
 #
 class ExtraLoop::Storage::Model < Ohm::Model
+  extend ExtraLoop::Storage::IdKey
 
-  def self.[](id)
+
+  # Internal: Overrides the default id key handling function and 
+  # replaces it with a validity check
+  #
+  # Returns the model name
+  # Raises an ArgumentError if the id string is not capitalized
+  #
+
+  def self.prefix(id)
     raise ArgumentError.new "model Id should be capitalized" unless id.to_s[0] =~ /[A-Z]/
-    super(id) || create(:id => id)
+    id
   end
 
   def to_hash

data/spec/id_key_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+include ExtraLoop::Storage
+
+class Entry < Record
+  extend IdKey
+  attribute :name
+  attribute :foo
+  index :foo
+end
+
+def session
+  ScrapingSession.create(
+    :title => 'test',
+    :model => Model[:Entry],
+  )
+end
+
+describe Entry do
+  describe "::[]()" do
+
+    context "with invalid key" do
+      it "should raise an error when the id key contains spaces" do
+        lambda { Entry['hello world'] }.should raise_error(ArgumentError)
+      end
+    end
+
+    context "with a symbol as key" do
+      before { @entry = Entry['foo', {:session => session, :foo => 'foo' } ] }
+
+      it "should cast the id as a string" do
+        @entry.id.should eql('Entry:foo')
+      end
+    end
+
+    context "without arguments" do
+      before do
+        @entry = Entry['foo']
+      end
+
+      it "should initialize a record with id 'entry:foo'" do
+        @entry.id.should eql('Entry:foo')
+      end
+
+      it "should initialize the same record" do
+        Entry['foo'].should eql(@entry)
+      end
+    end
+
+    context "with an attribute hash as its second argument" do
+      before do
+        @entry = Entry['foo', {:session => session, :foo => 'foo' }]
+      end
+
+      it "should persist the record" do
+        @entry.valid?.should be_true
+      end
+
+      it "should assign a value to the 'foo' attribute " do
+        @entry.foo.should eql('foo')
+      end
+
+      it "should not create duplicates" do
+        10.times do
+          Entry['foo', {:session => session, :foo => 'foo' } ]
+        end
+
+        Entry.find(:foo => 'foo').should include(@entry)
+        Entry.find(:foo => 'foo').should have(1).item
+      end
+
+      it "should update the record with the hash content" do
+        Entry['foo', {'foo' => 'bar'}]
+        Entry['foo'].foo.should eql('bar')
+        Entry.all.map(&:id).grep(/foo$/).should have(1).item
+      end
+    end
+  end
+end

data/spec/model_spec.rb

@@ -6,16 +6,16 @@ describe ExtraLoop::Storage::Model do
       @model = ExtraLoop::Storage::Model[:My_model]
     end
 
-    it "should create a record if a model with id 'my_model' does not exist" do
-      @model.should eql(ExtraLoop::Storage::Model[:My_model])
+    it "should create a record with 'My_model' as an id" do
+      @model.id.should eql('My_model')
     end
 
     it "should throw an argument error if the model id is not capitalized" do
       lambda { ExtraLoop::Storage::Model[:my_model] }.should raise_error(ArgumentError)
     end
 
-    after do
-      Ohm.flush
+    it "should throw an argument error if the model id contains spaces" do
+      lambda { ExtraLoop::Storage::Model['Bla bla'] }.should raise_error(ArgumentError)
     end
   end
 end

data/spec/spec_helper.rb

@@ -6,6 +6,11 @@ require "redis-storage"
 
 RSpec.configure do |config|
   config.mock_with :rr
+
+  # flush db content after each test run
+  config.after(:all) do
+    Ohm.flush
+  end
 end
 
 ENV['REDIS_URL']= "redis://127.0.0.1:6379/7"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: extraloop-redis-storage
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-03 00:00:00.000000000 Z
+date: 2012-04-06 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: extraloop
-  requirement: &6431000 !ruby/object:Gem::Requirement
+  requirement: &27209960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *6431000
+  version_requirements: *27209960
 - !ruby/object:Gem::Dependency
   name: ohm
-  requirement: &6429820 !ruby/object:Gem::Requirement
+  requirement: &27188400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *6429820
+  version_requirements: *27188400
 - !ruby/object:Gem::Dependency
   name: ohm-contrib
-  requirement: &6429120 !ruby/object:Gem::Requirement
+  requirement: &27187720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.1.2
   type: :runtime
   prerelease: false
-  version_requirements: *6429120
+  version_requirements: *27187720
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &6428420 !ruby/object:Gem::Requirement
+  requirement: &27187120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -54,10 +54,10 @@ dependencies:
         version: 0.14.6
   type: :runtime
   prerelease: false
-  version_requirements: *6428420
+  version_requirements: *27187120
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &6427680 !ruby/object:Gem::Requirement
+  requirement: &27186360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *6427680
+  version_requirements: *27186360
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &6426480 !ruby/object:Gem::Requirement
+  requirement: &27185080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *6426480
+  version_requirements: *27185080
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &6425200 !ruby/object:Gem::Requirement
+  requirement: &27184480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,10 +87,10 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *6425200
+  version_requirements: *27184480
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &6423760 !ruby/object:Gem::Requirement
+  requirement: &27183780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -98,10 +98,10 @@ dependencies:
         version: 1.0.4
   type: :development
   prerelease: false
-  version_requirements: *6423760
+  version_requirements: *27183780
 - !ruby/object:Gem::Dependency
   name: pry
-  requirement: &6442240 !ruby/object:Gem::Requirement
+  requirement: &27183060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 0.9.7.4
   type: :development
   prerelease: false
-  version_requirements: *6442240
+  version_requirements: *27183060
 - !ruby/object:Gem::Dependency
   name: fusion_tables
-  requirement: &6441640 !ruby/object:Gem::Requirement
+  requirement: &27182200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 0.3.1
   type: :development
   prerelease: false
-  version_requirements: *6441640
+  version_requirements: *27182200
 - !ruby/object:Gem::Dependency
   name: geocoder
-  requirement: &6441140 !ruby/object:Gem::Requirement
+  requirement: &27181360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,7 +131,7 @@ dependencies:
         version: 1.1.1
   type: :development
   prerelease: false
-  version_requirements: *6441140
+  version_requirements: *27181360
 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
@@ -149,6 +149,7 @@ files:
 - examples/lib/scrapers/amazon_review_scraper.rb
 - lib/extraloop/redis-storage.rb
 - lib/extraloop/redis-storage/dataset_factory.rb
+- lib/extraloop/redis-storage/id_key.rb
 - lib/extraloop/redis-storage/model.rb
 - lib/extraloop/redis-storage/record.rb
 - lib/extraloop/redis-storage/remote_store.rb
@@ -158,14 +159,14 @@ files:
 - lib/extraloop/support.rb
 - spec/dataset_factory_spec.rb
 - spec/fusion_tables_spec.rb
+- spec/id_key_spec.rb
 - spec/model_spec.rb
 - spec/record_spec.rb
 - spec/remote_store_spec.rb
 - spec/scraper_base_spec.rb
 - spec/scraping_session_spec.rb
 - spec/spec_helper.rb
-- !binary |-
-  YmluL2V4dHJhbG9vcA==
+- bin/extraloop
 homepage: http://github.com/afiore/extraloop-redis-storage
 licenses: []
 post_install_message: 
@@ -181,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 125904011551415212
+      hash: -650301633234086878
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -190,7 +191,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: extraloop-redis-storage
-rubygems_version: 1.8.17
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 2
 summary: Redis storage for Extraloop.