module Subby

Subby is a module for substituting string case variations.

It has one class method, ::sub, and a supporting sub-module which converts the strings from one case to another.

Constants

CASES

Cases and Examples

Case                Example
-------------------------------
camel               applePie
class | module      ApplePie
constant            APPLE_PIE
dash                apple-pie
lower               apple pie
sentence            Apple pie
snake | underscore  apple_pie
title               Apple Pie
upper               APPLE PIE

CASES_TO_METHOD

Public Class Methods

sub( text="", string_in="", string_out="", opts={} ) click to toggle source

Substitutes string case variations in text. By default this method command is greedy. It will substitute all string_in case variations that it knows. The case variations with examples are listed above in the CASES constant.

@example Default usage

Subby.sub("apple pie applePie apple_pie", "applePie", "chocolateCake")
# => "chocolate cake chocolateCake chocolate_cake"

@example Change one case to another

Subby.sub("apple pie applePie apple_pie", "applePie", "applePie",
  :case_in => :camel,
  :case_out => :snake)
# => "apple pie apple_pie apple_pie"

@example Only target certain cases

Subby.sub("apple pie applePie apple_pie", "applePie", "chocolateCake",
  :case_in => [:camel, :snake])
# => "apple pie chocolateCake chocolate_cake"

@param text [String] The text to be scanned for substitutions. @param string_in [String] The string to be replaced. @param string_out [String] The replacement string. @param opts [Hash] Options

* +:case_in+: Takes a CASE or [CASE]. Operates only on the given cases in
  order specified.
* +:case_out+: Takes a CASE. All incoming cases will be converted to this
  case.

@return [String]

# File lib/subby/base.rb, line 48
def self.sub( text="", string_in="", string_out="", opts={} )

  # Setup
  res = text.to_s
  case_in = self.normalize_options( opts )[:case_in]
  case_out = self.normalize_options( opts )[:case_out]

  # Main Loop
  case_in.each do |case_in|
    res = res.gsub(
      CaseChanger.send( case_in, string_in ),
      CaseChanger.send( (case_out || case_in), string_out) )
  end

  res
end

Private Class Methods

normalize_options( opts ) click to toggle source

# File lib/subby/base.rb, line 81
def self.normalize_options( opts )
  case_in = ( (opts[:case_in] && [opts[:case_in]].flatten.map(&:to_s)) || CASES).
    map { |c| CASES_TO_METHOD[c] }.uniq
  case_out = CASES_TO_METHOD[opts[:case_out].to_s]

  { case_in: case_in, case_out: case_out }
end