cassandro 0.2.0 → 0.3.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjdiYjhlYzUyNGRhZjJhNzQ5Y2I5NWQ5Nzk0OTkzMTVjYzEzZDBiOA==
+    NzRiYWJkNjAzZjJhODZjZDIzMGQzY2Q4MjlmM2QxOGUwMmM4ZjQxMQ==
   data.tar.gz: !binary |-
-    M2RjMGIxMWRiYzYxMDIxMTgxYjA5ODY5YmM0ZjQ5YzU2NGY5Y2JiNA==
+    NDM2NzY2N2FiN2RmYzQ1NzE2N2JjZDIxOGFlNDAyMDg2YTQwZjQzYQ==
 SHA512:
   metadata.gz: !binary |-
-    MjZmMGE4NzA3ZDdlNDViYzI2M2IyM2I3NWYzY2Q3ZThjYzBjODk1Yzg1NThk
-    NTBjMjcyMDE4MTc2ZDhlZWU4YzNjMjhmM2VkOWMzMzY0MWRkNTEyOWY2YTFh
-    MDE1OTA3NzJkOGFjZGRkNGI3N2VkMDk4Mjk1MjUxZWFiZmQzNjY=
+    Y2I4YjVkMTFkZjM5MmFiZDlmNGU2MDJjNzAzMjAxYWIzYzc0NmQ0MWI0NDBj
+    NjBiYzVmNTAzMjk0ZmI1MzUwM2E4ZTUyNTgyMjliODQ3NGQyZDE2NTlkOWQ1
+    M2QyYWUzNDQxNWE4NjM3ZjUyYTk4OWI4NjlhNDRmOTZmNzNmMTg=
   data.tar.gz: !binary |-
-    ODE4YzQzY2IzMDI0NGM3MThhOTVkMzgxZmE4ODA5NDNiOGM2MmU3ZGU2Y2Y2
-    ZDA1NGUyMmRlYmI2MDQxNWJjMTYzYzY5MDY1OWQ3ZTVkZTlkZTY4ZGNlYTZl
-    MzVmNzYzMWEwZWY0YzU1MjdkNGY5ZWQyNTQ4NDkzY2EyMzI3ZTE=
+    YWQ1ZTE2ZTk0NmI2YWNmMTczMWNlZTI3ZjdmMTllYjY4N2JlMDNmMDRmNGFk
+    MTYzODhjOGM2MTExNzE3ZmExZTVkMzM4NDlkYzNkNzBhNjM0OGExNTJkZmQ0
+    NzNmNzU5NjRlYjg0ZTBlZDYzNTVkYjg5NzU4M2ZlM2QxOTI4MWQ=

data/README.md

@@ -223,9 +223,67 @@ user.errors
 
 ```
 
+## Migrations
+
+Define your migrations by extending from `Cassandro::Migration`
+
+```ruby
+class UserMigration < Cassandro::Migration
+  version 1
+
+  def up
+    execute <<-TABLEDEF
+      CREATE TABLE users (
+        id UUID,
+        first_name VARCHAR,
+        last_name VARCHAR,
+        email VARCHAR,
+        PRIMARY KEY(id, email)
+      )
+    TABLEDEF
+  end
+
+  def down
+    execute <<-QUERY
+      DROP TABLE users;
+    QUERY
+  end
+end
+
+class UserGenderMigration < Cassandro::Migration
+
+  version 2
+
+  def up
+    execute <<-TABLEUPDATE
+      ALTER TABLE users ADD gender VARCHAR
+    TABLEUPDATE
+  end
+
+  def down
+    execute <<-QUERY
+      ALTER TABLE users DROP gender
+    QUERY
+  end
+end
+```
+
+Then use `Cassandro::Migrator` to run your migrations
+
+```ruby
+Cassandro.connect(hosts: ['127.0.0.1'], keyspace: 'some_keyspace')
+
+migrator = Cassandro::Migrator.new('./path/to/migrations', Logger.new(STDOUT))
+
+migrator.migrate!(:up) #migrates to last version
+migrator.migrate!(:down) #apply all downgrades
+
+migrator.migrate!(:up, 2) #migrates up to version 2
+migrator.migrate!(:down, 1) #migrates down to version 1
+```
+
 ## TODO
 
-* Migrations
 * Support Index
 * Better queries
 * Better documentation

data/cassandro.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "cassandro"
-  s.version = "0.2.0"
+  s.version = "0.3.0"
   s.summary = "Ruby ORM for Apache Cassandra"
   s.license = "MIT"
   s.description = "Lightweight Apache Cassandra ORM for Ruby"

data/lib/cassandro.rb

@@ -2,3 +2,4 @@ require_relative './cassandro/core'
 require_relative './cassandro/support/hash'
 require_relative './cassandro/ext/soft_delete'
 require_relative './cassandro/model'
+require_relative './cassandro/migrations'

data/lib/cassandro/ext/migration.rb

@@ -0,0 +1,29 @@
+module Cassandro
+  class Migration
+    @@migrations = []
+
+    def up; end
+
+    def down; end
+
+    def execute(query)
+      Cassandro.client.execute(query)
+    end
+
+    def self.version(version_number)
+      @@migrations[version_number.to_i] = self.name
+    end
+
+    def self.migrations
+      @@migrations
+    end
+
+    def self.apply(direction = :up)
+      new.send(direction)
+    end
+
+    def self.clean
+      @@migrations = []
+    end
+  end
+end

data/lib/cassandro/ext/migrator.rb

@@ -0,0 +1,74 @@
+require 'logger'
+
+module Cassandro
+  class Migrator
+
+    def initialize(path, logger = ::Logger.new(STDOUT))
+      Dir["#{path}/**/*.rb"].each { |file| require file }
+      @migrations = Cassandro::Migration.migrations
+      @logger = logger
+
+      Cassandro.client.execute CassandroMigration.schema
+
+      version = CassandroMigration[name: 'version'] || CassandroMigration.create(name: 'version', value: "0")
+
+      @current_version = version
+    end
+
+    def migrate!(direction, to = '.')
+      from = @current_version.value.to_i
+
+      case direction
+      when :up
+        to   = (to == '.' ? @migrations.size - 1 : to).to_i
+        return @logger.error "Can't migrate up to a prev version (#{from} to #{to})" if to < from
+        return @logger.info  "Database is up to date" if to == from
+
+        @logger.info "Upgrading database from version #{from} to #{to}"
+        begin
+          @migrations[from+1..to].each do |migration|
+            Object.const_get(migration).apply(:up)
+          end
+          @current_version.update_attributes(value: to.to_s)
+          @logger.info "OK"
+        rescue => e
+          @logger.error e.message
+        end
+      when :down
+        to   = (to == '.' ? 0 : to).to_i
+        return @logger.error "Can't migrate down to a higher version (#{from} to #{to})" if to > from
+        return @logger.info  "Database is up to date" if to == from
+
+        @logger.info "Drowngrading database from version #{from} to #{to}"
+        begin
+          @migrations[to+1..from].reverse_each do |migration|
+            Object.const_get(migration).apply(:down)
+          end
+          @current_version.update_attributes(value: to.to_s)
+          @logger.info "OK"
+        rescue => e
+          @logger.error e.message
+        end
+      end
+    end
+
+    class CassandroMigration < Cassandro::Model
+      table :cassandro_migrations
+
+      attribute :name, :text
+      attribute :value, :text
+
+      primary_key [:name]
+
+      def self.schema
+        <<-TABLEDEF
+          CREATE TABLE IF NOT EXISTS cassandro_migrations (
+            name VARCHAR,
+            value VARCHAR,
+            PRIMARY KEY (name)
+          )
+        TABLEDEF
+      end
+    end
+  end
+end

data/lib/cassandro/migrations.rb

@@ -0,0 +1,2 @@
+require_relative 'ext/migration'
+require_relative 'ext/migrator'

data/test/cassandro_migration_test.rb

@@ -0,0 +1,21 @@
+require_relative 'helper'
+
+Protest.describe "Cassandro Migration" do
+  setup do
+    Cassandro.connect(hosts: ['127.0.0.1'], keyspace: 'cassandro_test')
+  end
+
+  test "enqueue migrations" do
+    class FirstMigration < Cassandro::Migration
+      version 1
+    end
+
+    class SecondMigration < Cassandro::Migration
+      version 2
+    end
+
+    assert_equal 2, Cassandro::Migration.migrations.compact.size
+    assert_equal "FirstMigration", Cassandro::Migration.migrations[1]
+    assert_equal "SecondMigration", Cassandro::Migration.migrations[2]
+  end
+end

data/test/cassandro_migrator_test.rb

@@ -0,0 +1,66 @@
+require_relative 'helper'
+
+Protest.describe "Cassandro Migrator" do
+  setup do
+    #Cassandro::Migration.cleaassandra::Errors::InvalidError
+    Cassandro.client.execute("DROP TABLE IF EXISTS users")
+    Cassandro.client.execute("DROP TABLE IF EXISTS animals")
+    Cassandro.client.execute("DROP TABLE IF EXISTS cassandro_migrations")
+    @migrator = Cassandro::Migrator.new("./test/support/migrations", Logger.new('/dev/null'))
+  end
+
+  context "Migrating up" do
+
+    test "to last version" do
+       @migrator.migrate!(:up)
+       version = Cassandro::Migrator::CassandroMigration[name: 'version']
+
+       assert_equal 3, version.value.to_i
+       assert_equal Cassandra::Results::Paged, Cassandro.client.execute("SELECT * FROM users").class
+       assert_equal Cassandra::Results::Paged, Cassandro.client.execute("SELECT * FROM animals").class
+    end
+
+    test "to specific version" do
+      @migrator.migrate!(:up, 1)
+      version = Cassandro::Migrator::CassandroMigration[name: 'version']
+
+      assert_equal 1, version.value.to_i
+      assert_equal Cassandra::Results::Paged, Cassandro.client.execute("SELECT * FROM users").class
+      assert_raise Cassandra::Errors::InvalidError, "unconfigured columnfamily animals" do
+        Cassandro.client.execute("SELECT * FROM animals")
+      end
+    end
+  end
+
+  context 'Migrating down' do
+    setup do
+      @migrator.migrate!(:up)
+    end
+
+    test "to version 0" do
+      @migrator.migrate!(:down)
+
+      version = Cassandro::Migrator::CassandroMigration[name: 'version']
+
+      assert_equal 0, version.value.to_i
+      assert_raise Cassandra::Errors::InvalidError, "unconfigured columnfamily users" do
+        Cassandro.client.execute("SELECT * FROM users")
+      end
+      assert_raise Cassandra::Errors::InvalidError, "unconfigured columnfamily animals" do
+        Cassandro.client.execute("SELECT * FROM animals")
+      end
+    end
+
+    test "to specific version" do
+      @migrator.migrate!(:down, 1)
+
+      version = Cassandro::Migrator::CassandroMigration[name: 'version']
+
+      assert_equal 1, version.value.to_i
+      assert_equal Cassandra::Results::Paged, Cassandro.client.execute("SELECT * FROM users").class
+      assert_raise Cassandra::Errors::InvalidError, "unconfigured columnfamily animals" do
+        Cassandro.client.execute("SELECT * FROM animals")
+      end
+    end
+  end
+end

data/test/support/migrations/animals_table.rb

@@ -0,0 +1,20 @@
+class AnimalMigration < Cassandro::Migration
+  version 3
+
+  def up
+    execute <<-TABLEDEF
+      CREATE TABLE animals (
+        family VARCHAR,
+        genus VARCHAR,
+        name VARCHAR,
+        PRIMARY KEY(family, genus)
+      )
+    TABLEDEF
+  end
+
+  def down
+    execute <<-QUERY
+      DROP TABLE animals;
+    QUERY
+  end
+end

data/test/support/migrations/update_user_table.rb

@@ -0,0 +1,16 @@
+class UserGenderMigration < Cassandro::Migration
+
+  version 2
+
+  def up
+    execute <<-TABLEUPDATE
+      ALTER TABLE users ADD gender VARCHAR
+    TABLEUPDATE
+  end
+
+  def down
+    execute <<-QUERY
+      ALTER TABLE users DROP gender
+    QUERY
+  end
+end

data/test/support/migrations/user_table.rb

@@ -0,0 +1,23 @@
+class UserMigration < Cassandro::Migration
+
+  version 1
+
+  def up
+    execute <<-TABLEDEF
+      CREATE TABLE users (
+        id UUID,
+        first_name VARCHAR,
+        last_name VARCHAR,
+        email VARCHAR,
+        PRIMARY KEY(id, email)
+      )
+    TABLEDEF
+  end
+
+  def down
+    execute <<-QUERY
+      DROP TABLE users;
+    QUERY
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cassandro
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Lautaro Orazi
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cassandra-driver
@@ -55,13 +55,21 @@ files:
 - cassandro.gemspec
 - lib/cassandro.rb
 - lib/cassandro/core.rb
+- lib/cassandro/ext/migration.rb
+- lib/cassandro/ext/migrator.rb
 - lib/cassandro/ext/soft_delete.rb
+- lib/cassandro/migrations.rb
 - lib/cassandro/model.rb
 - lib/cassandro/support/hash.rb
 - rakefile
+- test/cassandro_migration_test.rb
+- test/cassandro_migrator_test.rb
 - test/cassandro_model_test.rb
 - test/cassandro_test.rb
 - test/helper.rb
+- test/support/migrations/animals_table.rb
+- test/support/migrations/update_user_table.rb
+- test/support/migrations/user_table.rb
 - test/support/tables.rb
 homepage: https://github.com/tarolandia/cassandro
 licenses: