ultimate_enumerable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16a63561533346867982e72095a101a4c8f7c79852c28078193221d9ccbf6675
+  data.tar.gz: ad9276b4214b088da497e79a4f14608d48f9657dfc303a74eb4fb5f2f0fcdd2f
+SHA512:
+  metadata.gz: 67011b19c6a232748e802bcec725dd76a84f953c878b5404f3f0f431964c0a59c95e25c3ee154d7b5f4ec9c288dcfe0983f50fa07545cdd1885a6af914da49b5
+  data.tar.gz: e5cb861d95a74117807a33dba01ab284b114e50645b4b840f9d090b78d34ceb74456fb169fe178bcab028580f77a753416dd29c2d4defeaf84576a8585b76557

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/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-03-22
+
+- Initial release

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    ultimate_enumerable (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.1)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-22
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  ultimate_enumerable!
+
+BUNDLED WITH
+   2.4.9

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Jacob Meyer
+
+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,53 @@
+# UltimateEnumerable
+
+This gem adds a few methods to String and Array and can also be mixed in with other classes that implement #[]
+
+These methods will will get either the last, second to last, or third to last elements or your string or array.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+To get the last element of a String or an Array, call `#ultimate`.
+
+```ruby
+"hello".ultimate #=> "o"
+[1,2,3].ultimate #=> 3
+```
+To get the second to last element of a String or an Array, call `#penultimate`.
+
+```ruby
+"hello".penultimate #=> "l"
+[1,2,3].penultimate #=> 2
+```
+
+To get the third to last element of a String or an Array, call `#antepenultimate`.
+
+```ruby
+"hello".antepenultimate #=> "l"
+[1,2,3].antepenultimate #=> 1
+```
+
+## 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/jacobpmeyer/ultimate-enumerable-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/lib/ultimate_enumerable/version.rb

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

data/lib/ultimate_enumerable.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "ultimate_enumerable/version"
+
+# This module is a collection of methods that return the ultimate, penultimate,
+# and antepenultimate elements of an array or string. You may also mix it into your
+# classes that have implemented the #[] method.
+module UltimateEnumerable
+  class Error < StandardError; end
+
+  def ultimate
+    self[-1]
+  end
+
+  def penultimate
+    self[-2]
+  end
+
+  def antepenultimate
+    self[-3]
+  end
+end
+
+class String
+  include UltimateEnumerable
+end
+
+class Array
+  include UltimateEnumerable
+end

data/sig/ultimate_enumerable.rbs

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

data/ultimate_enumerable.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/ultimate_enumerable/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ultimate_enumerable"
+  spec.version = UltimateEnumerable::VERSION
+  spec.authors = ["Jacob Meyer"]
+  spec.email = ["jacobpmeyer87@gmail.com"]
+
+  spec.summary = "Adds a few methods for grabbing the last few elements of an array, string, or other classes that implement the #[] method."
+  spec.homepage = "https://github.com/jacobpmeyer/ultimate-enumerable-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/jacobpmeyer/ultimate-enumerable-ruby"
+  spec.metadata["changelog_uri"] = "https://github.com/jacobpmeyer/ultimate-enumerable-ruby/CHANGELOG.md"
+
+  # 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|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: ultimate_enumerable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jacob Meyer
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-22 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- jacobpmeyer87@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ultimate_enumerable.rb
+- lib/ultimate_enumerable/version.rb
+- sig/ultimate_enumerable.rbs
+- ultimate_enumerable.gemspec
+homepage: https://github.com/jacobpmeyer/ultimate-enumerable-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jacobpmeyer/ultimate-enumerable-ruby
+  source_code_uri: https://github.com/jacobpmeyer/ultimate-enumerable-ruby
+  changelog_uri: https://github.com/jacobpmeyer/ultimate-enumerable-ruby/CHANGELOG.md
+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 a few methods for grabbing the last few elements of an array, string,
+  or other classes that implement the #[] method.'
+test_files: []