imw 0.2.18 → 0.3.0

data/lib/imw/utils/has_uri.rb

@@ -1,131 +0,0 @@
-require 'addressable/uri'
-
-module IMW
-  module Utils
-
-    # Endows an including class with a wrapper for Addressable::URI
-    module HasURI
-
-      # The URI of this object.
-      attr_reader :uri
-
-      # Set the URI of this resource by parsing the given +uri+ (if
-      # necessary).
-      #
-      # @param [String, Addressable::URI] uri the uri to parse
-      def uri= uri
-        if uri.is_a?(Addressable::URI)
-          @uri = uri
-        else
-          begin
-            @uri = Addressable::URI.parse(uri.to_s)
-          rescue URI::InvalidURIError
-            @uri = Addressable::URI.parse(URI.encode(uri.to_s))
-            @encoded_uri = true
-          end
-        end
-      end
-
-      # The scheme of this resource.  Will be +nil+ for local resources.
-      #
-      # @return [String]
-      def scheme
-        @scheme ||= uri.scheme
-      end
-
-      # The directory name of this resource's path.
-      #
-      # @return [String]
-      def dirname
-        @dirname  ||= File.dirname(path)
-      end
-
-      # The basename of this resource's path.
-      #
-      # @return [String]
-      def basename
-        @basename ||= File.basename(path)
-      end
-
-      # Returns the extension (INCLUDING the '.') of this resource's
-      # path.  Redefine this in an including class for which this is
-      # weird ('.tar.gz' I'm talking to you...)
-      #
-      # @return [String]
-      def extname
-        @extname ||= File.extname(path)
-      end
-
-      # Returns the extension (WITHOUT the '.') of this resource's path.
-      #
-      # @return [String]
-      def extension
-        @extension ||= extname[1..-1] || ''
-      end
-
-      # Returns the basename of the file with its extension removed
-      #
-      #   IMW.open('/path/to/some_file.tar.gz').name # => some_file
-      #
-      # @return [String]
-      def name
-        @name ||= extname ? basename[0,basename.length - extname.length] : basename
-      end
-
-      # Returns the user associated with the host of this URI.
-      #
-      # @return [String]
-      def user
-        @user ||= uri.user
-      end
-
-      # Returns the password associated with access to this URI.
-      #
-      # @return [String]
-      def password
-        @password ||= uri.password
-      end
-      
-      # Return the fragment part of this resource's URI.
-      #
-      # Will likely be +nil+ for local resources.
-      #
-      # @return [String]
-      def fragment
-        @fragment ||= uri.fragment
-      end
-
-      # Return the URI of this resource with any query strings and
-      # fragments removed.
-      #
-      # @return [URI::Generic]
-      def stripped_uri
-        uri_args = {}.tap do |args|
-          %w[scheme userinfo host port path].each do |method|
-            args[method.to_sym] = respond_to?(method) ? send(method) : uri.send(method)
-          end
-        end
-        uri.class.new(uri_args)
-      end
-
-      # Return the path complete with query string and fragment.
-      #
-      # @return [String]
-      def raw_path
-        p = uri.path
-        p += "?#{uri.query}"    unless uri.query.nil?
-        p += "##{uri.fragment}" unless uri.fragment.nil?
-        p
-      end
-
-      def to_s
-        uri.to_s
-      end
-    end
-  end
-end
-  
-
-  
-  
-

data/lib/imw/utils/log.rb

@@ -1,92 +0,0 @@
-require 'logger'
-
-module IMW
-
-  # Default log file.
-  LOG_FILE_DESTINATION = STDERR             unless defined?(LOG_FILE_DESTINATION)
-
-  # Default log file time format
-  LOG_TIMEFORMAT       = "%Y-%m-%d %H:%M:%S " unless defined?(LOG_TIMEFORMAT)
-
-  # Default verbosity
-  VERBOSE = false unless defined?(VERBOSE)
-
-  class << self; attr_accessor :log, :verbose end
-
-  # Is IMW operating in verbose mode?
-  #
-  # Calls to <tt>IMW.warn_if_verbose</tt> and friends utilize this
-  # method.  Verbosity is controlled on the command line (see
-  # IMW::Runner) or by setting IMW::VERBOSE in your configuration
-  # file.
-  #
-  # @return [nil, false, true]
-  def self.verbose?
-    VERBOSE || verbose
-  end
-  
-  # Create a Logger and point it at IMW::LOG_FILE_DESTINATION which is
-  # set in ~/.imwrc and defaults to STDERR.
-  def self.instantiate_logger!
-    IMW.log ||= Logger.new(LOG_FILE_DESTINATION)
-    IMW.log.datetime_format = "%Y%m%d-%H:%M:%S "
-    IMW.log.level           = Logger::INFO
-  end
-
-  def self.announce *events
-    options = events.flatten.extract_options!
-    options.reverse_merge! :level => Logger::INFO
-    IMW.log.add options[:level], "IMW: " + events.join("\n")
-  end
-  def self.announce_if_verbose *events
-    announce(*events) if IMW.verbose?
-  end
-  
-  def self.banner *events
-    options = events.flatten.extract_options!
-    options.reverse_merge! :level => Logger::INFO
-    announce(["*"*75, events, "*"*75], options)
-  end
-
-  def self.warn *events
-    options = events.flatten.extract_options!
-    options.reverse_merge! :level => Logger::WARN
-    announce events, options
-  end
-  def self.warn_if_verbose *events
-    warn(*events) if IMW.verbose?
-  end
-
-  PROGRESS_TRACKERS = {}
-  #
-  # When the slowly-changing tracked variable +var+ changes value,
-  # announce its new value.  Always announces on first call.
-  #
-  # Ex:
-  #   track_progress :indexing_names, name[0..0] # announce at each initial letter
-  #   track_progress :files, (i % 1000)          # announce at each 1,000 iterations
-  #
-  def track_progress tracker, val
-    unless (IMW::PROGRESS_TRACKERS.include?(tracker)) &&
-           (IMW::PROGRESS_TRACKERS[tracker] == val)
-      announce "#{tracker.to_s.gsub(/_/,' ')}: #{val}"
-      IMW::PROGRESS_TRACKERS[tracker] = val
-    end
-  end
-
-  PROGRESS_COUNTERS = {}
-  #
-  # Log repetitions in a given context
-  #
-  # At every n'th (default 1000) call,
-  # announce progress in the IMW.log
-  #
-  def track_count tracker, every=1000
-    PROGRESS_COUNTERS[tracker] ||= 0
-    PROGRESS_COUNTERS[tracker]  += 1
-    chunk = every * (PROGRESS_COUNTERS[tracker]/every).to_i
-    track_progress "count_of_#{tracker}", chunk
-  end
-end
-
-IMW.instantiate_logger!

data/lib/imw/utils/misc.rb

@@ -1,57 +0,0 @@
-module IMW
-
-  # A simple counter.  The +value+ and +add+ methods read and
-  # increment the counter's value.
-  #
-  #   counter = IMW::Counter.new
-  #   counter.value  #=> 0
-  #   counter.add 1
-  #   counter.value  #=> 1
-  #
-  # The +next!+ method acts as like C's <tt>value++</tt>, incrementing
-  # +value+ _after_ it is referenced.
-  #
-  #   counter = IMW::Counter.new
-  #   counter.value  #=> 0
-  #   counter.next!  #=> 0
-  #   counter.value  #=> 1
-  #
-  # Counters can also be reset
-  # 
-  #   counter.reset!
-  #   counter.value  #=> 0
-  class Counter
-
-    attr_accessor :value, :starting_value, :increment
-
-    # Return a new Counter.  The first argument is the starting value
-    # (defaults to 0) and the second is the increment (defaults to 1).
-    def initialize starting_value=0,increment=1
-      @starting_value = starting_value
-      @value          = starting_value
-      @increment      = increment
-    end
-
-    # Add +amount+ (defaults to the value of <tt>@increment</tt>).
-    def add amount=nil
-      @value += amount || @increment
-    end
-    alias_method :add!, :add
-
-    # Increment the counter by <tt>@increment</tt> but return its
-    # value _before_ being incremented.
-    def next!
-      old_value = @value      
-      @value += @increment
-      old_value
-    end
-
-    # Reset the counter to +value+ (defaults to the value of
-    # <tt>@starting_value</tt>).
-    def reset! value=nil
-      @value = value || @starting_value
-    end
-  end
-end
-
-# puts "#{File.basename(__FILE__)}: Your Monkeywrench seems suddenly more utilisable." # at bottom

data/lib/imw/utils/paths.rb

@@ -1,146 +0,0 @@
-require 'pathname'
-
-module IMW
-
-  # Implements methods designed to work with an object's
-  # <tt>@paths</tt> attributes, adding and deleting symbolic
-  # references to paths and expanding calls to +path_to+ from that
-  # attribute or (when a miss) from <tt>IMW::PATHS</tt>.
-  #
-  # An including class should therefore define an array attribute
-  # <tt>@paths</tt>.
-  module Paths
-
-    # Expands a shorthand workflow path specification to an actual
-    # file path.  Strings are interpreted literally but symbols are
-    # first resolved to the paths they represent.
-    #
-    #   add_path :foo, '~/whoa'
-    #   path_to :foo, 'my_thing'
-    #   => '~/whoa/my_thing'
-    #
-    # @param [String, Symbol] pathsegs the path segments to join
-    # @return [String] the resulting expanded path
-    def path_to *pathsegs
-      path = Pathname.new path_to_helper(*pathsegs)
-      path.absolute? ? File.expand_path(path) : path.to_s
-    end
-
-    # Return the presently defined paths for this object.
-    #
-    # @return [Hash]
-    def paths
-      @paths ||= {}
-    end
-
-    # Adds a symbolic path for expansion by +path_to+.
-    # 
-    #   add_path :foo, '~/whoa'
-    #   add_path :bar, :foo,   'baz'
-    #   path_to :bar
-    #   => '~/whoa/baz'
-    #
-    # @param [Symbol] sym the name of the path to store
-    # @param [Symbol, String] pathsegs the path segments to use to define the path to the name
-    # @return [String] the resulting path
-    def add_path sym, *pathsegs
-      paths[sym] = pathsegs.flatten
-      path_to(sym)
-    end
-
-    # Removes a symbolic path for expansion by +path_to+.
-    #
-    # @param [Symbol] sym the stored path symbol to remove
-    def remove_path sym
-      paths.delete sym if paths.include? sym
-    end
-
-    private
-    def path_to_helper *pathsegs # :nodoc:
-      # +path_to_helper+ handles the recursive calls for +path_to+.
-      expanded = pathsegs.flatten.compact.map do |pathseg|
-        case
-        when pathseg.is_a?(Symbol) && paths.include?(pathseg)      then path_to(paths[pathseg])
-        when pathseg.is_a?(Symbol) && IMW::PATHS.include?(pathseg) then path_to(IMW::PATHS[pathseg])          
-        when pathseg.is_a?(Symbol)                                 then raise IMW::PathError.new("No path expansion set for #{pathseg.inspect}")
-        else pathseg
-        end
-      end
-      File.join(*expanded)
-    end
-  end
-
-
-  # Default paths for the IMW.  Chosen to make sense on most *NIX
-  # distributions.
-  DEFAULT_PATHS = {
-    :home         => ENV['HOME'],
-    :data_root    => "/var/lib/imw",
-    :log_root     => "/var/log/imw",
-    :scripts_root => "/usr/share/imw",
-    :tmp_root     => "/tmp/imw",
-
-    # the imw library
-    :imw_root  => File.expand_path(File.dirname(__FILE__) + "/../../.."),
-    :imw_bin   => [:imw_root, 'bin'],
-    :imw_etc   => [:imw_root, 'etc'],
-    :imw_lib   => [:imw_root, 'lib'],
-
-    # workflow
-    :ripd_root  => [:data_root, 'ripd'],
-    :rawd_root  => [:data_root, 'rawd'],
-    :fixd_root  => [:data_root, 'fixd'],
-    :pkgd_root  => [:data_root, 'pkgd']
-  }
-  defined?(PATHS) ? PATHS.reverse_merge!(DEFAULT_PATHS) : PATHS = DEFAULT_PATHS
-
-  # Expands a shorthand workflow path specification to an actual
-  # file path.  Strings are interpreted literally but symbols are
-  # first resolved to the paths they represent.
-  #
-  #   IMW.add_path :foo, '~/whoa'
-  #   IMW.path_to :foo, 'my_thing'
-  #   => '~/whoa/my_thing'
-  #
-  # @param [String, Symbol] pathsegs the path segments to join
-  # @return [String] the resulting expanded path
-  def self.path_to *pathsegs
-    path = Pathname.new IMW.path_to_helper(*pathsegs)
-    path.absolute? ? File.expand_path(path) : path.to_s
-  end
-
-  # Adds a symbolic path for expansion by +path_to+.
-  # 
-  #   IMW.add_path :foo, '~/whoa'
-  #   IMW.add_path :bar, :foo,   'baz'
-  #   IMW.path_to :bar
-  #   => '~/whoa/baz'
-  #
-  # @param [Symbol] sym the name of the path to store
-  # @param [Symbol, String] pathsegs the path segments to use to define the path to the name
-  # @return [String] the resulting path
-  def self.add_path sym, *pathsegs
-    IMW::PATHS[sym] = pathsegs.flatten
-    path_to[sym]
-  end
-
-  # Removes a symbolic path for expansion by +path_to+.
-  #
-  # @param [Symbol] sym the stored path symbol to remove
-  def self.remove_path sym
-    IMW::PATHS.delete sym if IMW::PATHS.include? sym
-  end
-
-  protected
-  def self.path_to_helper *pathsegs # :nodoc:
-    # +path_to_helper+ handles the recursive calls for +path_to+.
-    expanded = pathsegs.flatten.compact.map do |pathseg|
-      case
-      when pathseg.is_a?(Symbol) && IMW::PATHS.include?(pathseg) then path_to(IMW::PATHS[pathseg])          
-      when pathseg.is_a?(Symbol)                                 then raise IMW::PathError.new("No path expansion set for #{pathseg.inspect}")
-      else pathseg
-      end
-    end
-    File.join(*expanded)
-  end
-end

data/lib/imw/utils/uri.rb

@@ -1,59 +0,0 @@
-require 'imw/utils'
-require 'imw/utils/uuid'
-require 'addressable/uri'
-module Addressable
-  #
-  # Add the #scrubbed and #revhost calls
-  #
-  class URI
-    SAFE_CHARS      = %r{a-zA-Z0-9\-\._!\(\)\*\'}
-    PATH_CHARS      = %r{#{SAFE_CHARS}\$&\+,:=@\/;}
-    RESERVED_CHARS  = %r{\$&\+,:=@\/;\?\%}
-    UNSAFE_CHARS    = %r{\\ \"\#<>\[\]\^\`\|\~\{\}}
-    HOST_HEAD     = '(?:[a-z0-9\-]+\.)+'
-    HOST_TLD      = '(?:[a-z]{2}|com|org|net|edu|gov|mil|biz|info|mobi|name|aero|jobs|museum)'
-
-    def host_valid?
-      !!(host =~ %r{\A#{HOST_HEAD}#{HOST_TLD}\z}i)
-    end
-    def path_valid?
-      !!(path =~ %r{\A[#{PATH_CHARS}%]*\z})
-    end
-    def simple_connection_part?
-      ( ['http', nil].include?(scheme) &&
-        [80,     nil].include?(port) &&
-        (self.to_hash.values_at(:password, :user).join.blank?) )
-    end
-
-    #
-    # Does this look like a
-    #
-    def simple?
-      host_valid? && path_valid? && simple_connection_part?
-    end
-
-    #
-    # +revhost+
-    # the dot-reversed host:
-    #   foo.company.com => com.company.foo
-    #
-    def revhost
-      return host unless host =~ /\./
-      host.split('.').reverse.join('.')
-    end
-    #
-    # +uuid+  -- RFC-4122 ver.5 uuid; guaranteed to be universally unique
-    #
-    # See
-    #   http://www.faqs.org/rfcs/rfc4122.html
-    #
-    def url_uuid
-      UUID.sha1_create(UUID_URL_NAMESPACE, self.normalize.to_s)
-    end
-  end
-end
-
-class << Addressable::URI
-  alias_method :encode_segment,   :encode_component    if ! defined?(encode_segment)
-  alias_method :unencode_segment, :unencode_component  if ! defined?(unencode_segment)
-end