sqlload 0.3.0beta

data/bin/sqlload

@@ -0,0 +1,109 @@
+#!/usr/bin/env ruby
+
+#   Copyright 2012 Ludovico Fischer
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+require 'sqlload'
+
+
+module Tasks
+  BASE_DIRECTORY = 'SQL'
+  def self.get_datasets()
+    datasets = []
+    Dir[File.join(BASE_DIRECTORY, '*')].each do |d|
+      if File.directory? d
+        datasets << DataSet.new(d)
+      end
+    end
+    datasets
+  end
+
+  def self.list_available_datasets()
+    self.get_datasets().each do |d|
+      puts File.basename(d.directory)
+    end
+  end
+
+  def self.load_dataset(dataset_name, user_options)
+    if dataset_name.nil? then abort 'You must specify a dataset to load' end
+    dataset = DataSet.new(File.join(BASE_DIRECTORY, dataset_name), user_options)
+    dataset.load
+  end
+
+  def self.delete_dataset(dataset_name, user_options)
+    if dataset_name.nil? then abort 'You must specify a dataset to reset' end
+    dataset = DataSet.new(File.join(BASE_DIRECTORY, dataset_name), user_options)
+    dataset.delete
+  end
+
+  def self.reset_dataset(dataset_name, user_options)
+    if dataset_name.nil? then abort 'You must specify a dataset to reset' end
+    dataset = DataSet.new(File.join(BASE_DIRECTORY, dataset_name), user_options)
+    dataset.reset
+  end
+end
+
+module User
+  def self.get_commandline_options(command_string)
+    require 'optparse'
+
+    options = {}
+
+    optparse = OptionParser.new do |opts|
+      opts.banner = 'Usage: sqlload [options] list|load|delete|reset [dataset]'
+
+      opts.version = '0.2.1'
+
+      opts.on('-U', '--user USERNAME', 'Specify username') do |user|
+        options[:user] = user
+      end
+
+      opts.on('-W', '--password PASSWORD', 'Specify password') do |password|
+        options[:password] = password
+      end
+
+      opts.on('-d', '--database DBNAME', 'Specify database name') do |dbname|
+        options[:dbname] = dbname
+      end
+
+      opts.on('-p', '--port PORT', 'Specify port') do |port|
+        options[:port] = port
+      end
+
+      opts.on_tail('-h', '--help', 'Displays this message') do
+        puts opts
+        exit
+      end
+    end
+
+    optparse.parse!(command_string)
+    options
+
+  end
+end
+
+user_options = User.get_commandline_options(ARGV)
+dataset_name = ARGV[1]
+
+case ARGV[0]
+when 'list'
+  Tasks.list_available_datasets
+when 'load'
+  Tasks.load_dataset(dataset_name, user_options)
+when 'delete'
+  Tasks.delete_dataset(dataset_name, user_options)
+when 'reset'
+  Tasks.reset_dataset(dataset_name, user_options)
+  
+else abort 'You must specify one of list, load, delete or reset.'
+end

data/lib/sqlload.rb

@@ -0,0 +1,127 @@
+#   Copyright 2012 Ludovico Fischer
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+require 'sqlload/database'
+require 'pty'
+require 'expect'
+
+## 
+# A collection of data that can be inserted together into a database
+class DataSet
+  include DBConfig, DB
+  attr_accessor :ups, :downs, :raws, :config, :directory
+
+  ##
+  # Creates a dataset using the SQL and the configuration contained
+  # in directory. The supplied user configuration overrides
+  # the configuration contained in the directory
+  def initialize(directory, user_config = {})
+    @ups = []
+    @downs = []
+    @raws = []
+    @directory = directory
+    populate() 
+    @config = load_config(directory).merge(user_config)
+    if insufficient(config)
+      raise ArgumentError, 'No database name'
+    end
+  end
+  
+  ##
+  # If there are reset scripts available,
+  # executes them before executing once again the regular scripts
+  def reset
+    if @downs.empty?
+      raise ArgumentError, 'There are no reset scripts to run'
+    end
+    delete
+    load
+  end
+  
+  ##
+  # Executes the SQL scripts associated with the dataset.
+  def load
+    get_db_connection(@config) do |db_connection|
+      @ups.each do |s|
+        result = db_connection.exec(s.statement)
+        puts "#{s.filename}: #{result.cmd_status}"
+      end
+    end
+    psql_count = 0
+    @raws.each do |s|
+      system({'PGPASSWORD' => @config[:password]}, "psql -h localhost -U #{@config[:user]} -d #{@config[:dbname]} < #{s.filename}")
+      psql_count += 1
+    end
+    puts "psql invoked #{psql_count} time(s)"
+  end
+   
+  ##
+  # Executes the SQL scripts marked as reset scripts
+  def delete
+    get_db_connection(@config) do |db_connection|
+      @downs.each do |s|
+        result = db_connection.exec(s.statement)
+        puts "#{s.filename}: #{result.cmd_status}"
+      end
+    end
+  end
+  
+  def to_s
+    File.basename(@directory)
+  end
+  
+  private
+  
+  DataPiece = Struct.new(:filename, :statement)
+  
+  # Fills the list of statements to execute from the information
+   # found by inspecting the directory contents
+  def populate()
+    require 'find'
+    Find.find(@directory) do |path|
+       if File.file?(path) && File.extname(path) == '.sql'
+         data = DataPiece.new(path, File.read(path))
+         if is_raws path
+           @raws << data
+         elsif is_downs path
+           @downs << data
+         elsif is_ups path
+           @ups << data
+         end
+       end
+    end
+    
+    @ups.sort! do |x, y|
+      File.basename(x.filename) <=> File.basename(y.filename)
+    end
+  end
+
+  # Returns true if the configuration does not contain enough information
+  # to connect to a database 
+  def insufficient(config)
+    config[:dbname].nil? 
+  end
+  
+  def is_ups(path)
+    File.extname(path) == '.sql' && File.basename(path) != 'reset.sql'
+  end
+  
+  def is_downs(path)
+    File.basename(path) == 'reset.sql'
+  end
+  
+  def is_raws(path)
+    File.fnmatch?('*psql*', path)
+  end
+end

data/lib/sqlload/database.rb

@@ -0,0 +1,52 @@
+#   Copyright 2012 Ludovico Fischer
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+
+module DB
+  require 'pg'
+  ##
+  # Yields a database connection configured with the supplied options.
+  # This method will attempt to close the connection once the block terminates.
+  def get_db_connection(options)
+    dbname = options[:dbname]
+    unless dbname
+      abort  "You must specify a database name"
+    end
+    user = options.fetch(:user, dbname)
+    password = options[:password]
+    port = options.fetch(:port, 5432)
+    begin
+      db_connection = PG.connect(:host => 'localhost', :port => port, :dbname => dbname, :user => user, :password => password)
+      yield db_connection
+    ensure
+      db_connection.finish unless db_connection.nil?
+    end
+  end
+end
+
+
+module DBConfig
+  ##
+  # Generates a configuration hash from a JSON file
+  #
+  # [path] the path to the dataset to load a config for 
+  def load_config(path)
+    require 'json'
+
+    config = JSON.parse(File.read(self.get_config_path(path)), :symbolize_names => true)
+  end
+
+  def get_config_path(dataset_path)
+    File.join(dataset_path, 'config.json')
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: sqlload
+version: !ruby/object:Gem::Version
+  version: 0.3.0beta
+  prerelease: 5
+platform: ruby
+authors:
+- Ludovico Fischer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: ! 'sqlload inspects a directory hierarchy: for each subdirectory, sqlload
+  offers to execute any SQL file, using the database specified in the JSON configuration.'
+email: ludovico.fischer@lunatech.com
+executables:
+- sqlload
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/sqlload.rb
+- lib/sqlload/database.rb
+- bin/sqlload
+homepage: https://github.com/ludovicofischer/sqlloader
+licenses:
+- Apache License, Version 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Load and execute SQL from a directory hierarchy. Only supports PostgreSQL
+test_files: []