SimpliTest 0.0.4 → 0.0.5

data/lib/SimpliTest/config/configuration.rb

@@ -1,107 +1,107 @@
-require "yaml"
-require 'SimpliTest/config/directory_paths'
-# Loads configuration from satelite projects
-module SimpliTest
-  @config = {
-    :support_directory => nil,
-    :environments_file => nil,
-    :pages_file => nil,
-    :selectors_file => nil,
-    :settings_file => nil,
-    :environments => nil,
-    :pages => nil,
-    :selectors => nil,
-    :settings => nil,
-    :environment => nil
-  }
-  @valid_config_keys = @config.keys
-
-  class << self
-
-    #TODO: Improve the documentation below
-=begin
-****************************************************************
-                Load Order/ Dependencies
-****************************************************************
-
-          ********TEST PROJECTS****************
-          In Test Projects, first load this file
-          Then set any config variables
-          Then load the environments file in the @config_dir
-          The environments file loads the steps directory
-          Steps Directory is self sufficient (no external files need to be loaded)
-          **************************************
-
-          ********BIN STUBS*********************
-          The gem has one bin stub: SimpliTest 
-          This simply executes a method in the Main class with @cli_directory
-          The Main class in the cli dir requires @helpers_dir and @tasks_dir
-          ***************************************
-
-          ********RAKE TASKS*********************
-          Some cli commands execute rake tasks in the @tasks_dir
-          @tasks_dir requires @helpers_dir
-          ***************************************
-
-*****************************************************************
-=end
-
-    def configure(opts={})
-      opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
-      load_configuration
-    end
-
-    def default_path_for(key)
-      File.join(@config[:support_directory], 'config', "#{key.to_s}.yml")
-    end
-
-    def read_from(path_to_file)
-      begin
-        YAML::load(IO.read(path_to_file))
-      rescue Errno::ENOENT
-        alert ("Expected to find #{path_to_file} but did not find it.")
-      rescue Psych::SyntaxError
-        alert "#{path_to_file} YAML file contains invalid syntax. Please correct it"
-      end
-    end
-
-    def config
-      @config
-    end
-
-    def load_configuration
-      begin
-        @config[:environments] = read_from(@config[:environments_file] || default_path_for(:environments))
-        @config[:pages] = read_from(@config[:pages_file] || default_path_for(:pages))
-        @config[:selectors] = read_from(@config[:selectors_file] || default_path_for(:selectors))
-        @config[:settings] = read_from(@config[:settings_file] || default_path_for(:settings))
-        @config[:environment] = ENV['ENVIRONMENT'] || @config[:settings]['DEFAULT_ENVIRONMENT'] || @config[:settings][:environments].values.first
-        @valid_config_keys = @config.keys
-      rescue Exception => e
-        alert "There was a problem reading one of the required configuration files\n" + e.message
-      end
-    end
-
-    def driver
-      ENV['SimpliTest_DRIVER'] || @config[:settings]['DRIVER'] || 'selenium'
-    end
-
-    def driver=(name)
-      @config[:driver]=name
-    end
-
-    def mode
-      @config[:settings]['MODE'] || 'REGULAR'
-    end
-
-    def screen_size
-      ENV['SCREEN_SIZE'] || @config[:settings]['SCREEN_SIZE'] || 'Desktop'
-    end
-
-    def wait_for_page_load
-      @config[:settings]['WAIT_FOR_PAGE_LOAD'].to_i rescue 0
-    end
-
-  end #end self << class all methods below this are instance methods
-
-end
+require "yaml"
+require 'SimpliTest/config/directory_paths'
+# Loads configuration from satelite projects
+module SimpliTest
+  @config = {
+    :support_directory => nil,
+    :environments_file => nil,
+    :pages_file => nil,
+    :selectors_file => nil,
+    :settings_file => nil,
+    :environments => nil,
+    :pages => nil,
+    :selectors => nil,
+    :settings => nil,
+    :environment => nil
+  }
+  @valid_config_keys = @config.keys
+
+  class << self
+
+    #TODO: Improve the documentation below
+=begin
+****************************************************************
+                Load Order/ Dependencies
+****************************************************************
+
+          ********TEST PROJECTS****************
+          In Test Projects, first load this file
+          Then set any config variables
+          Then load the environments file in the @config_dir
+          The environments file loads the steps directory
+          Steps Directory is self sufficient (no external files need to be loaded)
+          **************************************
+
+          ********BIN STUBS*********************
+          The gem has one bin stub: SimpliTest 
+          This simply executes a method in the Main class with @cli_directory
+          The Main class in the cli dir requires @helpers_dir and @tasks_dir
+          ***************************************
+
+          ********RAKE TASKS*********************
+          Some cli commands execute rake tasks in the @tasks_dir
+          @tasks_dir requires @helpers_dir
+          ***************************************
+
+*****************************************************************
+=end
+
+    def configure(opts={})
+      opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
+      load_configuration
+    end
+
+    def default_path_for(key)
+      File.join(@config[:support_directory], 'config', "#{key.to_s}.yml")
+    end
+
+    def read_from(path_to_file)
+      begin
+        YAML::load(IO.read(path_to_file))
+      rescue Errno::ENOENT
+        alert ("Expected to find #{path_to_file} but did not find it.")
+      rescue Psych::SyntaxError
+        alert "#{path_to_file} YAML file contains invalid syntax. Please correct it"
+      end
+    end
+
+    def config
+      @config
+    end
+
+    def load_configuration
+      begin
+        @config[:environments] = read_from(@config[:environments_file] || default_path_for(:environments))
+        @config[:pages] = read_from(@config[:pages_file] || default_path_for(:pages))
+        @config[:selectors] = read_from(@config[:selectors_file] || default_path_for(:selectors))
+        @config[:settings] = read_from(@config[:settings_file] || default_path_for(:settings))
+        @config[:environment] = ENV['ENVIRONMENT'] || @config[:settings]['DEFAULT_ENVIRONMENT'] || @config[:settings][:environments].values.first
+        @valid_config_keys = @config.keys
+      rescue Exception => e
+        alert "There was a problem reading one of the required configuration files\n" + e.message
+      end
+    end
+
+    def driver
+      ENV['SimpliTest_DRIVER'] || @config[:settings]['DRIVER'] || 'selenium'
+    end
+
+    def driver=(name)
+      @config[:driver]=name
+    end
+
+    def mode
+      @config[:settings]['MODE'] || 'REGULAR'
+    end
+
+    def screen_size
+      ENV['SCREEN_SIZE'] || @config[:settings]['SCREEN_SIZE'] || 'Desktop'
+    end
+
+    def wait_for_page_load
+      @config[:settings]['WAIT_FOR_PAGE_LOAD'].to_i rescue 0
+    end
+
+  end #end self << class all methods below this are instance methods
+
+end

data/lib/SimpliTest/config/directory_paths.rb

@@ -1,36 +1,36 @@
-require 'yaml'
-require 'pathname'
-require 'SimpliTest/helpers/project_setup'
-# exports instance variables for various directories of interest in the gem and the satelite projects
-module SimpliTest
-  extend ProjectSetupHelpers
-  @config_dir = File.dirname(__FILE__)
-  @SimpliTest_dir = Pathname.new( @config_dir).parent.to_s
-  @helpers_dir = File.join(@SimpliTest_dir, 'helpers')
-  @steps_dir = File.join(@SimpliTest_dir, 'steps')
-  @step_helpers_dir = File.join(@helpers_dir, 'step_helpers')
-  @templates_dir = File.join(@SimpliTest_dir, 'templates')
-  @lib_dir = Pathname.new(@SimpliTest_dir).parent.to_s
-  @tasks_dir = File.join(@SimpliTest_dir, 'tasks')
-  @gem_dir = Pathname.new(@lib_dir).parent.to_s
-  class << self
-    #TODO: Using method missing despite all the reasons not to
-    #FIXME: Get rid of this
-    def method_missing(meth, *args, &block)
-      if match = meth.to_s.match(/^config_(.+)$/)
-        config[match[1].to_sym]
-      elsif match = meth.to_s.match(/^path_to_(.+)$/)
-        instance_variable_get("@#{match[1]}")
-      else
-        super # You *must* call super if you don't handle the
-        # method, otherwise you'll mess up Ruby's method
-        # lookup.
-      end
-    end
-
-    def respond_to_missing?(method_name, include_private = false)
-      method_name.to_s.start_with?('config_') || meth.to_s.start_with?('path_to_') || super
-    end
-  end
-
-end
+require 'yaml'
+require 'pathname'
+require 'SimpliTest/helpers/project_setup'
+# exports instance variables for various directories of interest in the gem and the satelite projects
+module SimpliTest
+  extend ProjectSetupHelpers
+  @config_dir = File.dirname(__FILE__)
+  @SimpliTest_dir = Pathname.new( @config_dir).parent.to_s
+  @helpers_dir = File.join(@SimpliTest_dir, 'helpers')
+  @steps_dir = File.join(@SimpliTest_dir, 'steps')
+  @step_helpers_dir = File.join(@helpers_dir, 'step_helpers')
+  @templates_dir = File.join(@SimpliTest_dir, 'templates')
+  @lib_dir = Pathname.new(@SimpliTest_dir).parent.to_s
+  @tasks_dir = File.join(@SimpliTest_dir, 'tasks')
+  @gem_dir = Pathname.new(@lib_dir).parent.to_s
+  class << self
+    #TODO: Using method missing despite all the reasons not to
+    #FIXME: Get rid of this
+    def method_missing(meth, *args, &block)
+      if match = meth.to_s.match(/^config_(.+)$/)
+        config[match[1].to_sym]
+      elsif match = meth.to_s.match(/^path_to_(.+)$/)
+        instance_variable_get("@#{match[1]}")
+      else
+        super # You *must* call super if you don't handle the
+        # method, otherwise you'll mess up Ruby's method
+        # lookup.
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      method_name.to_s.start_with?('config_') || meth.to_s.start_with?('path_to_') || super
+    end
+  end
+
+end

data/lib/SimpliTest/config/environment.rb

@@ -1,67 +1,67 @@
-require 'capybara'
-require 'capybara/cucumber'
-require 'capybara/dsl'
-require 'rspec'
-require "nokogiri"
-require 'open-uri'
-require_relative './local_environment'
-require_relative './screen_size'
-require_relative './steps'
-require File.join(SimpliTest.path_to_helpers_dir, 'project_setup')
-RSpec.configure do |config|
-  config.include Capybara::DSL
-end
-
-Capybara.save_and_open_page_path = File.expand_path(File.join(SimpliTest.config_support_directory,'../../tmp')) if SimpliTest.config[:support_directory]
-Capybara.default_max_wait_time = 2
-
-driver = SimpliTest.driver #default is selenium
-profiles_dir = File.join(File.dirname(__FILE__), 'profiles')
-profiles = {
-  'phantomjs' => 'phantom',
-  'phantom_debug' => 'phantom_debug',
-  'chrome' => 'chrome',
-  'selenium' => 'selenium',
-  'ie' => 'internet_explorer',
-  'fire' => 'firefox'
-}
-profile = File.join profiles_dir, profiles[driver]
-require profile
-puts "Loaded Environment"
-
-
-
-#Leave the window open after a test fails if this tag is provided
-After('@leave_the_window_open') do |scenario|
-  if scenario.respond_to?(:status) && scenario.status == :failed
-    print "Step Failed. Press Return to close browser"
-    STDIN.getc
-  end
-end
-
-Before do |s|
-#  if SimpliTest.env_or_setting('JIRA_INTEGRATION_ENABLED') && SimpliTest.env_or_setting('JIRA_URL')
- #   $has_jira_info ||= false
- #   return $has_jira_info if $has_jira_info
- #   $jira = SimpliTest::JiraIntegration.load_project_details
- #   $has_jira_info = true
- # end
-end
-
-After do |s|
-
-  #Reuse Browser sessions
-if SimpliTest.config[:settings]['REUSE_BROWSER_SESSIONS']
-  Capybara.current_session.instance_variable_set('@touched', !SimpliTest.config[:settings]['REUSE_BROWSER_SESSIONS'])
-else
-  Capybara.current_session.instance_variable_set('@touched', true)
-end  
-
-  # Tell Cucumber to quit after this scenario is done - if it failed.
-        #Cucumber.wants_to_quit = true if SimpliTest.config[:settings][QUIT_ON_FAIL] && s.failed?
-        #zephyr_reporter = SimpliTest::JiraIntegration.new(s)
-        #zephyr_reporter.report
-end
-
-
-
+require 'capybara'
+require 'capybara/cucumber'
+require 'capybara/dsl'
+require 'rspec'
+require "nokogiri"
+require 'open-uri'
+require_relative './local_environment'
+require_relative './screen_size'
+require_relative './steps'
+require File.join(SimpliTest.path_to_helpers_dir, 'project_setup')
+RSpec.configure do |config|
+  config.include Capybara::DSL
+end
+
+Capybara.save_and_open_page_path = File.expand_path(File.join(SimpliTest.config_support_directory,'../../tmp')) if SimpliTest.config[:support_directory]
+Capybara.default_max_wait_time = 2
+
+driver = SimpliTest.driver #default is selenium
+profiles_dir = File.join(File.dirname(__FILE__), 'profiles')
+profiles = {
+  'phantomjs' => 'phantom',
+  'phantom_debug' => 'phantom_debug',
+  'chrome' => 'chrome',
+  'selenium' => 'selenium',
+  'ie' => 'internet_explorer',
+  'fire' => 'firefox'
+}
+profile = File.join profiles_dir, profiles[driver]
+require profile
+puts "Loaded Environment"
+
+
+
+#Leave the window open after a test fails if this tag is provided
+After('@leave_the_window_open') do |scenario|
+  if scenario.respond_to?(:status) && scenario.status == :failed
+    print "Step Failed. Press Return to close browser"
+    STDIN.getc
+  end
+end
+
+Before do |s|
+#  if SimpliTest.env_or_setting('JIRA_INTEGRATION_ENABLED') && SimpliTest.env_or_setting('JIRA_URL')
+ #   $has_jira_info ||= false
+ #   return $has_jira_info if $has_jira_info
+ #   $jira = SimpliTest::JiraIntegration.load_project_details
+ #   $has_jira_info = true
+ # end
+end
+
+After do |s|
+
+  #Reuse Browser sessions
+if SimpliTest.config[:settings]['REUSE_BROWSER_SESSIONS']
+  Capybara.current_session.instance_variable_set('@touched', !SimpliTest.config[:settings]['REUSE_BROWSER_SESSIONS'])
+else
+  Capybara.current_session.instance_variable_set('@touched', true)
+end  
+
+  # Tell Cucumber to quit after this scenario is done - if it failed.
+        #Cucumber.wants_to_quit = true if SimpliTest.config[:settings][QUIT_ON_FAIL] && s.failed?
+        #zephyr_reporter = SimpliTest::JiraIntegration.new(s)
+        #zephyr_reporter.report
+end
+
+
+

data/lib/SimpliTest/config/local_environment.rb

@@ -1,20 +1,20 @@
-module SimpliTest
-  def self.gems_installed?(list)
-    specs = []
-    list.each do |gem|
-      dep = Gem::Dependency.new(gem)
-      specs << !dep.matching_specs.empty?
-    end
-    specs.uniq == [true]
-  end
-
-  def self.chromedriver_detected?
-    installed = `chromedriver --help` rescue false
-    installed ? true : false
-  end
-
-  def self.env_or_setting(setting_name)
-    ENV[setting_name] || SimpliTest.config_settings[setting_name]
-  end
-end
-
+module SimpliTest
+  def self.gems_installed?(list)
+    specs = []
+    list.each do |gem|
+      dep = Gem::Dependency.new(gem)
+      specs << !dep.matching_specs.empty?
+    end
+    specs.uniq == [true]
+  end
+
+  def self.chromedriver_detected?
+    installed = `chromedriver --help` rescue false
+    installed ? true : false
+  end
+
+  def self.env_or_setting(setting_name)
+    ENV[setting_name] || SimpliTest.config_settings[setting_name]
+  end
+end
+