palindrome_ext 0.2.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af2e327fceee1d93aac88be3677cfd633ba8f6733dd810870cd644ccda1207af
-  data.tar.gz: 2110f44399dd79cb71348915fc61a391c7442fff74d15e1f17b29ff1355fe6b1
+  metadata.gz: 5c60b847f233df502210daa72da8a74170f6a20cb825513a055fc6c198dfe872
+  data.tar.gz: f9670ad65f3689972e49471fcd6653b4c9c7760728b4161bbeb28ada4d8b235c
 SHA512:
-  metadata.gz: da1b4c8ba46963cb602139f59b7bd62ea4e5783db04d7b9ff8d8b2427a273080c19db1fa5a07079491737f030a2b4cc0ad7243f88a5b079d525bc624abfa844c
-  data.tar.gz: bb1e256bef0cfc670cce888560a94d69034bef0b53a551ff49d5612112b8fdb22e0a03d8d594274eb00c0ddadb10b3ad0e47e376e62066afd265c204af4ef4cb
+  metadata.gz: 8292bc8e1a564698686120537a99c4bae55415db64df4ad53800761f471a911e7a72fa09321552b163bfd5a69437554cb1ba43271f5b11ec45f9be4526826f34
+  data.tar.gz: 7e030117baebc557146d251de5851e492ce71fbf8e6e0bbcfd21b9b01c4a87a59b519888f3d4ceec0a553bc85d240e3de3dae0a6742feee17a79d6ab468457c4

data/.yardopts

@@ -1,4 +1,4 @@
---no-private
---protected
--
+--no-private
+--protected
+-
 README.md

data/README.md

@@ -24,18 +24,20 @@ Or install it yourself as:
     $ gem install palindrome_ext
 
 ## Usage
+Detailed documentation can be found at https://rubydoc.info/gems/palindrome_ext.
 
 ### String
 ```ruby
 require 'palindrome_ext/string'
 
-# Palindrome - Not worrying about whitespace, case, or punctuation
+# Palindrome - Case Sensitive & Whitespace Sensitive
 'Example...'.palindrome? # => false
-'Radar?!?'.palindrome? # => true
+'radar'.palindrome? # => true
+'Radar'.palindrome? # => false
 
-# Strict Palindrome - Must match case, whitespace, and punctuation
-'Radar'.palindrome? true # => false
-'RadaR'.palindrome? true # => true
+# Non-Strict Palindrome - Removes whitespace, punctuation, and capitalization before checking.
+'Radar'.palindrome? false # => true
+'RadaR'.palindrome? # => false
 ```
 
 ### Integer
@@ -52,15 +54,31 @@ require 'palindrome_ext/integer'
 
 ## Development
 
-After forking this repo, navigate to the root directory and run `$ bundle install` to install dependencies and this gem on your machine.
+### Dependency Management
+After forking this repo, navigate to the root directory and run:
 
-To run tests, simply run `$ rspec` in the root directory.
+    $ bundle install
+
+### Testing with RSpec
+To run tests, simply run:
+
+    $ rake test
+
+### Linting with RuboCop
+To check if there are any style offenses in your forked repository and automatically fix these offenses, run:
+
+    $ rake lint
+
+### Benchmarking
+To execute a benchmark report, run:
+
+    $ rake benchmark
 
-To check if there are any style offenses in your forked repository, run `$ rubocop`. To attempt to automatically fix these offenses, run `$ rubocop -A`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/aj-rom/palindrome_ext. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/palindrome_ext/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/aj-rom/palindrome_ext.
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/aj-rom/palindrome_ext/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -68,4 +86,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the PalindromeExt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/palindrome_ext/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the PalindromeExt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/aj-rom/palindrome_ext/blob/master/CODE_OF_CONDUCT.md).

data/lib/palindrome_ext/array.rb

@@ -1,11 +1,16 @@
-# frozen_string_literal: true
-
-require "palindrome_ext/string"
-
-# Overrides Default Array Class by adding {palindrome?} method.
-class Array
-  # @return [Boolean] Whether or not the array is a palindrome.
-  def palindrome?
-    self == reverse
-  end
-end
+# frozen_string_literal: true
+
+require "palindrome_ext/string"
+
+# Overrides Default Array Class by adding {palindrome?} method.
+class Array
+  # @param strict whether or not to ignore whitespace and non-alphanumeric characters.
+  # @return [Boolean] Whether or not the array is a palindrome.
+  def palindrome?(strict = true)
+    return self == reverse if strict
+
+    arr = map { |x| x.to_s.downcase.tr("^a-z0-9", "") }
+    arr.delete_if(&:empty?)
+    arr == arr.reverse
+  end
+end

data/lib/palindrome_ext/integer.rb

@@ -6,6 +6,6 @@ require "palindrome_ext/string"
 class Integer
   # @return [Boolean] Whether or not the Integer is a palindrome.
   def palindrome?
-    to_s.palindrome? true
+    to_s.palindrome?
   end
 end

data/lib/palindrome_ext/version.rb

@@ -1,7 +1,7 @@
-# frozen_string_literal: true
-
-# palindrome_ext module and version.
-# @private
-module PalindromeExt
-  VERSION = "0.2.0"
-end
+# frozen_string_literal: true
+
+# palindrome_ext module and version.
+# @private
+module PalindromeExt
+  VERSION = "0.5.0"
+end

data/lib/palindrome_ext.rb

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
-
-require_relative "palindrome_ext/version"
-require_relative "palindrome_ext/string"
-require_relative "palindrome_ext/integer"
-require_relative "palindrome_ext/array"
+# frozen_string_literal: true
+
+require_relative "palindrome_ext/version"
+require_relative "palindrome_ext/string"
+require_relative "palindrome_ext/integer"
+require_relative "palindrome_ext/array"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: palindrome_ext
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.0
 platform: ruby
 authors:
 - A.J. Romaniello
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-19 00:00:00.000000000 Z
+date: 2021-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -144,7 +144,7 @@ metadata:
   source_code_uri: https://github.com/aj-rom/palindrome_ext
   changelog_uri: https://github.com/aj-rom/palindrome_ext
   documentation_uri: https://www.rubydoc.info/gems/palindrome_ext
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -159,8 +159,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
-signing_key:
+rubygems_version: 3.2.32
+signing_key: 
 specification_version: 4
 summary: Adds methods for determining whether or not a string, integer, or array are
   palindromes.