databasion 0.0.1 → 0.0.2

data/README.md

@@ -4,7 +4,9 @@
 
 If we were all part of a hive mind, we wouldn't need management anything.  Databases would get built, the correct columns would get used, programmers would align their ORMs, and keeping it all together wouldn't be some kind of management nightmare.
 
-Fortunately we aren't a hive mind (and if we were I would be just as confused as I am any other day, our office's main language is Japanese).  Still, even though my coworkers can't read my mind, we've come up with a tool that allows top end planners to describe system data in a spreadsheet, programmers to fudge in the column types, sizes, and database relationships, and everyone to export it out into YAML and Ruby migration scripts which update your infrastructure.  Ideally the fully automated suite is used in your test environment so your planner can quickly test changes, and a step by step process used if you are updating production machines.
+Fortunately we aren't a hive mind*.  Still, even though my coworkers can't read my mind, we've come up with a tool that allows top end planners to describe system data in a spreadsheet, programmers to fudge in the column types, sizes, and database relationships, and everyone to export it out into YAML and Ruby migration scripts which update your infrastructure.  Ideally the fully automated suite is used in your test environment so your planner can quickly test changes, and a step by step process used if you are updating production machines.
+
+* If we were I would be just as confused as I am any other day, our office's main language is Japanese.  Although I've been studying it for 9 years...
 
 ## Requirements
 
@@ -96,16 +98,20 @@ Setup the project space.
 
 Edit _config/google.yml_.  Then run the scripts.
 
-    databasion --system google
+    databasion --google
     databasion --migrate
+    databasion --update
+    databasion --svn
     
-Or run them both in order.
+Or run them all in order.
 
-    databasion --system google --migrate
+    databasion --google --migrate --update --svn
     
 You can supply a different config path as well.
 
-    databasion -s google -m --config config/my.other.config.yml
+    databasion -g -m -u -s --config config/my.other.config.yml
+    
+Someone administrating a production database with this tool would definitely want to run each script sequentially by hand.
     
 ### YAML Configuration
 
@@ -114,13 +120,22 @@ You can supply a different config path as well.
 * _login_: A valid Google username and password.
 * _sheets_: A list of the keys gleaned from the Google Docs URL, and a human readable name.
 * _output_: Where to output the relevant data.
+* _svn_: SVN configuration data.
+
+## SVN
+
+If the currently created databasion project is committed to SVN, running the _--svn_ switch will auto-add and commit all the project files.  This is useful for maintaining version control of the system, especially if something goes wrong and you need to do a rollback.
 
 ## Roadmap
 
-__0.0.2__
+__0.0.3__
 
 * Add ability to read existing tables, and make relative alter table migration scripts.
 
+__0.0.2__
+
+* <del>Add SVN hooks.</del>
+
 __0.0.1__
 
 * <del>Write this documentation.</del>

data/Rakefile

@@ -8,7 +8,7 @@ Jeweler::Tasks.new do |gem|
   gem.email       = "mojobojo@gmail.com"
   gem.homepage    = "http://github.com/boj/databasion"
   gem.authors     = ["Brian Jones", "Istpika"]
-  gem.version     = "0.0.1"
+  gem.version     = "0.0.2"
 
   gem.add_dependency('activerecord', '>= 2.3.5')
   gem.add_dependency('activesupport', '>= 2.3.5')

data/config/example.google.yml

@@ -10,4 +10,8 @@ output:
   yaml_path: 'data'
   migrations:
     path: 'migrations'
-    models: 'models'
+    models: 'models'
+    
+svn:
+  bin: /usr/bin/svn
+  repo: svn://repo/path

data/databasion.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{databasion}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brian Jones", "Istpika"]
-  s.date = %q{2010-05-19}
+  s.date = %q{2010-05-20}
   s.default_executable = %q{databasion}
   s.email = %q{mojobojo@gmail.com}
   s.executables = ["databasion"]
@@ -29,15 +29,20 @@ Gem::Specification.new do |s|
      "features/databasion/migitize.feature",
      "features/databasion/step_definitions/googlize_steps.rb",
      "features/databasion/step_definitions/migitize_steps.rb",
+     "features/databasion/step_definitions/svnilize_steps.rb",
      "features/databasion/step_definitions/yamalize_steps.rb",
+     "features/databasion/svnilize.feature",
      "features/databasion/yamalize.feature",
      "features/step_definitions/databasion_steps.rb",
      "lib/databasion.rb",
      "lib/databasion/applcize.rb",
      "lib/databasion/csvilize.rb",
+     "lib/databasion/datacize.rb",
      "lib/databasion/excelize.rb",
      "lib/databasion/googlize.rb",
+     "lib/databasion/loadlize.rb",
      "lib/databasion/migitize.rb",
+     "lib/databasion/svnilize.rb",
      "lib/databasion/yamalize.rb",
      "lib/migration_helpers/MIT-LICENSE",
      "lib/migration_helpers/README.markdown",

data/features/databasion/step_definitions/svnilize_steps.rb

@@ -0,0 +1,14 @@
+require 'lib/databasion'
+
+Given /a databasion created file structure/ do
+  Databasion::Applcize.create_project({ :create => 'cucumber_test' })
+end
+
+When /the commit command is ran/ do
+  Databasion::Svnilize.commit('cucumber_test')
+end
+
+Then /the data should be stored in SVN/ do
+
+  FileUtils.rm_rf 'cucumber_test'
+end

data/features/databasion/svnilize.feature

@@ -0,0 +1,8 @@
+Feature: SVN Auto Commit
+  In order to save files in SVN
+  We need a system that runs the commands for us
+  
+  Scenario: A typical auto commit
+    Given a databasion created file structure
+    When the commit command is ran
+    Then the data should be stored in SVN

data/lib/databasion/applcize.rb

@@ -15,9 +15,10 @@ module Databasion
         EOS
         opt :create, "Create a base deploy directory", :type => String
         opt :config, "Path to YAML config.  Looks for config/google.yml by default", :type => String
-        opt :system, "google, excel, migrate, update", :type => String
+        opt :google, "Googlize data from Google Spreadsheets"
         opt :migrate, "Migrate after Googlizing or Excelizing"
         opt :update, "Load parsed YAML into migrated database"
+        opt :svn, "Auto commit the project files (assuming it has been committed to SVN)"
       end
       if opts[:config].nil? and opts[:create].nil?
         config = "config/google.yml"
@@ -28,7 +29,6 @@ module Databasion
           Trollop::die :config, "A YAML config must be specified"
         end
       end
-      Trollop::die :system, "System requires a parameter" if opts[:system].nil? and opts[:create].nil?
 
       if opts[:create]
         create_project(opts)
@@ -38,14 +38,17 @@ module Databasion
     end
     
     def self.execute_databasion(opts)
-      if opts[:system] and opts[:config]
-        Databasion.databate(opts[:system], opts[:config])
-        if opts[:migrate] and opts[:system] != 'migrate'
-          Databasion.databate('migrate', opts[:config])
-        end
-        if opts[:update] and opts[:system] != 'update'
-          Databasion.databate('update', opts[:config])
-        end
+      if opts[:google]
+        Databasion.databate('google', opts[:config])
+      end
+      if opts[:migrate]
+        Databasion.databate('migrate', opts[:config])
+      end
+      if opts[:update]
+        Databasion.databate('update', opts[:config])
+      end
+      if opts[:svn]
+        Databasion.databate('svn', opts[:config])
       end
     end
     

data/lib/databasion/datacize.rb

@@ -0,0 +1,30 @@
+module Databasion
+  
+  class Datacize
+    
+    @@config = nil
+    
+    def self.config=(config)
+      @@config = config
+    end
+    
+    def self.datacize
+      require 'migration_helpers/init'
+
+      files = Dir["%s/*.yml" % @@config['output']['yaml_path']]
+      Databasion::Migitize.migrabate(files, @@config)
+
+      Databasion.set_ar_logger
+      Databasion::LOGGER.info "Migrating..."
+
+      YAML.load_file('config/database.yml').each do |config|
+        ActiveRecord::Base.establish_connection(config[1])
+        path = @@config['output']['migrations']['path'] + "/" + config[0]
+        ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
+        ActiveRecord::Migrator.migrate(path, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+      end
+    end
+    
+  end
+  
+end

data/lib/databasion/loadlize.rb

@@ -0,0 +1,45 @@
+module Databasion
+  
+  class Loadlize
+    
+    @@config = nil
+    
+    def self.config=(config)
+      @@config = config
+    end
+    
+    def self.config
+      @@config
+    end
+   
+    def self.loadalize
+      Databasion.set_ar_logger
+      Databasion::LOGGER.info "Updating from YAML..."
+
+      models = Dir[@@config['output']['migrations']['models'] + "/*.rb"].each { |file| load file }
+
+      models.each do |model|
+        f = model.split('/')
+        plural_name = f[f.size-1].split(".")[0].pluralize
+        camel_name  = f[f.size-1].split(".")[0].camelize
+
+        Databasion::LOGGER.info "Loading %s into database..." % camel_name
+
+        yaml_file = YAML.load_file('%s/%s.yml' % [@@config['output']['yaml_path'], plural_name])
+
+        for row in yaml_file['data']
+          klass = eval("%s.new" % camel_name)
+          model = camel_name.constantize.find(:first, :conditions => ['id = ?', row['id']])
+          if model
+            camel_name.constantize.update(model.id, row)
+          else
+            klass.id = row['id']
+            klass.update_attributes(row)
+          end
+        end
+      end
+    end
+    
+  end
+  
+end

data/lib/databasion/svnilize.rb

@@ -0,0 +1,62 @@
+require 'fileutils'
+
+module Databasion
+  
+  class Svnilize
+    
+    @@config = nil
+    
+    class SvnilizeError < StandardError; end
+    
+    def self.config=(config)
+      @@config = config
+    end
+    
+    def self.config
+      @@config
+    end
+    
+    def self.svn_path
+      @@config['svn']['bin']
+    end
+    
+    def self.commit(path=Dir.pwd)
+      raise SvnilizeError, "A file lock is in place.  Cannot commit." if check_lock?
+      create_lock
+      svn_add_files(path)
+      begin
+        Databasion::LOGGER.info 'running: svn commit -m "svn auto commit"'
+        system svn_path + ' commit -m "svn auto commit"'
+        Databasion::LOGGER.info 'running: svn update'
+        system svn_path + ' update'
+      rescue
+        remove_lock
+        raise SvnilizeError, "This isn't a valid SVN project."
+      end
+      remove_lock
+    end
+    
+    def self.svn_add_files(path)
+      files = Dir[Dir.pwd + "/" + path + "/**/*"]
+      files.each do |file|
+        Databasion::LOGGER.info 'running: svn add %s' % file
+        system svn_path + ' add %s' % file
+      end
+    end
+    
+    def self.check_lock?
+      return true if File.exist?('svn.lock')
+      false
+    end
+    
+    def self.create_lock
+      File.new('svn.lock', 'w') unless check_lock?
+    end
+    
+    def self.remove_lock
+      FileUtils.rm 'svn.lock'
+    end
+    
+  end
+  
+end

data/lib/databasion.rb

@@ -26,9 +26,11 @@ module Databasion
     when "excel"
       excelize
     when "migrate"
-      migrate
+      datacize
     when "update"
-      load_yaml
+      loadalize
+    when "svn"
+      svnilize
     end
   end
   
@@ -41,51 +43,19 @@ module Databasion
     Databasion::Excelize.excelbate
   end
   
-  def self.migrate
-    require 'migration_helpers/init'
-    
-    files = Dir["%s/*.yml" % @@config['output']['yaml_path']]
-    Databasion::Migitize.migrabate(files, @@config)
-    
-    Databasion::LOGGER.info "Migrating..."
-    
-    set_ar_logger
-
-    YAML.load_file('config/database.yml').each do |config|
-      ActiveRecord::Base.establish_connection(config[1])
-      path = @@config['output']['migrations']['path'] + "/" + config[0]
-      ActiveRecord::Migration.verbose = ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
-      ActiveRecord::Migrator.migrate(path, ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
-    end
+  def datacize
+    Databasion::Datacize.config = @@config
+    Databasion::Datacize.loadalize
   end
   
-  def self.load_yaml
-    Databasion::LOGGER.info "Updating from YAML..."
-    
-    set_ar_logger
-    
-    models = Dir[@@config['output']['migrations']['models'] + "/*.rb"].each { |file| load file }
-    
-    models.each do |model|
-      f = model.split('/')
-      plural_name = f[f.size-1].split(".")[0].pluralize
-      camel_name  = f[f.size-1].split(".")[0].camelize
-      
-      Databasion::LOGGER.info "Loading %s into database..." % camel_name
-
-      yaml_file = YAML.load_file('%s/%s.yml' % [@@config['output']['yaml_path'], plural_name])
-      
-      for row in yaml_file['data']
-        klass = eval("%s.new" % camel_name)
-        model = camel_name.constantize.find(:first, :conditions => ['id = ?', row['id']])
-        if model
-          camel_name.constantize.update(model.id, row)
-        else
-          klass.id = row['id']
-          klass.update_attributes(row)
-        end
-      end
-    end
+  def loadalize
+    Databasion::Loadlize.config = @@config
+    Databasion::Loadlize.loadalize
+  end
+  
+  def self.svnilize
+    Databasion::Svnilize.config = @@config
+    Databasion::Svnilize.commit
   end
   
   private
@@ -99,5 +69,8 @@ module Databasion
   autoload :Excelize, APP_PATH + '/databasion/excelize.rb'
   autoload :Csvilize, APP_PATH + '/databasion/csvilize.rb'
   autoload :Migitize, APP_PATH + '/databasion/migitize.rb'
+  autoload :Loadlize, APP_PATH + '/databasion/loadlize.rb'
+  autoload :Datacize, APP_PATH + '/databasion/datacize.rb'
+  autoload :Svnilize, APP_PATH + '/databasion/svnilize.rb'
   
 end

data/lib/tasks/databasion.rake

@@ -10,4 +10,14 @@ namespace :databasion do
   task :migrate do
     Databasion.databate('migrate', 'config/google.yml')
   end
+  
+  desc "Run the update script to stuff YAML data into database"
+  task :update do
+    Databasion.databate('update', 'config/google.yml')
+  end
+  
+  desc "Run the SVN auto-commit system"
+  task :svn do
+    Databasion.databate('svn', 'config/google.yml')
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: databasion
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Brian Jones
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-19 00:00:00 +09:00
+date: 2010-05-20 00:00:00 +09:00
 default_executable: databasion
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -105,15 +105,20 @@ files:
 - features/databasion/migitize.feature
 - features/databasion/step_definitions/googlize_steps.rb
 - features/databasion/step_definitions/migitize_steps.rb
+- features/databasion/step_definitions/svnilize_steps.rb
 - features/databasion/step_definitions/yamalize_steps.rb
+- features/databasion/svnilize.feature
 - features/databasion/yamalize.feature
 - features/step_definitions/databasion_steps.rb
 - lib/databasion.rb
 - lib/databasion/applcize.rb
 - lib/databasion/csvilize.rb
+- lib/databasion/datacize.rb
 - lib/databasion/excelize.rb
 - lib/databasion/googlize.rb
+- lib/databasion/loadlize.rb
 - lib/databasion/migitize.rb
+- lib/databasion/svnilize.rb
 - lib/databasion/yamalize.rb
 - lib/migration_helpers/MIT-LICENSE
 - lib/migration_helpers/README.markdown