zarby 0.1.6 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 656415d6b0a326bad3ad11708792f82c83296f341bb4c0d58389942abb8d44ed
-  data.tar.gz: 2f4d28eb627d2bee49cf8ceb4e9d500cc6ba968e83fe6a2f77b5c37b6fb193b8
+  metadata.gz: f4ae19530d59bcdcb294a5be185531ebded6026d0a19604abe14983dcd0be439
+  data.tar.gz: 78dde798c1d737a19e30ed8878f36b97536c54f44b2543aa8edfacb62af49a52
 SHA512:
-  metadata.gz: bea273ad274d1f0e5acc1bc084ec7d78e5d7c88789e4e7e8725fa3fefaff5969b424667a58f3e73af7aa43a9adedce7bc9f3509e9d57783701dac21f3f1e22e5
-  data.tar.gz: 62219550c9ab648a856018395edb45ffb4527085a543d29cba2970c839a81e529a0b33e150ba3b448c861d3c5af60d791903f0e076b201ec83c94b89496e21b4
+  metadata.gz: 7ae4664679eba882f4e2b095e78e51299fbe940eddc86bd02d522f45deb7dafbce859e1962bb1c37c6e33d62299d917365b2f935416692940b9b2e7b16697c13
+  data.tar.gz: a7db353db260819f47fba9253e5a87cecb47b37f9f1f162fc983e4c56091ca0125c27092c0e1e9fe4414420645f09cd3c578ca00c4d88dbd8264680a39d53f91

data/.env

@@ -0,0 +1,2 @@
+LOKALISE_API_TOKEN=123abc
+LOKALISE_PROJECT_ID=456.def

data/.rubocop.yml

@@ -0,0 +1,29 @@
+# .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+  Exclude:
+    - "vendor/**/*"
+
+Style/Documentation:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 100
+
+Metrics/MethodLength:
+  Max: 15
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+  EnforcedStyle: never
+
+Metrics/AbcSize:
+  Max: 35
+
+Layout/LineLength:
+  max: 120

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.3.8

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+# 0.2.1 / 2026-08-20
+
+## Enhancements
+
+* Perform anonymised email
+
+# 0.2.0 / 2024-06-28
+
+## Enhancements
+
+* Poro class Csv and Normalize to symplify syntax
+* Csv and Normalize class will be private and their method depreciated
+* Use only instance of Zarby
+* Add module to anonymize string value.
+
 # 0.1.5 / 2023-10-24
 
 ## Enhancements

data/README.md

@@ -1,31 +1,135 @@
 # Zarby
 
-TODO: Delete this and the text below, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/zarby.svg)](http://badge.fury.io/rb/zarby)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/zarby`. To experiment with that code, run `bin/console` for an interactive prompt.
+A library to Manipulate String with utiles methods.
 
 ## 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.
+Run:
 
-Install the gem and add to the application's Gemfile by executing:
+    bundle add zarby
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+Or install it yourself as:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+    $ gem install zarby
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+## WARNING
+:warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning:
+
+
+V 0.1.6 (methods used wase depreciated and removed on 10/2024) for version (V 0.2.0)
+
+
+:warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning: :warning:
 
 ## Usage
 
-TODO: Write usage instructions here
+Three module are available: CSV, Normelize And Anonymize
+
+### CSV
+
+```ruby
+detect_separator(content|string)
+```
+
+Method to detecte delimiter in csv!
+
+Since V 0.1.6 (depreciated and removed on 10/2024) :warning: :warning: :warning: :warning: :warning: :warning::warning: :warning: :warning:
+
+```ruby
+Zarby::Csv.detect_separator("aa,bb,cc") # => ","
+Zarby::Csv.detect_separator("aa;bb;cc") # => ";"
+Zarby::Csv.detect_separator("aa,bb;cc,dd") # => ","
+Zarby::Csv.detect_separator("aa;bb;cc,dd") # => ";"
+```
+Since V 0.1.7 :heart_eyes: :heart_eyes: :heart_eyes: :heart_eyes:
+
+```ruby
+Zarby.detect_separator("aa,bb,cc") # => ","
+Zarby.detect_separator("aa;bb;cc") # => ";"
+Zarby.detect_separator("aa,bb;cc,dd") # => ","
+Zarby.detect_separator("aa;bb;cc,dd") # => ";"
+```
+
+`detect_separator`, render the separator, define in a csv on XXXX ms.
+`[',', ';', ':', '|']`, is available by default.
+
+### Normalize
+
+```ruby
+utf8(input|string)
+```
+
+Method to utf8 encode all caracters in a string (since widows , sweden enoding, etc ...).
+
+Since V 0.1.6 (depreciated and removed on 10/2024) :warning: :warning: :warning: :warning: :warning: :warning::warning: :warning: :warning:
+
+```ruby
+Zarby::Normalize.utf8("Aa\xFCAa\xDF".force_encoding('Windows-1252')) # => "AaüAaß
+# actually Windows-1252
+Zarby::Normalize.utf8("Aa\xFCAa\xDF".force_encoding('ASCII-8BIT')) # => "AaüAaß"
+# actually Windows-1252
+Zarby::Normalize.utf8("Dur\xC3\xA9e".force_encoding('ASCII-8BIT')) # => "AaüAaß"
+
+Zarby::Normalize.utf8("Aa\x80Aa\x81".force_encoding('ASCII-8BIT')) # => "AaüAaß"
+
+```
+
+Since V 0.1.7 :heart_eyes: :heart_eyes: :heart_eyes: :heart_eyes:
+
+```ruby
+Zarby.utf8("Aa\xFCAa\xDF".force_encoding('Windows-1252')) # => "AaüAaß
+# actually Windows-1252
+Zarby.utf8("Aa\xFCAa\xDF".force_encoding('ASCII-8BIT')) # => "AaüAaß"
+# actually Windows-1252
+Zarby.utf8("Dur\xC3\xA9e".force_encoding('ASCII-8BIT')) # => "AaüAaß"
+
+Zarby.utf8("Aa\x80Aa\x81".force_encoding('ASCII-8BIT')) # => "AaüAaß"
+
+```
+
+### Anonymize
+
+```ruby
+anonymize(input|string, nb_chars|int \ 2, mask_with|string \ '*')
+```
+
+Method to anonymize a string.
+
+```ruby
+Zarby.anonymize("z") # => "**"
+Zarby.anonymize("za") # => "**"
+Zarby.anonymize("zar") # => "z*r"
+Zarby.anonymize("zarb") # => "z**b"
+Zarby.anonymize("zarby") # => "za*by"
+Zarby.anonymize("mewtwo") # => "me**wo"
+Zarby.anonymize("Ectoplasma") # => "Ec******ma"
+```
+
+`anonymize` try to set '\*' between two first and two last letter of the string if lenght greater than 4.
+if string length between 1 to 2, return **.
+if string length = 3 return a*a.
+if string length = 4 return a**a.
+
+if "@" is present, render `anonymize` string before and after "@", and kept "@" symbole.
+exemple:
 
-## Development
+```ruby
+Zarby.anonymize("z@z") # => "**@**"
+Zarby.anonymize("za@za") # => "**@**"
+Zarby.anonymize("zar@zar") # => "z*r@z*r"
+Zarby.anonymize("zarb@zarb") # => "z**b@z**b"
+Zarby.anonymize("zarby@zarby") # => "za*by@za*by"
+Zarby.anonymize("mewtwo@mewtwo") # => "me**wo@me**wo"
+Zarby.anonymize("Ectoplasma@Ectoplasma") # => "Ec******ma@Ec******ma"
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Using multiple "@"
 
-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).
+Zarby.anonymize("pichu@pikachu@raichu") # => "pi*hu@pi***hu@ra**hu"
+Zarby.anonymize("@fantominus@spectrum@ectoplasma@") # => "**@fa******us@sp****um@ec******ma"
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/VianneySonneville/zarby.
+Bug report and pull request are welcome on GitHub at https://github.com/zarby-ruby/zarby.

data/gem_info.txt

@@ -0,0 +1,12 @@
+## TEST ##
+
+$~ rspec
+
+si j ai un message d'ereure asdf , d'installer la version de ruby alors qu'elle est bonne
+c est que je n ai pas la gem rspec de cette version de ruby
+:::: gem install rspec
+
+
+## PUSH GEM ##
+
+gem build zarby.gemspec

data/lib/zarby/anonymize.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Zarby
+  # this class is used to anonymize string on replace char with *
+  class Anonymize
+    def initialize(input:, nb_chars: 2, mask_with: "*")
+      @input = input
+      @nb_chars = nb_chars
+      @mask_with = mask_with
+
+      validate!
+    end
+
+    # @return [String]
+    def call
+      return anonymize_email if email?
+
+      anonymize_segment(@input)
+    end
+
+    private
+
+    def anonymize_email
+      local, domain = @input.split("@", 2)
+      domain_name, tld = domain.split(".", 2)
+
+      "#{anonymize_segment(local)}@#{anonymize_segment(domain_name)}.#{tld}"
+    end
+
+    def anonymize_segment(input, nbr = @nb_chars)
+      return @mask_with * 2 if input.length < 3
+
+      return anonymize_segment(input, nbr - 1) if input.length <= nbr * 2 && nbr.positive?
+
+      prefix = input[0, nbr]
+      suffix = input[-nbr, nbr]
+      masked = @mask_with * (input.length - (nbr * 2))
+
+      prefix + masked + suffix
+    end
+
+    def email?
+      @input.match?(/\A[^\s@]+@[^\s@]+\.[^\s@]+\z/)
+    end
+
+    def validate!
+      raise Zarby::ArgumentZarby, "input must be a String" unless @input.is_a?(String)
+      raise Zarby::ArgumentZarby, "mask_with must be a String" unless @mask_with.is_a?(String)
+      raise Zarby::ArgumentZarby, "nb_chars must be >= 0" if @nb_chars.negative?
+    end
+  end
+end

data/lib/zarby/csv.rb

@@ -1,27 +1,26 @@
 # frozen_string_literal: true
 
 module Zarby
-  class NoColSepDetected < StandardError; end
-
   # this class is used to detect the column separator in a CSV file
   class Csv
+    extend Gem::Deprecate
+
     COMMON_DELIMITERS = ['","', '";"', '":"', '"|"'].freeze
 
     # @param [String] content
     # @return [Csv]
     def initialize(content:)
-      @content = content || ""
-    end
-
-    # @param [String] content
-    # @return [String]
-    def self.detect_separator(content)
-      new(content: content).detect_separator
+      @content = content.to_s.each_line.first.to_s.strip
     end
 
     # @return [String]
-    def detect_separator
-      valid? ? delimiters[0][0][1] : raise(Zarby::NoColSepDetected)
+    def call
+      if valid?
+        delimiters[0][0][1]
+      else
+        raise(Zarby::ColSeparatorZarby,
+              "The content to be analyzed must have one of this list as a delimiter: ',' ';' ':' '|'")
+      end
     end
 
     private

data/lib/zarby/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Zarby
+  class ColSeparatorZarby < StandardError; end
+  class ArgumentZarby < StandardError; end
+end

data/lib/zarby/functions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module Zarby
+  module Functions
+    def zp(*_args)
+      IO.console.winsize
+      puts location caller_locations.first
+    end
+
+    def location(call_loc)
+      " ⓩ Ⓐ Ⓡ Ⓑ ⓟ Ⓡ ⓘ ⓝ Ⓣ - from: #{name}##{call_loc.label} (in #{project_path call_loc.path}, at line: #{call_loc.lineno})" # rubocop:disable Layout/LineLength
+    end
+
+    def project_path(full_path)
+      root_path = Rails.root.nil? ? File.expand_path("../../..", __dir__) : Rails.root.to_s
+      full_path.sub "#{root_path}/", ""
+    end
+  end
+end

data/lib/zarby/normalize.rb

@@ -9,30 +9,33 @@ module Zarby
     # @param input [String]
     # @return [String]
     def initialize(input:)
-      @input = input&.force_encoding(Encoding::UTF_8) || ''
-    end
+      unless input.is_a?(String)
+        raise Zarby::ArgumentZarby, "input to normalise utf8 must be of type String, #{input.class} given"
+      end
 
-    # @param input [String]
-    # @return [String]
-    def self.utf8(input)
-      new(input: input).utf8
+      @input = input&.force_encoding(Encoding::UTF_8) || ""
     end
 
     # @return [String]
-    def utf8
-      output = @input if valid?
+    def call
+      return @input if valid?
 
+      @input.dup.force_encoding(Encoding::ISO_8859_1).encode!(Encoding::UTF_8)
+    end
 
-      output ||= @input.force_encoding(Encoding::ISO_8859_1).encode!(Encoding::UTF_8)
-    rescue Encoding::UndefinedConversionError, Encoding::InvalidByteSequenceError
-      nil
+    class << self
+      # @param input [String]
+      # @return [String]
+      def utf8(input)
+        new(input: input).utf8
+      end
     end
 
     private
 
     # @return [Boolean]
     def valid?
-      @input.encoding.name == 'UTF-8' && @input.valid_encoding?
+      @input.encoding.name == "UTF-8" && @input.valid_encoding?
     end
   end
 end

data/lib/zarby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Zarby
-  VERSION = "0.1.6"
+  VERSION = "0.2.1"
 end

data/lib/zarby.rb

@@ -1,9 +1,55 @@
-# frozen_string_literal: true
-
-require_relative 'zarby/version'
-require_relative 'zarby/csv'
-require_relative 'zarby/normalize'
+require_relative "zarby/anonymize"
+require_relative "zarby/csv"
+require_relative "zarby/errors"
+require_relative "zarby/functions"
+require_relative "zarby/normalize"
+require_relative "zarby/version"
 
 module Zarby
-  class ZarbyError < StandardError; end
+  def plop
+    zp "coucou ca va?"
+    puts inspect
+    puts self.class.inspect
+    puts self.class.name
+  end
+
+  class Foo
+    def self.plop
+      zp "ijijij"
+    end
+  end
+
+  # Anonymizes a given input by masking the first `nb_chars` characters with `mask_with`.
+  #
+  # @param input [String] The string input to be anonymized.
+  # @param nb_chars [Integer] The number of characters from the input to be masked. Default is 2.
+  # @param mask_with [String] The character to mask the input with. Default is '*'.
+  # @return [String] The anonymized string with masked characters.
+  def anonymize(input, nb_chars: 2, mask_with: "*")
+    Anonymize.new(input:, nb_chars:, mask_with:).call
+  end
+
+  # Detects and returns the separator used in the provided CSV content.
+  #
+  # @param content [String] The CSV content to detect the separator for.
+  # @return [String] The detected separator (e.g., ',' or ';').
+  def detect_separator(content)
+    Csv.new(content:).call
+  end
+
+  # Normalizes the input string to UTF-8 encoding.
+  #
+  # @param input [String] The input string to normalize.
+  # @return [String] The normalized string in UTF-8 encoding.
+  def utf8(input)
+    Normalize.new(input:).call
+  end
+
+  # Expose methods as module functions for easy use without needing to instantiate.
+  module_function :anonymize, :detect_separator, :utf8, :plop
+
+  # Prevents direct access to the Anonymize class outside the module.
+  private_constant :Anonymize
 end
+
+module Kernel; include Zarby::Functions; end # rubocop:disable Style/OneClassPerFile

data/zarby.gemspec

@@ -10,15 +10,16 @@ Gem::Specification.new do |spec|
 
   spec.summary = "String encoding and decoding with Ruby."
   # spec.description = "TODO: Write a longer description or delete this line."
-  spec.homepage = "https://guides.rubygems.org"
+  spec.homepage = "https://rubygems.org/gems/zarby"
   spec.required_ruby_version = ">= 2.6.0"
-  spec.licenses = ['MIT']
+  spec.licenses = ["MIT"]
 
-  spec.metadata = { 
-    "source_code_uri" => "https://github.com/VianneySonneville/zarby",  
-    "changelog_uri" => "https://github.com/VianneySonneville/zarby/blob/main/CHANGELOG.md"
+  spec.metadata = {
+    "source_code_uri" => "https://github.com/VianneySonneville/zarby",
+    "changelog_uri" => "https://github.com/VianneySonneville/zarby/blob/main/CHANGELOG.md",
+    "rubygems_mfa_required" => "true",
+    "allowed_push_host" => "https://rubygems.org"
   }
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   # spec.metadata["homepage_uri"] = spec.homepage
   # spec.metadata["source_code_uri"] = spec.homepage
@@ -36,8 +37,4 @@ Gem::Specification.new do |spec|
   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
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
 end

metadata

@@ -1,40 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: zarby
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.1
 platform: ruby
 authors:
 - vianney.sonneville
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2026-08-20 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email:
 - vianneysonneville4@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env"
+- ".rubocop.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - LICENSE
 - README.md
 - Rakefile
+- gem_info.txt
 - lib/zarby.rb
+- lib/zarby/anonymize.rb
 - lib/zarby/csv.rb
+- lib/zarby/errors.rb
+- lib/zarby/functions.rb
 - lib/zarby/normalize.rb
 - lib/zarby/version.rb
 - sig/zarby.rbs
+- zarby-0.1.0.gem
+- zarby-0.1.1.gem
+- zarby-0.1.2.gem
+- zarby-0.1.3.gem
+- zarby-0.1.4.gem
+- zarby-0.1.5.gem
+- zarby-0.1.6.gem
 - zarby.gemspec
-homepage: https://guides.rubygems.org
+homepage: https://rubygems.org/gems/zarby
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/VianneySonneville/zarby
   changelog_uri: https://github.com/VianneySonneville/zarby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -49,8 +64,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: String encoding and decoding with Ruby.
 test_files: []