lucky_case 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 127f2c04780cc216f3bfa6c606ecd720179bb70ec45973f2014eb5597643bb18
-  data.tar.gz: d0f7b9a6eb16c83101a6a5dbbdcf6a7d11b645107a163f6e9fd4ea78a96fa8ed
+  metadata.gz: eac6adfd588810a2859249ae38e7c67d0150c5887b8d77dfa696892ae1ea2a24
+  data.tar.gz: 5c4d028124cb29c76cbddf385a4ecadde25d0dc9f4e9e6bc2bf0a72825fd43f1
 SHA512:
-  metadata.gz: 50b70d0e7b6d9ed1c3d74c268e4a8e770738b77d0992ddde1a887d3a556d1ef0bcaff45132ecd12577db457824f909b92ef544e2c28293e313809d113e3f8b3d
-  data.tar.gz: 118b3cb70f084a9121e87ba015de64a6b5e9f8b616fa52b011478b584318d81152ec72b9163ea88b9e704c071c69220f1ccf28a5a46bf987d2c0ba82ba91d6ec
+  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.
@@ -51,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
@@ -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 and #cases are so general and could lead to conflicts, they are called #letter_case and #letter_cases at strings.
+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
   #----------------------------------------------------------------------------------------------------

data/lib/lucky_case/string.rb

@@ -451,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.4'.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.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Matthäus J. N. Beyrle
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-05 00:00:00.000000000 Z
+date: 2021-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler