cassandra-model 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tien Le
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,56 @@
+= cassandra-model
+
+Simple model support for Cassandra (http://github.com/fauna/cassandra)
+
+Currently, it supports:
+* Serialisation (_String_, _Integer_, _Float_, _Boolean_, _DateTime_, _JSON_)
+* Callbacks
+* Validations
+
+== Getting started
+
+  gem install cassandra-model
+
+== Define
+  require 'cassandra-model'
+
+  class User << CassandraModel::Base
+    column_family :Users
+
+    key :username
+    column :full_name
+    column :created, :datetime
+    column :profile, :json
+
+    write_consistency_level Cassandra::Consistency::ALL
+    before_save :set_created_at
+
+    validation do
+      errors << "full name required" if full_name.blank?
+    end
+
+  private
+
+    def set_created_at
+      self.created = Time.now
+    end
+  end
+
+
+== CRUD
+  User.create(:username => 'foo', :full_name => 'foo bar')
+
+  foo = User.new(:username => 'foo', :full_name => 'foo bar')
+  foo.save
+
+  foo.full_name = 'foo baz'
+  foo.save
+
+  foo = User['foo']
+  foo = User.get('foo')
+
+  foo.destroy
+
+== Copyright
+
+Copyright (c) 2010 Tien Le. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,90 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cassandra-model"
+    gem.summary = %Q{Minimal models for Cassandra.}
+    gem.description = %Q{Cassandra-model allows you to map ColumnFamily/SuperColumnFamily in Cassandra to Ruby objects. It was designed to be fast and simple.}
+    gem.email = "tienlx /at/ gmail /dot/ com"
+    gem.homepage = "http://github.com/tienle/cassandra-model"
+    gem.authors = ["Tien Le"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "cassandra", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cassandra-model #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+CASSANDRA_HOME = ENV["CASSANDRA_HOME"] || "#{ENV["HOME"]}/apache-cassandra-0.6.0"
+CASSANDRA_PID  = ENV["CASSANDRA_PID"] || "/tmp/cassandra.pid".freeze
+
+cassandra_env = ""
+cassandra_env << "CASSANDRA_INCLUDE=#{File.expand_path(Dir.pwd)}/test/config/cassandra.in.sh "
+cassandra_env << "CASSANDRA_HOME=#{CASSANDRA_HOME} "
+cassandra_env << "CASSANDRA_CONF=#{File.expand_path(Dir.pwd)}/test/config"
+
+namespace :cassandra do
+  desc "Start cassandra"
+  task :start do
+    Dir.chdir(CASSANDRA_HOME) do
+      sh("env #{cassandra_env} bin/cassandra -f -p #{CASSANDRA_PID}")
+    end
+  end
+
+  desc "Stop cassandra"
+  task :stop do
+    system "kill -9 `cat #{CASSANDRA_PID}`"
+  end
+
+  desc "Restart cassandra"
+  task :restart => [:stop, :start]
+
+  desc "Clear test data"
+  task :clear_test_data do
+    unless defined?(CassandraModel)
+      $: << 'test'
+      require 'test_helper'
+    end
+    CassandraModel::Base.establish_connection('CassandraModel').clear_keyspace!
+  end
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/cassandra-model.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cassandra-model}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tien Le"]
+  s.date = %q{2010-11-28}
+  s.description = %q{Cassandra-model allows you to map ColumnFamily/SuperColumnFamily in Cassandra to Ruby objects. It was designed to be fast and simple.}
+  s.email = %q{tienlx /at/ gmail /dot/ com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "cassandra-model.gemspec",
+     "lib/cassandra-model.rb",
+     "lib/cassandra-model/base.rb",
+     "lib/cassandra-model/callbacks.rb",
+     "lib/cassandra-model/persistence.rb",
+     "lib/cassandra-model/types.rb",
+     "test/base_test.rb",
+     "test/callbacks_test.rb",
+     "test/cassandra_model_test.rb",
+     "test/config/cassandra.in.sh",
+     "test/config/log4j-tools.properties",
+     "test/config/log4j.properties",
+     "test/config/storage-conf.xml",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/tienle/cassandra-model}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Minimal models for Cassandra.}
+  s.test_files = [
+    "test/base_test.rb",
+     "test/test_helper.rb",
+     "test/cassandra_model_test.rb",
+     "test/callbacks_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<cassandra>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<cassandra>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<cassandra>, [">= 0"])
+  end
+end
+

data/lib/cassandra-model.rb

@@ -0,0 +1,27 @@
+require 'cassandra'
+require 'forwardable'
+require 'date'
+
+$:.unshift(File.dirname(__FILE__))
+
+module CassandraModel
+  class CassandraModelError < StandardError;       end
+  class UnknownRecord       < CassandraModelError; end
+  class InvalidRecord       < CassandraModelError; end
+  class RecordNotFound      < CassandraModelError; end
+end
+
+unless Object.respond_to? :tap
+  class Object
+    def tap(value)
+      yield(value)
+      value
+    end
+  end
+end
+
+require 'cassandra-model/types'
+require 'cassandra-model/callbacks'
+require 'cassandra-model/persistence'
+require 'cassandra-model/base'
+

data/lib/cassandra-model/base.rb

@@ -0,0 +1,94 @@
+module CassandraModel
+  class Base
+    extend Forwardable
+    include CassandraModel::Callbacks
+    include CassandraModel::Persistence
+
+    def_delegators :self.class, :connection, :connection=
+    define_callbacks :save, :create, :update, :destroy
+
+    class << self
+      def establish_connection(*args)
+        @connection = Cassandra.new(*args)
+      end
+
+      def connection
+        @connection || (superclass.connection if superclass)
+      end
+
+      def column_family(name = nil)
+        @column_family || (@column_family = name || self.name.split('::').last)
+      end
+
+      def key(name)
+        class_eval "def #{name}=(value); @key = value.to_s; end"
+      end
+
+      def column(name, type = :string)
+        columns[name] = type
+        class_eval "def #{name}; #{type.capitalize}Type.load(@attributes['#{name}']); end"
+
+        if type == :string || type == :integer || type == :float
+          class_eval "def #{name}=(value); @attributes['#{name}'] = value.to_s; end"
+        else
+          class_eval "def #{name}=(value); @attributes['#{name}'] = #{type.capitalize}Type.dump(value); end"
+        end
+      end
+
+      def validate(&block)
+        raise ArgumentError.new('provide a block that does validation') unless block_given?
+        @validation = block
+      end
+
+      def validation
+        @validation
+      end
+
+      def columns
+        @columns ||= {}
+      end
+
+    private
+
+      def inherited(child)
+        child.instance_variable_set('@connection', @connection)
+        super
+      end
+    end
+
+    attr_accessor :new_record
+    attr_reader :key, :attributes, :errors
+
+    def initialize(attrs = {}, convert = true)
+      @new_record = true
+      @errors     = []
+      @attributes = {}
+      if convert
+        self.attributes = attrs
+      else
+        @attributes     = attrs
+      end
+    end
+
+    def attributes=(attrs)
+      attrs.each {|k, v| send("#{k}=", v) if respond_to? "#{k}=".to_sym }
+    end
+
+    def valid?
+      @errors << "key required" if key.to_s !~ /\S/
+      self.instance_eval(&self.class.validation) unless self.class.validation.nil?
+      @errors.empty?
+    end
+
+    def new_record?
+      @new_record
+    end
+
+    def ==(other)
+      true
+    end
+
+    alias :eql? ==
+  end
+
+end

data/lib/cassandra-model/callbacks.rb

@@ -0,0 +1,49 @@
+module CassandraModel
+  module Callbacks
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    module ClassMethods
+      def define_callbacks(*callbacks)
+        callbacks.each do |callback|
+          [:before, :after].each do |chain|
+            callback_name = "#{chain}_#{callback}"
+            instance_eval <<-EVAL, __FILE__, __LINE__ + 1
+              def #{callback_name}(*args)
+                callbacks[:#{callback_name}] += args
+              end
+            EVAL
+          end
+        end
+      end
+
+      def callbacks
+        @callbacks ||= Hash.new {|h, k| h[k] = [] }
+      end
+    end
+
+    module InstanceMethods
+      def run_callbacks(name, &block)
+        _run_callbacks(:before, name)
+        result = block.call
+        _run_callbacks(:after, name, result)
+        result
+      end
+
+      private
+      def _run_callbacks(chain, name, value = nil)
+        callback_name = "#{chain}_#{name}".to_sym
+        self.class.callbacks[callback_name].each do |callback|
+          next unless callback.is_a? Symbol
+          if self.class.instance_method(callback).arity > 0
+            self.send(callback, value)
+          else
+            self.send(callback)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cassandra-model/persistence.rb

@@ -0,0 +1,112 @@
+module CassandraModel
+  module Persistence
+    def self.included(base)
+      base.extend ClassMethods
+      base.send :include, InstanceMethods
+    end
+
+    module InstanceMethods
+      def save
+        return self unless valid?
+        run_callbacks :save do
+          callback = new_record? ? :create : :update
+          run_callbacks callback do
+            write(attributes)
+          end
+        end
+      end
+
+      def destroy
+        run_callbacks :destroy do
+          self.class.remove(key)
+        end
+      end
+
+      def reload
+        self.class.get(key)
+      end
+
+      def update_attributes(attrs)
+        attributes = attrs
+        save
+      end
+
+      def remove_attributes(attrs)
+        attrs.each {|attr| self.class.remove_column(key, attr) }
+      end
+
+    private
+
+      def write(attrs)
+        self.class.write(key, attrs)
+        @new_record = false
+      end
+    end
+
+    module ClassMethods
+      attr_writer :write_consistency_level, :read_consistency_level
+
+      def write_consistency_level(level)
+        @write_consistency_level = level
+      end
+
+      def read_consistency_level(level)
+        @read_consistency_level = level
+      end
+
+      def get(key, options = {})
+        attrs = connection.get(column_family, key, options)
+        return nil if attrs.empty?
+        new(attrs, false).tap do |object|
+          object.new_record = false
+        end
+      end
+
+      alias :find :get
+
+      def [](key)
+        record = get(key)
+        raise RecordNotFound, "cannot find out key=`#{key}` in `#{column_family}`" unless record
+        record
+      end
+
+      def exists?(key)
+        #connection.exists?(column_family, key)
+        !connection.get(column_family, key).empty?
+      end
+
+      def all(keyrange = ''..'', options = {})
+        results = connection.get_range(column_family, :start => keyrange.first,
+                                       :finish => keyrange.last, :count => (options[:limit] || 100))
+        keys = results.map(&:key)
+        keys.map {|key| get(key) }
+      end
+
+      def first(keyrange = ''..'', options = {})
+        all(keyrange, options.merge(:limit => 1)).first
+      end
+
+      def create(attributes)
+        new(attributes).tap do |object|
+          object.save
+        end
+      end
+
+      def write(key, attributes)
+        connection.insert(column_family, key, attributes,
+                          :consistency => @write_consistency_level || Cassandra::Consistency::QUORUM)
+        key
+      end
+
+      def remove(key)
+        connection.remove(column_family, key,
+                          :consistency => @write_consistency_level || Cassandra::Consistency::QUORUM)
+      end
+
+      def remove_column(key, column)
+        connection.remove(column_family, key, column,
+                          :consistency => @write_consistency_level || Cassandra::Consistency::QUORUM)
+      end
+    end
+  end
+end