flattendb 0.0.1.96 → 0.0.2.162

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to flattendb version 0.0.1
+This documentation refers to flattendb version 0.0.2
 
 
 == DESCRIPTION

data/Rakefile

@@ -1,23 +1,21 @@
-require 'lib/flattendb/version'
+begin
+  require 'hen'
+rescue LoadError
+  abort "Please install the 'hen' gem first."
+end
 
-FILES = FileList['lib/**/*.rb'].to_a
-EXECS = FileList['bin/*'].to_a
-RDOCS = %w[README COPYING ChangeLog]
-OTHER = FileList['[A-Z]*', 'example/*'].to_a
+require 'lib/flattendb/version'
 
-task(:doc_spec) {{
-  :title      => 'flattendb Application documentation',
-  :rdoc_files => RDOCS + FILES
-}}
+Hen.lay! {{
+  :rubyforge => {
+    :package => 'flattendb'
+  },
 
-task(:gem_spec) {{
-  :name             => 'flattendb',
-  :version          => FlattenDB::VERSION,
-  :summary          => 'Flatten relational databases',
-  :files            => FILES + EXECS + OTHER,
-  :require_path     => 'lib',
-  :bindir           => 'bin',
-  :executables      => EXECS,
-  :extra_rdoc_files => RDOCS,
-  :dependencies     => %w[highline mysql libxml-ruby builder]
+  :gem => {
+    :version      => FlattenDB::VERSION,
+    :summary      => 'Flatten relational databases.',
+    :files        => FileList['lib/**/*.rb', 'bin/*'].to_a,
+    :extra_files  => FileList['[A-Z]*', 'example/*'].to_a,
+    :dependencies => %w[highline libxml-ruby builder ruby-nuggets]
+  }
 }}

data/bin/flattendb

@@ -32,98 +32,160 @@ require 'optparse'
 
 require 'rubygems'
 require 'highline/import'
+require 'nuggets/array/flatten_once'
 
 $: << File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'flattendb'
+require 'flattendb/cli'
 
-USAGE = "Usage: #{$0} [-h|--help] [options] <infile> <outfile> <configfile>"
+include FlattenDB::CLI
 
-$options = {
-  :type => :mysql,
+USAGE = "Usage: #{$0} [-h|--help] [options]"
+abort USAGE if ARGV.empty?
+
+$global_options = {
+  :type    => :mysql,
+  :infiles => [],
+  :outfile => nil,
+  :confile => nil,
+  :keep    => false,
+  :mysql => {
+    :intype => :xml
+  },
+  :mdb => {
+    :intype => :mdb
+  }
+}
+
+$opts_by_type = {
   :mysql => {
-    :intype => :xml,
-    :keep   => false
+    :title => 'MySQL',
+    :opts  => lambda { |opts|
+      opts.on('-x', '--mysql-xml', "Input file is of type XML [This is the default]") {
+        $global_options[:mysql][:intype] = :xml
+      }
+      opts.on('-s', '--sql', "Input file is of type SQL") {
+        $global_options[:mysql][:intype] = :sql
+      }
+    }
+  },
+  :mdb => {
+    :title => 'MS Access',
+    :opts  => lambda { |opts|
+      opts.on('-m', '--mdb', "Input file is of type MDB [This is the default]") {
+        $global_options[:mdb][:intype] = :mdb
+      }
+      opts.on('-y', '--mdb-xml', "Input file is of type XML") {
+        $global_options[:mdb][:intype] = :xml
+      }
+    }
   }
 }
 
 def type_options(type, opts, with_heading = true)
-  heading = lambda { |name|
+  if type == :all
+    $opts_by_type.keys.sort_by { |t| t.to_s }.each { |t|
+      type_options(t, opts, with_heading)
+    }
+  else
+    opt = $opts_by_type[type.to_sym]
+
     if with_heading
       opts.separator ''
-      opts.separator "- #{name}"
+      opts.separator " - [#{type}] #{opt[:title]}"
     end
-  }
-
-  case type.to_sym
-    when :mysql
-      heading['MySQL']
 
-      opts.on('-x', '--xml', "Input file is of type XML [This is the default]") {
-        $options[:mysql][:intype] = :xml
-      }
-      opts.on('-s', '--sql', "Input file is of type SQL") {
-        $options[:mysql][:intype] = :sql
-      }
-      opts.on('-k', '--keep', "Keep intermediate XML dump; only applies if input type is 'sql'") {
-        $options[:mysql][:keep] = true
-      }
+    opt[:opts][opts]
   end
 end
 
 OptionParser.new { |opts|
   opts.banner = USAGE
-  opts.separator ''
 
+  opts.separator ''
   opts.separator 'Options:'
+
   if $type
     opts.separator "   [-t, --type]                      TYPE OVERRIDE IN EFFECT (#{$type})"
   else
-    opts.on('-t', '--type TYPE', "Type of database at hand [Default: #{$options[:type]}]") { |t|
-      $options[:type] = t.downcase.to_sym
+    opts.on('-t', '--type TYPE', "Type of database at hand [Default: #{$global_options[:type]}]") { |t|
+      $global_options[:type] = t.downcase.to_sym
     }
   end
 
+  opts.separator ''
+
+  opts.on('-i', '--input-files FILES...', "Input file(s); depending on the database type, multiple files may be given [REQUIRED]") { |f|
+    $global_options[:infiles] = f
+  }
+
+  opts.on('-o', '--output-file FILE', "Output file (flat XML) [REQUIRED]") { |f|
+    $global_options[:outfile] = f
+  }
+
+  opts.on('-c', '--config-file FILE', "Configuration file (YAML) [REQUIRED]") { |f|
+    $global_options[:confile] = f
+  }
+
+  opts.separator ''
+
+  opts.on('-k', '--keep', "Keep any intermediate files (generated XML dumps, etc.)") {
+    $global_options[:keep] = true
+  }
+
   opts.separator ''
   opts.separator 'Database-specific Options:'
 
   if $type
     type_options($type, opts, false)
   else
-    %w[mysql].each { |t|
-      type_options(t, opts)
-    }
+    type_options(:all, opts)
   end
 
   opts.separator ''
   opts.separator 'Generic options:'
+
   opts.on('-h', '--help', 'Print this help message and exit') {
     abort opts.to_s
   }
+
   opts.on('--version', 'Print program version and exit') {
     abort "#{File.basename($0)} v#{FlattenDB::VERSION}"
   }
 }.parse!
 
-$type  ||= $options[:type]
-$options = $options[$type] || {}
+$type  ||= $global_options[:type]
+$options = $global_options[$type] || {}
 
 # Load corresponding module
 begin
-  require "flattendb/#{$type}"
+  require "flattendb/types/#{$type}"
 rescue LoadError
   abort "Database type '#{$type}' is not supported at the moment."
 end
 
-abort USAGE unless ARGV.size == 3
+abort "No output file specified" unless $global_options[:outfile]
+abort "No configuration file specified" unless $global_options[:confile]
+abort "Configuration file not found: #{confile}" unless File.readable?(confile)
 
-$infile, $outfile, configfile = ARGV
+$global_options[:infiles].each { |infile|
+  abort "Input file not found: #{infile}" unless File.readable?(infile)
+}
 
-abort "Input file not found: #{$infile}" unless File.readable?($infile)
+$infiles = $global_options[:infiles]
+$outfile = $global_options[:outfile]
+$confile = $global_options[:confile]
 
 # Load type-specific script
-load File.join(File.dirname(__FILE__), "flattendb.#{$type}")
+begin
+  load File.join(File.dirname(__FILE__), "flattendb.#{$type}")
+rescue LoadError
+  # silently ignore
+end
 
-FlattenDB[$type].new($infile, $outfile, configfile).flatten!.to_xml
+FlattenDB[$type].new($infile || $infiles, $outfile, $confile).flatten!.to_xml
 
-File.delete($dump_file) if $dump_file && !$options[:keep]
+unless $global_options[:keep]
+  File.delete($dump_file) if $dump_file
+end

data/bin/flattendb.mdb

@@ -0,0 +1,54 @@
+#! /usr/bin/ruby
+
+# vi:ft=ruby
+
+#--
+###############################################################################
+#                                                                             #
+# flattendb -- Flatten relational databases                                   #
+#                                                                             #
+# Copyright (C) 2007 University of Cologne,                                   #
+#                    Albertus-Magnus-Platz,                                   #
+#                    50932 Cologne, Germany                                   #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# flattendb is free software; you can redistribute it and/or modify it under  #
+# the terms of the GNU General Public License as published by the Free        #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# flattendb is distributed in the hope that it will be useful, but WITHOUT    #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with flattendb. If not, see <http://www.gnu.org/licenses/>.                 #
+#                                                                             #
+###############################################################################
+#++
+
+if $0 == __FILE__
+  $type = :mdb
+  load File.join(File.dirname(__FILE__), 'flattendb')
+else
+  case $options[:intype]
+    when :xml
+      $infiles.each { |infile|
+        abort "Input file doesn't seem to be a valid XML file, XML declaration missing: #{infile}" \
+          unless IO.read(infile, 6) == '<?xml '
+      }
+    when :mdb
+      tables_cmd = 'mdb-tables'
+      export_cmd = 'mdb-export'
+
+      require_commands(tables_cmd, export_cmd, :pkg => 'mdbtools')
+      require_libraries('fastercsv')
+
+      $infiles.map! { |infile|
+        $dump_file
+      }
+  end
+end

data/bin/flattendb.mysql

@@ -34,25 +34,18 @@ if $0 == __FILE__
   $type = :mysql
   load File.join(File.dirname(__FILE__), 'flattendb')
 else
+  $infile = $infiles.first
+
   case $options[:intype]
     when :xml
       abort "Input file doesn't seem to be a valid XML file, XML declaration missing" \
         unless IO.read($infile, 6) == '<?xml '
     when :sql
-      require 'mysql'
-
       mysql_cmd = 'mysql'
       dump_cmd  = 'mysqldump'
 
-      [mysql_cmd, dump_cmd].each { |cmd|
-        catch :cmd_found do
-          ENV['PATH'].split(':').each { |path|
-            throw :cmd_found if File.executable?(File.join(path, cmd))
-          }
-
-          abort "Command not found: #{cmd}"
-        end
-      }
+      require_commands(mysql_cmd, dump_cmd, :pkg => 'a suitable MySQL client')
+      require_libraries('mysql')
 
       mysql_user = ask('Please enter the MySQL user name: ')              \
         { |q| q.default = ENV['USER'] }

data/lib/flattendb/base.rb

@@ -26,6 +26,8 @@
 ###############################################################################
 #++
 
+require 'yaml'
+
 require 'rubygems'
 require 'builder'
 
@@ -58,9 +60,47 @@ module FlattenDB
       protected
 
       def inherited(klass)
-        types[klass.name.split('::')[1..-1].downcase.to_sym] = klass
+        types[klass.name.split('::')[1..-1].join('/').downcase.to_sym] = klass
+      end
+
+    end
+
+    attr_reader :root, :config, :input, :output
+
+    def initialize(infiles, outfile, config)
+      config = case config
+        when Hash
+          config
+        when String
+          # assume file name
+          YAML.load_file(config)
+        else
+          raise ArgumentError, "invalid config argument of type '#{config.class}'"
       end
+      raise ArgumentError, "can't have more than one primary (root) table" if config.size > 1
+
+      (@root, @config), _ = *config  # get "first" (and only) hash element
+
+      @input = [*infiles].map { |infile|
+        case infile
+          when String
+            infile
+          when File
+            infile.path
+          else
+            raise ArgumentError, "invalid infile argument of type '#{infile.class}'"
+        end
+      }
 
+      @output = case outfile
+        when IO
+          outfile
+        when String
+          # assume file name
+          File.open(outfile, 'w')
+        else
+          raise ArgumentError, "invalid outfile argument of type '#{outfile.class}'"
+      end
     end
 
     def flatten!(*args)

data/lib/flattendb/cli.rb

@@ -0,0 +1,79 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of flattendb, the relational database flattener.                #
+#                                                                             #
+# Copyright (C) 2007 University of Cologne,                                   #
+#                    Albertus-Magnus-Platz,                                   #
+#                    50932 Cologne, Germany                                   #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# flattendb is free software; you can redistribute it and/or modify it under  #
+# the terms of the GNU General Public License as published by the Free        #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# flattendb is distributed in the hope that it will be useful, but WITHOUT    #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with flattendb. If not, see <http://www.gnu.org/licenses/>.                 #
+#                                                                             #
+###############################################################################
+#++
+
+module FlattenDB
+
+  module CLI
+
+    def require_libraries(*libraries)
+      parse_arguments(libraries, :gem).each { |lib, gem|
+        begin
+          require lib
+        rescue LoadError
+          abort_with_msg('Ruby library not found: %s', lib, 'Please install gem %s first', gem)
+        end
+      }
+    end
+
+    def require_commands(*commands)
+      parse_arguments(commands, :pkg).each { |cmd, pkg|
+        catch :cmd_found do
+          ENV['PATH'].split(':').each { |path|
+            throw :cmd_found if File.executable?(File.join(path, cmd))
+          }
+
+          abort_with_msg("Command not found: #{cmd}", "Please install #{pkg} first", pkg || cmd)
+        end
+      }
+    end
+
+    def abort_with_msg(msg1, arg1, msg2, arg2)
+      msg  = msg1 % arg1
+      msg += " (#{msg2})" % (arg2 || arg1)
+
+      abort msg
+    end
+
+    private
+
+    def parse_arguments(arguments, option)
+      options = arguments.last.is_a?(Hash) ? arguments.pop : {}
+      special = options.delete(option)
+
+      arguments.map { |arg|
+        [arg, special]
+      } + options.map { |args, spx|
+        [*args].map { |arg|
+          [arg, spx]
+        }
+      }.flatten_once
+    end
+
+  end
+
+end

data/lib/flattendb/types/mdb.rb

@@ -0,0 +1,53 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of flattendb, the relational database flattener.                #
+#                                                                             #
+# Copyright (C) 2007 University of Cologne,                                   #
+#                    Albertus-Magnus-Platz,                                   #
+#                    50932 Cologne, Germany                                   #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# flattendb is free software; you can redistribute it and/or modify it under  #
+# the terms of the GNU General Public License as published by the Free        #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# flattendb is distributed in the hope that it will be useful, but WITHOUT    #
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       #
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for    #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with flattendb. If not, see <http://www.gnu.org/licenses/>.                 #
+#                                                                             #
+###############################################################################
+#++
+
+require 'xml/libxml'
+
+require 'flattendb/base'
+
+module FlattenDB
+
+  class MDB < Base
+
+    JOIN_KEY = '@key'
+
+    def initialize(infiles, outfile, config)
+      super
+    end
+
+    def flatten!(options = {}, builder_options = {})
+      self
+    end
+
+    def to_xml(output = output, builder_options = {})
+      self
+    end
+
+  end
+
+end

data/lib/flattendb/{mysql.rb → types/mysql.rb}

@@ -26,7 +26,6 @@
 ###############################################################################
 #++
 
-require 'yaml'
 require 'xml/libxml'
 
 require 'flattendb/base'
@@ -37,41 +36,12 @@ module FlattenDB
 
     JOIN_KEY = '@key'
 
-    attr_reader :root, :config, :output, :document, :database, :name, :tables, :builder
+    attr_reader :document, :database, :name, :tables, :builder
 
     def initialize(infile, outfile, config)
-      config = case config
-        when Hash
-          config
-        when String
-          # assume file name
-          YAML.load_file(config)
-        else
-          raise ArgumentError, "invalid config argument of type '#{config.class}'"
-      end
-      raise ArgumentError, "can't have more than one primary (root) table" if config.size > 1
-
-      (@root, @config), _ = *config  # get "first" (and only) hash element
-
-      @output = case outfile
-        when IO
-          outfile
-        when String
-          # assume file name
-          File.open(outfile, 'w')
-        else
-          raise ArgumentError, "invalid outfile argument of type '#{outfile.class}'"
-      end
-
-      @document = XML::Document.file(case infile
-        when String
-          infile
-        when File
-          infile.path
-        else
-          raise ArgumentError, "invalid infile argument of type '#{infile.class}'"
-      end)
+      super
 
+      @document = XML::Document.file(@input.first)
       @database = @document.root.find_first('database[@name]')
       @name     = @database[:name]
       @tables   = {}

data/lib/flattendb/version.rb

@@ -32,7 +32,7 @@ module FlattenDB
 
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     class << self
 

metadata

@@ -1,97 +1,116 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.4
-specification_version: 1
 name: flattendb
 version: !ruby/object:Gem::Version 
-  version: 0.0.1.96
-date: 2007-10-11 00:00:00 +02:00
-summary: Flatten relational databases
-require_paths: 
-- lib
-email: jens.wille@uni-koeln.de
-homepage: 
-rubyforge_project: 
-description: 
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.0.2.162
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Jens Wille
-files: 
-- lib/flattendb.rb
-- lib/flattendb/version.rb
-- lib/flattendb/mysql.rb
-- lib/flattendb/base.rb
-- bin/flattendb
-- bin/flattendb.mysql
-- COPYING
-- README
-- ChangeLog
-- Rakefile
-- example/mysql-sample.sql
-- example/mysql-sample2flat.yaml
-- example/mysql-sample.flat.xml
-- example/mysql-sample.xml
-test_files: []
-
-rdoc_options: []
-
-extra_rdoc_files: 
-- README
-- COPYING
-- ChangeLog
-executables: 
-- flattendb
-- flattendb.mysql
-extensions: []
-
-requirements: []
+autorequire: 
+bindir: bin
+cert_chain: []
 
+date: 2008-01-08 00:00:00 +01:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: highline
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: mysql
+  name: libxml-ruby
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: libxml-ruby
+  name: builder
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: builder
+  name: ruby-nuggets
   version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.0
+        version: "0"
     version: 
+description: Flatten relational databases.
+email: jens.wille@uni-koeln.de
+executables: 
+- flattendb
+- flattendb.mysql
+- flattendb.mdb
+extensions: []
+
+extra_rdoc_files: 
+- README
+- COPYING
+- ChangeLog
+files: 
+- lib/flattendb/version.rb
+- lib/flattendb/base.rb
+- lib/flattendb/cli.rb
+- lib/flattendb/types/mysql.rb
+- lib/flattendb/types/mdb.rb
+- lib/flattendb.rb
+- bin/flattendb
+- bin/flattendb.mysql
+- bin/flattendb.mdb
+- COPYING
+- README
+- ChangeLog
+- Rakefile
+- example/mysql-sample.sql
+- example/mysql-sample2flat.yaml
+- example/mysql-sample.flat.xml
+- example/mysql-sample.xml
+has_rdoc: true
+homepage: http://prometheus.rubyforge.org/flattendb
+post_install_message: 
+rdoc_options: 
+- --all
+- --inline-source
+- --charset
+- UTF-8
+- --main
+- README
+- --title
+- flattendb Application documentation
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: prometheus
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Flatten relational databases.
+test_files: []
+