cequel-migrations-rails 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,52 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p327@cequel-migrations-rails"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.16.20 (master)" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+  if [[ $- == *i* ]] # check for interactive shells
+  then echo "Using: $(tput setaf 2)$GEM_HOME$(tput sgr0)" # show the user the ruby and gemset they are using in green
+  else echo "Using: $GEM_HOME" # don't use colors in non-interactive shells
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create use  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | GREP_OPTIONS= \grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | GREP_OPTIONS= \grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cequel-migrations-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 ReachLocal Inc., Andrew De Ponte
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+# Cequel Migrations Rails Plugin
+
+This Rails plugin basically provides a migration setup very similar to the
+standard ActiveRecord based migration system that normally exists in rails.
+The BIG difference is that it is designed to support specifically migrations
+for Cassandra data stores using Cequel.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cequel-migrations-rails'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cequel-migrations-rails
+
+## Usage
+
+For information on how to use this gem in your rails app please refer to the
+following. Note: You need to have the cequel gem setup and configured already
+in your Rails app before using this gem.
+
+### Initial Setup
+
+Before you can start using this gem you need to create the initial directory
+structure in your Rails app for it. You can do this using the following
+command:
+
+```
+rails g cequel:migrations:install
+```
+
+This creates the directory structure `cequel/migrate/` at the root of your
+Rails application as the place to store your migration scripts.
+
+### Generate Migration File
+
+To write a migration you first need to generate a migration file. This is done
+with the following command where `<migration_name>` is replaced with the name
+of the migration.
+
+```
+rails g cequel:migration <migration_name>
+```
+
+An example of the above command with a migration name would look as follows:
+
+```
+rails g cequel:migration CreateUserColumnFamily
+```
+
+### Create Database
+
+To create the database specified in your `config/cequel.yml` and create a
+column family in it called `schema_migrations` run the following command:
+
+```
+rake cequel:create
+```
+
+### Drop Database
+
+If you have already created the database and you want to drop it to start from
+scratch or something you can do so by running the following command:
+
+```
+rake cequel:drop
+```
+
+### Migrate Database
+
+If you database exists with a `schema_migrations` column family already
+because you followed the directions above in the "Create Database" section you
+can migrate the database with the following command:
+
+```
+rake cequel:migrate
+```
+
+### Rollback Migrations
+
+If you need to rollback a migration you do so with the following command:
+
+```
+rake cequel:rollback
+```
+
+If you need to rollback multiple migrations you can do so as follows, where 5
+is the number of steps I wanted to rollback.
+
+```
+STEPS=5 rake cequel:rollback
+```
+
+## Writing Migrations
+
+When you generate a migration you may know that it sets up the migration class
+with a base class of `Cequel::Migration`.
+
+The `Cequel::Migration` class provides the `execute` method to be used inside
+of your migrations `up` and `down` methods. The `execute` method takes a
+string of CQL.
+
+At the moment we currently only provide the `execute` method. However, we plan
+to provide other helper functions like, `create_column_family`,
+`drop_column_family`, etc.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cequel-migrations-rails.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cequel-migrations-rails/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "cequel-migrations-rails"
+  gem.version       = Cequel::Migrations::Rails::VERSION
+  gem.authors       = ["Andrew De Ponte"]
+  gem.email         = ["cyphactor@gmail.com"]
+  gem.description   = %q{Cequel migration support for Rails.}
+  gem.summary       = %q{A Rails plugin that provides migration support for Cequel.}
+  gem.homepage      = "http://github.com/cyphactor/cequel-migrations-rails"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency('shearwater', '>= 0.1.3')
+  gem.add_dependency('rails')
+  gem.add_dependency('cassandra-cql')
+  gem.add_development_dependency('rspec')
+end

data/lib/cequel-migrations-rails.rb

@@ -0,0 +1,16 @@
+require "cassandra-cql"
+
+require "cequel-migrations-rails/version"
+require "cequel/migration"
+
+module Cequel
+  module Migrations
+    module Rails
+      class Railtie < ::Rails::Railtie
+        rake_tasks do
+          load "cequel-migrations-rails/tasks/migrations.rake"
+        end
+      end
+    end
+  end
+end

data/lib/cequel-migrations-rails/tasks/migrations.rake

@@ -0,0 +1,72 @@
+require 'shearwater'
+require 'shearwater/cassandra_cql_backend'
+
+namespace :cequel do
+  desc "Create the cequel specified cassandra keystore for the current environment"
+  task :create => :environment do
+    # Read in the cequel config for the current Rails environment
+    cequel_env_conf = YAML::load(File.open(File.join(::Rails.root,"config", "cequel.yml")))[Rails.env]
+
+    # Create a CQL connection to use as the migrations backend.
+    db = CassandraCQL::Database.new(cequel_env_conf['host'])
+    db.execute("CREATE KEYSPACE #{cequel_env_conf['keyspace']} WITH strategy_class = 'SimpleStrategy' AND strategy_options:replication_factor = 1")
+    db.execute("USE #{cequel_env_conf['keyspace']}")
+    db.execute("CREATE COLUMNFAMILY schema_migrations (version bigint PRIMARY KEY, migrated_at timestamp)")
+  end
+
+  desc "Drop the cequel specified cassandra keystore for the current environment"
+  task :drop => :environment do
+    # Read in the cequel config for the current Rails environment
+    cequel_env_conf = YAML::load(File.open(File.join(::Rails.root,"config", "cequel.yml")))[Rails.env]
+
+    # Create a CQL connection to use as the migrations backend.
+    db = CassandraCQL::Database.new(cequel_env_conf['host'])
+    db.execute("DROP KEYSPACE #{cequel_env_conf['keyspace']}")
+  end
+
+  desc "Migrate the cassandra store"
+  task :migrate => :environment do
+    # Read in the cequel config for the current Rails environment
+    cequel_env_conf = YAML::load(File.open(File.join(::Rails.root,"config", "cequel.yml")))[Rails.env]
+
+    # Create a CQL connection to use as the migrations backend.
+    db = CassandraCQL::Database.new(cequel_env_conf['host'])
+    db.execute("USE #{cequel_env_conf['keyspace']}")
+
+    # Create the migrator
+    backend = Shearwater::CassandraCqlBackend.new(db)
+    migrations_directory = ::Rails.root.join('cequel', 'migrate')
+    migrator = Shearwater::Migrator.new(migrations_directory, backend)
+
+    # Migrate
+    migrator.migrate
+  end
+
+  desc "Rollback to the previous migration version by 1 step"
+  task :rollback => :environment do
+    # Read in the cequel config for the current Rails environment
+    cequel_env_conf = YAML::load(File.open(File.join(::Rails.root,"config", "cequel.yml")))[Rails.env]
+
+    # Create a CQL connection to use as the migrations backend.
+    db = CassandraCQL::Database.new(cequel_env_conf['host'])
+    db.execute("USE #{cequel_env_conf['keyspace']}")
+
+    # Create the migrator
+    backend = Shearwater::CassandraCqlBackend.new(db)
+    migrations_directory = ::Rails.root.join('cequel', 'migrate')
+    migrator = Shearwater::Migrator.new(migrations_directory, backend)
+
+    steps = ENV['STEPS'] || 1
+
+    # Migrate
+    migrator.rollback(steps.to_i)
+  end
+
+  desc "Drop the keystore, recreate it and run the migrations"
+  task :reset  do
+    Rake::Task["cequel:drop"].invoke
+    Rake::Task["cequel:create"].invoke
+    Rake::Task["cequel:migrate"].invoke
+  end
+  
+end

data/lib/cequel-migrations-rails/version.rb

@@ -0,0 +1,7 @@
+module Cequel
+  module Migrations
+    module Rails
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/cequel/migration.rb

@@ -0,0 +1,17 @@
+module Cequel
+  class Migration
+    attr_reader :db
+
+    def initialize
+      @db = CassandraCQL::Database.new(self.class.cequel_env_conf['host'], { :keyspace => self.class.cequel_env_conf['keyspace'] })
+    end
+
+    def execute(cql_string)
+      db.execute(cql_string)
+    end
+
+    def self.cequel_env_conf
+      YAML::load(File.open(File.join(::Rails.root,"config", "cequel.yml")))[::Rails.env]
+    end
+  end
+end

data/lib/generators/cequel/migration/migration_generator.rb

@@ -0,0 +1,17 @@
+module Cequel
+  module Generators
+    class MigrationGenerator < ::Rails::Generators::NamedBase
+      attr_reader :migration_class_name
+
+      def self.source_root
+        @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+      end
+
+      def create_migration
+        @migration_class_name = file_name.camelize
+        migration_timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S")
+        template 'migration.rb', File.join("cequel/migrate/#{migration_timestamp}_#{file_name.underscore}.rb")
+      end
+    end
+  end
+end

data/lib/generators/cequel/migration/templates/migration.rb

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

data/lib/generators/cequel/migrations/install/install_generator.rb

@@ -0,0 +1,20 @@
+module Cequel
+  module Migrations
+    module Generators
+      class InstallGenerator < ::Rails::Generators::Base
+        desc <<DESC
+  Description:
+      Setup cequel migrations directory structure.
+DESC
+
+        def self.source_root
+          @source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+        end
+
+        def copy_schema_files
+          directory 'cequel'
+        end
+      end
+    end
+  end
+end

data/spec/lib/cequel/migration_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Cequel::Migration do
+  let(:migration_class) { class FooMigration < Cequel::Migration; end; FooMigration }
+  let(:migration) { migration_class.new }
+
+  describe "#new" do
+    it "create a cassandra-cql database connection for the host & keyspace specified in the environment's config" do
+      migration_class.stub(:cequel_env_conf).and_return({ 'host' => 'somehost', 'keyspace' => 'somekeyspace' })
+      CassandraCQL::Database.should_receive(:new).with('somehost', { :keyspace => 'somekeyspace' })
+      migration
+    end
+  end
+  
+  describe "#execute" do
+    it "delegates to the cassandra-cql connection execute" do
+      migration_class.stub(:cequel_env_conf).and_return({ 'keyspace' => 'test keyspace', 'host' => '123.123.123.123' })
+      db = mock('db').as_null_object
+      CassandraCQL::Database.stub(:new).and_return(db)
+      db.should_receive(:execute).with("some cql string")
+      migration.execute("some cql string")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rails/all'
+
+module CequelMigrationsRails
+  class Application < ::Rails::Application
+  end
+end
+
+require 'cequel-migrations-rails'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: cequel-migrations-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew De Ponte
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shearwater
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cassandra-cql
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+description: Cequel migration support for Rails.
+email:
+- cyphactor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cequel-migrations-rails.gemspec
+- lib/cequel-migrations-rails.rb
+- lib/cequel-migrations-rails/tasks/migrations.rake
+- lib/cequel-migrations-rails/version.rb
+- lib/cequel/migration.rb
+- lib/generators/cequel/migration/migration_generator.rb
+- lib/generators/cequel/migration/templates/migration.rb
+- lib/generators/cequel/migrations/install/install_generator.rb
+- lib/generators/cequel/migrations/install/templates/cequel/migrate/.gitkeep
+- spec/lib/cequel/migration_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cyphactor/cequel-migrations-rails
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Rails plugin that provides migration support for Cequel.
+test_files:
+- spec/lib/cequel/migration_spec.rb
+- spec/spec_helper.rb