Class: IML::Base

Inherits:

OpenStruct

• Object
• OpenStruct
• IML::Base

Defined in:

lib/iml/base.rb

Overview

Base media file class

Direct Known Subclasses

Movie, TVSeries

Instance Attribute Summary

• #format_string ⇒ String

  Allows retrieving and setting of the format string for the output name.

• #prefix ⇒ String

  Allows for setting and getting the output path sans the output base filename.

• #pretend ⇒ Boolean

  Allows for setting and getting dry run setting.

Instance Method Summary

• #basename ⇒ Pathname

  Output base filename.

• #create_dir ⇒ Array<String>

  Creates the output directory if needed.

• #dirname ⇒ Pathname

  Output path sans the output base filename.

• #initialize(hash = nil, options = {}) ⇒ Base constructor

  A new instance of Base.

• #move(path) ⇒ Integer

  Moves the media file to the output directory.

• #pathname ⇒ Pathname

  Full output path of the media file.

• #present ⇒ String

  Formated output filename.

Constructor Details

#initialize(hash = nil, options = {}) ⇒ Base

# File 'lib/iml/base.rb', line 15

def initialize(hash = nil, options = {})
  @prefix = options[:target]
  @pretend = options[:pretend]
  super(hash)
  process if hash
end

Instance Attribute Details

#format_string ⇒ String

# File 'lib/iml/base.rb', line 6

def format_string
  @format_string
end

#prefix ⇒ String

# File 'lib/iml/base.rb', line 8

def prefix
  @prefix
end

#pretend ⇒ Boolean

# File 'lib/iml/base.rb', line 10

def pretend
  @pretend
end

Instance Method Details

#basename ⇒ Pathname

# File 'lib/iml/base.rb', line 13

delegate :basename, to: :pathname

#create_dir ⇒ Array<String>

Creates the output directory if needed

Examples:

movie = IML::Text.new('Cool.Movie.2018.720p.BluRay.H264.AAC2.0-GROUP.mp4').detect
# => <IML::Movie title="Cool Movie", year="2018", quality="720p", source="BluRay" ..>
movie.create_dir
# => ["."]

# File 'lib/iml/base.rb', line 43

def create_dir
  FileUtils.mkdir_p dirname unless @pretend
end

#dirname ⇒ Pathname

# File 'lib/iml/base.rb', line 12

delegate :dirname, to: :pathname

#move(path) ⇒ Integer

Moves the media file to the output directory

# File 'lib/iml/base.rb', line 49

def move(path)
  FileUtils.mv path, pathname unless @pretend
rescue Errno::ENOENT
  1
end

#pathname ⇒ Pathname

# File 'lib/iml/base.rb', line 32

def pathname
  @prefix ? Pathname(@prefix) + Pathname(present) : Pathname(present)
end

#present ⇒ String

# File 'lib/iml/base.rb', line 23

def present
  format_string = output_format
  self.class::PLACEHOLDERS.each do |placeholder, attribute|
    format_string = format_string.gsub(placeholder, send(attribute).to_s)
  end
  format_string
end