dbmanager 0.1.4 → 0.1.6

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## v0.1.6
+
+* close issue #5 (should not require 'dbmanager.rb' in the rake file)
+
+## v0.1.5
+
+* import task creates the target db if necessary
+
 ## v0.1.4
 
 * environments are now listed sorted

data/Guardfile

@@ -0,0 +1,25 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/README.md

@@ -33,7 +33,7 @@ rake db:dump
 ```
 This rake task will dump the requested db to a file on the local machine.
 
-**You will be prompted to choose the target dir** (defaults to *tmp* in the rails
+You will be prompted to choose the target dir (defaults to *tmp* in the rails
 root) and the sql file name (sql extension will be added automatically). If the
 file already exists, it will be overwritten.
 
@@ -44,7 +44,7 @@ file already exists, it will be overwritten.
 rake db:import
 ```
 
-**You will be prompted to choose the source and the target environment db**, and the
+You will be prompted to choose the source and the target environment db, and the
 source db will be imported into the target db.
 
 This task will import a source db to a destination db. Tipical use is to import
@@ -59,47 +59,62 @@ overwrite them unless you explicitly override this setting in the override file
 choose to overwite. I take no responsibility for misuse or bugs in the code ;-)
 
 
-#### Override database.yml
+#### Override database.yml and custom configurations
 
 Since some settings may be specific to the server environment (ie. host could
 be a private ip not reachable from elsewhere) you can override the settings in
 database.yml by adding a dbmanager_override.yml file in your rails config dir.
 
-You can also use this file to tell the dumper to ignore certain tables with
-the ignoretables directive:
-
-```yaml
-  beta:
-    ignoretables:
-      - users
-      - prods_view
-```
-
-Another use is to set some environment as protected, or on the other hand allow
+Tipical use is to set some environment as protected, or on the other hand allow
 overwriting if it's protected by default (ie. production env).
 
-For example if you want to override the following setting, and make the database
-protected from overwriting:
+If you want to override the following setting in the database.yml file making
+the database protected from overwriting and changing the host address to a
+public one:
 
 ```yaml
 beta:
   host: 192.168.0.1
 ```
-you should put this in dbmanager_override.yml:
+you should put this in config/dbmanager_override.yml:
 
 ```yaml
 beta:
-  host: 234.234.234.234
   protected: true
+  host: 234.234.234.234
 ```
 
-Instead, if you want to make the production env writable you should add this:
+Instead, if you want to make the production env writable you should add this to
+the config/dbmanager_override.yml file:
 
 ```yaml
 production:
   protected: false
 ```
 
+On mysql you can instruct the dumper to ignore certain tables using the
+ignoretables directive:
+
+```yaml
+  beta:
+    ignoretables:
+      - users
+      - prods_view
+```
+
+
+## Documentation
+
+You can find some more documentation on the workings of the gem on relish:
+https://www.relishapp.com/spaghetticode/dbmanager/docs
+
+
+## Tests
+
+run rspec tests: ```rake```
+
+run cucumber tests: ```cucumber```
+
 
 ### TODO
 

data/Rakefile

@@ -4,5 +4,5 @@ Bundler::GemHelper.install_tasks
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
-Rspec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec)
 task :default => :spec

data/dbmanager.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["andrea longhi"]
   s.email       = ["andrea.longhi@mikamai.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/spaghetticode/dbmanager"
   s.summary     = %q{database manager}
   s.description = %q{helps manage db dumps and imports via rake tasks}
 
@@ -23,4 +23,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rake'
+  s.add_development_dependency 'cucumber'
+  s.add_development_dependency 'guard-rspec'
+  s.add_development_dependency 'guard-cucumber'
 end

data/features/dump.feature

@@ -0,0 +1,17 @@
+Feature: dump database
+As a dbmanager gem user
+I want to dump any of my app databases to a sql file
+so that I can use the file later
+
+  After adding the gem, when running **rake db:dump**
+  you can choose the environment db to dump, and the
+  path/filename you want for the dump file. After the
+  task has completed you will find the dump in the
+  expected location.
+
+Scenario: Dump database to user specified file
+  Given I go to the dummy rails app folder
+
+  When  I run the task "db:dump" with input "1 tmp/dbmanager_dummy_dev.sql"
+  Then  a sql dump should be created in "tmp/dbmanager_dummy_dev.sql"
+  And   the dump file should include expected schema

data/features/rake_tasks.feature

@@ -0,0 +1,20 @@
+Feature: Dbmanager rake task listed in rake -T
+ As a dbmanager gem user
+  I want the dbmanager rake tasks to be added to my application
+  so that I can execute them.
+
+    **Dbmanager** adds 2 rake tasks to your application:
+
+      db:dump  that interactively dumps the content of a db
+      db:import that interactively import a db into another
+
+
+Scenario: db:dump task
+  Given I go to the dummy rails app folder
+  When  I execute "rake -T"
+  Then  I should see "db:dump" among the listed tasks
+
+Scenario: db:import task
+  Given I go to the dummy rails app folder
+  When  I execute "rake -T"
+  Then  I should see "db:import" among the listed tasks

data/features/readme.md

@@ -0,0 +1,121 @@
+## Dbmanager
+
+[![Build Status](https://secure.travis-ci.org/spaghetticode/dbmanager.png)](http://travis-ci.org/spaghetticode/dbmanager)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/spaghetticode/dbmanager)
+
+This gem will add some convenience rake tasks that will help you manage database
+dumps and imports. At the moment only the mysql adapter is available.
+
+The gems works both on rails 2.x and 3.x applications, but due to rails 2.x
+limitations you have to run a generator, see the usage section
+
+
+### Usage
+
+Add the gem to your gemfile:
+
+```ruby
+  gem 'dbmanager'
+```
+
+If you're on a rails 2.x application you also need to run:
+
+```ruby
+script/generate dbmanager
+```
+that will copy the gem rake tasks file into the lib/tasks directory.
+
+
+#### Database Dumps
+
+```ruby
+rake db:dump
+```
+This rake task will dump the requested db to a file on the local machine.
+
+You will be prompted to choose the target dir (defaults to *tmp* in the rails
+root) and the sql file name (sql extension will be added automatically). If the
+file already exists, it will be overwritten.
+
+
+#### Database Imports
+
+```ruby
+rake db:import
+```
+
+You will be prompted to choose the source and the target environment db, and the
+source db will be imported into the target db.
+
+This task will import a source db to a destination db. Tipical use is to import
+the production db into your development one. All environments containing the
+string 'production' in their name are protected by default, which means you cannot
+overwrite them unless you explicitly override this setting in the override file
+(see next section for more info).
+
+#### BEWARE
+
+**the import process is destructive** so be careful on which environment you
+choose to overwite. I take no responsibility for misuse or bugs in the code ;-)
+
+
+#### Override database.yml and custom configurations
+
+Since some settings may be specific to the server environment (ie. host could
+be a private ip not reachable from elsewhere) you can override the settings in
+database.yml by adding a dbmanager_override.yml file in your rails config dir.
+
+Tipical use is to set some environment as protected, or on the other hand allow
+overwriting if it's protected by default (ie. production env).
+
+If you want to override the following setting in the database.yml file making
+the database protected from overwriting and changing the host address to a
+public one:
+
+```yaml
+beta:
+  host: 192.168.0.1
+```
+you should put this in config/dbmanager_override.yml:
+
+```yaml
+beta:
+  protected: true
+  host: 234.234.234.234
+```
+
+Instead, if you want to make the production env writable you should add this to
+the config/dbmanager_override.yml file:
+
+```yaml
+production:
+  protected: false
+```
+
+On mysql you can instruct the dumper to ignore certain tables using the
+ignoretables directive:
+
+```yaml
+  beta:
+    ignoretables:
+      - users
+      - prods_view
+```
+
+
+## Documentation
+
+You can find some more documentation on the workings of the gem on relish:
+https://www.relishapp.com/spaghetticode/dbmanager/docs
+
+
+## Tests
+
+run rspec tests: ```rake```
+
+run cucumber tests: ```cucumber```
+
+
+### TODO
+
+* Add more db adapters

data/features/step_definitions/dump_steps.rb

@@ -0,0 +1,14 @@
+When /^I interactively execute "(.*?)"$/ do |command|
+  system command
+end
+
+Then /^an? sql dump should be created in "(.*?)"$/ do |path|
+  File.file?(path).should be_true
+end
+
+Then /^the dump file should include expected schema$/ do
+  dump = File.read('tmp/dbmanager_dummy_dev.sql')
+  File.open('db/structure.sql').each do |line|
+    dump.should include(line) unless line =~ /INSERT INTO schema_migrations/
+  end
+end

data/features/step_definitions/rake_tasks_steps.rb

@@ -0,0 +1,18 @@
+Given /^I go to the dummy rails app folder$/ do
+  Dir.chdir File.expand_path(DUMMY_PATH, __FILE__)
+end
+
+When /^I execute "(.*?)"$/ do |command|
+  @output = `#{command}`
+end
+
+Then /^I should see "(.*?)" among the listed tasks$/ do |task_name|
+  @output.should include(task_name)
+end
+
+When /^I run the task "(.*?)" with input "(.*?)"$/ do |task, params|
+  File.open STDIN_STUB, 'w' do |f|
+    params.split(' ').each {|param| f.puts param}
+  end
+  step "I execute \"rake #{task} < #{STDIN_STUB}\""
+end

data/features/support/dummy_app_initialization.rb

@@ -0,0 +1,21 @@
+# makes sure the dummy app is properly initialized:
+# bundles required gems
+# drops/creates the databases
+# migrates the development database
+# dumps db structure for reference
+# removes old sql dumps in tmp dir
+
+STDIN_STUB = 'STDIN_stub'
+DUMMY_PATH = '../../../spec/dummy'
+Dir.chdir File.expand_path(DUMMY_PATH, __FILE__) do
+  system 'bundle install'
+  system 'rm -f tmp/*sql'
+  %w[
+    db:drop:all
+    db:create:all
+    db:migrate
+    db:structure:dump
+  ].each do |command|
+    system "bundle exec rake #{command}"
+  end
+end

data/lib/dbmanager.rb

@@ -1,4 +1,17 @@
+require 'active_support/deprecation'
+require 'active_support/core_ext/module'
+require 'active_support/ordered_hash'
+require 'active_support/core_ext/enumerable'
+require 'active_support/core_ext/object/blank'
+
 module Dbmanager
+  autoload :Environment, 'dbmanager/environment'
+  autoload :YmlParser,   'dbmanager/yml_parser'
+  autoload :Runner,      'dbmanager/runner'
+  autoload :Importable,  'dbmanager/importable'
+  autoload :Dumpable,    'dbmanager/dumpable'
+  autoload :Adapters,    'dbmanager/adapters'
+
   class EnvironmentProtectedError < StandardError
     def initialize(message=nil)
       super message || 'sorry the environment is protected from writing'
@@ -36,13 +49,3 @@ module Dbmanager
     execute(command) or raise CommandError
   end
 end
-
-require 'active_support/deprecation'
-require 'active_support/core_ext/module'
-require 'active_support/ordered_hash'
-require 'active_support/core_ext/enumerable'
-require 'active_support/core_ext/object/blank'
-
-%w[environment yml_parser adapters/mysql adapters/mysql2 runner importable dumpable].each do |string|
-  require File.expand_path "../dbmanager/#{string}", __FILE__
-end

data/lib/dbmanager/adapters.rb

@@ -0,0 +1,6 @@
+module Dbmanager
+  module Adapters
+    autoload :Mysql,  'dbmanager/adapters/mysql'
+    autoload :Mysql2, 'dbmanager/adapters/mysql2'
+  end
+end

data/lib/dbmanager/adapters/mysql.rb

@@ -52,6 +52,7 @@ module Dbmanager
 
         def run
           Dumper.new(source, tmp_file).run
+          Dbmanager.execute! create_db_if_missing_command
           Dbmanager.execute! import_command
         ensure
           remove_tmp_file
@@ -64,6 +65,15 @@ module Dbmanager
         def remove_tmp_file
           Dbmanager.execute "rm #{tmp_file}"
         end
+
+        def create_db_if_missing_command
+          # it is safe to hardcode bundle exec here?
+          "#{bundle} rake db:create RAILS_ENV=#{target.name}"
+        end
+
+        def bundle
+          Dbmanager.execute('which bundle') ? 'bundle exec' : nil
+        end
       end
     end
   end