cql-model 0.3.0

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p392

data/Gemfile

@@ -0,0 +1,17 @@
+source "https://rubygems.org"
+
+# Runtime dependencies
+gem "cql-rb", "~> 1.0.0.pre4"
+
+# Gems used during test and development
+group :development do
+  gem "rake", "~> 0.9"
+  gem "rspec", "~> 2.0"
+  gem "cucumber", "~> 1.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "debugger"
+  gem "rdoc", ">= 2.4.2"
+  gem "flexmock", "~> 0.8"
+  gem "syntax", "~> 1.0.0" #rspec will syntax-highlight code snippets if this gem is available
+  gem "nokogiri", "~> 1.5"
+end

data/Gemfile.lock

@@ -0,0 +1,56 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.1.4)
+    columnize (0.3.6)
+    cql-rb (1.0.0.pre4)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    debugger (1.5.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.0)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.0)
+    diff-lcs (1.1.3)
+    flexmock (0.9.0)
+    gherkin (2.11.6)
+      json (>= 1.7.6)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    nokogiri (1.5.9)
+    rake (0.9.6)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+    syntax (1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cql-rb (~> 1.0.0.pre4)
+  cucumber (~> 1.0)
+  debugger
+  flexmock (~> 0.8)
+  jeweler (~> 1.8.3)
+  nokogiri (~> 1.5)
+  rake (~> 0.9)
+  rdoc (>= 2.4.2)
+  rspec (~> 2.0)
+  syntax (~> 1.0.0)

data/README.md

@@ -0,0 +1,24 @@
+Overview
+========
+
+[![Build Status](https://travis-ci.org/xeger/cql-model.png?branch=master)](https://travis-ci.org/xeger/cql-model)
+
+TODO
+
+To-Do List
+==========
+
+## Features
+
+* Add support for Time and other obvious Cassandra data types
+* Using-keyspace override
+* Declaration, read and write of set/list/map properties
+* Batch mutations
+* Notation for composite partition key (CompositeType), e.g. `primary_key [:id, :surname], :first_name`
+* Prepared statement support for SELECT & named scopes
+* Prepared statement support for INSERT/UPDATE
+
+## Usability / Correctness / Performance
+
+* Better solution for using and switching namespaces -- thread/fiber safety
+* Better use of cql-rb connection pooling

data/Rakefile

@@ -0,0 +1,54 @@
+# -*-ruby-*-
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rake'
+require 'rdoc/task'
+require 'rubygems/package_task'
+
+require 'rake/clean'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+require 'jeweler'
+
+task :default => [:cucumber, :spec]
+
+desc "Run unit tests"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = Dir['spec/**/*_spec.rb']
+end
+
+desc "Run functional tests"
+Cucumber::Rake::Task.new do |t|
+  t.cucumber_opts = %w{--color --format pretty}
+end
+
+desc 'Generate documentation for the cql-model gem.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'Cql'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.exclude('features/**/*')
+  rdoc.rdoc_files.exclude('spec/**/*')
+end
+
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification; see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name                  = "cql-model"
+  gem.required_ruby_version = ">= 1.9.0"
+  gem.homepage              = "https://github.com/xeger/cql-model"
+  gem.license               = "MIT"
+  gem.summary               = %Q{Cassandra CQL model.}
+  gem.description           = %Q{Lightweight, performant OOP wrapper for Cassandra tables; inspired by DataMapper.}
+  gem.email                 = "gemspec@tracker.xeger.net"
+  gem.authors               = ['Tony Spataro']
+  gem.files.exclude 'features/**/*'
+  gem.files.exclude 'spec/**/*'
+end
+
+Jeweler::RubygemsDotOrgTasks.new
+
+CLEAN.include('pkg')

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/cql-model.gemspec

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "cql-model"
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tony Spataro"]
+  s.date = "2013-04-24"
+  s.description = "Lightweight, performant OOP wrapper for Cassandra tables; inspired by DataMapper."
+  s.email = "gemspec@tracker.xeger.net"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".ruby-version",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "cql-model.gemspec",
+    "cql_model.rconf",
+    "lib/cql/model.rb",
+    "lib/cql/model/dsl.rb",
+    "lib/cql/model/query.rb",
+    "lib/cql/model/query/comparison_expression.rb",
+    "lib/cql/model/query/expression.rb",
+    "lib/cql/model/query/insert_statement.rb",
+    "lib/cql/model/query/mutation_statement.rb",
+    "lib/cql/model/query/select_statement.rb",
+    "lib/cql/model/query/statement.rb",
+    "lib/cql/model/query/update_expression.rb",
+    "lib/cql/model/query/update_statement.rb"
+  ]
+  s.homepage = "https://github.com/xeger/cql-model"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.0")
+  s.rubygems_version = "1.8.23"
+  s.summary = "Cassandra CQL model."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<cql-rb>, ["~> 1.0.0.pre4"])
+      s.add_development_dependency(%q<rake>, ["~> 0.9"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.0"])
+      s.add_development_dependency(%q<cucumber>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<debugger>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, [">= 2.4.2"])
+      s.add_development_dependency(%q<flexmock>, ["~> 0.8"])
+      s.add_development_dependency(%q<syntax>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<nokogiri>, ["~> 1.5"])
+    else
+      s.add_dependency(%q<cql-rb>, ["~> 1.0.0.pre4"])
+      s.add_dependency(%q<rake>, ["~> 0.9"])
+      s.add_dependency(%q<rspec>, ["~> 2.0"])
+      s.add_dependency(%q<cucumber>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<debugger>, [">= 0"])
+      s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+      s.add_dependency(%q<flexmock>, ["~> 0.8"])
+      s.add_dependency(%q<syntax>, ["~> 1.0.0"])
+      s.add_dependency(%q<nokogiri>, ["~> 1.5"])
+    end
+  else
+    s.add_dependency(%q<cql-rb>, ["~> 1.0.0.pre4"])
+    s.add_dependency(%q<rake>, ["~> 0.9"])
+    s.add_dependency(%q<rspec>, ["~> 2.0"])
+    s.add_dependency(%q<cucumber>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<debugger>, [">= 0"])
+    s.add_dependency(%q<rdoc>, [">= 2.4.2"])
+    s.add_dependency(%q<flexmock>, ["~> 0.8"])
+    s.add_dependency(%q<syntax>, ["~> 1.0.0"])
+    s.add_dependency(%q<nokogiri>, ["~> 1.5"])
+  end
+end
+

data/cql_model.rconf

@@ -0,0 +1,11 @@
+# Configuration settings for Cql
+ruby do
+  version  'ruby-1.9.3-p392'
+end
+bundler do
+  version '1.2.1'
+end
+cassandra do
+  version '1.1.10'
+end
+

data/lib/cql/model.rb

@@ -0,0 +1,49 @@
+require 'thread'
+require 'cql'
+
+module Cql::Model
+  # Raised if the user calls DSL that cannot generate valid CQL
+  class SyntaxError < Exception; end
+
+  # Raised if an insert statement does not specify all the primary keys
+  # or if an update statement does not specify any key (part of a composite primary key or a primary key)
+  class MissingKey < Exception; end
+
+  # Type aliases for use with the property-declaration DSL.
+  Uuid = Cql::Uuid
+  UUID = Uuid
+
+  # Type alias for use with the property-declaration DSL.
+  Boolean = TrueClass
+
+end
+
+require 'cql/model/query'
+require 'cql/model/class_methods'
+require 'cql/model/instance_methods'
+
+module Cql::Model
+  def self.included(klass)
+    klass.__send__(:extend, Cql::Model::ClassMethods)
+    klass.__send__(:include, Cql::Model::InstanceMethods)
+  end
+
+  # Get or set the "master" client connection shared by every model that doesn't bother to
+  # set its own. Defaults to a localhost connection with no default keyspace; every query
+  # must be wrapped in a "using_keyspace" method call.
+  #
+  # @param [optional, Cql::Client] new_client the new client to set
+  # @return [Cql::Client] the current client
+  def self.cql_client(new_client=nil)
+    if new_client
+      @@cql_model_mutex.synchronize do
+        @@cql_client = new_client
+      end
+    else
+      @@cql_client ||= Cql::Client.new
+      @@cql_client.start! unless @@cql_client.connected?
+    end
+
+    @@cql_client
+  end
+end

data/lib/cql/model/class_methods.rb

@@ -0,0 +1,178 @@
+module Cql::Model::ClassMethods
+  def self.extended(klass)
+    klass.instance_eval do
+      # The mutex is shared by all Cql::Model inheritors
+      @@cql_model_mutex            ||= Mutex.new
+
+      # Other attributes are tracked per-class
+      @cql_table_name              ||= klass.name.split('::').last
+      @cql_model_properties        ||= {}
+      @cql_model_keys              ||= []
+      @cql_model_read_consistency  ||= 'LOCAL_QUORUM'
+      @cql_model_write_consistency ||= 'LOCAL_QUORUM'
+    end
+  end
+
+  # Get or set the client connection used by this class.
+  #
+  # @param [optional, Cql::Client] new_client the new client to set
+  # @return [Cql::Client] the current client
+  def cql_client(new_client=nil)
+    if new_client
+      @@cql_model_mutex.synchronize do
+        @cql_client = new_client
+      end
+    end
+
+    @cql_client || ::Cql::Model.cql_client
+  end
+
+  # @TODO docs
+  def table_name(new_name=nil)
+    if new_name
+      @@cql_model_mutex.synchronize do
+        # Set the table name
+        @cql_table_name = new_name
+      end
+    else
+      # Get the table name
+      @cql_table_name
+    end
+  end
+
+  # @TODO docs
+  def read_consistency(new_consistency=nil)
+    if new_consistency
+      @cql_model_read_consistency = new_consistency
+    else
+      @cql_model_read_consistency
+    end
+  end
+
+  # @TODO docs
+  def write_consistency(new_consistency=nil)
+    if new_consistency
+      @cql_model_write_consistency = new_consistency
+    else
+      @cql_model_write_consistency
+    end
+  end
+
+  # Specify or get a primary key or a composite primary key
+  #
+  # @param key_vals [Symbol|Array<Symbol>] single key name or composite key names
+  #
+  # @return [Cql::Model] self
+  def primary_key(*keys)
+    if keys.empty?
+      @cql_model_keys
+    else
+      @@cql_model_mutex.synchronize do
+        @cql_model_keys = keys
+      end
+      self
+    end
+  end
+
+  # @TODO docs
+  def property(name, type, opts={})
+    definition = {}
+
+    # If the user specified the name as a symbol, then they automatically get
+    # a reader and writer because the property has a predictable, fixed column
+    # name.
+    if name.is_a?(Symbol)
+      definition[:reader] = opts[:reader] || name
+      definition[:writer] = opts[:writer] || "#{definition[:reader]}=".to_sym
+      name                = name.to_s
+    end
+
+    @@cql_model_mutex.synchronize do
+      definition[:type] = type
+
+      if @cql_model_properties.key?(name) && (@cql_model_properties[name] != definition)
+        raise ArgumentError, "Property #{name} is already defined"
+      end
+
+      unless @cql_model_properties.key?(name)
+        @cql_model_properties[name] = definition
+
+        __send__(:define_method, definition[:reader]) do
+          self[name]
+        end if definition[:reader]
+
+        __send__(:define_method, definition[:writer]) do |value|
+          self[name] = value
+        end if definition[:writer]
+      end
+    end
+
+    self
+  end
+
+  # @TODO docs
+  def scope(name, &block)
+    @@cql_model_mutex.synchronize do
+      eigenclass = class <<self
+        self
+      end
+
+      eigenclass.instance_eval do
+        define_method(name.to_sym) do |*params|
+          # @TODO use a prepared statement for speed
+          self.select.where(*params, &block)
+        end
+      end
+    end
+
+    self
+  end
+
+  # Begin building a CQL SELECT statement.
+  #
+  # @param [Object] *params list of yield parameters for the block
+  #
+  # @example tell us how old Joe is
+  #   Person.select.where { name == 'Joe' }.each { |person| puts person.age }
+  def select(*params)
+    Cql::Model::Query::SelectStatement.new(self).select(*params)
+  end
+
+  # Begin building a CQL INSERT statement.
+  # @see Cql::Model::Query::InsertStatement
+  #
+  # @param [Hash] values Hash of column values indexed by column name
+  # @return [Cql::Model::Query::InsertStatement] a query object to customize (timestamp, ttl, etc) or execute
+  #
+  # @example
+  #   Person.create(:name => 'Joe', :age => 25).ttl(3600).execute
+  def insert(values)
+    Cql::Model::Query::InsertStatement.new(self).insert(values)
+  end
+
+  alias create insert
+
+  # Start an UPDATE CQL statement
+  # The method #keys must be called on the result before #execute
+  # @see Cql::Model::Query::UpdateStatement
+  #
+  # @param [Hash] values Hash of column values indexed by column name, optional
+  # @return [Cql::Model::Query::UpdateStatement] a query object to customize (keys, ttl, timestamp etc) then execute
+  #
+  # @example
+  #   Person.update(:updated_at => Time.now.utc).keys(:name => ['joe', 'john', 'jane'])
+  #   Person.update.ttl(3600).keys(:name => 'joe')
+  def update(values={})
+    Cql::Model::Query::UpdateStatement.new(self).update(values)
+  end
+
+  # @TODO docs
+  def each_row(&block)
+    Cql::Model::Query::SelectStatement.new(self).each_row(&block)
+  end
+
+  # @TODO docs
+  def each(&block)
+    Cql::Model::Query::SelectStatement.new(self).each(&block)
+  end
+end