cornucopia 0.1.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1d77b60c09f0e90ba7b71c236ace93759f505747
+  data.tar.gz: e28665b7fae1b76f551d0f6a6bb54a8b140ff376
+SHA512:
+  metadata.gz: c7042a179f4d6b33772dd5ffd31f1fac82698a32ce7c1d7a745e234c5270a692e7840fb757dea98f04e5925fdda64a885390519cdf55fbebd48bf3cb51aaa1ed
+  data.tar.gz: 415cf0bf47a7636c6dcdb9a053fb1ec08aa5d18ea05df93378c7899639f1c25430c7d1f680efb9512a78067c1aca12c7ef5825b089baa7939214c59f31a28d98

data/.gitignore

@@ -0,0 +1,51 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+config/initializers/secret_token.rb
+config/secrets.yml
+
+## Environment normalisation:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalise the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+spec/dummy/log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/db/*.sqlite3-journal
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+*.gem
+*.rbc
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+doc/
+lib/bundler/man
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+cornucopia_report/
+spec/dummy/cornucopia_report/
+spec/dummy/sample_report/
+spec/dummy/.rspec
+test_reports/*
+.idea/

data/.ruby-gemset

@@ -0,0 +1 @@
+cornucopia

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+# Declare your gem's dependencies in cornucopia.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+
+gem "gem-release"

data/LICENSE.TXT

@@ -0,0 +1,22 @@
+Copyright (c) 2014 RealNobody
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,341 @@
+# Cornucopia
+
+This is a gem with a bunch of tools which I think are useful when testing.  There are many parts to the gem and not
+all parts are useful in all projects.  The gem is designed to work so that you can only use the parts that you need.
+If the gem ever grows large enough or complex enough, I might break it into pieces similar to rspec.  For now,
+this is just the way it is.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cornucopia', '~> 0.1.0', git: "git@github.com:RealNobody/cornucopia.git"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cornucopia
+
+## Usage
+
+### Hooks
+
+The primary usefulness of the system is the built in integration system.  Using your favorite supported test system
+include the appropriate files.
+
+#### RSPEC:
+
+spec_helper.rb:
+
+```
+require "cornucopia/rspec_hooks"
+```
+
+#### Cucumber:
+
+env.rb:
+
+```
+require "cornucopia/cucumber_hooks"
+```
+
+#### Spinach:
+
+env.rb:
+
+```
+require "cornucopia/spinach_hooks"
+```
+
+Once required in the hooks are installed, the system will automatically generate a report detailing the error.  The
+automatic report includes information about the failure including:
+
+* The exception
+* The callstack
+* Any instance variables for the test
+* Details about the failed test and/or step
+* Any Capybara windows and their details including a screen shot
+
+### Capybara
+
+I have added the following functions to Capybara to help simplify using it.
+
+* synchronize_test(seconds=Capybara.default_wait_time, options = {}, &block)
+
+This function yields to a block until the Capybara timeout occurs or the block returns true.
+
+    # Wait until either #some_element or #another_element exists.
+    Capybara::current_session.synchronize_test do
+      page.all("#some_element").length > 0 ||
+          page.all("#another_element").length > 0
+    end
+
+* **select_value**
+
+This function selects the option from a select box based on the value for the selected option instead of the
+value string.
+
+    page.find("#state_selector").select_value(my_address.state_abbreviation)
+
+* **value_text**
+
+This function returns the string value of the currently selected option(s).
+
+    page.find("#state_selector").value_text  # returns "Arizona" instead of "AZ"
+
+### SitePrism
+
+I love using SitePrism.  Unfortunately, I find it involves a lot of copy/paste.  To simplify the use of SitePrism, I
+have created what are basically some macros:
+
+* **patterned_elements(pattern, *element, options = {})**
+
+This allows you to define a list of multiple elements where the pattern for the finder includes the text for what you
+want the call the element.
+
+You can specify the type of finder to be used with the _finder_type_ parameter, and if necessary include additional
+parameters as well.
+
+Examples:
+
+    class MySection < SitePrism::Section
+      patterned_elements "td.column_%{element_name}",
+                         :my_element_1,
+                         :my_element_2,
+                         :my_element_3
+
+      # instead of:
+      # element :my_element_1, "td.column_my_element_1"
+      # element :my_element_2, "td.column_my_element_2"
+      # element :my_element_3, "td.column_my_element_3"
+
+      patterned_elements "//td[name = \"${element_name}\"]",
+                         :my_element_1,
+                         :my_element_2,
+                         :my_element_3,
+                         finder_type: :xpath,
+                         visible: false
+
+      # instead of:
+      # element :my_element_1, :xpath, "//td[name = \"my_element_1\"]", visible: false
+      # element :my_element_2, :xpath, "//td[name = \"my_element_2\"]", visible: false
+      # element :my_element_3, :xpath, "//td[name = \"my_element_3\"]", visible: false
+    end
+
+* **patterned_elements(form_type, *elements)**
+
+This provides a quick and easy way to define elements for the items in forms.  The ids of the elements in a form
+follow the simple pattern of:  &lt;form_name&gt;&lt;element_id&gt;.  Most of the time, you want the name of the
+element to match the &lt;element_id&gt;.
+
+Example:
+
+    = form_for my_table_object do |form|
+      = form.select :field_1
+      = form.text_box :field_2
+      = form.check_box :field_3
+
+    class MySection < SitePrism::Section
+      form_elements :my_table,
+                    :field_1,
+                    :field_2,
+                    :field_3,
+
+      # instead of:
+      # element :field_1, "#my_table_field_1"
+      # element :field_2, "#my_table_field_2"
+      # element :field_3, "#my_table_field_3"
+    end
+
+* **id_elements(*elements)**
+
+This is a quick and easy way to define elements where the name of the element is the same as the id for the element.
+
+Example:
+
+    class MySection < SitePrism::Section
+      id_elements :my_item_1,
+                  :my_item_2,
+                  :my_item_3
+
+      # instead of:
+      # element :my_item_1, "#my_item_1"
+      # element :my_item_2, "#my_item_2"
+      # element :my_item_3, "#my_item_3"
+    end
+
+* **class_elements(*elements)**
+
+This is a quick and easy way to define elements where the name of the element is the same as the class name used to
+identify the element.
+
+Example:
+
+    class MySection < SitePrism::Section
+      id_elements :my_item_1,
+                  :my_item_2,
+                  :my_item_3
+
+      # instead of:
+      # element :my_item_1, ".my_item_1"
+      # element :my_item_2, ".my_item_2"
+      # element :my_item_3, ".my_item_3"
+    end
+
+* **indexed_elements(pattern, *element, options = {})**
+
+This allows you to define a list of multiple elements where the pattern for the finder is based on an index value.
+This is useful for things like table columns.
+
+You can specify the type of finder to be used with the _finder_type_ parameter, and if necessary include additional
+parameters as well with _additional_options_.
+
+Examples:
+
+    class MySection < SitePrism::Section
+      patterned_elements "td:nth-child(%{element_index})",
+                         :my_element_1,
+                         :my_element_2,
+                         :my_element_3
+
+      # instead of:
+      # element :my_element_1, "td:nth-child(1)"
+      # element :my_element_2, "td:nth-child(2)"
+      # element :my_element_3, "td:nth-child(3)"
+
+      patterned_elements "//td_%{element_index}",
+                         :my_element_1,
+                         :my_element_2,
+                         :my_element_3,
+                         finder_type: :xpath,
+                         additional_options: { visible: false },
+                         start_index: 3,
+                         increment: 12
+
+      # instead of:
+      # element :my_element_1, :xpath, "//td_3", visible: false
+      # element :my_element_2, :xpath, "//td_15", visible: false
+      # element :my_element_3, :xpath, "//td_27", visible: false
+    end
+
+* **PageApplication**
+
+SitePrism recommends memoizing the page objects.  I found it annoying to create a class for the pages and define a
+new function for each page.  To simplify my life, I created the PageApplication class.  It will memoize pages for me
+automatically as long as I follow some simple rules.
+
+Basically, just create all of my pages underneath a single module in a single folder, and the a class derived from
+PageApplication will find the pages and memoize them for you automatically.
+
+    class MyApplication < Cornucopia::SitePrism::PageApplication
+      def pages_module
+        MyPagesModule
+      end
+    end
+
+    module MyPagesModule
+      module MyModule
+        class MyPage < SitePrism::Page
+          # your SitePirsm page definition here...
+        end
+      end
+    end
+
+    module MyPagesModule
+      class MyOtherPage < SitePrism::Page
+        # your SitePirsm page definition here...
+      end
+    end
+
+    a_memoized_page       = MyApplication.my_module__my_page
+    a_memoized_other_page = MyApplication.my_other_page
+
+### Utilities
+
+#### Configuration
+
+    Cornucopia::Util::Configuration
+
+The configuration class contains the various configurations that are used by the system.
+
+* **seed**
+
+    The seed value represents the seed value for `rand`.  It is used by the testing hooks to allow tests with
+    randomized values to still be repeatable.  This value can be set or read.
+
+* **grab_logs**
+
+    Indicates if the `Cornucopia::Util::LogCapture` class will capture any log files or not.
+
+* **user_log_files**
+
+    Returns a list of the log files which will be captures.  Changing the returned value will not affect log
+    capturing settings.
+
+* **num_lines(log_file_name=nil)**
+
+    This gets the number of lines that are captured for the indicated log file.  If no value is passed in for
+    `log_file_name`, the default number of lines will be returned.
+
+* **default_num_lines=**
+
+    Set the default number of lines to be captured when capturing log files.
+
+* **add_log_file(log_file_name, options = {})**
+
+    Add a log file to be captured.  The log path needs to be relative to the `Rails` log folder,
+    or if Rails is not being used in the project, relative to the current working directory.  If a file is added
+    multiple times, the file will be captured only once.  Subsequent calls will update the options for the file.
+
+    Options:
+
+    *num_lines* - The number of lines to capture for the file.
+
+* **remove_log_file**
+
+    Removes a log file from the list of files to be captured.
+
+* **report_configuration(report_name)**
+
+    Returns the `Cornucopia::Util::ConfiguredReport` for different reports.
+
+    Supported Reports:
+
+    *rspec*
+
+    *cucumber*
+
+    *spinach*
+
+    *capybara_page_diagnostics*
+
+* **print_timeout_min**
+
+    This is the amount of time (in seconds) the will be allowed for the rendering of a variable when printing a
+    value using `Cornucopia::Util::ReportBuilder.pretty_object`.
+
+    This value exists because in real testing I found a few vaules (which I now exclude automatically) which took
+    literally hours to print out using `pretty_inspect`.  (I suspect an infinite loop.)  This value prevents that by
+    interrupting a printout which takes too long.
+
+#### ConfiguredReport
+
+The `Cornucopia::Util::ConfiguredReport` class allows you to configure what information is exported to generated
+report files.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Todos...
+
+ReportBuilder - delayed reports
+  @delayed_reports = { key: { report_name: "", report_table: ReportTable.new do || end} }
+  finder diagnostics - within sub-report.  delayed_report?