chemistrykit 3.8.0 → 3.8.1

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+#3.8.1 (2013-08-09)
+Cleaned up chemists to use same instance in the formulas and bug fixes
+
+- Bumped version to 3.8.1 to prepare for release.
+- updated docs and moved the chemist aware module require to the base class
+- updated tests and chemist to reflect the mutability of type but not key
+- improved chemists by ensuring the same chemist object is always in play so that different formulas that update it state work together, also fixed a small bug with the loading of formulas by name
+
 #3.8.0 (2013-08-05)
 Implemented the chemists feature to add user data management as well as a simplified strategy for loading formulas
 

data/README.md

@@ -1,4 +1,4 @@
-#ChemistryKit 3.8.0 (2013-08-05)
+#ChemistryKit 3.8.1 (2013-08-09)
 
 [![Gem Version](https://badge.fury.io/rb/chemistrykit.png)](http://badge.fury.io/rb/chemistrykit) [![Build Status](https://travis-ci.org/arrgyle/chemistrykit.png?branch=develop)](https://travis-ci.org/jrobertfox/chef-broiler-platter) [![Code Climate](https://codeclimate.com/github/arrgyle/chemistrykit.png)](https://codeclimate.com/github/arrgyle/chemistrykit) [![Coverage Status](https://coveralls.io/repos/arrgyle/chemistrykit/badge.png?branch=develop)](https://coveralls.io/r/arrgyle/chemistrykit?branch=develop)
 
@@ -114,8 +114,11 @@ module Formulas
     ...
   end
 end
+```
 
+Note that because the `Chemist` is set after the instantiation of your formula by the `FormulaLab` you would *not be able* to do things in the constructor of your formula that depend on a chemist, unless you are explicitly passing in the `Chemist`. We suggest that you keep the instantiation of your page objects separate from the actions they take.
 
+```Ruby
 # my_beaker.rb
 describe "my beaker", :depth => 'shallow' do
   let(:my_formula) { @formula_lab.using('my_formula').with('admin1').mix }
@@ -131,7 +134,7 @@ Here is a summary of the other methods available:
 - `.with_random(type)` - Load a chemist at random from all those matching `type`
 - `.with_first(type)` - Load whatever chemist is first matched by `type`
 
-The FormulaLab will handle the heavy lifting of assembling your formal with a driver and correct user (if the formula needs one).
+The FormulaLab will handle the heavy lifting of assembling your formula with a driver and correct chemist (if the formula needs one). Also note that the specific instance of chemist is cached so that any changes your formula makes to the chemist is reflected in other formulas that use it.
 
 ###Execution Order
 Chemistry Kit executes specs in a random order. This is intentional. Knowing the order a spec will be executed in allows for dependencies between them to creep in. Sometimes unintentionally. By having them go in a random order parallelization becomes a much easier.

data/chemistrykit.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name          = 'chemistrykit'
-  s.version       = '3.8.0'
+  s.version       = '3.8.1'
   s.platform      = Gem::Platform::RUBY
   s.authors       = ['Dave Haeffner', 'Jason Fox']
   s.email         = ['dave@arrgyle.com', 'jason@arrgyle.com']
   s.homepage      = 'https://github.com/arrgyle/chemistrykit'
   s.summary       = 'A simple and opinionated web testing framework for Selenium that follows convention over configuration.'
-  s.description   = 'Implemented the chemists feature to add user data management as well as a simplified strategy for loading formulas'
+  s.description   = 'Cleaned up chemists to use same instance in the formulas and bug fixes'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)

data/features/chemists.feature

@@ -23,8 +23,6 @@ Feature: Brewing a ChemistryKit project
       """
     And a file named "formulas/chemist_formula.rb" with:
       """
-      require 'chemistrykit/formula/chemist_aware'
-
       module Formulas
         class ChemistFormula < Formula
           include ChemistryKit::Formula::ChemistAware

data/lib/chemistrykit/chemist.rb

@@ -4,7 +4,8 @@ module ChemistryKit
   # representation of the user object for interacting with the system under test
   class Chemist
 
-    attr_reader :key, :type, :data
+    attr_accessor :type
+    attr_reader :data, :key
 
     def initialize(key, type)
       @key = key.to_s
@@ -14,7 +15,7 @@ module ChemistryKit
 
     def data=(data)
       data.each do |key, value|
-        send("#{key}=", value)
+        send("#{key}=", value) unless key == :key
       end
     end
 

data/lib/chemistrykit/chemist/repository/csv_chemist_repository.rb

@@ -13,6 +13,7 @@ module ChemistryKit
 
         def initialize(csv_path)
           @tables = []
+          @chemist_cache = {}
           files = csv_path.kind_of?(String) ? [csv_path] : csv_path
 
           files.each do |file|
@@ -32,7 +33,8 @@ module ChemistryKit
         def load_chemist_by_key(key)
           @tables.each do |table|
             chemist_data = table.find { |row| row[:key] == key }
-            return make_chemist(key, chemist_data[:type], chemist_data) if chemist_data
+            chemist = make_chemist(key, chemist_data[:type], chemist_data) if chemist_data
+            return fetch_from_cache chemist
           end
           raise ArgumentError, "Chemist for type \"#{key}\" not found!"
         end
@@ -40,13 +42,13 @@ module ChemistryKit
         # Required Method
         # Load the first chemist found for a given type
         def load_first_chemist_of_type(type)
-          load_chemists_of_type(type)[0]
+          fetch_from_cache(load_chemists_of_type(type)[0])
         end
 
         # Required Method
         # Loads a chemist at random from all those found with a given type
         def load_random_chemist_of_type(type)
-          load_chemists_of_type(type).sample
+          fetch_from_cache(load_chemists_of_type(type).sample)
         end
 
         protected
@@ -73,6 +75,12 @@ module ChemistryKit
             chemist
           end
 
+          def fetch_from_cache(chemist)
+            return @chemist_cache[chemist.key.to_sym] if @chemist_cache.include?(chemist.key.to_sym)
+            @chemist_cache[chemist.key.to_sym] = chemist
+            fetch_from_cache chemist
+          end
+
       end
     end
   end

data/lib/chemistrykit/formula/base.rb

@@ -1,5 +1,7 @@
 # Encoding: utf-8
 
+require 'chemistrykit/formula/chemist_aware'
+
 module ChemistryKit
   module Formula
     # Base functionality for the Formula class

data/lib/chemistrykit/formula/formula_lab.rb

@@ -53,7 +53,7 @@ module ChemistryKit
 
         def find_formula_file
           Find.find(@formulas_dir) do |path|
-            return path if path =~ /.*#{@formula}\.rb$/
+            return path if path =~ /.*\/#{@formula}\.rb$/
           end
         end
 

data/spec/integration/lib/chemistrykit/formula/formula_lab_spec.rb

@@ -11,6 +11,7 @@ describe ChemistryKit::Formula::FormulaLab do
 
   VALID_BASIC_FORMULA_KEY = 'basic_formula'
   VALID_CHEMIST_FORMULA_KEY = 'chemist_formula'
+  VALID_ALTERNATE_CHEMIST_FORMULA = 'alt_chemist_formula'
 
   before(:each) do
     @stub_driver = double 'Selenium::WebDriver::Driver'
@@ -56,4 +57,16 @@ describe ChemistryKit::Formula::FormulaLab do
     (key == 'ran1' || key == 'ran2').should be_true
   end
 
+  it 'should deliver formulas with the same instance of chemist if indicated' do
+    formula1 = @lab.using(VALID_CHEMIST_FORMULA_KEY).with(VALID_CHEMIST_KEY).mix
+    formula2 = @lab.using(VALID_ALTERNATE_CHEMIST_FORMULA).with(VALID_CHEMIST_KEY).mix
+
+    expect(formula1.chemist).to be(formula2.chemist)
+    formula2.change_chemist_type 'other'
+    formula1.chemist.type.should eq 'other'
+
+    formula1.chemist.type = 'new'
+    formula2.chemist.type.should eq 'new'
+  end
+
 end

data/spec/spec_helper.rb

@@ -21,6 +21,7 @@ require_relative '../lib/chemistrykit/configuration'
 
 require_relative '../spec/support/formulas/sub_module/basic_formula'
 require_relative '../spec/support/formulas/sub_module/chemist_formula'
+require_relative '../spec/support/formulas/sub_module/alt_chemist_formula'
 
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,

data/spec/support/formulas/sub_module/alt_chemist_formula.rb

@@ -0,0 +1,18 @@
+# Encoding: utf-8
+
+require 'chemistrykit/formula/base'
+
+module Formulas
+  module SubModule
+    class AltChemistFormula < ChemistryKit::Formula::Base
+      include ChemistryKit::Formula::ChemistAware
+      def open(url)
+        @driver.get url
+      end
+
+      def change_chemist_type(type)
+        chemist.type = type
+      end
+    end
+  end
+end

data/spec/support/formulas/sub_module/chemist_formula.rb

@@ -1,7 +1,6 @@
 # Encoding: utf-8
 
 require 'chemistrykit/formula/base'
-require 'chemistrykit/formula/chemist_aware'
 
 module Formulas
   module SubModule

data/spec/unit/lib/chemistrykit/chemist/repository/csv_chemist_repository_spec.rb

@@ -96,4 +96,17 @@ describe ChemistryKit::Chemist::Repository::CsvChemistRepository do
     repo = ChemistryKit::Chemist::Repository::CsvChemistRepository.new(csv_file)
     repo.should be_an_instance_of ChemistryKit::Chemist::Repository::CsvChemistRepository
   end
+
+  it 'should always return the same instance of any chemist' do
+    chemist1 = @repo.load_chemist_by_key VALID_USER_KEY
+    chemist2 = @repo.load_chemist_by_key VALID_USER_KEY
+    expect(chemist2).to be(chemist1)
+  end
+
+  it 'should always return the same instance of any chemist by first type' do
+    chemist1 = @repo.load_first_chemist_of_type VALID_USER_TYPE
+    chemist2 = @repo.load_first_chemist_of_type VALID_USER_TYPE
+    expect(chemist2).to be(chemist1)
+  end
+
 end

data/spec/unit/lib/chemistrykit/chemist_spec.rb

@@ -28,10 +28,10 @@ describe ChemistryKit::Chemist do
     @chemist.data.should eq my_key: VALID_VALUE
   end
 
-  it 'should not be able to override the other instance variables' do
-    @chemist.type = 'other'
-    @chemist.type.should eq VALID_TYPE
-    @chemist.data.include?(:type).should be_false
+  it 'should not be able to override the key variable' do
+    @chemist.key = 'other'
+    @chemist.key.should eq VALID_KEY
+    @chemist.data.include?(:key).should be_false
   end
 
   it 'should be able to be populated with a hash of arbitrary data' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chemistrykit
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-05 00:00:00.000000000 Z
+date: 2013-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -156,8 +156,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.1
-description: Implemented the chemists feature to add user data management as well
-  as a simplified strategy for loading formulas
+description: Cleaned up chemists to use same instance in the formulas and bug fixes
 email:
 - dave@arrgyle.com
 - jason@arrgyle.com
@@ -229,6 +228,7 @@ files:
 - spec/support/chemists.csv
 - spec/support/config.yaml
 - spec/support/default_chemists.csv
+- spec/support/formulas/sub_module/alt_chemist_formula.rb
 - spec/support/formulas/sub_module/basic_formula.rb
 - spec/support/formulas/sub_module/chemist_formula.rb
 - spec/support/keyless_chemists.csv
@@ -262,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4028715665356631412
+      hash: -2034050010631894604
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -291,6 +291,7 @@ test_files:
 - spec/support/chemists.csv
 - spec/support/config.yaml
 - spec/support/default_chemists.csv
+- spec/support/formulas/sub_module/alt_chemist_formula.rb
 - spec/support/formulas/sub_module/basic_formula.rb
 - spec/support/formulas/sub_module/chemist_formula.rb
 - spec/support/keyless_chemists.csv