rspec-xunit 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19215c9547e287899a24854728c7dbe40ddf27012b340698c2aad20b2a7b94b3
-  data.tar.gz: e75a2c1d539bff30397b9658a371fe6136945f112ffeb65ea03a29ca9053717c
+  metadata.gz: d48b5d54ba47473aa22ac7ec656b7b3f772b6cbeb64d1bd4fc2f6717d0cf0775
+  data.tar.gz: 8cd92f78030c96d6d2c73b2fb0dc6853ec1a2b399af134160263a9fcc0ba56be
 SHA512:
-  metadata.gz: 7e986afb74f97d4d1cba41a66f38f64a728aaf0fcee2db976e04bae669864d715ba786205dade7d284a36004a63abd85a89e236fdfaf78e73c3297f70ecb837b
-  data.tar.gz: 05a1c176b31bc673aa72ed5b56f398b0857ae8ff02a7c4d27270a547466230c4002a3247d4e9388ff64b04b76e4caf2349f74ba31782236e2f476f09ffe9623c
+  metadata.gz: cbb7e89e1e735e8d593edf2c01b4b406a8af76ea2e59c81e4943e9ca72567460d431a61181c4826039dcf6fe7bfd7b0511f235c5b3e40a83b18f9022ab2c9e73
+  data.tar.gz: 70df062dddc7f78a23f67b7bb15429aa75459c65abeb4920f76048987662bf554790bc468f1974eca43f5081474527435f0774463a7e3c5f41aefa577cb45910

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+-Itest
+--pattern='test/**/*_test.rb'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gsamokovarov@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-xunit.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Genadi Samokovarov
+
+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,178 @@
+The RSpec you know and love with xUnit syntax.
+
+## BDD
+
+```ruby
+require "rails_helper"
+
+RSpec.describe Next::LoginForm do
+  it "validates a user can be found by email" do
+    login = Next::LoginForm.submit email: "oh@no.com", password: ":(",
+
+    expect(login).to be_invalid
+    expect(login.errors.details[:base]).to eq([error: :not_found])
+  end
+
+  it "validates a user can be authenticated" do
+    user = create :user
+
+    expect {
+      login = Next::LoginForm.submit email: user.email, password: user.password
+
+      expect(login).to be_valid
+    }.to change { Session.count }.by(1)
+  end
+end
+```
+
+🤢
+
+## xUnit
+
+```ruby
+require "test_helper"
+
+RSpec.case Next::LoginForm do
+  test "user cannot be found" do
+    login = Next::LoginForm.submit email: "oh@no.com", password: ":("
+
+    assert_invalid? login
+    assert_eq login.errors.details[:base], [error: :not_found]
+  end
+
+  test "user authentication" do
+    user = create :user
+
+    assert_change Session, :count do
+      login = Next::LoginForm.submit email: user.email, password: user.password
+
+      assert_valid? login
+    end
+  end
+end
+```
+
+🥳
+
+## Installation
+
+Add `rspec-xunit` to both the `:development` and `:test` groups of your `Gemfile`:
+
+```ruby
+group :development, :test do
+  gem 'rspec-xunit'
+end
+```
+
+If you want your tests in the `test` directory (as you should, my friend) put
+this in your `.rspec` file:
+
+```
+-Itest
+--pattern='test/**/*_test.rb'
+```
+
+## Syntax
+
+The syntax offered by `rspec-xunit` should be familiar to xUnit testing
+framework users like `minitest`.
+
+You start a test case by `RSpec.case`. This is a simple alias of
+`Rspec.describe`. You define individual tests (what you call examples in your
+past life) with the `test` macro. It is an alias of `it` and it supports all
+it's goodies, like skipping a test with `xtest`.
+
+This leaves us to at the most important change in `rspec-xunit`... You no
+longer write **expectations** but **assertions**!
+
+### Assertions
+
+Let's take a look at single RSpec BDD example:
+
+```ruby
+it "validates a user can be found by email" do
+  login = Next::LoginForm.submit email: "oh@no.com", password: ":(",
+
+  expect(login).to be_invalid
+  expect(login.errors.details[:base]).to eq([error: :not_found])
+end
+```
+
+The line `expect(login).to be_invalid` as an **expectation**. The `be_invalid`
+part of it is a **matcher**. For every RSpec matcher, we have a corresponding
+**assertion**. This is how we can rewrite the example above as a test:
+
+```ruby
+test "user cannot be found" do
+  login = Next::LoginForm.submit email: "oh@no.com", password: ":("
+
+  assert_invalid? login
+  assert_eq login.errors.details[:base], [error: :not_found]
+end
+```
+
+The assertions provided by `rspec-xunit` follow the pattern `assert_:matcher`,
+where `:matcher` is a name of standard RSpec matcher. This way, every matcher
+you expect from RSpec is already available in `rspec-xunit`. 🎉
+
+We even support block matchers like:
+
+```ruby
+test "missing required fields" do
+  assert_raise_error ActiveModel::ValidationError do
+    Next::LoginForm.submit!
+  end
+end
+```
+
+The test above is equivalent to the example below:
+
+```ruby
+it "requires email and password present" do
+  expect {
+    Next::LoginForm.submit!
+  }.to raise_error(ActiveModel::ValidationError)
+end
+```
+
+We have the aliases of `assert_raise` and `assert_raises` to
+`assert_raise_error` for that extra bittersweet xUnit feel. 🤤
+
+Some block-level assertions, though are hard to convert. Take this example,
+for example 😉:
+
+```ruby
+it "validates a user can be authenticated" do
+  user = create :user
+
+  expect {
+    login = Next::LoginForm.submit email: user.email, password: user.password
+
+    expect(login).to be_valid
+  }.to change { Session.count }.by(1)
+end
+```
+
+We cannot translate `change { Session.count }.by(1)` to a nice assertion. This
+is where the `assert` fall-back comes in:
+
+```ruby
+test "user authentication" do
+  user = create :user
+
+  assert {
+    assert_valid? login
+  }.to change { Session.count }.by(1)
+end
+```
+
+This looks suspiciously like `expect` because it is its alias! 🙄 Sometimes
+you just gotta `expect`, I mean `assert`, you know!
+
+Have you noticed the `assert_valid? login` line? We call it an assertion
+predicate! Every assertion ending in a question-mark invokes that predicate
+method on the asserted object.
+
+```ruby
+assert_empty? object_responding_to_empty_question_mark
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec/xunit"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rspec/xunit/assertions.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module RSpec
+  module XUnit
+    # Assertions contains the XUnit friendly assertions to be used in RSpec
+    # examples.
+    module Assertions
+      class << self
+        # Assertion match converts RSpec matchers into an XUnit friendly
+        # assertions.
+        #
+        # For example: `assertion_match :eq` will create an `assert_eq` method
+        # behaving in the same way as:
+        #
+        # `expect(action).to eq(expected)`
+        def assertion_match(matcher, suffix = guess_assertion_suffix(matcher))
+          define_method "assert_#{suffix}" do |value, *args, &block|
+            begin
+              expect(value).to send(matcher, *args, &block)
+            rescue Expectations::ExpectationNotMetError => e
+              raise e, e.message, adjust_for_better_failure_message(e.backtrace), cause: nil
+            end
+          end
+        end
+
+        # Assertion match block converts RSpec block matchers into XUnit
+        # friendly assertions.
+        #
+        # For example: `assertion_match_block :raises, :raise_error` will
+        # create an `assert_raises` method behaving in the same way as:
+        #
+        # `expect { bloc }.to raise_error`
+        def assertion_match_block(matcher, suffix = guess_assertion_suffix(matcher))
+          define_method "assert_#{suffix}" do |*args, &block|
+            begin
+              expect(&block).to send(matcher, *args)
+            rescue Expectations::ExpectationNotMetError => e
+              raise e, e.message, adjust_for_better_failure_message(e.backtrace), cause: nil
+            end
+          end
+        end
+
+        private
+
+        MATCHER_CRUFT_REGEX = /((?:be_)|(?:have_))(.*)/.freeze
+
+        def guess_assertion_suffix(matcher_name)
+          MATCHER_CRUFT_REGEX.match(matcher_name) do |match|
+            match[2]
+          end || matcher_name
+        end
+      end
+
+      assertion_match :be_truthy
+      assertion_match :be_falsy
+      assertion_match :be_nil
+      assertion_match :be
+      assertion_match :be_a
+      assertion_match :be_a, :is_a
+      assertion_match :be_kind_of
+      assertion_match :be_instance_of
+      assertion_match :be_between
+      assertion_match :be_within
+      assertion_match :contain_exactly
+      assertion_match :cover
+      assertion_match :end_with
+      assertion_match :eq
+      assertion_match :equal
+      assertion_match :eql
+      assertion_match :exist
+      assertion_match :have_attributes
+      assertion_match :include
+      assertion_match :all
+      assertion_match :match
+      assertion_match :match_array
+      assertion_match :respond_to
+      assertion_match :satisfy
+      assertion_match :start_with
+      assertion_match :throw_symbol
+      assertion_match :throw_symbol, :throw
+      assertion_match :yield_control
+      assertion_match :yield_with_no_args
+      assertion_match :yield_successive_args
+
+      assertion_match_block :change
+      assertion_match_block :raise_error
+      assertion_match_block :raise_error, :raise
+      assertion_match_block :raise_error, :raises
+      assertion_match_block :output
+
+      # Assert is an alias to `expect`. Use it when all else fails or doesn't
+      # feel right. The `change` assertion with a block is a good example:
+      #
+      # `assert { block }.to change { value }`
+      def assert(value = Expectations::ExpectationTarget::UndefinedValue, &block)
+        Expectations::ExpectationTarget.for(value, block)
+      end
+
+      private
+
+      ASSERTION_PREDICATE_REGEX = /^assert_(.*)\?$/.freeze
+
+      def method_missing(method, *args, &block)
+        ASSERTION_PREDICATE_REGEX.match(method.to_s) do |match|
+          value = args.shift
+          matcher = "be_#{match[1]}"
+
+          expect(value).to Matchers::BuiltIn::BePredicate.new(matcher, *args, &block)
+        end || super
+      end
+
+      def respond_to_missing?(method, *)
+        method =~ ASSERTION_PREDICATE_REGEX || super
+      end
+
+      # TODO(genadi): Figure out where exactly the code shown in the failure
+      # message is extracted.
+      def adjust_for_better_failure_message(backtrace)
+        backtrace.drop_while { |trace| !trace.include?(__FILE__) }[1..-1]
+      end
+    end
+  end
+end
+
+RSpec::Matchers.include RSpec::XUnit::Assertions

data/lib/rspec/xunit/syntax.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+RSpec::Core::ExampleGroup.define_example_group_method :case
+RSpec::Core::ExampleGroup.define_example_group_method :fcase, focus: true
+RSpec::Core::ExampleGroup.define_example_group_method :xcase, skip: 'Temporarily skipped with xcase'
+
+RSpec::Core::ExampleGroup.define_example_method :test
+RSpec::Core::ExampleGroup.define_example_method :ftest, focus: true
+RSpec::Core::ExampleGroup.define_example_method :xtest, skip: 'Temporarily skipped with xtest'
+
+RSpec::Core::Hooks.module_eval do
+  alias_method :setup, :before
+  alias_method :teardown, :after
+end

data/lib/rspec/xunit/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RSpec
+  module XUnit
+    VERSION = '0.4.0'
+  end
+end

data/lib/rspec/xunit.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'rspec/core'
+require 'rspec/expectations'
+require 'rspec/xunit/assertions'
+require 'rspec/xunit/syntax'

data/lib/rspec-xunit.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'rspec/xunit'

data/rspec-xunit.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec/xunit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec-xunit'
+  spec.version       = RSpec::XUnit::VERSION
+  spec.authors       = ['Genadi Samokovarov']
+  spec.email         = ['gsamokovarov@gmail.com']
+  spec.summary       = 'XUnit syntax for RSpec'
+  spec.description   = 'XUnit syntax for RSpec'
+  spec.homepage      = 'https://github.com/gsamokovarov/rspec-xunit'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rspec-core', '>= 3.0'
+  spec.add_dependency 'rspec-expectations', '>= 3.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-xunit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Genadi Samokovarov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2019-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-core
@@ -72,7 +72,22 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rspec-xunit.rb
+- lib/rspec/xunit.rb
+- lib/rspec/xunit/assertions.rb
+- lib/rspec/xunit/syntax.rb
+- lib/rspec/xunit/version.rb
+- rspec-xunit.gemspec
 homepage: https://github.com/gsamokovarov/rspec-xunit
 licenses:
 - MIT