rom-cassandra 0.0.1

data/lib/rom/cassandra/session.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require "cassandra"
+
+module ROM::Cassandra
+
+  # Wraps the external driver, responsible for sending CQL requests
+  # to the Cassandra cluster
+  #
+  class Session
+
+    # The regexp, describing the format of the allowed address of the cluster
+    FORMAT = /\d{1,3}(\.\d{1,3}){3}(\:\d+)?/
+
+    # @!attribute [r] uri
+    #
+    # @return [Hash] the settings for the session
+    #
+    attr_reader :uri
+
+    # Initializes a session to given cluster
+    #
+    # @param [Hash] options
+    #
+    def initialize(*options)
+      @uri  = extract(*options)
+      @conn = ::Cassandra.cluster(uri).connect
+    end
+
+    # Sends the query to the Cassandra syncronously
+    #
+    # @param [#to_s] query
+    #
+    # @return [Array<Hash>]
+    #
+    def call(query)
+      @conn.execute(query.to_s).to_a
+    end
+
+    private
+
+    def extract(uri = { hosts: ["127.0.0.1"], port: 9042 }, hash = {})
+      return uri if uri.instance_of? Hash
+      hosts, port = uri[FORMAT].split(":")
+      { hosts: [hosts], port: port.to_i }.merge hash
+    end
+
+  end # class Session
+
+end # module ROM::Cassandra

data/lib/rom/cassandra/tasks.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require "rake"
+require "rom-cassandra"
+
+load "tasks/db.rake"

data/lib/rom/cassandra/version.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+
+module ROM
+
+  module Cassandra
+
+    # The semantic version of the module.
+    #
+    # @see http://semver.org/ Semantic versioning 2.0
+    #
+    VERSION = "0.0.1".freeze
+
+  end # module Cassandra
+
+end # module ROM

data/lib/tasks/db.rake

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+namespace :db do
+  desc "Create a migration (required parameter: NAME)"
+  task :create_migration, [:name, :path] do |_, args|
+    unless (name = args[:name])
+      puts "No NAME specified.\n" \
+        "Usage example: `rake db:create_migration[create_users]`"
+      exit
+    end
+    path = args[:path] || "db/migrate"
+
+    result = ROM::Cassandra::Migrations::Generator.call(name, path)
+    puts "<= Created #{result}"
+  end
+end

data/rom-cassandra.gemspec

@@ -0,0 +1,33 @@
+# encoding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rom/cassandra/version"
+
+Gem::Specification.new do |gem|
+
+  gem.name             = "rom-cassandra"
+  gem.version          = ROM::Cassandra::VERSION.dup
+  gem.author           = ["Andrew Kozin"]
+  gem.email            = ["andrew.kozin@gmail.com"]
+  gem.summary          = "Cassandra support for Ruby Object Mapper"
+  gem.description      = gem.summary
+  gem.homepage         = "https://rom-rb.org"
+  gem.license          = "MIT"
+
+  gem.files            = `git ls-files -z`.split("\x0")
+  gem.executables      = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files       = gem.files.grep(%r{^(test|spec|features)/})
+  gem.extra_rdoc_files = Dir["README.md", "LICENSE"]
+  gem.require_paths    = ["lib"]
+
+  gem.required_ruby_version = ">= 1.9.3"
+
+  gem.add_runtime_dependency "cassandra-driver", "~> 2.1"
+  gem.add_runtime_dependency "inflecto", "~> 0.0"
+  gem.add_runtime_dependency "query_builder", "~> 0.0"
+  gem.add_runtime_dependency "rom", "~> 0.9.1"
+
+  gem.add_development_dependency "hexx-rspec", "~> 0.5"
+  gem.add_development_dependency "timecop", "~> 0.8"
+
+end # Gem::Specification

data/spec/config/reset_cluster.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+require "cassandra"
+
+RSpec.configure do |config|
+
+  # Prepares table auth.users using official Datastax ruby driver for Cassandra
+  #
+  # Populates table records [{id: 1, name: "joe"}, {id: 2, name: "jane"}]
+  #
+  def reset_cluster
+    [
+      "DROP KEYSPACE IF EXISTS auth;",
+      "CREATE KEYSPACE auth WITH " \
+        "replication = {'class': 'SimpleStrategy', 'replication_factor': 1};",
+      "CREATE TABLE auth.users (id int, name text, PRIMARY KEY (id));",
+      "INSERT INTO auth.users (id, name) VALUES (1, 'joe');",
+      "INSERT INTO auth.users (id, name) VALUES (2, 'jane');"
+    ].each(&::Cassandra.cluster.connect.method(:execute))
+  end
+
+  # Prepares the cluster before the suit
+  reset_cluster
+
+  # Recreates cluster after every example, marked by :reset_cluster tag
+  config.after(:example, :reset_cluster) { reset_cluster }
+
+end # RSpec.configure

data/spec/config/rom.rb

@@ -0,0 +1,3 @@
+# encoding: utf-8
+
+ROM.use :auto_registration

data/spec/config/test_module.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+# Recreates ROM::Cassandra::Test before every spec
+RSpec.configure do |config|
+  config.before { module ROM::Cassandra::Test; end }
+  config.after  { ROM::Cassandra.send :remove_const, :Test }
+end

data/spec/integration/batch_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require "shared/users"
+
+module ROM::Cassandra::Test # the namespace for newly created classes
+
+  describe "command 'batch'", :reset_cluster do
+
+    include_context :users
+
+    before do
+      class Batch < ROM::Cassandra::Commands::Batch
+        relation :users
+        register_as :batch
+
+        def execute
+          super do
+            add("DELETE FROM auth.users WHERE id = 1;")
+              .add(keyspace(:auth).table(:users).insert(id: 3, name: "frank"))
+          end
+        end
+      end
+    end
+
+    subject { rom.command(:users).batch }
+
+    it "works" do
+      expect { subject.call }
+        .to change { select.to_a }
+        .from([{ "id" => 1, "name" => "joe" }, { "id" => 2, "name" => "jane" }])
+        .to [{ "id" => 2, "name" => "jane" }, { "id" => 3, "name" => "frank" }]
+    end
+
+  end # describe command 'batch'
+
+end # module ROM::Cassandra::Commands::Batch

data/spec/integration/create_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require "shared/users"
+
+module ROM::Cassandra::Test # the namespace for newly created classes
+
+  describe "command 'create'", :reset_cluster do
+
+    include_context :users
+
+    before do
+      class CreateUser < ROM::Commands::Create[:cassandra]
+        relation :users
+        register_as :create
+
+        def execute(id, name)
+          super { insert(id: id, name: name) }
+        end
+      end
+    end
+
+    subject { rom.command(:users).create }
+
+    it "works" do
+      expect { subject.call(3, "jill") }
+        .to change { select.by_id(3).to_a }
+        .from([])
+        .to [{ "id" => 3, "name" => "jill" }]
+    end
+
+  end # describe command 'create'
+
+end # module ROM::Cassandra::Test

data/spec/integration/delete_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require "shared/users"
+
+module ROM::Cassandra::Test # the namespace for newly created classes
+
+  describe "command 'delete'", :reset_cluster do
+
+    include_context :users
+
+    before do
+      class DeleteUser < ROM::Commands::Delete[:cassandra]
+        relation :users
+        register_as :delete
+
+        def execute(id)
+          super { where(id: 1) }
+        end
+      end
+    end
+
+    subject { rom.command(:users).delete }
+
+    it "works" do
+      expect { subject.call(1) }
+        .to change { select.by_id(1).to_a }
+        .from([{ "id" => 1, "name" => "joe" }])
+        .to []
+    end
+
+  end # describe command 'delete'
+
+end # module ROM::Cassandra::Test

data/spec/integration/migrate/20150825142003_create_users.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+class CreateUsers < ROM::Cassandra::Migrations::Migration
+  def up
+    replication = { class: :SimpleStrategy, replication_factor: 1 }
+
+    call keyspace(:logs)
+      .create
+      .if_not_exists
+      .with(replication: replication)
+
+    call keyspace(:logs)
+      .table(:users)
+      .create
+      .if_not_exists
+      .add(:id, :int)
+      .add(:name, :text)
+      .primary_key(:id)
+  end
+
+  def down
+    call keyspace(:logs).drop.if_exists
+  end
+end # class CreateUsers

data/spec/integration/migrate/20150825142024_create_logs.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+class CreateLogs < ROM::Cassandra::Migrations::Migration
+  def up
+    call keyspace(:logs)
+      .table(:logs)
+      .create
+      .add(:id, :int)
+      .add(:name, :text)
+      .primary_key(:id)
+      .if_not_exists
+  end
+
+  def down
+    call "DROP TABLE IF EXISTS logs.logs;"
+  end
+end # class CreateUsers

data/spec/integration/migrate_spec.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+describe "migrate" do
+
+  # The helper function to check the db content
+  def check(query)
+    Cassandra.cluster.connect.execute query
+  end
+
+  let(:stdout)  { StringIO.new }
+  let(:logger)  { Logger.new stdout }
+  let(:path)    { File.expand_path("../migrate", __FILE__) }
+  let(:gateway) { ROM.finalize.env.gateways[:default] }
+
+  it "works" do
+    ROM.setup(:cassandra, "127.0.0.1:9042")
+
+    expect { check "SELECT * FROM logs.users;" }.to raise_error StandardError
+    expect { check "SELECT * FROM logs.logs" }.to raise_error StandardError
+    expect(stdout.string).to be_empty
+
+    gateway.migrate logger: logger, path: path, version: 20150825142003
+
+    expect { check "SELECT * FROM logs.users;" }.not_to raise_error
+    expect { check "SELECT * FROM logs.logs" }.to raise_error StandardError
+    expect(stdout.string).to     include "Apply migration 20150825142003"
+    expect(stdout.string).not_to include "Apply migration 20150825142024"
+
+    gateway.migrate logger: logger, path: path
+
+    expect { check "SELECT * FROM logs.users;" }.not_to raise_error
+    expect { check "SELECT * FROM logs.logs" }.not_to raise_error
+    expect(stdout.string).to     include "Apply migration 20150825142024"
+    expect(stdout.string).not_to include "Roll back"
+
+    gateway.migrate logger: logger, path: path, version: 0
+
+    expect { check "SELECT * FROM logs.users;" }.to raise_error StandardError
+    expect { check "SELECT * FROM logs.logs" }.to raise_error StandardError
+    expect(stdout.string).to include "Roll back migration 20150825142024"
+    expect(stdout.string).to include "Roll back migration 20150825142003"
+  end
+
+  after { check "DROP KEYSPACE IF EXISTS rom;" }
+  after { check "DROP KEYSPACE IF EXISTS logs;" }
+
+end # describe migrate

data/spec/integration/relation_spec.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require "shared/users"
+
+module ROM::Cassandra::Test # the namespace for newly created classes
+
+  describe "relation" do
+
+    include_context :users
+
+    let(:subject) { rom.relation(:users) }
+
+    it "works" do
+      expect(subject.to_a).to eql [
+        { "id" => 1, "name" => "joe" },
+        { "id" => 2, "name" => "jane" }
+      ]
+    end
+
+    it "works with modifiers" do
+      expect(subject.by_id(1).to_a)
+        .to eql [{ "id" => 1, "name" => "joe" }]
+    end
+
+  end # describe relation
+
+end # module ROM::Cassandra::Test

data/spec/integration/update_spec.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require "shared/users"
+
+module ROM::Cassandra::Test # the namespace for newly created classes
+
+  describe "command 'update'", :reset_cluster do
+
+    include_context :users
+
+    before do
+      class UpdateUser < ROM::Commands::Update[:cassandra]
+        relation :users
+        register_as :update
+
+        def execute(id, name)
+          super { update(name: name).where(id: 1) }
+        end
+      end
+    end
+
+    subject { rom.command(:users).update }
+
+    it "works" do
+      expect { subject.call(1, "frank") }
+        .to change { select.by_id(1).to_a }
+        .from([{ "id" => 1, "name" => "joe" }])
+        .to [{ "id" => 1, "name" => "frank" }]
+    end
+
+  end # describe command 'update'
+
+end # module ROM::Cassandra::Test

data/spec/shared/fake_migrate_folder.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require "fileutils"
+
+shared_context :fake_migrate_folder do |folder|
+  before { FileUtils.mkdir_p path }
+  before { files.reverse_each(&FileUtils.method(:touch)) }
+
+  let(:root) { File.expand_path "../../sandbox", __FILE__ }
+  let(:path) { File.join(root, folder) }
+  let(:files) do
+    [
+      "20151231235959_create_auth.rb",
+      "20160101000000_create_users.rb",
+      "20160101000001_create_logs.rb",
+      "20160101000002_create_rights.rb"
+    ].map { |name| File.join(path, name) }
+  end
+
+  after { FileUtils.rm_rf root }
+end # shared context