simple_symbolize 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07aae9ef22a012d4b461cac6145bd8c1a9a12310473d000d1618a23cf53db064
-  data.tar.gz: b18868b5d50109402449b3c92c98ca6246ecdefe66d979c50bd5902936b57c19
+  metadata.gz: 1e23023a3bb1c8d394ba3059e5e72d0fef3480b5c0f09900aa9d00e61d784058
+  data.tar.gz: 557b65ea91d5db0400dd5aa23b66894d9fe5576962bfc7c1bf9895337ccfc093
 SHA512:
-  metadata.gz: f03737f6f4d6a4fa170a1ffe3b685ea8f2c10899f3c125a50595b265479131e0b52cd1ea6ae25cbf7ebdeb6be237487e42e23fd104546fd68f3968bce1fc30fa
-  data.tar.gz: 27e9c7e2e6fea1d041d02b082cde749767577ec71bca85a6ba0033e93aa21914e6e6f8ad200679671267d2af54e5ab4d699cf59592aa6744d12907c80a3a81e3
+  metadata.gz: 67ef8dd2fa3215f422fe90ec76f86da67a61f6801a3f6cc1ef9cfb763136d2fe52ba561ab0339e80eab120c16ab0c03f1841868abc9101a61d8f55d45fd3c123
+  data.tar.gz: e330593b6aae61ad7ed11e6c82a7e9be6b3292d25847e69eafef9218583eaec787b9127e15447f8ca5f0c3d628b459909b5eb46f5a9414ca13f8b7daf0a36acd

data/.github/workflows/ruby.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['2.7', '3.0', '3.1']
 
     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.6', '2.7', '3.0' ]
+        ruby-version: [ '2.7', '3.0', '3.1' ]
 
     steps:
       - uses: actions/checkout@v2
@@ -25,7 +25,6 @@ jobs:
 
   deploy:
     needs: test
-    name: Build + Publish
     runs-on: ubuntu-latest
     permissions:
       packages: write

data/.gitignore

@@ -10,3 +10,4 @@
 *.gem
 # rspec failure tracking
 .rspec_status
+Gemfile.lock

data/.rubocop_todo.yml

@@ -1,13 +1,28 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-06-29 14:23:53 UTC using RuboCop version 1.18.0.
+# 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
-# Cop supports --auto-correct.
+# 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:
@@ -35,7 +50,7 @@ Style/Documentation:
     - 'lib/simple_symbolize.rb'
 
 # Offense count: 10
-# Cop supports --auto-correct.
+# This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: always, always_true, never
 Style/FrozenStringLiteralComment:
@@ -51,17 +66,7 @@ Style/FrozenStringLiteralComment:
     - 'spec/simple_symbolize_spec.rb'
     - 'spec/spec_helper.rb'
 
+# Offense count: 1
 Style/MixinUsage:
   Exclude:
     - 'lib/simple_symbolize.rb'
-
-
-
-
-
-
-
-
-
-
-

data/README.md

@@ -70,6 +70,34 @@ SimpleSymbolize.translate do |trans|
 end
 ```
 
+## Updates!
+
+V1.1: SimpleSymbolize has got new friends!
+
+Introducing `elementize` and `camelize`.
+
+### 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
+
+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/lib/simple_symbolize/version.rb

@@ -1,3 +1,3 @@
 module SimpleSymbolize
-  VERSION = '1.0.1'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/simple_symbolize.rb

@@ -34,4 +34,30 @@ module SimpleSymbolize
     str.downcase.tr(SimpleSymbolize.translations.underscore.join, '_')
       &.tr(SimpleSymbolize.translations.remove.join, '')&.to_sym
   end
+
+  # Symbolizes a String object and returns it as a String object.
+  #
+  # @param str [String] the String object to be symbolized.
+  #
+  # @example Symbolize a string using the camelize method
+  #   elementize("hello world!") #=> "helloWorld"
+  def elementize(str)
+    return str unless str.is_a?(Symbol) || str.is_a?(String)
+
+    symbolize(str).to_s
+  end
+
+  # Turns a String object into a camelCase Symbol.
+  #
+  # @param str [String] 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 str.to_sym if str.is_a?(String) && (str.split(/[_ ]/).size <= 1)
+
+    first, *rest = elementize(str).split('_')
+    rest ? (first << rest.map(&:capitalize).join).to_sym : first.to_sym
+  end
 end

data/simple_symbolize.gemspec

@@ -14,7 +14,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.5.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
@@ -33,5 +33,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rubocop', '~> 1.18.0'
+  spec.add_development_dependency 'rubocop', '~> 1.29.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_symbolize
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - alexo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.29.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.29.0
 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!'
@@ -68,7 +68,6 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -93,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,55 +0,0 @@
-PATH
-  remote: .
-  specs:
-    simple_symbolize (1.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.4.4)
-    parallel (1.20.1)
-    parser (3.0.1.1)
-      ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (12.3.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.18.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.7.0)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  rake (~> 12.0)
-  rspec (~> 3.2)
-  rubocop (~> 1.18.0)
-  simple_symbolize!
-
-BUNDLED WITH
-   2.2.15