gotime-cassandra_object 2.1.2 → 2.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gotime-cassandra_object (2.1.1)
+    gotime-cassandra_object (2.1.2)
       cassandra (~> 0.11.3)
       rails (~> 3.0)
 

data/README.markdown

@@ -1,79 +1,8 @@
 # Cassandra Object
 
-Cassandra Object provides a nice API for working with [Cassandra](http://incubator.apache.org/cassandra/). CassandraObjects are mostly duck-type compatible with ActiveRecord objects so most of your controller code should work ok.  Note that they're *mostly* compatible, Cassandra has no support for dynamic queries, or sorting.  So the following kinds of operations aren't supported and *never will be*.
+Cassandra Object provides a API for working with [Cassandra](http://incubator.apache.org/cassandra/).
 
-* `:order`
-* `:conditions`
-* `:joins`
-* `:group`
-
-There isn't much in the way of documentation yet, but a few examples.
+Example:
 
         class Customer < CassandraObject::Base
-          attribute :first_name,    :type => :string
-          attribute :last_name,     :type => :string
-          attribute :date_of_birth, :type => :date
-          attribute :signed_up_at,  :type => :time_with_zone
-    
-          validate :should_be_cool
-    
-          key :uuid
-  
-          index :date_of_birth
-  
-          association :invoices, :unique=>false, :inverse_of=>:customer
-
-          private
-  
-          def should_be_cool
-            unless ["Michael", "Anika", "Evan", "James"].include?(first_name)
-              errors.add(:first_name, "must be that of a cool person")
-            end
-          end
-        end
-
-        class Invoice < CassandraObject::Base
-          attribute :number, :type=>:integer
-          attribute :total, :type=>:float
-          attribute :gst_number, :type=>:string
-  
-          # indexes can have a single entry also.
-          index :number, :unique=>true
-  
-          # bi-directional associations with read-repair support.
-          association :customer, :unique=>true, :inverse_of=>:invoices
-  
-          # Read migration support
-          migrate 1 do |attrs|
-            attrs["total"] ||= rand(2000) / 100.0
-          end
-  
-          migrate 2 do |attrs|
-            attrs["gst_number"] = "66-666-666"
-          end
-  
-          key :natural, :attributes => :number
         end
-        
-        @invoice = Invoice.get("12345")
-        @invoice.customer.invoices.all.include?(@invoice) # true
-        
-# FAQ
-
-## How do I make this work?
-
-Here are some basic directions:
-
-  1. `git clone git://github.com/NZKoz/cassandra_object.git`
-  2. Run the bundler `gem bundle`
-  3. Make sure the tests pass `rake test`
-
-This gem has backwards compatibility with active support version 2.3.x,  this is to enable people to use it with rails 2.3 applications.  This backwards compatibility may not continue after the 1.0 release.
-
-## Should I use this in production?
-
-Only if you're looking to help out with the development, there are a bunch of rough edges right now.
-
-## Why do you use a superclass and not a module.
-
-Because.

data/gotime-cassandra_object.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'gotime-cassandra_object'
-  s.version = '2.1.2'
+  s.version = '2.2.0'
   s.description = 'Cassandra ActiveModel'
   s.summary = 'Cassandra ActiveModel'
 

data/lib/cassandra_object.rb

@@ -6,6 +6,7 @@ module CassandraObject
   autoload :Base
   autoload :Connection
   autoload :Attributes
+  autoload :PrimaryKey
   autoload :Dirty
   autoload :Consistency
   autoload :Persistence

data/lib/cassandra_object/base.rb

@@ -3,6 +3,7 @@ require 'set'
 
 require 'cassandra_object/log_subscriber'
 require 'cassandra_object/types'
+require 'cassandra_object/errors'
 
 module CassandraObject
   class Base
@@ -28,10 +29,11 @@ module CassandraObject
     extend ActiveSupport::DescendantsTracker
     
     include Connection
-    include Callbacks
+    include PrimaryKey
     include Identity
     include Attributes
     include Persistence
+    include Callbacks
     include Indexes
     include Dirty
     include Validation

data/lib/cassandra_object/callbacks.rb

@@ -6,5 +6,22 @@ module CassandraObject
       extend ActiveModel::Callbacks
       define_model_callbacks :save, :create, :destroy, :update
     end
+
+    def destroy #:nodoc:
+      _run_destroy_callbacks { super }
+    end
+
+    private
+      def create_or_update #:nodoc:
+        _run_save_callbacks { super }
+      end
+
+      def create #:nodoc:
+        _run_create_callbacks { super }
+      end
+
+      def update(*) #:nodoc:
+        _run_update_callbacks { super }
+      end
   end
 end

data/lib/cassandra_object/errors.rb

@@ -0,0 +1,10 @@
+module CassandraObject
+  class CasssandraObjectError < StandardError
+  end
+
+  class RecordNotSaved < CasssandraObjectError
+  end
+  
+  class RecordNotFound < CasssandraObjectError
+  end
+end

data/lib/cassandra_object/finder_methods.rb

@@ -2,6 +2,14 @@ module CassandraObject
   module FinderMethods
     extend ActiveSupport::Concern
     module ClassMethods
+      def find(key)
+        if parse_key(key) && attributes = connection.get(column_family, key)
+          instantiate(key, attributes)
+        else
+          raise CassandraObject::RecordNotFound
+        end
+      end
+
       def all(options = {})
         options = {:consistency => self.read_consistency, :limit => 100}.merge(options)
         count = options[:limit]

data/lib/cassandra_object/identity/uuid_key_factory.rb

@@ -25,6 +25,8 @@ module CassandraObject
       # Parse should create a new key object from the 'to_param' format
       def parse(string)
         UUID.new(string)
+      rescue
+        nil
       end
       
       # create should create a new key object from the cassandra format.

data/lib/cassandra_object/persistence.rb

@@ -89,62 +89,78 @@ module CassandraObject
       def column_family_configuration
         [{:Name => column_family, :CompareWith => "UTF8Type"}]
       end
+    end
 
+    def new_record?
+      @new_record
     end
 
-    def save(options={})
-      _run_save_callbacks do
-        create_or_update
-      end
+    def destroyed?
+      @destroyed
     end
-    
-    def create_or_update
-      result = persisted? ? update : create
-      result != false
+
+    def persisted?
+      !(new_record? || destroyed?)
     end
-    
-    def create
-      _run_create_callbacks do
-        @key ||= self.class.next_key(self)
-        _write
-        @new_record = false
-        @key
+
+    def save(*)
+      begin
+        create_or_update
+      rescue CassandraObject::RecordInvalid
+        false
       end
     end
-    
-    def update
-      _run_update_callbacks do
-        _write
-      end
+
+    def save!
+      create_or_update || raise(RecordNotSaved)
     end
-    
-    def _write
-      changed_attributes = changed.inject({}) { |h, n| h[n] = read_attribute(n); h }
-      self.class.write(key, changed_attributes, schema_version)
+
+    def destroy
+      self.class.remove(key)
+      @destroyed = true
+      freeze
     end
 
-    def new_record?
-      @new_record
+    def update_attribute(name, value)
+      name = name.to_s
+      send("#{name}=", value)
+      save(:validate => false)
     end
 
-    def destroyed?
-      @destroyed
+    def update_attributes(attributes)
+      self.attributes = attributes
+      save
     end
 
-    def persisted?
-      !(new_record? || destroyed?)
+    def update_attributes!(attributes)
+      self.attributes = attributes
+      save!
     end
 
-    def destroy
-      _run_destroy_callbacks do 
-        self.class.remove(key)
-        @destroyed = true
-        freeze
-      end
+    def reload
+      @attributes.update(self.class.find(self.id).instance_variable_get('@attributes'))
     end
+
+    private
+      def create_or_update
+        result = new_record? ? create : update
+        result != false
+      end
+
+      def create
+        @key ||= self.class.next_key(self)
+        write
+        @new_record = false
+        @key
+      end
     
-    def reload
-      self.class.get(self.key)
-    end  
+      def update
+        write
+      end
+
+      def write
+        changed_attributes = changed.inject({}) { |h, n| h[n] = read_attribute(n); h }
+        self.class.write(key, changed_attributes, schema_version)
+      end
   end
 end

data/lib/cassandra_object/primary_key.rb

@@ -0,0 +1,12 @@
+module CassandraObject
+  module PrimaryKey
+    def id
+      key.to_s
+    end
+
+    def id=(key)
+      self.key = self.class.parse_key(key)
+      id
+    end
+  end
+end

data/lib/cassandra_object/validation.rb

@@ -25,7 +25,7 @@ module CassandraObject
         new(attributes).tap &:save!
       end
     end
-    
+
     def valid?
       run_callbacks :validation do
         super

data/test/finder_methods_test.rb

@@ -1,11 +1,17 @@
 require 'test_helper'
 
 class CassandraObject::FinderMethodsTest < CassandraObject::TestCase
-  test 'first' do
-    first_issue = Issue.create
-    second_issue = Issue.create
+  test 'find' do
+    persisted_issue = Issue.create
+    found_issue = Issue.find(persisted_issue.id)
 
-    assert [first_issue, second_issue].include?(Issue.first)
+    assert_equal persisted_issue, found_issue
+  end
+
+  test 'find missing record' do
+    assert_raise CassandraObject::RecordNotFound do
+      Issue.find('what')
+    end
   end
 
   test 'all' do
@@ -15,6 +21,13 @@ class CassandraObject::FinderMethodsTest < CassandraObject::TestCase
     assert_equal [first_issue, second_issue].to_set, Issue.all.to_set
   end
 
+  test 'first' do
+    first_issue = Issue.create
+    second_issue = Issue.create
+
+    assert [first_issue, second_issue].include?(Issue.first)
+  end
+
   test 'find_with_ids' do
     first_issue = Issue.create
     second_issue = Issue.create

data/test/identity_test.rb

@@ -1,6 +1,16 @@
 require 'test_helper'
 
 class CassandraObject::IdentityTest < CassandraObject::TestCase
+  test 'parse_key' do
+    # p "Issue.parse_key('bb4cbbbc-b7c7-11e0-9ca2-732604ff41fe') = #{Issue.parse_key('bb4cbbbc-b7c7-11e0-9ca2-732604ff41fe').class}"
+    assert_kind_of(
+      CassandraObject::Identity::UUIDKeyFactory::UUID,
+      Issue.parse_key('bb4cbbbc-b7c7-11e0-9ca2-732604ff41fe')
+    )
+    
+    assert_nil Issue.parse_key('fail')
+  end
+
   test 'equality of new records' do
     assert_not_equal Issue.new, Issue.new
   end

data/test/persistence_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class CassandraObject::PersistenceTest < CassandraObject::TestCase
-  test 'persisted' do
+  test 'persistance inquiries' do
     issue = Issue.new
     assert issue.new_record?
     assert !issue.persisted?
@@ -9,9 +9,76 @@ class CassandraObject::PersistenceTest < CassandraObject::TestCase
     issue.save
     assert issue.persisted?
     assert !issue.new_record?
+  end
+
+  test 'save' do
+    issue = Issue.new
+    issue.save
+
+    assert_equal issue, Issue.find(issue.id)
+  end
 
+  test 'save!' do
+    begin
+      Issue.validates(:description, presence: true)
+
+      issue = Issue.new(description: 'bad')
+      issue.save!
+
+      issue = Issue.new
+      assert_raise(CassandraObject::RecordInvalid) { issue.save! }
+    ensure
+      Issue.reset_callbacks(:validate)
+    end
+  end
+
+  test 'destroy' do
+    issue = Issue.create
     issue.destroy
+ 
     assert issue.destroyed?
     assert !issue.persisted?
+    assert !issue.new_record?
+  end
+
+  test 'update_attribute' do
+    issue = Issue.create
+    issue.update_attribute(:description, 'lol')
+
+    assert !issue.changed?
+    assert_equal 'lol', issue.description
+  end
+  
+  test 'update_attributes' do
+    issue = Issue.create
+    issue.update_attributes(description: 'lol')
+
+    assert !issue.changed?
+    assert_equal 'lol', issue.description
+  end
+
+  test 'update_attributes!' do
+    begin
+      Issue.validates(:description, presence: true)
+
+      issue = Issue.new(description: 'bad')
+      issue.save!
+      
+      assert_raise CassandraObject::RecordInvalid do
+        issue.update_attributes! description: ''
+      end
+    ensure
+      Issue.reset_callbacks(:validate)
+    end
+  end
+
+  test 'reload' do
+    persisted_issue = Issue.create
+    fresh_issue = Issue.find(persisted_issue.id)
+    fresh_issue.update_attribute(:description, 'say what')
+
+    assert_nil persisted_issue.description
+    persisted_issue.reload
+    assert_equal 'say what', persisted_issue.description
   end
 end

data/test/primary_key_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+class CassandraObject::PrimaryKeyTest < CassandraObject::TestCase
+  test 'id' do
+    issue = Issue.create
+
+    assert_equal issue.key.to_s, issue.id
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gotime-cassandra_object
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2011-07-26 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2153248160 !ruby/object:Gem::Requirement
+  requirement: &2152763200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *2153248160
+  version_requirements: *2152763200
 - !ruby/object:Gem::Dependency
   name: cassandra
-  requirement: &2153247700 !ruby/object:Gem::Requirement
+  requirement: &2152762740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 0.11.3
   type: :runtime
   prerelease: false
-  version_requirements: *2153247700
+  version_requirements: *2152762740
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2153247240 !ruby/object:Gem::Requirement
+  requirement: &2152762280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,7 +44,7 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2153247240
+  version_requirements: *2152762280
 description: Cassandra ActiveModel
 email: gems@gotime.com
 executables: []
@@ -60,7 +60,6 @@ files:
 - MIT-LICENSE
 - README.markdown
 - Rakefile
-- TODO
 - gotime-cassandra_object.gemspec
 - lib/cassandra_object.rb
 - lib/cassandra_object/associations.rb
@@ -75,6 +74,7 @@ files:
 - lib/cassandra_object/consistency.rb
 - lib/cassandra_object/cursor.rb
 - lib/cassandra_object/dirty.rb
+- lib/cassandra_object/errors.rb
 - lib/cassandra_object/finder_methods.rb
 - lib/cassandra_object/generators/migration_generator.rb
 - lib/cassandra_object/generators/templates/migration.rb.erb
@@ -91,6 +91,7 @@ files:
 - lib/cassandra_object/migrations/migration.rb
 - lib/cassandra_object/mocking.rb
 - lib/cassandra_object/persistence.rb
+- lib/cassandra_object/primary_key.rb
 - lib/cassandra_object/railtie.rb
 - lib/cassandra_object/schema.rb
 - lib/cassandra_object/schema/migration.rb
@@ -143,6 +144,7 @@ files:
 - test/finder_methods_test.rb
 - test/identity_test.rb
 - test/persistence_test.rb
+- test/primary_key_test.rb
 - test/test_helper.rb
 - test/timestamps_test.rb
 - test/types/array_type_test.rb
@@ -186,6 +188,7 @@ test_files:
 - test/finder_methods_test.rb
 - test/identity_test.rb
 - test/persistence_test.rb
+- test/primary_key_test.rb
 - test/test_helper.rb
 - test/timestamps_test.rb
 - test/types/array_type_test.rb

data/TODO

@@ -1,2 +0,0 @@
-* Support for alternate column names in associations and indexes
-* Support for compound keys for associations e.g. "#{customer_id}:#{invoice_date}"