ndd-rspec 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1a9bf838319f743f0d510c8d245a4c22a2b0a12
-  data.tar.gz: cac3a557d43dc3e55594cacfc5452a9cc0a53ed1
+  metadata.gz: 48560d36649996143083b484f812383fcaa87489
+  data.tar.gz: 60f58615753e6ca3ce6d28282167096133aa9f82
 SHA512:
-  metadata.gz: fc0f7ece221e305b2801bab2b8533ecce8e1fa63a9e80faf736f592d0664eaf9a19f6f5311b52a785eaa29408155c5ae0fbba7976420709c5c3bbaf5f3c6753f
-  data.tar.gz: c26ccd336525beee3f29d9245e7e796d9c30383671813f2c375d39dc7da7904df2de1d2784fec9a568520703464bf6a2bb5f74e0df96b5a536d2f0ffe03a803a
+  metadata.gz: f87c4738d01ce7197f0a9185ab49d054f21034d1bed8ceabef05804525c605eb28f319502326773fe586dc21e05ead1448601a2f8d5cbf6986d6828ef4bebedd
+  data.tar.gz: 14b3fb92cdcec8c3a96a6d96a087a2c229a87f95411c5eb0270596dcd83040f87ecd9bcc56e25cba65aa4903a7946edebf4e2cc6f720ad38d4746c0fefaced9c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # NDD RSpec changelog
 
+## Version 1.2.0
+
+- Drop Jeweler
+- Update matchers to newer versions of RSpec
+
 ## Version 1.1.2
 
 - Updated dependencies to fix security alerts

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 c_inconnu2@yahoo.fr. 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/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 David DIDIER
+
+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

@@ -4,8 +4,8 @@
 [![Dependency Status](https://gemnasium.com/ddidier/ndd-rspec.png)](https://gemnasium.com/ddidier/ndd-rspec)
 [![Code Climate](https://codeclimate.com/github/ddidier/ndd-rspec/badges/gpa.svg)](https://codeclimate.com/github/ddidier/ndd-rspec)
 [![Test Coverage](https://codeclimate.com/github/ddidier/ndd-rspec/badges/coverage.svg)](https://codeclimate.com/github/ddidier/ndd-rspec)
-[![Documentation Coverage](https://inch-ci.org/github/ddidier/ndd-rspec.svg)](https://inch-ci.org/github/ddidier/ndd-rspec)
 [![Yard Documentation](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/ddidier/ndd-rspec)
+[![Documentation Coverage](https://inch-ci.org/github/ddidier/ndd-rspec.svg)](https://inch-ci.org/github/ddidier/ndd-rspec)
 
 RSpec utilities.
 
@@ -13,37 +13,59 @@ The API documentation can be find at [RubyDoc](http://www.rubydoc.info/github/dd
 
 ## Prerequisites
 
-This gem requires RSpec 3.1 and is tested with:
+This gem requires:
 
-- Ruby 1.9.3
-- Ruby 2.0.0
-- Ruby 2.1.x
+- `rspec >= 3.0`
 
-## Matchers
+And is tested with:
 
-### be\_sorted\_by
+- `Ruby 2.4`
+- `Ruby 2.3`
+- `Ruby 2.2`
 
-```ruby
-expect([1, 2, 3]).to be_sorted_by(:to_i)  # => success
-expect([1, 3, 2]).to be_sorted_by(:to_i)  # => failure
+## Installation
+
+Add this line to your application's Gemfile:
 
-Duck = Struct.new(:color)
-expect([Duck.new('Grey'), Duck.new('White')]).to be_sorted_by(:color) }  # => success
-expect([Duck.new('White'), Duck.new('Grey')]).to be_sorted_by(:color) }  # => failure
+```ruby
+gem 'ndd-rspec-rails'
 ```
 
-### be\_reverse\_sorted\_by
+And then execute `bundle`
+
+Or install it yourself with `gem install ndd-rspec-rails`
+
+## Matchers
+
+### be_sorted_by
 
 ```ruby
-expect([3, 2, 1]).to be_reverse_sorted_by(:to_i)  # => true
-expect([1, 3, 2]).to be_reverse_sorted_by(:to_i)  # => false
+expect(%w[1 2 3]).to be_sorted_by(:to_i)  # => success
+expect(%w[1 3 2]).to be_sorted_by(:to_i)  # => failure
+```
+
+### be_reverse_sorted_by
 
-Duck = Struct.new(:color)
-expect([Duck.new('White'), Duck.new('Grey')]).to be_reverse_sorted_by(:color) }  # => success
-expect([Duck.new('Grey'), Duck.new('White')]).to be_reverse_sorted_by(:color) }  # => failure
+```ruby
+expect(%w[3 2 1]).to be_reverse_sorted_by(:to_i)  # => true
+expect(%w[1 3 2]).to be_reverse_sorted_by(:to_i)  # => false
 ```
 
-## Copyright
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can 
+also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the 
+version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, 
+push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ddidier/ndd-rspec. This project is 
+intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the 
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
 
-Copyright (c) 2014 David DIDIER.
-See `LICENSE.txt` for further details.
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ndd/rspec/rails'
+
+# 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/rubocop

@@ -0,0 +1,22 @@
+#!/bin/bash
+
+APPLICATION_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." && pwd )"
+
+function _rubocop() {
+    local txt_orange='\e[38;5;214m'
+    local txt_reset='\e[0m'
+
+    pushd $APPLICATION_DIR > /dev/null \
+    && \
+    rubocop \
+        -D -R \
+        --format html -o tmp/rubocop.html \
+        --format progress \
+        --format offenses \
+    ; \
+    echo -e "${txt_orange}HTML report was generated at:\n  file://$APPLICATION_DIR/tmp/rubocop.html${txt_reset}" \
+    ; \
+    popd > /dev/null
+}
+
+_rubocop $@

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/ndd/rspec.rb

@@ -0,0 +1,2 @@
+require 'ndd/rspec/version'
+require 'ndd/rspec/matchers'

data/lib/ndd/rspec/matchers.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
 require 'ndd/rspec/matchers/be_reverse_sorted_by'
 require 'ndd/rspec/matchers/be_sorted_by'
 
-
-module RSpec::Matchers
-  include Ndd::RSpec::Matchers
+RSpec.configure do |config|
+  config.include Ndd::RSpec::Matchers
 end

data/lib/ndd/rspec/matchers/be_reverse_sorted_by.rb

@@ -1,68 +1,60 @@
-# encoding: utf-8
-require 'rspec/expectations'
-
-
 module Ndd
   module RSpec
-    module Matchers
+    module Matchers #:nodoc:
 
-      # Ensures that an enumerable responding to {#collect} is sorted in reverse order by the given attribute or
-      # method return value of the objects it contains.
+      # Ensures that an enumerable responding to
+      # {https://ruby-doc.org/core/Enumerable.html#method-i-collect Enumerable#collect} is sorted in reverse order by
+      # the values of the given attribute or by return values of the given method.
       #
       # @example
-      #     Duck = Struct.new(:color)
-      #
-      #     describe 'sorting' do
-      #       let(:a_pair_of_sorted_ducks)         { [Duck.new('Grey'), Duck.new('White')] }
-      #       let(:a_pair_of_reverse_sorted_ducks) { [Duck.new('White'), Duck.new('Grey')] }
       #
-      #       it { expect(a_pair_of_sorted_ducks).to_not     be_reverse_sorted_by(:color) }
-      #       it { expect(a_pair_of_reverse_sorted_ducks).to be_reverse_sorted_by(:color) }
-      #     end
+      #   REVERSE_SORTED_ARRAY = ['3', '2', '1'].freeze
+      #   UNSORTED_ARRAY = ['1', '3', '2'].freeze
       #
-      # @param attribute [Symbol] the attribute or the method to sort with
-      # @return [Ndd::RSpec::Matchers::BeSortedBy]
+      #   it { expect(SORTEDREVERSE_SORTED_ARRAY_ARRAY).to be_reverse_sorted_by(:to_i) }
+      #   it { expect(UNSORTED_ARRAY).to_not be_reverse_sorted_by(:to_i) }
       #
+      # @param attribute [Symbol] the attribute or the method to sort with.
+      # @return [Ndd::RSpec::Matchers::BeReverseSortedBy]
       def be_reverse_sorted_by(attribute)
         BeReverseSortedBy.new(attribute)
       end
 
-      # @private
+      # ------------------------------------------------------------------------------------------------------------
+      # Implements {#be_reverse_sorted_by}.
+      #
       class BeReverseSortedBy
 
-        def initialize(attribute = nil)
+        # @param attribute [Symbol] the attribute or the method to sort with.
+        def initialize(attribute)
           @attribute = attribute
         end
 
+        # @param actual [Object] the object being tested.
+        # @return [Boolean] true if the object is reverse sorted according to the given attribute, false otherwise.
         def matches?(actual)
           @actual = actual
           attributes = actual.collect { |e| e.send(@attribute) }
           @actual_attributes = attributes
-          @sorted_attributes = attributes.sort.reverse
-          @sorted_attributes == @actual_attributes
+          @expected_attributes = attributes.sort.reverse
+          @expected_attributes == @actual_attributes
         end
 
+        # @return [String] a description of this matcher.
         def description
-          "be sorted by '#@attribute' in reverse order"
+          "be sorted in reverse order by '#{@attribute}'"
         end
 
+        # @return [String] details about the failure of this matcher.
         def failure_message
-          return <<-MESSAGE
-
-expected '#{@actual.inspect}' to be sorted by '#@attribute' in reverse order
-expected attributes: #{@sorted_attributes.inspect}
-     got attributes: #{@actual_attributes.inspect}
-
-          MESSAGE
-        end
-
-        def ==(other)
-          matches?(other)
+          message = ''
+          message << "expected '#{@actual.inspect}'to be sorted in reverse order by '#{@attribute}' but\n"
+          message << "  expected attributes: #{@expected_attributes.inspect}\n"
+          message << "  actual attributes: #{@actual_attributes.inspect}"
+          message
         end
       end
 
-      private_constant :BeReverseSortedBy
-
     end
   end
 end

data/lib/ndd/rspec/matchers/be_sorted_by.rb

@@ -1,69 +1,60 @@
-# encoding: utf-8
-require 'rspec/expectations'
-
-
 module Ndd
   module RSpec
-    module Matchers
+    module Matchers #:nodoc:
 
-      # Ensures that an enumerable responding to {#collect} is sorted by the given attribute or method return value of
-      # the objects it contains.
+      # Ensures that an enumerable responding to
+      # {https://ruby-doc.org/core/Enumerable.html#method-i-collect Enumerable#collect} is sorted by the values of
+      # the given attribute or by return values of the given method.
       #
       # @example
-      #     Duck = Struct.new(:color)
       #
-      #     describe 'sorting' do
-      #       let(:a_pair_of_sorted_ducks)         { [Duck.new('Grey'), Duck.new('White')] }
-      #       let(:a_pair_of_reverse_sorted_ducks) { [Duck.new('White'), Duck.new('Grey')] }
+      #   SORTED_ARRAY = ['1', '2', '3'].freeze
+      #   UNSORTED_ARRAY = ['1', '3', '2'].freeze
       #
-      #       it { expect(a_pair_of_sorted_ducks).to             be_sorted_by(:color) }
-      #       it { expect(a_pair_of_reverse_sorted_ducks).to_not be_sorted_by(:color) }
-      #     end
+      #   it { expect(SORTED_ARRAY).to be_sorted_by(:to_i) }
+      #   it { expect(UNSORTED_ARRAY).to_not be_sorted_by(:to_i) }
       #
-      # @param attribute [Symbol] the attribute or the method to sort with
+      # @param attribute [Symbol] the attribute or the method to sort with.
       # @return [Ndd::RSpec::Matchers::BeSortedBy]
-      #
       def be_sorted_by(attribute)
         BeSortedBy.new(attribute)
       end
 
-
-      # @private
+      # ------------------------------------------------------------------------------------------------------------
+      # Implements {#be_sorted_by}.
+      #
       class BeSortedBy
 
-        def initialize(attribute = nil)
+        # @param attribute [Symbol] the attribute or the method to sort with.
+        def initialize(attribute)
           @attribute = attribute
         end
 
+        # @param actual [Object] the object being tested.
+        # @return [Boolean] true if the object is sorted according to the given attribute, false otherwise.
         def matches?(actual)
           @actual = actual
           attributes = actual.collect { |e| e.send(@attribute) }
           @actual_attributes = attributes
-          @sorted_attributes = attributes.sort
-          @sorted_attributes == @actual_attributes
+          @expected_attributes = attributes.sort
+          @expected_attributes == @actual_attributes
         end
 
+        # @return [String] a description of this matcher.
         def description
-          "be sorted by '#@attribute'"
+          "be sorted by '#{@attribute}'"
         end
 
+        # @return [String] details about the failure of this matcher.
         def failure_message
-          return <<-MESSAGE
-
-expected '#{@actual.inspect}' to be sorted by '#@attribute'
-expected attributes: #{@sorted_attributes.inspect}
-     got attributes: #{@actual_attributes.inspect}
-
-          MESSAGE
-        end
-
-        def ==(other)
-          matches?(other)
+          message = ''
+          message << "expected '#{@actual.inspect}'to be sorted by '#{@attribute}' but\n"
+          message << "  expected attributes: #{@expected_attributes.inspect}\n"
+          message << "  actual attributes: #{@actual_attributes.inspect}"
+          message
         end
       end
 
-      private_constant :BeSortedBy
-
     end
   end
 end