simple_symbolize 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59e6e0627c56ba92e83ade0f7da175a6900efb94239e7d090cf3021ceecc2c36
-  data.tar.gz: c38a440d4feca6c293e39ddd44241f78c1b0096933a60d0929abb254ffe77497
+  metadata.gz: fcd4f78253aed92cf1895fd948418deac6fe69f2e3ce80efae55eb79556b157c
+  data.tar.gz: 7cefb49253c485e825b05e27bf6fcf020f4ef24f1995cc0ab1590e76a5ef0aed
 SHA512:
-  metadata.gz: 6242fbdc38514b7eed4b3931eb5391abc5e7d6b833ccb8bd5dc982c4eb301b4606b256139233ab5f07efec72de2f6fc8964cc38a99a33d4ddd5e734f77382c1e
-  data.tar.gz: bf26933555776d4b25f32c3bc2df40e385ad38f45c599b2129a981aae677f38156dbbec63351968e217478c4ea600063a08c02fe6c83320764afa49ef19cdbdc
+  metadata.gz: fee566211bb3708c7f3225897008f9f5434fbaa8840f3fcab3b50d7031e74263a4b14a39fbf383834bbd3948cb4020457e00c6d83777f3235fa7d3d77877f312
+  data.tar.gz: a453a5a9be5d81ea8198f21b5fbd0fc1663f71f58f6051a9aa3ebc7c87893d76413d7b1c38b3e184032a7b773ed9ecabe92374f88fb467853ab986a55d17e57b

data/.github/workflows/ruby.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1']
+        ruby-version: [ '3.0', '3.1', '3.2' ]
 
     steps:
     - uses: actions/checkout@v2

data/.github/workflows/ruby_gem.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: [ '2.7', '3.0', '3.1' ]
+        ruby-version: [ '3.0', '3.1', '3.2' ]
 
     steps:
       - uses: actions/checkout@v2

data/.rubocop.yml

@@ -1,5 +1,30 @@
-inherit_from: .rubocop_todo.yml
-
 AllCops:
   NewCops: enable
-  SuggestExtensions: false
+  SuggestExtensions: false
+  TargetRubyVersion: 3.0
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Metrics/BlockLength:
+  Max: 120
+  Exclude:
+    - spec/**/*.rb
+
+Style/MixinUsage:
+  Enabled: false
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 25
+
+Layout/LineLength:
+  Max: 130

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in simple_symbolize.gemspec

data/README.md

@@ -64,40 +64,59 @@ No sweat, you can configure this gem to underscore and remove to your hearts con
 
 ```ruby
 SimpleSymbolize.translate do |trans|
-  trans.to_underscore('!')
-  trans.to_remove(' ')
-  trans.to_omit('@')
+  trans.to_underscore = '!'
+  trans.to_remove = ' '
+  trans.to_omit = '@'
 end
 ```
 
 ## Updates!
 
-V1.1: SimpleSymbolize has got new friends!
+### V3
+#### String to_snake_case
+
+`#to_snake_case` extends the String class to return you your String object in snake_case format.
+
+#### Handle camelCase with Symbolize
+
+```ruby
+symbolize('helloWorld!') # => :hello_world
+```
+
+This is the default behaviour and can be switched off by setting `#handle_camel_case` to `false`
+
+```ruby
+SimpleSymbolize.translate { |trans| trans.handle_camel_case = false }
+```
+
+#### Additional ways to configure SimpleSymbolize
+
+Arrays are now supported when configuring the gem
+
+```ruby
+SimpleSymbolize.translate { |trans| trans.to_underscore = %w[!&*] }
+```
+
+### V2
+
+SimpleSymbolize has got new friends!
 
 Introducing `elementize` and `camelize`.
 
-### Elementize
+#### Elementize
 
 Sometimes you just want a simple String obj without all the fuss. Elementize takes your String obj, removes that fuss
 and returns you a simple-to-use String.
 
-#### Example
-
 ```ruby
 elementize('hello world!') # => "hello_world"
 ```
 
-### Camelize
+#### Camelize
 
 Great for working with APIs that require fields in a JSON format. Camelize clears away the clutter and returns you 
 a Symbolized object in camelCase.
 
-#### Example
-
-```ruby
-camelize('hello world!') # => :helloWorld
-```
-
 [comment]: <> (## Contributing)
 
 [comment]: <> (Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/simple_symbolize.)

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'simple_symbolize'

data/lib/simple_symbolize/string.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simple_symbolize'
 
 # Extends the String class by mixing in the symbolize module.
@@ -7,4 +9,14 @@ class String
   def symbolize
     SimpleSymbolize.symbolize(self)
   end
+
+  # @example Turns a String into it's snake_case equivalent
+  #   "helloWorld".to_snake_case => 'hello_word'
+  def to_snake_case
+    # rubocop:disable Style/RedundantSelf
+    self.gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .downcase
+    # rubocop:enable Style/RedundantSelf
+  end
 end

data/lib/simple_symbolize/translations.rb

@@ -1,68 +1,93 @@
+# frozen_string_literal: true
+
 module SimpleSymbolize
   # The translations class holds the attributes used to transform a String object.
   # It also provides helper methods to manipulate those attributes.
   class Translations
     # @return [Array] the characters to be transformed into underscores.
-    attr_accessor :underscore
+    attr_reader :underscore
     # @return [Array] the characters to be removed from the String.
-    attr_accessor :remove
+    attr_reader :remove
     # @return [Array] the characters to be untouched from the String.
-    attr_accessor :omit
+    attr_reader :omit
+
+    attr_reader :handle_camel_case
 
     # Creates an instance of the Translations class.
     #
     # Sets the class variables to a default state.
     def initialize
-      @underscore = [' ']
-      @remove = %w[\' ( ) , . : "]
-      @omit = []
+      reset!
     end
 
     # Merges the String passed with the @underscore Array omitting duplicates.
-    # Removes those characters from the @remove ans @omit Arrays to avoid the change being over-written.
+    # Removes those characters from the @remove and @omit Arrays to avoid the change being over-written.
     #
-    # @param t [String] a String object containing characters to be underscored.
+    # @param chars [Array] an object containing characters to be underscored.
     #
     # @return [Array] the Array of characters to be underscored.
-    #
-    # @raise [ArgumentError] if the param does not respond to  #to_s.
-    def to_underscore(t)
-      raise ArgumentError 'needs to be a String or respond to #to_s' unless t.respond_to?(:to_s)
+    def to_underscore=(chars)
+      chars = sanitise_chars(chars)
 
-      @remove -= t.to_s.chars
-      @omit -= t.to_s.chars
-      @underscore |= t.to_s.chars
+      @remove -= chars
+      @omit -= chars
+      @underscore |= chars
     end
 
     # Merges the String passed with the @remove Array omitting duplicates.
     # Removes those characters from the @underscore and @omit Arrays to avoid the change being over-written.
     #
-    # @param t [String] a String object containing characters to be removed.
+    # @param chars [String] a String object containing characters to be removed.
     #
     # @return [Array] the Array of characters to be removed.
-    #
-    # @raise [ArgumentError] if the param does not respond to  #to_s.
-    def to_remove(t)
-      raise ArgumentError 'needs to be a String or respond to #to_s' unless t.respond_to?(:to_s)
+    def to_remove=(chars)
+      chars = sanitise_chars(chars)
 
-      @underscore -= t.to_s.chars
-      @omit -= t.to_s.chars
-      @remove |= t.to_s.chars
+      @underscore -= chars
+      @omit -= chars
+      @remove |= chars
     end
 
     # Removes characters within the String passed from the @remove and @underscore Arrays.
     #
-    # @param t [String] a String object containing characters to be removed.
+    # @param chars [String] a String object containing characters to be removed.
     #
     # @return [Array] the Array of characters to be omitted.
+    def to_omit=(chars)
+      chars = sanitise_chars(chars)
+
+      @underscore -= chars
+      @remove -= chars
+      @omit += chars
+    end
+
+    def handle_camel_case=(handle)
+      handle = handle.to_s.downcase
+      raise ArgumentError 'needs to be either `true` or `false`' unless %w[true false].include?(handle)
+
+      @handle_camel_case = handle.eql?('true')
+    end
+
+    def reset!
+      @underscore = [' ', '::', '-']
+      @remove = %w[' ( ) , . : " ! @ £ $ % ^ & * / { } [ ] < > ; = #]
+      @omit = []
+      @handle_camel_case = true
+    end
+
+    private
+
+    # Converts chars into Array of Strings
+    #
+    # @param arg Arg to be converted
+    #
+    # @return Array of Strings
     #
-    # @raise [ArgumentError] if the param does not respond to  #to_s.
-    def to_omit(t)
-      raise ArgumentError 'needs to be a String or respond to #to_s' unless t.respond_to?(:to_s)
+    # @raise [ArgumentError] if the arg is not either a String or an Array.
+    def sanitise_chars(arg)
+      raise ArgumentError 'needs to be a String or an Array of characters' unless [String, Array].include?(arg.class)
 
-      @underscore -= t.to_s.chars
-      @remove -= t.to_s.chars
-      @omit += t.to_s.chars
+      arg.respond_to?(:chars) ? arg.chars : arg.map(&:to_s)
     end
   end
 end

data/lib/simple_symbolize/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SimpleSymbolize
-  VERSION = '2.0.1'.freeze
+  VERSION = '3.0.0'
 end

data/lib/simple_symbolize.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simple_symbolize/version'
 
 require_relative 'simple_symbolize/string'
@@ -5,6 +7,8 @@ require_relative 'simple_symbolize/translations'
 
 include SimpleSymbolize
 
+# Main module for the gem
+# Contains the base methods and allows configuration
 module SimpleSymbolize
   class Error < StandardError; end
 
@@ -18,46 +22,55 @@ module SimpleSymbolize
   # Configures the Symbolize environment.
   #
   # @yieldparam [Translations] config the translations object yielded to the block.
-  def self.translate(&block)
-    yield translations
+  def self.translate
+    yield(translations) if block_given?
   end
 
   # Symbolizes a String object.
   #
-  # @param str [String] the String object to be symbolized.
+  # @param obj [Object] the String object to be symbolized.
   #
   # @example Symbolize a string using the symbolize method
   #   symbolize("hello world!") #=> :hello_world
-  def symbolize(str)
-    return str if str.is_a?(Symbol) || str.nil?
+  def symbolize(obj)
+    return obj unless obj.respond_to?(:to_s)
+    return obj if [Hash, Array, NilClass].include?(obj.class)
+
+    str = obj.to_s
+    str = str.to_snake_case if SimpleSymbolize.translations.handle_camel_case
 
-    str.downcase.tr(SimpleSymbolize.translations.underscore.join, '_')
-      &.tr(SimpleSymbolize.translations.remove.join, '')&.to_sym
+    str.downcase
+       .gsub(Regexp.union(SimpleSymbolize.translations.underscore), '_')
+       .gsub(Regexp.union(SimpleSymbolize.translations.remove), '')
+       .to_sym
   end
 
   # Symbolizes a String object and returns it as a String object.
   #
-  # @param str [String] the String object to be symbolized.
+  # @param obj [Object] the object to be symbolized.
   #
   # @example Elementize a string using the elementize method
   #   elementize("hello world!") #=> "helloWorld"
-  def elementize(str)
-    return str unless str.is_a?(Symbol) || str.is_a?(String)
+  def elementize(obj)
+    return obj unless obj.respond_to?(:to_s)
+    return obj if [Hash, Array, NilClass].include?(obj.class)
 
-    symbolize(str).to_s
+    symbolize(obj).to_s
   end
 
   # Turns a String object into a camelCase Symbol.
   #
-  # @param str [String] the String object to be camelized.
+  # @param obj [Object] the String object to be camelized.
   #
   # @example Camelize a string using the camelize method
   #   camelize("hello world!") #=> :helloWorld
-  def camelize(str)
-    return str unless str.is_a?(String) || str.is_a?(Symbol)
-    return symbolize(str) if str.is_a?(String) && (str.split(/[_ ]/).size <= 1)
+  def camelize(obj)
+    return obj unless obj.respond_to?(:to_s)
+    return obj if [Hash, Array, NilClass].include?(obj.class)
+
+    first, *rest = elementize(obj).split('_')
+    return obj if first.nil?
 
-    first, *rest = elementize(str).split('_')
-    rest ? (first << rest.map(&:capitalize).join).to_sym : symbolize(first)
+    rest.size.positive? ? (first << rest.map(&:capitalize).join).to_sym : symbolize(first)
   end
 end

data/simple_symbolize.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'lib/simple_symbolize/version'
 
 Gem::Specification.new do |spec|
@@ -14,7 +16,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/dvla/simple-symbolize'
 
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.0')
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
@@ -32,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'pry', '~> 0.14'
-  spec.add_development_dependency 'rake', '~> 12.0'
-  spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rubocop', '~> 1.29.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.12'
+  spec.add_development_dependency 'rubocop', '~> 1.54'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_symbolize
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - alexo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2023-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.29.0
+        version: '1.54'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.29.0
+        version: '1.54'
 description: 'simple_symbolize will remove special characters from a String, replacing
   whitespace with an underscore, down-casing and finally calling the #to_sym String
   method. Configure this gem to your hearts content!'
@@ -80,7 +80,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".rubocop_todo.yml"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -106,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.rubocop_todo.yml

@@ -1,72 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2022-05-20 09:59:54 UTC using RuboCop version 1.29.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 1
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequireMFA:
-  Exclude:
-    - 'simple_symbolize.gemspec'
-
-# Offense count: 1
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
-  Exclude:
-    - 'simple_symbolize.gemspec'
-
-# Offense count: 1
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods, IgnoreNotImplementedMethods.
-Lint/UnusedMethodArgument:
-  Exclude:
-    - 'lib/simple_symbolize.rb'
-
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
-# IgnoredMethods: refine
-Metrics/BlockLength:
-  Max: 88
-
-# Offense count: 3
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
-Naming/MethodParameterName:
-  Exclude:
-    - 'lib/simple_symbolize/translations.rb'
-
-# Offense count: 1
-# Configuration parameters: AllowedConstants.
-Style/Documentation:
-  Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/simple_symbolize.rb'
-
-# Offense count: 10
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Exclude:
-    - 'Gemfile'
-    - 'Rakefile'
-    - 'bin/console'
-    - 'lib/simple_symbolize.rb'
-    - 'lib/simple_symbolize/string.rb'
-    - 'lib/simple_symbolize/translations.rb'
-    - 'lib/simple_symbolize/version.rb'
-    - 'simple_symbolize.gemspec'
-    - 'spec/simple_symbolize_spec.rb'
-    - 'spec/spec_helper.rb'
-
-# Offense count: 1
-Style/MixinUsage:
-  Exclude:
-    - 'lib/simple_symbolize.rb'