symbiont 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd01188718c924a7aa3c99657e0298949e8f0e7d
-  data.tar.gz: cfe062617af607bd769e130bc5ae758a35ed9238
+  metadata.gz: e4dd5da4488bf024530d92fe4153d35de0cb682b
+  data.tar.gz: 63df367508079f7fe43c1764f9b31639d7dbd223
 SHA512:
-  metadata.gz: 2d3dbcda06fad22a7e0aec22fa05bd7ad55bba73d0b9b4145650cc75a376baa08dcc3af81647ec3232e6e57f6d6e7e256a8d776c98fb02cf5076f9bc75c89d31
-  data.tar.gz: 37bc5b36c3f0288d4a2e301afe0572d1f5b9502549a4e94ec4c1f1aaf93e4932c9fb42449b887f08a4cefd3bca1f717b49b953d9b2b35f4013c5ed3ef8b6e668
+  metadata.gz: 92eaac0062c704ef7cbd99dc51c67f90e5f73d7232176ce18ef45093884b0d8040a452fb6dfe800c755a62dcdc8f2abd23ba1a985f06f62a1dd86a67a5ac53df
+  data.tar.gz: 820896b1c967e3a3954925237e11856ffae0632a094cc6b7674d873c34800230c53e5b8da13608ac7353a5673a5756e2b70c511775f5573bf22fa123b211f7b2

data/.gitignore

@@ -13,6 +13,7 @@ lib/bundler/man
 pkg
 rdoc
 spec/reports
+spec/examples.txt
 test/tmp
 test/version_tmp
 tmp
@@ -25,4 +26,4 @@ mkmf.log
 .DS_Store
 .DS_Store?
 .Trashes
-.thumbs.db
+.thumbs.db

data/.hound.yml

@@ -0,0 +1,76 @@
+AllCops:
+  Exclude:
+    - symbiont.gemspec
+    - test/*.rb
+    - spec/**/*
+
+# missing top-level module documentation comment
+Style/Documentation:
+  Enabled: false
+
+# prefer reduce over inject
+Style/CollectionMethods:
+  PreferredMethods:
+    reduce: 'inject'
+
+# use each_with_object instead of inject
+Style/EachWithObject:
+  Enabled: false
+
+# removing the preference for string single quotes
+Style/StringLiterals:
+  Enabled: false
+
+# prefer fail over raise
+Style/SignalException:
+  Enabled: false
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+# this never works for validations
+Style/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+# align multi-line params with previous line
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# indent `when` clause one step from `case`
+Style/CaseIndentation:
+  IndentOneStep: true
+
+# don't force crappy var names for reduce/inject loops
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# for method chains, keep the dot with the method name
+Style/DotPosition:
+  EnforcedStyle: leading
+
+Style/AccessorMethodName:
+  Enabled: false
+
+# stop nesting so hard
+Metrics/BlockNesting:
+  Max: 2
+
+# short methods
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/LineLength:
+  Max: 105
+
+# fewer parameters
+Metrics/ParameterLists:
+  Max: 5
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Max: 120
+
+Metrics/CyclomaticComplexity:
+  Max: 7

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - .hound.yml

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+
+sudo: false
+
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+
+branches:
+  only:
+    - master
+
+notifications:
+  recipients:
+    - jeffnyman@gmail.com
+
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -1,6 +1,3 @@
 source 'https://rubygems.org'
 
-gem 'simplecov', '~> 0.10.0', require: false
-gem 'coveralls', require: false
-
 gemspec

data/README.md

@@ -1,8 +1,6 @@
 # Symbiont
 
-[ ![Codeship Status for jnyman/symbiont](https://codeship.com/projects/9cd74720-bba9-0132-db22-7ae602eb521b/status?branch=master)](https://codeship.com/projects/72247)
-
-[![Coverage Status](https://coveralls.io/repos/jnyman/symbiont/badge.svg?branch=master)](https://coveralls.io/r/jnyman/symbiont?branch=master)
+[![Build Status](https://travis-ci.org/jnyman/symbiont.svg)](https://travis-ci.org/jnyman/symbiont)
 [![Gem Version](https://badge.fury.io/rb/symbiont.svg)](http://badge.fury.io/rb/symbiont)
 [![Dependency Status](https://gemnasium.com/jnyman/symbiont.png)](https://gemnasium.com/jnyman/symbiont)
 [![Code Climate](https://codeclimate.com/github/jnyman/symbiont/badges/gpa.svg)](https://codeclimate.com/github/jnyman/symbiont)
@@ -16,20 +14,26 @@ Symbiont provides a semantic domain-specific language that can be used to constr
 
 Symbiont is a test solution micro-framework.
 
-A micro-framework provides a focused solution, which means it does one thing and one thing only, instead of trying to solve each and every problem. While doing that one thing it does well, the micro-framework should do it while being expressive and concise. Further, it should be able to serve as one component of your own custom modularized framework, allowing you to compose solutions.
+A micro-framework provides a focused solution, which means it does one thing and one thing only, instead of trying to solve each and every problem. While doing that one thing it does well, the micro-framework should do it while being expressive yet concise. Further, it should be able to serve as one component of your own custom modularized framework, allowing you to compose solutions. To that end, you can use Symbiont directly as an automated test library or you can use it with other tools such as [RSpec](http://rspec.info/), [Cucumber](http://cukes.info/), or my own [Specify](https://github.com/jnyman/specify) tool.
 
-To that end, you can use Symbiont directly as an automated test library or you can use it with other tools such as [RSpec](http://rspec.info/), [Cucumber](http://cukes.info/), or my own [Lucid](https://github.com/jnyman/lucid) tool.
+In terms of what Symbiont does, it provides a way to describe your application in terms of activity and page definitions. Those definitions can then be referenced as part of the DSL that Symbiont provides. This DSL can be utilized in the context of the [Watir-WebDriver test library](https://github.com/watir/watir-webdriver).
 
-In terms of what Symbiont does, it provides a way to describe your application in terms of activity and page definitions. Those definitions can then be referenced by the [Watir-WebDriver test library](https://github.com/watir/watir-webdriver) using the DSL and API that Symbiont provides. The DSL provides a fluent interface that can be used for constructing test execution logic. This fluent interface promotes the idea of compressibility of your test logic, allowing for more factoring, more reuse, and less repetition.
+The DSL provides a fluent interface that can be used for constructing test execution logic. This fluent interface promotes the idea of compressibility of your test logic, allowing for more factoring, more reuse, and less repetition.
 
 
 ## Installation
 
-You can use Symbiont as part of another project, in which case you can add the following to your Gemfile:
+To get the latest stable release, add this line to your application's Gemfile:
 
     gem 'symbiont'
 
-And then execute:
+To get the latest code:
+
+```ruby
+gem 'symbiont', git: https://github.com/jnyman/symbiont
+```
+
+After doing one of the above, execute the following command:
 
     $ bundle
 
@@ -57,6 +61,10 @@ So, with that bit of context, think of this library as a facultative, endosymbio
 
 ## Contributing
 
+Bug reports and pull requests are welcome on GitHub at [https://github.com/jnyman/symbiont](https://github.com/jnyman/symbiont). The testing ecosystem of Ruby is very large and this project is intended to be a welcoming arena for collaboration on yet another testing tool. As such, contributors are very much welcome but are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+To contribute to Symbiont:
+
 1. [Fork the project](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/) ( https://github.com/[my-github-username]/symbiont/fork ).
 2. Create your feature branch. (`git checkout -b my-new-feature`)
 3. Commit your changes. (`git commit -am 'new feature'`)

data/Rakefile

@@ -1,7 +1,11 @@
 #!/usr/bin/env rake
 require 'bundler/gem_tasks'
+require 'rdoc/task'
+require 'rubocop/rake_task'
 require 'rspec/core/rake_task'
 
+RuboCop::RakeTask.new
+
 namespace :test do
   desc 'Run the Symbiont script.'
   task :script do
@@ -15,7 +19,7 @@ namespace :spec do
     system('rm -rf spec/reports')
   end
 
-  RSpec::Core::RakeTask.new(:all => :clean) do |config|
+  RSpec::Core::RakeTask.new(all: :clean) do |config|
     options  = %w(--color)
     options += %w(--format documentation)
     options += %w(--format html --out spec/reports/symbiont-test-report.html)
@@ -24,4 +28,11 @@ namespace :spec do
   end
 end
 
-task default: %w(spec:all)
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.main = 'README.md'
+  rdoc.title = "Symbiont #{Symbiont::VERSION}"
+  rdoc.rdoc_files.include('README*', 'lib/**/*.rb')
+end
+
+task default: ['spec:all', :rubocop]

data/bin/console

@@ -6,5 +6,5 @@ require 'symbiont'
 require 'pry'
 Pry.start
 
-require 'irb'
-IRB.start
+# require 'irb'
+# IRB.start

data/lib/symbiont/accessor.rb

@@ -1,9 +1,9 @@
-module Symbiont
-  module Accessor
-    # @param element [Symbol] name of Watir-based object
-    # @param locator [Hash] locators for referencing the element
-    def reference_element(element, locator)
-      browser.send(element, locator)
-    end
-  end
-end
+module Symbiont
+  module Accessor
+    # @param element [Symbol] name of Watir-based object
+    # @param locator [Hash] locators for referencing the element
+    def reference_element(element, locator)
+      browser.send(element, locator)
+    end
+  end
+end

data/lib/symbiont/assertions.rb

@@ -1,33 +1,33 @@
-module Symbiont
-  module Assertion
-    include Helpers
-
-    def url_is(url=nil)
-      url_is_empty if url.nil? or url.empty?
-      @url = url
-    end
-
-    def url_matches(pattern=nil)
-      url_match_is_empty if pattern.nil?
-      url_match_is_empty if pattern.is_a?(String) and pattern.empty?
-      @url_match = pattern
-    end
-
-    def title_is(title=nil)
-      title_is_empty if title.nil? or title.empty?
-      @title = title
-    end
-
-    def asserted_url
-      @url
-    end
-
-    def url_match
-      @url_match
-    end
-
-    def asserted_title
-      @title
-    end
-  end
-end
+module Symbiont
+  module Assertion
+    include Helpers
+
+    def url_is(url = nil)
+      url_is_empty if url.nil? || url.empty?
+      @url = url
+    end
+
+    def url_matches(pattern = nil)
+      url_match_is_empty if pattern.nil?
+      url_match_is_empty if pattern.is_a?(String) && pattern.empty?
+      @url_match = pattern
+    end
+
+    def title_is(title = nil)
+      title_is_empty if title.nil? || title.empty?
+      @title = title
+    end
+
+    def asserted_url
+      @url
+    end
+
+    def url_match
+      @url_match
+    end
+
+    def asserted_title
+      @title
+    end
+  end
+end

data/lib/symbiont/data_builder.rb

@@ -1,35 +1,35 @@
-module Symbiont
-  module DataBuilder
-    extend DataReader
-
-    class << self
-      attr_accessor :data_source
-
-      def default_data_path
-        'data'
-      end
-    end
-
-    def data_about(key, specified={})
-      if key.is_a?(String) && key.match(%r{/})
-        file, record = key.split('/')
-        DataBuilder.load("#{file}.yml")
-      else
-        record = key.to_s
-        DataBuilder.load('default.yml')
-      end
-
-      Symbiont::trace("DataBuilder.data_source = #{DataBuilder.data_source}")
-
-      data = DataBuilder.data_source[record]
-      raise ArgumentError, "Undefined key for data: #{key}" unless data
-
-      data.merge(specified)
-    end
-
-    alias_method :data_from,       :data_about
-    alias_method :data_for,        :data_about
-    alias_method :using_data_for,  :data_about
-    alias_method :using_data_from, :data_about
-  end
-end
+module Symbiont
+  module DataBuilder
+    extend DataReader
+
+    class << self
+      attr_accessor :data_source
+
+      def default_data_path
+        'data'
+      end
+    end
+
+    def data_about(key, specified = {})
+      if key.is_a?(String) && key.match(%r{/})
+        file, record = key.split('/')
+        DataBuilder.load("#{file}.yml")
+      else
+        record = key.to_s
+        DataBuilder.load('default.yml')
+      end
+
+      Symbiont.trace("DataBuilder.data_source = #{DataBuilder.data_source}")
+
+      data = DataBuilder.data_source[record]
+      raise ArgumentError, "Undefined key for data: #{key}" unless data
+
+      data.merge(specified)
+    end
+
+    alias_method :data_from,       :data_about
+    alias_method :data_for,        :data_about
+    alias_method :using_data_for,  :data_about
+    alias_method :using_data_from, :data_about
+  end
+end

data/lib/symbiont/data_reader.rb

@@ -1,22 +1,20 @@
-module Symbiont
-  module DataReader
-
-    def data_path=(path)
-      @data_path = path
-    end
-
-    def data_path
-      return @data_path if @data_path
-      return default_data_path if self.respond_to? :default_data_path
-      nil
-    end
-
-    # The data_source name here must match the name used for the
-    # class accessor in the data builder. It is this data_source
-    # variable that connects the reader and the builder.
-    def load(file)
-      @data_source = YAML.load_file "#{data_path}/#{file}"
-    end
-    
-  end
-end
+module Symbiont
+  module DataReader
+    def data_path=(path)
+      @data_path = path
+    end
+
+    def data_path
+      return @data_path if @data_path
+      return default_data_path if self.respond_to? :default_data_path
+      nil
+    end
+
+    # The data_source name here must match the name used for the
+    # class accessor in the data builder. It is this data_source
+    # variable that connects the reader and the builder.
+    def load(file)
+      @data_source = YAML.load_file "#{data_path}/#{file}"
+    end
+  end
+end

data/lib/symbiont/data_setter.rb

@@ -1,32 +1,39 @@
-module Symbiont
-  module DataSetter
-    # @param data [Hash] the data to use
-    def using(data)
-      data.each do |key, value|
-        use_data_with(key, value) if object_enabled_for(key)
-      end
-    end
-
-    alias_method :using_data,   :using
-    alias_method :use_data,     :using
-    alias_method :using_values, :using
-    alias_method :use_values,   :using
-
-    def use_data_with(key, value)
-      element = self.send("#{key}")
-      self.call_method_chain("#{key}.set", value)     if element.class == Watir::TextField
-      self.call_method_chain("#{key}.set")            if element.class == Watir::Radio
-      self.call_method_chain("#{key}.select", value)  if element.class == Watir::Select
-
-      return self.call_method_chain("#{key}.check")   if element.class == Watir::CheckBox and value
-      return self.call_method_chain("#{key}.uncheck") if element.class == Watir::CheckBox
-    end
-
-    private
-
-    def object_enabled_for(key)
-      web_element = self.send("#{key}")
-      web_element.enabled? and web_element.visible?
-    end
-  end
-end
+module Symbiont
+  module DataSetter
+    # @param data [Hash] the data to use
+    def using(data)
+      data.each do |key, value|
+        use_data_with(key, value) if object_enabled_for(key)
+      end
+    end
+
+    alias_method :using_data,   :using
+    alias_method :use_data,     :using
+    alias_method :using_values, :using
+    alias_method :use_values,   :using
+
+    def use_data_with(key, value)
+      element = send("#{key}")
+      set_and_select(element, value)
+      check_and_uncheck(element, value)
+    end
+
+    private
+
+    def set_and_select(element, value)
+      call_method_chain("#{key}.set", value)     if element.class == Watir::TextField
+      call_method_chain("#{key}.set")            if element.class == Watir::Radio
+      call_method_chain("#{key}.select", value)  if element.class == Watir::Select
+    end
+
+    def check_and_uncheck(element, value)
+      return call_method_chain("#{key}.check")   if element.class == Watir::CheckBox && value
+      return call_method_chain("#{key}.uncheck") if element.class == Watir::CheckBox
+    end
+
+    def object_enabled_for(key)
+      web_element = send("#{key}")
+      web_element.enabled? && web_element.visible?
+    end
+  end
+end