lucky_case 0.2.2 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a436c523f2a63b7411b894d146a89725c153dfd3970f3f22d49be49dbd35882
-  data.tar.gz: 3b3faaac0ec66f6f47e82b3a802cdd2ce71b666a70ae01f6fea5c4e344303b37
+  metadata.gz: a02e8e5b6c87d69698ea74ce773d0db80054d0f95df611cf6787c8b64ca2ef9a
+  data.tar.gz: 65618b4882eafd8ef600cd798e9bad39a50b0bf3094ff140c6c6e17542fbe038
 SHA512:
-  metadata.gz: 146fee7851d89d9e1dacba0dac0012cf223285fb94e2d723270fe0111af0c4b366714bb8ffdc2836387b48a1046421cf45bdaca5c3822409f800b602554a1afd
-  data.tar.gz: a5c74f03bb733a25a3a246bdebdc27c04c1ee187bc973356e9893f678c50d4ef72c5fb149633319e0bc5649f133502b22aa224b6c64947363edcd9c0da8ae4b6
+  metadata.gz: 929b76eb4c553e6e1e404d33f2b60d6e8506f376fe3524ace0178e93d2b93da786e779d9b6b24d57faa4ad631edb43ae95319a9a74691d6779b5027dbba6db3f
+  data.tar.gz: 69120e28465009a311bdce99ffc49b071250f02cf5be846ef0a6256a7464e14f74b4a01609adcd4782e8bdf13980e3d71a4d4c8d64f91eea0138881644475881

data/README.md

@@ -25,7 +25,7 @@ Useful when working with conventions, where class names, method names and file n
 
 You can either use the static LuckyCase class with its method or optionally monkey patch the String class.
 
-### Use the static class only
+### Approach 1: Using the static class
 ```ruby
 require 'lucky_case'
 
@@ -42,8 +42,10 @@ LuckyCase.upper_word_case('PascalToUpperWord')         # => 'PASCAL TO UPPER WOR
 LuckyCase.capital_word_case('snake_to_capital_word')   # => 'Snake To Capital Word'
 LuckyCase.sentence_case('snake_to_sentence_case')      # => 'Snake to sentence case'
 LuckyCase.mixed_case('example_snake_string')           # => 'Example-snake_STRING'
+
 # converter by type
 LuckyCase.convert_case('some_snake', :pascal_case)     # => 'SomeSnake'
+
 # transformers
 LuckyCase.lower_case('Some_FuckingShit')               # => 'some_fuckingshit'
 LuckyCase.upper_case('Some_FuckingShit')               # => 'SOME_FUCKINGSHIT'
@@ -53,11 +55,13 @@ LuckyCase.capitalize('example')                        # => '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(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
 LuckyCase.cases('validformultiple')                    # => [ :snake_case, :camel_case, :dash_case, :word_case ]
+
 # checkers
 LuckyCase.snake_case?('valid_snake_case')              # => true
 LuckyCase.upper_snake_case?('UPPER_SNAKE')             # => true
@@ -81,7 +85,7 @@ LuckyCase.valid_case_string?('validString')            # => true
 LuckyCase.valid_case_string?('1nV4lid$tring')          # => false
 ```
 
-### Monkey patch the string class
+### 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.
 Additionally they provide versions with exclamation mark for direct manipulation.
@@ -96,10 +100,12 @@ a = 'ExampleString'
 a.pascal_case?                          # => true
 a.snake_case                            # => 'example_string'
 a                                       # => 'ExampleString'
+
 # string variable manipulation
 a.snake_case!                           # => 'example_string'
 a                                       # => 'example_string'
 ...
+
 # identifiers
 # got a other method name here because 'case' might be to common and cause conflicts
 b = 'example'

data/lib/lucky_case.rb

@@ -77,9 +77,9 @@ module LuckyCase
     end
     if matched_cases.empty?
       nil
-      # reject mixed case if there are other matches
-      # because it would always be included if one other case matches
     elsif matched_cases.size > 1
+      # reject :mixed_case if there are other matches
+      # because it would always be included if one other case matches
       matched_cases.reject { |e| e == :mixed_case }
     else
       matched_cases
@@ -115,12 +115,12 @@ module LuckyCase
 
   # Check if the string matches any of the available cases
   # 
-  # @param [String] case_type
+  # @param [String] string
   # @return [Boolean]
   def self.valid_case_string?(string)
     self.case(string) != nil
   end
-  
+
   #----------------------------------------------------------------------------------------------------
   # UPPER CASE
   #----------------------------------------------------------------------------------------------------
@@ -616,7 +616,9 @@ module LuckyCase
   #----------------------------------------------------------------------------------------------------
 
   # Convert the given string from any case
-  # into mixed case
+  # into mixed case.
+  #
+  # The new string is ensured to be different from the input.
   #
   # @example conversion
   #   'this-isAnExample_string' => 'This-Is_anExample-string'
@@ -626,9 +628,14 @@ module LuckyCase
   # @return [String]
   def self.mixed_case(string, preserve_prefixed_underscores: true)
     a = split_case_string string
-    converted = ''
-    a.each do |part|
-      converted += self.send random_case, part
+    converted = nil
+    loop do
+      converted = ''
+      a.each do |part|
+        converted += self.convert_case part, CASES.keys.sample, preserve_prefixed_underscores: preserve_prefixed_underscores
+      end
+      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
       underscores_at_start(string) + converted
@@ -641,8 +648,13 @@ module LuckyCase
   #
   # @param [String] string to check
   # @return [Boolean]
-  def self.mixed_case?(string)
-    _case_match? string, :mixed_case
+  def self.mixed_case?(string, allow_prefixed_underscores: true)
+    s = if allow_prefixed_underscores
+          cut_underscores_at_start string
+        else
+          string
+        end
+    _case_match? s, :mixed_case
   end
 
   #----------------------------------------------------------------------------------------------------
@@ -750,7 +762,7 @@ module LuckyCase
   #----------------------------------------------------------------------------------------------------
   # HELPERS
   #----------------------------------------------------------------------------------------------------
-  
+
   # Return string without underscores at the start
   #
   # @param [String] string
@@ -802,10 +814,10 @@ module LuckyCase
   # Check if the given case matches the string
   #
   # @param [String] string
-  # @param [Symbol,String] case_to_match
+  # @param [Symbol,String] case_type
   # @return [Boolean]
-  def self._case_match?(string, case_to_match)
-    !!(string =~ CASES[case_to_match.to_sym])
+  def self._case_match?(string, case_type)
+    !!(string =~ CASES[case_type.to_sym])
   end
 
   #----------------------------------------------------------------------------------------------------

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

data/lib/lucky_case/version.rb

@@ -1,3 +1,3 @@
 module LuckyCase
-  VERSION = '0.2.2'.freeze
+  VERSION = '1.0.2'.freeze
 end

metadata

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