fracassandra 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem "cassandra"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jeremy Tregunna
+
+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,40 @@
+= Fracassandra
+
+Fracassandra is an object mapper for the Cassandra database.
+
+It's currently not ready for prime time, as super column family support is not available yet. It also
+does not support adjusting the row/key cache sizes, how columns are sorted, etc.
+
+== Example usage
+
+It can be used in familiar ways, for instance:
+
+  class User < Fracassandra::Model
+    column_family :Users
+    
+    attribute :username, :key => true
+    attribute :password
+    attribute :salt
+    attribute :email
+  end
+
+This will create a class suitable for use with the Cassandra mapping, using the username as the key to the
+column family, storing a bunch of columns (password, salt and email respectively). Each attribute will respond
+to a getter with the same name, and a setter with the same name. One exception is the :key attribute, which
+is immutable, and cannot be modified. As such, an exception is thrown if you try and use the setter.
+
+== Contributing to Fracassandra
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Jeremy Tregunna. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fracassandra"
+  gem.homepage = "http://github.com/jeremytregunna/fracassandra"
+  gem.license = "MIT"
+  gem.summary = %Q{Simple object mapper for Cassandra}
+  gem.description = %Q{Hook your cassandra column families into ruby classes, mapping your rows to objects.}
+  gem.email = "jeremy.tregunna@me.com"
+  gem.authors = ["Jeremy Tregunna"]
+  gem.add_runtime_dependency 'cassandra', '>= 0'
+  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+#require 'spec/rake/spectask'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fracassandra #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/fracassandra/model.rb

@@ -0,0 +1,95 @@
+# Frac.as Cassandra Library
+# Copyright © 2011, Jeremy Tregunna, All Rights Reserved.
+
+module Fracassandra
+  
+  # This class covers a regular column family. If you need super column family support, you will
+  # want to look for the SuperModel class.
+  class Model
+    attr_reader :key
+    
+    def initialize(key=nil, defaults={})
+      if key
+        @key = key.to_s
+      else
+        r = @@attributes.select { |k,v| v[:key] == true }[0]
+        raise "Invalid key error. No key was given in either the model or as an argument to new" if r.nil?
+        @key = r[0]
+      end
+      
+      defaults.each_pair do |attribute, value|
+        self.send(:"#{attribute}=", value)
+      end
+    end
+    
+    def self.create(key=nil, defaults={})
+      self.new(key, defaults)
+    end
+    
+    def self.[](key)
+      raise DatabaseError, "No database defined. Please set Frassandra.database= to a Cassandra connection." unless $cassandra
+      raise DatabaseError, "No column family defined. Please edit your model." unless @@column_family_name
+      
+      t = Fracassandra::database.get(@@column_family_name, key)
+      return nil if t.nil?
+      r = self.new
+      t.each_pair do |k, v|
+        r.send(:"#{k}=", v)
+      end
+      r
+    end
+    
+    def self.attribute(name, options={})
+      @@attributes ||= {}
+      @@attributes[name.to_s] = options
+    end
+    
+    def self.column_family(column_family_name)
+      @@column_family_name = column_family_name.to_s
+    end
+    
+    def save
+      raise DatabaseError, "No database defined. Please set Frassandra.database= to a Cassandra connection." unless $cassandra
+      raise DatabaseError, "No column family defined. Please edit your model." unless @@column_family_name
+      
+      h = {}
+      @@attributes.each_pair do |attribute_name, hash|
+        next if hash[:key]
+        hash.each_pair do |key, value|
+          h[attribute_name] = (key == :value) ? value : nil
+        end
+      end
+      
+      Fracassandra::database.insert(@@column_family_name, key, h)
+    end
+    
+    def destroy
+      Fracassandra::database.remove(@@column_family_name, key)
+    end
+    
+    def eql?(other)
+      @@attributes.each_pair do |attribute_name, hash|
+        return false unless send(attribute_name.to_s).eql? other.send(attribute_name.to_s)
+      end
+      true
+    end
+    
+    def method_missing(sym, *args, &blk)
+      name = sym.to_s
+      
+      if @@attributes.keys.include?(name.sub(/=$/, '').to_s)
+        attribute = @@attributes[name.sub(/=$/, '').to_s]
+        if name.include?("=")
+          raise DatabaseError, "Key values are immutable, don't try and change them." if attribute[:key] && attribute[:value]
+          opts = attribute
+          opts[:value] = args[0]
+          @key = opts[:value] if opts[:key]
+        else
+          @@attributes[name.to_s][:value]
+        end
+      else
+        super
+      end
+    end
+  end
+end

data/lib/fracassandra/super_model.rb

@@ -0,0 +1,10 @@
+# Frac.as Cassandra Library
+# Copyright © 2011, Jeremy Tregunna, All Rights Reserved.
+
+module Fracassandra
+  
+  # Super column family... Not done yet.
+  class SuperModel
+    attr_reader :key
+  end
+end

data/lib/fracassandra.rb

@@ -0,0 +1,22 @@
+# Frac.as Cassandra Library
+# Copyright © 2011, Jeremy Tregunna, All Rights Reserved.
+
+FRACASSANDRA_VERSION = "0.1.0"
+
+require 'fracassandra/model'
+require 'fracassandra/super_model'
+
+module Fracassandra
+  $cassandra = nil
+  
+  def self.database=(db)
+    $cassandra = db
+  end
+  
+  def self.database
+    $cassandra
+  end
+  
+  class DatabaseError < Exception
+  end
+end

data/spec/model_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'cassandra/0.7'
+
+class User < Fracassandra::Model
+  column_family :Users
+  
+  attribute :username, :key => true
+  attribute :password
+  attribute :salt
+  attribute :email
+end
+
+describe "A user record" do
+  before(:all) do
+    Fracassandra.database = Cassandra.new("Twitter")
+  end
+  
+  it "creates a valid user record with minimal data" do
+    u = User.create("jeremytregunna", {
+      'password' => "foobar",
+      'salt' => "2F37B7B2-18F9-47BB-8D60-AEFF7275EF87",
+      'email' => "jeremy.tregunna@me.com"
+    })
+    u.should_not be_nil
+  end
+  
+  it "saves the record and can find it afterwards" do
+    u1 = User.create("jeremytregunna", {
+      'password' => "foobar",
+      'salt' => "2F37B7B2-18F9-47BB-8D60-AEFF7275EF87",
+      'email' => "jeremy.tregunna@me.com"
+    })
+    u1.save
+    u2 = User["jtregunna"]
+    u2.should.eql? u1
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'fracassandra'

metadata

@@ -0,0 +1,182 @@
+--- !ruby/object:Gem::Specification 
+name: fracassandra
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeremy Tregunna
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-15 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cassandra
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  type: :development
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  prerelease: false
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  type: :development
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: cassandra
+  type: :runtime
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 2
+        - 3
+        version: 1.2.3
+  prerelease: false
+  requirement: *id007
+description: Hook your cassandra column families into ruby classes, mapping your rows to objects.
+email: jeremy.tregunna@me.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/fracassandra.rb
+- lib/fracassandra/model.rb
+- lib/fracassandra/super_model.rb
+- spec/model_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/jeremytregunna/fracassandra
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Simple object mapper for Cassandra
+test_files: 
+- spec/model_spec.rb
+- spec/spec_helper.rb