lucky_case 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f4d90caf6443b20241256aa6721241b6c1cffe91ee094f1803bd4b4a8fa9bc4
-  data.tar.gz: 1d6ee16099adf04b3d3b5103f8b808a955797df41a61715c30bcb0951900eeb9
+  metadata.gz: afbd0b3dbbd7c21f311666d8c0ccabecab4ba9947df2da05e2013638516c89e2
+  data.tar.gz: 47050573fc4b1d3fcde64ab975bda715fbfa98256631ca663ee9ea3f5c13b58d
 SHA512:
-  metadata.gz: 4d4525d94e1eb4060030da2f1d071e05801a0ec81c9f6484af3cb89dd349207b735344782ce888153abc308560d1c11235d0041c22204660a2db4b695c9df354
-  data.tar.gz: 04e76e361b15ebff0e1fd36451ee36ad927dbb791ae58824d06046f31885223c2957c6d3dac2f96620d9f8544d007444358efc6f1424592c14c4b9fb6919d1eb
+  metadata.gz: 7245455162da41c94380f0738ee3bc6485053191af5fff2fbc2c62c1322ebcb8f1cac30803da544d938da8a8be1730e617ccc3101a61c68e08279acef43727c1
+  data.tar.gz: 1048bf41fd2c4d4bb3c1282d30b0fe5d795dabb7cc3415a5bbfc1dc4cc70b9c8eb928b9d437cefb624c66df2cf940b860db9b45dfd291230ba8776b82a17c6a0

data/README.md

@@ -30,13 +30,17 @@ You can either use the static LuckyCase class with its method or optionally monk
 require 'lucky_case'
 
 # converters
-LuckyCase.snake_case('ExamplePascalString')            # => 'example_pascal_string'
-LuckyCase.upper_snake_case('Example-Train-String')     # => 'EXAMPLE_TRAIN_STRING'
-LuckyCase.pascal_case('example_snake_string')          # => 'ExampleSnakeString'
-LuckyCase.camel_case('example-dash-string')            # => 'exampleDashString'
-LuckyCase.dash_case('ExamplePascalString')             # => 'example-pascal-string'
-LuckyCase.upper_dash_case('ExamplePascalString')       # => 'EXAMPLE-PASCAL-STRING'
-LuckyCase.train_case('example_snake_string')           # => 'Example-Snake-String'
+LuckyCase.snake_case('PascalToSnake')                  # => 'pascal_to_snake'
+LuckyCase.upper_snake_case('Train-To-Upper-Snake')     # => 'TRAIN_TO_UPPER_SNAKE'
+LuckyCase.pascal_case('snake_to_pascal')               # => 'SnakeToPascal'
+LuckyCase.camel_case('dash-to-camel-case')             # => 'dashToCamelCase'
+LuckyCase.dash_case('PascalToDashCase')                # => 'pascal-to-dash-case'
+LuckyCase.upper_dash_case('PascalToUpperDash')         # => 'PASCAL-TO-UPPER-DASH'
+LuckyCase.train_case('snake_to_train_case')            # => 'Snake-To-Train-Case'
+LuckyCase.word_case('PascalToWordCase')                # => 'pascal to word case'
+LuckyCase.upper_word_case('PascalToUpperWord')         # => 'PASCAL TO UPPER WORD'
+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'
@@ -56,12 +60,16 @@ LuckyCase.case('this_can_only_be_snake_case')          # => :snake_case
 LuckyCase.cases('multiple')                            # => [ :snake_case, :camel_case, :dash_case ]
 # checkers
 LuckyCase.snake_case?('valid_snake_case')              # => true
-LuckyCase.upper_snake_case?('inValidSnakeCase')        # => false
+LuckyCase.upper_snake_case?('UPPER_SNAKE')             # => true
 LuckyCase.pascal_case?('PascalCase')                   # => true
 LuckyCase.camel_case?('camelCase')                     # => true
 LuckyCase.dash_case?('dash-case')                      # => true
 LuckyCase.upper_dash_case?('DASH-CASE')                # => true
 LuckyCase.train_case?('Train-Case')                    # => true
+LuckyCase.word_case?('word case')                      # => true
+LuckyCase.upper_word_case?('UPPER WORD CASE')          # => true
+LuckyCase.capital_word_case?('Capital Word Case')      # => true
+LuckyCase.sentence_case?('Sentence case string')       # => true
 LuckyCase.mixed_case?('mixed_Case')                    # => true
 LuckyCase.upper_case?('UPPER50984')                    # => true
 LuckyCase.lower_case?('lower_cheese')                  # => true

data/lib/lucky_case.rb

@@ -18,6 +18,10 @@ module LuckyCase
       dash_case: /^([[:lower:]]){1}[[:lower:]\-0-9]*[[:lower:]0-9]+$/,
       upper_dash_case: /^([[:upper:]]){1}[[:upper:]\-0-9]*[[:upper:]0-9]+$/,
       train_case: /^([[:upper:]][[:lower:]0-9]*\-|[0-9]+\-)*([[:upper:]][[:lower:]0-9]*)$/,
+      word_case: /^[[:lower:]]{1}[[:lower:] 0-9]+$/,
+      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]*$/,
   }
 
@@ -391,6 +395,146 @@ module LuckyCase
     _case_match? s, :train_case
   end
 
+  #----------------------------------------------------------------------------------------------------
+  # WORD CASE
+  #----------------------------------------------------------------------------------------------------
+
+  # Converts the given string from any case
+  # into word case
+  #
+  # @example conversion
+  #   'this-isAnExample_string' => 'this is an example string'
+  #
+  # @param [String] string to convert
+  # @param [Boolean] preserve_prefixed_underscores
+  # @return [String]
+  def self.word_case(string, preserve_prefixed_underscores: true)
+    a = split_case_string string
+    converted = a.join(' ')
+    if preserve_prefixed_underscores
+      underscores_at_start(string) + converted
+    else
+      converted
+    end
+  end
+
+  # Checks if the string is word case
+  #
+  # @param [String] string to check
+  # @param [Boolean] allow_prefixed_underscores
+  # @return [Boolean]
+  def self.word_case?(string, allow_prefixed_underscores: true)
+    s = if allow_prefixed_underscores
+          cut_underscores_at_start string
+        else
+          string
+        end
+    _case_match? s, :word_case
+  end
+
+  # Converts the given string from any case
+  # into upper word case
+  #
+  # @example conversion
+  #   'this-isAnExample_string' => 'THIS IS AN EXAMPLE STRING'
+  #
+  # @param [String] string to convert
+  # @param [Boolean] preserve_prefixed_underscores
+  # @return [String]
+  def self.upper_word_case(string, preserve_prefixed_underscores: true)
+    a = split_case_string string
+    converted = a.map { |e| upper_case e }.join(' ')
+    if preserve_prefixed_underscores
+      underscores_at_start(string) + converted
+    else
+      converted
+    end
+  end
+
+  # Checks if the string is upper word case
+  #
+  # @param [String] string to check
+  # @param [Boolean] allow_prefixed_underscores
+  # @return [Boolean]
+  def self.upper_word_case?(string, allow_prefixed_underscores: true)
+    s = if allow_prefixed_underscores
+          cut_underscores_at_start string
+        else
+          string
+        end
+    _case_match? s, :upper_word_case
+  end
+
+  # Converts the given string from any case
+  # into capital word case
+  #
+  # @example conversion
+  #   'this-isAnExample_string' => 'This Is An Example String'
+  #
+  # @param [String] string to convert
+  # @param [Boolean] preserve_prefixed_underscores
+  # @return [String]
+  def self.capital_word_case(string, preserve_prefixed_underscores: true)
+    a = split_case_string string
+    converted = a.map { |e| capital e }.join(' ')
+    if preserve_prefixed_underscores
+      underscores_at_start(string) + converted
+    else
+      converted
+    end
+  end
+
+  # Checks if the string is capital word case
+  #
+  # @param [String] string to check
+  # @param [Boolean] allow_prefixed_underscores
+  # @return [Boolean]
+  def self.capital_word_case?(string, allow_prefixed_underscores: true)
+    s = if allow_prefixed_underscores
+          cut_underscores_at_start string
+        else
+          string
+        end
+    _case_match? s, :capital_word_case
+  end
+
+  #----------------------------------------------------------------------------------------------------
+  # SENTENCE CASE
+  #----------------------------------------------------------------------------------------------------
+
+  # Converts the given string from any case
+  # into sentence case
+  #
+  # @example conversion
+  #   'this-isAnExample_string' => 'This is an example string'
+  #
+  # @param [String] string to convert
+  # @param [Boolean] preserve_prefixed_underscores
+  # @return [String]
+  def self.sentence_case(string, preserve_prefixed_underscores: true)
+    a = split_case_string string
+    converted = capital(a.join(' '))
+    if preserve_prefixed_underscores
+      underscores_at_start(string) + converted
+    else
+      converted
+    end
+  end
+
+  # Checks if the string is sentence case
+  #
+  # @param [String] string to check
+  # @param [Boolean] allow_prefixed_underscores
+  # @return [Boolean]
+  def self.sentence_case?(string, allow_prefixed_underscores: true)
+    s = if allow_prefixed_underscores
+          cut_underscores_at_start string
+        else
+          string
+        end
+    _case_match? s, :sentence_case
+  end
+
   #----------------------------------------------------------------------------------------------------
   # CAPITALIZE
   #----------------------------------------------------------------------------------------------------
@@ -539,7 +683,7 @@ module LuckyCase
   # @param [Boolean] preserve_prefixed_underscores
   # @return [Constant]
   def self.constantize(string)
-    s = string.gsub('/','::')
+    s = string.gsub('/', '::')
     constants = if s.include? '::'
                   s.split('::')
                 else
@@ -627,6 +771,7 @@ module LuckyCase
   def self.split_case_string(string)
     s = cut_underscores_at_start string
     s = s.gsub(/([[:upper:]])/, '_\1') unless upper_case? s # prepend all upper characters with underscore
+    s = s.gsub(' ', '_') # replace all spaces with underscore
     s = s.gsub('-', '_') # replace all dashes with underscore
     s = cut_underscores_at_start s
     s.downcase.split('_').reject(&:empty?) # split everything by underscore

data/lib/lucky_case/string.rb

@@ -286,6 +286,110 @@ class String
     LuckyCase.train_case? self, allow_prefixed_underscores: allow_prefixed_underscores
   end
 
+  #----------------------------------------------------------------------------------------------------
+  # WORD CASE
+  #----------------------------------------------------------------------------------------------------
+
+  # Converts the given string from any case
+  # into word case
+  #
+  # @example conversion
+  #   'this-isAnExample_string' => 'this is an example string'
+  #
+  # @param [Boolean] preserve_prefixed_underscores
+  # @return [String]
+  def word_case(preserve_prefixed_underscores: true)
+    LuckyCase.word_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
+  end
+
+  def word_case!(preserve_prefixed_underscores: true)
+    set_self_value self.word_case preserve_prefixed_underscores: preserve_prefixed_underscores
+  end
+
+  # Checks if the string is word case
+  #
+  # @param [Boolean] allow_prefixed_underscores
+  # @return [Boolean]
+  def word_case?(allow_prefixed_underscores: true)
+    LuckyCase.word_case? self, allow_prefixed_underscores: allow_prefixed_underscores
+  end
+
+  # Converts the given string from any case
+  # into upper word case
+  #
+  # @example conversion
+  #   'this-isAnExample_string' => 'THIS IS AN EXAMPLE STRING'
+  #
+  # @param [Boolean] preserve_prefixed_underscores
+  # @return [String]
+  def upper_word_case(preserve_prefixed_underscores: true)
+    LuckyCase.upper_word_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
+  end
+
+  def upper_word_case!(preserve_prefixed_underscores: true)
+    set_self_value self.upper_word_case preserve_prefixed_underscores: preserve_prefixed_underscores
+  end
+
+  # Checks if the string is upper word case
+  #
+  # @param [Boolean] allow_prefixed_underscores
+  # @return [Boolean]
+  def upper_word_case?(allow_prefixed_underscores: true)
+    LuckyCase.upper_word_case? self, allow_prefixed_underscores: allow_prefixed_underscores
+  end
+
+  # Converts the given string from any case
+  # into capital word case
+  #
+  # @example conversion
+  #   'this-isAnExample_string' => 'This Is An Example String'
+  #
+  # @param [Boolean] preserve_prefixed_underscores
+  # @return [String]
+  def capital_word_case(preserve_prefixed_underscores: true)
+    LuckyCase.capital_word_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
+  end
+
+  def capital_word_case!(preserve_prefixed_underscores: true)
+    set_self_value self.capital_word_case preserve_prefixed_underscores: preserve_prefixed_underscores
+  end
+
+  # Checks if the string is capital word case
+  #
+  # @param [Boolean] allow_prefixed_underscores
+  # @return [Boolean]
+  def capital_word_case?(allow_prefixed_underscores: true)
+    LuckyCase.capital_word_case? self, allow_prefixed_underscores: allow_prefixed_underscores
+  end
+
+  #----------------------------------------------------------------------------------------------------
+  # SENTENCE CASE
+  #----------------------------------------------------------------------------------------------------
+
+  # Converts the given string from any case
+  # into sentence case
+  #
+  # @example conversion
+  #   'this-isAnExample_string' => 'This is an example string'
+  #
+  # @param [Boolean] preserve_prefixed_underscores
+  # @return [String]
+  def sentence_case(preserve_prefixed_underscores: true)
+    LuckyCase.sentence_case self, preserve_prefixed_underscores: preserve_prefixed_underscores
+  end
+
+  def sentence_case!(preserve_prefixed_underscores: true)
+    set_self_value self.sentence_case preserve_prefixed_underscores: preserve_prefixed_underscores
+  end
+
+  # Checks if the string is sentence case
+  #
+  # @param [Boolean] allow_prefixed_underscores
+  # @return [Boolean]
+  def sentence_case?(allow_prefixed_underscores: true)
+    LuckyCase.sentence_case? self, allow_prefixed_underscores: allow_prefixed_underscores
+  end
+
   #----------------------------------------------------------------------------------------------------
   # CAPITALIZE
   #----------------------------------------------------------------------------------------------------

data/lib/lucky_case/version.rb

@@ -1,3 +1,3 @@
 module LuckyCase
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lucky_case
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthäus J. N. Beyrle