key_set 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 19b39d7fc11b72e1276d84da44d947775f5e9acf845c4aba7315123ac62c9c6f
+  data.tar.gz: b9947bc238a8d186bacb4cbcf1ba1b9884ddc7d43e86d0faee90fbf66308c953
+SHA512:
+  metadata.gz: aa0b11f3bb468889a750c344758494a6ac765da00e6861dad29e828300a53d464ee2aea11621319607ec5642d49560e6e1e34759b2ea416dceda25cd95e3d512
+  data.tar.gz: b9b2284b2da74bddd52253d76a44a9701ea4c60a22a4b0ffb77b6b3419ae32c8a3747daa12fce6c13b73f4935530c83d266d3760aa60da2194615163ed027f71

data/.gitignore

@@ -0,0 +1,33 @@
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+/.idea
+/.bundle
+
+# Ignore all logfiles and tempfiles.
+/log/*
+/tmp/*
+!/log/.keep
+!/tmp/.keep
+
+# Ignore Byebug command history file.
+.byebug_history
+/coverage
+/manual_sandbox.json
+/brakeman.out.json
+.DS_Store
+
+# gem
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,45 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'
+    - 'db/schema.rb'
+  TargetRubyVersion: 2.5
+
+Rails:
+  Enabled: true
+
+Metrics/LineLength:
+  Max: 140
+  IgnoredPatterns: ['^[\s]*#']
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/SymbolArray:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Enabled: false
+
+RSpec/ExampleLength:
+  Enabled: false
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/HookArgument:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/.travis.yml

@@ -0,0 +1,18 @@
+---
+env:
+  global:
+    - CC_TEST_REPORTER_ID=1eec0569f37168d92ce0fbdecced22b50ba2e3425c309ed67b8e8685864acf6c
+language: ruby
+sudo: false
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

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 eturino@eturino.com. 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/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in key_set.gemspec
+gemspec
+
+gem 'simplecov', require: false, group: :test

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    key_set (1.0.0)
+      activesupport (>= 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    i18n (1.1.1)
+      concurrent-ruby (~> 1.0)
+    json (2.1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  key_set!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Eduardo Turiño
+
+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,202 @@
+# KeySet
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/eea7d889d4f13fbf45c7/maintainability)](https://codeclimate.com/github/eturino/ruby_key_set/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/eea7d889d4f13fbf45c7/test_coverage)](https://codeclimate.com/github/eturino/ruby_key_set/test_coverage)
+[![Build Status](https://travis-ci.org/eturino/ruby_key_set.svg?branch=master)](https://travis-ci.org/eturino/ruby_key_set)
+[![Gem Version](https://badge.fury.io/rb/key_set.svg)](https://badge.fury.io/rb/key_set)
+
+KeySet allows you to represent the 4 possible sets of elements:
+
+- All elements (`KeySet.all # => KeySet::All`)
+- No elements (`KeySet.non # => KeySet::None`)
+- Some elements (`KeySet.some(['k1', 'k2']) # => KeySet::Some`)
+- All except some elements (`KeySet.all_except_some(['k1', 'k2']) # => KeySet::AllExceptSome`)
+
+and do some operations on them, like:
+- calculate inverse KeySet (`key_set.invert`)
+- remove a KeySet from another KeySet (`key_set.remove(other)`)
+- intersect 2 KeySets (`key_set.intersect(other)`)
+
+The keys in the `Some` and `AllExceptSome` key sets are stored in a `SortedSet`, so they are sorted and without duplicates. 
+
+### Creation
+
+```ruby
+KeySet.all # => new KeySet of KeySet::All
+
+KeySet.none # => new KeySet of KeySet::None
+
+KeySet.some(['k1', 'k2']) # => new KeySet of KeySet::Some with keys ['k1', 'k2'] 
+KeySet.some([]) # => same as KeySet.none => returns new KeySet::None 
+
+KeySet.all_except_some(['k1', 'k2']) # => new KeySet of KeySet::AllExceptSome with keys ['k1', 'k2'] 
+KeySet.all_except_some([]) # => same as KeySet.all => returns new KeySet::All 
+```
+
+### Checks
+
+```ruby
+key_set.represents_all? # => true if the key set is a KeySet::All
+key_set.represents_none? # => true if the key set is a KeySet::None
+```
+
+### `.invert`
+
+```ruby
+KeySet.all.invert # => KeySet::None
+KeySet.none.invert # => KeySet::None
+KeySet.some(['k1', 'k2']).invert # => KeySet::AllExceptSome with keys 'k1' and 'k2'
+KeySet.all_except_some(['k1', 'k2']).invert # => KeySet::Some with keys 'k1' and 'k2'
+```
+
+### `.intersect`
+
+```
+  #intersect
+    All
+      KeySet.all.intersect(KeySet.all)
+        we have everything, we intersect everything => we have everything
+      KeySet.all.intersect(KeySet.none)
+        we have everything, we intersect nothing => we have nothing
+      KeySet.all.intersect(KeySet.some [key1, key2])
+        we have everything, we intersect some => we have some
+      KeySet.all.intersect(KeySet.all_except_some [key1, key2])
+        we have everything, we intersect all except some => we have all except some
+    None
+      KeySet.none.intersect(KeySet.all)
+        we have nothing, we intersect everything => we have nothing
+      KeySet.none.intersect(KeySet.none)
+        we have nothing, we intersect nothing => we have nothing
+      KeySet.none.intersect(KeySet.some [key1, key2])
+        we have nothing, we intersect some => we have nothing
+      KeySet.none.intersect(KeySet.all_except_some [key1, key2])
+        we have nothing, we intersect all except some => we have nothing
+    Some
+      KeySet.some([key1, key3]).intersect(KeySet.all)
+        we have some, we intersect everything => we have the same some
+      KeySet.some([key1, key3]).intersect(KeySet.none)
+        we have some, we intersect nothing => we have nothing
+      KeySet.some([key1, key3]).intersect(KeySet.some [key1, key2])
+        we have some, we intersect some others (that does not include our entire set) => we have the common keys
+      KeySet.some([key1, key3]).intersect(KeySet.some [key1, key2, key3])
+        we have some, we intersect some others that includes our entire set => we have the common keys, so our former set
+      KeySet.some([key1, key3]).intersect(KeySet.all_except_some [key1, key2])
+        we have some, we intersect all except others, which includes some of ours => we have the former keys that are not in the other keys
+      KeySet.some([key1, key3]).intersect(KeySet.all_except_some [key1, key2, key3])
+        we have some, we intersect all except others, which include all our keys => we have nothing
+      KeySet.some([key1, key3]).intersect(KeySet.all_except_some [key2, key4])
+        we have some, we intersect all except others, none of them are in our keys => we have the same set
+    AllExceptSome
+      KeySet.all_except_some([key1, key3]).intersect(KeySet.all)
+        we have all except some, we intersect everything => we have the same
+      KeySet.all_except_some([key1, key3]).intersect(KeySet.none)
+        we have all except some, we intersect nothing => we have none
+      KeySet.all_except_some([key1, key3]).intersect(KeySet.some [key1, key2])
+        we have all except some, we intersect some others => we have the keys in the second that area not in the keys of the first
+      KeySet.all_except_some([key1, key3]).intersect(KeySet.some [key1, key3])
+        we have all except some, we intersect some of the same keys => we have nothing
+      KeySet.all_except_some([key1, key3]).intersect(KeySet.some [key1, key2, key3])
+        we have all except some, we intersect some others that includes our entire set => we have the keys in the second that area not in the keys of the first
+      KeySet.all_except_some([key1, key3]).intersect(KeySet.all_except_some [key1, key2])
+        we have all except some, we intersect all except others (that includes some of the current set) => we get all except the union of keys in the first and in the second
+      KeySet.all_except_some([key1, key3]).intersect(KeySet.all_except_some [key1, key2, key3])
+        we have all except some, we intersect all except others (that includes the entire of the current set) => we get all except the union of keys in the first and in the second
+      KeySet.all_except_some([key1, key3]).intersect(KeySet.all_except_some [key2, key4])
+        we have all except some, we intersect all except others (that includes none of the current set) => we get all except the union of keys in the first and in the second
+      KeySet.all_except_some([key1, key3]).intersect(KeySet.all_except_some [key1, key3])
+        we have all except some, we intersect all except others (that has the same set) => we get the same
+```
+
+### `.intersect`
+
+```
+#remove
+  All
+    KeySet.all.remove(KeySet.all)
+      we have everything, we remove everything => we have nothing
+    KeySet.all.remove(KeySet.none)
+      we have everything, we remove nothing => we have everything
+    KeySet.all.remove(KeySet.some [key1, key2])
+      we have everything, we remove some => we have all except those
+    KeySet.all.remove(KeySet.all_except_some [key1, key2])
+      we have everything, we remove all except some => we have only those
+  None
+    KeySet.none.remove(KeySet.all)
+      we have nothing, we remove everything => we have nothing
+    KeySet.none.remove(KeySet.none)
+      we have nothing, we remove nothing => we have nothing
+    KeySet.none.remove(KeySet.some [key1, key2])
+      we have nothing, we remove some => we have nothing
+    KeySet.none.remove(KeySet.all_except_some [key1, key2])
+      we have nothing, we remove all except some => we have nothing
+  Some
+    KeySet.some([key1, key3]).remove(KeySet.all)
+      we have some, we remove everything => we have nothing
+    KeySet.some([key1, key3]).remove(KeySet.none)
+      we have some, we remove nothing => we have the same set
+    KeySet.some([key1, key3]).remove(KeySet.some [key1, key2])
+      we have some, we remove some others (that does not include our entire set) => we have the keys that we have not been removed
+    KeySet.some([key1, key3]).remove(KeySet.some [key1, key2, key3])
+      we have some, we remove some others that includes our entire set => we have nothing
+    KeySet.some([key1, key3]).remove(KeySet.all_except_some [key1, key2])
+      we have some, we remove all except others => we have only the keys that we had and they were excluded from the removal
+    KeySet.some([key1, key3]).remove(KeySet.all_except_some [key1, key2, key3])
+      we have some, we remove all except others, which include all our keys => we have the same keys
+    KeySet.some([key1, key3]).remove(KeySet.all_except_some [key2, key4])
+      we have some, we remove all except others, none of them are in our keys => we have nothing
+  AllExceptSome
+    KeySet.all_except_some([key1, key3]).remove(KeySet.all)
+      we have all except some, we remove everything => we have nothing
+    KeySet.all_except_some([key1, key3]).remove(KeySet.none)
+      we have all except some, we remove nothing => we have the same (all but these keys)
+    KeySet.all_except_some([key1, key3]).remove(KeySet.some [key1, key2])
+      we have all except some, we remove some others => we have all except the ones that we didn't have before and the ones that we don't have now
+    KeySet.all_except_some([key1, key3]).remove(KeySet.some [key1, key2, key3])
+      we have all except some, we remove some others that includes our entire set => we have all except the new set (that includes the old set)
+    KeySet.all_except_some([key1, key3]).remove(KeySet.all_except_some [key1, key2])
+      we have all except some, we remove all except others (that includes some of the current set) => we have only the ones that OTHER did not remove, except the ones that THIS was excluding
+    KeySet.all_except_some([key1, key3]).remove(KeySet.all_except_some [key1, key2, key3])
+      we have all except some, we remove all except others (that includes the entire of the current set) => we have only the ones that OTHER did not remove, except the ones that THIS was excluding
+    KeySet.all_except_some([key1, key3]).remove(KeySet.all_except_some [key2, key4])
+      we have all except some, we remove all except others (that includes none of the current set) => we get only the ones that the other is not excluding
+    KeySet.all_except_some([key1, key3]).remove(KeySet.all_except_some [key1, key3])
+      we have all except some, we remove all except others (that has the same set) => we get nothing
+```
+
+Note that removing a AllExceptSome logs a warning, since it is probably not what you want to do.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'key_set'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install key_set
+
+## Usage
+
+## 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/eturino/ruby_key_set. 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
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the KeySet project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/eturino/ruby_key_set/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "key_set"
+
+# 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/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

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/key_set.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'key_set/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'key_set'
+  spec.version       = KeySet::VERSION
+  spec.authors       = ['Eduardo Turiño']
+  spec.email         = ['eturino@eturino.com']
+
+  spec.summary       = <<~TXT
+    KeySet with 4 classes to represent concepts of All, None, Some, and AllExceptSome, the last 2 with a sorted uniq list of keys
+  TXT
+  spec.homepage      = 'https://github.com/eturino/ruby_key_set'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>= 4'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/key_set.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+class KeySet
+  class Error < StandardError
+  end
+
+  def self.logger
+    @logger ||= default_logger
+  end
+
+  def self.default_logger
+    require 'logger'
+    ::Logger.new($stdout)
+  end
+
+  def self.all
+    All.new
+  end
+
+  def self.none
+    None.new
+  end
+
+  def self.some(keys)
+    return none if keys.blank?
+
+    Some.new keys
+  end
+
+  def self.all_except_some(keys)
+    return all if keys.blank?
+
+    AllExceptSome.new keys
+  end
+
+  # COMMON
+
+  def represents_all?
+    false
+  end
+
+  def represents_none?
+    false
+  end
+
+  # :nocov:
+  # @param other [KeySet]
+  # @return [KeySet]
+  def remove(_other)
+    raise NotImplementedError
+  end
+
+  # @param other [KeySet]
+  # @return [KeySet]
+  def intersect(_other)
+    raise NotImplementedError
+  end
+
+  # @return [KeySet]
+  def invert
+    raise NotImplementedError
+  end
+  # :nocov:
+
+  # EQUALITY AND COMPARISON
+  def hash
+    if respond_to? :keys
+      [self.class.to_s, keys.map(&:hash)].hash
+    else
+      self.class.to_s.hash
+    end
+  end
+
+  def <=>(other)
+    if self.class.class_sort_index == other.class.class_sort_index
+      if respond_to? :keys_array
+        keys_array <=> other.keys_array
+      else
+        0
+      end
+    else
+      self.class.class_sort_index <=> other.class.class_sort_index
+    end
+  end
+
+  def ===(other)
+    self.class == other.class && try(:keys_array) === other.try(:keys_array) # rubocop:disable Style/CaseEquality
+  end
+
+  def ==(other)
+    self.class == other.class && try(:keys_array) == other.try(:keys_array)
+  end
+
+  def eql?(other)
+    self.class == other.class && try(:keys_array) == other.try(:keys_array)
+  end
+end
+
+require 'key_set/based_on_keys'
+
+require 'key_set/all'
+require 'key_set/none'
+require 'key_set/some'
+require 'key_set/all_except_some'
+
+require 'key_set/version'

data/lib/key_set/all.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+class KeySet
+  class All < KeySet
+    def self.class_sort_index
+      3
+    end
+
+    def represents_all?
+      true
+    end
+
+    def invert
+      KeySet.none
+    end
+
+    def remove(other)
+      case other
+      when All
+        # we have everything, we remove everything => we have nothing
+        KeySet.none
+      when None
+        # we have everything, we remove nothing => we have everything
+        KeySet.all
+      when Some
+        # we have everything, we remove some => we have all except those
+        KeySet.all_except_some other.keys
+      when AllExceptSome
+        # we have everything, we remove all except some => we have only those
+        KeySet.logger.warn "KeySet removing AllButSome, probably a mistake. this: ALL, removing keys: #{other.keys.inspect}"
+        KeySet.some other.keys
+      else
+        raise ArgumentError, 'it needs a valid KeySet'
+      end
+    end
+
+    def intersect(other)
+      case other
+      when All
+        KeySet.all
+      when None
+        KeySet.none
+      when Some
+        KeySet.some other.keys
+      when AllExceptSome
+        KeySet.all_except_some other.keys
+      else
+        raise ArgumentError, 'it needs a valid KeySet'
+      end
+    end
+  end
+end

data/lib/key_set/all_except_some.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+class KeySet
+  class AllExceptSome < KeySet
+    include BasedOnKeys
+
+    def self.class_sort_index
+      2
+    end
+
+    def invert
+      KeySet.some(keys_array)
+    end
+
+    def remove(other)
+      case other
+      when All
+        # we have all except some, we remove everything => we have nothing
+        KeySet.none
+      when None
+        # we have all except some, we remove nothing => we have the same (all but these keys)
+        KeySet.all_except_some keys.deep_dup
+      when Some
+        # we have all except some, we remove some others => we have all except the ones that we didn't have before and the ones that we don't have now
+        remove_some(other)
+      when AllExceptSome
+        # we have all except some, we remove all except others => we have only the ones that OTHER did not remove, except the ones that THIS was removing
+        KeySet.logger.warn "KeySet removing AllButSome, probably a mistake. this: ALL_BUT_SOME, removing keys: #{other.keys.inspect}"
+        remove_all_except_some(other)
+      else
+        raise ArgumentError, 'it needs a valid KeySet'
+      end
+    end
+
+    def intersect(other)
+      case other
+      when All
+        KeySet.all_except_some keys.deep_dup
+      when None
+        KeySet.none
+      when Some
+        # we have all except some, we remove some others => we have all except the ones that we didn't have before and the ones that we don't have now
+        intersect_some(other)
+      when AllExceptSome
+        intersect_all_except_some(other)
+      else
+        raise ArgumentError, 'it needs a valid KeySet'
+      end
+    end
+
+    private
+
+    def remove_some(other)
+      k = keys.deep_dup + other.keys.deep_dup
+      KeySet.all_except_some k
+    end
+
+    def remove_all_except_some(other)
+      k = other.keys.deep_dup - keys.deep_dup
+      KeySet.some k
+    end
+
+    def intersect_some(other)
+      k = other.keys.deep_dup - keys.deep_dup
+      KeySet.some k
+    end
+
+    def intersect_all_except_some(other)
+      k = other.keys.deep_dup + keys.deep_dup
+      KeySet.all_except_some k
+    end
+  end
+end

data/lib/key_set/based_on_keys.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class KeySet
+  module BasedOnKeys
+    extend ActiveSupport::Concern
+
+    included do
+      include Enumerable
+
+      attr_reader :keys
+
+      def initialize(keys)
+        @keys = SortedSet.new(keys.to_a)
+      end
+
+      delegate :each, to: :keys
+    end
+
+    def keys_array
+      keys.to_a
+    end
+
+    def represents_all?
+      false
+    end
+
+    def represents_none?
+      false
+    end
+
+    def clone
+      self.class.new keys.deep_dup
+    end
+  end
+end

data/lib/key_set/none.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+class KeySet
+  class None < KeySet
+    def self.class_sort_index
+      0
+    end
+
+    def represents_none?
+      true
+    end
+
+    def invert
+      KeySet.all
+    end
+
+    def remove(other)
+      case other
+      when All
+        # we have nothing, we remove everything => we have nothing
+        KeySet.none
+      when None
+        # we have nothing, we remove nothing => we have nothing
+        KeySet.none
+      when Some
+        # we have nothing, we remove some => we have nothing
+        KeySet.none
+      when AllExceptSome
+        # we have nothing, we remove all except some => we have nothing
+        KeySet.logger.warn "KeySet removing AllButSome, probably a mistake. this: NONE, removing keys: #{other.keys.inspect}"
+        KeySet.none
+      else
+        raise ArgumentError, 'it needs a valid KeySet'
+      end
+    end
+
+    def intersect(other)
+      case other
+      when All
+        KeySet.none
+      when None
+        KeySet.none
+      when Some
+        KeySet.none
+      when AllExceptSome
+        KeySet.none
+      else
+        raise ArgumentError, 'it needs a valid KeySet'
+      end
+    end
+  end
+end

data/lib/key_set/some.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+class KeySet
+  class Some < KeySet
+    include BasedOnKeys
+
+    def self.class_sort_index
+      1
+    end
+
+    def invert
+      KeySet.all_except_some(keys_array)
+    end
+
+    def remove(other)
+      case other
+      when All
+        # we have some, we remove everything => we have nothing
+        KeySet.none
+      when None
+        # we have some, we remove nothing => we have the same set
+        KeySet.some keys.deep_dup
+      when Some
+        # we have some, we remove some others => we have some with another set (or maybe none)
+        remove_some(other)
+      when AllExceptSome
+        # we have some, we remove all except others => we remove all except the intersection
+        KeySet.logger.warn "KeySet removing AllButSome, probably a mistake. this: SOME, removing keys: #{other.keys.inspect}"
+        remove_all_except_some(other)
+      else
+        raise ArgumentError, 'it needs a valid KeySet'
+      end
+    end
+
+    def intersect(other)
+      case other
+      when All
+        KeySet.some keys.deep_dup
+      when None
+        KeySet.none
+      when Some
+        intersect_with_some(other)
+      when AllExceptSome
+        intersect_with_all_except_some(other)
+      else
+        raise ArgumentError, 'it needs a valid KeySet'
+      end
+    end
+
+    private
+
+    def remove_some(other)
+      k = keys.deep_dup - other.keys.deep_dup
+      KeySet.some k
+    end
+
+    def remove_all_except_some(other)
+      k = keys.deep_dup & other.keys.deep_dup
+      KeySet.some k
+    end
+
+    def intersect_with_all_except_some(other)
+      k = keys.deep_dup - other.keys.deep_dup
+      KeySet.some k
+    end
+
+    def intersect_with_some(other)
+      k = keys.deep_dup & other.keys.deep_dup
+      KeySet.some k
+    end
+  end
+end

data/lib/key_set/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class KeySet
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: key_set
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eduardo Turiño
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- eturino@eturino.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/setup
+- key_set.gemspec
+- lib/key_set.rb
+- lib/key_set/all.rb
+- lib/key_set/all_except_some.rb
+- lib/key_set/based_on_keys.rb
+- lib/key_set/none.rb
+- lib/key_set/some.rb
+- lib/key_set/version.rb
+homepage: https://github.com/eturino/ruby_key_set
+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: KeySet with 4 classes to represent concepts of All, None, Some, and AllExceptSome,
+  the last 2 with a sorted uniq list of keys
+test_files: []