cassandra_store 1.0.0

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end

data/cassandra_store.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cassandra_store/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cassandra_store"
+  spec.version       = CassandraStore::VERSION
+  spec.authors       = ["Benjamin Vetter"]
+  spec.email         = ["vetter@flakks.com"]
+  spec.description   = %q{Powerful ORM for Cassandra}
+  spec.summary       = %q{Easy to use ActiveRecord like ORM for Cassandra}
+  spec.homepage      = "https://github.com/mrkamel/cassandra_store"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rubocop"
+
+  spec.add_dependency "activemodel", ">= 3.0"
+  spec.add_dependency "activesupport", ">= 3.0"
+  spec.add_dependency "cassandra-driver"
+  spec.add_dependency "connection_pool"
+  spec.add_dependency "hooks"
+end

data/docker-compose.yml

@@ -0,0 +1,9 @@
+  cassandra:
+    image: cassandra:3.11
+    environment:
+      - MAX_HEAP_SIZE=512m
+      - HEAP_NEWSIZE=128m
+      - KEYSPACES=cassandra_store
+    ports:
+      - 127.0.0.1:9042:9042
+

data/lib/cassandra_store.rb

@@ -0,0 +1,18 @@
+require "cassandra"
+require "connection_pool"
+require "active_model"
+require "active_support/all"
+require "hooks"
+
+require "cassandra_store/version"
+require "cassandra_store/base"
+require "cassandra_store/relation"
+require "cassandra_store/schema_migration"
+require "cassandra_store/migration"
+require "cassandra_store/railtie" if defined?(Rails)
+
+module CassandraStore
+  class RecordInvalid < StandardError; end
+  class RecordNotPersisted < StandardError; end
+  class UnknownType < StandardError; end
+end

data/lib/cassandra_store/base.rb

@@ -0,0 +1,426 @@
+class CassandraStore::Base
+  include ActiveModel::Dirty
+  include ActiveModel::Validations
+  include Hooks
+
+  class_attribute :keyspace_settings
+  class_attribute :cluster_pool
+  class_attribute :connection_pool
+
+  class_attribute :logger
+  self.logger = Logger.new(STDOUT)
+  logger.level = Logger::INFO
+
+  class_attribute :columns
+  self.columns = {}
+
+  define_hooks :before_validation, :after_validation
+  define_hooks :before_create, :after_create
+  define_hooks :before_update, :after_update
+  define_hooks :before_save, :after_save
+  define_hooks :before_destroy, :after_destroy
+
+  def self.configure(hosts: ["127.0.0.1"], keyspace:, cluster_settings: {}, replication: {}, durable_writes: true, pool: { size: 5, timeout: 5 })
+    self.keyspace_settings = { name: keyspace, replication: replication, durable_writes: durable_writes }
+
+    self.cluster_pool = ConnectionPool.new(pool) do
+      Cassandra.cluster(cluster_settings.merge(hosts: hosts)).connect
+    end
+
+    self.connection_pool = ConnectionPool.new(pool) do
+      Cassandra.cluster(cluster_settings.merge(hosts: hosts)).connect(keyspace)
+    end
+  end
+
+  def self.drop_keyspace(name: keyspace_settings[:name], if_exists: false)
+    cluster_execute("DROP KEYSPACE #{if_exists ? "IF EXISTS" : ""} #{quote_keyspace_name(name)}")
+  end
+
+  def self.create_keyspace(name: keyspace_settings[:name], replication: keyspace_settings[:replication], durable_writes: keyspace_settings[:durable_writes], if_not_exists: false)
+    cql = <<~CQL
+      CREATE KEYSPACE #{if_not_exists ? "IF NOT EXISTS" : ""} #{quote_keyspace_name(name)}
+        WITH REPLICATION = {
+          #{replication.map { |key, value| "#{quote_value(key)}: #{quote_value(value)}" }.join(", ")}
+        }
+        AND DURABLE_WRITES = #{quote_value(durable_writes)}
+    CQL
+
+    cluster_execute(cql)
+  end
+
+  def initialize(attributes = {})
+    @persisted = false
+    @destroyed = false
+
+    assign(attributes)
+  end
+
+  def ==(other)
+    other.instance_of?(self.class) && key_values == other.key_values
+  end
+
+  def eql?(other)
+    self == other
+  end
+
+  def hash
+    key_values.hash
+  end
+
+  def key_values
+    self.class.key_columns.map { |column, _| read_raw_attribute(column) }
+  end
+
+  def assign(attributes = {})
+    attributes.each do |column, value|
+      send(:"#{column}=", value)
+    end
+  end
+
+  def attributes
+    columns.each_with_object({}) do |(name, _), hash|
+      hash[name] = read_raw_attribute(name)
+    end
+  end
+
+  def read_raw_attribute(attribute)
+    return nil unless instance_variable_defined?(:"@#{attribute}")
+
+    instance_variable_get(:"@#{attribute}")
+  end
+
+  def write_raw_attribute(attribute, value)
+    instance_variable_set(:"@#{attribute}", value)
+  end
+
+  def self.create!(attributes = {})
+    new(attributes).tap(&:save!)
+  end
+
+  def self.create(attributes = {})
+    new(attributes).tap(&:save)
+  end
+
+  def save!
+    validate!
+
+    _save
+  end
+
+  def save
+    return false unless valid?
+
+    _save
+  end
+
+  def valid?(context = nil)
+    context ||= new_record? ? :create : :update
+
+    run_hook :before_validation
+
+    retval = super(context)
+
+    run_hook :after_validation
+
+    retval
+  end
+
+  def validate!(context = nil)
+    valid?(context) || raise(CassandraStore::RecordInvalid, errors.to_a.join(", "))
+  end
+
+  def persisted?
+    !!@persisted
+  end
+
+  def persisted!
+    @persisted = true
+  end
+
+  def new_record?
+    !persisted?
+  end
+
+  def destroyed?
+    !!@destroyed
+  end
+
+  def destroyed!
+    @destroyed = true
+  end
+
+  def update(attributes = {})
+    assign(attributes)
+
+    save
+  end
+
+  def update!(attributes = {})
+    assign(attributes)
+
+    save!
+  end
+
+  def destroy
+    raise CassandraStore::RecordNotPersisted unless persisted?
+
+    run_hook :before_destroy
+
+    delete
+
+    destroyed!
+
+    run_hook :after_destroy
+
+    true
+  end
+
+  def delete
+    raise CassandraStore::RecordNotPersisted unless persisted?
+
+    self.class.execute(delete_record_statement)
+
+    true
+  end
+
+  def self.table_name
+    name.tableize
+  end
+
+  def self.key_columns
+    partition_key_columns.merge(clustering_key_columns)
+  end
+
+  def self.partition_key_columns
+    columns.select { |_, options| options[:partition_key] }
+  end
+
+  def self.clustering_key_columns
+    columns.select { |_, options| options[:clustering_key] }
+  end
+
+  def self.column(name, type, partition_key: false, clustering_key: false)
+    self.columns = columns.merge(name => { type: type, partition_key: partition_key, clustering_key: clustering_key })
+
+    define_attribute_methods name
+
+    define_method name do
+      read_raw_attribute(name)
+    end
+
+    define_method :"#{name}=" do |value|
+      raise(ArgumentError, "Can't update key '#{name}' for persisted records") if persisted? && (self.class.columns[name][:partition_key] || self.class.columns[name][:clustering_key])
+
+      send :"#{name}_will_change!" unless read_raw_attribute(name) == value
+
+      write_raw_attribute(name, self.class.cast_value(value, type))
+    end
+  end
+
+  def self.relation
+    CassandraStore::Relation.new(target: self)
+  end
+
+  class << self
+    delegate :all, :where, :where_cql, :count, :limit, :first, :order, :distinct, :select, :find_each, :find_in_batches, :delete_in_batches, to: :relation
+  end
+
+  def self.cast_value(value, type)
+    return nil if value.nil?
+
+    case type
+    when :text
+      value.to_s
+    when :int, :bigint
+      Integer(value)
+    when :boolean
+      return true if [1, "1", "true", true].include?(value)
+      return false if [0, "0", "false", false].include?(value)
+
+      raise ArgumentError, "Can't cast '#{value}' to #{type}"
+    when :date
+      if value.is_a?(String) then Date.parse(value)
+      elsif value.respond_to?(:to_date) then value.to_date
+      else raise(ArgumentError, "Can't cast '#{value}' to #{type}")
+      end
+    when :timestamp
+      if value.is_a?(String) then Time.parse(value)
+      elsif value.respond_to?(:to_time) then value.to_time
+      elsif value.is_a?(Numeric) then Time.at(value)
+      else raise(ArgumentError, "Can't cast '#{value}' to #{type}")
+      end.utc.round(3)
+    when :timeuuid
+      return value if value.is_a?(Cassandra::TimeUuid)
+      return Cassandra::TimeUuid.new(value) if value.is_a?(String) || value.is_a?(Integer)
+
+      raise ArgumentError, "Can't cast '#{value}' to #{type}"
+    when :uuid
+      return value if value.is_a?(Cassandra::Uuid)
+      return Cassandra::Uuid.new(value) if value.is_a?(String) || value.is_a?(Integer)
+
+      raise ArgumentError, "Can't cast '#{value}' to #{type}"
+    else
+      raise CassandraStore::UnknownType, "Unknown type #{type}"
+    end
+  end
+
+  def self.quote_keyspace_name(keyspace_name)
+    quote_column_name(keyspace_name)
+  end
+
+  def self.quote_table_name(table_name)
+    quote_column_name(table_name)
+  end
+
+  def self.quote_column_name(column_name)
+    raise(ArgumentError, "Invalid column name #{column_name}") if column_name.to_s.include?("\"")
+
+    "\"#{column_name}\""
+  end
+
+  def self.quote_value(value)
+    case value
+    when Time, ActiveSupport::TimeWithZone
+      (value.to_r * 1000).round.to_s
+    when DateTime
+      quote_value(value.utc.to_time)
+    when Date
+      quote_value(value.strftime("%Y-%m-%d"))
+    when Numeric, true, false, Cassandra::Uuid
+      value.to_s
+    else
+      quote_string(value.to_s)
+    end
+  end
+
+  def self.quote_string(string)
+    "'#{string.gsub("'", "''")}'"
+  end
+
+  def self.truncate_table
+    execute "TRUNCATE TABLE #{quote_table_name table_name}"
+  end
+
+  def self.cluster_execute(statement, options = {})
+    logger.debug(statement)
+
+    cluster_pool.with do |connection|
+      connection.execute(statement, options)
+    end
+  end
+
+  def self.execute(statement, options = {})
+    logger.debug(statement)
+
+    connection_pool.with do |connection|
+      connection.execute(statement, options)
+    end
+  end
+
+  def self.execute_batch(statements, options = {})
+    statements.each do |statement|
+      logger.debug(statement)
+    end
+
+    connection_pool.with do |connection|
+      batch = connection.send(:"#{options[:batch_type] || "logged"}_batch")
+
+      statements.each do |statement|
+        batch.add(statement)
+      end
+
+      connection.execute(batch, options.except(:batch_type))
+    end
+  end
+
+  def self.statement(template, args = {})
+    res = template.dup
+
+    args.each do |key, value|
+      res.gsub!(":#{key}", quote_value(value))
+    end
+
+    res
+  end
+
+  private
+
+  def _save
+    run_hook :before_save
+
+    if persisted?
+      update_record
+    else
+      create_record
+      persisted!
+    end
+
+    run_hook :after_save
+
+    changes_applied
+
+    true
+  end
+
+  def create_record
+    run_hook :before_create
+
+    self.class.execute(create_record_statement)
+
+    run_hook :after_create
+  end
+
+  def create_record_statement
+    columns_clause = changes.keys.map { |column_name| self.class.quote_column_name column_name }.join(", ")
+    values_clause = changes.values.map(&:last).map { |value| self.class.quote_value value }.join(", ")
+
+    "INSERT INTO #{self.class.quote_table_name self.class.table_name}(#{columns_clause}) VALUES(#{values_clause})"
+  end
+
+  def update_record
+    run_hook :before_update
+
+    self.class.execute_batch(update_record_statements) unless changes.empty?
+
+    run_hook :after_update
+  end
+
+  def update_record_statements
+    nils = changes.select { |_, (__, new_value)| new_value.nil? }
+    objs = changes.reject { |_, (__, new_value)| new_value.nil? }
+
+    statements = []
+
+    if nils.present?
+      statements << "DELETE #{nils.keys.join(", ")} FROM #{self.class.quote_table_name self.class.table_name} #{where_key_clause}"
+    end
+
+    if objs.present?
+      update_clause = objs.map { |column, (_, new_value)| "#{self.class.quote_column_name column} = #{self.class.quote_value new_value}" }.join(", ")
+
+      statements << "UPDATE #{self.class.quote_table_name self.class.table_name} SET #{update_clause} #{where_key_clause}"
+    end
+
+    statements
+  end
+
+  def delete_record_statement
+    "DELETE FROM #{self.class.quote_table_name self.class.table_name} #{where_key_clause}"
+  end
+
+  def where_key_clause
+    "WHERE #{self.class.key_columns.map { |column, _| "#{self.class.quote_column_name column} = #{self.class.quote_value read_raw_attribute(column)}" }.join(" AND ")}"
+  end
+
+  protected
+
+  def generate_uuid
+    @uuid_generator ||= Cassandra::Uuid::Generator.new
+    @uuid_generator.uuid
+  end
+
+  def generate_timeuuid(time = Time.now)
+    @timeuuid_generator ||= Cassandra::TimeUuid::Generator.new
+    @timeuuid_generator.at(time)
+  end
+end