monkey_butler 1.2.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8608dfbdf6c5a0ba826db10aab5bcd902cb6a0f5
+  data.tar.gz: 93103df68206b61e6ebb1d4d704ae32355c11965
+SHA512:
+  metadata.gz: 40e6e913faded1c3b56690211b91b84b367c7c71172b0e3e7dfcfbb03a89bb2c008cf35401cd0b60a91140c33c3cbb360821e644dec41e6d67198716fbf6000f
+  data.tar.gz: dc075e0fc9b53f2849a674319b62dfa9064b27739561bffb1de7bcbed1b6e85a594400cfca7e0ddc84ad7e9fb3334a277b643abddb6c1ffecd3f698d10bee8bf

data/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_BIN: .bundle/bin

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+*.gem
+.bundle/bin

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p481

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+## v1.2.1
+
+* Fix double dumping of the default keyspace when using multiple Cassandra keyspaces.
+
+## v1.2.0
+
+* Introduced `mb drop` for dropping a database.
+* Introduced `mb config` for working with config variables.
+
+## v1.1.1
+
+* Include the names of all keyspaces being dumped during a multi-keyspace dump.
+
+## v1.1.0
+
+* Added support for dumping additional keyspaces in Cassandra. Keyspaces are specified via the `cassandra.keyspaces` config setting.
+
+## v1.0.2
+
+* Explicitly require database classes in database targets to avoid `NameError` exception.
+
+## v1.0.1
+
+* Guard against attempts to execute blank Cassandra queries when applying migrations.
+
+## v1.0.0
+
+* Initial public release supporting SQLite and Cassandra.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,122 @@
+PATH
+  remote: .
+  specs:
+    monkey_butler (1.2.2)
+      cql-rb (~> 2.0.0)
+      sqlite3 (~> 1.3.9)
+      thor (~> 0.19.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.18)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    byebug (3.1.2)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    claide (0.6.1)
+    cocoapods (0.33.1)
+      activesupport (>= 3.2.15, < 4)
+      claide (~> 0.6.1)
+      cocoapods-core (= 0.33.1)
+      cocoapods-downloader (~> 0.6.1)
+      cocoapods-plugins (~> 0.2.0)
+      cocoapods-trunk (~> 0.1.1)
+      cocoapods-try (~> 0.3.0)
+      colored (~> 1.2)
+      escape (~> 0.0.4)
+      json_pure (~> 1.8)
+      nap (~> 0.7)
+      open4 (~> 1.3)
+      xcodeproj (~> 0.17.0)
+    cocoapods-core (0.33.1)
+      activesupport (>= 3.2.15)
+      fuzzy_match (~> 2.0.4)
+      json_pure (~> 1.8)
+      nap (~> 0.5)
+    cocoapods-downloader (0.6.1)
+    cocoapods-plugins (0.2.0)
+      nap
+    cocoapods-trunk (0.1.3)
+      json_pure (~> 1.8)
+      nap (>= 0.6)
+      netrc
+    cocoapods-try (0.3.0)
+    coderay (1.1.0)
+    colored (1.2)
+    columnize (0.8.9)
+    cql-rb (2.0.0)
+      ione (~> 1)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    docile (1.1.3)
+    escape (0.0.4)
+    ffi (1.9.3)
+    formatador (0.2.5)
+    fuzzy_match (2.0.4)
+    guard (2.6.1)
+      formatador (>= 0.2.4)
+      listen (~> 2.7)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.2.10)
+      guard (~> 2.1)
+      rspec (>= 2.14, < 4.0)
+    i18n (0.6.9)
+    ione (1.1.2)
+    json_pure (1.8.1)
+    listen (2.7.7)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.6)
+    method_source (0.8.2)
+    multi_json (1.10.1)
+    nap (0.8.0)
+    netrc (0.7.7)
+    open4 (1.3.4)
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.3.2)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    slop (3.5.0)
+    sqlite3 (1.3.9)
+    thor (0.19.1)
+    timers (1.1.0)
+    xcodeproj (0.17.0)
+      activesupport (~> 3.0)
+      colored (~> 1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  byebug (~> 3.1.2)
+  cocoapods (~> 0.33.1)
+  guard-rspec (~> 4.2.9)
+  monkey_butler!
+  rake
+  rspec (~> 2.14.1)
+  simplecov (~> 0.8.2)

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/monkey_butler/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2009-2012 The RestKit Project
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,221 @@
+# Monkey Butler
+[![Gem Version](https://badge.fury.io/rb/monkey_butler.svg)](http://badge.fury.io/rb/monkey_butler)
+
+![Monkey Butler](logo.jpg)
+
+Monkey Butler is a database schema management system written in Ruby. It currently supports SQLite and Cassandra database 
+targets. It was built to solve the schema management challenges on the mobile SDK's and server side services developed for 
+the [Layer](http://layer.com) platform.
+
+Monkey Butler manages a Git repository containing a database schema and an arbitrary number of migrations. The migrations are 
+authored in SQL format and platform specific renderings of the schema and migrations are created via code generation.
+The current schema and all associated migrations can then be packaged into a release and shipped as a versioned, installable package.
+
+## Features
+
+* Manages a Git repository containing a database schema and migrations
+* Supports SQLite and Cassandra schemas
+* Generates platform specific database management and migration utilities
+* Ensures that the current schema and all migrations are valid SQLite
+* Packages schema and associated migrations into versioned releases
+* Publishes releases for dependency management via CocoaPods and Maven
+
+## Requirements
+
+Monkey Butler requires a modern Ruby runtime (v1.9.x and up) and the following supporting cast:
+
+* [thor](http://whatisthor.com/) - Toolkit for building powerful commandline utilities
+
+## Usage
+
+Monkey Butler is a commandline utility available via the `mb` binary. There are a number of standard commandline
+switches available that control the defaults and target behavior of a Monkey Butler invocation. You can obtain help directly from the 
+application by executing `mb help`.
+
+### Initializing a Project
+
+Creates a new Monkey Butler schema repository at the path specified. Please refer to the documentation below regarding
+the repository structure.
+
+`$ mb init [path/to/project]`
+
+The default database target is SQLite, but you can specify an alternate database by using the `database` switch:
+
+`$ mb init --database=cassandra://localhost:9042/keyspace`
+
+### Loading the Schema
+
+Loads the current schema defined in `schema.sql` into a local database named `database.sqlite`.
+
+`$ mb load`
+
+### Creating a Migration
+
+Creates a new migration file at `migrations/[TIMESTAMP]_[NAME].sql`. Please refer to the documentation below about timestamp
+and versioning semantics.
+
+`$ mb create [name]`
+
+### Displaying Status
+
+Displays information about the current schema and any unapplied migrations.
+
+`$ mb status`
+
+### Applying Migrations
+
+Applies all pending to a target database by directly executing the SQL migrations.
+
+`$ mb migrate [target version]`
+
+### Generating Implementations
+
+Generates platform specific implementations into `migrations/[migration].m` and `migrations/[migration].java`.
+
+`$ mb generate`
+
+### Validating Schema & Migrations
+
+Validates that the schema loads and all migrations apply forward from a clean database.
+
+`$ mb validate`
+
+### Packaging a Release
+
+Packages a release of the schema by validating the project, generating all implementations, and creating a tag into the
+project Git repository.
+
+`$ mb package [version]`
+
+### Pushing a Release
+
+Pushes a release to Git, CocoaPods, and Maven.
+
+`$ mb push [version]`
+
+## Design & Implementation Details
+
+Monkey Butler was designed to deliver the following properties:
+
+1. Provide a simple mechanism for integrating a unified schema into multiple codebases in parallel.
+1. Support straightforward bootstrapping of a database with the current schema.
+2. Support easy migrations from any previous version of the schema up to the latest by applying an ordered sequence of migrations.
+3. Enable reliable, low friction testing of the migration process.
+4. Support a heavily branched, multi-developer workflow in which multiple developers are evolving the schema in parallel.
+
+This portion of the document details how Monkey Butler has been implemented to deliver these properties.
+
+### Project Layout
+
+A Monkey Butler project is a simple filesystem layout with version control provided by Git. When a new project is
+initialized, it has the following structure:
+
+	.
+	├── .gitignore
+	├── .monkey_butler.yml
+	├── [project-name].sql
+	├── [project-name].sqlite
+	└── migrations
+	    └── <date-created>-create-[project-name].sql
+
+Subsequent commands will create files into this filesystem and perform manipulations on the database. The schema can be branched, merged, and 
+released using standard Git techniques.
+
+### Versioning
+
+The client schema is internally versioned using timestamps. Timestamps are used instead of monotonically incrementing integers because they better 
+support a branched, multi-developer workflow. The latest version of the overall schema is equal to the timestamp of the most recently applied migration. 
+The current schema version of a given database is derivable by examining the `schema_migrations` table, which maintains a record of all migrations that 
+have been applied to the database since its creation.
+
+The `schema_migrations` table has the following schema:
+
+```
+CREATE TABLE schema_migrations(
+	version INTEGER UNIQUE NOT NULL
+);
+
+```
+
+The `version` column encodes the date a migration was created. The presence of a given migration version in the table indicates that the migration 
+has been applied to the parent database.
+
+#### Computing Origin and Current Version
+
+To compute the "origin version" (the version of the schema at the time the database was created), select the minimum value for the `version` column in the `schema_migrations` table:
+
+`SELECT MIN(version) FROM schema_migrations`
+
+The current version of the database is computable by selecting the maximum value for the `version` column present in the `schema_migrations` table:
+
+`SELECT MAX(version) FROM schema_migrations`
+
+Note that knowing the current version is not sufficient for computing if the database is fully migrated. This is because migrations that were created 
+in the past may not yet have been merged, released and applied yet.
+
+#### Computing Unapplied Migrations
+
+In order to compute the set of migrations that have not yet been applied to a given database, one must take the following steps:
+
+1. Compute the origin version of the database
+2. Build a collection of the versions of all known migrations in the current build of the code.
+3. Build a collection of all migration versions that have already been applied to the database (`SELECT version FROM schema_migrations`);
+4. Remove any migrations from the list with a version less than the origin version of the database.
+5. Diff the collections of migrations. The set that remains is the set of unapplied migrations.
+6. Order the set of unapplied migrations into an array of ascending values and apply them in order from oldest to newest. 
+
+### Migrations
+
+Migrations are authored in pure SQL. A code generation process is used to platform-specific, executable implementation of the migrations in Java and Objective-C
+from the source SQL files.
+
+The SQL migration files are named by concatenating a timestamp version with a brief textual description of the database change they introduce to the system. 
+This naming convention is of the form "${VERSION_IDENTIFIER}_${MIGRATION_DESCRIPTION_UNDERSCORED}.sql". The `VERSION_IDENTIFIER` is equal to the 
+following invocation of the `date` utility (on platforms with GNU coreutils): `date +"%Y%m%d%H%M%S%3N"` This date format includes the year, month, day, hour, minute, 
+second and three digits of milliseconds. This ensures that there is very little chance of overlap no matter how many developers are working on the schema, 
+while still supporting very straightforward sorting in the database.
+
+An example migration file might be called: `201405125248499_add_unqiue_constraint_to_streams.sql`
+
+The implementation of the generated migration class in Objective-C may look like:
+
+```objc
+@interface MBAddUniqueConstraintToStreamsMigration : NSObject <MBMigratable>
+@end
+
+@implementation LYR_AddUniqueConstraintToStreamsMigration
+
++ (NSString *)version
+{
+	return @"201405125248499";
+}
+
+- (BOOL)migrateDatabase:(FMDatabase *)database error:(out NSError *__autoreleasing *)error
+{
+	// Apply the migration
+}
+
+@end
+```
+
+Platform specific migrations can also be generated.
+
+## Companion Projects
+
+Monkey Butler itself only generates installable packages containing the schema and migrations. To utilize these schemas in an application you'll
+need support code. The following companion projects are available for this use:
+
+* [FMDBMigrationManager](https://github.com/layerhq/FMDBMigrationManager) - An Objective-C SQLite migration manager implementation for use with the [FMDB](https://github.com/ccgus/fmdb) library.
+* [SQLiteMigrationManager](https://github.com/layerhq/SQLiteMigrationManager) - A Java SQLite migration manager implementation for the Android [SQLiteDatabase](http://developer.android.com/reference/android/database/sqlite/SQLiteDatabase.html) interface.
+
+## Credits
+
+Blake Watters
+
+- http://github.com/blakewatters
+- http://twitter.com/blakewatters
+- blakewatters@gmail.com
+
+## License
+
+Monkey Butler is available under the Apache 2 License. See the LICENSE file for more info.