rspec-tapas 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f10e4f1e41b47b59254485d54f9127440531b951
+  data.tar.gz: 427281a46f534e80876cd432c88d8b4e4df2a192
+SHA512:
+  metadata.gz: 519c3fdb1e282ea48f8139c6ec229e67c3ab479facf636cb9cfbc4490bce79775343948353e9c2ca808dbdfd865d23fa9dfe614fee55b771409e9279c7ef2ccc
+  data.tar.gz: db3cac2a8cbf0bc892626c2d15f88b4ddbd386b36bedf442c99d4d4c03bb62524ce10ff374e93dc8eff667aa9403a34baffec11504e8f3692293e471049894b7

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "juwelier", "~> 2.1.0"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,86 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.3.1)
+    faraday (0.12.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.4.0)
+    github_api (0.18.2)
+      addressable (~> 2.4)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8)
+      hashie (~> 3.5, >= 3.5.2)
+      oauth2 (~> 1.0)
+    hashie (3.5.7)
+    highline (2.0.0)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    json (1.8.6)
+    juwelier (2.1.3)
+      builder
+      bundler (>= 1.13)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+      semver
+    jwt (1.5.6)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
+    nokogiri (1.8.3)
+      mini_portile2 (~> 2.3.0)
+    oauth2 (1.4.0)
+      faraday (>= 0.8, < 0.13)
+      jwt (~> 1.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    public_suffix (3.0.2)
+    rack (2.0.5)
+    rake (12.3.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    semver (1.0.1)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.2)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  juwelier (~> 2.1.0)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2018 Błażej Kosmowski
+
+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.rdoc

@@ -0,0 +1,18 @@
+= rspec-tapas
+
+Description goes here.
+
+== Contributing to rspec-tapas
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2018 Błażej Kosmowski. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'juwelier'
+Juwelier::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "rspec-tapas"
+  gem.homepage = "http://github.com/Selleo/rspec-tapas"
+  gem.license = "MIT"
+  gem.summary = "A selection of small rSpec extensions"
+  gem.description = "A selection of small rSpec extensions"
+  gem.email = "b.kosmowski@selleo.com"
+  gem.authors = ["Błażej Kosmowski"]
+
+  # dependencies defined in Gemfile
+end
+Juwelier::RubygemsDotOrgTasks.new
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rspec-tapas #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/rspec-tapas.rb

@@ -0,0 +1,10 @@
+require 'rspec_extensions/behavior_dsl'
+require 'rspec_extensions/downloads_helpers'
+require 'rspec_extensions/feature_helpers'
+require 'rspec_extensions/get_message_part'
+require 'rspec_extensions/invoke_task'
+require 'rspec_extensions/json_response'
+require 'rspec_extensions/stub_env'
+require 'rspec_extensions/view_page'
+require 'rspec_extensions/matchers/have_table_row'
+

data/lib/rspec_extensions/behavior_dsl.rb

@@ -0,0 +1,28 @@
+module RspecExtensions
+  module BehaviorDSL
+    def behavior(name)
+      metadata[:description_args].push(name)
+      refresh_description
+      yield
+      metadata[:description_args].pop
+      refresh_description
+    end
+
+    private
+
+    def refresh_description
+      metadata[:description] = metadata[:description_args].join(' ')
+      metadata[:full_description] = \
+      [metadata[:example_group][:full_description]].
+        concat(metadata[:description_args]).join(' ')
+    end
+
+    def metadata
+      RSpec.current_example.metadata
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RspecExtensions::BehaviorDSL, type: :feature
+end

data/lib/rspec_extensions/date_helpers.rb

@@ -0,0 +1,19 @@
+module RspecExtensions
+  module DateHelpers
+    def at_date(*parts)
+      travel_to(Date.new(*parts)) do
+        yield
+      end
+    end
+
+    def freeze_time
+      travel_to(Time.current) do
+        yield
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RspecExtensions::DateHelpers
+end

data/lib/rspec_extensions/downloads_helpers.rb

@@ -0,0 +1,37 @@
+module RspecExtensions
+  module DownloadsHelpers
+    DOWNLOADS_PATH = Rails.root.join('tmp').freeze
+
+    def allow_file_downloads(page)
+      bridge = page.driver.browser.send(:bridge)
+      path = '/session/:session_id/chromium/send_command'
+      path[':session_id'] = bridge.session_id
+      bridge.http.call(
+        :post,
+        path,
+        cmd: 'Page.setDownloadBehavior',
+        params: { behavior: 'allow', downloadPath: DOWNLOADS_PATH }
+      )
+    end
+
+    def downloaded_file_contents(name)
+      read_attempt = 1
+
+      begin
+        File.read(Support::DownloadsHelpers::DOWNLOADS_PATH.join(name))
+      rescue Errno::ENOENT => exception
+        if read_attempt < 3
+          read_attempt += 1
+          sleep(Capybara.default_max_wait_time)
+          retry
+        else
+          raise exception
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RspecExtensions::DownloadsHelpers, type: :feature
+end

data/lib/rspec_extensions/feature_helpers.rb

@@ -0,0 +1,19 @@
+module RspecExtensions
+  module FeatureHelpers
+    def display_logs
+      puts page.driver.browser.manage.logs.get('browser')
+    end
+
+    def ss
+      page.save_and_open_screenshot
+    end
+
+    def reload_page
+      page.evaluate_script('window.location.reload()')
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RspecExtensions::FeatureHelpers, type: :feature
+end

data/lib/rspec_extensions/get_message_part.rb

@@ -0,0 +1,24 @@
+module RspecExtensions
+  module GetMessagePart
+    def get_message_part(mail, content_type)
+      is_multipart = mail.body.parts.present?
+      if is_multipart
+        mail.body.parts.detect { |part| part.content_type.match(content_type) }.body.raw_source
+      else
+        mail.body.raw_source
+      end
+    end
+
+    def html_part(mail)
+      get_message_part(mail, /html/)
+    end
+
+    def text_part(mail)
+      get_message_part(mail, /plain/)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RspecExtensions::GetMessagePart, type: :mailer
+end

data/lib/rspec_extensions/invoke_task.rb

@@ -0,0 +1,24 @@
+# https://robots.thoughtbot.com/test-rake-tasks-like-a-boss
+module RspecExtensions
+  module InvokeTask
+    def invoke_task(name, options = {})
+      task_path =
+        metadata[:file_path].match(%r{spec/(?<file_path>.*)_spec\.rb})[:file_path]
+      loaded_files_excluding_current_rake_file =
+        $".reject { |file| file == Rails.root.join("#{task_path}.rake").to_s }
+      Rake.application = Rake::Application.new
+      Rake.application.rake_require(
+        task_path,
+        [Rails.root.to_s],
+        loaded_files_excluding_current_rake_file
+      )
+      Rake::Task.define_task(:environment)
+      task = Rake.application[name]
+      task.execute(options)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RspecExtensions::InvokeTask, type: :rake
+end

data/lib/rspec_extensions/json_response.rb

@@ -0,0 +1,19 @@
+module RspecExtensions
+  module JsonResponse
+    def json_response
+      parsed_json = JSON.parse(response.body)
+      if parsed_json.is_a?(Hash)
+        HashWithIndifferentAccess.new(parsed_json)
+      else
+        parsed_json.map do |entry|
+          entry.is_a?(Hash) ? HashWithIndifferentAccess.new(entry) : entry
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RspecExtensions::JsonResponse, type: :request
+  config.include RspecExtensions::JsonResponse, type: :controller
+end

data/lib/rspec_extensions/locators/find_table_row.rb

@@ -0,0 +1,107 @@
+require 'rspec/expectations'
+
+module FindTableRow
+  def find_table_row(*column_expectations)
+    expectations_hash = column_expectations.extract_options!
+    TableRowFinder.call(self, expectations_hash)
+  end
+
+  def find_table_cell(column_index_or_name, *column_expectations)
+    expectations_hash = column_expectations.extract_options!
+    finder = TableRowFinder.new(self, expectations_hash)
+    row = finder.call
+    column_index = finder.header_key_to_column_index(column_index_or_name)
+    row.find(:xpath, "./td[#{column_index + 1}]")
+  end
+
+  class TableRowFinder
+    def initialize(page, column_expectations)
+      @page = page
+      @column_expectations = column_expectations
+    end
+
+    def self.call(page, column_expectations)
+      new(page, column_expectations).call
+    end
+
+    def call
+      verify_table_ambiguity!
+      find_row
+    end
+
+    def header_key_to_column_index(key)
+      key.is_a?(String) ? existing_header_labels.index(key) : key
+    end
+
+    private
+
+    attr_reader :page, :column_expectations
+
+    def normalized_column_expectations
+      @normalized_column_expectations ||= begin
+        if column_expectations.is_a? Array
+          column_expectations.each_with_index.each_with_object({}) do |(value, index), result|
+            result[index] = value
+          end
+        else
+          ensure_headers_presence!
+
+          column_expectations.transform_keys do |key|
+            header_key_to_column_index(key)
+          end
+        end
+      end
+    end
+
+    def verify_table_ambiguity!
+      if page.all('table').count > 1
+        raise Capybara::Ambiguous, 'Ambiguous match, there is more than one table'
+      end
+    end
+
+    def existing_header_labels
+      @existing_header_labels ||= page.all('thead > tr > th').map(&:text)
+    end
+
+    def ensure_headers_presence!
+      expected_header_labels = column_expectations.keys.select { |v| v.is_a? String }
+      missing_headers = expected_header_labels - existing_header_labels
+
+      if missing_headers.present?
+        raise Capybara::ElementNotFound, "Could not find columns: #{missing_headers.join(', ')}"
+      end
+    end
+
+    def find_row
+      matching_rows = page.all('tbody > tr').find_all do |row|
+        normalized_column_expectations.all? do |column_index, expectation|
+          cell = row.find(:xpath, "./td[#{column_index + 1}]")
+          compare(cell, expectation)
+        end
+      end
+
+      if matching_rows.count > 1
+        raise Capybara::Ambiguous, "Ambiguous match, found #{matching_rows.count} rows"
+      elsif matching_rows.empty?
+        raise Capybara::ElementNotFound, "Row with #{formatted_expected_attributes} not found"
+      else
+        matching_rows.first
+      end
+    end
+
+    def formatted_expected_attributes
+      if column_expectations.is_a?(Array)
+        column_expectations.join(', ')
+      else
+        column_expectations.map do |header_name, expected_value|
+          "#{header_name}: #{expected_value}"
+        end.join(', ')
+      end
+    end
+
+    def compare(cell, expectation)
+      return expectation.matches?(cell) if expectation.respond_to?(:matches?)
+      cell.text.strip == expectation.to_s.strip
+    end
+  end
+end

data/lib/rspec_extensions/matchers/have_table_row.rb

@@ -0,0 +1,38 @@
+require_relative '../locators/find_table_row.rb'
+require 'rspec/expectations'
+
+Capybara::Session.include FindTableRow
+Capybara::Node::Simple.include FindTableRow
+
+RSpec::Matchers.define :have_table_row do |*expected|
+  match do |page|
+    with_delay do
+      page.find_table_row(*expected)
+    end
+  end
+
+  match_when_negated do
+    page.find_table_row(*expected)
+    false
+  rescue Capybara::ElementNotFound
+    true
+  end
+
+  failure_message do
+    @failure_message
+  end
+
+  private
+
+  def with_delay
+    Timeout.timeout(Capybara.default_max_wait_time) do
+      yield
+    rescue => error
+      @failure_message = error.message
+      sleep(1)
+      retry
+    end
+  rescue Timeout::Error
+    false
+  end
+end

data/lib/rspec_extensions/stub_env.rb

@@ -0,0 +1,17 @@
+module RspecExRspecExtensionstensions
+  module StubEnv
+    def stub_env(name, value)
+      allow(ENV).to receive(:fetch).and_wrap_original do |m, *args|
+        if args.first == name
+          value
+        else
+          m.call(*args)
+        end
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RspecExtensions::StubEnv
+end

data/lib/rspec_extensions/view_page.rb

@@ -0,0 +1,14 @@
+module RspecExtensions
+  module ViewPage
+    def page
+      Capybara.string(rendered)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include RspecExtensions::ViewPage, type: :view
+  config.around(:each, type: :view) do |example|
+    without_partial_double_verification { example.run }
+  end
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: rspec-tapas
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Błażej Kosmowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: juwelier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A selection of small rSpec extensions
+email: b.kosmowski@selleo.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- ".document"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rspec-tapas.rb
+- lib/rspec_extensions/behavior_dsl.rb
+- lib/rspec_extensions/date_helpers.rb
+- lib/rspec_extensions/downloads_helpers.rb
+- lib/rspec_extensions/feature_helpers.rb
+- lib/rspec_extensions/get_message_part.rb
+- lib/rspec_extensions/invoke_task.rb
+- lib/rspec_extensions/json_response.rb
+- lib/rspec_extensions/locators/find_table_row.rb
+- lib/rspec_extensions/matchers/have_table_row.rb
+- lib/rspec_extensions/stub_env.rb
+- lib/rspec_extensions/view_page.rb
+homepage: http://github.com/Selleo/rspec-tapas
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A selection of small rSpec extensions
+test_files: []