ruby_on_asteroids 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f1e794683e45f44361b34d7a7e77a19a7d7b86b7c0bfd10ec92e02589f729b0
+  data.tar.gz: 9ec1d342ebe6b48bb70f24cda0862e0a96fa23285de3f4ec2980c8c5ce76a67d
+SHA512:
+  metadata.gz: 0403abb5f7d70ed91255c8bde5fe01c9f401f968cac0d2aca9f38ecd35197e29542aa7d970c667134c1780694fc2538644dc65a39aac9458fda96aa90db73fa8
+  data.tar.gz: 304593a7702a666d12de20667ae20876dc67368a7b2be9ab360481ee7ecde7b3a249b46f8117074cffef215243a98c17f207d373bc1539fb498237e57670b74c

data/.overcommit.yml

@@ -0,0 +1,37 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/sds/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/sds/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/sds/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+    flags: [ '--auto-correct', '--format=progress', '--display-style-guide', '--force-exclusion', '--display-cop-names' ]
+    command: ['bundle', 'exec', 'rubocop', '--fail-level=autocorrect']
+
+
+#
+#  TrailingWhitespace:
+#    enabled: true
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,37 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-thread_safety
+
+AllCops:
+  TargetRubyVersion: 2.4
+  NewCops: enable
+
+# Exclude files that contain purely declarative DSLs
+# see https://stackoverflow.com/a/41187163 for more details
+Metrics/BlockLength:
+  Exclude:
+    - 'Rakefile'
+    - '**/*.rake'
+    - 'spec/**/*.rb'
+    - '*.gemspec'
+
+# I don't like the approach of forcing the first describe block to point to a class. In some cases specs are more
+# flexible if they describe an abstract behavior rather than a specific class
+RSpec/DescribeClass:
+  Enabled: false
+
+# I like the idea of restricting the amount of nested groups, but 3 seems too low
+RSpec/NestedGroups:
+  Max: 5
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+### 0.1.1 / 2022-01-28
+
+Initial release of the gem
+
+Features
+* Enhance `String` objects by adding `but_last` method

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 MatiasFernandez
+
+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,64 @@
+# RubyOnAsteroids
+
+A gem with useful tools to expand Ruby language and make it more powerful
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_on_asteroids'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ruby_on_asteroids
+
+## Available enhancements
+
+### String
+
+- [`but_last`](lib/ruby_on_asteroids/core_ext/string/accessing.rb): Return a copy of the string without the 
+last # of characters requested.
+
+## Usage
+
+The gem is designed to provide only the enhancements you ask for, that means by default we won't auto-load classes 
+that are not needed, nor apply enhancements you didn't ask for.
+
+To enable enhancements you need to first load the gem:
+
+``` ruby
+require "ruby_on_asteroids"
+```
+
+and then enable the enhancements you want
+
+``` ruby
+RubyOnAsteroids.enhance_strings
+```
+
+**Tip:** If you use `pry` gem as a Ruby REPL you can enable the enhancements in your 
+[`.pryrc`](https://github.com/pry/pry#overview) file in your home directory to benefit from the enhancements during
+your REPL sessions even if the gem is not installed in your project. 
+
+## 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/10pines/ruby_on_asteroids.
+
+## 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/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ruby_on_asteroids"
+
+# 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/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/lib/ruby_on_asteroids/core_ext/string/accessing.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module RubyOnAsteroids
+  module CoreExt
+    module String
+      # Useful extensions to String class related to accessing the string content
+      module Accessing
+        # Returns a copy of the original string object with the last `num_of_characters` being removed.
+        # If `num_of_characters` is not provided, it defaults to removing the last character.
+        # When the original string is empty, returns an empty string
+        def but_last(num_of_characters = 1)
+          self[0..-(1 + num_of_characters)]
+        end
+      end
+    end
+  end
+end

data/lib/ruby_on_asteroids/version.rb

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

data/lib/ruby_on_asteroids.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "ruby_on_asteroids/version"
+
+# I'm the root module of the gem. I provide useful methods to enable enhancements
+module RubyOnAsteroids
+  class Error < StandardError; end
+
+  # Apply patches to the String class to enhance it by adding new methods
+  def enhance_strings
+    require "ruby_on_asteroids/core_ext/string/accessing"
+
+    String.include RubyOnAsteroids::CoreExt::String::Accessing
+  end
+
+  module_function :enhance_strings
+end

data/ruby_on_asteroids.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/ruby_on_asteroids/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_on_asteroids"
+  spec.version       = RubyOnAsteroids::VERSION
+  spec.authors       = ["MatiasFernandez"]
+  spec.email         = ["mfernandez@10pines.com"]
+
+  spec.summary       = "A gem with useful tools to expand Ruby language and make it more powerful."
+  spec.homepage      = "https://github.com/10Pines/ruby_on_asteroids"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/10Pines/ruby_on_asteroids"
+  spec.metadata["changelog_uri"] = "https://github.com/10Pines/ruby_on_asteroids/blob/main/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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?: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 "overcommit", "~> 0.58"
+  spec.add_development_dependency "pry", "~> 0.14"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "~> 1.12.0"
+  spec.add_development_dependency "rubocop-performance", "~> 1.10"
+  spec.add_development_dependency "rubocop-rake", "~> 0.5"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.2"
+  spec.add_development_dependency "rubocop-thread_safety", "~> 0.4"
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: ruby_on_asteroids
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- MatiasFernandez
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.12.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rubocop-thread_safety
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description:
+email:
+- mfernandez@10pines.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ruby_on_asteroids.rb
+- lib/ruby_on_asteroids/core_ext/string/accessing.rb
+- lib/ruby_on_asteroids/version.rb
+- ruby_on_asteroids.gemspec
+homepage: https://github.com/10Pines/ruby_on_asteroids
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/10Pines/ruby_on_asteroids
+  source_code_uri: https://github.com/10Pines/ruby_on_asteroids
+  changelog_uri: https://github.com/10Pines/ruby_on_asteroids/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: A gem with useful tools to expand Ruby language and make it more powerful.
+test_files: []