cassandra_migrations 0.0.1.pre4 → 0.0.1.pre5

data/bin/prepare_for_cassandra

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'fileutils'
+require 'colorize'
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($0)} [path]"
+
+  opts.on("-h", "--help", "Displays this help info") do
+    puts opts
+    exit 0
+  end
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    warn e.message
+    puts opts
+    exit 1
+  end
+end
+
+if ARGV.empty?
+  abort "Please specify the directory of a rails appilcation, e.g. `#{File.basename($0)} .'"
+elsif !File.directory?(ARGV.first)
+  abort "`#{ARGV.first}' is not a directory."
+elsif ARGV.length > 1
+  abort "Too many arguments; please specify only the directory of the rails application."
+end
+
+rails_root = ARGV.first
+
+# create cassandra.yaml
+if File.exists?(File.expand_path('config/cassandra.yml', rails_root))
+  puts "[skip] 'config/cassandra.yml' already exists".yellow
+else
+  puts "[new] creating 'config/cassandra.yml' (please update with your own configurations!)".green
+  FileUtils.cp(
+    File.expand_path('../template/cassandra.yml', File.dirname(__FILE__)),
+    File.expand_path('config/cassandra.yml', rails_root)
+  )
+end
+
+# create db/cassandra_migrations
+if File.exists?(File.expand_path('db/cassandra_migrate', rails_root))
+  puts "[skip] 'db/cassandra_migrate' already exists".yellow
+else
+  puts "[new] creating 'db/cassandra_migrate' directory".green
+  FileUtils.mkdir(File.expand_path('db/cassandra_migrate', rails_root))
+end
+
+puts '[done] prepared for cassandra!'.green
+puts ''
+puts 'Your steps from here are:'.green
+puts '  1. configure '.green + 'config/cassandra.yml'.red
+puts '  2. run '.green + 'rake cassandra:setup'.red + ' and try starting your application'.green
+puts '  3. create your first migration with '.green + 'rails g cassandra_migration'.red
+puts '  4. apply your migration with '.green + 'rake cassandra:migrate'.red
+puts '  5. run '.green + 'rake cassandra:test:prepare'.red + 'and start testing'.green
+puts '  6. have lots of fun!'.green.blink
+

data/lib/cassandra_migrations.rb

@@ -2,5 +2,6 @@ require 'cassandra_migrations/config'
 require 'cassandra_migrations/errors'
 require 'cassandra_migrations/cassandra'
 require 'cassandra_migrations/migrator'
+require 'cassandra_migrations/migration'
 
 require 'cassandra_migrations/railtie' if defined?(Rails)

data/lib/cassandra_migrations/cassandra.rb

@@ -5,7 +5,6 @@ require 'cql'
 require 'cassandra_migrations/cassandra/queries'
 require 'cassandra_migrations/cassandra/keyspace_operations'
 
-
 module CassandraMigrations
   module Cassandra
     extend Queries

data/lib/cassandra_migrations/cassandra/queries.rb

@@ -10,7 +10,14 @@ module CassandraMigrations
         
         hash.each do |k,v| 
           columns << k.to_s
-          values << (v.is_a?(String) ? "'#{v.to_s}'" : v.to_s)
+          
+          if v.respond_to?(:strftime)
+            values << "'#{v.strftime('%Y-%m-%d %H:%M:%S%z')}'"
+          elsif v.is_a?(String)
+            values << "'#{v}'"          
+          else
+            values << v.to_s
+          end
         end
     
         execute("INSERT INTO #{table} (#{columns.join(', ')}) VALUES (#{values.join(', ')})")

data/lib/cassandra_migrations/errors.rb

@@ -38,5 +38,11 @@ module CassandraMigrations
       end
     end
     
+    class MigrationDefinitionError < CassandraError
+      def initialize(msg)
+        super(msg)
+      end
+    end
+    
   end
 end

data/lib/cassandra_migrations/migration.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+
+require 'cassandra_migrations/migration/table_operations'
+require 'cassandra_migrations/migration/column_operations'
+
+module CassandraMigrations
+  
+  # Base class for all cassandra migration
+  class Migration
+    
+    include TableOperations
+    include ColumnOperations
+    
+    # Makes +execute+ method directly available to migrations
+    delegate :execute, :to => Cassandra
+    
+    # Makes +up+ work if the method in the migration is defined with self.up
+    def up
+      return unless self.class.respond_to?(:up)
+      self.class.instance_to_delegate = self
+      self.class.up
+    end
+    
+    # Makes +down+ work if the method in the migration is defined with self.down
+    def down
+      return unless self.class.respond_to?(:down)
+      self.class.instance_to_delegate = self
+      self.class.down
+    end
+    
+    # Class variable that holds an instance of Migration when the methods +up+ or
+    # +down+ are called on the class. The class then delegates missing method
+    # calls to this instance.
+    cattr_accessor :instance_to_delegate, :instance_accessor => false
+    
+    # Delegate missing method calls to an instance. That's what enables the
+    # writing of migrations using both +def up+ and +def self.up+ sintax.
+    def self.method_missing(name, *args, &block)
+      if instance_to_delegate
+        instance_to_delegate.send(name, *args, &block)
+      else
+        super
+      end
+    end
+    
+    # Execute this migration in the named direction.
+    #
+    # The advantage of using this instead of directly calling up or down is that
+    # this method gives informative output and benchmarks the time taken.
+    def migrate(direction)
+      return unless respond_to?(direction)
+
+      case direction
+      when :up   then announce_migration "migrating"
+      when :down then announce_migration "reverting"
+      end
+
+      time = Benchmark.measure { send(direction) }
+
+      case direction
+      when :up   then announce_migration "migrated (%.4fs)" % time.real; puts
+      when :down then announce_migration "reverted (%.4fs)" % time.real; puts
+      end
+    end  
+    
+  private
+  
+    # Generates output labeled with name of migration and a line that goes up 
+    # to 75 characters long in the terminal
+    def announce_migration(message)
+      text = "#{name}: #{message}"
+      length = [0, 75 - text.length].max
+      puts "== %s %s" % [text, "=" * length]
+    end
+    
+    def announce_operation(message)
+      puts "  " + message
+    end
+    
+    def announce_suboperation(message)
+      puts "  -> " + message
+    end
+    
+    # Gets the name of the migration
+    def name
+      self.class.name
+    end
+  end
+end

data/lib/cassandra_migrations/migration/column_operations.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+require 'cassandra_migrations/migration/table_definition'
+
+module CassandraMigrations
+  class Migration
+    
+    # Module grouping methods used in migrations to make table operations like:
+    # - adding/removing columns
+    # - changing column types
+    # - renaming columns
+    module ColumnOperations
+  
+      # Adds a column to a table.
+      #
+      # options: same options you would pass to create a table with that column
+      # (i.e. :limit might be applicable)
+      
+      def add_column(table_name, column_name, type, options = {})
+        table_definition = TableDefinition.new
+        
+        if !table_definition.respond_to?(type)
+          raise Errors::MigrationDefinitionError("Type '#{type}' is not valid for cassandra migration.")
+        end
+
+        table_definition.send(type, column_name, options)
+
+        announce_operation "add_column(#{column_name}, #{type})"
+
+        cql =  "ALTER TABLE #{table_name} ADD "
+        cql << table_definition.to_add_column_cql
+        announce_suboperation cql
+        
+        execute cql
+      end
+      
+      # Removes a column from the table
+      def remove_column(table_name, column_name)
+        announce_operation "drop_table(#{table_name})"
+
+        cql =  "ALTER TABLE #{table_name} DROP #{column_name}"
+        announce_suboperation cql
+        
+        execute cql
+      end
+    end
+  end
+end

data/lib/cassandra_migrations/migration/table_definition.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+
+module CassandraMigrations
+  class Migration
+
+    # Used to define a table in a migration of table creation or to
+    # add columns to an existing table.
+    #
+    # An instance of this class is passed to the block of the method
+    # +create_table+, available on every migration.
+    #
+    # This class is also internally used in the method +add_column+.
+    
+    class TableDefinition
+
+      def initialize()
+        @columns_name_type_hash = {}
+        @primary_keys = []
+      end
+      
+      def to_create_cql
+        cql = []
+
+        if !@columns_name_type_hash.empty?
+          @columns_name_type_hash.each do |column_name, type|
+            cql << "#{column_name} #{type}"
+          end
+        else
+          raise Errors::MigrationDefinitionError('No columns defined for table.')
+        end
+
+        if !@primary_keys.empty?
+          cql << "PRIMARY KEY(#{@primary_keys.join(', ')})"
+        else
+          raise Errors::MigrationDefinitionError('No primary key defined.')
+        end
+        
+        cql.join(', ')
+      end
+      
+      def to_add_column_cql
+        cql = ""
+
+        if @columns_name_type_hash.size == 1
+          cql = "#{@columns_name_type_hash.keys.first} #{@columns_name_type_hash.values.first}"
+        elsif @columns_name_type_hash.empty?
+          raise Errors::MigrationDefinitionError('No column to add.')
+        else
+          raise Errors::MigrationDefinitionError('Only one column ca be added at once.')
+        end
+        
+        cql
+      end
+      
+      def boolean(column_name, options={})
+        @columns_name_type_hash[column_name.to_sym] = :boolean
+        define_primary_keys(column_name) if options[:primary_key]
+      end
+      
+      def integer(column_name, options={})
+        if options[:limit].nil? || options[:limit] == 4
+          @columns_name_type_hash[column_name.to_sym] = :int
+        elsif options[:limit] == 8
+          @columns_name_type_hash[column_name.to_sym] = :bigint
+        else
+          raise Errors::MigrationDefinitionError(':limit option should be 4 or 8 for integers.')
+        end 
+        define_primary_keys(column_name) if options[:primary_key]
+      end
+      
+      def float(column_name, options={})
+        if options[:limit].nil? || options[:limit] == 4
+          @columns_name_type_hash[column_name.to_sym] = :float
+        elsif options[:limit] == 8
+          @columns_name_type_hash[column_name.to_sym] = :double
+        else
+          raise Errors::MigrationDefinitionError(':limit option should be 4 or 8 for floats.')
+        end
+        define_primary_keys(column_name) if options[:primary_key]
+      end
+      
+      def string(column_name, options={})
+        @columns_name_type_hash[column_name.to_sym] = :varchar
+        define_primary_keys(column_name) if options[:primary_key]
+      end
+      
+      def text(column_name, options={})
+        @columns_name_type_hash[column_name.to_sym] = :text
+        define_primary_keys(column_name) if options[:primary_key]
+      end
+      
+      def datetime(column_name, options={})
+        @columns_name_type_hash[column_name.to_sym] = :timestamp
+        define_primary_keys(column_name) if options[:primary_key]
+      end
+      
+      def timestamp(column_name, options={})
+        @columns_name_type_hash[column_name.to_sym] = :timestamp
+        define_primary_keys(column_name) if options[:primary_key]
+      end
+      
+      def define_primary_keys(*keys)
+        if !@primary_keys.empty?
+          raise Errors::MigrationDefinitionError('Primary key defined twice for the same table.')
+        end
+        
+        @primary_keys = keys.flatten
+      end
+    end
+  end
+end

data/lib/cassandra_migrations/migration/table_operations.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'cassandra_migrations/migration/table_definition'
+
+module CassandraMigrations
+  class Migration
+    
+    # Module grouping methods used in migrations to make table operations like:
+    # - creating tables
+    # - dropping tables
+    module TableOperations
+  
+      # Creates a new table in the keyspace
+      #
+      # options:
+      # - :primary_keys: single value or array (for compound primary keys). If
+      # not defined, some column must be chosen as primary key in the table definition. 
+      
+      def create_table(table_name, options = {})
+        table_definition = TableDefinition.new
+        table_definition.define_primary_keys(options[:primary_keys]) if options[:primary_keys]
+
+        yield table_definition if block_given?
+
+        announce_operation "create_table(#{table_name})"
+
+        create_cql =  "CREATE TABLE #{table_name} ("
+        create_cql << table_definition.to_create_cql
+        create_cql << ")"
+        
+        announce_suboperation create_cql
+        
+        execute create_cql
+      end
+      
+      # Drops a table
+      def drop_table(table_name)
+        announce_operation "drop_table(#{table_name})"
+        drop_cql =  "DROP TABLE #{table_name}"
+        announce_suboperation drop_cql
+        
+        execute drop_cql
+      end
+    end
+  end
+end

data/lib/cassandra_migrations/migrator.rb

@@ -31,7 +31,7 @@ module CassandraMigrations
       if !executed_migrations.empty?
         count.times do |i|
           if executed_migrations[i]
-            down(executed_migrations[i], executed_migrations[i])
+            down(executed_migrations[i], executed_migrations[i+1])
             down_count += 1
           end
         end
@@ -56,7 +56,7 @@ private
       # load migration
       require migration_name
       # run migration
-      get_class_from_migration_name(migration_name).up
+      get_class_from_migration_name(migration_name).new.migrate(:up)
       
       # update version
       Cassandra.write!(METADATA_TABLE, {:data_name => 'version', :data_value => get_version_from_migration_name(migration_name).to_s})
@@ -66,8 +66,8 @@ private
       # load migration
       require migration_name
       # run migration
-      get_class_from_migration_name(migration_name).down
-      
+      get_class_from_migration_name(migration_name).new.migrate(:down)
+
       # downgrade version
       if previous_migration_name
         Cassandra.write!(METADATA_TABLE, {:data_name => 'version', :data_value => get_version_from_migration_name(previous_migration_name).to_s})

data/lib/cassandra_migrations/railtie.rb

@@ -13,4 +13,10 @@ class CassandraMigrations::Railtie < ::Rails::Railtie
     end
   end
   
+  generators do
+    Dir[File.expand_path("railtie/**/*_generator.rb", File.dirname(__FILE__))].each do |file| 
+      require file
+    end
+  end
+  
 end

data/lib/cassandra_migrations/railtie/generators/cassandra_migration/USAGE

@@ -0,0 +1,23 @@
+Description:
+    Stubs out a new cassandra migration. 
+    
+    Pass the migration name, either CamelCased or under_scored. A migration
+    class is generated in db/cassandra_migrate, prefixed by a timestamp of the
+    current date and time
+
+Example:
+    rails generate migration create_tweets
+
+    This will create:
+      db/cassandra_migrate/20080514090912_create_tweets.rb
+      
+    Inside this file we'll have a migration ready for completion:
+      class CreateTweets << CassandraMigrations::Migration
+        def up
+
+        end
+        
+        def down
+        
+        end
+      end

data/lib/cassandra_migrations/railtie/generators/cassandra_migration/cassandra_migration_generator.rb

@@ -0,0 +1,18 @@
+class CassandraMigrationGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', File.dirname(__FILE__))
+  
+  argument :migration_name, :type => :string
+  
+  # Interpolates template and creates migration in the application
+  #
+  # Any public method in the generator is run automatically when 
+  # the generator is run. To understand fully see 
+  # http://asciicasts.com/episodes/218-making-generators-in-rails-3
+  
+  def generate_migration
+    file_name = "#{Time.current.utc.strftime('%Y%m%d%H%M%S')}_#{migration_name.underscore}"
+    @migration_class_name = migration_name.camelize
+    
+    template "empty_migration.rb.erb", "db/cassandra_migrate/#{file_name}.rb"  
+  end
+end

data/lib/cassandra_migrations/railtie/generators/cassandra_migration/templates/empty_migration.rb.erb

@@ -0,0 +1,9 @@
+class <%= @migration_class_name %> < CassandraMigrations::Migration
+  def up
+  
+  end
+  
+  def down
+  
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cassandra_migrations
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre4
+  version: 0.0.1.pre5
   prerelease: 6
 platform: ruby
 authors:
@@ -59,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,22 +110,31 @@ dependencies:
 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: []
+executables:
+- prepare_for_cassandra
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/cassandra_migrations.rb
+- lib/cassandra_migrations/migration.rb
 - lib/cassandra_migrations/migrator.rb
 - lib/cassandra_migrations/cassandra.rb
 - lib/cassandra_migrations/railtie.rb
 - lib/cassandra_migrations/cassandra/keyspace_operations.rb
 - lib/cassandra_migrations/cassandra/queries.rb
 - lib/cassandra_migrations/config.rb
+- lib/cassandra_migrations/migration/table_operations.rb
+- lib/cassandra_migrations/migration/column_operations.rb
+- lib/cassandra_migrations/migration/table_definition.rb
 - lib/cassandra_migrations/railtie/initializer.rb
+- lib/cassandra_migrations/railtie/generators/cassandra_migration/cassandra_migration_generator.rb
+- lib/cassandra_migrations/railtie/generators/cassandra_migration/templates/empty_migration.rb.erb
+- lib/cassandra_migrations/railtie/generators/cassandra_migration/USAGE
 - lib/cassandra_migrations/railtie/tasks.rake
 - lib/cassandra_migrations/errors.rb
 - spec/cassandra_migrations_spec.rb
 - spec/cassandra_migrations/cassandra_spec.rb
+- bin/prepare_for_cassandra
 homepage: https://github.com/hsgubert/cassandra_migrations
 licenses:
 - MIT