str_masker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e4d859aa7040645a8c484b5ac506641393b3dc556ee37c8a68d7d1afb75b48e
+  data.tar.gz: 5f2ea19605cde435670c90d155430b7b4162a38c8fd08771fa0f0a473020ad24
+SHA512:
+  metadata.gz: 8a4f798f31b2198a4333cecabc54aa59752eb6d21fff87322a2079496369237e2627b3a76c5ab88279567c1512e54e06ab8b34bbbca0075a969c6fa0dfcccc2a
+  data.tar.gz: 6cce3c03db32628e41a6e4daf1af3e12bd93ac3932a9305f53362f70ee6d0712534317e7581ed2a5730fa99ce8958733b0208c1b99822dd30db7ae17aebd7e66

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  rubocop-espago: rubocop.yml
+
+Bundler/GemComment:
+  Enabled: false
+
+Layout/LeadingCommentSpace:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [0.1.0] - 2025-07-18
+
+- Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Michał Zaporski
+
+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,113 @@
+# StrMasker
+
+A simple and flexible Ruby gem for masking portions of strings with customizable characters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'str_masker'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install str_masker
+```
+
+## Usage
+
+StrMasker provides a simple interface for masking strings with asterisks or any custom character.
+
+### Basic Usage
+
+```ruby
+require 'str_masker'
+
+# Mask entire string (default behavior)
+StrMasker.mask_string("password")
+#=> "********"
+
+# Mask middle characters, keeping first and last
+StrMasker.mask_string("password", from: 1, to: -2)
+#=> "p******d"
+
+# Mask from beginning, keeping last character
+StrMasker.mask_string("secret", from: 0, to: -2)
+#=> "*****t"
+
+# Mask from second character to end
+StrMasker.mask_string("confidential", from: 1, to: -1)
+#=> "c***********"
+```
+
+### Custom Masking Character
+
+```ruby
+# Use a different character for masking
+StrMasker.mask_string("password", from: 1, to: -2, char: '#')
+#=> "p######d"
+
+StrMasker.mask_string("email@example.com", from: 2, to: -5, char: 'X')
+#=> "emXXXXXXXXX.com"
+```
+
+### Edge Cases
+
+```ruby
+# Returns nil for nil input
+StrMasker.mask_string(nil)
+#=> nil
+
+# Returns original string if no masking is needed
+StrMasker.mask_string("ab", from: 1, to: -2)
+#=> "ab"
+
+# Empty string
+StrMasker.mask_string("")
+#=> ""
+```
+
+## API Reference
+
+### `mask_string(val, from: 0, to: -1, char: '*')`
+
+Masks a portion of a string with the specified character.
+
+#### Parameters
+
+- `val` (String, nil): The string to mask. Returns `nil` if input is `nil`.
+- `from` (Integer, optional): Starting position for masking (inclusive). Must be non-negative. Default: `0`.
+- `to` (Integer, optional): Ending position for masking (must be negative, counts from end). Default: `-1`.
+- `char` (String, optional): The character to use for masking. Must be a single character. Default: `'*'`.
+
+#### Returns
+
+- `String` or `nil`: The masked string, or `nil` if input was `nil`.
+
+#### Raises
+
+- `ArgumentError`: If `from` is negative, `to` is non-negative, or `char` is not a single character.
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests.
+
+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/MichalZaporski/str_masker.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/str_masker/version.rb

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

data/lib/str_masker.rb

@@ -0,0 +1,46 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative 'str_masker/version'
+
+# A StrMasker gem main module.
+module StrMasker
+  class << self
+    # Mask a portion of a string with asterisks (*) or your selected char between the specified positions.
+    #
+    # @param val: The string to mask
+    # @param from: Starting position for masking (inclusive, default: 0)
+    # @param to: Ending position for masking (must be negative, default: -1)
+    # @param char: The character to use for masking (default: '*')
+    # @return The masked string or nil if input is nil
+    #
+    # Example:
+    #
+    #   Mask middle characters
+    #     mask_string("password", from: 1, to: -2) #=> "p******d"
+    #
+    #   Mask from start
+    #     mask_string("secret", from: 0, to: -2) #=> "*****t"
+    #
+    #   Default usage:
+    #     mask_string("secret") #=> "******"
+    #
+    #: (String?, ?from: Integer, ?to: Integer, ?char: String) -> String?
+    def mask_string(val, from: 0, to: -1, char: '*')
+      raise ArgumentError, '"from" must be a non-negative int' unless from.is_a?(Integer) && from >= 0
+      raise ArgumentError, '"to" must be a negative int' unless to.is_a?(Integer) && to < 0
+      raise ArgumentError, '"char" must be a single character string' unless char.is_a?(String) && char.length == 1
+
+      return unless val
+
+      len = val.length
+      masked_chars_len = len - from + to + 1
+      return val if masked_chars_len <= 0
+
+      prefix = from.zero? ? '' : val[..(from - 1)]
+      suffix = to == -1 ? '' : val[(to + 1)..]
+      filling = char * masked_chars_len
+      "#{prefix}#{filling}#{suffix}"
+    end
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: str_masker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michał Zaporski
+bindir: exe
+cert_chain: []
+date: 2025-07-18 00:00:00.000000000 Z
+dependencies: []
+email:
+- focus16k@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/str_masker.rb
+- lib/str_masker/version.rb
+homepage: https://github.com/MichalZaporski/str_masker
+licenses: []
+metadata:
+  homepage_uri: https://github.com/MichalZaporski/str_masker
+  source_code_uri: https://github.com/MichalZaporski/str_masker
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A simple gem for masking sensitive strings.
+test_files: []