cassandra_migrations 0.0.1.pre0

data/lib/cassandra_migrations.rb

@@ -0,0 +1,5 @@
+
+module CassandraMigrations
+end
+
+require 'cassandra_migrations/railtie' if defined?(Rails)

data/lib/cassandra_migrations/cassandra.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+
+require 'yaml'
+require 'cql'
+require 'cassandra_migrations/cassandra/query'
+require 'cassandra_migrations/cassandra/errors'
+require 'cassandra_migrations/cassandra/migrator'
+
+module CassandraMigrations::Cassandra
+  extend Query
+  
+  mattr_accessor :client
+  mattr_accessor :config 
+  
+  def self.start!
+    connect_to_server unless client
+    
+    # setup keyspace use
+    begin
+      use(config['keyspace'])
+    rescue Cql::QueryError # keyspace does not exist
+      raise Errors::UnexistingKeyspaceError, config['keyspace']
+    end
+  end
+  
+  def self.shutdown!
+    if client
+      client.shutdown!
+      self.client = nil
+    end
+      
+    self.config = nil if config
+  end
+  
+  def self.create_keyspace!
+    connect_to_server unless client
+    
+    begin
+      execute(
+        "CREATE KEYSPACE #{config['keyspace']} \
+         WITH replication = { \ 
+           'class':'#{config['replication']['class']}', \
+           'replication_factor': #{config['replication']['replication_factor']} \
+         }"
+      )
+      use(config['keyspace'])
+      execute("CREATE TABLE metadata (data_name varchar PRIMARY KEY, data_value varchar)") 
+      write("metadata", {:data_name => 'version', :data_value => '0'})
+    rescue Exception => exception
+      drop!
+      raise exception
+    end
+  end
+  
+  def self.drop!
+    connect_to_server unless client
+    
+    begin
+      execute("DROP KEYSPACE #{config['keyspace']}")
+    rescue Cql::QueryError
+      raise Errors::UnexistingKeyspaceError, config['keyspace']
+    end
+  end
+  
+  def self.use(keyspace)
+    raise Errors::ClientNotStartedError unless client
+    client.use(keyspace)
+  end
+
+  def self.execute(cql)
+    raise Errors::ClientNotStartedError unless client
+    client.execute(cql)
+  end  
+  
+private
+  
+  def self.connect_to_server
+    load_config
+    
+    begin
+      self.client = Cql::Client.new(:host => config['host'], :port => config['port'])
+      client.start!
+    rescue Cql::Io::ConnectionError => e
+      raise Errors::ConnectionError, e.message      
+    end
+  end
+  
+  def self.load_config
+    begin
+      self.config = YAML.load_file(Rails.root.join("config", "cassandra.yml"))[Rails.env]
+    rescue Errno::ENOENT
+      raise Errors::MissingConfigurationError
+    end
+  end
+end

data/lib/cassandra_migrations/cassandra/errors.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module CassandraMigrations::Cassandra
+  module Errors
+
+    class CassandraError < StandardError
+    end
+    
+    class ClientNotStartedError < CassandraError
+      def initialize
+        super("Cassandra.start has not been called yet! Can't execute queries before connecting to server...")
+      end
+    end
+    
+    class MissingConfigurationError < CassandraError
+      def initialize
+        super("config/cassandra.yml is missing use this as example: \n\
+               development: \n\
+                 host: '127.0.0.1' \n\
+                 port: 9042 \n\
+                 keyspace: 'lme_smart_grid_server_development' \n\
+                 replication: \n\
+                   class: 'SimpleStrategy' \n\
+                   replication_factor: 1
+              ")
+      end
+    end
+    
+    class UnexistingKeyspaceError < CassandraError
+      def initialize(keyspace)
+        super("Keyspace #{keyspace} does not exist. Run rake cassandra:create.")
+      end
+    end
+    
+    class ConnectionError < CassandraError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+    
+  end
+end

data/lib/cassandra_migrations/cassandra/migrator.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+
+module CassandraMigrations::Cassandra
+  module Migrator
+    
+    def self.up_to_latest
+      current_version = read_current_version
+  
+      new_migrations = get_all_migration_names.sort.select do |migration_name|
+        get_version_from_migration_name(migration_name) > current_version
+      end
+        
+      if !new_migrations.empty?
+        new_migrations.each { |migration| up(migration) }
+      end
+      
+      new_migrations.size
+    end
+  
+    def self.rollback(count=1)
+      current_version = read_current_version
+      
+      executed_migrations = get_all_migration_names.sort.reverse.select do |migration_name|
+        get_version_from_migration_name(migration_name) <= current_version
+      end
+      
+      down_count = 0
+      
+      if !executed_migrations.empty?
+        count.times do |i|
+          if executed_migrations[i]
+            down(executed_migrations[i], executed_migrations[i])
+            down_count += 1
+          end
+        end
+      end
+      
+      down_count
+    end
+  
+    def self.read_current_version
+      CassandraMigrations::Cassandra.select("metadata", :selection => "data_name='version'", :projection => 'data_value').first['data_value'].to_i
+    end
+    
+private
+  
+    def self.up(migration_name)
+      # load migration
+      require migration_name
+      # run migration
+      get_class_from_migration_name(migration_name).up
+      
+      # update version
+      CassandraMigrations::Cassandra.write("metadata", {:data_name => 'version', :data_value => get_version_from_migration_name(migration_name).to_s})
+    end
+    
+    def self.down(migration_name, previous_migration_name=nil)
+      # load migration
+      require migration_name
+      # run migration
+      get_class_from_migration_name(migration_name).down
+      
+      # downgrade version
+      if previous_migration_name
+        CassandraMigrations::Cassandra.write("metadata", {:data_name => 'version', :data_value => get_version_from_migration_name(previous_migration_name).to_s})
+      else
+        CassandraMigrations::Cassandra.write("metadata", {:data_name => 'version', :data_value => '0'})
+      end
+    end
+    
+    def self.get_all_migration_names
+      Dir[Rails.root.join("db", "cassandra_migrate/[0-9]*_*.rb")]
+    end
+  
+    def self.get_class_from_migration_name(filename)
+      filename.match(/[0-9]{14}_(.+)\.rb$/).captures.first.camelize.constantize    
+    end  
+    
+    def self.get_version_from_migration_name(migration_name)
+      migration_name.match(/([0-9]{14})_.+\.rb$/).captures.first.to_i
+    end
+  end
+end

data/lib/cassandra_migrations/cassandra/query.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+module CassandraMigrations::Cassandra
+  module Query
+  
+    def write(table, hash)
+      columns = []
+      values = []
+      
+      hash.each do |k,v| 
+        columns << k.to_s
+        values << "'#{v.to_s}'"
+      end
+  
+      execute("INSERT INTO #{table} (#{columns.join(', ')}) VALUES (#{values.join(', ')})")
+    end
+    
+    def select(table, options={})
+      query_string = "SELECT #{options[:projection] || '*'} FROM #{table}"
+      
+      if options[:selection]
+        query_string << " WHERE #{options[:selection]}"
+      end
+      
+      if options[:order_by]
+        query_string << " ORDER BY #{options[:order_by]}"
+      end
+      
+      if options[:limit]
+        query_string << " LIMIT #{options[:limit]}"
+      end
+  
+      execute(query_string)
+    end
+    
+    def delete(table, selection, options={})
+      execute("DELETE #{options[:projection]} FROM #{table} WHERE #{selection}")
+    end
+    
+    def truncate(table)
+      execute("TRUNCATE #{table}")
+    end
+  end
+end

data/lib/cassandra_migrations/railtie.rb

@@ -0,0 +1,17 @@
+# encoding : utf-8
+
+require 'cassandra_migrations/cassandra'
+
+class CassandraMigrations::Railtie < ::Rails::Railtie
+  
+  initializer "cassandra_migrations.start" do
+    CassandraMigrations::Cassandra.start!
+  end
+
+  rake_tasks do
+    Dir[File.expand_path("tasks/**/*.rake", File.dirname(__FILE__))].each do |file| 
+      load file
+    end
+  end
+  
+end

data/lib/cassandra_migrations/tasks/cassandra.rake

@@ -0,0 +1,74 @@
+# encoding : utf-8
+
+namespace :cassandra do
+
+  task :start do
+    CassandraMigrations::Cassandra.start!
+  end
+
+  desc 'Create the keyspace in config/cassandra.yml for the current environment'
+  task :create do
+    begin
+      CassandraMigrations::Cassandra.start!
+      puts "Keyspace #{CassandraMigrations::Cassandra.config['keyspace']} already exists!"
+    rescue CassandraMigrations::Cassandra::Errors::UnexistingKeyspaceError
+      CassandraMigrations::Cassandra.create_keyspace!
+      puts "Created keyspace #{CassandraMigrations::Cassandra.config['keyspace']}"
+    end
+  end
+
+  desc 'Drop keyspace in config/cassandra.yml for the current environment'
+  task :drop do
+    begin
+      CassandraMigrations::Cassandra.drop!
+      puts "Dropped keyspace #{CassandraMigrations::Cassandra.config['keyspace']}"
+    rescue CassandraMigrations::Cassandra::Errors::UnexistingKeyspaceError
+      puts "Keyspace #{CassandraMigrations::Cassandra.config['keyspace']} does not exist already... cannot be dropped"
+    end
+  end
+
+  desc 'Migrate the keyspace to the latest version'
+  task :migrate => :start do
+    migrations_up_count = CassandraMigrations::Cassandra::Migrator.up_to_latest
+
+    if migrations_up_count == 0
+      puts "Already up-to-date"
+    else
+      puts "Migrated #{migrations_up_count} version(s) up."
+    end
+  end
+
+  desc 'Rolls the schema back to the previous version (specify steps w/ STEP=n)'
+  task :rollback => :start do
+    steps = ENV['STEP'] ? ENV['STEP'].to_i : 1
+
+    migrations_down_count = CassandraMigrations::Cassandra::Migrator.rollback(steps)
+
+    if steps == migrations_down_count
+      puts "Rolled back #{steps} version(s)."
+    else
+      puts "Asked to rollback #{steps} version(s). Only achieved #{migrations_down_count}."
+    end
+  end
+
+  desc 'Resets and prepares cassandra database (all data will be lost)'
+  task :setup do
+    Rake::Task['cassandra:drop'].execute
+    Rake::Task['cassandra:create'].execute
+    Rake::Task['cassandra:migrate'].execute
+  end
+
+  namespace :test do
+    desc 'Load the development schema in to the test keyspace'
+    task :prepare do
+      Rails.env = 'test'
+      Rake::Task['cassandra:setup'].execute
+    end
+  end
+
+  desc 'Retrieves the current schema version number'
+  task :version => :start do
+    puts "Current version: #{Cassandra::Migrator.read_current_version}"
+  end
+
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: cassandra_migrations
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre0
+  prerelease: 6
+platform: ruby
+authors:
+- Henrique Gubert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cql-rb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to manage Cassandra database schema for Rails. This gem offers
+  migrations and environment specific databases out-of-the-box for Rails users.
+email: guberthenrique@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/cassandra_migrations/cassandra.rb
+- lib/cassandra_migrations/cassandra/errors.rb
+- lib/cassandra_migrations/cassandra/migrator.rb
+- lib/cassandra_migrations/cassandra/query.rb
+- lib/cassandra_migrations/tasks/cassandra.rake
+- lib/cassandra_migrations/railtie.rb
+- lib/cassandra_migrations.rb
+homepage: https://github.com/hsgubert/cassandra_migrations
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.0
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Cassandra schema management for a multi-environment developer.
+test_files: []