bbq-rspec 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e7617712f73b5b7b340497577d207d4580d0d4ef5055ab3ff7a33f1f1b1f1e7
+  data.tar.gz: a2098d9c920993d90bf8a87be822baceedcc2f783182b6419fc9e847e8d61280
+SHA512:
+  metadata.gz: 1b6edb1a6122f0b154caa09ad0e0a7a5264f6b4853c65488e126c0490e605d84f55e9586d1c2715b63fcd58e5d1648f178145de2414437a4a80f10e54aeec75a
+  data.tar.gz: 27ebed9c4328a8c8b94ecce57e26ee56cffad37dea58728c7d7e7981971805212cbc76ab6b0586905a501a95de5bd8ef2fde00e198ddb1878dae1ea06858ac20

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+Gemfile*.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.4
+  - rbx-19mode
+
+gemfile:
+  - Gemfile.rspec2
+  - Gemfile.rspec3

data/Contributing.md

@@ -0,0 +1,9 @@
+# Development setup
+
+    BUNDLE_GEMFILE=Gemfile.rspec2 bundle
+    BUNDLE_GEMFILE=Gemfile.rspec3 bundle
+
+# Running specs
+  
+    BUNDLE_GEMFILE=Gemfile.rspec2 bundle exec rake
+    BUNDLE_GEMFILE=Gemfile.rspec3 bundle exec rake

data/Gemfile.rspec2

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'rspec', '~> 2.0'
+gem 'bbq-core', github: 'drugpl/bbq-core'

data/Gemfile.rspec3

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'rspec', '~> 3.0'
+gem 'bbq-core', github: 'drugpl/bbq-core'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jakub Kosinski
+
+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/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 DRUG, Dolnośląska Grupa Użytkowników Ruby
+
+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,106 @@
+# Bbq-rspec
+
+[![Build Status](https://secure.travis-ci.org/drugpl/bbq-rspec.png)](http://travis-ci.org/drugpl/bbq-rspec) [![Dependency Status](https://gemnasium.com/drugpl/bbq-rspec.png)](https://gemnasium.com/drugpl/bbq-rspec) [![Code Climate](https://codeclimate.com/github/drugpl/bbq-rspec.png)](https://codeclimate.com/github/drugpl/bbq-rspec) [![Gem Version](https://badge.fury.io/rb/bbq-rspec.png)](http://badge.fury.io/rb/bbq-rspec)
+
+
+RSpec integration for object oriented acceptance testing with [bbq](https://github.com/drugpl/bbq).
+
+## Setup
+
+Add `bbq-rspec` to your `Gemfile`:
+
+```ruby
+gem "bbq-rspec"
+```
+
+Run install generator:
+
+```
+bundle exec rails generate bbq:install
+```
+
+Require BBQ in spec/spec_helper.rb:
+
+```ruby
+require "bbq/rspec"
+```
+
+## Feature generator
+
+```
+bundle exec rails g bbq:test MyFeatureName
+```
+
+## Running features
+
+```
+bundle exec rake spec:acceptance
+```
+
+## Examples
+
+```ruby
+class TestUser < Bbq::TestUser
+  def email
+    @options[:email] || "buyer@example.com"
+  end
+
+  module Buyer
+    def ask_question(question)
+      fill_in "question", :with => question
+      fill_in "email", :with => email
+      click_on("Ask")
+    end
+
+    def go_to_page_and_open_widget(page_url, &block)
+      go_to_page(page_url)
+      open_widget &block
+    end
+
+    def go_to_page(page_url)
+      visit page_url
+      wait_until { page.find("iframe") }
+    end
+
+    def open_widget
+      within_widget do
+        page.find("#widget h3").click
+        yield if block_given?
+      end
+    end
+
+    def within_widget(&block)
+      within_frame(widget_frame, &block)
+    end
+
+    def widget_frame
+      page.evaluate_script("document.getElementsByTagName('iframe')[0].id")
+    end
+  end
+end
+```
+
+```ruby
+feature "ask question widget" do
+  let(:user) {
+    user = TestUser.new(:driver => :webkit)
+    user.roles('buyer')
+    user
+  }
+
+  scenario "as a guest user, I should be able to ask a question" do
+    user.go_to_page_and_open_widget("/widget") do
+      user.ask_question "my question"
+      expect(user).to see("Thanks!")
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/drugpl/bbq-rspec/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: :spec

data/bbq-rspec.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bbq/rspec/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bbq-rspec"
+  spec.version       = Bbq::RSpec::VERSION
+  spec.authors       = ["DRUG - Dolnośląska Grupa Użytkowników Ruby"]
+  spec.email         = ["bbq@drug.org.pl"]
+  spec.summary       = %q{RSpec integration for bbq.}
+  spec.description   = %q{RSpec integration for bbq.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bbq-core", ">= 0.0"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   ">= 2.0"
+end

data/lib/bbq/rspec.rb

@@ -0,0 +1,43 @@
+require "bbq/core"
+require "bbq/core/test_user"
+require "bbq/rspec/version"
+require "bbq/rspec/matchers"
+require "rspec/core"
+require "capybara/rspec/matchers"
+
+module Bbq
+  module RSpec
+    module Feature
+      def self.included(base)
+        base.metadata[:type]   = :acceptance
+        base.metadata[:caller] = caller
+
+        base.instance_eval do
+          alias :background :before
+          alias :scenario :it
+          alias :feature :describe
+        end
+      end
+    end
+
+    ::RSpec.configure do |config|
+      if Gem::Version.new(::RSpec::Core::Version::STRING) >= Gem::Version.new('2.99')
+        config.include Feature, :type => :acceptance, :file_path => %r{spec/acceptance}
+      else
+        config.include Feature, :type => :acceptance, :example_group => {:file_path => %r{spec/acceptance}}
+      end
+      config.include Matchers
+      config.after :each, :type => :acceptance do
+        ::Bbq::Core::Session.pool.release
+      end
+    end
+  end
+
+  module Core
+    class TestUser
+      include Capybara::RSpecMatchers
+      include ::Bbq::RSpec::Matchers
+      include ::RSpec::Matchers
+    end
+  end
+end

data/lib/bbq/rspec/matchers.rb

@@ -0,0 +1,9 @@
+require "bbq/rspec/matchers/see"
+
+module Bbq
+  module RSpec
+    module Matchers
+      include See
+    end
+  end
+end

data/lib/bbq/rspec/matchers/see.rb

@@ -0,0 +1,71 @@
+module Bbq
+  module RSpec
+    module Matchers
+      module See
+        class Matcher
+          attr_reader :text, :scope
+
+          def initialize(text)
+            @text = text
+            @scope = nil
+          end
+
+          def description
+            if scope
+              "see #{text} within #{scope}"
+            else
+              "see #{text}"
+            end
+          end
+
+          def matches?(actor)
+            @actual = page_fragment(actor)
+            @actual.has_text?(text)
+          end
+
+          def does_not_match?(actor)
+            @actual = page_fragment(actor)
+            @actual.has_no_text?(text)
+          end
+
+          def failure_message_for_should
+            "expected to see \"#{text}\" in #{format(@actual.text)}"
+          end
+          alias :failure_message :failure_message_for_should
+
+          def failure_message_for_should_not
+            "expected not to see \"#{text}\" in #{format(@actual.text)}"
+          end
+          alias :failure_message_when_negated :failure_message_for_should_not
+
+          def within(scope)
+            @scope = scope
+            self
+          end
+
+          private
+          def page_fragment(actor)
+            if scope
+              actor.page.first(*scope)
+            else
+              actor.page
+            end
+          end
+
+          def format(text)
+            case text
+              when Regexp
+                text.inspect
+              else
+                text.to_s.gsub(/[[:space:]]+/, ' ').strip.inspect
+            end
+          end
+        end
+
+        def see(text)
+          Matcher.new(text)
+        end
+      end
+    end
+  end
+end

data/lib/bbq/rspec/version.rb

@@ -0,0 +1,5 @@
+module Bbq
+  module RSpec
+    VERSION = "0.3.0"
+  end
+end

data/spec/acceptance/attributes_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe 'attributes' do
+
+  specify 'acceptance type in spec/acceptance' do
+    expect(RSpec.current_example.metadata[:type]).to eq(:acceptance)
+  end
+
+end

data/spec/rspec_matchers_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'RSpec matchers' do
+
+  specify 'see given string' do
+    user = Bbq::Core::TestUser.new
+    user.visit('/test_page')
+
+    expect { expect(user).to see('Pink') }.to_not raise_error
+  end
+
+  specify 'unable to see given string' do
+    user = Bbq::Core::TestUser.new
+    user.visit('/test_page')
+
+    expect { expect(user).to see('nothing to see') }.to raise_error(RSpec::Expectations::ExpectationNotMetError)
+  end
+
+  specify 'see given string within scope' do
+    user = Bbq::Core::TestUser.new
+    user.visit('/test_page')
+
+    expect { expect(user).to see('Pink').within('#unicorns') }.to_not raise_error
+  end
+
+  specify 'unable to see given string within scope' do
+    user = Bbq::Core::TestUser.new
+    user.visit('/test_page')
+
+    expect { expect(user).to see('Violet').within('#unicorns') }.to raise_error(RSpec::Expectations::ExpectationNotMetError)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require 'bbq/rspec'
+require 'rack/builder'
+
+Bbq::Core.app = Rack::Builder.new do
+  map '/test_page' do
+    html_page = <<-EOP
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <title>Ponycorns</title>
+        </head>
+        <body>
+          <ul id="unicorns">
+            <li>Pink</li>
+          </ul>
+          <ul id="ponies">
+            <li>Violet</li>
+          </ul>
+        </body>
+      </html>
+    EOP
+
+    run ->(env) { ['200', {'Content-Type' => 'text/html'}, [html_page]] }
+  end
+end

data/spec/test_user_matchers_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+class TestUserWithMatchers < Bbq::Core::TestUser
+  def ensure_no_red_ponycorns
+    expect(self).to have_no_content('Red')
+  end
+
+  def ensure_pink_ponycorns
+    expect(self).to see('Pink').within('#unicorns')
+  end
+end
+
+describe 'TestUser matchers' do
+
+  specify 'capybara matcher' do
+    user = TestUserWithMatchers.new
+    user.visit('/test_page')
+
+    expect { user.ensure_no_red_ponycorns }.not_to raise_error
+  end
+
+  specify 'bbq matcher' do
+    user = TestUserWithMatchers.new
+    user.visit('/test_page')
+
+    expect { user.ensure_pink_ponycorns }.not_to raise_error
+  end
+
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: bbq-rspec
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- DRUG - Dolnośląska Grupa Użytkowników Ruby
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bbq-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: RSpec integration for bbq.
+email:
+- bbq@drug.org.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Contributing.md
+- Gemfile.rspec2
+- Gemfile.rspec3
+- LICENSE.txt
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bbq-rspec.gemspec
+- lib/bbq/rspec.rb
+- lib/bbq/rspec/matchers.rb
+- lib/bbq/rspec/matchers/see.rb
+- lib/bbq/rspec/version.rb
+- spec/acceptance/attributes_spec.rb
+- spec/rspec_matchers_spec.rb
+- spec/spec_helper.rb
+- spec/test_user_matchers_spec.rb
+homepage: ''
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: RSpec integration for bbq.
+test_files:
+- spec/acceptance/attributes_spec.rb
+- spec/rspec_matchers_spec.rb
+- spec/spec_helper.rb
+- spec/test_user_matchers_spec.rb