antfarm-core 0.5.0.beta1

data/lib/antfarm/framework.rb

@@ -0,0 +1,166 @@
+################################################################################
+#                                                                              #
+# Copyright (2008-2010) Sandia Corporation. Under the terms of Contract        #
+# DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains       #
+# certain rights in this software.                                             #
+#                                                                              #
+# 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, distribute with     #
+# modifications, 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  #
+# ABOVE 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.                                                                    #
+#                                                                              #
+# Except as contained in this notice, the name(s) of the above copyright       #
+# holders shall not be used in advertising or otherwise to promote the sale,   #
+# use or other dealings in this Software without prior written authorization.  #
+#                                                                              #
+################################################################################
+
+require 'antfarm/plugin'
+
+module Antfarm
+  class Framework
+    attr_reader :plugin
+
+    def version
+      return Antfarm.version
+    end
+
+    # If this method is called first, ALL plugins will be
+    # loaded and cached for the duration of process.
+    def plugins
+      return @plugins ||= Antfarm::Plugin.load
+    end
+
+    def clean_db
+      message = "Deleting #{ANTFARM_ENV} log file..."
+      Antfarm::Helpers.output message
+      Antfarm::Helpers.log :info, message
+
+      FileUtils.rm "#{Antfarm::Helpers.log_file(ANTFARM_ENV)}" if File.exists?(Antfarm::Helpers.log_file(ANTFARM_ENV))
+
+      message = "Deleted #{ANTFARM_ENV} log file successfully."
+      Antfarm::Helpers.output message
+      Antfarm::Helpers.log :info, message
+
+      config = YAML::load(IO.read(Antfarm::Helpers.defaults_file))
+
+      # TODO <scrapcoder>: can this stuff be done using the postgres gem instead?
+      if config && config[ANTFARM_ENV] && config[ANTFARM_ENV]['adapter'] == 'postgres'
+        message = "Dropping PostgreSQL #{ANTFARM_ENV} database..."
+        Antfarm::Helpers.output message
+        Antfarm::Helpers.log :info, message
+
+        exec "dropdb #{ANTFARM_ENV}"
+
+        message = "Dropped PostgreSQL #{ANTFARM_ENV} database successfully."
+        Antfarm::Helpers.output message
+        Antfarm::Helpers.log :info, message
+      else
+        message = "Dropping SQLite3 #{ANTFARM_ENV} database..."
+        Antfarm::Helpers.output message
+        Antfarm::Helpers.log :info, message
+
+        FileUtils.rm "#{Antfarm::Helpers.db_file(ANTFARM_ENV)}" if File.exists?(Antfarm::Helpers.db_file(ANTFARM_ENV))
+
+        message = "Dropped SQLite3 #{ANTFARM_ENV} database successfully."
+        Antfarm::Helpers.output message
+        Antfarm::Helpers.log :info, message
+      end
+    end
+
+    # Creates a new database and schema file.  The location of the newly created
+    # database file is set in the initializer class via the user
+    # configuration hash, and is based on the current ANTFARM environment.
+    def migrate_db
+      begin
+        message = 'Migrating database...'
+        Antfarm::Helpers.output message
+        Antfarm::Helpers.log :info, message
+
+        DataMapper.auto_upgrade!
+
+        message = 'Database successfully migrated.'
+        Antfarm::Helpers.output message
+        Antfarm::Helpers.log :info, message
+      rescue => e # TODO: better error catching - not EVERY error is PostreSQL...
+        message = "No PostgreSQL database exists for the #{ANTFARM_ENV} environment. Creating PostgreSQL database..."
+        Antfarm::Helpers.output message
+        Antfarm::Helpers.log :info, message
+
+        exec "createdb #{ANTFARM_ENV}"
+
+        message = 'PostgreSQL database for this environment created. Continuing on with migration.'
+        Antfarm::Helpers.output message
+        Antfarm::Helpers.log :info, message
+
+        DataMapper.auto_upgrade!
+
+        message = 'Database successfully migrated.'
+        Antfarm::Helpers.output message
+        Antfarm::Helpers.log :info, message
+      end
+    end
+
+    # Forces a destructive migration
+    def reset_db
+      clean_db
+      migrate_db
+    end
+
+    def use(plugin)
+      @plugin = load_plugin(plugin)
+    end
+
+    def back
+      @plugin_name = nil
+      @plugin      = nil
+    end
+
+    def run(options = Hash.new)
+      raise Antfarm::AntfarmError, 'No plugin loaded' unless @plugin
+
+      if @plugin.options.nil?
+        @plugin.run
+      else
+        @plugin.run(options)
+      end
+    end
+
+    def method_missing(method, *args)
+      raise Antfarm::AntfarmError, "Command '#{method}' not recognized"
+    end
+
+    #######
+    private
+    #######
+
+    def load_plugin(plugin)
+      raise Antfarm::AntfarmError, 'Must supply name of one plugin to use' if plugin.nil? or plugin.empty?
+
+      @plugins ||= Hash.new
+      return @plugins[plugin] if @plugins.has_key?(plugin)
+
+      # Load and save the plugin. An exception will be
+      # thrown if the plugin cannot be found or loaded.
+      @plugins[plugin] = Antfarm::Plugin.load(plugin)
+
+      # will not get here if plugin doesn't exist.
+      # Exception will have been thrown by now.
+      return @plugins[plugin]
+    end
+  end
+end

data/lib/antfarm/helpers.rb

@@ -0,0 +1,146 @@
+################################################################################
+#                                                                              #
+# Copyright (2008-2010) Sandia Corporation. Under the terms of Contract        #
+# DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains       #
+# certain rights in this software.                                             #
+#                                                                              #
+# 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, distribute with     #
+# modifications, 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  #
+# ABOVE 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.                                                                    #
+#                                                                              #
+# Except as contained in this notice, the name(s) of the above copyright       #
+# holders shall not be used in advertising or otherwise to promote the sale,   #
+# use or other dealings in this Software without prior written authorization.  #
+#                                                                              #
+################################################################################
+
+require 'fileutils'
+
+module Antfarm
+  module Helpers
+    # Symbolic marker points on the fuzzy logic certainty factor scale.
+    # Certainty Factors (CF)
+    CF_PROVEN_TRUE   =  1.0000
+    CF_LIKELY_TRUE   =  0.5000
+    CF_LACK_OF_PROOF =  0.0000
+    CF_LIKELY_FALSE  = -0.5000
+    CF_PROVEN_FALSE  = -1.0000
+
+    # Amount by which a value can differ and still be considered the same.
+    # Mainly used as a buffer against floating point round-off errors.
+    CF_VARIANCE      =  0.0001
+
+    @user_dir        = nil
+    @logger_callback = nil
+    class << self
+      attr_accessor :logger_callback
+      attr_accessor :outputter
+      attr_accessor :user_dir
+    end
+
+    def self.clamp(x, low = CF_PROVEN_FALSE, high = CF_PROVEN_TRUE)
+      if x < low
+        return low
+      elsif x > high
+        return high
+      else
+        return x
+      end
+    end
+
+    def self.simplify_interfaces
+      #TODO
+    end
+
+    def self.timestamp
+      return Time.now.utc.xmlschema
+    end
+
+    def self.output(message)
+      @outputter.puts(message) unless @outputter.nil?
+    end
+
+    def self.log(level, *msg)
+      @logger_callback.call(level, msg.join) if @logger_callback
+    end
+
+    def self.db_dir
+      return File.expand_path("#{self.user_dir}/db")
+    end
+
+    def self.db_file(environment)
+      return File.expand_path("#{self.user_dir}/db/#{environment}.db")
+    end
+
+    def self.log_dir
+      return File.expand_path("#{self.user_dir}/log")
+    end
+
+    def self.log_file(environment)
+      return File.expand_path("#{self.user_dir}/log/#{environment}.log")
+    end
+
+    def self.defaults_file
+      return File.expand_path("#{self.user_dir}/config/defaults.yml")
+    end
+
+    def self.history_file
+      return File.expand_path("#{self.user_dir}/history")
+    end
+
+    def self.user_plugins_dir
+      return File.expand_path("#{self.user_dir}/plugins")
+    end
+
+    #######
+    private
+    #######
+
+    USER_DIRECTORIES = ['config', 'db', 'log', 'plugins']
+
+    def self.user_dir
+      return @user_dir unless @user_dir.nil?
+      return self.create_user_directory
+    end
+
+    # Initializes a suitable directory structure for the user
+    def self.create_user_directory
+      USER_DIRECTORIES.each do |directory|
+        path = "#{ENV['HOME']}/.antfarm/#{directory}"
+        # Just to be safe... don't want to wipe out existing user data!
+        unless File.exists?(path)
+          FileUtils.makedirs(path)
+          Antfarm::Helpers.log :info, "User '#{directory}' directory created in #{ENV['HOME'] + '/.antfarm'}"
+        end
+      end
+
+      defaults_file = "#{ENV['HOME']}/.antfarm/config/defaults.yml"
+      # Just to be safe... don't want to wipe out existing user data!
+      unless File.exists?(defaults_file)
+        File.open(defaults_file, 'w') do |file|
+          file.puts '---'
+          file.puts 'environment: antfarm'
+          file.puts 'log_level: warn'
+        end
+        Antfarm::Helpers.log :info, "Default config file created at #{ENV['HOME'] + '/.antfarm/config/defaults.yml'}"
+      end
+
+      return @user_dir = (ENV['HOME'] + '/.antfarm').dup
+    end
+  end
+end

data/lib/antfarm/initializer.rb

@@ -0,0 +1,160 @@
+################################################################################
+#                                                                              #
+# Copyright (2008-2010) Sandia Corporation. Under the terms of Contract        #
+# DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains       #
+# certain rights in this software.                                             #
+#                                                                              #
+# 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, distribute with     #
+# modifications, 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  #
+# ABOVE 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.                                                                    #
+#                                                                              #
+# Except as contained in this notice, the name(s) of the above copyright       #
+# holders shall not be used in advertising or otherwise to promote the sale,   #
+# use or other dealings in this Software without prior written authorization.  #
+#                                                                              #
+################################################################################
+
+require 'yaml'
+
+require 'rubygems'
+require 'dm-core'
+
+module Antfarm
+  class Initializer
+    attr_reader :configuration
+
+    # Run the initializer, first making the configuration object available
+    # to the user, then creating a new initializer object, then running the
+    # given command.
+    def self.run(command = :process, configuration = Configuration.new)
+      yield configuration if block_given?
+      initializer = new configuration
+      initializer.send(command)
+    end
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def process
+      initialize_database
+      initialize_logger
+      load_requirements
+    end
+
+    def setup
+      # Set application load paths
+      load_paths = configuration.load_paths
+      load_paths.reverse_each { |path| $LOAD_PATH.unshift(path) if File.directory?(path) }
+      $LOAD_PATH.uniq!
+
+      # Load the Antfarm::Helpers module
+      load_helpers
+
+      # Load the general Antfarm error classes
+      load_errors
+
+      # Make sure an application directory exists for the current user
+      Antfarm::Helpers.create_user_directory
+    end
+
+    #######
+    private
+    #######
+
+    def load_helpers
+      require 'antfarm/helpers'
+    end
+
+    def load_errors
+      require 'antfarm/errors'
+    end
+
+    # Currently, SQLite3 and PostgreSQL databases are the only ones supported.
+    # The name of the ANTFARM environment (which defaults to 'antfarm') is the
+    # name used for the database file and the log file.
+    def initialize_database
+      config = YAML::load(IO.read(Antfarm::Helpers.defaults_file))
+      # Database setup based on adapter specified
+      if config && config[ANTFARM_ENV] && config[ANTFARM_ENV].has_key?('adapter')
+        if config[ANTFARM_ENV]['adapter'] == 'sqlite3'
+          config[ANTFARM_ENV]['database'] = Antfarm::Helpers.db_file(ANTFARM_ENV)
+        elsif config[ANTFARM_ENV]['adapter'] == 'postgres'
+          config[ANTFARM_ENV]['database'] = ANTFARM_ENV
+        else
+          # If adapter specified isn't one of sqlite3 or postgresql,
+          # default to SQLite3 database configuration.
+          config = nil
+        end
+      else
+        # If the current environment configuration doesn't specify a
+        # database adapter, default to SQLite3 database configuration.
+        config = nil
+      end
+      # Default to SQLite3 database configuration
+      config ||= { ANTFARM_ENV => { 'adapter' => 'sqlite3', 'database' => Antfarm::Helpers.db_file(ANTFARM_ENV) } }
+      if config[ANTFARM_ENV]['adapter'] == 'postgres'
+        DataMapper.setup(:default, "postgres:///#{config[ANTFARM_ENV]['database']}")
+      else
+        DataMapper.setup(:default, "sqlite3://#{config[ANTFARM_ENV]['database']}")
+      end
+    end
+
+    def initialize_logger
+      @logger = DataMapper::Logger.new(Antfarm::Helpers.log_file(ANTFARM_ENV), configuration.log_level)
+      Antfarm::Helpers.logger_callback = lambda do |severity,msg|
+        @logger.send(severity,msg)
+      end
+    end
+    
+    def load_requirements
+      # This will most likely already have been required by RubyGems, but let's
+      # keep it in here anyway just in case...
+      #
+      # Note that 'antfarm-core' calls for boot strapping the ANTFARM
+      # environment. However, that shouldn't lead to a circular dependency
+      # here since this 'load_requirements' method is called by the initializer
+      # 'process' method, not the boot strap's 'setup' method.
+      require 'antfarm-core'
+    end
+  end
+
+  class Configuration
+    attr_accessor :load_paths
+    attr_accessor :log_level
+    
+    def initialize
+      self.load_paths = default_load_paths
+      self.log_level  = default_log_level
+    end
+
+    #######
+    private
+    #######
+
+    def default_load_paths
+      paths  = Array.new
+      paths << File.expand_path(ANTFARM_ROOT + "/lib")
+      return paths
+    end
+
+    def default_log_level
+      return :warn
+    end
+  end
+end