bacon-custom_matchers_messages 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ee7e81802514302f8b01976c544786cb6f826bc7ac04fd909d8543a11d674559
+  data.tar.gz: b8ce21baf9b741468c77ed99bd74f2043d1d6d27659db08ba3e8b088b47f4762
+SHA512:
+  metadata.gz: 32d47ae16dcc850ec06a7e58b1b5123f9c2be55dbf8b9778d2ac3b82da963a0fc5d46184e300e19c445f69d57cd0a898f999313507950c8c062e109e5f6bb289
+  data.tar.gz: 8750650fdfbc8b4dd0579a5115fda4619065d8130ae6a8bd896fba8342134bd5e681a34bb38f5c30055d66fc3967d3918c07d589ef62295e256dfe13db18b377

data/.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.yml]
+indent_style = space
+
+[*.md]
+indent_style = space
+trim_trailing_whitespace = false

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Layout/Tab:
+  Enabled: false
+  IndentationWidth: 2
+Layout/IndentationWidth:
+  Width: 1
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3
+  - 2.4

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Alexander Popov
+
+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,93 @@
+# Bacon::CustomMatchersMessages
+
+Errors messages for [`bacon`](https://github.com/chneukirchen/bacon) custom matchers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bacon-custom_matchers_messages'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install bacon-custom_matchers_messages
+```
+
+## Usage
+
+```ruby
+require 'bacon/custom_matchers_messages'
+
+## Old style, without message:
+
+def shorter_than(max_size)
+  ->(obj) { obj.size < max_size }
+end
+
+# Bacon::Error:
+
+
+## Old style, with error message:
+
+def shorter_than(max_size)
+  lambda do |obj|
+    obj.size < max_size ||
+      "#{obj.inspect} doesn't shorter than #{max_size}"
+  end
+end
+
+# Bacon::Error: "foo bar baz" doesn't shorter than 2
+
+
+## New style, with generated error message:
+
+custom_matcher :shorter_than do |obj, max_size|
+  obj.size < max_size
+end
+
+# Bacon::Error: "foo bar baz" doesn't shorter than 2
+
+
+## Old style, with custom arguments in message:
+
+def include_words(*words)
+  lambda do |obj|
+    words.all? { |word| obj.split.include? word } ||
+      "#{obj.inspect} doesn't include words" \
+      " #{(words - obj.split).map!(&:inspect).join(',')}"
+  end
+end
+
+# Bacon::Error: "foo bar baz" doesn't include words "hello"
+
+
+## New style, with custom arguments for generated error message:
+
+custom_matcher :include_words do |obj, *words|
+  words.all? { |word| obj.split.include? word } ||
+    (words - obj.split)
+end
+
+# Bacon::Error: "foo bar baz" doesn't include words "hello"
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [AlexWayfer/bacon-custom_matchers_messages](https://github.com/AlexWayfer/bacon-custom_matchers_messages).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+task :spec do
+	sh 'bacon -a -s'
+end
+
+task default: :spec

data/bacon-custom_matchers_messages.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/bacon/custom_matchers_messages/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = 'bacon-custom_matchers_messages'
+	spec.version       = Bacon::CustomMatchersMessages::VERSION
+	spec.authors       = ['Alexander Popov']
+	spec.email         = ['alex.wayfer@gmail.com']
+
+	spec.summary       = 'Specify errors messages for `bacon` custom matchers.'
+	spec.description   = 'Allows add errors messages for `bacon` custom matchers'
+	spec.homepage      =
+		'https://github.com/AlexWayfer/bacon-custom_matchers_messages'
+	spec.license       = 'MIT'
+
+	spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+		f.match(%r{^(test|spec|features)/})
+	end
+	spec.require_paths = ['lib']
+
+	spec.add_development_dependency 'bacon', '~> 1.2'
+	spec.add_development_dependency 'bacon-colored_output', '~> 1.1'
+	spec.add_development_dependency 'pry-byebug', '~> 3.4'
+	spec.add_development_dependency 'rake', '~> 12.3'
+	spec.add_development_dependency 'rubocop', '~> 0.65.0'
+end

data/lib/bacon/custom_matchers_messages.rb

@@ -0,0 +1,37 @@
+require_relative 'custom_matchers_messages/version'
+
+module Bacon
+	## Extend bacon for errors messages of custom matchers
+	module CustomMatchersMessages
+		::Should.prepend(
+			Module.new do
+				def satisfy(description = '', &block)
+					r = yield(@object)
+					if r.is_a? String
+						description = r
+						block = ->(_obj) { false }
+					end
+					super(description, &block)
+				end
+			end
+		)
+	end
+end
+
+## Add private method into Kernel for custom matchers
+module Kernel
+	private
+
+	def custom_matcher(name, &_block)
+		description = name.to_s.tr('_', ' ')
+		define_method name do |*args|
+			lambda do |obj|
+				result = yield(obj, *args)
+				return result if result == true
+
+				"#{obj.inspect} doesn't #{description}" \
+					" #{(result || args).map(&:inspect).join(', ')}"
+			end
+		end
+	end
+end

data/lib/bacon/custom_matchers_messages/version.rb

@@ -0,0 +1,5 @@
+module Bacon
+	module CustomMatchersMessages
+		VERSION = '0.1.0'.freeze
+	end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: bacon-custom_matchers_messages
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexander Popov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bacon-colored_output
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.65.0
+description: Allows add errors messages for `bacon` custom matchers
+email:
+- alex.wayfer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bacon-custom_matchers_messages.gemspec
+- lib/bacon/custom_matchers_messages.rb
+- lib/bacon/custom_matchers_messages/version.rb
+homepage: https://github.com/AlexWayfer/bacon-custom_matchers_messages
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Specify errors messages for `bacon` custom matchers.
+test_files: []