cassanity 0.6.0.beta5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f0756deb7322a0613027e49cf30ec6d37f9643d
-  data.tar.gz: c7f1f8679988d87049daeb929e657223ea2747f0
+  metadata.gz: 8463dccda7b4fa69e8920bf632ff5436c752c8c0
+  data.tar.gz: 72fb90eb87e6fdff894d017f4be9cdc4c1c4c09f
 SHA512:
-  metadata.gz: d68305b3a2395732a858d158212234667b8b2cf16353dde999d6774e7e214ac6e0be240416eb9b9b649d46be53bba9f7bd89f7e6d7b7f5fa3b8d70af84ed5076
-  data.tar.gz: edf5a6e070675b6994f9f31e5a0c746e93216a584409ae0856f4a26266210b5122de97c81f473946ff17ae20f72e81f0f3bebf3e00dcb499f5993736ab1bbd85
+  metadata.gz: 3fddf06889ca7c6be97a23c07708ec0d714aac31515e7d499a4ba41adb2fcd368f074b492408711b0710f61978971d5c9511b7af9fa3cca6d8ffeac17adb21cb
+  data.tar.gz: 280945481fa843e44c334269a5b632bcff9742a599e5ceb7b5fe40663824fbfb099a093eb04eb8822221099ace095ac60a10d5a8fd2345e1e2af4d9fa5c122a9

data/README.md

@@ -90,6 +90,7 @@ You can also do a lot more. Here are a few more [examples](https://github.com/jn
 * [Keyspaces](https://github.com/jnunemaker/cassanity/tree/master/examples/keyspaces.rb)
 * [Column Families](https://github.com/jnunemaker/cassanity/tree/master/examples/column_families.rb)
 * [Select a Range](https://github.com/jnunemaker/cassanity/tree/master/examples/select_range.rb)
+* [Collections](https://github.com/jnunemaker/cassanity/tree/master/examples/collections.rb)
 
 ## More Reading
 

data/doc/Migrations.md

@@ -18,9 +18,11 @@ mkdir -p db/migrate
 Second, create a file for the create users migration:
 
 ```bash
-touch db/migrate/001_create_users.rb
+touch db/migrate/`date +%s`_create_users.rb
 ```
 
+This will create a file with the current timestamp as the prefix. This is the recommended naming convention.
+
 Now, open the file up in your favorite editor and paste in the following:
 
 ```ruby
@@ -112,20 +114,7 @@ migrator.migrate_to(0, :down)
 migrator.migrate_to(1, :up)
 ```
 
-## Migration Version Numbers
-
-In the example above, I used a migration with a version of 001. The only requirement cassanity enforces on migration version numbers is that they be an integer. This means that you can you timestamped migrations if you prefer. For example, the following are all completely valid migration names.
-
-```
-touch db/migrate/001_create_users.rb
-touch db/migrate/201303_create_users.rb
-touch db/migrate/20130304_create_users.rb
-touch db/migrate/20130304160000_create_users.rb
-```
-
-The version could be year, month, day, hour, minute, second (20130304160000, 4:00pm on March 4, 2013), as in the example I just showed, or you could standardize on year, month, day (20130304, March 4, 2013).
-
-**Note**: Migrations will run in the order they appear on disk. They are sorted by their path, which means if you do not go with timestamped migrations, you should padd migrations with leading zero's, as Rails does (ie: "001" instead of "01" or "1").
+**Note**: Migrations will run in the order they appear on disk (alphanumerically sorted), that's why we encourage you to use timestamped migrations.
 
 ## Rake Tasks
 

data/examples/collections.rb

@@ -0,0 +1,82 @@
+require_relative '_shared'
+require 'cassanity'
+
+client = Cassanity::Client.new(['127.0.0.1'], 9042, {
+  instrumenter: ActiveSupport::Notifications,
+})
+
+keyspace = client['cassanity_examples']
+keyspace.recreate
+
+# setup column family
+users = keyspace.column_family('users', {
+  schema: {
+    primary_key: :id,
+    columns: {
+      id: :text,
+      emails: :"set<text>",
+      top_places: :"list<text>",
+      todo: :"map<timestamp,text>",
+    },
+  },
+})
+users.create
+
+
+## Sets
+
+# insert a row
+users.insert(data: {id: '1', emails: Set['f@baggings.com','baggins@gmail.com']})
+
+# add an element to the set
+users.update(set: {emails: Cassanity.set_add('a@b.com')}, where: {id: '1'})
+
+# delete an element from the set
+users.update(set: {emails: Cassanity.set_remove('f@baggings.com')}, where: {id: '1'})
+
+# delete all elements from the set
+users.delete(columns: :emails, where: {id: '1'})
+# or
+users.update(set: {emails: Set[]}, where: {id: '1'})
+
+
+## Lists
+
+# insert a row
+users.insert(data: {id: '2', top_places: ['mordor','rivendell','rohan']})
+
+# add an element to the list
+users.update(set: {top_places: Cassanity.add('the shire')}, where: {id: '2'})
+
+# update an element by its index
+users.update(set: {top_places: Cassanity.item(0,'riddermark')}, where: {id: '2'})
+
+# delete an element or more from the list
+users.update(set: {top_places: Cassanity.remove('riddermark', 'rivendell')}, where: {id: '2'})
+# or delete an element by its index
+users.delete(columns: Cassanity.item(0, :top_places), where: {id: '2'})
+
+# delete all elements from the list
+users.delete(columns: :top_places, where: {id: '2'})
+# or
+users.update(set: {top_places: []}, where: {id: '2'})
+
+
+## Maps
+require 'date'
+today = Date.today
+tomorrow = today + 1
+
+# insert a row
+users.insert(data: {id: '3', todo: {today.to_time => 'enter mordor'}})
+
+# add/update an element to the map
+users.update(set: {todo: Cassanity.item(tomorrow.to_time, 'find water')}, where: {id: '3'})
+
+# delete an element from the map
+users.delete(columns: Cassanity.item(tomorrow.to_time, :todo), where: {id: '3'})
+
+# delete all elements from the map
+users.delete(columns: :todo, where: {id: '3'})
+# or
+users.update(set: {todo: {}}, where: {id: '3'})

data/lib/cassanity.rb

@@ -6,6 +6,11 @@ require 'cassanity/operators/lte'
 require 'cassanity/increment'
 require 'cassanity/decrement'
 require 'cassanity/range'
+require 'cassanity/addition'
+require 'cassanity/removal'
+require 'cassanity/set_addition'
+require 'cassanity/set_removal'
+require 'cassanity/collection_item'
 
 module Cassanity
   # Public: Shortcut for returning an equality operator.
@@ -83,6 +88,52 @@ module Cassanity
     Cassanity::Range.new(start, finish, exclusive)
   end
 
+  # Public: Shortcut for returning an addition value for a list collection.
+  #
+  # values - The values to add to the list.
+  #
+  # Returns an Cassanity::Addition instance.
+  def self.add(*values)
+    Addition.new(*values)
+  end
+
+  # Public: Shortcut for returning a removal value for a list collection.
+  #
+  # values - The values to remove from the list.
+  #
+  # Returns an Cassanity::Removal instance.
+  def self.remove(*values)
+    Removal.new(*values)
+  end
+
+  # Public: Shortcut for returning an addition value for a set collection.
+  #
+  # value - The values to add to the set.
+  #
+  # Returns an Cassanity::SetAddition instance.
+  def self.set_add(*values)
+    SetAddition.new(*values)
+  end
+
+  # Public: Shortcut for returning a removal value for a set collection.
+  #
+  # values - The values to remove from the set.
+  #
+  # Returns an Cassanity::SetRemoval instance.
+  def self.set_remove(*values)
+    SetRemoval.new(*values)
+  end
+
+  # Public: Shortcut for returning a collection item.
+  #
+  # key - The item key in the list/map collection
+  # value - The item value.
+  #
+  # Returns a Cassanity::CollectionItem instance.
+  def self.item(key, value)
+    CollectionItem.new(key, value)
+  end
+
   class << self
     alias_method :equal, :eq
 
@@ -97,6 +148,9 @@ module Cassanity
 
     alias_method :decr, :dec
     alias_method :decrement, :dec
+
+    alias_method :sadd, :set_add
+    alias_method :sremove, :set_remove
   end
 end
 

data/lib/cassanity/addition.rb

@@ -0,0 +1,15 @@
+module Cassanity
+  def self.Addition(*args)
+    Addition.new(*args)
+  end
+
+  class Addition < Operator
+    # Public: Returns an addition instance
+    def initialize(*args)
+      values = args.flatten.compact
+      raise ArgumentError.new("value cannot be nil") if values.empty?
+
+      super :+, values
+    end
+  end
+end

data/lib/cassanity/argument_generators/batch.rb

@@ -4,6 +4,9 @@ module Cassanity
   module ArgumentGenerators
     class Batch
 
+      # Private: List of supported batch types
+      BatchTypes = ['COUNTER','LOGGED','UNLOGGED']
+
       # Private: Map of command to argument generator
       Commands = {
         insert: ColumnFamilyInsert.new,
@@ -19,11 +22,15 @@ module Cassanity
 
       # Internal
       def call(args = {})
+        type = args[:type].to_s.upcase
+        type = 'LOGGED' if type.empty?
+        raise ArgumentError.new("invalid batch type") unless BatchTypes.include?(type)
+
         using = args[:using]
         modifications_argument = args.fetch(:modifications) { [] }
 
         variables = []
-        cql = "BEGIN BATCH"
+        cql = type == 'LOGGED' ? "BEGIN BATCH" : "BEGIN #{type} BATCH"
 
         using_cql, *using_variables = @using_clause.call(using: using)
         cql << using_cql

data/lib/cassanity/argument_generators/column_family_create.rb

@@ -27,7 +27,7 @@ module Cassanity
           definitions << "#{name} #{type}"
         end
 
-        definitions << "PRIMARY KEY (#{primary_keys.join(', ')})"
+        definitions << "PRIMARY KEY (#{compose_primary_key(primary_keys).join(', ')})"
 
         cql_definition = definitions.join(', ')
 
@@ -39,6 +39,16 @@ module Cassanity
 
         [cql, *variables]
       end
+
+      def compose_primary_key(primary_keys)
+        primary_keys.map do |key|
+          if key.is_a? Array
+            "(#{key.join(', ')})"
+          else
+            key
+          end
+        end
+      end
     end
   end
 end

data/lib/cassanity/argument_generators/column_family_delete.rb

@@ -15,7 +15,7 @@ module Cassanity
       def call(args = {})
         name    = args.fetch(:column_family_name)
         where   = args.fetch(:where)
-        columns = Array(args.fetch(:columns) { [] })
+        columns = args.fetch(:columns) { [] }
         using   = args[:using]
 
         if (keyspace_name = args[:keyspace_name])
@@ -23,10 +23,25 @@ module Cassanity
         end
 
         column_clause, variables = '', []
-
-        unless columns.empty?
-          column_clause = " #{columns.join(', ')}"
+        columns ||= []
+
+        cols = []
+        [columns].flatten.each do |c|
+          if Hash === c
+            column_name = c.keys.first
+            keys = c.values.first
+            [keys].flatten.each do |k| 
+              cols << "#{column_name}[?]"
+              variables << k
+            end
+          elsif Cassanity::CollectionItem === c
+            cols << "#{c.value}[?]"
+            variables << c.key
+          else
+            cols << c
+          end
         end
+        column_clause = " #{cols.join(', ')}".rstrip
 
         cql = "DELETE#{column_clause} FROM #{name}"
 

data/lib/cassanity/argument_generators/keyspace_create.rb

@@ -14,7 +14,11 @@ module Cassanity
         name = args.fetch(:keyspace_name)
         cql = "CREATE KEYSPACE #{name}"
 
-        replication = default_replication_options.merge(args[:replication] || {})
+        replication = args.fetch(:replication, {})
+
+        if replication.empty? || replication[:class] !~ /NetworkTopologyStrategy/
+          replication = default_replication_options.merge(replication)
+        end
 
         with_cql, *with_variables = @with_clause.call(with: { replication: replication })
         cql << with_cql

data/lib/cassanity/argument_generators/set_clause.rb

@@ -12,9 +12,12 @@ module Cassanity
 
         set.each do |key, value|
           case value
-          when Cassanity::Increment, Cassanity::Decrement
+          when Cassanity::Increment, Cassanity::Decrement, Cassanity::Addition, Cassanity::Removal, Cassanity::SetAddition, Cassanity::SetRemoval
             sets << "#{key} = #{key} #{value.symbol} ?"
             variables << value.value
+          when Cassanity::CollectionItem
+            sets << "#{key}[?] = ?"
+            variables << value.key << value.value
           else
             sets << "#{key} = ?"
             variables << value

data/lib/cassanity/collection_item.rb

@@ -0,0 +1,39 @@
+module Cassanity
+  def self.CollectionItem(*args)
+    CollectionItem.new(*args)
+  end
+
+  class CollectionItem
+    # Internal
+    attr_reader :key
+
+    # Internal
+    attr_reader :value
+
+    # Public: Returns a collection item instance
+    def initialize(key, value)
+      raise ArgumentError.new("key cannot be nil") if key.nil?
+      raise ArgumentError.new("value cannot be nil") if value.nil?
+      
+      @key   = key
+      @value = value
+    end
+
+    def eql?(other)
+      self.class.eql?(other.class) &&
+        value == other.value &&
+        key == other.key
+    end
+
+    alias_method :==, :eql?
+
+    # Public
+    def inspect
+      attributes = [
+        "key=#{key.inspect}",
+        "value=#{value.inspect}",
+      ]
+      "#<#{self.class.name}:#{object_id} #{attributes.join(', ')}>"
+    end
+  end
+end

data/lib/cassanity/removal.rb

@@ -0,0 +1,15 @@
+module Cassanity
+  def self.Removal(*args)
+    Removal.new(*args)
+  end
+
+  class Removal < Operator
+    # Public: Returns a removal instance
+    def initialize(*args)
+      values = args.flatten.compact
+      raise ArgumentError.new("value cannot be nil") if values.empty?
+
+      super :-, values
+    end
+  end
+end

data/lib/cassanity/schema.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module Cassanity
   class Schema
     # Internal
@@ -57,8 +59,9 @@ module Cassanity
 
     # Private
     def primary_keys_are_defined_as_columns?
-      shared_columns = column_names & @primary_keys
-      shared_columns == @primary_keys
+      flattened_primary_keys = @primary_keys.flatten
+      shared_columns = column_names & flattened_primary_keys
+      shared_columns.to_set == flattened_primary_keys.to_set
     end
 
     # Public

data/lib/cassanity/set_addition.rb

@@ -0,0 +1,16 @@
+require 'cassanity/addition'
+require 'set'
+
+module Cassanity
+  def self.SetAddition(*args)
+    SetAddition.new(*args)
+  end
+
+  class SetAddition < Addition
+    # Public: Returns a set_addition instance
+    def initialize(*args)
+      super(*args)
+      @value = @value.to_set
+    end
+  end
+end

data/lib/cassanity/set_removal.rb

@@ -0,0 +1,16 @@
+require 'cassanity/removal'
+require 'set'
+
+module Cassanity
+  def self.SetRemoval(*args)
+    SetRemoval.new(*args)
+  end
+
+  class SetRemoval < Removal
+    # Public: Returns a set_removal instance
+    def initialize(*args)
+      super(*args)
+      @value = @value.to_set
+    end
+  end
+end