cosmos 3.0.1 → 3.1.0

data/lib/cosmos/core_ext/class.rb

@@ -1,51 +1,51 @@
-# encoding: ascii-8bit
-
-# Copyright 2014 Ball Aerospace & Technologies Corp.
-# All Rights Reserved.
-#
-# This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
-# as published by the Free Software Foundation; version 3 with
-# attribution addendums as found in the LICENSE.txt
-
-# COSMOS specific additions to the Ruby Class class
-class Class
-  # Creates instance variables in the class which have corresponding class
-  # method accessors. NOTE: You must define self.instance for this to work.
-  #
-  # For example:
-  #   class MyClass
-  #     instance_attr_reader :test
-  #     @@instance = nil
-  #     def self.instance
-  #       @@instance ||= self.new
-  #       return @@instance
-  #     end
-  #     def initialize
-  #       @test = "Test"
-  #       @@instance = self
-  #     end
-  #
-  # Will allow the following:
-  #   my = MyClass.new
-  #   my.test # returns "Test"
-  #   MyClass.test # returns "Test"
-  #
-  # @param args [Array<Symbol>] Array of symbols which should be turned into
-  #   instance variables with class method accessors
-  def instance_attr_reader(*args)
-    args.each do |arg|
-      self.class_eval("def #{arg};@#{arg};end")
-      self.instance_eval("def #{arg};self.instance.#{arg};end")
-    end
-  end
-
-  def instance_attr_accessor(*args)
-    args.each do |arg|
-      self.class_eval("def #{arg};@#{arg};end")
-      self.instance_eval("def #{arg};self.instance.#{arg};end")
-      self.class_eval("def #{arg}=(arg);@#{arg} = arg;end")
-      self.instance_eval("def #{arg}=(arg);self.instance.#{arg} = arg;end")
-    end
-  end
-end
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+# COSMOS specific additions to the Ruby Class class
+class Class
+  # Creates instance variables in the class which have corresponding class
+  # method accessors. NOTE: You must define self.instance for this to work.
+  #
+  # For example:
+  #   class MyClass
+  #     instance_attr_reader :test
+  #     @@instance = nil
+  #     def self.instance
+  #       @@instance ||= self.new
+  #       return @@instance
+  #     end
+  #     def initialize
+  #       @test = "Test"
+  #       @@instance = self
+  #     end
+  #
+  # Will allow the following:
+  #   my = MyClass.new
+  #   my.test # returns "Test"
+  #   MyClass.test # returns "Test"
+  #
+  # @param args [Array<Symbol>] Array of symbols which should be turned into
+  #   instance variables with class method accessors
+  def instance_attr_reader(*args)
+    args.each do |arg|
+      self.class_eval("def #{arg};@#{arg};end")
+      self.instance_eval("def #{arg};self.instance.#{arg};end")
+    end
+  end
+
+  def instance_attr_accessor(*args)
+    args.each do |arg|
+      self.class_eval("def #{arg};@#{arg};end")
+      self.instance_eval("def #{arg};self.instance.#{arg};end")
+      self.class_eval("def #{arg}=(arg);@#{arg} = arg;end")
+      self.instance_eval("def #{arg}=(arg);self.instance.#{arg} = arg;end")
+    end
+  end
+end

data/lib/cosmos/core_ext/cosmos_io.rb

@@ -1,29 +1,29 @@
-# encoding: ascii-8bit
-
-# Copyright 2014 Ball Aerospace & Technologies Corp.
-# All Rights Reserved.
-#
-# This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
-# as published by the Free Software Foundation; version 3 with
-# attribution addendums as found in the LICENSE.txt
-
-require 'cosmos/ext/cosmos_io'
-
-# COSMOS specific additions to the Ruby IO and StringIO classes
-module CosmosIO
-  # Reads a length field and then return the String resulting from reading the
-  # number of bytes the length field indicates
-  #
-  # For example:
-  #   io = StringIO.new
-  #   # where io is "\x02\x01\x02\x03\x04...."
-  #   result = io.read_length_bytes(1)
-  #   # result will be "\x01x02" because the length field was given
-  #   # to be 1 byte. We read 1 byte which is a 2. So we then read two
-  #   # bytes and return.
-  #
-  # @param length_num_bytes [Integer] Number of bytes in the length field
-  # @return [String] A String of "length field" number of bytes
-  # def read_length_bytes(length_num_bytes)
-end
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'cosmos/ext/cosmos_io'
+
+# COSMOS specific additions to the Ruby IO and StringIO classes
+module CosmosIO
+  # Reads a length field and then return the String resulting from reading the
+  # number of bytes the length field indicates
+  #
+  # For example:
+  #   io = StringIO.new
+  #   # where io is "\x02\x01\x02\x03\x04...."
+  #   result = io.read_length_bytes(1)
+  #   # result will be "\x01x02" because the length field was given
+  #   # to be 1 byte. We read 1 byte which is a 2. So we then read two
+  #   # bytes and return.
+  #
+  # @param length_num_bytes [Integer] Number of bytes in the length field
+  # @return [String] A String of "length field" number of bytes
+  # def read_length_bytes(length_num_bytes)
+end

data/lib/cosmos/core_ext/exception.rb

@@ -1,52 +1,52 @@
-# encoding: ascii-8bit
-
-# Copyright 2014 Ball Aerospace & Technologies Corp.
-# All Rights Reserved.
-#
-# This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
-# as published by the Free Software Foundation; version 3 with
-# attribution addendums as found in the LICENSE.txt
-
-# COSMOS specific additions to the Ruby Exception class
-class Exception
-  # @param hide_runtime_error_class [Boolean] Whether to hide the Exception
-  #   error class if the class is RuntimeError. Other classes will continue to
-  #   be printed.
-  # @param include_backtrace [Boolean] Whether to include the full exception
-  #   backtrace
-  # @return [String] The formatted Exception
-  def formatted(hide_runtime_error_class = false, include_backtrace = true)
-    if include_backtrace and self.backtrace
-      if hide_runtime_error_class and self.class == RuntimeError
-        "#{self.message}\n#{self.backtrace.join("\n")}"
-      else
-        "#{self.class.to_s.split('::')[-1]} : #{self.message}\n#{self.backtrace.join("\n")}"
-      end
-    else
-      if hide_runtime_error_class and self.class == RuntimeError
-        "#{self.message}"
-      else
-        "#{self.class.to_s.split('::')[-1]} : #{self.message}"
-      end
-    end
-  end
-
-  # @return [Array(String, Fixnum)] The filename and line number where the Exception
-  #   occurred
-  def source
-    trace = self.backtrace[0]
-    split_trace = trace.split(':')
-    filename = ''
-    line_number = ''
-    if trace[1..1] == ':' # Windows Path
-      filename = split_trace[0] + ':' + split_trace[1]
-      line_number = split_trace[2].to_i
-    else
-      filename = split_trace[0]
-      line_number = split_trace[1].to_i
-    end
-
-    [filename, line_number]
-  end
-end
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+# COSMOS specific additions to the Ruby Exception class
+class Exception
+  # @param hide_runtime_error_class [Boolean] Whether to hide the Exception
+  #   error class if the class is RuntimeError. Other classes will continue to
+  #   be printed.
+  # @param include_backtrace [Boolean] Whether to include the full exception
+  #   backtrace
+  # @return [String] The formatted Exception
+  def formatted(hide_runtime_error_class = false, include_backtrace = true)
+    if include_backtrace and self.backtrace
+      if hide_runtime_error_class and self.class == RuntimeError
+        "#{self.message}\n#{self.backtrace.join("\n")}"
+      else
+        "#{self.class.to_s.split('::')[-1]} : #{self.message}\n#{self.backtrace.join("\n")}"
+      end
+    else
+      if hide_runtime_error_class and self.class == RuntimeError
+        "#{self.message}"
+      else
+        "#{self.class.to_s.split('::')[-1]} : #{self.message}"
+      end
+    end
+  end
+
+  # @return [Array(String, Fixnum)] The filename and line number where the Exception
+  #   occurred
+  def source
+    trace = self.backtrace[0]
+    split_trace = trace.split(':')
+    filename = ''
+    line_number = ''
+    if trace[1..1] == ':' # Windows Path
+      filename = split_trace[0] + ':' + split_trace[1]
+      line_number = split_trace[2].to_i
+    else
+      filename = split_trace[0]
+      line_number = split_trace[1].to_i
+    end
+
+    [filename, line_number]
+  end
+end

data/lib/cosmos/core_ext/file.rb

@@ -1,75 +1,75 @@
-# encoding: ascii-8bit
-
-# Copyright 2014 Ball Aerospace & Technologies Corp.
-# All Rights Reserved.
-#
-# This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
-# as published by the Free Software Foundation; version 3 with
-# attribution addendums as found in the LICENSE.txt
-
-require 'find'
-
-# COSMOS specific additions to the Ruby File class
-class File
-  NON_ASCII_PRINTABLE = /[^\x21-\x7e\s]/
-
-  # @return [Boolean] Whether the file only contains ASCII characters
-  def self.is_ascii?(filename)
-    return_value = true
-    File.open(filename) do |file|
-      while buf = file.read(1024)
-        if buf =~ NON_ASCII_PRINTABLE
-          return_value = false
-          break
-        end
-      end
-    end
-    return return_value
-  end
-
-  # Builds a String for use in creating a file. The time is formatted as
-  # YYYY_MM_DD_HH_MM_SS. The tags and joined with an underscore and appended to
-  # the date before appending the extension.
-  #
-  # For example:
-  #   File.build_timestamped_filename(['test','only'], '.bin', Time.now)
-  #   # result is YYYY_MM_DD_HH_MM_SS_test_only.bin
-  #
-  # @param tags [Array<String>] An array of strings to be joined by underscores
-  #   after the date. Pass nil or an empty array to use no tags.
-  # @param extension [String] The filename extension
-  # @param time [Time] The time to format into the filename
-  # @return [String] The filename string containing the timestamp, tags, and
-  #   extension
-  def self.build_timestamped_filename(tags = nil, extension = '.txt', time = Time.now)
-    timestamp = sprintf("%04u_%02u_%02u_%02u_%02u_%02u", time.year, time.month, time.mday, time.hour, time.min, time.sec)
-    tags ||= []
-    tags.compact!
-    combined_tags = tags.join("_")
-    if combined_tags.length > 0
-      filename = timestamp + "_" + combined_tags + extension
-    else
-      filename = timestamp + extension
-    end
-    return filename
-  end
-
-  # @param filename [String] The file to search for
-  # @return [String] The full path to the filename if it was found in the Ruby
-  #   search path. nil if the fild was not found.
-  def self.find_in_search_path(filename)
-    $:.each do |load_path|
-      begin
-        Find.find(load_path) do |path|
-          Find.prune if path =~ /\.svn/
-          return path if File.basename(path) == filename
-        end
-      rescue Errno::ENOENT
-        # Ignore non-existent folders
-        next
-      end
-    end
-    return nil
-  end
-end
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+require 'find'
+
+# COSMOS specific additions to the Ruby File class
+class File
+  NON_ASCII_PRINTABLE = /[^\x21-\x7e\s]/
+
+  # @return [Boolean] Whether the file only contains ASCII characters
+  def self.is_ascii?(filename)
+    return_value = true
+    File.open(filename) do |file|
+      while buf = file.read(1024)
+        if buf =~ NON_ASCII_PRINTABLE
+          return_value = false
+          break
+        end
+      end
+    end
+    return return_value
+  end
+
+  # Builds a String for use in creating a file. The time is formatted as
+  # YYYY_MM_DD_HH_MM_SS. The tags and joined with an underscore and appended to
+  # the date before appending the extension.
+  #
+  # For example:
+  #   File.build_timestamped_filename(['test','only'], '.bin', Time.now)
+  #   # result is YYYY_MM_DD_HH_MM_SS_test_only.bin
+  #
+  # @param tags [Array<String>] An array of strings to be joined by underscores
+  #   after the date. Pass nil or an empty array to use no tags.
+  # @param extension [String] The filename extension
+  # @param time [Time] The time to format into the filename
+  # @return [String] The filename string containing the timestamp, tags, and
+  #   extension
+  def self.build_timestamped_filename(tags = nil, extension = '.txt', time = Time.now)
+    timestamp = sprintf("%04u_%02u_%02u_%02u_%02u_%02u", time.year, time.month, time.mday, time.hour, time.min, time.sec)
+    tags ||= []
+    tags.compact!
+    combined_tags = tags.join("_")
+    if combined_tags.length > 0
+      filename = timestamp + "_" + combined_tags + extension
+    else
+      filename = timestamp + extension
+    end
+    return filename
+  end
+
+  # @param filename [String] The file to search for
+  # @return [String] The full path to the filename if it was found in the Ruby
+  #   search path. nil if the fild was not found.
+  def self.find_in_search_path(filename)
+    $:.each do |load_path|
+      begin
+        Find.find(load_path) do |path|
+          Find.prune if path =~ /\.svn/
+          return path if File.basename(path) == filename
+        end
+      rescue Errno::ENOENT
+        # Ignore non-existent folders
+        next
+      end
+    end
+    return nil
+  end
+end

data/lib/cosmos/core_ext/hash.rb

@@ -1,28 +1,28 @@
-# encoding: ascii-8bit
-
-# Copyright 2014 Ball Aerospace & Technologies Corp.
-# All Rights Reserved.
-#
-# This program is free software; you can modify and/or redistribute it
-# under the terms of the GNU General Public License
-# as published by the Free Software Foundation; version 3 with
-# attribution addendums as found in the LICENSE.txt
-
-# COSMOS specific additions to the Ruby Hash class
-class Hash
-  # Redefine inspect to only print for small numbers of
-  # items.  Prevents exceptions taking forever to be raised with
-  # large objects.  See http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/105145
-  alias old_inspect inspect
-
-  # @param max_elements [Integer] The maximum number of elements in the Hash to
-  #   print out before simply displaying the Hash class and object id
-  # @return [String] String representation of the hash
-  def inspect(max_elements = 10)
-    if self.length <= max_elements
-      old_inspect()
-    else
-      '#<' + self.class.to_s + ':' + self.object_id.to_s + '>'
-    end
-  end
-end
+# encoding: ascii-8bit
+
+# Copyright 2014 Ball Aerospace & Technologies Corp.
+# All Rights Reserved.
+#
+# This program is free software; you can modify and/or redistribute it
+# under the terms of the GNU General Public License
+# as published by the Free Software Foundation; version 3 with
+# attribution addendums as found in the LICENSE.txt
+
+# COSMOS specific additions to the Ruby Hash class
+class Hash
+  # Redefine inspect to only print for small numbers of
+  # items.  Prevents exceptions taking forever to be raised with
+  # large objects.  See http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/105145
+  alias old_inspect inspect
+
+  # @param max_elements [Integer] The maximum number of elements in the Hash to
+  #   print out before simply displaying the Hash class and object id
+  # @return [String] String representation of the hash
+  def inspect(max_elements = 10)
+    if self.length <= max_elements
+      old_inspect()
+    else
+      '#<' + self.class.to_s + ':' + self.object_id.to_s + '>'
+    end
+  end
+end