knjdbrevision 0.0.3

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "knjrbfw", ">= 0.0.3"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.3"
+  gem "rcov", ">= 0"
+  gem "sqlite3"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.6.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    knjrbfw (0.0.3)
+    rake (0.9.2)
+    rcov (0.9.9)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    sqlite3 (1.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.3)
+  knjrbfw (>= 0.0.3)
+  rcov
+  rspec (~> 2.3.0)
+  sqlite3

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kasper Johansen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1 @@
+This is an application for automatically managing database on multiple machines

data/README.rdoc

@@ -0,0 +1,19 @@
+= knjdbrevision
+
+Description goes here.
+
+== Contributing to knjdbrevision
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Kasper Johansen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "knjdbrevision"
+  gem.homepage = "http://github.com/kaspernj/knjdbrevision"
+  gem.license = "MIT"
+  gem.summary = %Q{A framework that can do database revision.}
+  gem.description = %Q{Can create/alter tables, columns, indexes and even table rows. Supports callbacks when certain events are triggered like an on_created.}
+  gem.email = "k@spernj.org"
+  gem.authors = ["Kasper Johansen"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "knjdbrevision #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/bin/run_with_schema.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "knjdbrevision"
+require "knj/autoload"
+Knj::Os.chdir_file(__FILE__)
+
+begin
+  options = {
+    :dbargs => {
+      :return_keys => "symbols"
+    }
+  }
+  
+  OptionParser.new do |opts|
+    opts.banner = "Usage: example.rb [options]"
+    
+    opts.on("-t DBTYPE", "--type DBTYPE", "This database type.") do |t|
+      options[:type] = t
+    end
+    
+    opts.on("-d DBKEY=DBVALUE", "--dbarg DBKEY=DKVALUE", "Sets another database config key and value.") do |val|
+      split_data = val.split("=")
+      options[:dbargs][split_data.first.to_sym] = split_data.last
+    end
+    
+    opts.on("-s FILEPATH", "A file with JSON content which contains the schema.") do |s|
+      options[:schema_file] = s
+      options[:schema] = JSON.parse(File.read(s))
+    end
+    
+    opts.on("-r FILEPATH", "A Ruby file which sets the global variable $tables which contains the schema.") do |val|
+      options[:rb_schema_file] = val
+      require val
+      options[:schema] = $tables
+    end
+  end.parse!
+rescue OptionParser::InvalidOption => e
+  print "#{e.message}\n"
+  exit
+end
+
+dbrev.init_db(
+  options[:schema],
+  Knjdbrevision.new
+)

data/knjdbrevision.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{knjdbrevision}
+  s.version = ""
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kasper Johansen"]
+  s.date = %q{2011-07-02}
+  s.default_executable = %q{run_with_schema.rb}
+  s.description = %q{Can create/alter tables, columns, indexes and even table rows. Supports callbacks when certain events are triggered like an on_created.}
+  s.email = %q{k@spernj.org}
+  s.executables = ["run_with_schema.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README",
+    "README.rdoc",
+    "Rakefile",
+    "bin/run_with_schema.rb",
+    "knjdbrevision.rb",
+    "lib/knjdbrevision.rb",
+    "spec/knjdbrevision_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/kaspernj/knjdbrevision}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{A framework that can do database revision.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.3"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.3"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.3"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+  end
+end
+

data/lib/knjdbrevision.rb

@@ -0,0 +1,215 @@
+class Knjdbrevision
+  def initialize(args = {})
+    @args = args
+  end
+  
+  def init_db(schema, db)
+    schema["tables"].each do |table_name, table_data|
+      begin
+        begin
+          table_obj = db.tables[table_name.to_sym]
+          
+          if table_data["columns"]
+            table_data["columns"].each do |col_data|
+              begin
+                col_obj = table_obj.column(col_data["name"])
+                col_str = "#{table_name}.#{col_obj.name}"
+                type = col_data["type"].to_s
+                
+                #BUGFIX: When using SQLite3 the primary-column or a autoincr-column may never change type from int... This will break it!
+                if db.opts[:type] == "sqlite3" and col_obj.type.to_s == "int" and (col_data["primarykey"] or col_data["autoincr"]) and db.int_types.index(col_data["type"].to_s)
+                  type = "int"
+                end
+                
+                dochange = false
+                
+                if type and col_obj.type.to_s != type
+                  print "Type mismatch on #{col_str}: #{col_data["type"]}, #{col_obj.type}\n"
+                  dochange = true
+                end
+                
+                if col_data.has_key?("maxlength") and col_obj.maxlength.to_s != col_data["maxlength"].to_s
+                  print "Maxlength mismatch on #{col_str}: #{col_data["maxlength"]}, #{col_obj.maxlength}\n"
+                  dochange = true
+                end
+                
+                if col_data.has_key?("null") and col_obj.null?.to_s != col_data["null"].to_s
+                  print "Null mismatch on #{col_str}: #{col_data["null"]}, #{col_obj.null?}\n"
+                  dochange = true
+                end
+                
+                if col_data.has_key?("default") and col_obj.default.to_s != col_data["default"].to_s
+                  print "Default mismatch on #{col_str}: #{col_data["default"]}, #{col_obj.default}\n"
+                  dochange = true
+                end
+                
+                if col_data.has_key?("comment") and col_obj.comment.to_s != col_data["comment"].to_s
+                  print "Comment mismatch on #{col_str}: #{col_data["comment"]}, #{col_obj.comment}\n"
+                  dochange = true
+                end
+                
+                if col_data.is_a?(Hash) and col_data["on_before_alter"]
+                  callback_data = col_data["on_before_alter"].call("db" => db, "table" => table_obj, "col" => col_obj, "col_data" => col_data)
+                  if callback_data and callback_data["action"]
+                    if callback_data["action"] == "retry"
+                      raise Knj::Errors::Retry
+                    end
+                  end
+                end
+                
+                col_obj.change(col_data) if dochange
+              rescue Knj::Errors::NotFound => e
+                print "Column not found: #{table_obj.name}.#{col_data["name"]}.\n"
+                
+                if col_data.has_key?("renames")
+                  rename_found = false
+                  col_data["renames"].each do |col_name|
+                    begin
+                      col_rename = table_obj.column(col_name)
+                    rescue Knj::Errors::NotFound => e
+                      next
+                    end
+                    
+                    print "Rename #{table_obj.name}.#{col_name} to #{table_obj.name}.#{col_data["name"]}\n"
+                    if col_data.is_a?(Hash) and col_data["on_before_rename"]
+                      col_data["on_before_rename"].call("db" => db, "table" => table_obj, "col" => col_rename, "col_data" => col_data)
+                    end
+                    
+                    col_rename.change(col_data)
+                    
+                    if col_data.is_a?(Hash) and col_data["on_after_rename"]
+                      col_data["on_after_rename"].call("db" => db, "table" => table_obj, "col" => col_rename, "col_data" => col_data)
+                    end
+                    
+                    rename_found = true
+                    break
+                  end
+                  
+                  retry if rename_found
+                end
+                
+                #Try to find out the previous column - if so we can set "after" which makes the column being created in the right order as defined.
+                if !col_data.has_key?("after")
+                  prev_no = table_data["columns"].index(col_data)
+                  if prev_no != nil and prev_no != 0
+                    prev_no = prev_no - 1
+                    prev_col_data = table_data["columns"][prev_no]
+                    col_data["after"] = prev_col_data["name"]
+                  end
+                end
+                
+                oncreated = col_data["on_created"]
+                col_data.delete("on_created") if col_data["oncreated"]
+                col_obj = table_obj.create_columns([col_data])
+                oncreated.call("db" => db, "table" => table_obj) if oncreated
+              end
+            end
+          end
+          
+          if table_data["columns_remove"]
+            table_data["columns_remove"].each do |column_name, column_data|
+              begin
+                col_obj = table_obj.column(column_name)
+              rescue Knj::Errors::NotFound => e
+                next
+              end
+              
+              column_data["callback"].call if column_data.is_a?(Hash) and column_data["callback"]
+              col_obj.drop
+            end
+          end
+          
+          if table_data["indexes"]
+            table_data["indexes"].each do |index_data|
+              begin
+                index_obj = table_obj.index(index_data["name"])
+              rescue Knj::Errors::NotFound => e
+                table_obj.create_indexes([index_data])
+              end
+            end
+          end
+          
+          if table_data["indexes_remove"]
+            table_data["indexes_remove"].each do |index_name, index_data|
+              begin
+                index_obj = table_obj.index(index_name)
+              rescue Knj::Errors::NotFound => e
+                next
+              end
+              
+              if index_data.is_a?(Hash) and index_data["callback"]
+                index_data["callback"].call if index_data["callback"]
+              end
+              
+              index_obj.drop
+            end
+          end
+          
+          if table_data["rows"]
+            table_data["rows"].each do |row_data|
+              if row_data["find_by"]
+                find_by = row_data["find_by"]
+              elsif row_data["data"]
+                find_by = row_data["data"]
+              else
+                raise "Could not figure out the find-by."
+              end
+              
+              rows_found = 0
+              q_rows = db.select(table_name, find_by)
+              while d_rows = q_rows.fetch
+                rows_found += 1
+                
+                if Knj::ArrayExt.hash_diff?(Knj::ArrayExt.hash_sym(row_data["data"]), Knj::ArrayExt.hash_sym(d_rows), {"h2_to_h1" => false})
+                  print "Data was not right - updating row: #{JSON.generate(row_data["data"])}\n"
+                  db.update(table_name, row_data["data"], d_rows)
+                end
+              end
+              
+              if rows_found == 0
+                print "Inserting row: #{JSON.generate(row_data["data"])}\n"
+                db.insert(table_name, row_data["data"])
+              end
+            end
+          end
+        rescue Knj::Errors::NotFound => e
+          if table_data["renames"]
+            table_data["renames"].each do |table_name_rename|
+              begin
+                table_rename = db.tables[table_name_rename]
+                table_rename.rename(table_name)
+                raise Knj::Errors::Retry
+              rescue Knj::Errors::NotFound
+                next
+              end
+            end
+          end
+          
+          if table_data["on_create"]
+            table_data["on_create"].call("db" => db, "table_name" => table_name, "table_data" => table_data)
+          end
+          
+          table_obj = db.tables.create(table_name, table_data)
+          
+          if table_data["on_create_after"]
+            table_data["on_create_after"].call("db" => db, "table_name" => table_name, "table_data" => table_data)
+          end
+        end
+      rescue Knj::Errors::Retry
+        retry
+      end
+    end
+    
+    if schema["tables_remove"]
+      schema["tables_remove"].each do |table_name, table_data|
+        begin
+          table_obj = db.tables[table_name.to_sym]
+          table_data["callback"].call if table_data.is_a?(Hash) and table_data["callback"]
+          table_obj.drop
+        rescue Knj::Errors::NotFound => e
+          next
+        end
+      end
+    end
+  end
+end

data/spec/knjdbrevision_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Knjdbrevision" do
+  it "should create a SQLite3 database with a table who is a bigint with primarykey and autoincr. It should then convert it to a normal integer and not try to change it afterwards." do
+    require "knjdbrevision"
+    require "knjrbfw"
+    require "knj/autoload"
+    require "tmpdir"
+    
+    db_path = "#{Dir.tmpdir}/knjdbrevision_test.sqlite3"
+    
+    begin
+      db = Knj::Db.new(
+        :type => "sqlite3",
+        :return_keys => "symbols",
+        :index_append_table_name => true,
+        :path => db_path
+      )
+      
+      schema = {
+        "tables" => {
+          "test_table" => {
+            "columns" => [
+              {"name" => "id", "type" => "bigint", "autoincr" => true, "primarykey" => true},
+              {"name" => "name", "type" => "varchar"}
+            ]
+          }
+        }
+      }
+      
+      dbrev = Knjdbrevision.new
+      dbrev.init_db(schema, db)
+      dbrev.init_db(schema, db)
+      
+      db.close
+      db = Knj::Db.new(
+        :type => "sqlite3",
+        :return_keys => "symbols",
+        :index_append_table_name => true,
+        :path => db_path
+      )
+      
+      #Test autoincr is still working (if primarykey 'id' was converted to a bigint then it will not... knjdbrevision should not convert the primarykey to bigint on SQLite3... Specific bugfix..
+      if db.tables["test_table"].column("id").type != "int"
+        raise "The primary ID was not of the 'int'-type."
+      end
+      
+      db.insert("test_table", {"name" => "Kasper"})
+      db.q("SELECT * FROM test_table") do |d|
+        if d[:id].to_i != 1
+          Knj::Php.print_r(d)
+          raise "The ID was not 1 on the inserted row: '#{d[:id]}'."
+        end
+      end
+    ensure
+      File.unlink(db_path) if File.exists?(db_path)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'knjdbrevision'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: knjdbrevision
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+  prerelease: 
+platform: ruby
+authors:
+- Kasper Johansen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-07-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: knjrbfw
+  requirement: &21972080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: *21972080
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &21948600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *21948600
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &21946720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *21946720
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &21945280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.3
+  type: :development
+  prerelease: false
+  version_requirements: *21945280
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &21942920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21942920
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &21919620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *21919620
+description: Can create/alter tables, columns, indexes and even table rows. Supports
+  callbacks when certain events are triggered like an on_created.
+email: k@spernj.org
+executables:
+- run_with_schema.rb
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README
+- README.rdoc
+files:
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/run_with_schema.rb
+- knjdbrevision.gemspec
+- lib/knjdbrevision.rb
+- spec/knjdbrevision_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/kaspernj/knjdbrevision
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3882259143430684128
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A framework that can do database revision.
+test_files: []