nomadize 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24e4a53c7ce85b9aee4219137933e62f8d4ae79c
-  data.tar.gz: a859e3e0db9e603db1998d7f5e8e11907e5c9274
+  metadata.gz: 1356c5d4667a3fbd4c11ab51081300c6a9f33c9a
+  data.tar.gz: 5aaf1896c0727b7707c0ce1e451534dce8e08446
 SHA512:
-  metadata.gz: 9959f0b9257e56ac4d77cb8c7918fe5c9d9927e4a6b63d9fde13a7253e36f149a739792926ab1bcbed96b51159bfe06997206965dd125ae43ecad37d5b530247
-  data.tar.gz: 53fc2a4752307418c5a5a48a154cd626e44d8c60866c7b184fb6584a21464a9bb6f1cea36539d543f0d41ad0cbcc9c6eedcdec7684e2e5462c291530fe552dee
+  metadata.gz: 2796afcc8b7c193276fed363e6224c2f41afe483feb6ba144611bde7d074fbd29b8d962c25e5c19dbc1ac084a8a804feea504e8279c2ccc4c26948717ca0f1ad
+  data.tar.gz: 39241f364e82510901a39a32f45527048090dda7188134e1c98dabe2d3f7c87e9e9e7a1a7bef46e16efe4f6c575cd9bf97345a7f491aa47fd7e77f824a040157

data/README.md

@@ -22,7 +22,11 @@ Or install it yourself as:
 
 ## Usage
 
-Nomadize expects a database configuration file in `config/database.yml`. You can generate this file with the rake task `db:generate_template_config` or write it yourself. This file should look something like:
+Nomadize supports two different methods for configuring the connection to Postgres. Nomadize will also provide access to the underlying PG connection wrapper (using your defined config) by using the `Nomadize::Config.db` method. This wrapper responds to `exec` in the same way that the underlying PG connection object does.
+
+### Config File
+
+You may use a config file `config/database.yml`. This file can be generated with either the rake task: `db:generate_template_config` or the CLI: `$ nomadize generate_template_config`. You can also choose to create the file for yourself. `config/database.yml` should look something like:
 
 ```
 development:
@@ -33,10 +37,28 @@ production:
   :dbname: lol_production
 ```
 
-test/development/production keys set environment dependent options (through `RACK_ENV`) for the postgres connection object. These key/value pairs are handed directly to the `PG.connect` method, documentation for what options can be passed can be found [here](http://deveiate.org/code/pg/PG/Connection.html#method-c-new).
+The test/development/production keys define environment dependent options for the `PG.connection` based on the environment set via `RACK_ENV`. These key/value pairs are handed directly to the `PG.connect` method, documentation for what options can be passed can be found [here](http://deveiate.org/code/pg/PG/Connection.html#method-c-new).
+
+The directory in which to find migrations files can optionally be set with the config:
+`migrations_path: db/migrations`
+The default value is `db/migrations`
 
-`migrations_path: db/migrations` defines where Nomadize should find and create your migration files, this setting is optional and is set to `db/migrations` by default.
+### ENV['DATABASE_URL']
 
+As of 0.4.0 Nomadize will also respect the `DATABASE_URL` environment variable. If `DATABASE_URL` is set it will override the connection information in the config file `config/database.yml`.
+eg `postgres://user1:supersecure@somehost:1337/database-name` will result in the following configuration hash being passed to the underlying `PG.connection` object.
+
+```ruby
+{
+  dbname:   'database-name',
+  port:     1337,
+  user:     'user1',
+  password: 'supersecure',
+  host:     'somehost'
+}
+```
+
+### Migrations
 After a config file is in place  add `require 'nomadize/tasks'` to your rake file, and enjoy helpful new rake tasks such as:
 
 * `rake db:create` - creates a database and a schema_migrations table
@@ -55,6 +77,7 @@ Alternatively you can use the commandline tool `nomadize`:
 * `nomadize migrate` - runs migrations found in db/migrations that have not been run yet
 * `nomadize status` - see which migrations have or have not been run
 * `nomadize rollback $count` - rollback migrations (default count: 1)
+* `nomadize generate_template_config` - generate a config file in `config/database.yml`
 
 Migrations are written in SQL in the generated YAML files:
 
@@ -64,8 +87,6 @@ Migrations are written in SQL in the generated YAML files:
 :down: 'DROP TABLE testing;'
 ```
 
-You also have access to the underlying PG connection wrapper (using your defined config) by using the `Nomadize::Config.db` method. This wrapper responds to `exec` in the same way that the underlying PG connection object does.
-
 ## Development
 
 todo:
@@ -75,7 +96,7 @@ todo:
 - [x] to display migration status
 - [x] migration rollbacks
 - [ ] transactions / error handling
-- [ ] maybe some kind of logging idk
+- [x] maybe some kind of logging idk
 - [x] possibly wrap pg
 - [x] template config file generator
 - [x] maybe set a default migrations path (so the key isn't required in the config file)
@@ -91,6 +112,13 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/piisal
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 ## Changelog
+0.4.0
+  * support DATABASE_URL env variable
+  * Add template_config generator to command line tool
+  * Update the README
+  * Added some basic logging
+  * Fix an issue with rollback count not actually working :'(
+
 0.3.0
   * Include a command line interface for Nomadize commands (THANKS [@moonglum](https://github.com/moonglum))
 

data/exe/nomadize

@@ -6,7 +6,7 @@ require 'nomadize/help'
 def show_help
   puts "Usage:"
   Nomadize.help.each_pair do |command, help|
-    puts "  nomadize #{command.to_s.ljust(15)} #{help}"
+    puts "  nomadize #{command.to_s.ljust(25)} #{help}"
   end
 end
 
@@ -25,6 +25,7 @@ when 'new_migration' then Nomadize.generate_template_migration_file(migration_na
 when 'migrate' then Nomadize.migrate
 when 'status' then Nomadize.status
 when 'rollback' then Nomadize.rollback(ARGV.fetch(1, 1))
+when 'generate_template_config' then Nomadize.generate_template_config
 when nil then abort 'Error: No Command Provided'
 else abort "Error: Unknown Command '#{ARGV[0]}'"
 end

data/lib/nomadize/config.rb

@@ -1,5 +1,6 @@
 require 'yaml'
 require 'pg'
+require 'uri'
 require 'nomadize/pg_wrapper'
 
 module Nomadize
@@ -10,7 +11,7 @@ module Nomadize
     end
 
     def self.db_connection_info
-      config_file.fetch(env)
+      database_url_config || config_file.fetch(env)
     end
 
     def self.database_name
@@ -29,5 +30,22 @@ module Nomadize
       PGWrapper.new(PG.connect(db_connection_info))
     end
 
+    private
+
+    def self.database_url_config
+      ENV['DATABASE_URL'] ? parse(ENV['DATABASE_URL']) : nil
+    end
+
+    def self.parse(database_url)
+      uri = URI.parse(database_url)
+      config = { }
+      config[:port]     = uri.port               if uri.port
+      config[:user]     = uri.user               if uri.user
+      config[:host]     = uri.host               if uri.host
+      config[:password] = uri.password           if uri.password
+      config[:dbname]   = uri.path.sub("/", "")  if uri.path
+      config
+    end
+
   end
 end

data/lib/nomadize/file_generator.rb

@@ -14,7 +14,9 @@ module Nomadize
 
     def save
       FileUtils.mkdir_p path unless File.exists?(path)
+      migration_file = File.join(path, timestamped_name)
       File.open(File.join(path, timestamped_name), "w") { |f| f.write(template_content) }
+      migration_file
     end
 
     private

data/lib/nomadize/help.rb

@@ -5,7 +5,8 @@ module Nomadize
     new_migration: 'Generate a migration template file. default directory: {appdir}/db/migrations',
     migrate: 'Run migrations',
     status: 'View the status of known migrations',
-    rollback: 'Rollback migrations (default count: 1)'
+    rollback: 'Rollback migrations (default count: 1)',
+    generate_template_config: 'generate template config/database.yml config file'
   }
   class << self; attr_reader :help; end
 end

data/lib/nomadize/migration.rb

@@ -12,11 +12,13 @@ module Nomadize
     def run(db)
       db.exec(up)
       db.insert_migration_filename(filename)
+      filename
     end
 
     def rollback(db)
       db.exec(down)
       db.remove_migration_filename(filename)
+      filename
     end
 
   end

data/lib/nomadize/migrator.rb

@@ -13,7 +13,7 @@ module Nomadize
     end
 
     def rollback(count)
-      done[-count..-1].reverse.map { |migration| migration.rollback(db) }
+      done[-count.to_i..-1].reverse.map { |migration| migration.rollback(db) }
     end
 
     def pending

data/lib/nomadize/tasks.rb

@@ -34,7 +34,7 @@ namespace :db do
     Nomadize.rollback(count)
   end
 
-  desc 'generate template config file'
+  desc Nomadize.help.fetch(:generate_template_config)
   task :generate_template_config do
     Nomadize.generate_template_config
     puts 'Config created in config/database.yml'

data/lib/nomadize/version.rb

@@ -1,3 +1,3 @@
 module Nomadize
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/nomadize.rb

@@ -14,7 +14,8 @@ module Nomadize
     migrations      = migration_files.map { |migration| Migration.new(migration) }
     migrator        = Migrator.new(db: db, migrations: migrations)
 
-    migrator.run
+    files_migrated = migrator.run
+    puts files_migrated
     db
   end
 
@@ -45,7 +46,8 @@ module Nomadize
     migrations      = migration_files.map { |migration| Migration.new(migration) }
     migrator        = Migrator.new(db: db, migrations: migrations)
 
-    migrator.rollback(count)
+    files_rolled_back = migrator.rollback(count)
+    puts files_rolled_back
     db
   end
 
@@ -54,7 +56,8 @@ module Nomadize
   end
 
   def self.generate_template_migration_file(name)
-    Nomadize::FileGenerator.new(path: Config.migrations_path, name: name).save
+    migration_file = Nomadize::FileGenerator.new(path: Config.migrations_path, name: name).save
+    puts "Migration file created: #{Dir.pwd}/#{migration_file}"
   end
 
   def self.generate_template_config

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nomadize
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Paul Dawson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-02 00:00:00.000000000 Z
+date: 2015-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler