add support for 'decapitalize'

Author: magynhard

README.md

@@ -53,6 +53,7 @@ LuckyCase.lower_case('Some_FuckingShit')               # => 'some_fuckingshit'
 LuckyCase.upper_case('Some_FuckingShit')               # => 'SOME_FUCKINGSHIT'
 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
@@ -81,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

Rakefile

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

lib/lucky_case.rb

@@ -611,6 +611,44 @@ def self.capitalized?(string, skip_prefixed_underscores: false)
     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
   #----------------------------------------------------------------------------------------------------

lib/lucky_case/string.rb

@@ -451,6 +451,34 @@ def capitalized?(skip_prefixed_underscores: false)
     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
   #----------------------------------------------------------------------------------------------------

spec/lucky_case_spec.rb

@@ -1113,6 +1113,63 @@
     end
   end
 
+  context 'decapitalize conversions: ' do
+    it 'default into lower first letter' do
+      conversion_examples = {
+          'ExampleOne' => 'exampleOne',
+          'exampleTwo' => 'exampleTwo',
+          'example-three' => 'example-three',
+          'Example-Four' => 'example-Four',
+          'EXAMPLE-FIVE' => 'eXAMPLE-FIVE',
+          'EXAMPLE_SIX' => 'eXAMPLE_SIX',
+          'example_Seven-extra' => 'example_Seven-extra',
+          'example_eight' => 'example_eight',
+          '_Example_underscoreOne' => '_Example_underscoreOne',
+          '___Example_underscoreTwo' => '___Example_underscoreTwo',
+      }
+      conversion_examples.each do |source, expected_result|
+        final_result = LuckyCase.decapitalize source
+        expect(final_result).to eql(expected_result)
+      end
+    end
+    it 'into lower first letter with skipping underscores' do
+      conversion_examples = {
+          'ExampleOne' => 'exampleOne',
+          'exampleTwo' => 'exampleTwo',
+          'example-three' => 'example-three',
+          'Example-Four' => 'example-Four',
+          'EXAMPLE-FIVE' => 'eXAMPLE-FIVE',
+          'EXAMPLE_SIX' => 'eXAMPLE_SIX',
+          'example_Seven-extra' => 'example_Seven-extra',
+          'example_eight' => 'example_eight',
+          '_Example_underscoreOne' => '_example_underscoreOne',
+          '___Example_underscoreTwo' => '___example_underscoreTwo',
+      }
+      conversion_examples.each do |source, expected_result|
+        final_result = LuckyCase.decapitalize source, skip_prefixed_underscores: true
+        expect(final_result).to eql(expected_result)
+      end
+    end
+    it 'into lower first letter without explicitly skipping underscores' do
+      conversion_examples = {
+          '_ExampleOne' => '_ExampleOne',
+          '_exampleTwo' => '_exampleTwo',
+          '____example-three' => '____example-three',
+          '_Example-Four' => '_Example-Four',
+          '__EXAMPLE-FIVE' => '__EXAMPLE-FIVE',
+          '___eXAMPLE_SIX' => '___eXAMPLE_SIX',
+          'Example_Seven-extra' => 'example_Seven-extra',
+          '__Example_eight' => '__Example_eight',
+          '_Example_underscoreOne' => '_Example_underscoreOne',
+          '___Example_underscoreTwo' => '___Example_underscoreTwo',
+      }
+      conversion_examples.each do |source, expected_result|
+        final_result = LuckyCase.decapitalize source, skip_prefixed_underscores: false
+        expect(final_result).to eql(expected_result)
+      end
+    end
+  end
+
   context 'mixed case conversions: ' do
     it 'default into mixed case' do
       conversion_examples = [

spec/lucky_case_string_spec.rb

@@ -44,6 +44,8 @@
       expect(s).to eql('Some')
       s = "some"; s.capitalize!
       expect(s).to eql('Some')
+      s = "SoMe"; s.decapitalize!
+      expect(s).to eql('soMe')
       s = "swap_it"; s.swap_case!
       expect(s).to eql('SWAP-IT')
       s = "SwapMore-Than_Him"; s.swap_case!