select_by 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: bc787435838656dc0bf8a2ea5e8a4c238b05598c
4
+ data.tar.gz: 69463e2557d5d78431673b5c1831d547029cefe1
5
+ SHA512:
6
+ metadata.gz: 56155431b0347aee3171737d3e22e13d6f06eaef4ea595a7068ce8af24e07630e1df971fa885179395a827548aa4db12634ac5dd98b97d723359fe66fc7553d6
7
+ data.tar.gz: 26b0b7106d900d6e7011c3ef37d3e242b106a4258be280574c65c21a965ef544851133a6c72a383a89b6aba30fe55b6c483f6ff5fdc9dac8746c4cb73f642f1f
@@ -0,0 +1,9 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,4 @@
1
+ language: ruby
2
+ rvm:
3
+ - 2.2.0
4
+ before_install: gem install bundler -v 1.11.2
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at tom@buildinsync.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in select_by.gemspec
4
+ gemspec
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2018 Tom Corley
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,64 @@
1
+ # SelectBy
2
+
3
+ SelectBy is a ruby gem that adds some equality methods onto the Array class.
4
+
5
+ If you have ever used select in this manner:
6
+
7
+ ```
8
+ ["smith","pete","tom","sara"].select { |name| name.first == "s" && name.size == 5 }.map(&:upcase) # => ["SMITH"]
9
+ ```
10
+ this can be accomplished with
11
+
12
+ ```
13
+ ["smith","pete","tom","sara"].select_by(:first => "s", :size => 5, &:upcase)
14
+ ```
15
+
16
+ ## Installation
17
+
18
+ Add this line to your application's Gemfile:
19
+
20
+ ```ruby
21
+ gem 'select_by'
22
+ ```
23
+
24
+ And then execute:
25
+
26
+ $ bundle
27
+
28
+ Or install it yourself as:
29
+
30
+ $ gem install select_by
31
+
32
+ ## Usage
33
+
34
+ By including this gem you will add :select_by (aliased as find_all_by), :reject_by, :detect_by (aliased as find_by), :partition_by methods to the Array class. if a hash is provided as the argument use each hash key as a method name and value as what the method should return if any of key/value pairs are not callable or do not match the reciever based on equality then reject the element of the array. if the argument that is provided is a callable method (calling to_s on the object returns a method the element responds to) then call that method on each element only returning the elements that return a truthy value (similar to select(&:method)).
35
+
36
+ if you provide a code block the method will apply that code block to each returned element and return the resulting array
37
+
38
+ ```
39
+ ["Smith", "peter"].detect_by(:size => 5) # => "Smith"
40
+ ["Smith", "peter"].detect_by(:size => 5, &:downcase) # => "smith"
41
+ ["Smith", "peter"].select_by(:size => 5) {|name| name.downcase} # => ["smith", "peter"]
42
+ ["Smith", "peter"].reject_by(:size => 5, &:downcase) # => []
43
+ ["Smith", "peter"].partition_by(:size => 5) # => [["Smith"],["peter"]]
44
+
45
+ when the object does not respond to the key the selecting block assumes it is falsey
46
+ ["Smith", "peter"].reject_by(:peter => 5, &:downcase) # => ["smith", "peter"]
47
+ ["Smith", "peter"].select_by(:peter => 5, &:downcase) # => []
48
+ ```
49
+
50
+ ## Development
51
+
52
+ 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.
53
+
54
+ 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).
55
+
56
+ ## Contributing
57
+
58
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/select_by. 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.
59
+
60
+
61
+ ## License
62
+
63
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
64
+
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "select_by"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,5 @@
1
+ require "select_by/version"
2
+ require "select_by/core_extensions/array/selecting_by"
3
+ module SelectBy
4
+ Array.include SelectBy::CoreExtensions::Array::SelectingBy
5
+ end
@@ -0,0 +1,103 @@
1
+ module SelectBy
2
+ module CoreExtensions
3
+ module Array
4
+ module SelectingBy
5
+ SELECTING_METHODS = [:select, :reject, :detect, :partition, :find_all, :find]
6
+
7
+ class InvalidArgumentError < StandardError
8
+ def message
9
+ "method argument or hash key must respond to to_s"
10
+ end
11
+ end
12
+
13
+ class InvalidSelectingMethodError < StandardError
14
+ def message
15
+ "Only #{SELECTING_METHODS} methods can be passed to private method: :selecting_by"
16
+ end
17
+ end
18
+
19
+ # if a hash is provided use each hash key as a method name and value as what the method should return
20
+ # if any of key/value pairs are not callable or do not match the reciever based on equality then reject
21
+ # the element of the array. if argument that is provided is a callable method (calling to_s on the object
22
+ # returns a method the element responds to) then call that method on each element only returning the elements
23
+ # that return a truthy value (similar to select(&:method)).
24
+ #
25
+ # if you provide a code block the method will apply that code block to each returned element
26
+ #
27
+ # ["Smith", "peter"].detect_by(:size => 5) # => "Smith"
28
+ # ["Smith", "peter"].detect_by(:size => 5, &:downcase) # => "smith"
29
+ # ["Smith", "peter"].select_by(:size => 5) {|name| name.downcase} # => ["smith", "peter"]
30
+ # ["Smith", "peter"].reject_by(:size => 5, &:downcase) # => []
31
+ #
32
+ # when the object does not respond to the key the selecting block assumes it is falsey
33
+ # ["Smith", "peter"].reject_by(:peter => 5, &:downcase) # => ["smith", "peter"]
34
+ # ["Smith", "peter"].select_by(:peter => 5, &:downcase) # => []
35
+
36
+ def select_by(hash_or_method = nil, &block)
37
+ select_or_reject_by(:select, hash_or_method, &block)
38
+ end
39
+
40
+ # works the same as select_by but returns elements that do not evaluate to true
41
+ def reject_by(hash_or_method = nil, &block)
42
+ select_or_reject_by(:reject, hash_or_method, &block)
43
+ end
44
+
45
+ def partition_by(hash_or_method = nil, &block)
46
+ array = if hash_or_method.nil?
47
+ [self, []]
48
+ else
49
+ selecting_by(:partition, hash_or_method)
50
+ end
51
+
52
+ block_given? ? array.map{|inner_array| inner_array.map(&block)} : array
53
+ end
54
+
55
+ def detect_by(hash_or_method = nil, &block)
56
+ array = if hash_or_method.nil?
57
+ self
58
+ else
59
+ selecting_by(:select, hash_or_method, true)
60
+ end
61
+
62
+ (block_given? ? array.map(&block) : array).first
63
+ end
64
+
65
+ alias_method :find_by, :detect_by
66
+ alias_method :find_all_by, :select_by
67
+
68
+ private
69
+
70
+ def select_or_reject_by(meth, hash_or_method, &block)
71
+ array = if hash_or_method.nil?
72
+ self
73
+ else
74
+ selecting_by(meth, hash_or_method)
75
+ end
76
+ block_given? ? array.map(&block) : array
77
+ end
78
+
79
+ def selecting_by(meth, hash_or_method, stop_first_time = false)
80
+ raise InvalidArgumentError unless (meth.respond_to?(:to_sym))
81
+ raise InvalidSelectingMethodError unless SELECTING_METHODS.include?(meth.to_sym)
82
+
83
+ send(meth) do |obj|
84
+ case hash_or_method
85
+ when Hash
86
+ val = hash_or_method.all? do |key, value|
87
+ raise InvalidArgumentError.new unless key.respond_to?(:to_s)
88
+ obj.respond_to?(key.to_s) && obj.send(key.to_s) == value
89
+ end
90
+ return [obj] if val && stop_first_time
91
+ val
92
+ else
93
+ raise InvalidArgumentError.new unless hash_or_method.respond_to?(:to_s)
94
+ val = obj.respond_to?(hash_or_method.to_s) && obj.send(hash_or_method.to_s)
95
+ return [obj] if val && stop_first_time
96
+ val
97
+ end
98
+ end
99
+ end
100
+ end
101
+ end
102
+ end
103
+ end
@@ -0,0 +1,3 @@
1
+ module SelectBy
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,25 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'select_by/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "select_by"
8
+ spec.version = SelectBy::VERSION
9
+ spec.authors = ["Tom Corley"]
10
+ spec.email = ["tom@buildinsync.com"]
11
+
12
+ spec.summary = %q{Extends ruby Array class to add new equality filtering methods}
13
+ spec.description = %q{Extends ruby Array class to add new equality filtering methods select_by, reject_by, detect_by, partition_by}
14
+ spec.homepage = "https://github.com/mgidea/select_by"
15
+ spec.license = "MIT"
16
+
17
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
18
+ spec.bindir = "exe"
19
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
20
+ spec.require_paths = ["lib"]
21
+
22
+ spec.add_development_dependency "bundler", "~> 1.11"
23
+ spec.add_development_dependency "rake", "~> 10.0"
24
+ spec.add_development_dependency "rspec", "~> 3.0"
25
+ end
metadata ADDED
@@ -0,0 +1,101 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: select_by
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Tom Corley
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2018-01-23 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.11'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.11'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: Extends ruby Array class to add new equality filtering methods select_by,
56
+ reject_by, detect_by, partition_by
57
+ email:
58
+ - tom@buildinsync.com
59
+ executables: []
60
+ extensions: []
61
+ extra_rdoc_files: []
62
+ files:
63
+ - ".gitignore"
64
+ - ".rspec"
65
+ - ".travis.yml"
66
+ - CODE_OF_CONDUCT.md
67
+ - Gemfile
68
+ - LICENSE.txt
69
+ - README.md
70
+ - Rakefile
71
+ - bin/console
72
+ - bin/setup
73
+ - lib/select_by.rb
74
+ - lib/select_by/core_extensions/array/selecting_by.rb
75
+ - lib/select_by/version.rb
76
+ - select_by.gemspec
77
+ homepage: https://github.com/mgidea/select_by
78
+ licenses:
79
+ - MIT
80
+ metadata: {}
81
+ post_install_message:
82
+ rdoc_options: []
83
+ require_paths:
84
+ - lib
85
+ required_ruby_version: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - ">="
88
+ - !ruby/object:Gem::Version
89
+ version: '0'
90
+ required_rubygems_version: !ruby/object:Gem::Requirement
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ version: '0'
95
+ requirements: []
96
+ rubyforge_project:
97
+ rubygems_version: 2.4.5
98
+ signing_key:
99
+ specification_version: 4
100
+ summary: Extends ruby Array class to add new equality filtering methods
101
+ test_files: []