nomadize 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee738d9952a99b01a995138cb42d3f02a33a552e
-  data.tar.gz: a2d88cf37009b8826e651f4e7823e94305c45661
+  metadata.gz: 281d8eece08ec4e4ff09e73656dd2c7c57f5c723
+  data.tar.gz: e585f19613a01e82e198b57678c721d54d2fa09b
 SHA512:
-  metadata.gz: 10b5374b4a415af7adb87ad3268ef6fa103a86c17b989311e957085df2b843d722ee92314b3b89cbf515118f9c2d4eb879fe0085acf234812eb1fe5c0f639298
-  data.tar.gz: 1c9f547803f18082f8ee1d8a94f153b4c9f07886551524bc50d3c467951a9a4250cd010beb256853f783e3d119a7ce98477bc9984864da67119a1c03b74c0e54
+  metadata.gz: 0103c0e40303bb05c0b35cfc7b61e736c46fcf7b3e88ba260f77cb28c678a701483ea099bbb0bae1f7f41d9773d83ef63158e9c2d44b8cc5161a3c61b161cb6a
+  data.tar.gz: 5b2fa8e1548e3697c0e1d332c00afa4084038f640a573630b6bca1566d46ea4ab37ab801aff444e5f91c7741165f43c8c4bd271630e6d7e31ad206a2ad4b08d5

data/README.md

@@ -1,6 +1,7 @@
 # Nomadize
 
-Some simple tools for managing migrations with postgres (without requiring an entire ORM).
+Nomadize is a collection of rake tasks for managing migrations using a PostgreSQL database. It does not import an entire ORM and aims to be a small / simple utility.
+
 
 ## Installation
 
@@ -21,10 +22,9 @@ Or install it yourself as:
 
 ## Usage
 
-Nomadize expects a database configuration file in `config/database.yml`. This file should look something like:
+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:
 
 ```
-migrations_path: db/migrations
 development:
   :dbname: lol_dev
 test:
@@ -33,9 +33,9 @@ production:
   :dbname: lol_production
 ```
 
-`migrations_path` defines where Nomadize should find and create your migration files.
+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 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).
+`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.
 
 After a config file is in place  add `require 'nomadize/tasks'` to your rake file, and enjoy helpful new rake tasks such as:
 
@@ -45,7 +45,17 @@ After a config file is in place  add `require 'nomadize/tasks'` to your rake fil
 * `rake db:migrate` - runs migrations found in db/migrations that have not been run yet
 * `rake db:status` - see which migrations have or have not been run
 * `rake db:rollback[count]` - rollback migrations (default count: 1)
+* `rake db:generate_template_config` - generate a config file in `config/database.yml`
+
+Migrations are written in SQL in the generated YAML files:
+
+```
+---
+:up:   'CREATE TABLE testing (field TEXT);'
+: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
 
@@ -58,6 +68,8 @@ todo:
 - [ ] transactions / error handling
 - [ ] 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)
 
 
 ## Contributing

data/lib/nomadize.rb

@@ -57,4 +57,15 @@ module Nomadize
     Nomadize::FileGenerator.new(path: Config.migrations_path, name: name).save
   end
 
+  def self.generate_template_config
+    fail 'Config file already exists' if File.exists?('config/database.yml')
+    template_config = YAML.dump(
+      { 'development' => { dbname: '' },
+        'test'        => { dbname: '' },
+        'production'  => { dbname: '' }
+      } )
+    FileUtils.mkdir 'config' unless File.exists?('config')
+    File.open('config/database.yml', 'w') { |f| f.write(template_config) }
+  end
+
 end

data/lib/nomadize/config.rb

@@ -18,7 +18,7 @@ module Nomadize
     end
 
     def self.migrations_path
-      config_file.fetch("migrations_path")
+      config_file.fetch('migrations_path', 'db/migrations')
     end
 
     def self.config_file(path = 'config/database.yml')

data/lib/nomadize/tasks.rb

@@ -12,7 +12,7 @@ namespace :db do
     Nomadize.drop_database
   end
 
-  desc 'Generate a migration template file in {appdir}/db/migrations/'
+  desc "Generate a migration template file. default directory: {appdir}/db/migrations"
   task :new_migration, [:migration_name] do |_, args|
     Nomadize.generate_template_migration_file(args.migration_name)
   end
@@ -33,4 +33,10 @@ namespace :db do
     Nomadize.rollback(count)
   end
 
+  desc 'generate template config file'
+  task :generate_template_config do
+    Nomadize.generate_template_config
+    puts 'Config created in config/database.yml'
+  end
+
 end

data/lib/nomadize/version.rb

@@ -1,3 +1,3 @@
 module Nomadize
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/nomadize.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["paul@into.computer"]
 
   spec.summary       = %q{A simple database migration utility}
+  spec.description   = %q{Nomadize is a collection of rake tasks for managing migrations using a PostgreSQL database. It does not import an entire ORM and aims to be a small / simple utility.}
   spec.homepage      = "https://github.com/piisalie/nomadize"
   spec.license       = "MIT"
 
@@ -17,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = '~> 2.0'
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nomadize
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Dawson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-10 00:00:00.000000000 Z
+date: 2015-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,7 +66,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.1
-description: 
+description: Nomadize is a collection of rake tasks for managing migrations using
+  a PostgreSQL database. It does not import an entire ORM and aims to be a small /
+  simple utility.
 email:
 - paul@into.computer
 executables: []
@@ -101,9 +103,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="