riak-shim 0.0.9 → 0.0.10

data/Gemfile

@@ -2,5 +2,7 @@ source 'https://rubygems.org'
 gemspec
 
 platforms :jruby do
-  gem "jruby-openssl"
+  gem 'jruby-openssl'
+  gem 'json-jruby'
 end
+

data/README.md

@@ -35,10 +35,10 @@ Create a config/database.yml containing the details of your Riak setup like so:
       <<: *default
       bucket_prefix: myapp_test_
 
-`bucket_prefix will be prefixed to each bucket name, allowing you to point
-`multiple applications (or multiple copies of the same application) at a
-`single Riak install. During development, this prevents you from stepping on
-`your own toes.
+`bucket_prefix` will be prefixed to each bucket name, allowing you to point
+multiple applications (or multiple copies of the same application) at a
+single Riak install. During development, this prevents you from stepping on
+your own toes.
 
 ## Converting a model to use Riak
 
@@ -52,22 +52,25 @@ Then, write a #to_hash method which returns a hash representing your object
 
     def to_hash
       # Return hashified version of your class
+      { 'foo' => self.foo, 'bar' => self.bar }
     end
 
 You'll use Class#from_hash to create an instance from the hash which was
 pulled from Riak:
 
     def self.from_hash(data)
+      # Return a fresh instance of your class populated by the hash provided
       your_obj = new
       your_obj.foo = data['foo']
-      # Return a fresh instance of your class populated by the hash provided
+      your_obj.bar = data['bar']
       return your_obj
     end
 
-You can now save instances of your class by calling #save and later retrieve
-them from Riak by calling...
+You can now save instances of your class by calling `#save` and later retrieve
+them from Riak by calling `.for_key`:
 
-    YourClass.for_key(key)
+    an_instance.save
+    retrieved_copy = YourClass.for_key(key)
 
 ### Secondary indexes
 
@@ -79,6 +82,7 @@ riak-shim will populate a secondary index for that field.
 
     def fields_to_index
       # Return an Array of hash keys you would like placed into a secondary index.
+      [foo]
     end
 
 The `for_index` method retrieves all records whose value for the given index
@@ -105,6 +109,6 @@ Return value is an Array of instances of your class matching the query.
 ## TODOS
 
 - Examples directory
-- Revisit tests
+- Keep expanding tests
 - find less horrible way to deal with index names
 

data/lib/riak-shim/persistable.rb

@@ -1,7 +1,6 @@
 module Riak
   module Shim
     module Persistable
-      attr_writer :store
       attr_writer :key
 
       def key
@@ -75,7 +74,9 @@ module Riak
           begin
             raw = bucket.get(key)
             data = raw.data
-            from_hash(data)
+            result = from_hash(data)
+            result.key = key
+            result
           rescue Riak::HTTPFailedRequest
             return nil
           end

data/lib/riak-shim/store.rb

@@ -7,9 +7,14 @@ module Riak
       attr_writer :config_location
       attr_writer :riak
 
+      class NoSettingsForCurrentEnvError < StandardError; end
+      class RackEnvNotSetError < StandardError; end
+
       def config
-        env = ENV['RACK_ENV'] || 'test'
+        env = ENV['RACK_ENV'] or raise RackEnvNotSetError.new
         @config ||= read_config[env]
+        @config or raise NoSettingsForCurrentEnvError.new(
+            "RACK_ENV #{ENV['RACK_ENV']} not specified in #{config_location}.")
       end
 
       def read_config

data/lib/riak-shim/version.rb

@@ -1,5 +1,5 @@
 module Riak
   module Shim
-    VERSION = "0.0.9"
+    VERSION = "0.0.10"
   end
 end

data/riak-shim.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'riak-client', '~>1.0.4'
   gem.add_dependency 'excon'
-  gem.add_dependency 'uuidtools', '~>2.1.2'
+  gem.add_dependency 'uuidtools', '~>2.1.3'
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"

data/spec/persistable_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'riak-shim/persistable'
+require 'support/camelcase'
 
 class PersistableExample
   include Riak::Shim::Persistable
@@ -16,12 +17,27 @@ class PersistableExample
     result.baz = data['baz']
     result
   end
+
+  def ==(other)
+    other.instance_of?(self.class) and
+        self.key == other.key and
+        self.foo == other.foo and
+        self.bar == other.bar and
+        self.baz == other.baz
+  end
+end
+
+class PersistableExampleWithIndex < PersistableExample
+  def fields_to_index
+    [:bar, :baz]
+  end
 end
 
 describe 'persistable' do
   let(:persistable) do
     p = PersistableExample.new ; p.foo = 'boo' ; p.bar = 'who' ; p
   end
+  let(:bucket) { PersistableExample.bucket }
 
   before do
     Riak::Shim::Store.any_instance.stub(:read_config).and_return(DB_CONFIG)
@@ -39,7 +55,7 @@ describe 'persistable' do
 
   describe '#bucket' do
     it 'returns the correct bucket' do
-      persistable.bucket.name.should == 'test_persistable_example'
+      bucket.name.should == 'test_persistable_example'
     end
   end
 
@@ -53,13 +69,13 @@ describe 'persistable' do
     it 'increases key count' do
       expect do
         persistable.save
-      end.to change{ persistable.bucket.keys.count }.by(1)
+      end.to change{ bucket.keys.count }.by(1)
     end
 
     it 'can then be retrieved' do
       persistable.save
       retrieved = PersistableExample.for_key(persistable.key)
-      retrieved.should_not be_nil
+      retrieved.should eq persistable
     end
   end
 
@@ -70,7 +86,7 @@ describe 'persistable' do
     end
 
     it 'removes the key' do
-      persistable.bucket.exists?(persistable.key).should be_false
+      bucket.exists?(persistable.key).should be_false
     end
   end
 
@@ -92,12 +108,6 @@ describe 'persistable' do
     end
 
     context 'with a model which needs indexes' do
-      class PersistableExampleWithIndex < PersistableExample
-        def fields_to_index
-          [:bar, :baz]
-        end
-      end
-
       let(:indexable) { PersistableExampleWithIndex.new }
       before do
         indexable.foo = 1
@@ -113,21 +123,91 @@ describe 'persistable' do
   end
 
   describe '#delete_all' do
+    before do
+      10.times do |i|
+        p = PersistableExample.new
+        p.foo, p.bar, p.baz = i, i, i
+        p.save
+      end
+      @keys = bucket.keys
+      PersistableExample.delete_all
+    end
+
+    it 'has no instances in the DB' do
+      @keys.map { |k| bucket.exists?(k).should be_false }
+    end
   end
 
   describe '#de_camel' do
+    it 'handles a bacic camel-case name' do
+      DeCamel.each do |camelcase, lowered|
+        PersistableExample.de_camel(camelcase).should eq(lowered)
+      end
+    end
+
+    it 'handles runs of capitals appropriately' do
+      DeCamelCapsRuns.each do |camelcase, lowered|
+        PersistableExample.de_camel(camelcase).should eq(lowered)
+      end
+    end
+
+    it 'turns module separators into slashes' do
+      DeCamelWithModule.each do |camelcase, lowered|
+        PersistableExample.de_camel(camelcase).should eq(lowered)
+      end
+    end
+
+    it 'does not produce collisions' do
+      PersistableExample.de_camel('RiakShim').should_not
+          eq PersistableExample.de_camel('Riak::Shim')
+    end
   end
 
   describe '#for_key' do
-    it 'fetches items for keys which exist'
-    it 'returns null when the key does not exist'
+    it 'fetches items for keys which exist' do
+      persistable.save
+      PersistableExample.for_key(persistable.key).should eq persistable
+    end
+
+    it 'returns null when the key does not exist' do
+      PersistableExample.for_key('no such key').should be_nil
+    end
   end
 
   describe '#for_index' do
+    before do
+      @indexed = []
+      3.times do |i|
+        indexable = PersistableExampleWithIndex.new
+        indexable.foo = i
+        indexable.bar = 'wombat'
+        indexable.save
+        @indexed << indexable
+      end
+    end
+
+    after do
+      PersistableExampleWithIndex.delete_all
+    end
+
+    it 'returns all items which match indexed value' do
+      PersistableExampleWithIndex.for_index('bar_bin', 'wombat').should =~ @indexed
+    end
+
+    it 'returns an empty list when no matches are found' do
+      PersistableExampleWithIndex.for_index('bar_bin', 'chew').should be_empty
+    end
   end
 
   describe '#gen_key' do
-    it 'produces no duplicates when called a bunch of times'
+    before do
+      @keys = []
+      20.times { @keys << PersistableExample.gen_key }
+    end
+
+    it 'produces no duplicates when called a bunch of times' do
+      @keys.uniq!.should be_nil
+    end
   end
 end
 

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ $: << './lib'
 require 'riak-shim'
 require 'pry'
 
+ENV['RACK_ENV'] = 'test' unless ENV['RACK_ENV']
 DB_CONFIG = { 'development' => { 'bucket_prefix' => 'dev_', 'host' => "localhost", 'http_port' => 8098},
     'test' => {'bucket_prefix' => 'test_', 'host' => "localhost", 'http_port' => 8098 }}
 

data/spec/store_spec.rb

@@ -25,6 +25,36 @@ describe Riak::Shim::Store do
       end
     end
 
+    describe 'error handling' do
+      before do
+        @stashed_rack_env = ENV['RACK_ENV']
+      end
+
+      after do
+        ENV['RACK_ENV'] = @stashed_rack_env
+      end
+
+      context 'with current RACK_ENV not explicitly configured in database.yml' do
+        before do
+          ENV['RACK_ENV'] = 'production'
+        end
+
+        it "raises an error" do
+          expect { store.config }.to raise_error(Riak::Shim::Store::NoSettingsForCurrentEnvError)
+        end
+      end
+
+      context 'with no RACK_ENV set' do
+        before do
+          ENV['RACK_ENV'] = nil
+        end
+
+        it "raises an error" do
+          expect { store.config }.to raise_error(Riak::Shim::Store::RackEnvNotSetError)
+        end
+      end
+    end
+
     describe '#config' do
       context 'with RACK_ENV=test' do
         before do

data/spec/support/camelcase.rb

@@ -0,0 +1,21 @@
+
+DeCamel = {
+  "Cheezburger"               => "cheezburger",
+  "SpecialGuest"          => "special_guest",
+  "Area51Controller"      => "area51_controller"
+}
+
+DeCamelCapsRuns = {
+  "LOLCat"              => "lol_cat",
+  "LOLCatBukkit"         => "lol_cat_bukkit",
+  "MayberryRFD"             => "mayberry_rfd",
+  "CNN"                => "cnn",
+}
+
+DeCamelWithModule = {
+  "Riak::Shim" => "riak__shim",
+  "Taco::Bell::Dog" => "taco__bell__dog",
+  "PizzaHut::PersonalPanPizza" => "pizza_hut__personal_pan_pizza",
+}
+
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riak-shim
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-26 00:00:00.000000000 Z
+date: 2012-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak-client
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 2.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.1.2
+        version: 2.1.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -193,6 +193,7 @@ files:
 - spec/persistable_spec.rb
 - spec/spec_helper.rb
 - spec/store_spec.rb
+- spec/support/camelcase.rb
 - spec/support/database.yml
 homepage: https://github.com/mkb/riak-shim
 licenses: []
@@ -223,4 +224,5 @@ test_files:
 - spec/persistable_spec.rb
 - spec/spec_helper.rb
 - spec/store_spec.rb
+- spec/support/camelcase.rb
 - spec/support/database.yml