schema_plus_core 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14d4c29d30666d3262db03f9eb185ad19183aa0f
-  data.tar.gz: 84a5af526cb51da858aee93e203ec6cb4c788fdb
+  metadata.gz: be82dc70c1337ef9fec4f7bcc88ad9011455bf86
+  data.tar.gz: fb4f3f8aa09a494fc535b8c4e337f08ef43994c4
 SHA512:
-  metadata.gz: a333726087546218a3bad3b0b85d4396fb04aad22080636c1bce21a009a1c1e022729092a7044e82571788f1fe4bf9375c72b60d2a08a32fef9a8c39afc354ee
-  data.tar.gz: 644d807294fd2d3b863fb4ef6ff0588cad8ab15b82503be681b3ff4078e4bfa9edf37f167de7dab123811bfa56f90a95e2cd542d138d65a7888e9d8599314fd4
+  metadata.gz: 59e8ed21ad18ee6dfbed44d4d70b2700a9617044a96d87746c61b8ca3d54aa4911d7c3c147fd7afa38ff8da0ee6242d9f5f0570b25aed6c1593d5db186768e49
+  data.tar.gz: 53e646d5d164ce111e58b137dd0c4e07b129429699de0c913a638971ca94ad53076725ac9e2f28f266b6fe48a6b258bcbbcde384d1b3d0f23bc66bb9efe5693e

data/README.md

@@ -7,7 +7,7 @@
 
 SchemaPlus::Core creates an internal extension API to ActiveRecord.  The idea is that:
 
-* ShemaPlus::Core does the monkey-patching so clients don't have to know too much about the internal of ActiveRecord. 
+* ShemaPlus::Core does the monkey-patching so clients don't have to know too much about the internal of ActiveRecord.
 
 * SchemaPlus::Core's extension API is consistent across the various connection adapters, so clients don't have to figure out how to extend each connection adapter independently.
 
@@ -15,7 +15,7 @@ SchemaPlus::Core creates an internal extension API to ActiveRecord.  The idea is
 
 By itself, SchemaPlus::Core does not change any behavior or add any external features to ActiveRecord.  It just makes the API available to clients.
 
-SchemaPlus::Core is a client of [schema_monkey](https://github.com/SchemaPlus/schema_monkey), using [modware](https://github.com/ronen/modware) to define middleware callback stacks. 
+SchemaPlus::Core is a client of [schema_monkey](https://github.com/SchemaPlus/schema_monkey), using [modware](https://github.com/ronen/modware) to define middleware callback stacks.
 
 
 ## Compatibility
@@ -31,8 +31,6 @@ SchemaPlus::Core is tested on:
 
 ## Installation
 
-As usual:
-
 <!-- SCHEMA_DEV: TEMPLATE INSTALLATION - begin -->
 <!-- These lines are auto-inserted from a schema_dev template -->
 As usual:
@@ -65,7 +63,7 @@ module MyClient
     #
     # Middleware modules to insert in SchemaPlus::Core API stacks
     #
-  end 
+  end
   module ActiveRecord
     #
     # direct ActiveRecord enhancements, should your client need any.
@@ -83,7 +81,7 @@ require "schema_plus/core"
 
 module AutoUniquify
   module Middleware
-  
+
     module Migration
       module Index
         def before(env)
@@ -91,7 +89,7 @@ module AutoUniquify
         end
       end
     end
-    
+
   end
 end
 
@@ -118,13 +116,13 @@ Stacks for general queries pertaining to the entire database schema:
     `:connection` | The current ActiveRecord connection | *context*
     `:table_name` | The name of the table to query | *arg*
     `:query_name` | Label sometimes used by ActiveRecord logging | *arg*
-  
+
   The base implementation appends its results to `env.index_definitions`
 
 * `Schema::Tables`
 
   Wrapper around the `connection.tables()` method.  Env contains:
-  
+
     Env Field    | Description | Initialized
     --- | --- | ---
     `:tables`     | The result of the lookup | `[]`
@@ -133,9 +131,9 @@ Stacks for general queries pertaining to the entire database schema:
     `:database`   | (Mysql only) | *arg*
     `:like`       | (Mysql only) | *arg*
     `:query_name` | Label sometimes used by ActiveRecord logging | *arg*
-  
+
   The base implementation appends its results to `env.tables`
-  
+
 ### Model
 
 Stacks for class methods on ActiveRecord models.
@@ -143,32 +141,32 @@ Stacks for class methods on ActiveRecord models.
 * `Model::Columns`
 
   Wrapper around the `Model.columns` query
-  
+
       Env Field    | Description | Initialized
     --- | --- | ---
     `:columns`     | The resulting Column objects | `[]`
     `:model` | The model Class being queried | *context*
 
   The base implementation appends its results to `env.columns`
-  
+
 * `Model::ResetColumnInformation`
 
     Wrapper around the `Model.reset_column_information` method
-    
+
         Env Field    | Description | Initialized
         --- | --- | ---
         `:model` | The model Class being reset | *context*
-    
+
     The base implementation performs the reset.
 
 ### Migration
 
-Stacks for operations that define database objects in migrations and schema loading.
+Stacks for operations that change the schema.  In some cases the operation immediately modifies the database schema, in others the operation defines ActiveRecord objects (e.g., column definitions in a create_table definition) and the actual modification of the database schema will happen some time later.
 
 * `Migration::Column`
 
   Callback stack for various ways to define or modify a column.
-  
+
     Env Field    | Description | Initialized
     --- | --- | ---
     `:caller`     | The ActiveRecord instance responsible for performing the action | *context*
@@ -179,24 +177,36 @@ Stacks for operations that define database objects in migrations and schema load
     `:options`    | The column options | *arg*, default `{}`
 
   The base implementation performs the column operation.  No value is returned.
-  
+
   Notes:
-  
+
   1. The `:operation` field has the following meanings:
-  
+
       * `:add` - The column will be added immediately (`Migration#add_column`)
       * `:change` - The column will be changed immediately (`Migration#change_column`)
       * `:define` - The column will be added to table definition, which will be emitted later
       * `:record` - The column info will be added to a migration command recorder, for later playback in reverse by `Migration#down`
 
   2. In the case of a table definition using `t.references` or `t.belongs_to`, the `:type` field will be set to `:reference` and the `:column_name` will include the `"_id"` suffix
-  
+
   3. ActiveRecord's base implementation may make nested calls to column creation.  For example: References result in a nested call to create an integer column; Polymorphic references nest calls to create two columns; Sqlite3 implements `:change` by a nested call to a new table definition.  SchemaPlus::Core doesn't attempt to normalize or suppress these; each such nested call will result in its own `Migration::Column` stack execution.
-  
+
+* `Migration::DropTable`
+
+  Drops a table from the database
+
+    Env Field    | Description | Initialized
+    --- | --- | ---
+    `:connection`     | The current ActiveRecord connection | *context*
+    `:table_name` | The name of the table | *arg*
+    `:options`    | The index options | *arg*
+
+   The base implementation drops the table.  No value is returned.
+
 * `Migration::Index`
 
-  Callback stack for various ways to define an index column.
-  
+  Callback stack for various ways to define an index.
+
     Env Field    | Description | Initialized
     --- | --- | ---
     `:caller`     | The ActiveRecord instance responsible for performing the action | *context*
@@ -206,11 +216,11 @@ Stacks for operations that define database objects in migrations and schema load
     `:options`    | The index options | *arg*, default `{}`
 
   The base implementation performs the index creation operation.  No value is returned.
-  
+
   Notes:
-  
+
   1. The `:operation` field has the following meanings:
-  
+
       * `:add` - The index will be added immediately (`Migration#add_index`)
       * `:define` - The index will be added to a table definition, which will be emitted later.
 
@@ -221,7 +231,7 @@ Stacks for internal operations that generate SQL.
 * `Sql::ColumnOptions`
 
   Callback stack around generation of the SQL options for a column definition.
-  
+
     Env Field    | Description | Initialized
     --- | --- | ---
     `:sql` | The resulting SQL | `""`
@@ -235,7 +245,7 @@ Stacks for internal operations that generate SQL.
 * `Sql::IndexComponents`
 
   Callback stack around generation of the SQL for an index definition.
-  
+
     Env Field    | Description | Initialized
     --- | --- | ---
     `:sql` | The resulting SQL components, in a struct with fields `:name`, `:type`, `:columns`, `:options`, `:algorithm`, `:using` | *empty struct*
@@ -245,30 +255,30 @@ Stacks for internal operations that generate SQL.
     `:options`    | The index options | *context*
 
   The base implementation *overwrites* the contents of `env.sql`
-  
+
   Notes:
-  
+
   1. SQLite3 ignores the `:type`, `:algoritm`, and `:using` fields of `env.sql`
 
 * `Sql::Table`
 
   Callback stack around generation of the SQL for a table
-    
+
     Env Field    | Description | Initialized
     --- | --- | ---
     `:sql` | The resulting SQL components in a struct with fields `:command`, `:name`, `:body`, `:options`, `:quotechar` | *empty struct*
     `:caller`     | The ActiveRecord::SchemaCreation instance | *context*
     `:connection` | The current ActiveRecord connection | *context*
     `:table_definition` | The TableDefinition object for the table | *context*
-  
+
   The base implementation *overwrites* the contents of `env.sql`
-  
+
   Notes:
-  
+
   1. `env.sql.command` contains the index creation command such as `CREATE TABLE` or `CREATE TEMPORARY TABLE`
   2. `env.sql.quotechar` contains the quote character ', ", or \` to wrap `env.sql.name` in.
 
-          
+
 ### Query
 
 Stacks around low-level query execution
@@ -276,7 +286,7 @@ Stacks around low-level query execution
 * `Query::Exec`
 
   Callback stack wraps the emission of sql to the underlying dbms gem.
-  
+
       Env Field    | Description | Initialized
     --- | --- | ---
     `:result` | The result of the database query | *unset*
@@ -284,28 +294,28 @@ Stacks around low-level query execution
     `:sql`        | The SQL string | *context*
     `:binds`      | Values to substitute into the SQL string
     `:query_name` | Label sometimes used by ActiveRecord logging | *arg*
-          
-          
+
+
 ### Dumper
 
 SchemaPlus::Core provides a state object and of callbacks to various phases of the schema dumping process.  The dumping process fleshes out the state object-- nothing is actually written to the dump file until after the state is fleshed out.
 
 #### Schema Dump state
 
-* `Class SchemaPlus::Core::SchemaDump` 
+* `Class SchemaPlus::Core::SchemaDump`
 
   An instance of `SchemaPlus::Core::SchemaDump` gets passed to each of the callback stacks; the dump gets built up by fleshing out its contents.  `SchemaDump` has the following fields and methods:
-  
+
   * `dump.initial = []` - an array of strings containing statements to start the schema with, such as `enable_extension 'hstore'`
   * `dump.data = OpenStruct.new` - a place for clients to store arbitrary data between phases
   * `dump.tables = {}` - a hash mapping table names to SchemaDump::Table objects
   * `dump.final = []` - an array of strings containing statements to end the schema with.
   * `dump.depends(table_name, [prerequisite_table_names])` - call this method to ensure that the definition of `table_name` won't be output before its prerequisites.
-  
+
 * `Class SchemaPlus::Core::SchemaDump::Table`
-  
+
   Each table in the dump has its contents in a SchemaDump::Table object, with these fields:
-  
+
   * `table.name` - the table name
   * `table.pname` - table as actually used in SQL (without any prefixes or suffixes)
   * `table.options` - a string containing the options to `Migration.create_table`
@@ -317,7 +327,7 @@ SchemaPlus::Core provides a state object and of callbacks to various phases of t
 * `Class SchemaPlus::Core::SchemaDump::Table::Column`
 
   Each column in a table has its contents in a SchemaDump::Table::Column object, with these fields and methods:
-  
+
   * `column.name` - the column name
   * `column.type` - the column type (i.e., what comes after `"t."`)
   * `column.options` - an optional string containing the options for the column
@@ -328,25 +338,25 @@ SchemaPlus::Core provides a state object and of callbacks to various phases of t
 * `Class SchemaPlus::Core::SchemaDump::Table::Index`
 
   Each index in a table has its contents in a SchemaDump::Table::Index object, with these fields and methods:
-  
+
   * `index.name` - the index name
   * `index.columns` - the columns that are in the index
   * `index.options` - an optional string containing the options for the index
   * `index.add_option(option)` - adds an option to the current string, separating with a "," if the current set isn't blank
 
-#### Schema Dump Middleware stacks  
+#### Schema Dump Middleware stacks
 
 * `Dumper::Initial`
 
   Callback stack wraps the creation of initial statements for the dump.
-  
+
       Env Field    | Description | Initialized
     --- | --- | ---
     `:initial` | The initial statements | []
     `:dump`    | The SchemaDump object | *context*
     `:dumper`  | The current ActiveRecord::SchemaDumper instance| *context*
     `:connection`      | The current ActiveRecord connection | *context*
-          
+
   The base method appends initial statements to `env.initial`.
 
 * `Dumper::Tables`
@@ -358,7 +368,7 @@ SchemaPlus::Core provides a state object and of callbacks to various phases of t
     `:dump`    | The SchemaDump object | *context*
     `:dumper`  | The current ActiveRecord::SchemaDumper instance| *context*
     `:connection`      | The current ActiveRecord connection | *context*
-          
+
   The base method iterates through all tables, dumping each.
 
 
@@ -372,11 +382,11 @@ SchemaPlus::Core provides a state object and of callbacks to various phases of t
     `:dump`    | The SchemaDump object | *context*
     `:dumper`  | The current ActiveRecord::SchemaDumper instance| *context*
     `:connection`      | The current ActiveRecord connection | *context*
-          
-  The base method iterates through all columns and indexes of the table, and *overwrites* the contents of `table`, 
-  
+
+  The base method iterates through all columns and indexes of the table, and *overwrites* the contents of `table`,
+
   Notes:
-  
+
   1. When the stack is called, `env.dump.tables[env.table.name]` contains the `env.table` object.
 
 * `Dumper::Indexes`

data/lib/schema_plus/core/active_record/connection_adapters/abstract_adapter.rb

@@ -16,6 +16,12 @@ module SchemaPlus
             end
           end
 
+          def drop_table(table_name, options={})
+            SchemaMonkey::Middleware::Migration::DropTable.start(connection: self, table_name: table_name, options: options.dup) do |env|
+              super env.table_name, env.options
+            end
+          end
+
           def add_index_options(table_name, column_names, options={})
             SchemaMonkey::Middleware::Sql::IndexComponents.start(connection: self, table_name: table_name, column_names: Array.wrap(column_names), options: options.deep_dup, sql: SqlStruct::IndexComponents.new) { |env|
               env.sql.name, env.sql.type, env.sql.columns, env.sql.options, env.sql.algorithm, env.sql.using = super env.table_name, env.column_names, env.options

data/lib/schema_plus/core/active_record/connection_adapters/mysql2_adapter.rb

@@ -16,6 +16,12 @@ module SchemaPlus
             end
           end
 
+          def drop_table(table_name, options={})
+            SchemaMonkey::Middleware::Migration::DropTable.start(connection: self, table_name: table_name, options: options.dup) do |env|
+              super env.table_name, env.options
+            end
+          end
+
           def indexes(table_name, query_name=nil)
             SchemaMonkey::Middleware::Schema::Indexes.start(connection: self, table_name: table_name, query_name: query_name, index_definitions: []) { |env|
               env.index_definitions += super env.table_name, env.query_name

data/lib/schema_plus/core/active_record/connection_adapters/postgresql_adapter.rb

@@ -16,6 +16,12 @@ module SchemaPlus
             end
           end
 
+          def drop_table(table_name, options={})
+            SchemaMonkey::Middleware::Migration::DropTable.start(connection: self, table_name: table_name, options: options.dup) do |env|
+              super env.table_name, env.options
+            end
+          end
+
           def exec_cache(sql, name, binds)
             SchemaMonkey::Middleware::Query::Exec.start(connection: self, sql: sql, query_name: name, binds: binds) { |env|
               env.result = super env.sql, env.query_name, env.binds

data/lib/schema_plus/core/middleware.rb

@@ -17,6 +17,7 @@ module SchemaPlus
         module Indexes
           ENV = [:connection, :query_name, :table_name, :index_definitions]
         end
+
       end
 
       module Migration
@@ -27,6 +28,11 @@ module SchemaPlus
         module Index
           ENV = [:caller, :operation, :table_name, :column_names, :options]
         end
+
+        module DropTable
+          ENV = [:connection, :table_name, :options]
+        end
+
       end
 
       module Sql

data/lib/schema_plus/core/version.rb

@@ -1,5 +1,5 @@
 module SchemaPlus
   module Core
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/spec/dumper_spec.rb

@@ -33,7 +33,7 @@ describe SchemaMonkey::Middleware::Dumper do
   end
 
 
-  private 
+  private
 
   def middleware
     described_class

data/spec/middleware_spec.rb

@@ -59,6 +59,10 @@ describe SchemaMonkey::Middleware do
       Then { expect_middleware(enable: {type: :reference}, env: {operation: :define, column_name: "ref_id"}) { table_statement(:belongs_to, "ref") } }
     end
 
+    context TestReporter::Middleware::Migration::DropTable do
+      Then { expect_middleware { connection.drop_table "things" } }
+    end
+
     context TestReporter::Middleware::Migration::Index do
       Given { migration.add_column("things", "column1", "integer") }
       Then { expect_middleware { table_statement(:index, "id") } }

data/spec/support/test_reporter.rb

@@ -1,5 +1,5 @@
 module TestReporter
-  
+
   class Called < Exception
     attr_accessor :middleware, :env
     def initialize(middleware:, env:)
@@ -32,6 +32,7 @@ module TestReporter
     module Migration
       module Column ;                   include Notify ; end
       module Index ;                    include Notify ; end
+      module DropTable ;                include Notify ; end
     end
 
     module Sql

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_plus_core
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ronen barzel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord