clamped 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fcc2cf8878aed212d39404deb09a9a7aecd400b7aaac9d4ace956f7d077157e6
+  data.tar.gz: 15c1643fafce3c7f4f6dd4c449a9002282d60efe103e6209482f5e8f430a25b6
+SHA512:
+  metadata.gz: 0a018d8e1a8801fa482a7cb96e0ecdb8bc2a3c1ab28818e5e20baa0bccae9b1a6623763cabadfa034c2abd06d902f9084a15c38c7041fc8b5ad642a1f1fd3270
+  data.tar.gz: 50965da9de6680e9198e02b2e66ca971739382eab334f67406b68648069e40454ba2fc04bf510623ff88bc24431e032009c4310063aed573cd3c3639f6a03d30

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-07-21
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in clamped.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard"

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    clamped (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.29.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.12.1)
+      rubocop (= 1.29.1)
+      rubocop-performance (= 1.13.3)
+    unicode-display_width (2.2.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  clamped!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard
+
+BUNDLED WITH
+   2.3.16

data/README.md

@@ -0,0 +1,102 @@
+# Clamped
+
+`Clamped` monkey patches a couple of Ruby classes to clamp values to a whitelist.
+
+For example:
+
+```ruby
+"apple".clamped(%w[banana orange])
+# nil
+
+
+"apple".clamped(%w[apple banana])
+# "apple"
+```
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add clamped
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install clamped
+
+## Usage
+
+Supported classes:
+
+- [`String`](#string)
+- [`Symbol`](#symbol)
+- [`Array`](#array)
+- [`Hash`](#hash)
+
+### String
+
+```ruby
+"apple".clamped(%w[banana orange])
+# nil
+
+
+"apple".clamped(%w[apple banana])
+# "apple"
+```
+
+`strict: false` calls `to_s` on the passed array:
+
+```ruby
+"apple".clamped(%i[apple banana], strict: false)
+# "apple"
+```
+
+### Symbol
+
+```ruby
+:apple.clamped(%i[banana orange])
+# nil
+
+
+:apple.clamped(%i[apple banana])
+# :apple
+```
+
+`strict: false` calls `to_sym` on the passed array:
+
+```ruby
+:apple.clamped(%w[apple banana], strict: false)
+# :apple
+```
+
+### Array
+
+Clamp an array with another array:
+
+```ruby
+%i[apple banana orange].clamped %i[apple banana]
+# %i[apple banana]
+```
+
+### Hash
+
+```ruby
+{
+  apple: 'golden',
+  banana: 'cavendish',
+  orange: 'sinensis'
+}.clamped %i[apple banana]
+# {
+#   apple: 'golden',
+#   banana: 'cavendish'
+# }
+```
+
+## 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 the created tag, 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/metikular/clamped.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard:fix]

data/clamped.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/clamped/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "clamped"
+  spec.version = Clamped::VERSION
+  spec.authors = ["Serge Hänni"]
+  spec.email = ["serge@metikular.ch"]
+
+  spec.summary = "Adds convenience methods to clamp values to a whitelist."
+  spec.homepage = "https://github.com/metikular/clamped"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/metikular/clamped"
+  spec.metadata["changelog_uri"] = "https://github.com/metikular/raw/main/clamped"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/lib/clamped/array.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class Array
+  def clamped(whitelist)
+    self.select do |item|
+      whitelist.include?(item)
+    end
+  end
+end

data/lib/clamped/hash.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Hash
+  def clamped(whitelist)
+    slice(*whitelist)
+  end
+end

data/lib/clamped/string.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class String
+  def clamped(whitelist, strict: true)
+    is_included = proc do |item|
+      if strict
+        item == self
+      else
+        item.to_s == self
+      end
+    end
+
+    return self if whitelist.any?(is_included)
+  end
+end

data/lib/clamped/symbol.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class Symbol
+  def clamped(whitelist, strict: true)
+    is_included = proc do |item|
+      if strict
+        item == self
+      else
+        item.to_sym == self
+      end
+    end
+
+    return self if whitelist.any?(is_included)
+  end
+end

data/lib/clamped/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Clamped
+  VERSION = "0.1.0"
+end

data/lib/clamped.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "clamped/version"
+
+require_relative "clamped/array"
+require_relative "clamped/hash"
+require_relative "clamped/string"
+require_relative "clamped/symbol"

data/sig/clamped.rbs

@@ -0,0 +1,4 @@
+module Clamped
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: clamped
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Serge Hänni
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description:
+email:
+- serge@metikular.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- clamped.gemspec
+- lib/clamped.rb
+- lib/clamped/array.rb
+- lib/clamped/hash.rb
+- lib/clamped/string.rb
+- lib/clamped/symbol.rb
+- lib/clamped/version.rb
+- sig/clamped.rbs
+homepage: https://github.com/metikular/clamped
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/metikular/clamped
+  source_code_uri: https://github.com/metikular/clamped
+  changelog_uri: https://github.com/metikular/raw/main/clamped
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Adds convenience methods to clamp values to a whitelist.
+test_files: []