cassandra_store 1.0.0

data/spec/cassandra_store/migration_spec.rb

@@ -0,0 +1,79 @@
+require File.expand_path("../spec_helper", __dir__)
+
+RSpec.describe CassandraStore::Migration do
+  let(:path) { File.expand_path("../fixtures", __dir__) }
+
+  describe ".up" do
+    let(:version) { "1589957812" }
+
+    before { CassandraStore::SchemaMigration.create_table(if_not_exists: true) }
+
+    it "calls the up migration" do
+      migration = double(up: true)
+
+      allow(described_class.migration_class(path, version)).to receive(:new).and_return(migration)
+
+      described_class.up(path, version)
+
+      expect(migration).to have_received(:up)
+    end
+  end
+
+  describe ".down" do
+    let(:version) { "1589957812" }
+
+    before { CassandraStore::SchemaMigration.create_table(if_not_exists: true) }
+
+    it "calls the down migration" do
+      migration = double(down: true)
+
+      allow(described_class.migration_class(path, version)).to receive(:new).and_return(migration)
+
+      described_class.down(path, version)
+
+      expect(migration).to have_received(:down)
+    end
+  end
+
+  describe ".execute" do
+    it "delegates to CassandraStore::Base.execute" do
+      allow(CassandraStore::Base).to receive(:execute)
+
+      described_class.new.execute("args")
+
+      expect(CassandraStore::Base).to have_received(:execute).with("args")
+    end
+  end
+
+  describe ".migrate" do
+    before { CassandraStore::SchemaMigration.create_table(if_not_exists: true) }
+
+    it "runs all pending migrations" do
+      migration1 = double(up: true)
+      migration2 = double(up: true)
+
+      allow(described_class.migration_class(path, "1589957812")).to receive(:new).and_return(migration1)
+      allow(described_class.migration_class(path, "1589957813")).to receive(:new).and_return(migration2)
+
+      described_class.migrate(path)
+
+      expect(migration1).to have_received(:up)
+      expect(migration2).to have_received(:up)
+    end
+
+    it "does not run already executed migrations" do
+      described_class.up(path, "1589957812")
+
+      migration1 = double(up: true)
+      migration2 = double(up: true)
+
+      allow(described_class.migration_class(path, "1589957812")).to receive(:new).and_return(migration1)
+      allow(described_class.migration_class(path, "1589957813")).to receive(:new).and_return(migration2)
+
+      described_class.migrate(path)
+
+      expect(migration1).not_to have_received(:up)
+      expect(migration2).to have_received(:up)
+    end
+  end
+end

data/spec/cassandra_store/relation_spec.rb

@@ -0,0 +1,222 @@
+require File.expand_path("../spec_helper", __dir__)
+
+RSpec.describe CassandraStore::Relation do
+  describe "#all" do
+    it "returns all records" do
+      post1 = Post.create!(user: "user", domain: "domain", message: "message1")
+      post2 = Post.create!(user: "user", domain: "domain", message: "message2")
+
+      expect(Post.all.to_a.to_set).to eq([post1, post2].to_set)
+    end
+  end
+
+  describe "#update_all" do
+    it "allows to update records via a cql string" do
+      post1 = Post.create!(user: "user1", domain: "domain1", message: "message1")
+      post2 = Post.create!(user: "user2", domain: "domain2", message: "message2")
+
+      Post.where(user: "user1", domain: "domain1", id: post1.id).update_all("message = 'new message'")
+
+      post1 = Post.where(user: "user1", domain: "domain1", id: post1.id).first
+      post2 = Post.where(user: "user2", domain: "domain2", id: post2.id).first
+
+      expect(post1.message).to eq("new message")
+      expect(post2.message).to eq("message2")
+    end
+
+    it "allows to update records via a hash" do
+      post1 = Post.create!(user: "user1", domain: "domain1", message: "message1")
+      post2 = Post.create!(user: "user2", domain: "domain2", message: "message2")
+
+      Post.where(user: "user1", domain: "domain1", id: post1.id).update_all(message: "new message")
+
+      post1 = Post.where(user: "user1", domain: "domain1", id: post1.id).first
+      post2 = Post.where(user: "user2", domain: "domain2", id: post2.id).first
+
+      expect(post1.message).to eq("new message")
+      expect(post2.message).to eq("message2")
+    end
+  end
+
+  describe "#where" do
+    it "is chainable" do
+      post1 = Post.create!(user: "user", domain: "domain1", message: "message1")
+      post2 = Post.create!(user: "user", domain: "domain1", message: "message2")
+      _post3 = Post.create!(user: "user", domain: "domain2", message: "message1")
+
+      posts = Post.where(user: "user").where(domain: "domain1").to_a
+
+      expect(posts.to_a.to_set).to eq([post1, post2].to_set)
+    end
+
+    it "allows to pass multiple hash arguments" do
+      post1 = Post.create!(user: "user", domain: "domain1", message: "message1")
+      post2 = Post.create!(user: "user", domain: "domain1", message: "message2")
+      _post3 = Post.create!(user: "user", domain: "domain2", message: "message1")
+
+      posts = Post.where(user: "user", domain: "domain1").to_a
+
+      expect(posts.to_a.to_set).to eq([post1, post2].to_set)
+    end
+
+    it "allows to pass an array as constraint" do
+      post1 = Post.create!(user: "user", domain: "domain1")
+      post2 = Post.create!(user: "user", domain: "domain2")
+      _post3 = Post.create!(user: "user", domain: "domain3")
+
+      posts = Post.where(user: "user").where(domain: ["domain1", "domain2"]).to_a
+
+      expect(posts.to_a.to_set).to eq([post1, post2].to_set)
+    end
+
+    it "allows to pass a range as constraint" do
+      post1 = Post.create!(user: "user", domain: "domain1")
+      post2 = Post.create!(user: "user", domain: "domain2")
+      _post3 = Post.create!(user: "user", domain: "domain3")
+
+      expect(Post.where(user: "user").where(domain: "domain1".."domain2").to_a.to_set).to eq([post1, post2].to_set)
+    end
+
+    it "allows to pass an arbitrary cql string" do
+      post1 = Post.create!(user: "user", domain: "domain1", message: "message1")
+      post2 = Post.create!(user: "user", domain: "domain1", message: "message2")
+      _post3 = Post.create!(user: "user", domain: "domain2", message: "message1")
+
+      expect(Post.where_cql("user = 'user'").where_cql("domain = :domain", domain: "domain1").to_a.to_set).to eq([post1, post2].to_set)
+    end
+  end
+
+  describe "#order" do
+    it "sorts the records by the specified criteria" do
+      post1 = Post.create!(user: "user", domain: "domain", timestamp: Time.now)
+      post2 = Post.create!(user: "user", domain: "domain", timestamp: Time.now + 1.day)
+      post3 = Post.create!(user: "user", domain: "domain", timestamp: Time.now + 2.days)
+
+      expect(Post.where(user: "user", domain: "domain").order(id: :asc).to_a).to eq([post1, post2, post3])
+      expect(Post.where(user: "user", domain: "domain").order(id: :desc).to_a).to eq([post3, post2, post1])
+    end
+  end
+
+  describe "#limit" do
+    it "limits the records returned" do
+      Post.create!(user: "user", domain: "domain", timestamp: Time.now)
+      Post.create!(user: "user", domain: "domain", timestamp: Time.now)
+      Post.create!(user: "user", domain: "domain", timestamp: Time.now)
+      Post.create!(user: "user", domain: "domain", timestamp: Time.now)
+
+      expect(Post.limit(2).find_each.count).to eq(2)
+      expect(Post.where(user: "user", domain: "domain").limit(2).find_each.count).to eq(2)
+
+      expect(Post.limit(3).find_each.count).to eq(3)
+      expect(Post.where(user: "user", domain: "domain").limit(3).find_each.count).to eq(3)
+    end
+  end
+
+  describe "#first" do
+    it "returns the first record" do
+      post1 = Post.create!(user: "user", domain: "domain", timestamp: Time.now - 1.day)
+      post2 = Post.create!(user: "user", domain: "domain", timestamp: Time.now + 1.day)
+
+      expect(Post.where(user: "user", domain: "domain").order(id: :asc).first).to eq(post1)
+      expect(Post.where(user: "user", domain: "domain").order(id: :desc).first).to eq(post2)
+    end
+  end
+
+  describe "#distinct" do
+    it "returns distinct values for the specified columns" do
+      Post.create!(user: "user1", domain: "domain1", timestamp: Time.now)
+      Post.create!(user: "user1", domain: "domain1", timestamp: Time.now)
+      Post.create!(user: "user1", domain: "domain2", timestamp: Time.now)
+      Post.create!(user: "user1", domain: "domain2", timestamp: Time.now)
+      Post.create!(user: "user2", domain: "domain1", timestamp: Time.now)
+      Post.create!(user: "user2", domain: "domain1", timestamp: Time.now)
+
+      expect(Post.select(:user, :domain).distinct.find_each.to_a).to eq(
+        [
+          { "user" => "user1", "domain" => "domain1" },
+          { "user" => "user1", "domain" => "domain2" },
+          { "user" => "user2", "domain" => "domain1" }
+        ]
+      )
+    end
+  end
+
+  describe "#select" do
+    it "returns the specified columns only" do
+      Post.create!(user: "user1", domain: "domain1", timestamp: Time.now)
+      Post.create!(user: "user2", domain: "domain2", timestamp: Time.now)
+
+      expect(Post.select(:user, :domain).find_each.to_a).to eq(
+        [
+          { "user" => "user1", "domain" => "domain1" },
+          { "user" => "user2", "domain" => "domain2" }
+        ]
+      )
+    end
+  end
+
+  describe "#find_each" do
+    it "returns all records" do
+      Post.create!(user: "user", domain: "domain", message: "message1", timestamp: Time.now)
+      Post.create!(user: "user", domain: "domain", message: "message2", timestamp: Time.now + 1.day)
+      Post.create!(user: "user", domain: "domain", message: "message3", timestamp: Time.now + 2.days)
+
+      expect(Post.find_each(batch_size: 2).map(&:message)).to eq(["message1", "message2", "message3"])
+    end
+  end
+
+  describe "#find_in_batches" do
+    it "returns all records in batches" do
+      Post.create!(user: "user", domain: "domain", message: "message1", timestamp: Time.now)
+      Post.create!(user: "user", domain: "domain", message: "message2", timestamp: Time.now + 1.day)
+      Post.create!(user: "user", domain: "domain", message: "message3", timestamp: Time.now + 2.days)
+
+      expect(Post.find_in_batches(batch_size: 2).map { |batch| batch.map(&:message) }).to eq([["message1", "message2"], ["message3"]])
+    end
+  end
+
+  describe "#count" do
+    it "returns the number of records" do
+      Post.create!(user: "user1", domain: "domain", timestamp: Time.now)
+      Post.create!(user: "user1", domain: "domain", timestamp: Time.now)
+      Post.create!(user: "user2", domain: "domain", timestamp: Time.now)
+
+      expect(Post.count).to eq(3)
+      expect(Post.where(user: "user1", domain: "domain").count).to eq(2)
+    end
+  end
+
+  describe "#delete_all" do
+    it "deletes the specified records" do
+      _post1 = Post.create!(user: "user", domain: "domain1", timestamp: Time.now)
+      _post2 = Post.create!(user: "user", domain: "domain1", timestamp: Time.now)
+      post3 = Post.create!(user: "user", domain: "domain2", timestamp: Time.now)
+
+      Post.where(user: "user", domain: "domain1").delete_all
+
+      expect(Post.all.to_a).to eq([post3])
+    end
+  end
+
+  describe "#delete_in_batches" do
+    it "deletes the records in batches" do
+      _post1 = Post.create!(user: "user", domain: "domain1", timestamp: Time.now)
+      _post2 = Post.create!(user: "user", domain: "domain1", timestamp: Time.now)
+      post3 = Post.create!(user: "user", domain: "domain2", timestamp: Time.now)
+
+      Post.where(user: "user", domain: "domain1").delete_in_batches
+
+      expect(Post.all.to_a).to eq([post3])
+    end
+  end
+
+  describe "#to_a" do
+    it "converts the relation to an array" do
+      Post.create!(user: "user", domain: "domain1", message: "message1", timestamp: Time.now)
+      Post.create!(user: "user", domain: "domain1", message: "message2", timestamp: Time.now)
+      Post.create!(user: "user", domain: "domain2", message: "message3", timestamp: Time.now)
+
+      expect(Post.where(user: "user", domain: "domain1").to_a.map(&:message).to_set).to eq(["message1", "message2"].to_set)
+    end
+  end
+end

data/spec/cassandra_store/schema_migration_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path("../spec_helper", __dir__)
+
+RSpec.describe CassandraStore::SchemaMigration do
+  describe ".create_table" do
+    it "creates the schema migration table" do
+      expect { described_class.create(version: Time.now.to_i) }.to raise_error(Cassandra::Errors::InvalidError)
+
+      described_class.create_table
+
+      expect { described_class.create(version: Time.now.to_i) }.not_to raise_error
+    end
+
+    it "respects the if_not_exists option" do
+      described_class.create_table
+
+      expect { described_class.create_table(if_not_exists: true) }.not_to raise_error
+    end
+  end
+end

data/spec/fixtures/1589957812_migration1.rb

@@ -0,0 +1,5 @@
+class Migration1 < CassandraStore::Migration
+  def up; end
+
+  def down; end
+end

data/spec/fixtures/1589957813_migration2.rb

@@ -0,0 +1,5 @@
+class Migration2 < CassandraStore::Migration
+  def up; end
+
+  def down; end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,87 @@
+require "cassandra_store"
+
+CassandraStore::Base.configure(
+  keyspace: "cassandra_store",
+  replication: { class: "SimpleStrategy", replication_factor: 1 }
+)
+
+CassandraStore::Base.drop_keyspace(if_exists: true)
+CassandraStore::Base.create_keyspace
+
+CassandraStore::Base.execute <<CQL
+  CREATE TABLE posts(
+    user TEXT,
+    domain TEXT,
+    id TIMEUUID,
+    message TEXT,
+    timestamp TIMESTAMP,
+    PRIMARY KEY((user, domain), id)
+  )
+CQL
+
+class Post < CassandraStore::Base
+  column :user, :text, partition_key: true
+  column :domain, :text, partition_key: true
+  column :id, :timeuuid, clustering_key: true
+  column :message, :text
+  column :timestamp, :timestamp
+
+  before_create do
+    self.timestamp ||= Time.now
+    self.id ||= generate_timeuuid(timestamp)
+  end
+end
+
+CassandraStore::Base.execute <<CQL
+  CREATE TABLE test_logs(
+    date DATE,
+    bucket INT,
+    id TIMEUUID,
+    query TEXT,
+    username TEXT,
+    timestamp TIMESTAMP,
+    PRIMARY KEY((date, bucket), id)
+  )
+CQL
+
+class TestLog < CassandraStore::Base
+  column :date, :date, partition_key: true
+  column :bucket, :int, partition_key: true
+  column :id, :timeuuid, clustering_key: true
+  column :query, :text
+  column :username, :text
+  column :timestamp, :timestamp
+
+  validates_presence_of :timestamp
+
+  def self.bucket_for(id)
+    Digest::SHA1.hexdigest(id.to_s)[0].to_i(16) % 8
+  end
+
+  before_create do
+    self.id = generate_timeuuid(timestamp)
+
+    self.date = id.to_date.strftime("%F")
+    self.bucket = self.class.bucket_for(id)
+  end
+end
+
+class TestLogWithContext < TestLog
+  def self.table_name
+    "test_logs"
+  end
+
+  validates_presence_of :username, on: :create
+  validates_presence_of :query, on: :update
+end
+
+RSpec.configure do |config|
+  config.before do
+    CassandraStore::Base.execute <<~CQL
+      DROP TABLE IF EXISTS schema_migrations
+    CQL
+
+    TestLog.delete_in_batches
+    Post.delete_in_batches
+  end
+end

metadata

@@ -0,0 +1,214 @@
+--- !ruby/object:Gem::Specification
+name: cassandra_store
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Benjamin Vetter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: cassandra-driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: connection_pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Powerful ORM for Cassandra
+email:
+- vetter@flakks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cassandra_store.gemspec
+- docker-compose.yml
+- lib/cassandra_store.rb
+- lib/cassandra_store/base.rb
+- lib/cassandra_store/migration.rb
+- lib/cassandra_store/railtie.rb
+- lib/cassandra_store/relation.rb
+- lib/cassandra_store/schema_migration.rb
+- lib/cassandra_store/tasks/cassandra.rake
+- lib/cassandra_store/version.rb
+- spec/cassandra_store/base_spec.rb
+- spec/cassandra_store/migration_spec.rb
+- spec/cassandra_store/relation_spec.rb
+- spec/cassandra_store/schema_migration_spec.rb
+- spec/fixtures/1589957812_migration1.rb
+- spec/fixtures/1589957813_migration2.rb
+- spec/spec_helper.rb
+homepage: https://github.com/mrkamel/cassandra_store
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Easy to use ActiveRecord like ORM for Cassandra
+test_files:
+- spec/cassandra_store/base_spec.rb
+- spec/cassandra_store/migration_spec.rb
+- spec/cassandra_store/relation_spec.rb
+- spec/cassandra_store/schema_migration_spec.rb
+- spec/fixtures/1589957812_migration1.rb
+- spec/fixtures/1589957813_migration2.rb
+- spec/spec_helper.rb