chemistrykit 3.7.0 → 3.8.0

data/.rubocop.yml

@@ -3,3 +3,9 @@ LineLength:
 
 MethodLength:
   Max: 30
+
+SymbolName:
+  AllowCamelCase: false
+
+Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+#3.8.0 (2013-08-05)
+Implemented the chemists feature to add user data management as well as a simplified strategy for loading formulas
+
+- Bumped version to 3.8.0 to prepare for release.
+- cleaned up docs a little and ensured the default chemists csv file wouldnt cause a failure if left unpopulated
+- added a uuid injector for a token in csv files
+- integrated the fomula lab into the suite runner and added basic cucumber tests
+- built out the rest of the formula lab and integration tests
+- updated templates to create the default chemists folder
+- upped the flog limits... still need to understand how that will help
+- updated chemist and chemist repository to include key, as well as selection by key, random, or first of type
+- updated documentation of new changes
+- built out the rest of the csv chemist repository
+- started building out the user data repository from a csv file.
+- built out a basic chemist class
+- added module to define chemist aware for the formulas to include
+- added reek and rubocop to the guard file
+- moved dev dependencies to gemfile, added in new code quality checks, fixed some code issues found by rubocop, updated rake tasks
+- updated selenium connect version
+- added animoto mention to friends section
+
 #3.7.0 (2013-07-24)
 updated evidence to put in test based folders and added configuration for the retry functionality
 

data/Gemfile

@@ -2,3 +2,16 @@ source "https://rubygems.org"
 
 # Specify dependencies in chemistrykit.gemspec
 gemspec
+
+gem 'aruba', '~> 0.5.1'
+gem 'cucumber', '~> 1.2.1'
+gem 'rake', '~> 10.0.3'
+gem 'rubocop', git: 'https://github.com/bbatsov/rubocop.git', branch: 'master'
+gem 'guard-rspec', '~> 3.0.2'
+gem 'coveralls', '~> 0.6.7'
+gem 'flog'
+gem 'flay'
+gem 'ruby2ruby'
+gem 'reek', '1.3.1'
+gem 'guard-reek'
+gem 'guard-rubocop'

data/Guardfile

@@ -1,5 +1,14 @@
+# Encoding: utf-8
+
 guard :rspec do
   watch(%r{^spec/unit/.+_spec\.rb$})
+  watch(%r{^spec/integration/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/unit/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/integration/lib/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
 end
+
+guard :rubocop, all_on_start: false do
+  watch(%r{^spec/.+\.rb$})
+  watch(%r{^lib/.+\.rb$})
+end

data/README.md

@@ -1,10 +1,10 @@
-#ChemistryKit 3.7.0 (2013-07-24)
+#ChemistryKit 3.8.0 (2013-08-05)
 
 [![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)
 
 ### A simple and opinionated web testing framework for Selenium WebDriver
 
-This framework was designed to help you get started with Selenium WebDriver quickly, to grow as needed, and to avoid common pitfalls by following convention over configuration. To checkout the user group go [here](https://groups.google.com/forum/#!forum/chemistrykit-users).
+This framework was designed to help you get started with Selenium WebDriver quickly, to grow as needed, and to avoid common pitfalls by following convention over configuration. To checkout the user group go [here](https://groups.google.com/forum/#!forum/chemistrykit-users). For more usage examples check out our [Friends](#friends) section!
 
 
 ChemistryKit's inspiration comes from the Saunter Selenium framework which is available in Python and PHP. You can find more about it [here](http://element34.ca/products/saunter).
@@ -17,6 +17,7 @@ All the documentation for ChemistryKit can be found in this README, organized as
 - [Command Line Usage](#command-line-usage)
 - [Contribution Guidelines](#contribution-guidelines)
 - [Deployment](#deployment)
+- [Friends](#friends)
 
 ##Getting Started
 
@@ -84,6 +85,54 @@ Code in the `formula` directory can be used to build out page objects and helper
 
 So for example if you have a `alpha_page.rb` file in your formulas directory that depends on a `helpers.rb` file, then you best put the `helpers.rb` file in the `lib` directory so it is loaded before the file that depends on it.
 
+###Chemists! The Users of your System Under Test
+With ChemistryKit we made it simple to encapsulate data about a particular user that is "using" your application that you are testing. We call them chemists. When you create a new test harness there will be a `chemists` folder that contains an empty `chemists.csv` file with only the words `key` and `type` at the top. In this folder you can create any number of files with arbitrary user data, **just make sure to include the `key` and`type` headings!** such as:
+
+    /chemists/my_valid_users.csv
+    /chemists/my_bad_users.csv
+
+An example file might look like this:
+
+    Key,Type,Email,Name,Password
+    admin1,admin,admin@email.com,Mr. Admin,abc123$
+    normal1,normal,normal@email.com,Ms. Normal,test123%
+    normal2,normal,normal2@email.com,Ms. Normals,test123%
+
+The `key` should be unique so you can pick a specific user, the type, allows you to group users to aid in their selection ad detailed below.
+
+You can also put a special token in your csv files: `{{UUID}}` which will be replaced on runtime with a unique identifier. This can be helpful for ensuring certain date is unique across your tests, especially with concurrent runs.
+
+Chemists are made available to your formulas simply by including the `ChemistAware` module in your formula, and loading the formula with the instance of `FormulaLab` provided to your beakers:
+
+```Ruby
+# my_formula.rb
+module Formulas
+  class MyFormula < Formula
+    include ChemistryKit::Formula::ChemistAware
+    ...
+    if chemist.email ...
+    ...
+  end
+end
+
+
+# my_beaker.rb
+describe "my beaker", :depth => 'shallow' do
+  let(:my_formula) { @formula_lab.using('my_formula').with('admin1').mix }
+  # or
+  let(:my_other_formula) { @formula_lab.formula.mix('my_other_formula') }
+  ...
+end
+```
+
+Here is a summary of the other methods available:
+
+- `.with(key)` - Load a specific chemist by the key.
+- `.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).
+
 ###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.
 
@@ -211,3 +260,11 @@ And another to finish the release:
     rake release_finish['A helpful tag message that will be included in the gemspec.']
 
 This handles updating the change log, committing, and tagging the release.
+
+## Friends
+
+Below you can find some honorable mentions of those friends that are using ChemistryKit:
+
+![image](http://d14f1fnryngsxt.cloudfront.net/images/logo/animotologotext_f78c60cbbd36837c7aad596e3b3bb019.svg)
+
+We are proud that [Animoto](http://animoto.com/) uses ChemistryKit to help them test their awesome web app.

data/Rakefile

@@ -4,14 +4,21 @@ require 'bundler/gem_tasks'
 require 'cucumber'
 require 'cucumber/rake/task'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'flog_task'
+require 'flay_task'
+require 'reek/rake/task'
 
 task default: :build
 
 desc 'Runs standard build activities.'
-task build: [:clean, :prepare, :rubocop, :unit, :integration]
+task build: [:clean, :prepare, :quality, :unit, :integration]
 
-desc 'Runs standard build activities for ci server.'
-task build_full: [:clean, :prepare, :rubocop, :unit, :integration, :system]
+desc 'Runs full build activities.'
+task build_full: [:clean, :prepare, :quality, :unit, :integration, :system]
+
+desc 'Runs quality checks.'
+task quality: [:rubocop, :reek, :flog_total, :flog_average, :flay]
 
 desc 'Removes the build directory.'
 task :clean do
@@ -40,9 +47,30 @@ end
 
 Cucumber::Rake::Task.new(:system)
 
-desc 'Runs code quality check'
-task :rubocop do
-  sh 'rubocop'
+Rubocop::RakeTask.new
+
+# TODO: lower the quality score and improve the code!
+FlogTask.new :flog_total, 2000 do |t|
+  t.method = :total_score
+  t.verbose = true
+end
+
+# TODO: lower the quality score and improve the code!
+FlogTask.new :flog_average, 20 do |t|
+  t.method = :average
+  t.verbose = true
+end
+
+# TODO: lower the quality score and improve the code!
+FlayTask.new :flay, 2000 do |t|
+  t.verbose = true
+end
+
+# TODO: fix all the smells and turn on failing on error
+Reek::Rake::Task.new do |t|
+    t.fail_on_error = false
+    t.verbose = false
+    t.reek_opts = '--quiet'
 end
 
 # TODO This could probably be more cleanly automated

data/chemistrykit.gemspec

@@ -2,13 +2,13 @@
 
 Gem::Specification.new do |s|
   s.name          = 'chemistrykit'
-  s.version       = '3.7.0'
+  s.version       = '3.8.0'
   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   = 'updated evidence to put in test based folders and added configuration for the retry functionality'
+  s.description   = 'Implemented the chemists feature to add user data management as well as a simplified strategy for loading formulas'
   s.license       = 'MIT'
 
   s.files         = `git ls-files`.split($/)
@@ -24,16 +24,8 @@ Gem::Specification.new do |s|
   s.add_dependency 'builder', '~> 3.2.2'
   s.add_dependency 'selenium-webdriver', '~> 2.29.0'
   s.add_dependency 'rest-client', '~> 1.6.7'
-  s.add_dependency 'selenium-connect', '~> 3.3.1'
+  s.add_dependency 'selenium-connect', '~> 3.4.0'
   s.add_dependency 'parallel_tests', '~> 0.15.0'
   s.add_dependency 'parallel', '~> 0.7.0'
   s.add_dependency 'rspec-retry', '~> 0.2.1'
-
-  s.add_development_dependency 'rspec', '~> 2.14.1'
-  s.add_development_dependency 'aruba', '~> 0.5.1'
-  s.add_development_dependency 'cucumber', '~> 1.2.1'
-  s.add_development_dependency 'rake', '~> 10.0.3'
-  s.add_development_dependency 'rubocop', '~> 0.9.0'
-  s.add_development_dependency 'guard-rspec', '~> 3.0.2'
-  s.add_development_dependency 'coveralls', '~> 0.6.7'
 end

data/exceptions.reek

@@ -0,0 +1,3 @@
+FeatureEnvy:
+  exclude:
+    - method_missing # the very nature of handling the method name requires this

data/features/chemists.feature

@@ -0,0 +1,123 @@
+Feature: Brewing a ChemistryKit project
+
+  Background: Setup the project
+    Given I run `ckit new chemists-test`
+    And I cd to "chemists-test"
+    And a file named "chemists/chemists.csv" with:
+      """
+      Key,Type,Email,Name,Password
+      admin1,admin,admin@email.com,Mr. Admin,abc123$
+      normal1,normal,normal@email.com,Ms. Normal,test123%
+      ran1,random,normal@email.com,Ms. Normal,test123%
+      ran2,random,normal@email.com,Ms. Normal,test123%
+      """
+    And a file named "formulas/basic_formula.rb" with:
+      """
+      module Formulas
+        class BasicFormula < Formula
+          def open(url)
+            @driver.get url
+          end
+        end
+      end
+      """
+    And a file named "formulas/chemist_formula.rb" with:
+      """
+      require 'chemistrykit/formula/chemist_aware'
+
+      module Formulas
+        class ChemistFormula < Formula
+          include ChemistryKit::Formula::ChemistAware
+          def open(url)
+            @driver.get url
+          end
+
+          def search
+            search_box = find id: 'gbqfq'
+            search_box.send_keys chemist.type
+            search_box.send_keys :enter
+          end
+
+          def search_results_found?
+            wait_for(5) { displayed? id: 'search' }
+            search_results = find id: 'search'
+            search_results.text.include?(chemist.type)
+          end
+        end
+      end
+      """
+    And a file named "formulas/lib/formula.rb" with:
+      """
+      module Formulas
+        class Formula < ChemistryKit::Formula::Base
+
+          def open(url)
+            @driver.get url
+          end
+
+          def find(locator)
+            @driver.find_element locator
+          end
+
+          def displayed?(locator)
+            begin
+              find(locator).displayed?
+            rescue
+              false
+            end
+          end
+
+          def wait_for(seconds=2)
+            Selenium::WebDriver::Wait.new(:timeout => seconds).until { yield }
+          end
+        end
+      end
+      """
+
+  Scenario: Simple formula loading with formula_lab
+    Given a file named "beakers/chemist_beaker.rb" with:
+      """
+      describe "Chemist Beaker", :depth => 'shallow' do
+        let(:basic) { @formula_lab.mix('basic_formula') }
+
+        it "loads an external web page" do
+          basic.open "http://www.google.com"
+        end
+      end
+      """
+    When I run `ckit brew`
+    Then the stdout should contain "1 example, 0 failures"
+
+  Scenario: Chemist formula loading with formula_lab
+    Given a file named "beakers/chemist_beaker.rb" with:
+      """
+      describe "Chemist Beaker", :depth => 'shallow' do
+        let(:chem) { @formula_lab.using('chemist_formula').with('admin1').mix }
+
+        it "loads an external web page" do
+          chem.open "http://www.google.com"
+          chem.search
+          chem.search_results_found?.should eq true
+        end
+      end
+      """
+    When I run `ckit brew`
+    Then the stdout should contain "1 example, 0 failures"
+
+  Scenario: Loading multiple formulas in a beaker
+    Given a file named "beakers/chemist_beaker.rb" with:
+      """
+      describe "Chemist Beaker", :depth => 'shallow' do
+        let(:basic) { @formula_lab.mix('basic_formula') }
+        let(:chem) { @formula_lab.using('chemist_formula').with('admin1').mix }
+
+        it "loads an external web page" do
+          basic.open "http://www.google.com"
+          chem.search
+          chem.search_results_found?.should eq true
+        end
+      end
+      """
+    When I run `ckit brew`
+    Then the stdout should contain "1 example, 0 failures"
+

data/features/new.feature

@@ -13,6 +13,8 @@ Feature: ckit new
       | formulas/lib            |
       | formulas/lib/catalysts  |
       | evidence                |
+      | chemists                |
     And the following files should exist:
       | config.yaml             |
       | formulas/lib/formula.rb |
+      | chemists/chemists.csv   |

data/lib/chemistrykit/chemist.rb

@@ -0,0 +1,34 @@
+# Encoding: utf-8
+
+module ChemistryKit
+  # representation of the user object for interacting with the system under test
+  class Chemist
+
+    attr_reader :key, :type, :data
+
+    def initialize(key, type)
+      @key = key.to_s
+      @type = type.to_s
+      @data = {}
+    end
+
+    def data=(data)
+      data.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    # allow this object to be set with arbitrary key value data
+    def method_missing(name, *arguments)
+      value = arguments[0]
+      name = name.to_s
+      if name[-1, 1] == '='
+        key = name[/(.+)\s?=/, 1]
+        @data[key.to_sym] = value unless instance_variables.include? "@#{key}".to_sym
+      else
+        @data[name.to_sym]
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,79 @@
+# Encoding: utf-8
+
+require 'csv'
+require 'securerandom'
+require 'chemistrykit/chemist'
+
+module ChemistryKit
+  # Chemist namespace
+  class Chemist
+    module Repository
+      # Provides the ability to load a chemist by type identifyer from a csv file
+      class CsvChemistRepository
+
+        def initialize(csv_path)
+          @tables = []
+          files = csv_path.kind_of?(String) ? [csv_path] : csv_path
+
+          files.each do |file|
+            raise ArgumentError, 'Supplied file does not exist!' unless File.exist? file
+            table = CSV.read(file, { headers: true, converters: :all, header_converters: :symbol })
+            [:key, :type].each do |header|
+              unless table.headers.include?(header) || table.headers.length == 0
+                raise ArgumentError, "You must define a #{header.to_s} field!"
+              end
+            end
+            @tables.push table
+          end
+        end
+
+        # Required Method
+        # Load a specific chemist by the unique key
+        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
+          end
+          raise ArgumentError, "Chemist for type \"#{key}\" not found!"
+        end
+
+        # Required Method
+        # Load the first chemist found for a given type
+        def load_first_chemist_of_type(type)
+          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
+        end
+
+        protected
+
+          def load_chemists_of_type(type)
+            chemists = []
+            @tables.each do |table|
+              chemist_data = table.select { |row| row[:type] == type }
+              if chemist_data
+                chemist_data.each do |data|
+                  chemists << make_chemist(data[:key], type, data)
+                end
+              end
+            end
+            raise ArgumentError, "Chemist for type \"#{type}\" not found!" if chemists.empty?
+            chemists
+          end
+
+          def make_chemist(key, type, data)
+            chemist = Chemist.new(key, type)
+            data_hash = data.to_hash
+            data_hash.map { |index, value| value.gsub!(/{{UUID}}/, SecureRandom.uuid) }
+            chemist.data = data_hash
+            chemist
+          end
+
+      end
+    end
+  end
+end