limit_detectors 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f398636cec36bb15d61697a991d57a6c68601e1e0c36fa1bc43331e07691dfd
-  data.tar.gz: 8124df6653bdd41a652d8bbef5227af8f786623dd79a896d93570ac259530c73
+  metadata.gz: 9738252b947222c3086089c51114911b2cc620b23c95a1f0b9b768b49cba0b9d
+  data.tar.gz: 7d3724ec0bf9968f1724938c61621d8067573322e1d4ec89b920ffb17ce240ea
 SHA512:
-  metadata.gz: fb52a0fe84e61ed1d555829baf489470e51ae6cbefa30fd5e9480aa59ef8e1470efe82c2ed0b4d9097e34353f9902535f6e6ac877346674eb6f2b2465cb284ef
-  data.tar.gz: d131a52a266b894d03d9909213cd62b5edf6b2b6bece70d4ad3259da8becba4fc3e2b62203c59f62298fa16df9cf131bd06c603fe0d37e865f61c2f10d19065f
+  metadata.gz: bd351474b2c0013b31985c09b218d761432905b1943ba247d0cb839f613661e4ecdb664c3f70720535aeb026ee1a2ee1a676d4ab0a21a3c86e0470669a24abe5
+  data.tar.gz: f55c1be6b0812a2a70db74009175ff21a1012f5ed014f677d9e0d663d6a185fe4b4bb6b894fbf154dcc0917e3890ea5b4f88e56d79af8a2593079951f9f962a1

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'bin/**/*'
+
+Style/EmptyMethod:
+  Enabled: false
+

data/Gemfile

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

data/README.md

@@ -7,8 +7,8 @@ A second reason to create this gem is to explore various other services -- see t
 ## Stati
 
 * Version: [![Gem Version](https://badge.fury.io/rb/limit_detectors.svg)](http://badge.fury.io/rb/limit_detectors)
-* Travis CI: [![Build Status](https://travis-ci.org/s2k/limit_detectors.svg?branch=master)](https://travis-ci.org/s2k/limit_detectors)
-* Code Climate: [![Code Climate](https://codeclimate.com/github/s2k/limit_detectors.png)](https://codeclimate.com/github/s2k/limit_detectors)
+* Travis CI: [![Build Status](https://travis-ci.com/s2k/limit_detectors.svg?branch=main)](https://travis-ci.com/s2k/limit_detectors)
+* Code Climate: [![Maintainability](https://api.codeclimate.com/v1/badges/f29deb5bcd4e2ad44d25/maintainability)](https://codeclimate.com/github/s2k/limit_detectors/maintainability)
 
 
 ## Installation
@@ -27,51 +27,74 @@ Or install it yourself as:
 
 ## Usage
 
-In your code you can `require 'limit_detectors'` then define you classes (or use built-in classes like Array, Hash
-or other enumerable objects), extend these objects with LimitDetectors (or include the module in your class) and
-then call `at_most?` (or àt_least?') on your object.
+In your code, you can `require 'limit_detectors'` then define your classes and `include` module `LimitDetectors` in your class, or create enumerable objects and `extend` these objects with `LimitDetectors`. Then call `at_most?` (or `t_least?`) on your object.
 
-For example:
+For example using `pry`(you can use `irb` as well) you can do this:
 
-    $pry -I lib -r limit_detectors
-    [1] pry(main)> a = [1, 2, 3, 4, 5]
-    => [1, 2, 3, 4, 5]
-    [2] pry(main)> a.extend LimitDetectors
-    => [1, 2, 3, 4, 5]
-    [3] pry(main)> a.at_most?(4){|e| e.odd?}
-    => true # There are indeed no more than 4 odd numbers in the array
-    [4] pry(main)> a.at_most?(1){|e| e.even?}
-    => false # In fact there are two even numbers in the array
+```ruby
+$pry -I lib -r limit_detectors
+[1] pry(main)> a = [1, 2, 3, 4, 5]
+=> [1, 2, 3, 4, 5]
+[2] pry(main)> a.extend LimitDetectors
+=> [1, 2, 3, 4, 5]
+[3] pry(main)> a.at_most?(4){|e| e.odd?}
+=> true # There are indeed no more than 4 odd numbers in the array
+[4] pry(main)> a.at_most?(1){|e| e.even?}
+=> false # In fact there are two even numbers in the array
+```
+
+In code the usage may look like this (see example/example.rb for the file):
+
+```ruby
+require 'limit_detectors'
+
+class Example
+  include Enumerable
+  def each
+    ('a'..'d').each { |c| yield c }
+  end
+end
+
+e = Example.new
+e.extend LimitDetectors
 
-## Compatibility
 
-Please note the current version of 0.0.something, which means the future releases
-may not be compatible with the current version.
+puts e.at_least?(1) { |c| 'f' == c }
+puts e.at_least?(1) { |c| 'b' == c }
+puts e.at_most?(0) { |c| 'b' == c }
+puts e.at_most?(42) { |c| 'b' == c }
+```
+
+
+
+## Compatibility
 
 This gem is tested with these Ruby versions (MRI, unless JRuby):
 
-  - 2.5.8
-  - 2.6.6
-  - 2.7.1
+  - 2.6.7
+  - 2.7.3
+  - 3.0.1
 
 as well as a current version of JRuby.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/limit_detectors/fork )
+1. Fork it ( https://github.com/[my-github-username]/limit_detectors/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
 
+A more detailed descritpion is at https://opensource.com/article/19/7/create-pull-request-github
+
 ### Reporting a bug
 
 Please, provide answers to the following questions, when submitting a bug report:
 
-1. What's actually happening? What the observed behaviour?
-2. What's the expectation, i.e. what should have happened?
+1. What's _actually_ happening? What is the observed behaviour?
+2. What's the _expectation_, i.e. what should have happened?
 3. Why did you expect this behaviour?
 
-If you provide an RSpec check that demonstrates the bug, would give extra good karma,
+If you provide an `RSpec` check that demonstrates the bug, would give extra good karma,
 especially in case of a minimal check, something that just demonstrates the bug without
 any (or much) overhead.

data/Rakefile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new :spec
 
-task :default => :spec
+task default: :spec
 
 task :console do
   exec 'irb -I ./lib -r limit_detectors'

data/example/example.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'limit_detectors'
+
+class Example
+  include Enumerable
+  def each(&block)
+    ('a'..'d').each(&block)
+  end
+end
+
+e = Example.new
+e.extend LimitDetectors
+
+puts e.at_least?(1) { |c| c == 'f' }
+puts e.at_least?(1) { |c| c == 'b' }
+puts e.at_most?(0)  { |c| c == 'b' }
+puts e.at_most?(42) { |c| c == 'b' }

data/lib/limit_detectors.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 require 'limit_detectors/version'
 
 module LimitDetectors
-
   # Deprecated, use at_most? instead
   def at_most(limit, &block)
     Kernel.warn "'at_most' is deprecated, use 'at_most?' instead"
@@ -17,22 +18,21 @@ module LimitDetectors
   # Check whether the condition given in the block
   # occurs at most limit times in the collection
   def at_most?(limit, &block)
-    ocurrences_of(&block) <= limit
+    occurrences_of(&block) <= limit
   end
 
   # Check whether the condition given in the block
   # occurs at least limit times in the collection
   def at_least?(limit, &block)
-    ocurrences_of(&block) >= limit
+    occurrences_of(&block) >= limit
   end
 
   # Count how often the condition given in the block
   # is met for the collection
-  def ocurrences_of &block
-    inject(0) { |res, el|
+  def occurrences_of
+    inject(0) do |res, el|
       res += 1 if yield el
       res
-    }
+    end
   end
-
 end

data/lib/limit_detectors/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LimitDetectors
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/limit_detectors.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'limit_detectors/version'
 
@@ -8,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.version       = LimitDetectors::VERSION
   spec.authors       = ['Stephan Kämper']
   spec.email         = ['the.tester@seasidetesting.com']
-  spec.summary       = %q{Detect certain conditions of elements of an Enumerable object}
-  spec.description   = %q{Some methods to detect whether an Enumerable object contains a constrained number of elements that match a given condition.}
+  spec.summary       = 'Detect certain conditions of elements of an Enumerable object'
+  spec.description   = 'Some methods to detect whether an Enumerable object contains a constrained number of elements that match a given condition.'
   spec.homepage      = ''
   spec.license       = 'MIT'
 
@@ -19,8 +20,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 13.0.3'
-  spec.add_development_dependency 'rspec', '~> 3.10'
   spec.add_development_dependency 'pry', '~> 0.14.1'
   spec.add_development_dependency 'pry-doc', '~> 1.1.0'
+  spec.add_development_dependency 'rake', '~> 13.0.3'
+  spec.add_development_dependency 'rspec', '~> 3.10'
 end

data/spec/limit_detectors_spec.rb

@@ -1,140 +1,137 @@
+# frozen_string_literal: true
+
 require 'set'
 
-Array.send :include, LimitDetectors
+Array.include LimitDetectors
 
 describe '#at_most' do
-
   it 'is true for an empty Array' do
     expect(Kernel).to_not receive(:warn)
-    expect([].at_most?(5){ true }).to be_truthy
-    expect([].at_most?(0){ true }).to be_truthy
-    expect([].at_most?(1){ true }).to be_truthy
-    expect([].at_most?(5){ :foo }).to be_truthy
+    expect([].at_most?(5) { true }).to be_truthy
+    expect([].at_most?(0) { true }).to be_truthy
+    expect([].at_most?(1) { true }).to be_truthy
+    expect([].at_most?(5) { :foo }).to be_truthy
   end
 
   it 'is true if the criterion is met once' do
-    expect(["it's there"].at_most?(1){ |el| el == "it's there"}).to be_truthy
+    expect(["it's there"].at_most?(1) { |el| el == "it's there" }).to be_truthy
   end
 
   it 'is true if all elements meet the criterion and the size is the given maximum number' do
-    expect([1,1,1].at_most?(3){|e| e == 1})
+    expect([1, 1, 1].at_most?(3) { |e| e == 1 })
   end
 
   it 'is false if not enough elements meet the criterion' do
-    expect([1, 2, 4].at_most?(1){|e| e.even?}).to be_falsey
+    expect([1, 2, 4].at_most?(1, &:even?)).to be_falsey
   end
 
   it 'is true if 0 elements are expected to match' do
-    r = Array.new(10){rand}
-    expect(r.at_most?(0){ |i| i > 2 }).to be_truthy
+    r = Array.new(10) { rand }
+    expect(r.at_most?(0) { |i| i > 2 }).to be_truthy
   end
 
   describe 'Hash#at_most' do
-    Hash.send :include, LimitDetectors
+    Hash.include LimitDetectors
     it 'detects a condition based on key as well as value properties' do
-      h = { 'foo' => 1, 'bar' => 4, 'baz' => 5, 'bum' => 1, 'fum' => 0}
-      expect( h.at_most?(3){|ky,vl| ky.match(/^b/) || vl > 1  }).to be_truthy
+      h = { 'foo' => 1, 'bar' => 4, 'baz' => 5, 'bum' => 1, 'fum' => 0 }
+      expect(h.at_most?(3) { |ky, vl| ky.match(/^b/) || vl > 1 }).to be_truthy
     end
   end
-
 end
 
 describe '#at_least' do
-
   it 'is false for an empty Array, if at least one is expected' do
     expect(Kernel).to_not receive(:warn)
-    expect([].at_least?(1){ true }).to be_falsey
+    expect([].at_least?(1) { true }).to be_falsey
   end
 
   it 'is true if the expected number is 0 and Array is empty' do
-    expect([].at_least?(0){ true }).to be_truthy
-    expect({}.at_least?(0){ false }).to be_truthy
+    expect([].at_least?(0) { true }).to be_truthy
+    expect({}.at_least?(0) { false }).to be_truthy
   end
 
   it 'is false if the container ist smaller than the expected number' do
     size = 10
-    expect(Array.new(10).at_least?(size + 1){true}).to be_falsey
+    expect(Array.new(10).at_least?(size + 1) { true }).to be_falsey
   end
 
   it 'is true if the criterion is met and expected once' do
-    expect(["it's there"].at_least?(1){ |el| el == "it's there"}).to be_truthy
+    expect(["it's there"].at_least?(1) { |el| el == "it's there" }).to be_truthy
   end
 
-  it 'is false for an empty Array if you expect at leat 1' do
-    expect([].at_least?(1){ true }).to be_falsey
+  it 'is false for an empty Array if you expect at least 1' do
+    expect([].at_least?(1) { true }).to be_falsey
   end
 
-  it 'is true for an empty Array if you expect at leat 0' do
-    expect([].at_least?(0){  }).to be_truthy
+  it 'is true for an empty Array if you expect at least 0' do
+    expect([].at_least?(0) {}).to be_truthy
   end
 
   it 'is true if the criterion is met once' do
-    expect(["it's there"].at_least?(1){ |el| el == "it's there"}).to be_truthy
+    expect(["it's there"].at_least?(1) { |el| el == "it's there" }).to be_truthy
   end
 
   it 'is true if all elements meet the criterion and the size is the given minimum number' do
-    expect([1,1,1].at_least?(3){|e| e == 1}).to be_truthy
+    expect([1, 1, 1].at_least?(3) { |e| e == 1 }).to be_truthy
   end
 
   it 'is true if enough elements meet the criterion' do
-    expect([1, 2, 4, 8].at_least?(2){|e| e.even?}).to be_truthy
+    expect([1, 2, 4, 8].at_least?(2, &:even?)).to be_truthy
   end
 
   it 'is true if there are enough elements to match' do
-    r = Array.new(10){|i|i}
-    expect(r.at_least?(7){ |i| i > 2 }).to be_truthy
-    expect(r.at_least?(8){ |i| i > 2 }).to be_falsey
+    r = Array.new(10) { |i| i }
+    expect(r.at_least?(7) { |i| i > 2 }).to be_truthy
+    expect(r.at_least?(8) { |i| i > 2 }).to be_falsey
   end
-
 end
 
 describe '#ocurrences_of' do
   context 'collection with content' do
-    Set.send :include, LimitDetectors
-    subject{ Set.new( [1, 2, 3, 4, 5, 6, 7]) }
+    Set.include LimitDetectors
+    subject { Set.new([1, 2, 3, 4, 5, 6, 7]) }
 
-    it('counts 3 even numbers')     { expect( subject.ocurrences_of &:even?).to     be 3 }
-    it('counts 4 odd numbers')      { expect( subject.ocurrences_of &:odd?).to      be 4 }
-    it('counts no number < 0')      { expect( subject.ocurrences_of{ |e| e < 0}).to be 0 }
-    it('counts 7 positive numbers') { expect( subject.ocurrences_of{ |e| e > 0}).to be 7 }
+    it('counts 3 even numbers')     { expect(subject.occurrences_of(&:even?)).to be 3 }
+    it('counts 4 odd numbers')      { expect(subject.occurrences_of(&:odd?)).to be 4 }
+    it('counts no number < 0')      { expect(subject.occurrences_of { |e| e < 0 }).to be 0 }
+    it('counts 7 positive numbers') { expect(subject.occurrences_of { |e| e > 0 }).to be 7 }
   end
 
   context 'empty collection' do
     it 'counts 0 for any empty collection' do
-      [[], Set.new, {}].each do | obj |
-        expect(obj.ocurrences_of {true}).to be(0), "Expected to count 0, for an empty #{obj.class}"
+      [[], Set.new, {}].each do |obj|
+        expect(obj.occurrences_of { true }).to be(0), "Expected to count 0, for an empty #{obj.class}"
       end
     end
   end
 
-  it('doen\'t return nil') { expect([1].ocurrences_of {}).not_to be_nil }
+  it("doesn't return nil") { expect([1].occurrences_of {}).not_to be_nil }
 end
 
-
-describe 'Using an object that doesn\'t respond to #inject' do
+describe "Using an object that doesn't respond to #inject" do
   object = Object.new
   object.extend LimitDetectors
   it 'will raise an exception, if it\'s sent #at_most' do
-    expect{ object.at_most?(1){ |el| el.condition? } }.to raise_exception(NoMethodError, /undefined method .inject./)
+    expect { object.at_most?(1, &:condition?) }.to raise_exception(NoMethodError, /undefined method .inject./)
   end
 end
 
 describe 'Give a warning, if non-predicate versions are used' do
   it 'yields a warning for old-style at_most' do
     expect(Kernel).to receive(:warn).with(/'at_most'.+deprecated.+'at_most\?'/)
-    [1,2,4,8].at_most(2) {|e| e.even?}
+    [1, 2, 4, 8].at_most(2, &:even?)
   end
 
   it 'yields a warning for old-style at_least' do
     expect(Kernel).to receive(:warn).with(/'at_least'.+deprecated.+'at_least\?'/)
-    [1,2,4,8].at_least(2) {|e| e.even?}
-  end
+    [1, 2, 4, 8].at_least(2, &:even?)
   end
+end
 
 describe 'When the provided block raises an exception' do
-  subject{ [1] }
+  subject { [1] }
   it 'passes up the stack unchanged' do
-    expect{ subject.at_most?(1) { raise ArgumentError, 'BoomError' } }.to raise_error(ArgumentError, 'BoomError')
-    expect{ subject.ocurrences_of { raise ArgumentError, 'BoomError'} }.to raise_error(ArgumentError, 'BoomError')
+    expect { subject.at_most?(1) { raise ArgumentError, 'BoomError' } }.to raise_error(ArgumentError, 'BoomError')
+    expect { subject.occurrences_of { raise ArgumentError, 'BoomError' } }.to raise_error(ArgumentError, 'BoomError')
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'limit_detectors'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
@@ -7,9 +9,9 @@ require 'limit_detectors'
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  #config.treat_symbols_as_metadata_keys_with_true_values = true
-  #config.run_all_when_everything_filtered = true
-  #config.filter_run :focus
+  # config.treat_symbols_as_metadata_keys_with_true_values = true
+  # config.run_all_when_everything_filtered = true
+  # config.filter_run :focus
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: limit_detectors
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Stephan Kämper
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-01 00:00:00.000000000 Z
+date: 2021-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,61 +25,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: 0.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: 0.14.1
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry-doc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 13.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.1
+        version: 13.0.3
 - !ruby/object:Gem::Dependency
-  name: pry-doc
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '3.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: '3.10'
 description: Some methods to detect whether an Enumerable object contains a constrained
   number of elements that match a given condition.
 email:
@@ -90,11 +90,13 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- example/example.rb
 - lib/limit_detectors.rb
 - lib/limit_detectors/version.rb
 - limit_detectors.gemspec