carl 0.1.1

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+
+gem 'cassandra-cql', '~> 1.0.2'
+
+group :development do
+  gem "rspec", "~> 2.5.0"
+  gem "guard-rspec", "~> 0.5.9"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end
+
+group :development, :linux do
+  gem 'rb-inotify'
+  gem 'libnotify'
+end

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('spec/spec_helper.rb')                        { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Thomas Hollstegge
+
+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.md

@@ -0,0 +1,48 @@
+# Carl
+
+Carl constructs CQL statements for Cassandra.
+
+Quick Start
+-----------
+
+Establish a connection:
+
+    require 'carl'
+    Carl::Base.establish_connection :keyspace => 'carl', :hosts => ['localhost:9160']
+
+Build a query
+
+    carl = Carl::Base.new
+    carl.select('rowname').from('columnfamily').where(:key => 42).query
+    # => ["SELECT ? FROM ? WHERE key = ?", "rowname", "columnfamily", 42]
+
+Execute a query
+
+    carl.select('rowname').from('columnfamily').where(:key => 42).execute
+    # => #<CassandraCQL::Result:...
+
+    carl.select('rowname').from('columnfamily').where(:key => 42).to_hash
+    # => {...}
+
+Supported statements
+--------------------
+
+* *INSERT*: ~90% complete
+* *other*: ~0% complete
+
+Contributing to Carl
+--------------------
+ 
+* 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 Thomas Hollstegge. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+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 = "carl"
+  gem.homepage = "http://github.com/Tho85/carl"
+  gem.license = "MIT"
+  gem.summary = %Q{A CQL statement generator for Cassandra}
+  gem.description = %Q{Cassandra CQL queries - gone awesome!}
+  gem.email = "thomas.hollstegge@zweitag.de"
+  gem.authors = ["Thomas Hollstegge"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "carl #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/carl.gemspec

@@ -0,0 +1,73 @@
+# 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 = %q{carl}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Thomas Hollstegge}]
+  s.date = %q{2011-12-11}
+  s.description = %q{Cassandra CQL queries - gone awesome!}
+  s.email = %q{thomas.hollstegge@zweitag.de}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Guardfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "carl.gemspec",
+    "lib/carl.rb",
+    "lib/carl/base.rb",
+    "spec/carl/base_spec.rb",
+    "spec/carl_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/generate_query_matcher.rb"
+  ]
+  s.homepage = %q{http://github.com/Tho85/carl}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.7}
+  s.summary = %q{A CQL statement generator for Cassandra}
+
+  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<cassandra-cql>, ["~> 1.0.2"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_development_dependency(%q<guard-rspec>, ["~> 0.5.9"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rb-inotify>, [">= 0"])
+      s.add_development_dependency(%q<libnotify>, [">= 0"])
+    else
+      s.add_dependency(%q<cassandra-cql>, ["~> 1.0.2"])
+      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_dependency(%q<guard-rspec>, ["~> 0.5.9"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rb-inotify>, [">= 0"])
+      s.add_dependency(%q<libnotify>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<cassandra-cql>, ["~> 1.0.2"])
+    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+    s.add_dependency(%q<guard-rspec>, ["~> 0.5.9"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rb-inotify>, [">= 0"])
+    s.add_dependency(%q<libnotify>, [">= 0"])
+  end
+end
+

data/lib/carl.rb

@@ -0,0 +1,3 @@
+require 'cassandra-cql'
+require 'carl/base'
+

data/lib/carl/base.rb

@@ -0,0 +1,123 @@
+module Carl
+  class Base
+    include Enumerable
+
+    class << self
+      attr_accessor :config
+
+      def connection
+        @connection ||= establish_connection
+      end
+
+      def establish_connection(config={:keyspace => 'carl', :hosts => ['localhost:9160']})
+        @config = config
+        @connection = CassandraCQL::Database.new config[:hosts], :keyspace => config[:keyspace]
+      end
+    end
+
+    # Define single argument methods
+    [:from, :using_consistency, :limit, :count, :column_limit, :reversed].each do |meth|
+      class_eval %Q$
+        attr_accessor :#{meth}_value
+
+        def #{meth}(value=true)
+          clone.tap {|c| c.#{meth}_value = value }
+        end
+      $
+    end
+
+    # Define multiple argument methods
+    [:select, :range].each do |meth|
+      class_eval %Q$
+        attr_accessor :#{meth}_values
+
+        def #{meth}(*values)
+          clone.tap {|c| c.#{meth}_values = values }
+        end
+      $
+    end
+
+    # Define "additive" methods
+    attr_accessor :where_sql, :where_bindings
+    def where(*conditions)
+      clone.tap do |c|
+        c.where_sql ||= []
+        c.where_bindings ||= []
+        # Simple conditions: {:condition => 42}
+
+        if conditions.first.is_a?(Hash)
+          conditions.first.each do |k,v|
+            c.where_sql << "#{k} = ?"
+            c.where_bindings << v
+          end
+        elsif conditions.first.is_a?(String)
+          c.where_sql << conditions.shift
+          c.where_bindings += conditions
+        end
+      end
+    end
+
+    alias :and :where
+
+    # Build query
+    def query
+      @sql = []
+      @bindings = []
+
+      # SELECT
+      add_to_sql "SELECT"
+      if select_values
+        add_to_sql (["?"] * select_values.count).join(", "), *select_values.map(&:to_s)
+      elsif count_value
+        add_to_sql "COUNT(*)"
+      else
+        add_to_sql "FIRST ?", column_limit_value if column_limit_value
+        add_to_sql "REVERSED" if reversed_value
+        if range_values
+          add_to_sql (["?"] * range_values.count).join(" .. "), *range_values
+        else
+          add_to_sql "*"
+        end
+      end
+
+      # FROM
+      add_to_sql "FROM ?", from_value if from_value
+
+      # USING CONSISTENCY
+      add_to_sql "USING CONSISTENCY ?", using_consistency_value.to_s if using_consistency_value
+
+      # WHERE
+      if where_sql && !where_sql.empty?
+        add_to_sql "WHERE"
+        add_to_sql where_sql.join(" AND "), *where_bindings
+      end
+
+      # LIMIT
+      add_to_sql "LIMIT ?", limit_value if limit_value
+
+      [@sql.join(" ")] + @bindings
+    end
+    
+    def execute
+      self.class.connection.execute(*query)
+    end
+
+    def to_hash
+      execute.result.fetch_hash
+    end
+
+    def each
+      to_hash.each do |_,v|
+        yield v
+      end
+    end
+
+    private
+
+    def add_to_sql(*args)
+      @sql << args.shift
+      @bindings += args
+    end
+
+  end
+end

data/spec/carl/base_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Carl::Base do
+  it "should have a Cassandra connection" do
+    Carl::Base.connection.should be_kind_of CassandraCQL::Database
+  end
+
+  it "should establish a connection with given parameters" do
+    CassandraCQL::Database.should_receive(:new).with(['localhost:9160'], :keyspace => 'carl')
+    Carl::Base.establish_connection :keyspace => 'carl', :hosts => ['localhost:9160']
+  end
+
+  subject { Carl::Base.new.select('row-name').from('my_cf') }
+
+  context "simple queries" do
+
+    it "should generate a simple query" do
+      expect { subject }.to generate_query 'SELECT ? FROM ?', 'row-name', 'my_cf'
+    end
+    
+    it "should fallback to SELECT *" do
+      expect { Carl::Base.new.from('my_cf') }.to generate_query 'SELECT * FROM ?', 'my_cf'
+    end
+
+    it "should allow to specify a consistency level" do
+      expect { subject.using_consistency(:quorum) }.to generate_query 'SELECT ? FROM ? USING CONSISTENCY ?', 'row-name', 'my_cf', 'quorum'
+    end
+
+    it "should allow to specify a limit" do
+      expect { subject.limit(10) }.to generate_query 'SELECT ? FROM ? LIMIT ?', 'row-name', 'my_cf', 10
+    end
+  end
+  
+  context "conditions" do
+    it "should allow to specify simple conditions" do
+      expect { subject.where(:condition => 42) }.to generate_query 'SELECT ? FROM ? WHERE condition = ?', 'row-name', 'my_cf', 42
+    end
+
+    it "should allow to specify multiple conditions chained by AND" do
+      expect { subject.where(:condition1 => 42).and(:condition2 => 24) }.to generate_query 'SELECT ? FROM ? WHERE condition1 = ? AND condition2 = ?', 'row-name', 'my_cf', 42, 24
+    end
+
+    it "should allow to specify CQL in conditions" do
+      expect { subject.where("condition => 42") }.to generate_query 'SELECT ? FROM ? WHERE condition => 42', 'row-name', 'my_cf'
+    end
+
+    it "should allow to add bindings to string conditions" do
+      expect { subject.where("condition1 = ? and condition2 = ?", 24, 42) }.to generate_query 'SELECT ? FROM ? WHERE condition1 = ? and condition2 = ?', 'row-name', 'my_cf', 24, 42
+    end
+  end
+
+  context "projections" do
+
+    subject { Carl::Base.new.from('my_cf') }
+    
+    it "should count rows" do
+      expect { subject.count }.to generate_query 'SELECT COUNT(*) FROM ?', 'my_cf'
+    end
+
+    it "should allow multiple columns" do
+      expect { subject.select(:column1, :column2) }.to generate_query 'SELECT ?, ? FROM ?', 'column1', 'column2', 'my_cf'
+    end
+
+    it "should accept ranges" do
+      expect { subject.range(24, 42) }.to generate_query 'SELECT ? .. ? FROM ?', 24, 42, 'my_cf'
+    end
+
+    it "should allow FIRST statements" do
+      # We don't use #first as it is already taken by Enumerable
+      expect { subject.column_limit(10) }.to generate_query 'SELECT FIRST ? * FROM ?', 10, 'my_cf'
+    end
+
+    it "should allow REVERSED keyword" do
+      expect { subject.reversed }.to generate_query 'SELECT REVERSED * FROM ?', 'my_cf'
+    end
+  end
+
+  context "execution" do
+    subject { Carl::Base.new.from('my_cf') }
+
+    it "should execute the query" do
+      Carl::Base.connection.should_receive(:execute).with(*subject.query)
+      subject.execute
+    end
+  end
+end

data/spec/carl_spec.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Carl" do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'cassandra-cql'
+require 'carl'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/support/generate_query_matcher.rb

@@ -0,0 +1,11 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :generate_query do |*query|
+  match do |block|
+    block.call.query == query
+  end
+
+  failure_message_for_should do |block|
+    %Q(expected query "#{query}",\ngot query "#{block.call.query}")
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: carl
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Thomas Hollstegge
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cassandra-cql
+  requirement: &78270930 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *78270930
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &78270500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: *78270500
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &78270140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.9
+  type: :development
+  prerelease: false
+  version_requirements: *78270140
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &78269790 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *78269790
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &78269520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *78269520
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &78269230 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *78269230
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: &78268900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *78268900
+- !ruby/object:Gem::Dependency
+  name: libnotify
+  requirement: &78268600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *78268600
+description: Cassandra CQL queries - gone awesome!
+email: thomas.hollstegge@zweitag.de
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- carl.gemspec
+- lib/carl.rb
+- lib/carl/base.rb
+- spec/carl/base_spec.rb
+- spec/carl_spec.rb
+- spec/spec_helper.rb
+- spec/support/generate_query_matcher.rb
+homepage: http://github.com/Tho85/carl
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 141567407
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: A CQL statement generator for Cassandra
+test_files: []