lucky_case 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7c4dc263bc163972145a81df6aee8c9f95326618965c5fae6f499be6d90aad7
-  data.tar.gz: 28397c3898961a0651a518ecfcf22750f54646433b032cb1a61148e0953bdea8
+  metadata.gz: eac6adfd588810a2859249ae38e7c67d0150c5887b8d77dfa696892ae1ea2a24
+  data.tar.gz: 5c4d028124cb29c76cbddf385a4ecadde25d0dc9f4e9e6bc2bf0a72825fd43f1
 SHA512:
-  metadata.gz: 3bee15287a4859b58818ba57c602afe70623c8020177b6af654f08059325f64fc03cce898d7ae97d7d33a6acdf9ee81afd47a5251049f05e25bffb51125a4bf6
-  data.tar.gz: 68ffb0cc620c65ce3bca6f0ec5c14d582ad01cab8477be6afdfafa67728888989b15f28bc851c409c622f86fd0aab2cbc5520397b221b3845fdd2589b6bd8214
+  metadata.gz: fb781175697d671389a9c2126e932178298c43272308615adf4f467a952212d3a95581a568d7a61714c2b7dc69f626c8a5f3fdea50337de0bc0996bfe645d2b1
+  data.tar.gz: abb0a8947521ec1146c1e4767a5a3dbcd6b63131185ffbb3682a495369e416be3e5b52ae8a28a1f42326b9af60c568fa205066658e15e94c55cb629dceb840c6

data/README.md

@@ -2,6 +2,8 @@
 
 The lucky ruby gem to identify and convert strings from any letter case to another. Plus some extra functions.
 
+I also created a javascript port named [lucky-case](https://github.com/magynhard/lucky-case).
+
 Useful when working with conventions, where class names, method names and file names needs to be converted.
 
 * Converters: Only characters, numbers, dashes and underlines are allowed inside a string.
@@ -49,14 +51,15 @@ LuckyCase.convert_case('some_snake', :pascal_case)     # => 'SomeSnake'
 # transformers
 LuckyCase.lower_case('Some_FuckingShit')               # => 'some_fuckingshit'
 LuckyCase.upper_case('Some_FuckingShit')               # => 'SOME_FUCKINGSHIT'
-LuckyCase.swap_case('SomeSwappy_Case-Example')         # => 'sOMEsWAPPY-cASE_eXAMPLE'
 LuckyCase.capital('example')                           # => 'Example'
 LuckyCase.capitalize('example')                        # => 'Example'
+LuckyCase.decapitalize('ExaMple')                      # => 'exaMple'
+LuckyCase.swap_case('SomeSwappy_Case-Example')         # => 'sOMEsWAPPY-cASE_eXAMPLE'
 LuckyCase.constantize('some_constant')                 # => SomeConstant
 LuckyCase.constantize('SOME_CONSTANT')                 # => SomeConstant
 LuckyCase.constantize('some/path_example/folder')      # => Some::PathExample::Folder
-LuckyCase.deconstantize(SomeConstant)                  # => 'some_constant'
-LuckyCase.deconstantize(Some::PathExample::Folder, case_type: :camel_case)     # => 'some/pathExample/folder'
+LuckyCase.deconstantize(SomeConstant)                  # => 'some_constant' // default case_type: :snake_case
+LuckyCase.deconstantize(Some::PathExample::Folder, case_type: :camel_case)  # => 'some/pathExample/folder'
 
 # identifiers
 LuckyCase.case('this_can_only_be_snake_case')          # => :snake_case
@@ -79,6 +82,8 @@ LuckyCase.upper_case?('UPPER50984')                    # => true
 LuckyCase.lower_case?('lower_cheese')                  # => true
 LuckyCase.capital?('Some')                             # => true
 LuckyCase.capitalized?('some')                         # => false
+LuckyCase.decapitalized?('soMe')                       # => true
+LuckyCase.not_capital?('Some')                         # => false
 LuckyCase.valid_case_type?(:snake_case)                # => true
 LuckyCase.valid_case_type?(:apple_case)                # => false
 LuckyCase.valid_case_string?('validString')            # => true
@@ -87,10 +92,10 @@ LuckyCase.valid_case_string?('1nV4lid$tring')          # => false
 
 ### Approach 2: Monkey patch the string class
 
-With monkey patching you can access the same methods (except deconstantize, valid_case_type?) of LuckyCase directly from strings.
+With monkey patching you can access the same methods (except `#deconstantize`, `#valid_case_type?`) of LuckyCase directly from strings.
 Additionally they provide versions with exclamation mark for direct manipulation.
 
-Because the method #case is so general and could lead to conflicts, it is called #letter_case here.
+Because the methods `#case` and `#cases` are so general and could lead to conflicts, they are called `#letter_case` and `#letter_cases` at strings.
 
 ```ruby
 require 'lucky_case/string'

data/Rakefile

@@ -8,4 +8,8 @@ task :default do
   system 'rake --tasks'
 end
 
+task :test do
+  system 'rspec'
+end
+
 RSpec::Core::RakeTask.new(:spec)

data/lib/lucky_case.rb

@@ -611,6 +611,44 @@ module LuckyCase
     capital? string, skip_prefixed_underscores: skip_prefixed_underscores
   end
 
+  # Convert the first character to lower case
+  #
+  # @param [String] string to convert
+  # @param [Boolean] skip_prefixed_underscores
+  # @return [String]
+  def self.decapitalize(string, skip_prefixed_underscores: false)
+    return string if string.empty?
+    s = if skip_prefixed_underscores
+          cut_underscores_at_start string
+        else
+          string
+        end
+    s = s[0].downcase + s[1..-1]
+    if skip_prefixed_underscores
+      underscores_at_start(string) + s
+    else
+      s
+    end
+  end
+
+  # Check if the strings first character is a lower letter
+  #
+  # @param [String] string to check
+  # @param [Boolean] skip_prefixed_underscores
+  # @return [Boolean]
+  def self.not_capital?(string, skip_prefixed_underscores: false)
+    decapitalized? string, skip_prefixed_underscores
+  end
+
+  # Check if the strings first character is a lower letter
+  #
+  # @param [String] string to check
+  # @param [Boolean] skip_prefixed_underscores
+  # @return [Boolean]
+  def self.decapitalized?(string, skip_prefixed_underscores: false)
+    !(capital? string, skip_prefixed_underscores)
+  end
+
   #----------------------------------------------------------------------------------------------------
   # MIXED CASE
   #----------------------------------------------------------------------------------------------------
@@ -632,9 +670,9 @@ module LuckyCase
     loop do
       converted = ''
       a.each do |part|
-        converted += self.send CASES.keys.sample, part
+        converted += self.convert_case part, CASES.keys.sample, preserve_prefixed_underscores: preserve_prefixed_underscores
       end
-      converted = self.send CASES.keys.sample, converted
+      converted = self.convert_case converted, CASES.keys.sample, preserve_prefixed_underscores: preserve_prefixed_underscores
       break if converted != string && underscores_at_start(string) + converted != string
     end
     if preserve_prefixed_underscores

data/lib/lucky_case/string.rb

@@ -21,6 +21,11 @@ class String
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Symbol,nil] symbol of type, nil if no match
+  def letter_case(allow_prefixed_underscores: true)
+    LuckyCase.case self, allow_prefixed_underscores: allow_prefixed_underscores
+  end
+
+  # easter egg version of #letter_case
   def lucky_case(allow_prefixed_underscores: true)
     LuckyCase.case self, allow_prefixed_underscores: allow_prefixed_underscores
   end
@@ -29,6 +34,11 @@ class String
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Array<Symbol>,nil] symbols of types, nil if no one matches
+  def letter_cases(allow_prefixed_underscores: true)
+    LuckyCase.cases self, allow_prefixed_underscores: allow_prefixed_underscores
+  end
+
+  # easter egg version of #letter_cases
   def lucky_cases(allow_prefixed_underscores: true)
     LuckyCase.cases self, allow_prefixed_underscores: allow_prefixed_underscores
   end
@@ -441,6 +451,34 @@ class String
     self.capital? skip_prefixed_underscores: skip_prefixed_underscores
   end
 
+  # Convert the first character to lower case
+  #
+  # @param [Boolean] skip_prefixed_underscores
+  # @return [String]
+  def decapitalize(skip_prefixed_underscores: false)
+    LuckyCase.decapitalize self, skip_prefixed_underscores: skip_prefixed_underscores
+  end
+
+  def decapitalize!(skip_prefixed_underscores: false)
+    set_self_value self.decapitalize skip_prefixed_underscores: skip_prefixed_underscores
+  end
+
+  # Check if the strings first character is a lower letter
+  #
+  # @param [Boolean] skip_prefixed_underscores
+  # @return [Boolean]
+  def decapitalized?(skip_prefixed_underscores: false)
+    LuckyCase.decapitalized? self, skip_prefixed_underscores: skip_prefixed_underscores
+  end
+
+  # Check if the strings first character is a lower letter
+  #
+  # @param [Boolean] skip_prefixed_underscores
+  # @return [Boolean]
+  def not_capital?(skip_prefixed_underscores: false)
+    self.decapitalized? skip_prefixed_underscores: skip_prefixed_underscores
+  end
+
   #----------------------------------------------------------------------------------------------------
   # MIXED CASE
   #----------------------------------------------------------------------------------------------------

data/lib/lucky_case/version.rb

@@ -1,3 +1,3 @@
 module LuckyCase
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lucky_case
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Matthäus J. N. Beyrle
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-11-25 00:00:00.000000000 Z
+date: 2021-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler