rspec-matcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8341fb1025efb39d3636ec52f6fe98122f8e04a6
+  data.tar.gz: 0548717cf018015a0ea92211e8fd09dfbf643be7
+SHA512:
+  metadata.gz: 0cb7ee5d8b98ab55ae7265ace61f2768c39e674f25bac70f4a95b11b8349e5b566f12fc1640969bf1294ffd967ac3b05bcfc1bdebf84b17a7102947a89cd5b5f
+  data.tar.gz: 937e1327820d681dbed4dec4062128529ce57be1ef5b1148dc6c29931b9e93fa1bfd1b4a50f05d0e7437f476cd24c753789781c9df684114fd6ceb5623fc5a8d

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2016 [Pooyan Khosravi](https://www.github.com/pekhee).
+
+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,110 @@
+# RspecMatcher
+
+[![Gem Version](https://badge.fury.io/rb/rspec-matcher.svg)](http://badge.fury.io/rb/rspec-matcher)
+[![Code Climate GPA](https://codeclimate.com/github/pekhee/rspec-matcher.svg)](https://codeclimate.com/github/pekhee/rspec-matcher)
+[![Code Climate Coverage](https://codeclimate.com/github/pekhee/rspec-matcher/coverage.svg)](https://codeclimate.com/github/pekhee/rspec-matcher)
+[![Gemnasium Status](https://gemnasium.com/pekhee/rspec-matcher.svg)](https://gemnasium.com/pekhee/rspec-matcher)
+[![Travis CI Status](https://secure.travis-ci.org/pekhee/rspec-matcher.svg)](https://travis-ci.org/pekhee/rspec-matcher)
+[![Inch CI](https://inch-ci.org/github/pekhee/rspec-matcher.svg?branch=master)](https://inch-ci.org/github/pekhee/rspec-matcher)
+[![Gitter](https://camo.githubusercontent.com/da2edb525cde1455a622c58c0effc3a90b9a181c/68747470733a2f2f6261646765732e6769747465722e696d2f4a6f696e253230436861742e737667)](https://gitter.im/pekhee/rspec-matcher)
+
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
+# Table of Contents
+
+- [Features](#features)
+- [Requirements](#requirements)
+- [Setup](#setup)
+- [Usage](#usage)
+- [Tests](#tests)
+- [Versioning](#versioning)
+- [Code of Conduct](#code-of-conduct)
+- [Contributions](#contributions)
+- [License](#license)
+- [History](#history)
+- [Credits](#credits)
+
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
+
+# Features
+- Implementes RSpec matcher interface as a module.
+- Registers matcher with RSpec.
+- It is stable in contrast to RSpec::Matchers::BaseMatcher.
+- Well tested and documented.
+
+# Requirements
+
+0. [MRI 2.1.0](https://www.ruby-lang.org)
+
+# Setup
+
+For a secure install, type the following (recommended):
+
+    gem cert --add <(curl -Ls https://raw.githubusercontent.com/pekhee/rspec-matcher/master/gem-public.pem)
+    gem install rspec-matcher --trust-policy MediumSecurity
+
+NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
+allowing the installation of unsigned dependencies since they are beyond the scope of this gem.
+
+For an insecure install, type the following (not recommended):
+
+    gem install rspec-matcher
+
+Add the following to your Gemfile:
+
+    gem "rspec-matcher"
+
+# Usage
+[API Reference](http://www.rubydoc.info/github/pekhee/rspec-matcher/master)
+
+    class BeNilMatcher
+      include RSpec::Matcher
+      register_as "be_nil"
+
+      def match
+        actual.nil?
+      end
+
+      def failure_message
+        "expected #{expected} to be nil"
+      end
+    end
+
+    expect(nil).to be_nil
+
+# Tests
+
+To test, run:
+
+    bundle exec rake
+
+# Versioning
+
+Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
+
+- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+
+# Code of Conduct
+
+Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By participating in this project
+you agree to abide by its terms.
+
+# Contributions
+
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+# License
+
+Copyright (c) 2016 [Pooyan Khosravi](https://www.github.com/pekhee).
+Read the [LICENSE](LICENSE.md) for details.
+
+# History
+
+Read the [CHANGELOG](CHANGELOG.md) for details.
+Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
+
+# Credits
+
+Developed by [Pooyan Khosravi](https://www.github.com/pekhee) at [Pooyan Khosravi](https://www.github.com/pekhee).

data/lib/rspec/matcher/identity.rb

@@ -0,0 +1,23 @@
+module RSpec
+  module Matcher
+    # Gem identity information.
+    # @api private
+    module Identity #:nodoc:
+      def self.name
+        "rspec-matcher"
+      end
+
+      def self.label
+        "RSpec::Matcher"
+      end
+
+      def self.version
+        "0.1.0"
+      end
+
+      def self.version_label
+        "#{label} #{version}"
+      end
+    end
+  end
+end

data/lib/rspec/matcher.rb

@@ -0,0 +1,158 @@
+require "rspec/matcher/identity"
+require "active_support/concern"
+
+module RSpec
+  # Provides minimal interface for creating RSpec Matchers.
+  #
+  # Register matcher with RSpec via `register_as`.
+  #
+  # Include `RSpec::Matchers::Composable` to support composable matchers.
+  #
+  # @example
+  #   class BeNil
+  #     include RSpec::Matcher
+  #     register_as "be_nil"
+  #
+  #     def match
+  #       return actual.nil?
+  #     end
+  #   end
+  #
+  #   expect(actual).to be_nil
+  #
+  # ## Required Methods:
+  # - `match`
+  #
+  # ## Optional Methods:
+  # - `description`
+  # - `failure_message`
+  # - `failure_message_when_negated`
+  # - `diffable?`
+  # - `supports_block_expectations?`
+  module Matcher
+    extend ActiveSupport::Concern
+
+    # To indicate no value was passed to matcher
+    UNDEFINED = Object.new.freeze
+
+    included do
+      prepend RSpec::Matcher::PrependedMethods
+
+      attr_accessor :expected, :actual
+    end
+
+    # @api private
+    # Used to let user define initialize
+    module PrependedMethods #:nodoc:
+      # Stores expected and passes all args to super
+      # @api private
+      # @param [any] expected stored as expected and not passed to custom initializer
+      # @param [any] args... passed to custom initializer
+      # @param [Proc] block passed to custom initializer
+      def initialize expected = UNDEFINED, *args, &block
+        self.expected = expected
+        super(*args, &block)
+      end
+    end
+
+    # Methods added as class method to includer
+    module ClassMethods
+      # Registers this matcher in RSpec.
+      # @example
+      #   class BeNil
+      #     include RSpec::Matcher
+      #     register_as "be_nil"
+      #     #...
+      #   end
+      #
+      #   expect(actual).to be_nil
+      #
+      # @param [String] name what to register this matcher as
+      # @return [void]
+      def register_as name
+        s = self
+        m = Module.new do
+          define_method name do |*args, &block|
+            s.new(*args, &block)
+          end
+        end
+
+        RSpec.configure do |config|
+          config.include m
+        end
+      end
+    end
+
+    # @api private
+    # Hides RSpec internal api
+    def matches? actual
+      self.actual = actual
+      return match if method(:match).arity == 0
+
+      match actual
+    end
+
+    # @method actual
+    # @example expect(actual).to be(expected)
+    # @return [any] value passed to `expect()`
+
+    # @method expected
+    # @example expect(actual).to be(expected)
+    # @return [any] value passed to matcher function.
+
+    # @method initialize
+    # First argument passed to matcher is placed in expected and removed from
+    # arg list. Every argument beside that including a block is passed to
+    # initialize function.
+
+    # Determines if there is a match or not.
+    # @note Must be implemented.
+    # @param [any] actual same as actual method.
+    # @return [Boolean] true for success, false for failure.
+    def match _ = nil
+      raise "not implemented"
+    end
+
+    # Describes what this matcher does for composable matchers.
+    # @example be an string with X length
+    # @example match X regex
+    # @note raises by default
+    # @return [String]
+    def description
+      raise "not implemented"
+    end
+
+    # Describe failure.
+    # @example "expected EXPECTED to be of length X"
+    # @example "expected EXPECTED to match X"
+    # @note raises by default
+    # @return [String]
+    def failure_message
+      raise "not implemented"
+    end
+
+    # Describe failure when not_to is used.
+    # @example "expected EXPECTED not to be of length X"
+    # @example "expected EXPECTED not to match X"
+    # @note raises by default
+    # @return [String]
+    def failure_message_when_negated
+      raise "not implemented"
+    end
+
+    # Indicates if actual and expected should be diffed on failure.
+    # @note false by default
+    # @return [Boolean]
+    def diffable?
+      false
+    end
+
+    # Indicates if actual can be a block.
+    # @example expect { something }.not_to raise_error
+    # @note false by default
+    # @return [Boolean]
+    def supports_block_expectations?
+      false
+    end
+  end
+end

data/lib/tasks/rspec.rake

@@ -0,0 +1,6 @@
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => error
+  puts error.message
+end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,6 @@
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError => error
+  puts error.message
+end

metadata

@@ -0,0 +1,283 @@
+--- !ruby/object:Gem::Specification
+name: rspec-matcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pooyan Khosravi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: gemsmith
+  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: pry
+  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: pry-byebug
+  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: pry-remote
+  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: pry-state
+  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: pry-rescue
+  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: pry-stack_explorer
+  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: rspec
+  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: rb-fsevent
+  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: guard-rspec
+  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: terminal-notifier
+  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: terminal-notifier-guard
+  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: rubocop
+  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: codeclimate-test-reporter
+  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: RSpec Base Matcher implementation with automatic registration as a module.
+email:
+- pekhee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- LICENSE.md
+- README.md
+- lib/rspec/matcher.rb
+- lib/rspec/matcher/identity.rb
+- lib/tasks/rspec.rake
+- lib/tasks/rubocop.rake
+homepage: https://github.com/pekhee/rspec-matcher
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Implements RSpec Matcher interface as a module.
+test_files: []
+has_rdoc: