cassie 1.0.0.beta.33 → 1.0.0.1

data/lib/cassie/tasks/task_runner.rb

@@ -0,0 +1,49 @@
+module Cassie
+  module Tasks
+    class TaskRunner
+
+      def run_command(args)
+        cmd = args.delete_at(0) if args.first !~ /^-/
+        task = "cassie:#{cmd}"
+
+        Cassie.logger.level = ::Logger::WARN unless args.delete('--debug')
+
+        if Rake::Task.task_defined?(task)
+          Rake::Task[task].invoke
+        else
+          case args.delete_at(0)
+          when "--help"
+            print_documentation
+          when "-v"
+            puts Cassie::VERSION
+          else
+            puts "'#{cmd}' is not a supported command.\n\n"
+            print_documentation
+          end
+        end
+      end
+
+      def print_documentation
+        docs = <<-EOS
+Usage:
+  cassie <command> [options]
+
+Commands:
+EOS
+        Rake.application.tasks.each do |task|
+          docs += "  #{task.name.sub('cassie:','').ljust(25)} # #{task.comment}\n"
+        end
+        docs += <<-EOS
+
+Options:
+  -h, --help                # Print this documentation
+  -v, --version             # List the library version
+  <command> --help          # List options for a given command
+
+EOS
+
+        puts docs
+      end
+    end
+  end
+end

data/lib/cassie/tasks.rb

@@ -0,0 +1,18 @@
+require 'rake'
+
+require_relative "tasks/task_runner"
+require_relative "tasks/io"
+require_relative "extensions/object/color_methods"
+
+module Cassie
+  # Various modules and classes for use with executables.
+  # These classes are not loaded by +require 'cassie'+.
+  # Execute +require 'cassie/tasks' if they are needed in an application.
+  module Tasks
+    Rake::TaskManager.record_task_metadata = true
+    # load all tasks, but only once
+    Dir.glob("#{__dir__}/tasks/**/*.rake").each do |file|
+      load file
+    end
+  end
+end

data/lib/cassie/testing/fake/execution_info.rb

@@ -6,7 +6,7 @@ module Cassie::Testing::Fake
       @statement = statement
     end
 
-    def bind(params)
+    def bind(_params)
       statement
     end
 

data/lib/cassie/testing/fake/result.rb

@@ -16,7 +16,7 @@ module Cassie::Testing::Fake
     end
 
     def each
-      _rows = if paging_enabled?
+      result_rows = if paging_enabled?
         index = current_page - 1
         offset = index * page_size
         @data.slice(offset, page_size) || []
@@ -25,10 +25,10 @@ module Cassie::Testing::Fake
       end
 
       if block_given?
-        _rows.each(&block)
+        result_rows.each(&block)
         self
       else
-        _rows.each
+        result_rows.each
       end
     end
     alias rows each

data/lib/cassie/testing.rb

@@ -1,4 +1,8 @@
 module Cassie
+  # Various modules and classes for use during application
+  # testing. These classes are not loaded by +require 'cassie'+.
+  # Execute +require 'cassie/testing'+ during test setup to include
+  # test harnessing features.
   module Testing
     require_relative 'testing/fake/definition'
     require_relative 'testing/fake/query'

data/lib/cassie/version.rb

@@ -1,3 +1,3 @@
 module Cassie
-  VERSION = "1.0.0.beta.33"
+  VERSION = "1.0.0.1"
 end

data/lib/cassie.rb

@@ -12,6 +12,7 @@ require 'active_support'
 require 'cassandra'
 
 module Cassie
+  require_relative 'cassie/version'
   require_relative 'cassie/support'
   require_relative 'cassie/logger'
   require_relative 'cassie/instrumentation'
@@ -21,15 +22,17 @@ module Cassie
   require_relative 'cassie/definition'
   require_relative 'cassie/query'
   require_relative 'cassie/modification'
-  require_relative 'cassie/migration'
+  require_relative 'cassie/schema'
 
   extend Configuration::Core
   extend ConnectionHandler
 
+  # Logger used for logging by Cassandra instrumentation
   def self.logger
     Logger.logger
   end
 
+  # Assigns a custom logger for use by Cassandra instrumentation
   def self.logger=(logger)
     Logger.logger = logger
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cassie
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.33
+  version: 1.0.0.1
 platform: ruby
 authors:
 - Evan Prothro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cassandra-driver
@@ -64,6 +64,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -109,22 +123,41 @@ files:
 - lib/cassie/connection_handler/sessions.rb
 - lib/cassie/connection_handler/sessions/instrumentation.rb
 - lib/cassie/definition.rb
+- lib/cassie/extensions/object/color_methods.rb
 - lib/cassie/instrumentation.rb
 - lib/cassie/logger.rb
-- lib/cassie/migration.rb
-- lib/cassie/migration/README.md
-- lib/cassie/migration/configuration.rb
-- lib/cassie/migration/initialization.rb
-- lib/cassie/migration/queries.rb
-- lib/cassie/migration/queries/create_schema_keyspace_query.rb
-- lib/cassie/migration/queries/create_versions_table_query.rb
-- lib/cassie/migration/queries/insert_version_query.rb
-- lib/cassie/migration/queries/select_versions_query.rb
-- lib/cassie/migration/structure_dumper.rb
-- lib/cassie/migration/structure_loader.rb
-- lib/cassie/migration/version.rb
 - lib/cassie/modification.rb
 - lib/cassie/query.rb
+- lib/cassie/schema.rb
+- lib/cassie/schema/README.md
+- lib/cassie/schema/apply_command.rb
+- lib/cassie/schema/cassandra_migrations/importer.rb
+- lib/cassie/schema/cassandra_migrations/migration_file.rb
+- lib/cassie/schema/configuration.rb
+- lib/cassie/schema/migration.rb
+- lib/cassie/schema/migration/cassandra_support.rb
+- lib/cassie/schema/migration/dsl.rb
+- lib/cassie/schema/migration/dsl/announcing.rb
+- lib/cassie/schema/migration/dsl/column_operations.rb
+- lib/cassie/schema/migration/dsl/table_definition.rb
+- lib/cassie/schema/migration/dsl/table_operations.rb
+- lib/cassie/schema/migrator.rb
+- lib/cassie/schema/queries.rb
+- lib/cassie/schema/queries/create_keyspace_query.rb
+- lib/cassie/schema/queries/create_versions_table_query.rb
+- lib/cassie/schema/queries/delete_version_query.rb
+- lib/cassie/schema/queries/drop_keyspace_query.rb
+- lib/cassie/schema/queries/insert_version_query.rb
+- lib/cassie/schema/queries/select_versions_query.rb
+- lib/cassie/schema/rollback_command.rb
+- lib/cassie/schema/structure_dumper.rb
+- lib/cassie/schema/structure_loader.rb
+- lib/cassie/schema/version.rb
+- lib/cassie/schema/version_file_loader.rb
+- lib/cassie/schema/version_loader.rb
+- lib/cassie/schema/version_object_loader.rb
+- lib/cassie/schema/version_writer.rb
+- lib/cassie/schema/versioning.rb
 - lib/cassie/statements.rb
 - lib/cassie/statements/README.md
 - lib/cassie/statements/core.rb
@@ -180,8 +213,31 @@ files:
 - lib/cassie/statements/statement/type_hinting.rb
 - lib/cassie/statements/statement/updating.rb
 - lib/cassie/support.rb
-- lib/cassie/support/command_runner.rb
+- lib/cassie/support/server_process.rb
 - lib/cassie/support/statement_parser.rb
+- lib/cassie/support/system_command.rb
+- lib/cassie/tasks.rb
+- lib/cassie/tasks/configuration/generate.rake
+- lib/cassie/tasks/io.rb
+- lib/cassie/tasks/migration/create.rake
+- lib/cassie/tasks/migration/import.rake
+- lib/cassie/tasks/migration/reset.rake
+- lib/cassie/tasks/restart.rake
+- lib/cassie/tasks/schema/drop.rake
+- lib/cassie/tasks/schema/dump.rake
+- lib/cassie/tasks/schema/history.rake
+- lib/cassie/tasks/schema/import.rake
+- lib/cassie/tasks/schema/init.rake
+- lib/cassie/tasks/schema/load.rake
+- lib/cassie/tasks/schema/migrate.rake
+- lib/cassie/tasks/schema/reset.rake
+- lib/cassie/tasks/schema/status.rake
+- lib/cassie/tasks/schema/version.rake
+- lib/cassie/tasks/schema/version_display.rb
+- lib/cassie/tasks/start.rake
+- lib/cassie/tasks/stop.rake
+- lib/cassie/tasks/tail.rake
+- lib/cassie/tasks/task_runner.rb
 - lib/cassie/testing.rb
 - lib/cassie/testing/README.md
 - lib/cassie/testing/fake/definition.rb
@@ -208,9 +264,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.2

data/lib/cassie/migration/README.md

@@ -1,141 +0,0 @@
-# Cassie Migrations
-
-Cassie provides versioned migrations similar to many existing adapters and frameworks.
-
-Practically speaking, this gives your cluster schmea its own "version" and simplifies upgrading or downgrading the schema.
-
-As such, Cassie uses semantic versioning, where a defined version describes all non-system keyspaces.
-
-Major, minor, and patch versions are used, without support for semantic extensions (prerelase or metadata, ex: 1.0.0.beta).
-
-### Schema Migrations
-#### Creating a migration
-
-```
-cassie migration:create that_killer_feature --bump minor
-=> 0.2.0 - migrations/000_002_000_that_killer_feature.rb
-```
-
-```ruby
-# migrations/000_002_000_that_killer_feature.rb
-
-Uses the excellend DSL from `cassandra_migrations`.
-```
-
-#### Executing migrations
-
-```
-cassie migrate
-=> roll up to latest version
-```
-
-```
-cassie migrate 0.2.0
-=> roll up to 0.2.0 and stop
-```
-
-```
-cassie migrate 0.1.9
-=> roll back to 0.1.9 and stop
-```
-
-#### Rolling back
-
-```
-cassie rollback
-=> roll back 1 version and stop
-```
-
-```
-cassie rollback 3
-=> roll back 3 versions and stop
-```
-
-#### Getting the current version
-```
-cassie schema:version
-+---------+----------------+-------------+---------------------------+
-| Version | Description    | Migrated by | Migrated at               |
-+---------+----------------+-------------+---------------------------+
-| * 0.1.0 | initial schema | eprothro    | 2016-09-08 09:23:54 -0500 |
-+---------+----------------+-------------+---------------------------+
-```
-
-#### Getting the version history
-```
-cassie schema:history
-+---------+----------------+-------------+---------------------------+
-| Version | Description    | Migrated by | Migrated at               |
-+---------+----------------+-------------+---------------------------+
-| * 0.2.0 |  create users  | serverbot   | 2016-09-08 10:23:54 -0500 |
-| * 0.1.0 | initial schema | eprothro    | 2016-09-08 09:23:54 -0500 |
-+---------+----------------+-------------+---------------------------+
-```
-
-### Data Migrations
-
-####TODO:
-
-Best practice is calling data massaging from the migration, implemented with nice OO elsewhere...
-
-### Schema overrides per environment
-
-####TODO:
-
-Migrations define production use case. Development and/or testing use cases may have slightly different needs.
-
-Configure keyspace and/or table properties per env that should override migrations.
-
-Example of keyspace replication settings.
-
-Make sure it is clear what the schema dump is (with or without overrides)
-
-### Multiple Keyspaces
-
-####TODO:
-
-Don't agree with different ENVs for managing multiple keyspaces. That assumes keyspaces align with domains.
-
-Example of counter tables in a separate keyspace for higher replication to make read pressure lower.
-
-Manage multiple keyspaces in configruation.
-
-Configuration defaults to simple replication with durable writes.
-
-Example of changing replication for production and how overrides keep dev working.
-
-### Application Growth
-
-####TODO:
-
-This works for starting out, single app, single dev.
-
-This also scales well to multiple apps or microservices, and multiple teams (ops, etc.), managing and depending on a central repository of migrations with a semantically versioned database schema.
-
-### Transitioning from Other Tools
-
-####TODO:
-
-Support for sucking in `cassandra_migrations` migration files and changing to semantic versioning.
-
-```
-cassie migration:import cassandra_migrate
-=> 0.0.1 - cassandra_migrate/20160818213805_create_users.rb -> migrations/000_000_001_create_users.rb
-=> 0.0.2 - cassandra_migrate/20160818213811_create_widgets.rb -> migrations/000_000_002_create_widgets.rb
-=> 0.0.3 - cassandra_migrate/20160818213843_create_sprockets.rb -> migrations/000_000_003_create_sprockets.rb
-3 migrations imported
-```
-
-Support for a .cdl migration file to act as initial migration (dump defining initial version).
-
-```
-cassie migration:initialize
-=> 0.1.0 - migrations/000_001_000_initial_schema.cdl
-schema initialized at v0.1.0 from current database structure
-```
-
-```
-cassie migration:initialize 0.15.3
-=> 0.1.0 - migrations/000_015_003_initial_schema.cdl
-schema initialized at v0.15.3 from current database structure
-```

data/lib/cassie/migration/configuration.rb

@@ -1,18 +0,0 @@
-module Cassie::Migration
-  # Extend a module/class with Configuration to enable migration management
-  module Configuration
-
-    attr_accessor :schema_keyspace,
-                  :versions_table
-
-    def self.extended(extender)
-      extender.paths["schema_structure"] = "db/structure.cql"
-      extender.schema_keyspace = "cassie_schema"
-      extender.versions_table = "versions"
-    end
-
-    def paths
-      @paths ||= {}.with_indifferent_access
-    end
-  end
-end

data/lib/cassie/migration/initialization.rb

@@ -1,70 +0,0 @@
-module Cassie::Migration
-
-  class AlreadyInitiailizedError < StandardError; end
-  class UninitializedError < StandardError; end
-
-  module Initialization
-    require 'etc'
-
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-
-      def initialize_versioning(version=default_version)
-        create_schema_keyspace unless keyspace_exists?
-        raise Cassie::Migration::AlreadyInitiailizedError if version_exists?
-        create_versions_table unless versions_table_exists?
-        insert_version(build_version(version, 'initial schema'))
-      end
-
-      def keyspace_exists?
-        Cassie.cluster.keyspaces.map(&:name).any?{|k| k == Cassie::Migration.schema_keyspace}
-      end
-
-      def version_exists?
-        !!Cassie::Migration.version
-      rescue Cassie::Migration::UninitializedError
-        false
-      end
-
-      def versions_table_exists?
-        !!SelectVersionsQuery.new(limit: 1).fetch
-      rescue Cassandra::Errors::InvalidError
-        false
-      end
-
-      def build_version(version_number, description)
-        id = Cassandra::TimeUuid::Generator.new.now
-        migrator = Etc.getlogin rescue '<unknown>'
-        migrated_at = Time.now
-        Version.new(id, version_number, description, migrator, migrated_at)
-      end
-
-      def insert_version(version)
-        InsertVersionQuery.new(version: version).execute
-      end
-
-      protected
-
-      def default_version
-        '0.1.0'
-      end
-
-      def create_schema_keyspace
-        CreateSchemaKeyspaceQuery.new.execute
-      end
-
-      def create_versions_table
-        CreateVersionsTableQuery.new.execute
-      end
-
-      def uninitialized_error
-        UninitializedError.new(uninitialized_message)
-      end
-
-      def uninitialized_message
-        "Cassie Schema Versions table not found at '#{schema_keyspace}.#{versions_table}'. Create a migration or initialize your schema to enable versioned migration support."
-      end
-    end
-  end
-end

data/lib/cassie/migration/queries/create_schema_keyspace_query.rb

@@ -1,17 +0,0 @@
-module Cassie::Migration
-  class CreateSchemaKeyspaceQuery < Cassie::Definition
-    self.prepare = false
-
-    def statement
-      cql = %(
-        CREATE KEYSPACE #{Cassie::Migration.schema_keyspace}
-        WITH replication = {'class': 'SimpleStrategy', 'replication_factor': '1'}
-        AND durable_writes = true;
-       )
-    end
-
-    def keyspace
-      nil
-    end
-  end
-end

data/lib/cassie/migration/queries/insert_version_query.rb

@@ -1,23 +0,0 @@
-module Cassie::Migration
-  class InsertVersionQuery < Cassie::Modification
-
-    insert_into Cassie::Migration.versions_table
-
-    set :bucket
-    set :id
-    set :version_number
-    set :description
-    set :migrator
-    set :migrated_at
-
-    map_from :version
-
-    def bucket
-      0
-    end
-
-    def keyspace
-      Cassie::Migration.schema_keyspace
-    end
-  end
-end

data/lib/cassie/migration/queries/select_versions_query.rb

@@ -1,14 +0,0 @@
-module Cassie::Migration
-  class SelectVersionsQuery < Cassie::Query
-
-    select_from Cassie::Migration.versions_table
-
-    def build_result(row)
-      Version.new(*row.values_at(*Version.members.map(&:to_s)))
-    end
-
-    def keyspace
-      Cassie::Migration.schema_keyspace
-    end
-  end
-end

data/lib/cassie/migration/structure_dumper.rb

@@ -1,94 +0,0 @@
-module Cassie::Migration
-  require_relative 'queries'
-
-  class StructureDumper
-    attr_reader :destination_path
-
-    def initialize(opts={})
-      @destination_path = opts[:destination_path] || default_destination_path
-    end
-
-    def stream
-      @stream ||= begin
-        prepare_stream
-        File.open(destination_path, "w+")
-      end
-    end
-
-    def structure
-      @structure ||= begin
-        args = ["-e", "'DESCRIBE SCHEMA'"]
-        runner = Cassie::Support::CommandRunner.new("cqlsh", args)
-        runner.run
-
-        raise runner.failure_message unless runner.success?
-
-        runner.output
-      end
-    end
-
-    def versions
-      @versions ||= begin
-        versions_query.fetch
-      rescue Cassandra::Errors::InvalidError => e
-        log_versions_not_found(e)
-        []
-      end
-    end
-
-    def versions_insert_cql
-      inserts = versions.map do |v|
-        InsertVersionQuery.new(version: v).to_cql
-      end
-      inserts.join("\n")
-    end
-
-    def dump
-      stream << structure
-      stream << "\n\n"
-      stream << versions_insert_cql
-      stream << "\n"
-
-      close_stream
-    end
-
-    def versions_table_name
-      "cassie_schema.versions"
-    end
-
-    def destination_path
-      @destination_path || raise("Unconfigured schema structure path: `Cassie::Migration.paths[:schema_structure]` is empty")
-    end
-
-    protected
-
-    def versions_query
-      SelectVersionsQuery.new
-    end
-
-    def default_destination_path
-      Cassie::Migration.paths[:schema_structure]
-    end
-
-    def prepare_stream
-      dir = File.dirname(destination_path)
-      Dir.mkdir(dir) unless File.directory?(dir)
-    end
-
-    def close_stream
-      stream.close
-      @stream = nil
-    end
-
-    def log_versions_not_found(error)
-      msg = "WARNING: Cassie Schema Versions table not found at '#{versions_table_name}'. Create a migration, or initialize your schema for versioned migration support."
-      msg << "\n\t"
-      msg << error.message.split("\n").join("\n\t")
-      logger.warn(msg)
-    end
-
-    def logger
-      Cassie.logger
-    end
-  end
-end

data/lib/cassie/migration/version.rb

@@ -1,4 +0,0 @@
-module Cassie::Migration
-  Version = Struct.new(:id, :version_number, :description, :migrator, :migrated_at) do
-  end
-end