lucky_case 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f78932c6caab460f362db13b18485d98b98b016dda12cc9750b9a649297c4587
-  data.tar.gz: 0240f607386929862771d4a44df92cd6f7dc186cdf11f2bd1a281463286b9c43
+  metadata.gz: 8a436c523f2a63b7411b894d146a89725c153dfd3970f3f22d49be49dbd35882
+  data.tar.gz: 3b3faaac0ec66f6f47e82b3a802cdd2ce71b666a70ae01f6fea5c4e344303b37
 SHA512:
-  metadata.gz: 8455aad2bc3344d211556e326e073a68ee5ef02e2b9edab1f02454fab8841513323383f6d2e7679de21a641fce17f4438506fbc32ee72fdb2d249133d9f1a3b3
-  data.tar.gz: bc6cda1182cc9c1d83977d8a75fe726c543efc8713c3dab7761e58617d8ab92e7e4f00e31dc648d6df2518da6be7e8ec4b4cc5426a4554b15daf3a55046ff49b
+  metadata.gz: 146fee7851d89d9e1dacba0dac0012cf223285fb94e2d723270fe0111af0c4b366714bb8ffdc2836387b48a1046421cf45bdaca5c3822409f800b602554a1afd
+  data.tar.gz: a5c74f03bb733a25a3a246bdebdc27c04c1ee187bc973356e9893f678c50d4ef72c5fb149633319e0bc5649f133502b22aa224b6c64947363edcd9c0da8ae4b6

data/README.md

@@ -55,7 +55,7 @@ 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'
-# identifier
+# identifiers
 LuckyCase.case('this_can_only_be_snake_case')          # => :snake_case
 LuckyCase.cases('validformultiple')                    # => [ :snake_case, :camel_case, :dash_case, :word_case ]
 # checkers
@@ -75,13 +75,19 @@ LuckyCase.upper_case?('UPPER50984')                    # => true
 LuckyCase.lower_case?('lower_cheese')                  # => true
 LuckyCase.capital?('Some')                             # => true
 LuckyCase.capitalized?('some')                         # => false
+LuckyCase.valid_case_type?(:snake_case)                # => true
+LuckyCase.valid_case_type?(:apple_case)                # => false
+LuckyCase.valid_case_string?('validString')            # => true
+LuckyCase.valid_case_string?('1nV4lid$tring')          # => false
 ```
 
 ### Monkey patch the string class
 
-With monkey patching you can access the same methods (except deconstantize) 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.
+
 ```ruby
 require 'lucky_case/string'
 
@@ -93,6 +99,12 @@ 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'
+b.letter_case                           # => :snake_case
+b.letter_cases                          # => [ :snake_case, :camel_case, :dash_case, :word_case ]
 ```
 
 

data/lib/lucky_case.rb

@@ -22,7 +22,7 @@ module LuckyCase
       upper_word_case: /^[[:upper:]]{1}[[:upper:] 0-9]+$/,
       capital_word_case: /^([[:upper:]][[:lower:]0-9]*\ |[0-9]+\ )*([[:upper:]][[:lower:]0-9]*)$/,
       sentence_case: /^[[:upper:]]{1}[[:lower:] 0-9]+$/,
-      mixed_case: /^[[:upper:][:lower:]][[:upper:][:lower:]_\-0-9]*$/,
+      mixed_case: /^[[:upper:][:lower:]][[:upper:][:lower:]_\-0-9 ]*$/,
   }
 
   FORMATS = {
@@ -101,11 +101,31 @@ module LuckyCase
     raise InvalidCaseError.new error_message
   end
 
+  # Check if given case type is a valid case type
+  # 
+  # @param [Symbol, String] case_type
+  # @return [Boolean]
+  def self.valid_case_type?(case_type)
+    if CASES.keys.include? case_type.to_sym
+      true
+    else
+      false
+    end
+  end
+
+  # Check if the string matches any of the available cases
+  # 
+  # @param [String] case_type
+  # @return [Boolean]
+  def self.valid_case_string?(string)
+    self.case(string) != nil
+  end
+  
   #----------------------------------------------------------------------------------------------------
   # UPPER CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts all characters inside the string
+  # Convert all characters inside the string
   # into upper case
   #
   # @example conversion
@@ -117,7 +137,7 @@ module LuckyCase
     string.upcase
   end
 
-  # Checks if all characters inside the string are upper case
+  # Check if all characters inside the string are upper case
   #
   # @param [String] string to check
   # @return [Boolean]
@@ -129,7 +149,7 @@ module LuckyCase
   # LOWER CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts all characters inside the string
+  # Convert all characters inside the string
   # into lower case
   #
   # @example conversion
@@ -141,7 +161,7 @@ module LuckyCase
     string.downcase
   end
 
-  # Checks if all characters inside the string are lower case
+  # Check if all characters inside the string are lower case
   #
   # @param [String] string to check
   # @return [Boolean]
@@ -153,7 +173,7 @@ module LuckyCase
   # SNAKE CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into snake case
   #
   # @example conversion
@@ -172,7 +192,7 @@ module LuckyCase
     end
   end
 
-  # Checks if the string is snake case
+  # Check if the string is snake case
   #
   # @param [String] string to check
   # @param [Boolean] allow_prefixed_underscores
@@ -186,7 +206,7 @@ module LuckyCase
     _case_match? s, :snake_case
   end
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into upper snake case
   #
   # @example conversion
@@ -205,7 +225,7 @@ module LuckyCase
     end
   end
 
-  # Checks if the string is upper snake case
+  # Check if the string is upper snake case
   #
   # @param [String] string to check
   # @param [Boolean] allow_prefixed_underscores
@@ -223,7 +243,7 @@ module LuckyCase
   # PASCAL CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into pascal case
   #
   # @example conversion
@@ -242,7 +262,7 @@ module LuckyCase
     end
   end
 
-  # Checks if the string is upper pascal case
+  # Check if the string is upper pascal case
   #
   # @param [String] string to check
   # @param [Boolean] allow_prefixed_underscores
@@ -260,7 +280,7 @@ module LuckyCase
   # CAMEL CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into camel case
   #
   # @example conversion
@@ -279,7 +299,7 @@ module LuckyCase
     end
   end
 
-  # Checks if the string is camel case
+  # Check if the string is camel case
   #
   # @param [String] string to check
   # @param [Boolean] allow_prefixed_underscores
@@ -297,7 +317,7 @@ module LuckyCase
   # DASH CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into dash case
   #
   # @example conversion
@@ -316,7 +336,7 @@ module LuckyCase
     end
   end
 
-  # Checks if the string is dash case
+  # Check if the string is dash case
   #
   # @param [String] string to check
   # @param [Boolean] allow_prefixed_underscores
@@ -330,7 +350,7 @@ module LuckyCase
     _case_match? s, :dash_case
   end
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into upper dash case
   #
   # @example conversion
@@ -344,7 +364,7 @@ module LuckyCase
     upper_case s
   end
 
-  # Checks if the string is upper dash case
+  # Check if the string is upper dash case
   #
   # @param [String] string to check
   # @param [Boolean] allow_prefixed_underscores
@@ -362,7 +382,7 @@ module LuckyCase
   # TRAIN CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into train case
   #
   # @example conversion
@@ -381,7 +401,7 @@ module LuckyCase
     end
   end
 
-  # Checks if the string is train case
+  # Check if the string is train case
   #
   # @param [String] string to check
   # @param [Boolean] allow_prefixed_underscores
@@ -399,7 +419,7 @@ module LuckyCase
   # WORD CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into word case
   #
   # @example conversion
@@ -418,7 +438,7 @@ module LuckyCase
     end
   end
 
-  # Checks if the string is word case
+  # Check if the string is word case
   #
   # @param [String] string to check
   # @param [Boolean] allow_prefixed_underscores
@@ -432,7 +452,7 @@ module LuckyCase
     _case_match? s, :word_case
   end
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into upper word case
   #
   # @example conversion
@@ -451,7 +471,7 @@ module LuckyCase
     end
   end
 
-  # Checks if the string is upper word case
+  # Check if the string is upper word case
   #
   # @param [String] string to check
   # @param [Boolean] allow_prefixed_underscores
@@ -465,7 +485,7 @@ module LuckyCase
     _case_match? s, :upper_word_case
   end
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into capital word case
   #
   # @example conversion
@@ -484,7 +504,7 @@ module LuckyCase
     end
   end
 
-  # Checks if the string is capital word case
+  # Check if the string is capital word case
   #
   # @param [String] string to check
   # @param [Boolean] allow_prefixed_underscores
@@ -502,7 +522,7 @@ module LuckyCase
   # SENTENCE CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into sentence case
   #
   # @example conversion
@@ -521,7 +541,7 @@ module LuckyCase
     end
   end
 
-  # Checks if the string is sentence case
+  # Check if the string is sentence case
   #
   # @param [String] string to check
   # @param [Boolean] allow_prefixed_underscores
@@ -539,7 +559,7 @@ module LuckyCase
   # CAPITALIZE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the first character to capital
+  # Convert the first character to capital
   #
   # @param [String] string to convert
   # @param [Boolean] skip_prefixed_underscores
@@ -559,7 +579,7 @@ module LuckyCase
     end
   end
 
-  # Converts the first character to capital
+  # Convert the first character to capital
   #
   # @param [String] string to convert
   # @param [Boolean] skip_prefixed_underscores
@@ -568,7 +588,7 @@ module LuckyCase
     capital string, skip_prefixed_underscores: skip_prefixed_underscores
   end
 
-  # Checks if the strings first character is a capital letter
+  # Check if the strings first character is a capital letter
   #
   # @param [String] string to check
   # @param [Boolean] skip_prefixed_underscores
@@ -582,7 +602,7 @@ module LuckyCase
     _case_match? s, :capital
   end
 
-  # Checks if the strings first character is a capital letter
+  # Check if the strings first character is a capital letter
   #
   # @param [String] string to check
   # @param [Boolean] skip_prefixed_underscores
@@ -595,7 +615,7 @@ module LuckyCase
   # MIXED CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into mixed case
   #
   # @example conversion
@@ -617,7 +637,7 @@ module LuckyCase
     end
   end
 
-  # Checks if the string is a valid mixed case (without special characters!)
+  # Check if the string is a valid mixed case (without special characters!)
   #
   # @param [String] string to check
   # @return [Boolean]
@@ -672,7 +692,7 @@ module LuckyCase
   # CONSTANTIZE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the string from any case
+  # Convert the string from any case
   # into pascal case and casts it into a constant
   #
   # @example conversion
@@ -730,7 +750,7 @@ module LuckyCase
   #----------------------------------------------------------------------------------------------------
   # HELPERS
   #----------------------------------------------------------------------------------------------------
-
+  
   # Return string without underscores at the start
   #
   # @param [String] string

data/lib/lucky_case/string.rb

@@ -46,11 +46,18 @@ class String
     set_self_value self.convert_case(case_type, preserve_prefixed_underscores: preserve_prefixed_underscores)
   end
 
+  # Check if the string matches any of the available cases
+  #
+  # @return [Boolean]
+  def valid_case_string?()
+    LuckyCase.case(self) != nil
+  end
+
   #----------------------------------------------------------------------------------------------------
   # UPPER CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts all characters inside the string
+  # Convert all characters inside the string
   # into upper case
   #
   # @example conversion
@@ -65,7 +72,7 @@ class String
     set_self_value self.upper_case
   end
 
-  # Checks if all characters inside the string are upper case
+  # Check if all characters inside the string are upper case
   #
   # @return [Boolean]
   def upper_case?()
@@ -76,7 +83,7 @@ class String
   # LOWER CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts all characters inside the string
+  # Convert all characters inside the string
   # into lower case
   #
   # @example conversion
@@ -91,7 +98,7 @@ class String
     set_self_value self.lower_case
   end
 
-  # Checks if all characters inside the string are lower case
+  # Check if all characters inside the string are lower case
   #
   # @return [Boolean]
   def lower_case?()
@@ -102,7 +109,7 @@ class String
   # SNAKE CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into snake case
   #
   # @example conversion
@@ -118,7 +125,7 @@ class String
     set_self_value self.snake_case preserve_prefixed_underscores: preserve_prefixed_underscores
   end
 
-  # Checks if the string is snake case
+  # Check if the string is snake case
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Boolean]
@@ -126,7 +133,7 @@ class String
     LuckyCase.snake_case? self, allow_prefixed_underscores: allow_prefixed_underscores
   end
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into upper snake case
   #
   # @example conversion
@@ -142,7 +149,7 @@ class String
     set_self_value self.upper_snake_case preserve_prefixed_underscores: preserve_prefixed_underscores
   end
 
-  # Checks if the string is upper snake case
+  # Check if the string is upper snake case
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Boolean]
@@ -154,7 +161,7 @@ class String
   # PASCAL CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into pascal case
   #
   # @example conversion
@@ -170,7 +177,7 @@ class String
     set_self_value self.pascal_case preserve_prefixed_underscores: preserve_prefixed_underscores
   end
 
-  # Checks if the string is upper pascal case
+  # Check if the string is upper pascal case
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Boolean]
@@ -182,7 +189,7 @@ class String
   # CAMEL CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into camel case
   #
   # @example conversion
@@ -198,7 +205,7 @@ class String
     set_self_value self.camel_case preserve_prefixed_underscores: preserve_prefixed_underscores
   end
 
-  # Checks if the string is camel case
+  # Check if the string is camel case
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Boolean]
@@ -210,7 +217,7 @@ class String
   # DASH CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into dash case
   #
   # @example conversion
@@ -226,7 +233,7 @@ class String
     set_self_value self.dash_case preserve_prefixed_underscores: preserve_prefixed_underscores
   end
 
-  # Checks if the string is dash case
+  # Check if the string is dash case
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Boolean]
@@ -234,7 +241,7 @@ class String
     LuckyCase.dash_case? self, allow_prefixed_underscores: allow_prefixed_underscores
   end
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into upper dash case
   #
   # @example conversion
@@ -250,7 +257,7 @@ class String
     set_self_value self.upper_dash_case preserve_prefixed_underscores: preserve_prefixed_underscores
   end
 
-  # Checks if the string is upper dash case
+  # Check if the string is upper dash case
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Boolean]
@@ -262,7 +269,7 @@ class String
   # TRAIN CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into train case
   #
   # @example conversion
@@ -278,7 +285,7 @@ class String
     set_self_value self.train_case preserve_prefixed_underscores: preserve_prefixed_underscores
   end
 
-  # Checks if the string is train case
+  # Check if the string is train case
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Boolean]
@@ -290,7 +297,7 @@ class String
   # WORD CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into word case
   #
   # @example conversion
@@ -306,7 +313,7 @@ class String
     set_self_value self.word_case preserve_prefixed_underscores: preserve_prefixed_underscores
   end
 
-  # Checks if the string is word case
+  # Check if the string is word case
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Boolean]
@@ -314,7 +321,7 @@ class String
     LuckyCase.word_case? self, allow_prefixed_underscores: allow_prefixed_underscores
   end
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into upper word case
   #
   # @example conversion
@@ -330,7 +337,7 @@ class String
     set_self_value self.upper_word_case preserve_prefixed_underscores: preserve_prefixed_underscores
   end
 
-  # Checks if the string is upper word case
+  # Check if the string is upper word case
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Boolean]
@@ -338,7 +345,7 @@ class String
     LuckyCase.upper_word_case? self, allow_prefixed_underscores: allow_prefixed_underscores
   end
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into capital word case
   #
   # @example conversion
@@ -354,7 +361,7 @@ class String
     set_self_value self.capital_word_case preserve_prefixed_underscores: preserve_prefixed_underscores
   end
 
-  # Checks if the string is capital word case
+  # Check if the string is capital word case
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Boolean]
@@ -366,7 +373,7 @@ class String
   # SENTENCE CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into sentence case
   #
   # @example conversion
@@ -382,7 +389,7 @@ class String
     set_self_value self.sentence_case preserve_prefixed_underscores: preserve_prefixed_underscores
   end
 
-  # Checks if the string is sentence case
+  # Check if the string is sentence case
   #
   # @param [Boolean] allow_prefixed_underscores
   # @return [Boolean]
@@ -394,7 +401,7 @@ class String
   # CAPITALIZE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the first character to capital
+  # Convert the first character to capital
   #
   # @param [Boolean] skip_prefixed_underscores
   # @return [String]
@@ -402,7 +409,7 @@ class String
     LuckyCase.capitalize self, skip_prefixed_underscores: skip_prefixed_underscores
   end
 
-  # Converts the first character to capital
+  # Convert the first character to capital
   #
   # @param [Boolean] skip_prefixed_underscores
   # @return [String]
@@ -418,7 +425,7 @@ class String
     self.capital! skip_prefixed_underscores: skip_prefixed_underscores
   end
 
-  # Checks if the strings first character is a capital letter
+  # Check if the strings first character is a capital letter
   #
   # @param [Boolean] skip_prefixed_underscores
   # @return [Boolean]
@@ -426,7 +433,7 @@ class String
     LuckyCase.capital? self, skip_prefixed_underscores: skip_prefixed_underscores
   end
 
-  # Checks if the strings first character is a capital letter
+  # Check if the strings first character is a capital letter
   #
   # @param [Boolean] skip_prefixed_underscores
   # @return [Boolean]
@@ -438,7 +445,7 @@ class String
   # MIXED CASE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the given string from any case
+  # Convert the given string from any case
   # into mixed case
   #
   # @example conversion
@@ -454,7 +461,7 @@ class String
     set_self_value self.mixed_case preserve_prefixed_underscores: preserve_prefixed_underscores
   end
 
-  # Checks if the string is a valid mixed case (without special characters!)
+  # Check if the string is a valid mixed case (without special characters!)
   #
   # @return [Boolean]
   def mixed_case?()
@@ -491,7 +498,7 @@ class String
   # CONSTANTIZE
   #----------------------------------------------------------------------------------------------------
 
-  # Converts the string from any case
+  # Convert the string from any case
   # into pascal case and casts it into a constant
   #
   # @example conversion

data/lib/lucky_case/version.rb

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

metadata

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