app_mode 0.0.1

data/test/lib/app_mode.rb

@@ -0,0 +1,61 @@
+# This file overrides the main class during tests.
+
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU General Public License           #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+#                                                                              #
+# Commercial licensing may be available for a fee under a different license.   #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU General Public License for more details.                         #
+#                                                                              #
+# You should have received a copy of the GNU General Public License            #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+class AppMode
+  ############################################################################
+  private
+  ############################################################################
+
+  def getwd
+    if @valid_states.include?(:dynamic_dev)
+      return '/root/path/development'
+    else
+      return '/root/path/production'
+    end
+  end
+
+  def origin
+    case @valid_states[0]
+      when /^dev_/
+        "./file_name.rb:00:in `<main>'"
+      when /^test_/
+        "/root/ruby/gems/ruby-9.8.7-p123/gems/rake-6.5.4/lib/rake/" +
+        "rake_test_loader.rb:5:in `<main>'"
+      when /^rake_/
+        "/root/ruby/gems/ruby-9.8.7-p123/bin/rake:19:in `<main>'"
+      else
+        "./root/file_name.rb:00:in `<main>'"
+    end
+  end
+end

data/test/lib/app_mode_support.rb

@@ -0,0 +1,133 @@
+# This file contains a module which bridges the gap between test code
+# and applciation code.
+
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU General Public License           #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+#                                                                              #
+# Commercial licensing may be available for a fee under a different license.   #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU General Public License for more details.                         #
+#                                                                              #
+# You should have received a copy of the GNU General Public License            #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+# This module is provided to be used as an include in any necessary class.
+#
+# This serves as a bridge between test code and application code.
+module AppModeSupport
+  # These are things that will be used throughout testing in multiple locations.
+  ITEMS = {
+    :states => {
+      :default => [:development, :test, :rake, :production],
+      :dev     => [:dev_dev, :dev_test, :dev_rake, :dev_prod],
+      :test    => [:test_dev, :test_test, :test_rake, :test_prod],
+      :rake    => [:rake_dev, :rake_test, :rake_rake, :rake_prod],
+      :prod    => [:prod_dev, :prod_test, :prod_rake, :prod_prod],
+    }, # :states
+
+    :method_list => {
+      :valid_states => :valid_states,
+      :state        => :state,
+    }, # :methods
+  } # ITEMS
+
+  ITEMS.each_key do |key|
+    new_method = <<-DOC
+      def #{key}(*args)
+        method_missing(:#{key}, *args)
+      end
+      module_function :#{key}
+    DOC
+
+    module_eval <<-EOT, __FILE__, __LINE__ + 1
+      eval new_method
+    EOT
+  end
+
+  # Black magic.
+  #
+  # This is used for the following purposes:
+  # * To return elements from the ITEMS hash.
+  # * To return messages (from the ITEMS hash),
+  #   possibly with string substitutions.
+  # ==== Input
+  # [method : Symbol] The method that was called.
+  # [*args : Array] Any arguments that were passed in.
+  # [&block : Block] A block, if specified.
+  # ==== Output
+  # [Any] It depends on the method.
+  def method_missing(method, *args, &block)
+    # Check if the method is a key in the ITEMS hash.
+    if ITEMS.has_key? method
+      # Initialize the variable that will hold the return value.
+      value = nil
+
+      if args.nil? or args.count == 0
+        # If no arguments have been specified, return the element as is.
+        value = ITEMS[method]
+      elsif ITEMS[method][args[0]].is_a?(String) &&
+          ITEMS[method][args[0]].index('%s')
+        # The first parameter is the message.
+        msg = args.shift
+
+        if args.count == 0
+          # If no arguments are left, return the message.
+          value = ITEMS[method][msg]
+        else
+          # Use any remaining arguments to make substitutions.
+          value = ITEMS[method][msg] % args
+        end
+      else # All other methods - which are expected to have one parameter.
+        # Get the element to return.
+        item = args[0].to_sym
+
+        # Return the indicated element.
+        value = ITEMS[method][item]
+      end
+
+      # Strip all trailing line feeds from strings.
+      value.gsub!(/\n*\z/, '') if value.is_a?(String)
+
+      return value
+    else
+      super
+    end
+  end
+  module_function :method_missing
+
+  # Indicates which methods the class will respond to.
+  # ==== Input
+  # [method : Symbol] The method to check for.
+  # [include_private : Boolean] Whether private methods should be checked.
+  # ==== Output
+  # [Boolean] Whether the object will respond to the specified method.
+  def respond_to_missing?(method, include_private = false)
+    if ITEMS.has_key? method
+      return true
+    else
+      super
+    end
+  end
+end

data/test/lib/test_case.rb

@@ -0,0 +1,502 @@
+# This file contains a monkey patch of Test::Unit::TestCase.
+
+#--
+################################################################################
+#                      Copyright (C) 2011 Travis Herrick                       #
+################################################################################
+#                                                                              #
+#                                 \v^V,^!v\^/                                  #
+#                                 ~%       %~                                  #
+#                                 {  _   _  }                                  #
+#                                 (  *   -  )                                  #
+#                                 |    /    |                                  #
+#                                  \   _,  /                                   #
+#                                   \__.__/                                    #
+#                                                                              #
+################################################################################
+# This program is free software: you can redistribute it                       #
+# and/or modify it under the terms of the GNU General Public License           #
+# as published by the Free Software Foundation,                                #
+# either version 3 of the License, or (at your option) any later version.      #
+#                                                                              #
+# Commercial licensing may be available for a fee under a different license.   #
+################################################################################
+# This program is distributed in the hope that it will be useful,              #
+# but WITHOUT ANY WARRANTY;                                                    #
+# without even the implied warranty of MERCHANTABILITY                         #
+# or FITNESS FOR A PARTICULAR PURPOSE.                                         #
+# See the GNU General Public License for more details.                         #
+#                                                                              #
+# You should have received a copy of the GNU General Public License            #
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.        #
+################################################################################
+#++
+
+# Monkey patch Test::Unit::TestCase to make it do cool stuff.
+Test::Unit::TestCase.class_eval do
+  # Since this is in a class_eval, instance methods need to be wrapped up
+  # in class_variable_set or ruby will throw warnings.
+
+  # Indicates whether the class has already been initialized.
+  # This combined with @@class_name prevents duplicate patching.
+  class_variable_set(:@@initialized, false)
+
+  # Keeps track of the class that has most recently been initialized.
+  # This combined with @@initialized prevents duplicate patching.
+  class_variable_set(:@@class_name, '')
+
+  # Initializes the class
+  # and exposes private methods and variables of the class that is being tested.
+  def initialize(*args)
+    # Call initialize on the superclass.
+    super
+
+    @obj = nil
+
+    reset_io
+    reset_trace
+
+    # This block ensures that tests still work if there is not a class that
+    # corresponds with the test file/class.
+    @class = nil
+    begin
+      # Get the class that is being tested.
+      # Assume that the name of the class is found by removing 'Test'
+      # from the test class.
+      @class = Kernel.const_get(self.class.name.gsub(/Test$/, ''))
+      @@initialized = ((@class.name == @@class_name) && @@initialized)
+      @@class_name = @class.name
+    rescue
+      @@initialized = true
+      @@class_name = ''
+    end
+
+    # Only patch if this code has not yet been run.
+    if !@@initialized and @class.class.name != 'Module'
+      set_instance_method_wrappers
+
+      # Expose private class methods.
+      # We will only expose the methods we are responsible for creating.
+      # (i.e. subtracting the superclass's private methods)
+      expose_private_methods(:class,
+        @class.private_methods - 
+        @class.superclass.private_methods)
+
+      # Expose private instance methods.
+      # We will only expose the methods we are responsible for creating.
+      # (i.e. subtracting the superclass's private methods)
+      expose_private_methods(:instance,
+        @class.private_instance_methods -
+        @class.superclass.private_instance_methods)
+
+      # Expose variables.
+      # Requires that variables are assigned to in the constructor.
+      wrap_output {
+        expose_variables(@class.class_variables +
+          @class.new.instance_variables)
+      }
+
+      # Indicate that this code has been run.
+      @@initialized = true
+    end
+  end
+
+  # Sets up functionality for all tests.
+  #
+  # Tracing is set up here so that it is only running during tests.
+  #
+  # If you want to disable tracing, simply override the setup method
+  # without calling super. (It would be good form to also override teardown).
+  def setup
+    set_trace_func proc { |event, file, line, id, binding, class_name|
+      if class_name == @class and
+          @stack_trace.last != {:class => class_name.name, :method => id}
+        @stack_trace  << {
+          :class => class_name.name,
+          :method => id,
+        }
+      end
+    }
+  end
+
+  # Clean up after each test.
+  #
+  # If you disable tracing, it would be good form to override this method
+  # as well without calling super.
+  def teardown
+    set_trace_func nil
+  end
+
+  ############################################################################
+  private
+  ############################################################################
+
+  ############################################################################
+  # Monkey patching methods for the class being tested.
+  ############################################################################
+
+  # Monkey patch the class's initializer to enable tracing
+  # with parameters and results.
+  def set_initializer
+    @class.class_eval do
+      attr_accessor :trace
+
+      alias :test_case_initialize :initialize
+      def initialize(*args)
+        @trace = []
+        result = test_case_initialize(*args)
+        return result
+      end
+    end
+  end
+
+  # Loop through the instance methods, calling set_instance_methods for each.
+  def set_instance_method_wrappers
+    [
+      :public_instance_methods,
+      :protected_instance_methods,
+      :private_instance_methods
+    ].each do |method_id|
+
+      scope = method_id.to_s.gsub(/_.*/, '')
+
+      set_instance_methods(@class.send(method_id) -
+        @class.superclass.send(method_id), scope)
+    end
+
+    # If this is not at the end, the loop will attempt to do it's thing
+    # with the constructor created in this method, which is not necessary.
+    set_initializer
+  end
+
+  # Loop through the list of methods that are passed in,
+  # creating a wrapper method that enables tracing.
+  #
+  # Tracing data includes method name, parameters, and result.
+  # ==== Input
+  # [method_list : Array] A list of methods that will have wrapping functions
+  #                       created to enable tracing.
+  # [scope : String] The scope of the original function.
+  def set_instance_methods(method_list, scope)
+    method_list.each do |method_id|
+      # Setters and methods that accept blocks do not appear to work.
+      next if method_id =~ /=/ or method_id =~ /wrap_output/
+
+      # Build the method.
+      new_method = <<-DOC
+        alias :test_case_#{method_id} :#{method_id}
+        def #{method_id}(*args)
+          result = test_case_#{method_id}(*args)
+          @trace << {
+            :method => '#{method_id}',
+            :args => args,
+            :result => result
+          }
+          return result
+        end
+        #{scope} :#{method_id}
+      DOC
+
+      # Add the method to the class.
+      @class.class_eval do
+        eval(new_method)
+      end
+    end
+  end
+
+  # Expose the private methods that are passed in.  New methods will be created
+  # with the old method name followed by '_public_test'.  If the original
+  # method contained a '?', it will be removed in the new method.
+  # ==== Input
+  # [type : Symbol] Indicates whether to handle instance or class methods.
+  #
+  #                 Only :class and :instance are supported.
+  # [methods : Array] An array of the methods to expose.
+  def expose_private_methods(type, methods)
+    # Get the text that the method should be wrapped in.
+    method_wrapper = wrapper(type)
+
+    # Loop through the methods.
+    methods.each do |method|
+      # Remove ?s.
+      new_method = method.to_s.gsub(/\?/, '')
+
+      # This is the new method.
+      new_method = <<-DOC
+        def #{new_method}_public_test(*args)
+          #{method}(*args)
+        end
+      DOC
+
+      # Add the wrapping text.
+      new_method = method_wrapper % [new_method]
+
+      # Add the method to the class.
+      @class.class_eval do
+        eval(new_method)
+      end
+    end
+  end
+
+  # Expose the variables.
+  #
+  # New methods will be created (a getter and a setter) for each variable.
+  #
+  # Regardless of the type of variable, these methods are only available
+  # via an instance.
+  # ==== Input
+  # [variables : Array] An array of variables to expose.
+  def expose_variables(variables)
+    # Get the text that the methods should be wrapped in.
+    var_wrapper = wrapper(:instance)
+
+    # Loop through the variables
+    variables.each do |var|
+      # Remove any @s.
+      new_method = var.to_s.gsub(/@/, '')
+
+      # These are the new getter and setters.
+      new_method = <<-DOC
+        def #{new_method}_variable_method
+          #{var}
+        end
+
+        def #{new_method}_variable_method=(value)
+          #{var} = value
+        end
+      DOC
+
+      # Add the wrapping text.
+      new_method = var_wrapper % [new_method]
+
+      # Add the methods to the class.
+      @class.class_eval do
+        eval(new_method)
+      end
+    end
+  end
+
+  # Returns the wrapping text for the specified type of method.
+  # ==== Input
+  # [type : Symbol] Indicates whether to handle instance or class methods.
+  #
+  #                 Only :class & :instance are supported.
+  # ==== Output
+  # [String] The text that the specified type of method should be wrapped in.
+  def wrapper(type)
+    case type
+      when :class then 'class << self;%s;end'
+      when :instance then '%s'
+    end
+  end
+
+  ############################################################################
+  # I/O support methods.
+  ############################################################################
+
+  # Return the actual output to stdout and stderr.
+  # ==== Output
+  # [Array] Two element array of strings.
+  #
+  #         The first element is from stdout.
+  #
+  #         The second element is from stderr.
+  def real_finis
+    return out, err
+  end
+
+  # Wrap a block to capture the output to stdout and stderr.
+  # ==== Input
+  # [&block : Block] The block of code that will have stdout and stderr trapped.
+  def wrap_output(&block)
+    begin
+      $stdout = @out
+      $stderr = @err
+      yield
+    ensure
+      $stdout = STDOUT
+      $stderr = STDERR
+    end
+  end
+
+  # Returns the output from stdout as a string.
+  # ==== Output
+  # [String] The output from stdout.
+  #
+  #          All trailing line feeds are removed.
+  def out
+    @out.respond_to?(:string) ?  @out.string.gsub(/\n*\z/, '') : ''
+  end
+
+  # Returns the output from stderr as a string.
+  # ==== Output
+  # [String] The output from stderr.
+  #
+  #          All trailing line feeds are removed.
+  def err
+    @err.respond_to?(:string) ?  @err.string.gsub(/\n*\z/, '') : ''
+  end
+
+  # Reset the stdout and stderr stream variables.
+  def reset_io
+    @out = StringIO.new
+    @err = StringIO.new
+  end
+
+  ############################################################################
+  # Support methods.
+  ############################################################################
+
+  # Indicates whether the specified method has been called on a given class.
+  # ==== Input
+  # [method_name : String] The name of the method.
+  #
+  #                        This value may be a string or a symbol.
+  # [class_name : String : @class.name] The name of the class that the method
+  #                                     should have been invoked from.
+  def method_called?(method_name, class_name = @class.name)
+    !@stack_trace.index(
+      {:method => method_name.to_sym, :class => class_name}).nil?
+  end
+
+  # Resets the trace arrays.
+  #
+  # This is intended for use in cases where code may be called multiple
+  # times in a single test.
+  def reset_trace
+    @stack_trace = []
+    @obj.trace = [] if @obj.respond_to?(:trace=)
+  end
+
+  # Shows the trace history as it stands, if the object supports it.
+  def show_trace
+    return unless defined? @obj
+    puts @obj.trace.join("\n" + '-' * 80 + "\n") if @obj.respond_to?(:trace)
+  end
+
+  ############################################################################
+  # Assertions.
+  ############################################################################
+
+  # Asserts that a value is equal to false.
+  # ==== Input
+  # [value : Any] The value to check for equality against false.
+  # [message : String : nil] The message to display if the value is not false.
+  def assert_false(value, message = nil)
+    assert_equal false, value, message
+  end
+
+  # Asserts that a value is equal to true.
+  # ==== Input
+  # [value : Any] The value to check for equality against true.
+  # [message : String : nil] The message to display if the value is not true.
+  def assert_true(value, message = nil)
+    assert_equal true, value, message
+  end
+
+  # Asserts that the negation of a value is true.
+  # ==== Input
+  # [value : Any] The value which will be negated and then asserted.
+  # [message : String : nil] The message to display if the assertion fails.
+  def assert_not(value, message = nil)
+    assert !value, message
+  end
+
+  # Assert that an array has a specified number of elements.
+  # ==== Input
+  # [array : Array] The array that will have it's length checked.
+  # [length : Fixnum] The length that the array should be.
+  # [message : String : nil] The message to display if the assertion fails.
+  def assert_array_count(array, length, message = nil)
+    if message.nil?
+      message = "#{array} has #{array.length} item(s), " +
+        "but was expected to have #{length}."
+    end
+
+    assert array.length == length, message
+  end
+
+  ############################################################################
+  # Assertions - Stack trace.
+  ############################################################################
+
+  # Asserts that a method was called on a class.
+  # ==== Input
+  # [method_name : String] The name of the method to check for.
+  # [class_name : String : @class.name] The name of the class
+  #                                     on which <tt>method_name</tt>
+  #                                     should have been invoked.
+  def assert_method(method_name, class_name = @class.name)
+    assert method_called?(method_name.to_sym, class_name),
+      "#{class_name}.#{method_name} has not been called."
+  end
+
+  # Asserts that a method was not called on a class.
+  # ==== Input
+  # [method_name : String] The name of the method to check for.
+  # [class_name : String : @class.name] The name of the class
+  #                                     on which <tt>method_name</tt>
+  #                                     should not have been invoked.
+  def assert_not_method(method_name, class_name = @class.name)
+    assert !method_called?(method_name.to_sym, class_name),
+      "#{class_name}.#{method_name} should not be called."
+  end
+
+  # Asserts that a method was called with the specified parameters.
+  # ==== Input
+  # [method_name : String] The name of the method to check.
+  # [*args : Array] The parameters that were passed in to the method.
+  def assert_trace_args(method_name, *args)
+    match = false
+
+    list = []
+
+    # Loop through the stack trace to see if the method was called
+    # with the specified arguments.
+    @obj.trace.each do |trace|
+      if trace[:method] == method_name and trace[:args] == args
+        match = true
+        break
+      elsif trace[:method] == method_name
+        list << trace[:args]
+      end
+    end
+
+    assert match,
+      "#{method_name} was not called with the following parameters:\n" +
+      "#{args.join("\n" + '-' * 80 + "\n")}\n" +
+      '*' * 80 + "\n" +
+      "#{method_name} was recorded as follows:\n" +
+      "#{list.join("\n" + '-' * 80 + "\n")}"
+  end
+
+  # Asserts that a method was called with the specified parameters
+  # and returned the specified result.
+  # ==== Input
+  # [method_name : String] The name of the method to check.
+  # [result : Any] The expected result of the method call.
+  # [*args : Array] The parameters that were passed in to the method.
+  def assert_trace_info(method_name, result, *args)
+    match = (@obj.trace.index(
+      {:methd => method_name, :args => args, :result => result}))
+
+    list = []
+
+    # Only get a list of possible results if a match was not found.
+    unless match
+      @obj.trace.each do |trace|
+        if trace[:method] == method_name
+          list << {:args => trace[:args], :result => trace[:result]}
+        end
+      end
+    end
+
+    assert match,
+      "#{method_name} was not called with the following parameters:\n" +
+      "#{args}\n" +
+      "or did not return the following result:\n" +
+      "#{result}\n" +
+      "#{method_name} was recorded as follows:\n" +
+      "#{list.join("\n" + '-' * 80 + "\n")}"
+  end
+end