cornucopia 0.1.13 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3346fed2eb1ac7927737bf2bbbdd9fdd4c82edca
-  data.tar.gz: 6adeed695e6be6f05292d6327272290fe2a34b41
+  metadata.gz: f2682bd2d0aef45b217d6232d738f47f3e263a84
+  data.tar.gz: 6421bfd30df02f3374930bbc9fde78e96503d8a2
 SHA512:
-  metadata.gz: f2a81685b388928f567d25f7fc754d4d128f0ba9c2479391ad784eb79c78800d5fc200650378c48d16195e49c69b3f7cee17ab29f48c6ca457b74f553def7bab
-  data.tar.gz: 462a916d48b5f1c25da256e68ae77b8dd87fd32a2a26c3074caedf2cfe167371e82dce94fa89ef9275cc966bf12fa46b7b658e7e3362b43b66ec7f364eef6f62
+  metadata.gz: 8b236913bc33aa3af05bddf15938f360e59032615891215d7e8a3f47045d50ed10a589580cfb6e9d92ba5b52cbe561326910123e116dfa46495a0c90f9aa83a7
+  data.tar.gz: 45552b891a827b6a5e8a7f73bbd0a172058c0121959374681167444d9ff8b86a90c6863c349eb1c52bedca07ff717c0750800a74c422b19e4b4bccef68e02ef2

data/README.md

@@ -9,11 +9,11 @@ this is just the way it is.
 
 Add this line to your application's Gemfile:
 
-    gem 'cornucopia', '~> 0.1.0', git: "git@github.com:RealNobody/cornucopia.git"
+    gem 'cornucopia'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -28,7 +28,7 @@ include the appropriate files.
 
 #### RSPEC:
 
-spec_helper.rb:
+spec_helper.rb or rails_helper.rb depending on the version of RSpec you are using, or where you want to put it:
 
 ```
 require "cornucopia/rspec_hooks"
@@ -125,7 +125,7 @@ Examples:
       # element :my_element_3, :xpath, "//td[name = \"my_element_3\"]", visible: false
     end
 
-* **patterned_elements(form_type, *elements)**
+* **form_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:  <form_name><element_id>.  Most of the time, you want the name of the
@@ -177,12 +177,14 @@ Example:
     class MySection < SitePrism::Section
       id_elements :my_item_1,
                   :my_item_2,
-                  :my_item_3
+                  :my_item_3,
+                  "my-class-name"
 
       # instead of:
       # element :my_item_1, ".my_item_1"
       # element :my_item_2, ".my_item_2"
       # element :my_item_3, ".my_item_3"
+      # element :my_class_name, ".my-class-name"
     end
 
 * **indexed_elements(pattern, *element, options = {})**
@@ -266,6 +268,14 @@ The configuration class contains the various configurations that are used by the
     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.
 
+* **order_seed**
+
+    **Experimental** The order_seed value represents the seed value for the order that RSpec tests are run in if they 
+    are run randomly.  This value in the configurations actually doesn't always work as it is very dependent on when 
+    it is set during the RSpec configuration process.  The system tries, but it may be best just to do what this does
+     and set `RSpec.configuration.seed = <your value>` youself in spec_helper.rb.  Really I've just started playing 
+     around with it and seeing what I can do with it.
+
 * **grab_logs**
 
     Indicates if the `Cornucopia::Util::LogCapture` class will capture any log files or not.
@@ -321,6 +331,20 @@ The configuration class contains the various configurations that are used by the
     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.
 
+* **auto_open_report_after_generation**
+
+    This allows you to tell the system to open a report with errors in it after the report is closed/finished.  If 
+    you do not specify a type of report the value you specify will be the default value used for any report that is 
+    generated. 
+
+* And more...
+
+    There are more configurations.  They are commented in the configuraiton.rb file.  If I didn't include them here, 
+    then I probably thought that they were well commented in the file, or that they weren't important enough to put 
+    here, or that they shouldn't be used normally, or (hopefully not) I just forgot to update the readme.
+
+    If I forgot one and you think it should be here, let me know.
+
 #### ConfiguredReport
 
 The `Cornucopia::Util::ConfiguredReport` class allows you to configure what information is exported to generated
@@ -338,4 +362,20 @@ report files.
 
 ReportBuilder - delayed reports
   @delayed_reports = { key: { report_name: "", report_table: ReportTable.new do || end} }
-  finder diagnostics - within sub-report.  delayed_report?
+  finder diagnostics - within sub-report.  delayed_report?
+ReportBuilder - reports by test with multiple sub-reports
+  Instead of delayed reports?
+ReportBuilder - reformat and styling of report?
+ReportBuilder - Each test in separate files so we can create a report with a list of failed tests in case there are a
+                lot of them.
+  Instead of delayed reports?
+Hooks to add stuff to reports
+  Add own section to report for test
+  Option/way to make new section a more-details section
+SitePrism override section, element, sections and elements command to allow parameters to be passed in as additional 
+    options.
+  functions to override:
+    main function (name)
+    has_
+    ???
+Make configuration a singleton

data/lib/cornucopia/capybara/finder_diagnostics.rb

@@ -79,6 +79,12 @@ module Cornucopia
       class FindAction
         @@diagnosed_finders = {}
 
+        # Clears the class variable @@diagnosed_finders between tests if called.
+        # This is done so that finder analysis is called at least once per test.
+        def self.start_test
+          @@diagnosed_finders = {}
+        end
+
         attr_accessor :return_value
         attr_accessor :support_options
 

data/lib/cornucopia/cucumber_hooks.rb

@@ -8,6 +8,8 @@ Around do |scenario, block|
 
   scenario.instance_variable_set :@seed_value, seed_value
 
+  Cornucopia::Capybara::FinderDiagnostics::FindAction.start_test
+
   block.call
 
   if scenario.failed?

data/lib/cornucopia/rspec_hooks.rb

@@ -4,6 +4,8 @@ load ::File.expand_path("capybara/install_matcher_extensions.rb", File.dirname(_
 load ::File.expand_path("site_prism/install_element_extensions.rb", File.dirname(__FILE__))
 
 RSpec.configure do |config|
+  config.seed = Cornucopia::Util::Configuration.order_seed if Cornucopia::Util::Configuration.order_seed
+
   config.before(:suite) do |*args|
     Cornucopia::Util::ReportBuilder.new_report("rspec_report")
   end
@@ -18,6 +20,8 @@ RSpec.configure do |config|
 
     srand(@seed_value)
 
+    Cornucopia::Capybara::FinderDiagnostics::FindAction.start_test
+
     example.run
 
     test_example = example.example if example.respond_to?(:example)
@@ -29,7 +33,7 @@ RSpec.configure do |config|
           within_section("Test Error: #{test_example.full_description}") do |report|
         configured_report = Cornucopia::Util::Configuration.report_configuration :rspec
 
-        configured_report.add_report_objects example: test_example
+        configured_report.add_report_objects example: test_example, rspec: RSpec
         configured_report.generate_report(report)
       end
     end

data/lib/cornucopia/spinach_hooks.rb

@@ -8,6 +8,8 @@ Spinach.hooks.before_scenario do |scenario, step_definitions|
       100000000000000000000000000000000000000 + rand(899999999999999999999999999999999999999)
 
   scenario.instance_variable_set :@seed_value, seed_value
+
+  Cornucopia::Capybara::FinderDiagnostics::FindAction.start_test
 end
 
 Spinach.hooks.after_scenario do |scenario, step_definitions|

data/lib/cornucopia/util/configuration.rb

@@ -6,6 +6,7 @@ module Cornucopia
   module Util
     class Configuration
       @@configurations                             = Cornucopia::Util::GenericSettings.new
+      @@configurations.order_seed                  = nil
       @@configurations.rand_seed                   = nil
       @@configurations.user_log_files              = {}
       @@configurations.default_num_lines           = 500
@@ -34,6 +35,7 @@ module Cornucopia
                                         :example,
                                         :example__example_group_instance,
                                         :example__metadata__caller,
+                                        :rspec__configuration__seed,
                                         :logs,
                                         :capybara_page_diagnostics
                                     ],
@@ -268,6 +270,18 @@ module Cornucopia
           @@configurations.rand_seed
         end
 
+        # order_seed is the seed value used to set the order that randomly ordered tests are run in.
+        # This is provided as a convenience method.  I think it is easier to set this in rails_helper than it is to
+        # set it on the command line.  This also provides a uniform method to do it.
+        def order_seed=(value)
+          @@configurations.order_seed = value
+          RSpec.configuration.seed = value if value
+        end
+
+        def order_seed
+          @@configurations.order_seed
+        end
+
         # grab_logs indicates if the system should try to automatically grab a tail of
         # the log file if outputing a diagnostics report.
         #

data/lib/cornucopia/version.rb

@@ -1,3 +1,3 @@
 module Cornucopia
-  VERSION = "0.1.13"
+  VERSION = "0.1.14"
 end

data/spec/lib/capybara/finder_diagnostics_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/util/report_builder", File.dirname(__FILE__))
 require ::File.expand_path("../../../lib/cornucopia/capybara/page_diagnostics", File.dirname(__FILE__))
 require ::File.expand_path("../../../lib/cornucopia/capybara/finder_diagnostics", File.dirname(__FILE__))

data/spec/lib/capybara/finder_extensions_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/capybara/finder_extensions", File.dirname(__FILE__))
 
 describe Cornucopia::Capybara::FinderExtensions, type: :feature do

data/spec/lib/capybara/matcher_extensions_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/capybara/matcher_extensions", File.dirname(__FILE__))
 
 describe Cornucopia::Capybara::MatcherExtensions, type: :feature do

data/spec/lib/capybara/page_diagnostics_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "rails_helper"
 require 'rack/file'
 require ::File.expand_path("../../../lib/cornucopia/util/report_builder", File.dirname(__FILE__))
 require ::File.expand_path("../../../lib/cornucopia/capybara/page_diagnostics", File.dirname(__FILE__))

data/spec/lib/site_prism/element_extensions_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/site_prism/element_extensions", File.dirname(__FILE__))
 
 describe "SitePrism element_extensions" do

data/spec/lib/site_prism/page_application_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/site_prism/page_application", File.dirname(__FILE__))
 
 describe Cornucopia::SitePrism::PageApplication do

data/spec/lib/util/configuration_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/util/configuration", File.dirname(__FILE__))
 
 describe "Cornucopia::Util::Configuration" do
@@ -18,6 +18,25 @@ describe "Cornucopia::Util::Configuration" do
     end
   end
 
+  it "has a default order_seed value" do
+    expect(Cornucopia::Util::Configuration.order_seed).not_to be
+  end
+
+  it "can set the order_seed value" do
+    config_seed = RSpec.configuration.seed
+    begin
+      seed_value = rand(0..999999999999999999999999999)
+
+      Cornucopia::Util::Configuration.order_seed = seed_value
+
+      expect(Cornucopia::Util::Configuration.order_seed).to be == seed_value
+      expect(RSpec.configuration.seed).to be == seed_value
+    ensure
+      RSpec.configuration.seed = config_seed
+      Cornucopia::Util::Configuration.order_seed = nil
+    end
+  end
+
   describe "log files" do
     it "grabs logs by default" do
       expect(Cornucopia::Util::Configuration.grab_logs).to be_truthy

data/spec/lib/util/configured_report_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/util/configured_report", File.dirname(__FILE__))
 
 class SubTestClass

data/spec/lib/util/file_asset_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "rails_helper"
 require "tempfile"
 require ::File.expand_path("../../../lib/cornucopia/util/file_asset", File.dirname(__FILE__))
 

data/spec/lib/util/generic_settings_spec.rb

@@ -1,4 +1,4 @@
-require "spec_helper"
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/util/generic_settings", File.dirname(__FILE__))
 
 describe Cornucopia::Util::GenericSettings do

data/spec/lib/util/log_capture_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/util/log_capture", File.dirname(__FILE__))
 
 describe Cornucopia::Util::LogCapture do

data/spec/lib/util/pretty_formatter_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/util/pretty_formatter", File.dirname(__FILE__))
 
 describe Cornucopia::Util::PrettyFormatter do

data/spec/lib/util/report_builder_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/util/report_builder", File.dirname(__FILE__))
 
 describe Cornucopia::Util::ReportBuilder do

data/spec/lib/util/report_formatters_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/util/report_formatters", File.dirname(__FILE__))
 
 describe Cornucopia::Util::CucumberFormatter do

data/spec/lib/util/report_table_exception_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/util/report_table", File.dirname(__FILE__))
 
 describe Cornucopia::Util::ReportTable::ReportTableException do

data/spec/lib/util/report_table_spec.rb

@@ -1,4 +1,4 @@
-require 'spec_helper'
+require "rails_helper"
 require ::File.expand_path("../../../lib/cornucopia/util/report_table", File.dirname(__FILE__))
 
 describe Cornucopia::Util::ReportTable do

data/spec/rails_helper.rb

@@ -1,7 +1,7 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
-ENV["RAILS_ENV"] ||= 'test'
-require 'spec_helper'
-require File.expand_path("../../config/environment", __FILE__)
+  ENV["RAILS_ENV"] ||= 'test'
+require "spec_helper"
+# require File.expand_path("../../config/environment", __FILE__)
 require 'rspec/rails'
 
 # Requires supporting ruby files with custom matchers and macros, etc, in
@@ -19,7 +19,7 @@ ActiveRecord::Migration.check_pending! if defined?(ActiveRecord::Migration)
 
 RSpec.configure do |config|
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.fixture_path               = "#{::Rails.root}/spec/fixtures"
 
   # If you're not using ActiveRecord, or you'd prefer not to run each of your
   # examples within a transaction, remove the following line or assign false
@@ -40,4 +40,10 @@ RSpec.configure do |config|
   # The different available types are documented in the features, such as in
   # https://relishapp.com/rspec/rspec-rails/docs
   config.infer_spec_type_from_file_location!
+
+  config.before(:each) do
+    Cornucopia::Capybara::FinderDiagnostics::FindAction.start_test
+
+    expect(Cornucopia::Capybara::FinderDiagnostics::FindAction.class_variable_get(:@@diagnosed_finders)).to be_blank
+  end
 end

data/spec/spec_helper.rb

@@ -59,17 +59,19 @@ require ::File.expand_path("../lib/cornucopia/util/configuration", File.dirname(
 Capybara.default_driver = :selenium
 
 # Cornucopia::Util::Configuration.seed = 1
+# Cornucopia::Util::Configuration.order_seed = 1
+
 RSpec.configure do |config|
   config.around(:each) do |example|
-    @seed_value = Cornucopia::Util::Configuration.seed ||
+    @test_seed_value = Cornucopia::Util::Configuration.seed ||
         100000000000000000000000000000000000000 + rand(899999999999999999999999999999999999999)
 
-    srand(@seed_value)
+    srand(@test_seed_value)
 
     example.run
 
     if (example.exception)
-      puts("random seed for testing was: #{@seed_value}")
+      puts("random seed for testing was: #{@test_seed_value}")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cornucopia
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors:
 - RealNobody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails