Class: FilterRename::FilterBase

Inherits:

SimpleDelegator

• Object
• SimpleDelegator
• FilterRename::FilterBase

Defined in:

lib/filter_rename/filter_base.rb

Overview

The base class for all type of filters.

Direct Known Subclasses

FilterNumber, FilterOccurrence, FilterRegExp, FilterWord, FilterRename::Filters::Append, FilterRename::Filters::AppendAsWordTo, FilterRename::Filters::AppendFrom, FilterRename::Filters::AppendTo, FilterRename::Filters::Capitalize, FilterRename::Filters::Config, FilterRename::Filters::CopyFrom, FilterRename::Filters::LeftJustify, FilterRename::Filters::Lowercase, FilterRename::Filters::Prepend, FilterRename::Filters::PrependFrom, FilterRename::Filters::ReplaceDate, FilterRename::Filters::Reverse, FilterRename::Filters::RightJustify, FilterRename::Filters::Select, FilterRename::Filters::Set, FilterRename::Filters::SetWhen, FilterRename::Filters::Spacify, FilterRename::Filters::Squeeze, FilterRename::Filters::Template, FilterRename::Filters::Translate, FilterRename::Filters::Trim, FilterRename::Filters::Uppercase

Instance Method Summary

• #current_target ⇒ Object
• #filter(value) ⇒ Object
• #get_config(name) ⇒ Object
• #get_string(target = nil) ⇒ Object
• #get_words(name, section, idx = nil) ⇒ Object
• #initialize(obj, options) ⇒ FilterBase constructor

  A new instance of FilterBase.

• #match?(mask) ⇒ Boolean
• #set_config(name, value) ⇒ Object
• #set_string(value, target = nil) ⇒ Object
• #wrap_regex(str) ⇒ Object

Constructor Details

#initialize(obj, options) ⇒ FilterBase

Returns a new instance of FilterBase.

# File 'lib/filter_rename/filter_base.rb', line 45

def initialize(obj, options)
  super(obj)
  @dest = obj # useful for macros
  @cfg = options[:cfg]
  @words = options[:words]
end

Instance Method Details

#current_target ⇒ Object

# File 'lib/filter_rename/filter_base.rb', line 99

def current_target
  @cfg.target.to_s
end

#filter(value) ⇒ Object

# File 'lib/filter_rename/filter_base.rb', line 68

def filter(value)
  set_string value
end

#get_config(name) ⇒ Object

Raises:

• (InvalidFilterSetting)

# File 'lib/filter_rename/filter_base.rb', line 62

def get_config(name)
  raise InvalidFilterSetting, name unless @cfg.instance_variables.include?(:"@#{name}")

  @cfg.instance_variable_get "@#{name}"
end

#get_string(target = nil) ⇒ Object

# File 'lib/filter_rename/filter_base.rb', line 82

def get_string(target = nil)
  if target.nil?
    super(@cfg.target)
  else
    super
  end
end

#get_words(name, section, idx = nil) ⇒ Object

# File 'lib/filter_rename/filter_base.rb', line 52

def get_words(name, section, idx = nil)
  @words.get_words name, section, idx
end

#match?(mask) ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/filter_rename/filter_base.rb', line 90

def match?(mask)
  get_string =~ Regexp.new(mask)
end

#set_config(name, value) ⇒ Object

Raises:

• (InvalidFilterSetting)

# File 'lib/filter_rename/filter_base.rb', line 56

def set_config(name, value)
  raise InvalidFilterSetting, name unless @cfg.instance_variables.include?(:"@#{name}")

  @cfg.instance_variable_set "@#{name}", value
end

#set_string(value, target = nil) ⇒ Object

# File 'lib/filter_rename/filter_base.rb', line 72

def set_string(value, target = nil)
  return if value.nil?

  if target.nil?
    super(@cfg.target, value)
  else
    super(target, value)
  end
end

#wrap_regex(str) ⇒ Object

# File 'lib/filter_rename/filter_base.rb', line 94

def wrap_regex(str)
  str = "(#{str})" unless str =~ /\(.*\)/
  str
end