riak-record 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9cefbb009666dc6e1e326b9e0f27add25fde982
-  data.tar.gz: 16df6690a2751083ba1bfa157158dd648aeee2e8
+  metadata.gz: e51ff6ee221ebec773b72a371ad33d36b67bfd00
+  data.tar.gz: 5981fda818b55246e37830a9460c5efe12e66a63
 SHA512:
-  metadata.gz: 9dda40575f7149e095a93ff445ac05870d906f4c364faf899fa0ab59fa27e79faf90367f8e8ec1e83989c3f01803ec928b052e791260d65ffa14d089560de061
-  data.tar.gz: 90d8f57ddc8e236431c472f68d9468ea5f8b91317f9751a9cf22dc5b53dad363606716addd548772e834f8b7a40b4fa131cbccba13b9e8a3777f5a74983b5a99
+  metadata.gz: c7261d2c6f4abd75fc86475d3ed9b5b23232478dae3bd98d206e52615e315665e2fc9fffd71e645f1b1ae86f33caab532ac14fb9706cf9debd3aa209583953ee
+  data.tar.gz: 758c83cdd23fb36cc4a0f1ab39db09efcd8ddf17698c2a0b771c8a3e9696e3f635d6fdca2533c1d53591a590c5415a132c50324567bedf81ffb2017c74de64bd

data/README.md

@@ -15,51 +15,44 @@ RiakRecord::Base.namespace = 'staging' # optional. Namespaces buckets
 
 class Post < RiakRecord::Base
   bucket_name :posts
-  data_attributes :title, :body, :category
-  belongs_to :author
-  has_many :comments
+  data_attributes :title, :body
 
   index_int_attributes :author_id # author_id_int
   index_bin_attributes :category # catgory_bin
 end
 
-class Author < RiakRecord::Base
-  bucket_name :authors
-  data_attributes :name
-  has_many :posts
-end
-
-class Comment < RiakRecord::Base
-  bucket_name :comments
-  data_attribute :comment
-  belongs_to :post
-
-  index_int_attributes :post_id
-end
+Post.client #> instance of Riak::Client
+Post.bucket #> instance of Riak::Bucket named "staging:posts"
 
-Author.client #> instance of Riak::Client
-Author.bucket #> instance of Riak::Bucket
-
-author = Author.new(99) # create a new record with id/key 99
-author.name = 'Robert' # set an attribute
-author.save # store in riak
-
-Post.find(["my-first-post","a-farewell-to-blogging"]) #> Array of ExampleRecords returned
-
-post = Post.find("my-first-post") #> Instance of ExampleRecord
+Post.find(["my-first-post","a-farewell-to-blogging"]) #> Array of Posts returned
+post = Post.find("my-first-post") #> Instance of Post
 post.riak_object #> directly access Riak::RObject
 post.data #> same as record.riak_object.data
 
 post.title = 'My First Post' #> record.riak_object.data['title']=
 post.title #> record.riak_object.data['title']
 
-post.author = 99 #> record.riak_object.indexes["author_id_int"] = [99]
+post.author_id = 99 #> record.riak_object.indexes["author_id_int"] = [99]
 post.category = 'ruby' #> record.riak_object.indexes["category_bin"] = ["ruby"]
 post.save  #> record.riak_object.store
+post.new_record? #> false
 post.reload #> reload the underlying riak_object from the db discarding changes
 
-Author.find(99).posts #> [post]
+```
+
+Callbacks are called in this order:
+* before_save
+* before_create or before_update
+* ...save...
+* after_save
+* after_create or after_update
+
 
+### RiakRecord::Finder
+
+RiakRecord::Finder provides find objects by indexes. Results are loaded in batches as needed.
+
+```ruby
 finder = Post.where(:category => 'ruby') #> Instance of RiakRecord::Finder
 finder.count #> 1
 finder.any? #> true
@@ -69,6 +62,54 @@ finder.each{|e| ... } #> supports all enumerable methods
 finder.count_by(:author_id) #> {"1" => 1}
 ```
 
+### RiakRecord::Associations
+
+RiakRecord supports `has_many` and `belongs_to` associations which are light versions of what you'd expect with ActiveRecord.
+
+```ruby
+class Author < RiakRecord::Base
+  bucket_name :authors
+  data_attributes :name
+  has_many :posts, :class_name => 'Post', :foreign_key => "post_id"
+end
+
+class Comment < RiakRecord::Base
+  bucket_name :comments
+  data_attribute :comment
+  belongs_to :post, :class_name => 'Post', :foreign_key => "post_id"
+
+  index_int_attributes :post_id
+end
+
+Author.find(99).posts #> RiakRecord::Finder [post]
+Comment.find(12).author #> an instance of Author
+```
+
+### RiakRecord::Callbacks
+
+RiakRecord supports before and after callbacks for save, create and update. You can prepend or append callbacks. And they can be strings (eval'd), Procs, Objects or Symbols.
+
+```ruby
+class Blog < RiakRecord::Base
+  bucket :blogs
+  data_attribute :subdomain
+
+  class BlogCallbacks
+    def before_update
+    end
+  end
+
+  before_save Proc.new{|record| record.create_subdomain }
+  after_create :send_welcome_email
+  prepend_after_create "logger('new blog')"
+  after_update :send_change_confirmation
+  before_update BlogCallbacks.new
+
+  ...
+end
+
+```
+
 ## Using RiakRecord::Associations in other classes
 
 If you're using another data store with Riak, it might be helpful to include Riak's associations in the other class.

data/TODO.md

@@ -2,7 +2,9 @@
 
 * RiakRecord::Base
   * links_to should create a walkable link
+  * delete
+  * new(hash)
+  * id_generator
 * Document methods in classes
 * Validations support
   * Validate key is unique (bucket.get_or_new)
-* Autogen id/key (snowflake?)

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/riak_record/base.rb

@@ -3,6 +3,7 @@ require 'riak'
 module RiakRecord
   class Base
     attr_reader :riak_object
+    include Callbacks
     include Associations
     class << self
       alias :has_many :has_many_riak
@@ -13,6 +14,7 @@ module RiakRecord
       unless r.is_a? Riak::RObject
         r = self.class.bucket.new(r.to_s)
         r.data = {}
+        r.content_type = 'application/json'
       end
       @riak_object = r
     end
@@ -26,10 +28,22 @@ module RiakRecord
     end
 
     def save
+      creating = new_record?
+
+      before_save!
+      creating ? before_create! : before_update!
       riak_object.store(:returnbody => false)
+      creating ? after_create! : after_update!
+      after_save!
+
+      @_stored = true
       self
     end
 
+    def new_record?
+      !(@_stored || riak_object.vclock)
+    end
+
     def id
       riak_object.key
     end
@@ -66,7 +80,7 @@ module RiakRecord
         index_names[method_name.to_sym] = "#{method_name}_int"
 
         define_method(method_name) do
-          indexes["#{method_name}_int"]
+          indexes["#{method_name}_int"].to_a
         end
 
         define_method("#{method_name}=".to_sym) do |value|
@@ -80,7 +94,7 @@ module RiakRecord
         index_names[method_name.to_sym] = "#{method_name}_bin"
 
         define_method(method_name) do
-          indexes["#{method_name}_bin"]
+          indexes["#{method_name}_bin"].to_a
         end
 
         define_method("#{method_name}=".to_sym) do |value|
@@ -126,7 +140,7 @@ module RiakRecord
     end
 
     def self.namespace_prefixed
-      self.namespace + ":-:"
+      self.namespace + ":"
     end
 
     def self.all_buckets_in_namespace

data/lib/riak_record/callbacks.rb

@@ -0,0 +1,65 @@
+module RiakRecord
+  module Callbacks
+
+    CALLBACK_TRIGGERS = [
+      :before_create, :after_create,
+      :before_save, :after_save,
+      :before_update, :after_update
+    ]
+
+    def call_callbacks!(trigger)
+      callbacks = self.class._callbacks(trigger)
+      callbacks.each do |callback|
+        if callback.is_a? Symbol
+          self.send(callback)
+        elsif callback.is_a? Proc
+          callback.call(self)
+        elsif callback.is_a? String
+          eval(callback)
+        else
+          callback.send(trigger, self)
+        end
+      end
+    end
+
+    CALLBACK_TRIGGERS.each do |trigger|
+      define_method("#{trigger}!") do
+        call_callbacks!(trigger)
+      end
+    end
+
+    module ClassMethods
+      def _callbacks(trigger)
+        @_callbacks ||= {}
+        @_callbacks[trigger] ||= []
+      end
+
+      CALLBACK_TRIGGERS.each do |trigger|
+
+          ruby = <<-END_OF_RUBY
+
+              def append_#{trigger}(*args)
+                _callbacks(:#{trigger}).concat(args)
+              end
+
+              def #{trigger}(*args)
+                append_#{trigger}(*args)
+              end
+
+              def prepend_#{trigger}(*args)
+                _callbacks(:#{trigger}).unshift(*args)
+              end
+
+          END_OF_RUBY
+
+          class_eval ruby
+      end
+
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+  end
+end

data/lib/riak_record/finder.rb

@@ -27,7 +27,7 @@ module RiakRecord
     alias :to_a :all
 
     def each
-      @loaded_objects.each{|o| yield o}
+      all.each{|o| yield o}
     end
 
     def count

data/lib/riak_record.rb

@@ -1,3 +1,4 @@
+require 'riak_record/callbacks'
 require 'riak_record/associations'
 require 'riak_record/finder'
 require 'riak_record/base'

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.1.0 ruby lib
+# stub: riak-record 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "riak-record"
-  s.version = "0.1.0"
+  s.version = "0.2.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-23"
+  s.date = "2014-09-25"
   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 = [
@@ -32,10 +32,13 @@ Gem::Specification.new do |s|
     "lib/riak_record.rb",
     "lib/riak_record/associations.rb",
     "lib/riak_record/base.rb",
+    "lib/riak_record/callbacks.rb",
     "lib/riak_record/finder.rb",
+    "riak-record-0.1.0.gem",
     "riak-record.gemspec",
     "spec/riak_record/associations_spec.rb",
     "spec/riak_record/base_spec.rb",
+    "spec/riak_record/callbacks_spec.rb",
     "spec/riak_record/finder_spec.rb",
     "spec/riak_record_spec.rb",
     "spec/spec_helper.rb"

data/spec/riak_record/base_spec.rb

@@ -16,8 +16,8 @@ end
 
 describe RiakRecord::Base do
   it "should set the bucket name on each instance of RiakRecord class" do
-    expect(ExampleA.bucket_name).to eq(RiakRecord::Base.namespace+":-:example_a")
-    expect(ExampleB.bucket_name).to eq(RiakRecord::Base.namespace+':-:example_b')
+    expect(ExampleA.bucket_name).to eq(RiakRecord::Base.namespace+":example_a")
+    expect(ExampleB.bucket_name).to eq(RiakRecord::Base.namespace+':example_b')
   end
 
   it "should share a client among all classes" do
@@ -45,13 +45,90 @@ describe RiakRecord::Base do
     end
   end
 
+  describe "new_record?" do
+    let(:record){ ExampleA.new("1") }
+    it "should be true for a new record" do
+      expect(record).to be_new_record
+    end
+
+    it "should be false for loaded new records" do
+      expect(record.save.reload).to_not be_new_record
+    end
+
+    it "should be a new_record if unstored" do
+      expect{
+        record.save
+      }.to change{ record.new_record? }.from(true).to(false)
+    end
+  end
+
   describe "save" do
-    let(:record) { ExampleA.new("1234") }
+    after :each do
+      example_class.instance_variable_set("@_callbacks", nil)
+    end
+    let(:example_class){ ExampleA }
+    let(:record) { example_class.new("1234") }
+
     it "should store the object" do
       record.attribute1 = 'hello'
       record.save
       expect(record.reload.attribute1).to eq('hello')
     end
+
+    it "should call before_save callbacks" do
+      example_class.before_save(:a_callback)
+      expect(record).to receive(:a_callback)
+      record.save
+    end
+
+    it "should call after_save callbacks" do
+      example_class.after_save(:a_callback)
+      expect(record).to receive(:a_callback)
+      record.save
+    end
+
+    context "new records" do
+      before :each do
+        allow(record).to receive(:new_record?).and_return(true)
+      end
+      it "should call the before_create callbacks" do
+        example_class.before_create(:a_create_callback)
+        example_class.before_update(:an_update_callback)
+        expect(record).to receive(:a_create_callback).and_return(true)
+        expect(record).to_not receive(:an_update_callback)
+        record.save
+      end
+
+      it "should call the after_create callbacks" do
+        example_class.after_create(:a_create_callback)
+        example_class.after_update(:an_update_callback)
+        expect(record).to receive(:a_create_callback).and_return(true)
+        expect(record).to_not receive(:an_update_callback)
+        record.save
+      end
+    end
+
+    context "existing records" do
+      before :each do
+        allow(record).to receive(:new_record?).and_return(false)
+      end
+
+      it "should call the before_update callbacks" do
+        example_class.before_create(:a_create_callback)
+        example_class.before_update(:an_update_callback)
+        expect(record).to_not receive(:a_create_callback)
+        expect(record).to receive(:an_update_callback).and_return(true)
+        record.save
+      end
+
+      it "should call the after_update callbacks" do
+        example_class.after_create(:a_create_callback)
+        example_class.after_update(:an_update_callback)
+        expect(record).to_not receive(:a_create_callback)
+        expect(record).to receive(:an_update_callback).and_return(true)
+        record.save
+      end
+    end
   end
 
   describe "class methods" do
@@ -135,14 +212,24 @@ describe RiakRecord::Base do
     end
 
     describe "index_int_attributes" do
-      let(:riak_object) { Riak::RObject.new("obj").tap{|r| r.indexes["index1_int"] = [1] } }
-      let(:record) { ExampleA.new(riak_object) }
+      let(:record) { ExampleA.new("ob") }
+      before :each do
+        record.riak_object.indexes["index1_int"] = [1]
+        record.save
+      end
       it "should read and write each index" do
         expect{
           record.index1=[2]
         }.to change{record.riak_object.indexes["index1_int"]}.from([1]).to([2])
       end
 
+      it "should return arrays on reload" do
+        expect{
+          record.index1=2
+          record.save.reload
+        }.to change{record.riak_object.indexes["index1_int"]}.from([1]).to([2])
+      end
+
       it "should handle non arrays" do
         expect{
           record.index2=2
@@ -181,7 +268,7 @@ describe RiakRecord::Base do
     describe "namespacing buckets" do
       it "should prepend namespace to bucket name" do
         RiakRecord::Base.namespace = "namespace_test"
-        expect(ExampleA.bucket_name).to eq("namespace_test:-:example_a")
+        expect(ExampleA.bucket_name).to eq("namespace_test:example_a")
       end
     end
 

data/spec/riak_record/callbacks_spec.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+class Example
+  include RiakRecord::Callbacks
+end
+
+describe RiakRecord::Callbacks do
+
+  let(:example_class) { Example }
+  let(:example){ example_class.new }
+
+  before :each do
+    example_class.instance_variable_set("@_callbacks", nil)
+    example_class.before_save("nil")
+  end
+
+  describe "adding call backs" do
+    it "should add to the callbacks" do
+      example_class.after_save(:a_new_callback)
+      expect( example_class._callbacks(:after_save).last ).to eq(:a_new_callback)
+    end
+
+    it "should append to the callbacks" do
+      example_class.append_before_save(:a_late_callback)
+      expect( example_class._callbacks(:before_save).last ).to eq(:a_late_callback)
+    end
+
+    it "should prepend to the callbacks" do
+      example_class.prepend_before_save(:an_early_callback)
+      expect( example_class._callbacks(:before_save).first ).to eq(:an_early_callback)
+    end
+  end
+
+
+  describe "call_callbacks!" do
+    it "should call symbol callbacks" do
+      example_class.before_save(:a_symbol_callback)
+      expect( example ).to receive(:a_symbol_callback).and_return(nil)
+      example.before_save!
+    end
+
+    it "should eval string callbacks" do
+      class EvalProof < StandardError
+      end
+      example_class.before_save("raise EvalProof")
+      expect{
+        example.before_save!
+      }.to raise_error(EvalProof)
+    end
+
+    it "should call CallbackObjects" do
+      class CallbackObject
+        def before_save
+        end
+      end
+      callback_object = CallbackObject.new
+      example_class.before_save(callback_object)
+      expect(callback_object).to receive(:before_save)
+      example.before_save!
+    end
+
+    it "should call procs" do
+      a_proc = Proc.new{|a| a}
+      example_class.before_create(a_proc)
+      expect(a_proc).to receive(:call).with(example).and_return(nil)
+      example.call_callbacks!(:before_create)
+    end
+  end
+
+end

data/spec/riak_record/finder_spec.rb

@@ -64,7 +64,10 @@ describe RiakRecord::Finder do
 
   describe "enumberable methods" do
     it "should yield once per block" do
-      expect( pop_finder.all?{|o| o.category == 'rock'} ).to eq(true)
+      expect( pop_finder.all?{|o| o.category == ['pop']} ).to eq(true)
+    end
+    it "should yield once per block" do
+      expect( pop_finder.map{|x| 1}.inject{|sum,x| sum = sum.to_i + x}).to eq(155)
     end
   end
 

data/spec/spec_helper.rb

@@ -1,18 +1,18 @@
 require 'simplecov'
 
 module SimpleCov::Configuration
-  def clean_filters
+  def cleans
     @filters = []
   end
 end
 
 SimpleCov.configure do
-  clean_filters
+  cleans
   load_profile 'test_frameworks'
 end
 
 ENV["COVERAGE"] && SimpleCov.start do
-  add_filter "/.rvm/"
+  add "/.rvm/"
 end
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -30,7 +30,7 @@ Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 RSpec.configure do |config|
   config.before do
     RiakRecord::Base.namespace = 'test'
-    RiakRecord::Base.all_buckets_in_namespace do |bucket|
+    RiakRecord::Base.all_buckets_in_namespace.each do |bucket|
       bucket.keys.each{|k| bucket.delete(k) }
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: riak-record
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Robert Graff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-23 00:00:00.000000000 Z
+date: 2014-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: riak-client
@@ -159,10 +159,13 @@ files:
 - lib/riak_record.rb
 - lib/riak_record/associations.rb
 - lib/riak_record/base.rb
+- lib/riak_record/callbacks.rb
 - lib/riak_record/finder.rb
+- riak-record-0.1.0.gem
 - riak-record.gemspec
 - spec/riak_record/associations_spec.rb
 - spec/riak_record/base_spec.rb
+- spec/riak_record/callbacks_spec.rb
 - spec/riak_record/finder_spec.rb
 - spec/riak_record_spec.rb
 - spec/spec_helper.rb