riak-record 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb4640475e65d8b57d7dd89fb6bcea9dc8b98efc
-  data.tar.gz: 07bc6462e699e51c3997c722bbaa03fa22f4ef6a
+  metadata.gz: f9cefbb009666dc6e1e326b9e0f27add25fde982
+  data.tar.gz: 16df6690a2751083ba1bfa157158dd648aeee2e8
 SHA512:
-  metadata.gz: ed8334fa967f783728aacd07603cf3454d26e16398ffa30babc0a806933d216ef85feb0f06a3e86db297fcfff881ef2895fc4c35f4f990222254362fffe38ad6
-  data.tar.gz: 22cb2b18af1bd6245986cbc371e03829b20a939699f78846407a238a18d5786d2a541e204e94e0d3f96132031bde38fecdd136dec3f6c818c80c5e70fa08c04e
+  metadata.gz: 9dda40575f7149e095a93ff445ac05870d906f4c364faf899fa0ab59fa27e79faf90367f8e8ec1e83989c3f01803ec928b052e791260d65ffa14d089560de061
+  data.tar.gz: 90d8f57ddc8e236431c472f68d9468ea5f8b91317f9751a9cf22dc5b53dad363606716addd548772e834f8b7a40b4fa131cbccba13b9e8a3777f5a74983b5a99

data/Gemfile

@@ -8,4 +8,7 @@ group :development do
   gem "bundler", "~> 1.0"
   gem "jeweler", "~> 2.0.1"
   gem "simplecov", ">= 0"
+  gem 'guard-rspec', '~> 4.3.1'
+  gem 'guard-bundler'
+  gem 'terminal-notifier-guard'
 end

data/Gemfile.lock

@@ -4,13 +4,18 @@ GEM
     addressable (2.3.6)
     beefcake (1.0.0)
     builder (3.2.2)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
     cert_validator (0.0.1)
+    coderay (1.1.0)
     descendants_tracker (0.0.4)
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     docile (1.1.5)
     faraday (0.9.0)
       multipart-post (>= 1.2, < 3)
+    ffi (1.9.3)
+    formatador (0.2.5)
     git (1.2.8)
     github_api (0.12.1)
       addressable (~> 2.3)
@@ -20,6 +25,18 @@ GEM
       multi_json (>= 1.7.5, < 2.0)
       nokogiri (~> 1.6.3)
       oauth2
+    guard (2.6.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-bundler (2.0.0)
+      bundler (~> 1.0)
+      guard (~> 2.2)
+    guard-rspec (4.3.1)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
     hashie (3.3.1)
     highline (1.6.21)
     i18n (0.6.11)
@@ -35,6 +52,12 @@ GEM
       rdoc
     json (1.8.1)
     jwt (1.0.0)
+    listen (2.7.8)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.6)
+    method_source (0.8.2)
     mini_portile (0.6.0)
     multi_json (1.10.1)
     multi_xml (0.5.5)
@@ -47,8 +70,15 @@ GEM
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
       rack (~> 1.2)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rack (1.5.2)
     rake (10.3.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
     rdoc (3.12.2)
       json (~> 1.4)
     riak-client (2.0.0)
@@ -74,15 +104,22 @@ GEM
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
+    slop (3.5.0)
+    terminal-notifier-guard (1.5.3)
+    thor (0.19.1)
     thread_safe (0.3.4)
+    timers (1.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.0)
+  guard-bundler
+  guard-rspec (~> 4.3.1)
   jeweler (~> 2.0.1)
   rdoc (~> 3.12)
   riak-client (~> 2.0.0)
   rspec (~> 3.1.0)
   simplecov
+  terminal-notifier-guard

data/Guardfile

@@ -0,0 +1,11 @@
+guard :bundler do
+  watch('Gemfile')
+  # Uncomment next line if your Gemfile contains the `gemspec' command.
+  # watch(/^.+\.gemspec/)
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,33 +1,89 @@
 # riak-record
 
 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.
+each class, provides a simple finder, and creates attribute reader.  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.
 
 ## Usage
 
 ```ruby
 require 'riak-record'
 
-RiakRecord.client = Riak::Client.new
-RiakRecord.namespace = 'staging' # optional. Namespaces buckets
+RiakRecord::Base.client = Riak::Client.new
+RiakRecord::Base.namespace = 'staging' # optional. Namespaces buckets
 
-class ExampleRecord < RiakRecord
-  bucket_name 'example_a'
-  record_attributes :attribute1, :attribute2
+class Post < RiakRecord::Base
+  bucket_name :posts
+  data_attributes :title, :body, :category
+  belongs_to :author
+  has_many :comments
+
+  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
 
-ExampleRecord.find("a-key") #> Instance of ExampleRecord
-ExampleRecord.find(["a-key","b-key"]) #> Array of ExampleRecords returned
+class Comment < RiakRecord::Base
+  bucket_name :comments
+  data_attribute :comment
+  belongs_to :post
+
+  index_int_attributes :post_id
+end
+
+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.riak_object #> directly access Riak::RObject
+post.data #> same as record.riak_object.data
 
-record = ExampleRecord.find("a-key")
-record.riak_object #> directly access Riak::RObject
-record.data #> same as record.riak_object.data
-record.attribute1 #> record.riak_object.data[:attribute1]
-record.attribute1 = 'name'
-record.save  #> record.riak_object.store
+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.category = 'ruby' #> record.riak_object.indexes["category_bin"] = ["ruby"]
+post.save  #> record.riak_object.store
+post.reload #> reload the underlying riak_object from the db discarding changes
+
+Author.find(99).posts #> [post]
+
+finder = Post.where(:category => 'ruby') #> Instance of RiakRecord::Finder
+finder.count #> 1
+finder.any? #> true
+finder.any?{|o| o.category == 'php'} #> false
+finder.none? #> false
+finder.each{|e| ... } #> supports all enumerable methods
+finder.count_by(:author_id) #> {"1" => 1}
 ```
 
+## 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.
+
+```ruby
+class User < ActiveRecord::Base
+  include RiakRecord::Assocations
+
+  has_many_riak :posts, :class_name => "Post", :foreign_key => :user_id
+  belongs_to_riak :author, :class_name => "Author", :foreign_key => :author_id
+end
+
+User.find(1).posts #> create RiakRecord::Finder(Post, :user_id => 1)
+User.find(1).author #> Author.find(self.author_id)
+```
 
 ## Contributing to riak-record
 

data/TODO.md

@@ -0,0 +1,8 @@
+# TODO
+
+* RiakRecord::Base
+  * links_to should create a walkable link
+* Document methods in classes
+* Validations support
+  * Validate key is unique (bucket.get_or_new)
+* Autogen id/key (snowflake?)

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.0

data/lib/riak_record/associations.rb

@@ -0,0 +1,49 @@
+module RiakRecord
+  module Associations
+
+    module ClassMethods
+      def belongs_to_riak(association_name, options = {})
+        class_name = options[:class_name] ||= association_name.to_s.split("_").collect(&:capitalize).join
+        foreign_key = options[:foreign_key] || "#{association_name}_id"
+        method_def = <<-END_OF_RUBY
+
+        def #{association_name}
+          @belongs_to_riak_#{association_name} = nil if @belongs_to_riak_#{association_name} && @belongs_to_riak_#{association_name}.id.to_s != Array(#{foreign_key}).first.to_s
+          @belongs_to_riak_#{association_name} ||= #{class_name}.find(#{foreign_key})
+        end
+
+        def #{association_name}=(obj)
+          raise ArgumentError, "not an instance of RiakRecord" unless obj.kind_of?(RiakRecord::Base)
+          @belongs_to_riak_#{association_name} = obj
+          self.#{foreign_key} = obj.id
+        end
+
+        END_OF_RUBY
+
+        class_eval method_def
+      end
+
+      def has_many_riak(association_name, options = {})
+        class_name = options[:class_name]
+        foreign_key = options[:foreign_key]
+        class_name && foreign_key or raise ArgumentError, "has_many_riak requires class_name and foreign_key options"
+
+        method_def = <<-END_OF_RUBY
+
+        def #{association_name}
+          @has_many_riak_#{association_name} ||= #{class_name}.where(:#{foreign_key} => self.id.to_s)
+        end
+
+        END_OF_RUBY
+
+        class_eval method_def
+      end
+
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+  end
+end

data/lib/riak_record/base.rb

@@ -0,0 +1,146 @@
+require 'riak'
+
+module RiakRecord
+  class Base
+    attr_reader :riak_object
+    include Associations
+    class << self
+      alias :has_many :has_many_riak
+      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 = {}
+      end
+      @riak_object = r
+    end
+
+    def data
+      riak_object.data
+    end
+
+    def indexes
+      riak_object.indexes
+    end
+
+    def save
+      riak_object.store(:returnbody => false)
+      self
+    end
+
+    def id
+      riak_object.key
+    end
+
+    def reload
+      @riak_object = self.class.bucket.get(id)
+      @riak_object.data = {} if @riak_object.data.nil?
+      self
+    end
+
+    def self.bucket_name(name = :not_a_name)
+      @bucket_name = name.to_s unless name == :not_a_name
+      namespace.present? ? namespace_prefixed+@bucket_name : @bucket_name
+    end
+
+    def self.bucket
+      @bucket ||= client.bucket(bucket_name)
+    end
+
+    def self.data_attributes(*attributes)
+      attributes.map(&:to_sym).each do |method_name|
+        define_method(method_name) do
+            data[method_name.to_s]
+        end
+
+        define_method("#{method_name}=".to_sym) do |value|
+          data[method_name.to_s] = value
+        end
+      end
+    end
+
+    def self.index_int_attributes(*attributes)
+      attributes.map(&:to_sym).each do |method_name|
+        index_names[method_name.to_sym] = "#{method_name}_int"
+
+        define_method(method_name) do
+          indexes["#{method_name}_int"]
+        end
+
+        define_method("#{method_name}=".to_sym) do |value|
+          indexes["#{method_name}_int"] = Array(value).map(&:to_i)
+        end
+      end
+    end
+
+    def self.index_bin_attributes(*attributes)
+      attributes.map(&:to_sym).each do |method_name|
+        index_names[method_name.to_sym] = "#{method_name}_bin"
+
+        define_method(method_name) do
+          indexes["#{method_name}_bin"]
+        end
+
+        define_method("#{method_name}=".to_sym) do |value|
+          indexes["#{method_name}_bin"] = Array(value).map(&:to_s)
+        end
+      end
+    end
+
+    def self.index_names
+      @index_names ||= {}
+    end
+
+    def self.where(options)
+      RiakRecord::Finder.new(self, options)
+    end
+
+    def self.find(key_or_keys)
+      return find_many(key_or_keys) if key_or_keys.is_a?(Array)
+
+      begin
+        self.new(bucket.get(key_or_keys.to_s))
+      rescue Riak::FailedRequest => e
+        if e.not_found?
+          nil
+        else
+          raise e
+        end
+      end
+    end
+
+    def self.find_many(keys)
+      hash = bucket.get_many(keys.map(&:to_s))
+      keys.map{ |k| hash[k] }
+    end
+
+    @@namespace = nil
+    def self.namespace=(namespace)
+      @@namespace = namespace
+    end
+
+    def self.namespace
+      @@namespace
+    end
+
+    def self.namespace_prefixed
+      self.namespace + ":-:"
+    end
+
+    def self.all_buckets_in_namespace
+      raise "namespace not set" unless self.namespace
+      client.list_buckets.select{|b| b.name.match(/^#{ Regexp.escape(self.namespace_prefixed) }/) }
+    end
+
+    def self.client=(client)
+      @@client = client
+    end
+
+    def self.client
+      @@client
+    end
+
+  end
+end

data/lib/riak_record/finder.rb

@@ -0,0 +1,125 @@
+module RiakRecord
+  class Finder
+    include Enumerable
+
+    def initialize(finder_class, conditions)
+      unless finder_class <= RiakRecord::Base
+        raise ArgumentError, "RiakRecord::Finder requires a RiakRecord::Base class"
+      end
+      unless conditions.is_a?(Hash) && conditions.size == 1
+        raise ArgumentError, "RiakRecord::Finder requires exactly one condition specified as a hash"
+      end
+      @finder_class = finder_class
+      @bucket = finder_class.bucket
+      @index = finder_class.index_names[conditions.keys.first.to_sym]
+      @value = conditions.values.first
+      @load_complete = false
+      @page_size = 100
+      @loaded_objects = []
+    end
+
+    def all
+      until @load_complete do
+        load_next_page
+      end
+      @loaded_objects
+    end
+    alias :to_a :all
+
+    def each
+      @loaded_objects.each{|o| yield o}
+    end
+
+    def count
+      @load_complete ? @loaded_objects.count : count_map_reduce
+    end
+
+    def first(n=nil)
+      if n
+        until @load_complete || n <= @loaded_objects.count
+          load_next_page
+        end
+        @loaded_objects.first(n)
+      else
+        load_next_page unless load_started?
+        @loaded_objects.first
+      end
+    end
+
+    def find(ifnone = nil, &block)
+      found = @loaded_objects.find(&block)
+      until found || @load_complete
+        found = load_next_page.find(&block)
+      end
+      return found if found
+      return ifnone.call if ifnone
+      nil
+    end
+    alias :detect :find
+
+    def empty?(&block)
+      if block_given?
+        !any?(&block)
+      else
+        load_next_page unless load_started?
+        @loaded_objects.count.zero?
+      end
+    end
+    alias :none? :empty?
+
+    def any?(&block)
+      if block_given?
+        return true if @loaded_objects.any? &block
+        until @load_complete
+          load_next_page.any? &block
+        end
+        false
+      else
+        !empty?
+      end
+    end
+
+    def count_by(attribute)
+      return count_by_map_reduce(attribute) unless @load_complete
+      results = {}
+      @loaded_objects.each{|o| k = o.send(attribute).to_s; results[k] ||= 0; results[k] += 1 }
+      results
+    end
+
+  private
+
+    def load_started?
+      @load_complete || @loaded_objects.count > 0
+    end
+
+    def count_by_map_reduce(attribute)
+      count_by_index = @finder_class.index_names[attribute.to_sym].present?
+      parsed_attribute = count_by_index ? "v.values[0].metadata.index.#{@finder_class.index_names[attribute.to_sym]}" : "JSON.parse(v.values[0].data).#{attribute}"
+      Riak::MapReduce.new(@finder_class.client).
+        index(@bucket, @index, @value).
+        map("function(v){ var h = {}; h[#{parsed_attribute}] = 1; return [h] }", :keep => false).
+        reduce("function(values) { var result = {}; for (var value in values) { for (var key in values[value]) { if (key in result) { result[key] += values[value][key]; } else { result[key] = values[value][key]; }}} return [result]; }", :keep => true).run.first
+    end
+
+    def count_map_reduce
+      Riak::MapReduce.new(@finder_class.client).
+        index(@bucket, @index, @value).
+        map("function(v){ return [1] }", :keep => false).
+        reduce("Riak.reduceSum", :keep => true).run.first
+    end
+
+    def load_next_page
+      return if @load_complete
+      if @querier
+        @querier = @querier.next_page
+      else
+        @querier = Riak::SecondaryIndex.new(@bucket, @index, @value, :max_results => @page_size)
+      end
+      @load_complete = !@querier.has_next_page?
+      new_objects = @querier.values.map{ |robject| @finder_class.new(robject) }
+      @loaded_objects.concat(new_objects)
+      new_objects
+    end
+
+  end
+end

data/lib/riak_record.rb

@@ -0,0 +1,6 @@
+require 'riak_record/associations'
+require 'riak_record/finder'
+require 'riak_record/base'
+
+module RiakRecord
+end

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.0.4 ruby lib
+# stub: riak-record 0.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "riak-record"
-  s.version = "0.0.4"
+  s.version = "0.1.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-18"
+  s.date = "2014-09-23"
   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 = [
@@ -23,13 +23,21 @@ Gem::Specification.new do |s|
     ".rspec",
     "Gemfile",
     "Gemfile.lock",
+    "Guardfile",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
+    "TODO.md",
     "VERSION",
-    "lib/riak-record.rb",
+    "lib/riak_record.rb",
+    "lib/riak_record/associations.rb",
+    "lib/riak_record/base.rb",
+    "lib/riak_record/finder.rb",
     "riak-record.gemspec",
-    "spec/riak-record_spec.rb",
+    "spec/riak_record/associations_spec.rb",
+    "spec/riak_record/base_spec.rb",
+    "spec/riak_record/finder_spec.rb",
+    "spec/riak_record_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/rgraff/riak-record"
@@ -47,6 +55,9 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<guard-rspec>, ["~> 4.3.1"])
+      s.add_development_dependency(%q<guard-bundler>, [">= 0"])
+      s.add_development_dependency(%q<terminal-notifier-guard>, [">= 0"])
     else
       s.add_dependency(%q<riak-client>, ["~> 2.0.0"])
       s.add_dependency(%q<rspec>, ["~> 3.1.0"])
@@ -54,6 +65,9 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<bundler>, ["~> 1.0"])
       s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
       s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<guard-rspec>, ["~> 4.3.1"])
+      s.add_dependency(%q<guard-bundler>, [">= 0"])
+      s.add_dependency(%q<terminal-notifier-guard>, [">= 0"])
     end
   else
     s.add_dependency(%q<riak-client>, ["~> 2.0.0"])
@@ -62,6 +76,9 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>, ["~> 1.0"])
     s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
     s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<guard-rspec>, ["~> 4.3.1"])
+    s.add_dependency(%q<guard-bundler>, [">= 0"])
+    s.add_dependency(%q<terminal-notifier-guard>, [">= 0"])
   end
 end