Class: ReVIEW::Book::Part

Inherits:
Object show all
Includes:
Compilable
Defined in:
lib/review/book/part.rb

Instance Attribute Summary collapse

Attributes included from Compilable

#book, #content, #path

Instance Method Summary collapse

Methods included from Compilable

#basename, #bibpaper, #bibpaper_index, #column, #column_index, #dirname, #env, #footnote, #footnote_index, #headline, #headline_index, #icon_index, #image, #image_index, #indepimage_index, #lines, #list, #list_index, #next_chapter, #numberless_image_index, #open, #prev_chapter, #size, #table, #table_index, #title

Methods included from TextUtils

#detab, #split_paragraph

Constructor Details

#initialize(book, number, chapters, name = '', io = nil) ⇒ Part

if Part is dummy, ‘number` is nil.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/review/book/part.rb', line 18

def initialize(book, number, chapters, name = '', io = nil)
  @book = book
  @number = number
  @chapters = chapters
  @name = name
  @path = name
  @content = nil
  if io
    @content = io.read
  elsif @path && File.exist?(@path)
    @content = File.read(@path, mode: 'r:BOM|utf-8')
    @name = File.basename(@name, '.re')
  end
  @title = name
  @title = nil if file?
  @volume = nil
end

Instance Attribute Details

#chapters ⇒ Object (readonly)

Returns the value of attribute chapters.



37
38
39
 
# File 'lib/review/book/part.rb', line 37

def chapters
  @chapters
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



38
39
40
 
# File 'lib/review/book/part.rb', line 38

def name
  @name
end

#number ⇒ Object (readonly)

Returns the value of attribute number.



36
37
38
 
# File 'lib/review/book/part.rb', line 36

def number
  @number
end

Instance Method Details

#each_chapter(&block) ⇒ Object 



40
41
42
 
# File 'lib/review/book/part.rb', line 40

def each_chapter(&block)
  @chapters.each(&block)
end

#file? ⇒ Boolean

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/review/book/part.rb', line 50

def file?
  name.present? and path.end_with?('.re') ? true : false
end

#format_number(heading = true) ⇒ Object 



54
55
56
57
58
59
60
 
# File 'lib/review/book/part.rb', line 54

def format_number(heading = true)
  if heading
    I18n.t('part', @number)
  else
    @number.to_s
  end
end

#on_appendix? ⇒ Boolean Also known as: on_APPENDIX?

Returns:

  • (Boolean) 


62
63
64
 
# File 'lib/review/book/part.rb', line 62

def on_appendix?
  false
end

#volume ⇒ Object 



44
45
46
47
48
 
# File 'lib/review/book/part.rb', line 44

def volume
  vol = Volume.sum(@chapters.map(&:volume))
  vol.page_per_kbyte = @book.page_metric.page_per_kbyte
  vol
end