active-dump 0.0.1 → 0.0.2

data/README.md

@@ -5,7 +5,7 @@
     Date        : 2013-11-13
 
     Copyright   : Copyright (C) 2013  Felix C. Stegerman
-    Version     : v0.0.1
+    Version     : v0.0.2
 
 []: }}}1
 
@@ -16,11 +16,12 @@
 
   active-dump - dump and restore activerecord from/to yaml
 
-  active-dump provides 2 rake tasks that allow you to dump and restore
+  active-dump provides 3 rake tasks that allow you to dump and restore
   activerecord data from/to yaml:
 
   * `rake db:data:dump` creates a yaml dump
   * `rake db:data:restore` restores a yaml dump
+  * `rake db:data:delete` deletes all records in database
 
 #
 
@@ -42,12 +43,16 @@ gem 'active-dump', require: 'active-dump/rails'
   * `FILE`: the file to dump to/restore from (defaults to
     `db/data.yml`)
   * `MODELS`: the models to dump (defaults to all models)
+  * `DELETE`: delete records with same id before restore (defaults to
+    false)
+  * `VERBOSE`: print info/sql (defaults to false)
+  * `DRYRUN`: don't do anything (defaults to false, implies `VERBOSE`)
 
 #
 
   Configuration files:
 
-  * `config/active-dump.yml`: the default file and models
+  * `config/active-dump.yml`: set defaults
   * `config/database.yml`: database connection
 
 []: }}}2
@@ -59,11 +64,14 @@ gem 'active-dump', require: 'active-dump/rails'
 
     $ rake db:data:dump MODELS=Foo,Bar
     $ RAILS_ENV=production rake db:data:load
+    $ rake db:data:restore DELETE=yes
+    $ rake db:data:delete   # CAREFUL!
 
 `config/active-dump.yml`:
 
 ```yaml
 file: db/dump.yml
+verbose: true
 models:
   - Cms::Block
   - Cms::Categorization
@@ -85,7 +93,7 @@ models:
 
 ## TODO
 
-  * specs/docs?
+  * specs! docs?
   * use model's database connection?!
   * ...
 

data/lib/active-dump/rake.rb

@@ -21,25 +21,37 @@ module ActiveDump
     extend ::Rake::DSL
 
     # define rake tasks
-    def self.define_tasks
+    def self.define_tasks                                       # {{{1
       namespace :db do
         namespace :data do
           desc 'Dump data'
           task :dump => :environment do
-            m = ENV['MODELS']
-            c = ActiveDump.config ENV['FILE'], (m && m.split(','))
-            ActiveDump.dump c
+            ActiveDump.dump cfg_from_env
           end
 
           desc 'Restore data'
           task :restore => :environment do
-            c = ActiveDump.config ENV['FILE']
-            ActiveDump.restore c
+            ActiveDump.restore cfg_from_env
+          end
+
+          desc 'Delete data'
+          task :delete => :environment do
+            ActiveDump.delete cfg_from_env
           end
         end
       end
-    end
-
+    end                                                         # }}}1
+
+    # get config from ENV
+    def self.cfg_from_env                                       # {{{1
+      f = ENV['FILE']   ; f2 = f && f.blank? ? nil : f
+      m = ENV['MODELS'] ; ms = m && m.split(',')
+      d = (ENV['DELETE'] ||'') =~ /yes|true/i
+      v = (ENV['VERBOSE']||'') =~ /yes|true/i
+      n = (ENV['DRYRUN'] ||'') =~ /yes|true/i
+      ActiveDump.config file: f2, models: ms, delete: d, verbose: v,
+        dryrun: n
+    end                                                         # }}}1
   end
 
 end

data/lib/active-dump/version.rb

@@ -1,4 +1,4 @@
 module ActiveDump
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
   DATE    = '2013-11-13'
 end

data/lib/active-dump.rb

@@ -22,38 +22,63 @@ module ActiveDump
   # --
 
   # dump to yaml
-  def self.dump(c)                                              # {{{1
-    data = Hash[ c['models'].map do |m|
-      model   = m.constantize
-      records = model.all.map(&:attributes)
+  def self.dump(cfg)                                            # {{{1
+    data = Hash[ cfg[:models].map do |m|
+      records = m.constantize.all.map(&:attributes)
+      printf "dumping model %-30s: %10d record(s)\n",
+        m, records.length if cfg[:verbose] or cfg[:dryrun]
       [m, records]
     end ]
-    File.write c['file'], YAML.dump(data)
+    File.write cfg[:file], YAML.dump(data) unless cfg[:dryrun]
   end                                                           # }}}1
 
-  # restore from yaml
-  def self.restore(c)                                           # {{{1
-    data = YAML.load File.read(c['file'])
+  # restore from yaml; optionally delete existing records first
+  def self.restore(cfg)                                         # {{{1
+    data = YAML.load File.read(cfg[:file])
     conn = connection
     ActiveRecord::Base.transaction do
       data.each do |m,records|
-        model = m.constantize
-        table = model.quoted_table_name
+        table = m.constantize.quoted_table_name
         records.each do |record|
           cols = record.keys.map { |k| conn.quote_column_name k }
           vals = record.values.map { |v| conn.quote v }
-          insert conn, table, cols, vals
+          delete_record conn, cfg, table, conn.quote(record['id']) \
+            if cfg[:delete]
+          insert_record conn, cfg, table, cols, vals
         end
       end
     end
   end                                                           # }}}1
 
+  # delete all records
+  def self.delete(cfg)                                          # {{{1
+    conn = connection
+    ActiveRecord::Base.transaction do
+      cfg[:models].each do |m|
+        sql = "DELETE FROM #{m.constantize.quoted_table_name};"
+        execute conn, cfg, sql
+      end
+    end
+  end                                                           # }}}1
+
   # --
 
+  # execute sql (optionally verbose)
+  def self.execute(conn, cfg, sql)
+    puts sql if cfg[:verbose] or cfg[:dryrun]
+    conn.execute sql unless cfg[:dryrun]
+  end
+
+  # delete record w/ id; make sure everything is quoted !!!
+  def self.delete_record(conn, cfg, table, id)
+    sql = "DELETE FROM #{table} WHERE id = #{id};"
+    execute conn, cfg, sql
+  end
+
   # insert data; make sure everything is quoted !!!
-  def self.insert(conn, table, cols, vals)
-    sql = "INSERT INTO #{table} (#{cols*','}) VALUES (#{vals*','})"
-    conn.execute sql
+  def self.insert_record(conn, cfg, table, cols, vals)
+    sql = "INSERT INTO #{table} (#{cols*','}) VALUES (#{vals*','});"
+    execute conn, cfg, sql
   end
 
   # --
@@ -68,16 +93,14 @@ module ActiveDump
     end .map(&:to_s)
   end                                                           # }}}1
 
-  # configuration: file + models
-  def self.config(file, models = nil)                           # {{{1
-    nb  = ->(x) { x && !x.blank? }
-    ne  = ->(x) { x && !x.empty? }
-    c   = File.exists?(CFG_DUMP) ? YAML.load(File.read(CFG_DUMP)) : {}
-    c['file']   = file        if nb[file]
-    c['models'] = models      if ne[models]
-    c['file']   = DUMP        unless nb[c['file']]
-    c['models'] = all_models  unless ne[c['models']]
-    c
+  # configuration
+  def self.config(cfg = {})                                     # {{{1
+    c1 = File.exists?(CFG_DUMP) ? YAML.load(File.read(CFG_DUMP)) : {}
+    c2 = Hash[ c1.map { |k,v| [k.to_sym, v] } ]
+    c3 = c2.merge cfg.reject { |k,v| v.nil? }
+    c4 = { file: DUMP } .merge c3.reject { |k,v| v.nil? }
+    c4[:models] && !c4[:models].empty? ? c4
+                                       : c4.merge(models: all_models)
   end                                                           # }}}1
 
   # ActiveRecord connection

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active-dump
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &11520100 !ruby/object:Gem::Requirement
+  requirement: &12593080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11520100
+  version_requirements: *12593080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &11519340 !ruby/object:Gem::Requirement
+  requirement: &12592200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *11519340
+  version_requirements: *12592200
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &11517020 !ruby/object:Gem::Requirement
+  requirement: &12589880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *11517020
+  version_requirements: *12589880
 description: ! 'dump and restore activerecord from/to yaml