active-dump 0.0.1

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -0,0 +1,107 @@
+[]: {{{1
+
+    File        : README.md
+    Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+    Date        : 2013-11-13
+
+    Copyright   : Copyright (C) 2013  Felix C. Stegerman
+    Version     : v0.0.1
+
+[]: }}}1
+
+[![Gem Version](https://badge.fury.io/rb/active-dump.png)](http://badge.fury.io/rb/active-dump)
+
+## Description
+[]: {{{1
+
+  active-dump - dump and restore activerecord from/to yaml
+
+  active-dump provides 2 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
+
+#
+
+  NB: active-dump does not take migrations (or validations etc.) into
+  account -- it dumps and restores raw data from the ActiveRecord
+  models -- so make sure your migrations are in sync.
+
+  When using rails, add this to your Gemfile:
+
+```ruby
+gem 'active-dump', require: 'active-dump/rails'
+```
+
+[]: {{{2
+
+  You can use these environment variables to configure active-dump:
+
+  * `RAILS_ENV`: the environment
+  * `FILE`: the file to dump to/restore from (defaults to
+    `db/data.yml`)
+  * `MODELS`: the models to dump (defaults to all models)
+
+#
+
+  Configuration files:
+
+  * `config/active-dump.yml`: the default file and models
+  * `config/database.yml`: database connection
+
+[]: }}}2
+
+[]: }}}1
+
+## Examples
+[]: {{{1
+
+    $ rake db:data:dump MODELS=Foo,Bar
+    $ RAILS_ENV=production rake db:data:load
+
+`config/active-dump.yml`:
+
+```yaml
+file: db/dump.yml
+models:
+  - Cms::Block
+  - Cms::Categorization
+  - Cms::Category
+  - Cms::File
+  - Cms::Layout
+  - Cms::Page
+  - Cms::Revision
+  - Cms::Site
+  - Cms::Snippet
+```
+
+[]: }}}1
+
+## Specs & Docs
+
+    $ rake spec   # TODO
+    $ rake docs
+
+## TODO
+
+  * specs/docs?
+  * use model's database connection?!
+  * ...
+
+## License
+
+  GPLv2 [1] or EPLv1 [2].
+
+## References
+[]: {{{1
+
+  [1] GNU General Public License, version 2
+  --- http://www.opensource.org/licenses/GPL-2.0
+
+  [2] Eclipse Public License, version 1
+  --- http://www.opensource.org/licenses/EPL-1.0
+
+[]: }}}1
+
+[]: ! ( vim: set tw=70 sw=2 sts=2 et fdm=marker : )

data/Rakefile

@@ -0,0 +1,59 @@
+desc 'Run specs'
+task :spec do
+  sh 'rspec -c'
+end
+
+desc 'Run specs verbosely'
+task 'spec:verbose' do
+  sh 'rspec -cfd'
+end
+
+desc 'Run specs verbosely, view w/ less'
+task 'spec:less' do
+  sh 'rspec -cfd --tty | less -R'
+end
+
+desc 'Check for warnings'
+task :warn do
+  reqs = %w{ config }.map { |x| "-r active-dump/#{x}" } * ' '
+  sh "ruby -w -I lib #{reqs} -e ''"
+end
+
+desc 'Check for warnings in specs'
+task 'warn:spec' do
+  reqs = Dir['spec/**/*.rb'].sort.map { |x| "-r ./#{x}" } * ' '
+  sh "ruby -w -I lib -r rspec #{reqs} -e ''"
+end
+
+desc 'Check for warnings in specs (but not void context)'
+task 'warn:spec:novoid' do
+  sh 'rake warn:spec 2>&1 | grep -v "void context"'
+end
+
+desc 'Generate docs'
+task :docs do
+  sh 'yardoc | cat'
+end
+
+desc 'List undocumented objects'
+task 'docs:undoc' do
+  sh 'yard stats --list-undoc'
+end
+
+desc 'Cleanup'
+task :clean do
+  sh 'rm -rf .yardoc/ doc/ *.gem'
+end
+
+desc 'Build SNAPSHOT gem'
+task :snapshot do
+  v = Time.new.strftime '%Y%m%d%H%M%S'
+  f = 'lib/active-dump/version.rb'
+  sh "sed -ri~ 's!(SNAPSHOT)!\\1.#{v}!' #{f}"
+  sh 'gem build active-dump.gemspec'
+end
+
+desc 'Undo SNAPSHOT gem'
+task 'snapshot:undo' do
+  sh 'git checkout -- lib/active-dump/version.rb'
+end

data/active-dump.gemspec

@@ -0,0 +1,32 @@
+require File.expand_path('../lib/active-dump/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'active-dump'
+  s.homepage    = 'https://github.com/obfusk/active-dump'
+  s.summary     = 'dump and restore activerecord from/to yaml'
+
+  s.description = <<-END.gsub(/^ {4}/, '')
+    dump and restore activerecord from/to yaml
+
+    ...
+  END
+
+  s.version     = ActiveDump::VERSION
+  s.date        = ActiveDump::DATE
+
+  s.authors     = [ 'Felix C. Stegerman' ]
+  s.email       = %w{ flx@obfusk.net }
+
+  s.licenses    = %w{ GPLv2 EPLv1 }
+
+  s.files       = %w{ .yardopts README.md Rakefile } \
+                + %w{ active-dump.gemspec } \
+                + Dir['{lib,spec}/**/*.rb']
+
+  s.add_runtime_dependency 'activerecord'
+  s.add_runtime_dependency 'rake'
+
+  s.add_development_dependency 'rspec'
+
+  s.required_ruby_version = '>= 1.9.1'
+end

data/lib/active-dump.rb

@@ -0,0 +1,110 @@
+# --                                                            ; {{{1
+#
+# File        : active-dump.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-11-13
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2 or EPLv1
+#
+# --                                                            ; }}}1
+
+require 'active_record'
+require 'yaml'
+
+# namespace
+module ActiveDump
+
+  CFG_DB    = 'config/database.yml'
+  CFG_DUMP  = 'config/active-dump.yml'
+  DUMP      = 'db/data.yml'
+
+  # --
+
+  # dump to yaml
+  def self.dump(c)                                              # {{{1
+    data = Hash[ c['models'].map do |m|
+      model   = m.constantize
+      records = model.all.map(&:attributes)
+      [m, records]
+    end ]
+    File.write c['file'], YAML.dump(data)
+  end                                                           # }}}1
+
+  # restore from yaml
+  def self.restore(c)                                           # {{{1
+    data = YAML.load File.read(c['file'])
+    conn = connection
+    ActiveRecord::Base.transaction do
+      data.each do |m,records|
+        model = m.constantize
+        table = model.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
+        end
+      end
+    end
+  end                                                           # }}}1
+
+  # --
+
+  # insert data; make sure everything is quoted !!!
+  def self.insert(conn, table, cols, vals)
+    sql = "INSERT INTO #{table} (#{cols*','}) VALUES (#{vals*','})"
+    conn.execute sql
+  end
+
+  # --
+
+  # get all existing models' names
+  def self.all_models                                           # {{{1
+    return @models if @models
+    eager_load!
+    @models = ActiveRecord::Base.descendants.select do |m|
+      (m.to_s != 'ActiveRecord::SchemaMigration') && \
+       m.table_exists? && m.exists?
+    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
+  end                                                           # }}}1
+
+  # ActiveRecord connection
+  # @todo use model?!
+  def self.connection                                           # {{{1
+    return @connection if @connection
+    unless ActiveRecord::Base.connected?
+      c = YAML.load File.read(CFG_DB)
+      ActiveRecord::Base.establish_connection c[env]
+    end
+    @connection = ActiveRecord::Base.connection
+  end                                                           # }}}1
+
+  # eager_load! all rails engines' models (if Rails is defined)
+  def self.eager_load!                                          # {{{1
+    return false if @eager_load
+    Rails::Engine::Railties.engines.each do |e|
+      e.eager_load!
+    end if defined? Rails
+    @eager_load = true
+  end                                                           # }}}1
+
+  # like Rails.env; (cached)
+  def self.env
+    @env ||= ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'development'
+  end
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/active-dump/rails.rb

@@ -0,0 +1,26 @@
+# --                                                            ; {{{1
+#
+# File        : active-dump/rails.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-11-13
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2 or EPLv1
+#
+# --                                                            ; }}}1
+
+require 'rails'
+
+require 'active-dump/rake'
+
+# namespace
+module ActiveDump
+
+  # railtie that adds the rake tasks
+  class Railtie < Rails::Railtie
+    rake_tasks { ActiveDump::Rake.define_tasks }
+  end
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/active-dump/rake.rb

@@ -0,0 +1,47 @@
+# --                                                            ; {{{1
+#
+# File        : active-dump/rake.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-11-13
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2 or EPLv1
+#
+# --                                                            ; }}}1
+
+require 'rake/dsl_definition'
+
+require 'active-dump'
+
+# namespace
+module ActiveDump
+
+  # rake tasks
+  module Rake
+    extend ::Rake::DSL
+
+    # define rake tasks
+    def self.define_tasks
+      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
+          end
+
+          desc 'Restore data'
+          task :restore => :environment do
+            c = ActiveDump.config ENV['FILE']
+            ActiveDump.restore c
+          end
+        end
+      end
+    end
+
+  end
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/active-dump/version.rb

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

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: active-dump
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Felix C. Stegerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &11520100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11520100
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &11519340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11519340
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &11517020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11517020
+description: ! 'dump and restore activerecord from/to yaml
+
+
+  ...
+
+'
+email:
+- flx@obfusk.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .yardopts
+- README.md
+- Rakefile
+- active-dump.gemspec
+- lib/active-dump/rake.rb
+- lib/active-dump/version.rb
+- lib/active-dump/rails.rb
+- lib/active-dump.rb
+homepage: https://github.com/obfusk/active-dump
+licenses:
+- GPLv2
+- EPLv1
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: dump and restore activerecord from/to yaml
+test_files: []
+has_rdoc: