chemistrykit 2.1.0 → 3.0.0

data/lib/chemistrykit/formula/base.rb

@@ -1,5 +1,8 @@
+# Encoding: utf-8
+
 module ChemistryKit
   module Formula
+    # Base functionality for the Formula class
     class Base
 
       attr_accessor :catalyst
@@ -12,6 +15,6 @@ module ChemistryKit
         self.catalyst = ChemistryKit::Catalyst.new(path_to_file)
       end
 
-    end #Base
-  end #Formula
-end #ChemistryKit
+    end # Base
+  end # Formula
+end # ChemistryKit

data/lib/chemistrykit/parallel_tests_mods.rb

@@ -0,0 +1,55 @@
+# Encoding: utf-8
+
+require 'parallel_tests/rspec/runner'
+require 'parallel_tests/test/runner'
+
+module ParallelTests
+  module RSpec
+    # Monkey Patching the ParallelTest RSpec Runner class to work with CKit's config and binary
+    class Runner < ParallelTests::Test::Runner
+
+      class << self
+
+        def run_tests(test_files, process_number, num_processes, options)
+          exe = executable # expensive, so we cache
+          version = (exe =~ /\brspec\b/ ? 2 : 1)
+
+        # // Beginning of method modifications //
+        # cmd = [exe, options[:test_options], (rspec_2_color if version == 2), spec_opts, *test_files].compact.join(" ")
+        # NOTE: The above line was modified to conform to ckit's command line constraints
+
+          cmd = [exe, options[:test_options]].compact.join(' ')
+          cmd << test_files.join(' ')
+          puts cmd
+
+        # This concatenates the command into `bundle exec ckit brew --beakers=beaker1 beaker2 beaker3 etc`
+        # Which enables each test group to be run in its own command
+        # --beakers= is set in lib/chemkistrykit/cli/cli.rb when parallel_tests is executed using its -o option flag
+
+        # // End of method modifications //
+
+          options = options.merge(env: rspec_1_color) if version == 1
+          execute_command(cmd, process_number, num_processes, options)
+        end
+
+        def determine_executable
+          'bundle exec ckit brew --parallel'
+        end
+
+        def test_file_name
+          'beaker'
+        end
+
+        def test_suffix
+          '_beaker.rb'
+        end
+
+        def runtime_log
+          # TODO This needs to do something.
+          File.join(Dir.getwd, 'evidence', 'parallel_runtime_rspec.log')
+        end
+
+      end # self
+    end # Runner
+  end # RSpec
+end # ParallelTests

data/lib/chemistrykit/shared_context.rb

@@ -1,16 +1,25 @@
-require 'selenium-connect'
+# Encoding: utf-8
+
 require 'rspec/core/shared_context'
+require 'selenium-connect'
+require 'chemistrykit/configuration'
+require 'yaml'
 
 module ChemistryKit
+  # Extends the Rspec Shared Context to include hooks for Selenium Connect
   module SharedContext
     extend RSpec::Core::SharedContext
 
+      config_file = File.join(Dir.getwd, ENV['CONFIG_FILE'])
+      config = ChemistryKit::Configuration.initialize_with_yaml config_file
+
       SeleniumConnect.configure do |c|
-        c.config_file = File.join(Dir.getwd, ENV['CONFIG_FILE'])
+        c.populate_with_hash config.selenium_connect
       end
 
       before(:each) do
         @driver = SeleniumConnect.start
+        @config = config
       end
 
       after(:each) do
@@ -21,5 +30,5 @@ module ChemistryKit
         SeleniumConnect.finish
       end
 
-  end #SharedContext
-end #ChemistryKit
+  end # SharedContext
+end # ChemistryKit

data/lib/templates/chemistrykit/config.yaml.tt

@@ -1,23 +1,28 @@
-#Setup & Debugging
-jar:
-log:
+# Default Chemisty Kit Configuration File
 
+base_url: http://google.com
+concurrency: 2
+selenium_connect:
+    #Setup & Debugging
+    jar:
+    log:
 
-#Where to run your tests
-host: 'localhost'
-port: #set to 4444 by default
 
+    #Where to run your tests
+    host: 'localhost'
+    port: #set to 4444 by default
 
-#Browser & Host
-browser:      'firefox'
-browser_path:
-profile_path:
-profile_name:
 
+    #Browser & Host
+    browser:      'firefox'
+    browser_path:
+    profile_path:
+    profile_name:
 
-#Saucelabs
-os:
-sauce_username:
-sauce_api_key:
-browser_version:
-description:
+
+    #Saucelabs
+    os:
+    sauce_username:
+    sauce_api_key:
+    browser_version:
+    description:

data/lib/templates/chemistrykit/formulas/lib/formula.rb

@@ -1,4 +1,7 @@
+# Encoding: utf-8
+
+# this is where you can define generic helper functions that are inhereted by
+# the rest of your formulas
 class Formula < ChemistryKit::Formula::Base
-  #this is where you can define generic helper functions that are inhereted by
-  #the rest of your formulas
+
 end

data/spec/chemistrykit/catalyst_spec.rb

@@ -1,3 +1,5 @@
+# Encoding: utf-8
+
 require 'spec_helper'
 
 describe ChemistryKit::Catalyst do
@@ -6,7 +8,7 @@ describe ChemistryKit::Catalyst do
 
     Dir.mkdir(File.join(TEST_TMP_PATH, 'catalyst'))
     @data_file = File.join(TEST_TMP_PATH, 'catalyst', 'catalyst_data.csv')
-    File.open(@data_file, 'w') {|f| f.write("first_key,first_value\nsecond_key,second_value") }
+    File.open(@data_file, 'w') { |f| f.write("first_key,first_value\nsecond_key,second_value") }
     @catalyst = ChemistryKit::Catalyst.new(@data_file)
   end
 
@@ -25,14 +27,8 @@ describe ChemistryKit::Catalyst do
   end
 
   it 'Should throw an exception for a non existant key.' do
-    expect {
-      @catalyst.get_value_for('third_key')
-    }.to raise_error("Unknown \"third_key\"")
-
-    expect {
-      @catalyst.third_key
-    }.to raise_error("Unknown \"third_key\"")
-
+    expect { @catalyst.get_value_for('third_key') }.to raise_error("Unknown \"third_key\"")
+    expect { @catalyst.third_key }.to raise_error("Unknown \"third_key\"")
   end
 
   after(:each) do

data/spec/chemistrykit/cli/helpers/formula_loader_spec.rb

@@ -1,5 +1,7 @@
+# Encoding: utf-8
+
 require 'spec_helper'
-#might be able to use something like this: https://github.com/alexeypetrushin/class_loader
+# might be able to use something like this: https://github.com/alexeypetrushin/class_loader
 
 describe ChemistryKit::CLI::Helpers::FormulaLoader do
 
@@ -13,7 +15,7 @@ describe ChemistryKit::CLI::Helpers::FormulaLoader do
   end
 
   it 'should return ruby files in alphabetical order' do
-    #create some test files
+    # create some test files
     d = File.join(TEST_TMP_PATH, 'formula', 'd.rb')
     a = File.join(TEST_TMP_PATH, 'formula', 'a.rb')
     b = File.join(TEST_TMP_PATH, 'formula', 'b.rb')
@@ -21,15 +23,15 @@ describe ChemistryKit::CLI::Helpers::FormulaLoader do
     FileUtils.touch(a)
     FileUtils.touch(b)
 
-    #ensure the result
+    # ensure the result
     @loader.get_formulas(File.join(TEST_TMP_PATH, 'formula')).should eq [a, b, d]
 
   end
 
   it 'should order files in child directories before parent directories' do
     Dir.mkdir(File.join(TEST_TMP_PATH, 'formula', 'child'))
-    d = File.join(TEST_TMP_PATH, 'formula', 'child' ,'d.rb')
-    b = File.join(TEST_TMP_PATH, 'formula', 'child' ,'b.rb')
+    d = File.join(TEST_TMP_PATH, 'formula', 'child', 'd.rb')
+    b = File.join(TEST_TMP_PATH, 'formula', 'child', 'b.rb')
     a = File.join(TEST_TMP_PATH, 'formula', 'a.rb')
     c = File.join(TEST_TMP_PATH, 'formula', 'c.rb')
     FileUtils.touch(d)
@@ -43,8 +45,8 @@ describe ChemistryKit::CLI::Helpers::FormulaLoader do
   it 'should load directories in alphabetical order' do
     Dir.mkdir(File.join(TEST_TMP_PATH, 'formula', 'abby'))
     Dir.mkdir(File.join(TEST_TMP_PATH, 'formula', 'road'))
-    d = File.join(TEST_TMP_PATH, 'formula', 'abby' ,'d.rb')
-    b = File.join(TEST_TMP_PATH, 'formula', 'road' ,'b.rb')
+    d = File.join(TEST_TMP_PATH, 'formula', 'abby', 'd.rb')
+    b = File.join(TEST_TMP_PATH, 'formula', 'road', 'b.rb')
     FileUtils.touch(d)
     FileUtils.touch(b)
     @loader.get_formulas(File.join(TEST_TMP_PATH, 'formula')).should eq [d, b]
@@ -53,8 +55,8 @@ describe ChemistryKit::CLI::Helpers::FormulaLoader do
   it 'should load any lib directory before any other' do
     Dir.mkdir(File.join(TEST_TMP_PATH, 'formula', 'lib'))
     Dir.mkdir(File.join(TEST_TMP_PATH, 'formula', 'abby'))
-    d = File.join(TEST_TMP_PATH, 'formula', 'lib' ,'d.rb')
-    b = File.join(TEST_TMP_PATH, 'formula', 'abby' ,'b.rb')
+    d = File.join(TEST_TMP_PATH, 'formula', 'lib', 'd.rb')
+    b = File.join(TEST_TMP_PATH, 'formula', 'abby', 'b.rb')
     FileUtils.touch(d)
     FileUtils.touch(b)
     @loader.get_formulas(File.join(TEST_TMP_PATH, 'formula')).should eq [d, b]
@@ -66,11 +68,11 @@ describe ChemistryKit::CLI::Helpers::FormulaLoader do
     Dir.mkdir(File.join(TEST_TMP_PATH, 'formula', 'abby', 'lib'))
     Dir.mkdir(File.join(TEST_TMP_PATH, 'formula', 'abby', 'road'))
 
-    a = File.join(TEST_TMP_PATH, 'formula', 'lib' ,'a.rb')
-    c = File.join(TEST_TMP_PATH, 'formula', 'abby' ,'c.rb')
+    a = File.join(TEST_TMP_PATH, 'formula', 'lib', 'a.rb')
+    c = File.join(TEST_TMP_PATH, 'formula', 'abby', 'c.rb')
     b = File.join(TEST_TMP_PATH, 'formula', 'b.rb')
-    d = File.join(TEST_TMP_PATH, 'formula', 'abby' , 'lib', 'd.rb')
-    e = File.join(TEST_TMP_PATH, 'formula', 'abby' , 'road', 'e.rb')
+    d = File.join(TEST_TMP_PATH, 'formula', 'abby', 'lib', 'd.rb')
+    e = File.join(TEST_TMP_PATH, 'formula', 'abby', 'road', 'e.rb')
 
     FileUtils.touch(a)
     FileUtils.touch(b)

data/spec/chemistrykit/configuration_spec.rb

@@ -0,0 +1,56 @@
+# Encoding: utf-8
+
+require 'spec_helper'
+
+describe ChemistryKit::Configuration do
+
+  VALID_BASE_URL = 'http://google.com'
+  VALID_CONCURRENCY = 1
+  VALID_CONFIG_FILE = 'config.yaml'
+
+  before(:each) do
+    @valid_selenium_connect_hash = { log: 'evidence', host: 'localhost' }
+    @valid_config_hash = {
+      base_url: VALID_BASE_URL,
+      concurrency: VALID_CONCURRENCY,
+      selenium_connect: @valid_selenium_connect_hash
+    }
+  end
+
+  def validate_config(config)
+    config.concurrency.should eq VALID_CONCURRENCY
+    config.base_url.should eq VALID_BASE_URL
+    config.selenium_connect.should eq @valid_selenium_connect_hash
+  end
+
+  it 'should initialize with sane defaults' do
+    config = ChemistryKit::Configuration.new({})
+    config.concurrency.should eq 1
+  end
+
+  it 'should initialize with a hash of configurations' do
+    validate_config ChemistryKit::Configuration.new(@valid_config_hash)
+  end
+
+  it 'can be initialized staticlly with a yaml file' do
+    yaml_file = File.join(Dir.pwd, 'spec', 'support', VALID_CONFIG_FILE)
+    validate_config ChemistryKit::Configuration.initialize_with_yaml yaml_file
+  end
+
+  it 'should throw an exception for unsupported config variable' do
+    expect do
+      ChemistryKit::Configuration.new bad: 'config-value'
+    end.to raise_error ArgumentError, 'The config key: "bad" is unknown!'
+  end
+
+  it 'should throw an error if concurrency is configured and the host is not saucelabs' do
+    expect do
+      config_hash = {
+      base_url: VALID_BASE_URL,
+      concurrency: 2,
+      selenium_connect: @valid_selenium_connect_hash
+      }
+      ChemistryKit::Configuration.new(config_hash)
+    end.to raise_error ArgumentError, 'Concurrency is only supported for the host: "saucelabs"!'
+  end
+end

data/spec/chemistrykit/formula/base_spec.rb

@@ -1,15 +1,17 @@
+# Encoding: utf-8
+
 require 'spec_helper'
 
 describe ChemistryKit::Formula::Base do
 
   before(:each) do
-    #ideally we should mock the driver and not pass in nil
+    # ideally we should mock the driver and not pass in nil
     driver = nil
     @formula_base = ChemistryKit::Formula::Base.new(driver)
 
     Dir.mkdir(File.join(TEST_TMP_PATH, 'catalyst'))
     @data_file = File.join(TEST_TMP_PATH, 'catalyst', 'catalyst_data.csv')
-    File.open(@data_file, 'w') {|f| f.write("first_key,first_value\nsecond_key,second_value") }
+    File.open(@data_file, 'w') { |f| f.write("first_key,first_value\nsecond_key,second_value") }
     @catalyst = ChemistryKit::Catalyst.new(@data_file)
   end
 

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# Encoding: utf-8
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # Require this file using `require "spec_helper"` to ensure that it is only
@@ -8,10 +10,11 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'fileutils'
-#not sure it this is the right way to include all the files under test.
+# not sure it this is the right way to include all the files under test.
 require_relative '../lib/chemistrykit/cli/helpers/formula_loader'
 require_relative '../lib/chemistrykit/formula/base'
 require_relative '../lib/chemistrykit/catalyst'
+require_relative '../lib/chemistrykit/configuration'
 
 TEST_TMP_PATH = File.join(Dir.pwd, 'build', 'tmp')
 

data/spec/support/config.yaml

@@ -0,0 +1,7 @@
+# Default Chemisty Kit Configuration File
+
+base_url: http://google.com
+concurrency: 1
+selenium_connect:
+    log: 'evidence'
+    host: 'localhost'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chemistrykit
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2013-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -99,7 +99,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -107,7 +107,39 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: parallel_tests
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -172,7 +204,23 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 10.0.3
-description: Automated build process
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Now with concurrent tests
 email:
 - dave@arrgyle.com
 - jason@arrgyle.com
@@ -183,6 +231,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .rubocop.yml
 - .ruby-gemset
 - .ruby-version
 - .travis.yml
@@ -197,7 +246,9 @@ files:
 - chemistrykit.gemspec
 - features/brew.feature
 - features/catalyst.feature
+- features/concurrency.feature
 - features/exit_status.feature
+- features/global-config.feature
 - features/load_page_objects.feature
 - features/multi-config.feature
 - features/new.feature
@@ -210,7 +261,9 @@ files:
 - lib/chemistrykit/cli/formula.rb
 - lib/chemistrykit/cli/helpers/formula_loader.rb
 - lib/chemistrykit/cli/new.rb
+- lib/chemistrykit/configuration.rb
 - lib/chemistrykit/formula/base.rb
+- lib/chemistrykit/parallel_tests_mods.rb
 - lib/chemistrykit/shared_context.rb
 - lib/templates/beaker.tt
 - lib/templates/beaker_with_formula.tt
@@ -224,8 +277,10 @@ files:
 - lib/templates/formula.tt
 - spec/chemistrykit/catalyst_spec.rb
 - spec/chemistrykit/cli/helpers/formula_loader_spec.rb
+- spec/chemistrykit/configuration_spec.rb
 - spec/chemistrykit/formula/base_spec.rb
 - spec/spec_helper.rb
+- spec/support/config.yaml
 homepage: https://github.com/arrgyle/chemistrykit
 licenses:
 - MIT
@@ -247,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3509311149288293585
+      hash: -488486412254778435
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -258,7 +313,9 @@ summary: A simple and opinionated web testing framework for Selenium that follow
 test_files:
 - features/brew.feature
 - features/catalyst.feature
+- features/concurrency.feature
 - features/exit_status.feature
+- features/global-config.feature
 - features/load_page_objects.feature
 - features/multi-config.feature
 - features/new.feature
@@ -266,5 +323,7 @@ test_files:
 - features/support/env.rb
 - spec/chemistrykit/catalyst_spec.rb
 - spec/chemistrykit/cli/helpers/formula_loader_spec.rb
+- spec/chemistrykit/configuration_spec.rb
 - spec/chemistrykit/formula/base_spec.rb
 - spec/spec_helper.rb
+- spec/support/config.yaml