riak-record 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e51ff6ee221ebec773b72a371ad33d36b67bfd00
-  data.tar.gz: 5981fda818b55246e37830a9460c5efe12e66a63
+  metadata.gz: 323433e9c9fb5acd1f53b15aebadb059e8cd2302
+  data.tar.gz: f085f0f28796d53fb8e9146ab799ac54b55c86b8
 SHA512:
-  metadata.gz: c7261d2c6f4abd75fc86475d3ed9b5b23232478dae3bd98d206e52615e315665e2fc9fffd71e645f1b1ae86f33caab532ac14fb9706cf9debd3aa209583953ee
-  data.tar.gz: 758c83cdd23fb36cc4a0f1ab39db09efcd8ddf17698c2a0b771c8a3e9696e3f635d6fdca2533c1d53591a590c5415a132c50324567bedf81ffb2017c74de64bd
+  metadata.gz: 2fa5ac5afafbd7e089ab4d04ae8c7a1e4b7862cde0312b738aaca34b12a328904192adef314b7873754813d117e1ab9fffda3e4e5d77ed734204f34e48bcb147
+  data.tar.gz: 9ff0f2298cfd033786ee6f5b42fb8dc5a16224d6882b1339d13e54827cecefaf80eb6a5e62651b69a820c04e5b6df4a4aab86f3bfbfabbeb1dd9df1360af556d

data/README.md

@@ -1,14 +1,18 @@
-# riak-record
+# RiakRecord
 
 RiakRecord is a thin and immature wrapper around riak-ruby-client. It creates a bucket for
-each class, provides a simple finder, and creates attribute reader.  It adds a layer over
+each class, provides a simple finder, and creates attribute accessors for data and indexes.  It adds a layer over
 the Riak::Client to make interacting with Riak more ActiveRecord-like while
 still giving you all the access to Riak's underlying client's capabilities.
 
+RiakRecord is is very similar to [Basho's Ripple](https://github.com/basho-labs/ripple) which is more feature rich
+but also abandoned. For the [same reasons](http://basho.com/tag/ripple-client-apis/)
+that Basho abandoned Ripple, you should think twice before using RiakRecord.
+
 ## Usage
 
 ```ruby
-require 'riak-record'
+require 'riak_record'
 
 RiakRecord::Base.client = Riak::Client.new
 RiakRecord::Base.namespace = 'staging' # optional. Namespaces buckets

data/TODO.md

@@ -2,8 +2,6 @@
 
 * RiakRecord::Base
   * links_to should create a walkable link
-  * delete
-  * new(hash)
   * id_generator
 * Document methods in classes
 * Validations support

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/riak_record/base.rb

@@ -10,13 +10,21 @@ module RiakRecord
       alias :belongs_to :belongs_to_riak
     end
 
-    def initialize(r = nil)
-      unless r.is_a? Riak::RObject
-        r = self.class.bucket.new(r.to_s)
-        r.data = {}
-        r.content_type = 'application/json'
+    def initialize(options = nil)
+      if options.is_a?(Riak::RObject)
+        @riak_object = options
+      else
+        @riak_object = self.class.bucket.new
+        @riak_object.content_type = 'application/json'
+        @riak_object.data = {}
+        if options.is_a?(Hash)
+          id = options.delete(:id) || options.delete(:key)
+          @riak_object.key = id.to_s if id
+          options.each_pair{ |k,v| self.send("#{k}=".to_sym, v) }
+        elsif !options.nil?
+          @riak_object.key = options.to_s
+        end
       end
-      @riak_object = r
     end
 
     def data
@@ -39,6 +47,19 @@ module RiakRecord
       @_stored = true
       self
     end
+    alias :save! :save
+
+    def self.create(*args)
+      self.new(*args).save
+    end
+
+    def self.create!(*args)
+      self.new(*args).save
+    end
+
+    def delete
+      riak_object.delete
+    end
 
     def new_record?
       !(@_stored || riak_object.vclock)
@@ -48,6 +69,11 @@ module RiakRecord
       riak_object.key
     end
 
+    def ==(record)
+      return false unless record.kind_of?(RiakRecord::Base)
+      self.class.bucket_name == record.class.bucket_name && id == record.id
+    end
+
     def reload
       @riak_object = self.class.bucket.get(id)
       @riak_object.data = {} if @riak_object.data.nil?

data/lib/riak_record/finder.rb

@@ -24,7 +24,11 @@ module RiakRecord
       end
       @loaded_objects
     end
-    alias :to_a :all
+    alias :to_ary :all # internal array
+
+    def to_a
+      all.dup # new array
+    end
 
     def each
       all.each{|o| yield o}

data/riak-record.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: riak-record 0.2.0 ruby lib
+# stub: riak-record 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "riak-record"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Robert Graff"]
-  s.date = "2014-09-25"
+  s.date = "2014-09-26"
   s.description = "RiakRecord is a thin and immature wrapper around riak-ruby-client. It creates a bucket for\n  each class, provides a simple finder, and creates attribute reader."
   s.email = "robert_graff@yahoo.com"
   s.extra_rdoc_files = [

data/spec/riak_record/base_spec.rb

@@ -25,6 +25,28 @@ describe RiakRecord::Base do
     expect(ExampleA.client).to eq(ExampleB.client)
   end
 
+  describe "new" do
+    it "should accept a string" do
+      record = ExampleA.new("abc")
+      expect(record.id).to eq("abc")
+    end
+    it "should accept a int" do
+      record = ExampleA.new(123)
+      expect(record.id).to eq("123")
+    end
+    it "should accept an robject" do
+      robject = ExampleA.bucket.new("abc")
+      record = ExampleA.new(robject)
+      expect(record.id).to eq("abc")
+    end
+    it "should accept a hash" do
+      record = ExampleA.new(:id => "abc", :attribute1 => 'sappy', :index1 => 123)
+      expect(record.id).to eq("abc")
+      expect(record.attribute1).to eq('sappy')
+      expect(record.index1).to eq([123])
+    end
+  end
+
   describe "index_names" do
     it "should look up the index by symbol" do
       expect( ExampleA.index_names[:index1] ).to eq("index1_int")
@@ -129,6 +151,15 @@ describe RiakRecord::Base do
         record.save
       end
     end
+
+    describe "delete" do
+      let(:saved_record){ ExampleA.create("abc") }
+      it "should remove from riak" do
+        expect{
+          saved_record.delete
+        }.to change{ ExampleA.find("abc") }.from(saved_record).to(nil)
+      end
+    end
   end
 
   describe "class methods" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riak-record
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Robert Graff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-25 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak-client