riak-shim 0.0.5 → 0.0.9

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 .rspec
+.rvmrc
 Gemfile.lock
 coverage
 pkg

data/.travis.yml

@@ -7,4 +7,6 @@ rvm:
   - jruby-19mode # JRuby in 1.9 mode
   - rbx-18mode
   - rbx-19mode
-script: bundle exec rspec spec
+script: bundle exec rake travis
+
+

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in riak-shim.gemspec
 gemspec
+
+platforms :jruby do
+  gem "jruby-openssl"
+end

data/README.md

@@ -1,4 +1,4 @@
-# Riak::Shim
+# Riak Shim
 
 A teeny shim between your code and the riak-client gem.  Reads database configuration
 out of config/database.yml and derives bucket names from your class names and an
@@ -6,8 +6,7 @@ appropriate prefix.
 
 Riak is a database from the good people at Basho.  Check it out:  http://basho.com/products/riak-overview/
 
-[![Build Status](https://secure.travis-ci.org/mkb/riak-shim.png?branch=master)](http://travis-ci.org/mkb/riak-shim)
-
+[![Build Status](https://secure.travis-ci.org/mkb/riak-shim.png?branch=master)](http://travis-ci.org/mkb/riak-shim) [![Dependency Status](https://gemnasium.com/mkb/riak-shim.png)](https://gemnasium.com/mkb/riak-shim) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/mkb/riak-shim)
 
 ## Installation
 
@@ -25,16 +24,21 @@ Or install it yourself as:
 
 ## Usage
 
-Create a config/database.yml containing the details of your Riak like so:
+Create a config/database.yml containing the details of your Riak setup like so:
 
     development: &default
-      bucket_prefix: dev_
+      bucket_prefix: myapp_dev_
       host: localhost
       http_port: 8098
 
     test:
       <<: *default
-      bucket_prefix: test_
+      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.
 
 ## Converting a model to use Riak
 
@@ -43,14 +47,15 @@ In any class you wish to persist, you must include the module:
     require 'riak-shim'
     include Riak::Shim::Persistable
 
-Then, write a #to_hash method which returns a hash representing your object (and consequently, what you are
-going to store):
+Then, write a #to_hash method which returns a hash representing your object
+(and consequently, what you are going to store):
 
     def to_hash
       # Return hashified version of your class
     end
 
-You'll use Class#from_hash to create an instance from the hash which was pulled from Riak:
+You'll use Class#from_hash to create an instance from the hash which was
+pulled from Riak:
 
     def self.from_hash(data)
       your_obj = new
@@ -59,28 +64,30 @@ You'll use Class#from_hash to create an instance from the hash which was pulled
       return your_obj
     end
 
-You can now save instances of yoru 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...
 
     YourClass.for_key(key)
 
 ### Secondary indexes
 
-Secondary indexes in Riak allow you to query based on the contents of a particular field.  Define
-YourClass#fields_to_index and return the names of any fields you wish to query on.  When you #save
-an instance of YourClass, riak-shim will populate a secondary index for that field.
+Secondary indexes in Riak allow you to query based on the contents of a
+particular field.  If you'd like to look up your data by the contents
+of fields, define `#fields_to_index` and return the names of
+any fields you wish to query on.  When you #save an instance of YourClass,
+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.
-      # Return an empty Array if you don't know what this means. :)
     end
 
-You can now retrieve records based on the content of those fields by calling...
-The `for_index` method retrieves all records whose value for the given index matches.
+The `for_index` method retrieves all records whose value for the given index
+matches:
 
     YourClass.for_index(index_name, value)
 
-Where `index_name` is what you defined in `fields_to_index` plus the suffix "_bin" .
+...where `index_name` is what you defined in `fields_to_index` plus the suffix
+"_bin" .
 
 The `value` is what you want to look up.
 
@@ -99,3 +106,5 @@ Return value is an Array of instances of your class matching the query.
 
 - Examples directory
 - Revisit tests
+- find less horrible way to deal with index names
+

data/Rakefile

@@ -1,2 +1,22 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--backtrace -cfs']
+end
+
+desc "Travis build checks for JRuby and adds a needed gem before testing"
+task :travis => [:check_jruby, :spec]
+
+desc "JRuby needs an additional gem"
+task :check_jruby do
+  if RUBY_PLATFORM == 'java'
+    `gem install jruby-openssl`
+  end
+end
+

data/lib/riak-shim/persistable.rb

@@ -2,7 +2,7 @@ module Riak
   module Shim
     module Persistable
       attr_writer :store
-      attr_accessor :key
+      attr_writer :key
 
       def key
         @key ||= self.class.gen_key
@@ -28,12 +28,18 @@ module Riak
         self
       end
 
+      def destroy
+        bucket.delete(key)
+      end
+
       def set_indexes(indexes)
         indexes.clear
-        fields_to_index.each do |field|
-          index_name = "#{field}_bin"
-          index_value = send(field)
-          indexes[index_name] << index_value
+        if self.respond_to?(:fields_to_index)
+          fields_to_index.each do |field|
+            index_name = "#{field}_bin"
+            index_value = send(field)
+            indexes[index_name] << index_value
+          end
         end
       end
 

data/lib/riak-shim/version.rb

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

data/riak-shim.gemspec

@@ -15,13 +15,15 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Riak::Shim::VERSION
 
-  gem.add_dependency 'riak-client'
-  gem.add_dependency 'uuidtools'
+  gem.add_dependency 'riak-client', '~>1.0.4'
+  gem.add_dependency 'excon'
+  gem.add_dependency 'uuidtools', '~>2.1.2'
 
   gem.add_development_dependency "rake"
   gem.add_development_dependency "rspec"
   gem.add_development_dependency "guard"
   gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "pry"
 
   if RUBY_PLATFORM.include? 'darwin'
     gem.add_development_dependency 'growl'

data/spec/persistable_spec.rb

@@ -1,26 +1,45 @@
 require 'spec_helper'
 require 'riak-shim/persistable'
 
-class PersistableTester
+class PersistableExample
   include Riak::Shim::Persistable
+  attr_accessor :foo, :bar, :baz
+
+  def to_hash
+    { 'foo' => foo, 'bar' => bar, 'baz' => baz }
+  end
+
+  def self.from_hash(data)
+    result = self.new
+    result.foo = data['foo']
+    result.bar = data['bar']
+    result.baz = data['baz']
+    result
+  end
 end
 
 describe 'persistable' do
-  let(:persistable) { PersistableTester.new }
+  let(:persistable) do
+    p = PersistableExample.new ; p.foo = 'boo' ; p.bar = 'who' ; p
+  end
 
   before do
     Riak::Shim::Store.any_instance.stub(:read_config).and_return(DB_CONFIG)
   end
 
+  after do
+    PersistableExample.delete_all
+  end
+
   describe '#bucket_name' do
     it 'composes #db_name and class name' do
-      persistable.bucket_name.should == 'test_persistable_tester'
+      persistable.bucket_name.should == 'test_persistable_example'
     end
   end
 
   describe '#bucket' do
     it 'returns the correct bucket' do
-      persistable.bucket.name.should == 'test_persistable_tester'
+      persistable.bucket.name.should == 'test_persistable_example'
     end
   end
 
@@ -29,5 +48,86 @@ describe 'persistable' do
       persistable.store.should respond_to(:bucket)
     end
   end
+
+  describe '#save' do
+    it 'increases key count' do
+      expect do
+        persistable.save
+      end.to change{ persistable.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
+    end
+  end
+
+  describe '#destroy' do
+    before do
+      persistable.save
+      persistable.destroy
+    end
+
+    it 'removes the key' do
+      persistable.bucket.exists?(persistable.key).should be_false
+    end
+  end
+
+  describe '#set_indexes' do
+    before do
+      @indexes = Hash.new { |hash, key| hash[key] = [] }
+      @indexes[:oldkey] = ['oldval']
+    end
+
+    context 'with a model which does not need indes' do
+      it 'does not require #fields_to_index to be defined' do
+        expect { persistable.set_indexes(@indexes) }.to_not raise_error
+      end
+
+      it 'clears preexisting indexes' do
+        persistable.set_indexes(@indexes)
+        @indexes.should be_empty
+      end
+    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
+        indexable.bar = 2
+        indexable.baz = 3
+        indexable.set_indexes(@indexes)
+      end
+
+      it 'sets indexes for specified fields and no others' do
+        @indexes.keys.should =~ ['bar_bin', 'baz_bin']
+      end
+    end
+  end
+
+  describe '#delete_all' do
+  end
+
+  describe '#de_camel' do
+  end
+
+  describe '#for_key' do
+    it 'fetches items for keys which exist'
+    it 'returns null when the key does not exist'
+  end
+
+  describe '#for_index' do
+  end
+
+  describe '#gen_key' do
+    it 'produces no duplicates when called a bunch of times'
+  end
 end
 

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 $: << './lib'
 require 'riak-shim'
+require 'pry'
 
 DB_CONFIG = { 'development' => { 'bucket_prefix' => 'dev_', 'host' => "localhost", 'http_port' => 8098},
     'test' => {'bucket_prefix' => 'test_', 'host' => "localhost", 'http_port' => 8098 }}
+
+Riak.disable_list_keys_warnings = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: riak-shim
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,26 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-18 00:00:00.000000000 Z
+date: 2012-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: excon
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -32,17 +48,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.1.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +123,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: growl
   requirement: !ruby/object:Gem::Requirement