cosmos 3.9.2 → 4.0.0

data/lib/cosmos/core_ext/array.rb

@@ -8,7 +8,7 @@
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
 
-require 'cosmos/ext/array'
+require 'cosmos/ext/array' if RUBY_ENGINE == 'ruby' and !ENV['COSMOS_NO_EXT']
 
 # COSMOS specific additions to the Ruby Array class
 class Array
@@ -229,11 +229,51 @@ class Array
     self.map {|value| value * value}
   end
 
-  # return [Numeric, Fixnum] The first maximum value and its index
-  # def max_with_index
+  if RUBY_ENGINE != 'ruby' or ENV['COSMOS_NO_EXT']
+    # return [Numeric, Fixnum] The first maximum value and its index
+    def max_with_index
+      maximum = nil
+      maximum_index = nil
 
-  # return [Numeric, Fixnum] The first minimum value and its index
-  # def min_with_index
+      if self.length > 0
+        maximum = self[0]
+        maximum_index = 0
+
+        (1..(self.length - 1)).each do |index|
+          value = self[index]
+
+          if value > maximum
+            maximum = value
+            maximum_index = index
+          end
+        end
+      end
+
+      return [maximum, maximum_index]
+    end
+
+    # return [Numeric, Fixnum] The first minimum value and its index
+    def min_with_index
+      minimum = nil
+      minimum_index = nil
+
+      if self.length > 0
+        minimum = self[0]
+        minimum_index = 0
+
+        (1..(self.length - 1)).each do |index|
+          value = self[index]
+
+          if value < minimum
+            minimum = value
+            minimum_index = index
+          end
+        end
+      end
+
+      return [minimum, minimum_index]
+    end
+  end
 
   # @param num_buckets [Integer] The number of buckets (groups of numbers) that
   #   will be used when histogramming. nil indicates to use as many buckets as

data/lib/cosmos/core_ext/cosmos_io.rb

@@ -8,22 +8,38 @@
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
 
-require 'cosmos/ext/cosmos_io'
+require 'cosmos/packets/binary_accessor'
+require 'cosmos/ext/cosmos_io' if RUBY_ENGINE == 'ruby' and !ENV['COSMOS_NO_EXT']
 
 # 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)
+  if RUBY_ENGINE != 'ruby' or ENV['COSMOS_NO_EXT']
+    # 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)
+      return nil unless (length_num_bytes == 1) || (length_num_bytes == 2) or (length_num_bytes == 4)
+
+      # Read bytes for string length
+      temp_string_length = self.read(length_num_bytes)
+      return nil if (temp_string_length.nil?) || (temp_string_length.length != length_num_bytes)
+      string_length = Cosmos::BinaryAccessor.read(0, length_num_bytes * 8, :UINT, temp_string_length, :BIG_ENDIAN)
+
+      # Read String
+      string = self.read(string_length)
+      return nil if (string.nil?) || (string.length != string_length)
+      return string
+    end
+  end
+
 end

data/lib/cosmos/core_ext/file.rb

@@ -34,7 +34,7 @@ class File
   # the date before appending the extension.
   #
   # For example:
-  #   File.build_timestamped_filename(['test','only'], '.bin', Time.now)
+  #   File.build_timestamped_filename(['test','only'], '.bin', Time.now.sys)
   #   # result is YYYY_MM_DD_HH_MM_SS_test_only.bin
   #
   # @param tags [Array<String>] An array of strings to be joined by underscores
@@ -43,7 +43,7 @@ class File
   # @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)
+  def self.build_timestamped_filename(tags = nil, extension = '.txt', time = Time.now.sys)
     timestamp = sprintf("%04u_%02u_%02u_%02u_%02u_%02u", time.year, time.month, time.mday, time.hour, time.min, time.sec)
     tags ||= []
     tags.compact!

data/lib/cosmos/core_ext/kernel.rb

@@ -12,12 +12,7 @@
 module Kernel
   # @return [Boolean] Whether the current platform is Windows
   def is_windows?
-    _, platform, *_ = RUBY_PLATFORM.split("-")
-    result = false
-    if platform == 'mswin32' or platform == 'mingw32'
-      result = true
-    end
-    return result
+    Gem.win_platform?
   end
 
   # @return [Boolean] Whether the current platform is Mac

data/lib/cosmos/core_ext/objectspace.rb

@@ -8,8 +8,6 @@
 # as published by the Free Software Foundation; version 3 with
 # attribution addendums as found in the LICENSE.txt
 
-require 'cosmos/ext/array'
-
 # COSMOS specific additions to the ObjectSpace class
 module ObjectSpace
   def self.find(klass)

data/lib/cosmos/core_ext/string.rb

@@ -9,13 +9,15 @@
 # attribution addendums as found in the LICENSE.txt
 
 require 'cosmos/packets/binary_accessor'
-require 'cosmos/ext/string'
+require 'cosmos/ext/string' if RUBY_ENGINE == 'ruby' and !ENV['COSMOS_NO_EXT']
 
 # COSMOS specific additions to the Ruby String class
 class String
 
   # The printable range of ASCII characters
   PRINTABLE_RANGE = 32..126
+  # Regular expression to identify a character that is not in the printable range
+  NON_PRINTABLE_REGEX = /[^ -~]/
   # Regular expression to identify a String as a floating point number
   FLOAT_CHECK_REGEX = /\A\s*[-+]?\d*\.\d+\s*\z/
   # Regular expression to identify a String as a floating point number in
@@ -161,8 +163,17 @@ class String
     value
   end
 
-  # @return [String] The string with leading and trailing quotes removed
-  # def remove_quotes
+  if RUBY_ENGINE != 'ruby' or ENV['COSMOS_NO_EXT']
+   # @return [String] The string with leading and trailing quotes removed
+    def remove_quotes
+      return self if self.length < 2
+      first_char = self[0]
+      return self if (first_char != '"') && (first_char != "'")
+      last_char = self[-1]
+      return self if first_char != last_char
+      return self[1..-2]
+    end
+  end
 
   # @return [Boolean] Whether the String represents a floating point number
   def is_float?
@@ -184,6 +195,11 @@ class String
     if self =~ ARRAY_CHECK_REGEX then true else false end
   end
 
+  # @return [Boolean] Whether the string contains only printable characters
+  def is_printable?
+    if self =~ NON_PRINTABLE_REGEX then false else true end
+  end
+
   # @return Converts the String into either a Float, Integer, or Array
   # depending on what the String represents. It can successfully convert
   # floating point numbers in both fixed and scientific notation, integers
@@ -192,7 +208,14 @@ class String
   def convert_to_value
     return_value = self
     begin
-      if self.is_float?
+      upcase_self = self.upcase
+      if upcase_self == 'INFINITY'.freeze
+        return_value = Float::INFINITY
+      elsif upcase_self == '-INFINITY'.freeze
+        return_value = -Float::INFINITY
+      elsif upcase_self == 'NAN'.freeze
+        return_value = Float::NAN
+      elsif self.is_float?
         # Floating Point in normal or scientific notation
         return_value = self.to_f
       elsif self.is_int?

data/lib/cosmos/core_ext/time.rb

@@ -68,6 +68,32 @@ class Time
   USEC_PER_DAY_FLOAT = USEC_PER_DAY.to_f
   MINUTES_PER_DAY_FLOAT = MINUTES_PER_DAY.to_f
 
+  # Class variable that allows us to globally select whether to use
+  # UTC or local time.
+  @@use_utc = false
+  
+  # Set up the Time class so that a call to the sys method will set the 
+  # Time object being operated upon to be a UTC time. 
+  def self.use_utc
+    @@use_utc = true
+  end
+  
+  # Set up the Time class so that a call to the sys method will set the 
+  # Time object being operated upon to be a local time. 
+  def self.use_local
+    @@use_utc = false
+  end
+
+  # Set the Time object to be either a UTC or local time depending on the
+  # use_utc flag.
+  def sys
+    if @@use_utc
+      self.utc
+    else
+      self.localtime
+    end
+  end
+
   # @param seconds [Numeric] Total number of seconds
   # @return [String] Seconds formatted as a human readable string with days,
   #   hours, minutes, and seconds.
@@ -209,17 +235,20 @@ class Time
     Time.total_seconds(self.hour, self.min, self.sec, self.usec)
   end
 
-  # @return [String] Date formatted as YYYY/MM/DD HH:MM:SS.US
-  def formatted(include_year = true, fractional_digits = 3)
-    if include_year && fractional_digits > 0
-      self.strftime("%Y/%m/%d %H:%M:%S.%#{fractional_digits}N")
-    elsif include_year && fractional_digits == 0
-      self.strftime("%Y/%m/%d %H:%M:%S")
-    elsif fractional_digits > 0 # no year
-      self.strftime("%H:%M:%S.%#{fractional_digits}N")
-    else # no year and no fractional digits
-      self.strftime("%H:%M:%S")
+  # @return [String] Date formatted as YYYY/MM/DD HH:MM:SS.US UTC_OFFSET
+  def formatted(include_year = true, fractional_digits = 3, include_utc_offset = false)
+    str =  ""
+    str << "%Y/%m/%d " if include_year
+    str << "%H:%M:%S"
+    str << ".%#{fractional_digits}N" if fractional_digits > 0
+    if include_utc_offset
+      if self.utc?
+        str << " UTC"
+      else
+        str << " %z"
+      end
     end
+    self.strftime(str)
   end
 
   # @param time [Time]

data/lib/cosmos/gui/choosers/combobox_chooser.rb

@@ -11,29 +11,36 @@
 require 'cosmos'
 
 module Cosmos
-
-  # This class implements the ComboboxChooser
+  # Widget which creates a horizontally laid out label, and combobox.
+  # A callback can be specified which is called once the combobox is changed.
   class ComboboxChooser < Qt::Widget
-
     # Width of the button in the combobox
     COMBOBOX_BUTTON_WIDTH = 30
-
     # Optional callback for when the combobox value changes
     attr_accessor :sel_command_callback
 
+    # @param parent [Qt::Widget] Widget to parent this widget to
+    # @param label_text [String] Text to place in the label
+    # @param items [Array<#to_s>] Array of items to add to the combobox
+    # @param allow_user_entry [Boolean] Whether to allow the user to enter an
+    #   arbitrary string in the combobox
+    # @param compact_combobox [Boolean] Whether to fix the size of the combobox
+    #   or let it expand to fill the space
+    # @param color_chooser [Boolean] Whether to create a rectangular color
+    #   swatch based on each item name
     def initialize(
       parent, label_text, items, # required
       allow_user_entry: false, compact_combobox: true, color_chooser: false
     )
       super(parent)
       layout = Qt::HBoxLayout.new(self)
-      layout.setContentsMargins(0,0,0,0)
+      layout.setContentsMargins(0, 0, 0, 0)
       @combo_label = Qt::Label.new(label_text)
       @combo_label.setSizePolicy(Qt::SizePolicy::Fixed, Qt::SizePolicy::Fixed) unless compact_combobox
       layout.addWidget(@combo_label)
       @combo_value = Qt::ComboBox.new
       @combo_value.setEditable(allow_user_entry)
-      string_items = items.map {|item| item.to_s}
+      string_items = items.map {|item| item.to_s }
       @combo_value.addItems(string_items)
       @color_chooser = color_chooser
       set_colors(string_items) if @color_chooser
@@ -50,11 +57,15 @@ module Cosmos
       @sel_command_callback = nil
     end
 
-    # Changes the items in the combobox and resizes it
+    # Clears the combobox and adds new items
+    # @param items [Array<String>] Items to add to the combobox
+    # @param include_blank [Boolean] Whether to add a blank item as the first
+    #   combobox item. This is typically done to indicate to the user that a
+    #   value must be selected.
     def update_items(items, include_blank = true)
       @combo_value.clearItems
       @combo_value.addItem(' ') if include_blank
-      string_items = items.map {|item| item.to_s}
+      string_items = items.map {|item| item.to_s }
       @combo_value.addItems(string_items)
       set_colors(string_items) if @color_chooser
       if items.length < 20
@@ -64,40 +75,42 @@ module Cosmos
       end
     end
 
-    def set_current(string)
-      @combo_value.setCurrentText(string.to_s)
-    end
-
-    # Supports a callback on item changing
-    def handle_combobox_sel_command(index)
-      if index >= 0
-        @sel_command_callback.call(string()) if @sel_command_callback
-      end
-      0
+    # @param text [String] Text to set in the current combobox item
+    def set_current(text)
+      @combo_value.setCurrentText(text.to_s)
     end
 
-    # Returns the selected item as an integer
+    # @return [Integer] Current item as an integer
     def integer
       Integer(@combo_value.currentText)
     end
 
-    # Returns the selected item as a float
+    # @return [Float] Current item as a float
     def float
       @combo_value.currentText.to_f if @combo_value.currentText
     end
 
-    # Returns the selected item as a string
+    # @return [String] Current item as a string
     def string
       @combo_value.currentText
     end
 
-    # Returns the selected item as a symbol
+    # @return [Symbol] Current item as a symbol
     def symbol
       @combo_value.currentText.intern if @combo_value.currentText
     end
 
     protected
 
+    # Calls the combobox selection changed callback if it exists
+    def handle_combobox_sel_command(index)
+      if index >= 0
+        @sel_command_callback.call(string()) if @sel_command_callback
+      end
+      0
+    end
+
+    # Creates a rectangle of color based on the combobox item name
     def set_colors(string_items)
       # Create an image we can draw into
       img = Qt::Image.new(16, 16, Qt::Image::Format_RGB32)
@@ -124,7 +137,5 @@ module Cosmos
       img.dispose
       p.dispose
     end
-
-  end # class ComboboxChooser
-
-end # module Cosmos
+  end
+end

data/lib/cosmos/gui/choosers/file_chooser.rb

@@ -11,12 +11,29 @@
 require 'cosmos'
 
 module Cosmos
-
+  # Widget which creates a horizontally laid out label, value, and button that
+  # opens a FileDialog to choose a file. A callback can be specified which is
+  # called once the file is selected by the FileDialog.
   class FileChooser < Qt::Widget
-
     # Callback for a chosen filename
     attr_accessor :callback
 
+    # @param parent [Qt::Widget] Widget to parent this widget to
+    # @param label_text [String] Text to place in the label
+    # @param initial_value [String] Initial value to put in the value box. Note
+    #   this has no impact on the FileDialog.
+    # @param button_text [String] Text to place on the button which launches
+    #   the FileDialog
+    # @param file_path [String] Default path which is used when initially
+    #   opening the FileDialog
+    # @param field_width [Integer] Minimum width of the value field
+    # @param fill [Boolean] Whether to make this widget fill up the horizontal
+    #   space allocated to it or be fixed width.
+    # @param extensions [String] List of file filters which can be selected by
+    #   the user. Must be formatted with the filter name followed by the
+    #   extension in parens. Multiple filters must be separated by double
+    #   semicolons. For example:
+    #     "Images (*.png *.jpg);;Text files (*.txt)"
     def initialize(
       parent, label_text, initial_value, button_text, file_path,
       field_width = 20, fill = false, extensions = nil
@@ -55,14 +72,14 @@ module Cosmos
       @callback = nil
     end
 
+    # @return [String] The selected filename
     def filename
       @filename_value.text
     end
 
+    # @param filename [String] Filename to set the value to
     def filename=(filename)
       @filename_value.text = filename.to_s
     end
-
-  end # class FloatChooser
-
-end # module Cosmos
+  end
+end