Class: EPUBMaker::Producer

Inherits:
Object show all
Defined in:
lib/epubmaker/producer.rb

Overview

EPUBMaker produces EPUB file.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = nil, version = nil) ⇒ Producer

Construct producer object. config takes initial parameter hash. This parameters can be overriden by EPUBMaker#load or EPUBMaker#merge_config. version takes EPUB version (default is 2).



47
48
49
50
51
52
53
54
55
 
# File 'lib/epubmaker/producer.rb', line 47

def initialize(config = nil, version = nil)
  @contents = []
  @config = ReVIEW::Configure.new
  @epub = nil
  @config['epubversion'] = version unless version.nil?
  @res = ReVIEW::I18n

  merge_config(config) if config
end

Instance Attribute Details

#config ⇒ Object

Parameter hash.



26
27
28
 
# File 'lib/epubmaker/producer.rb', line 26

def config
  @config
end

#contents ⇒ Object

Array of content objects.



24
25
26
 
# File 'lib/epubmaker/producer.rb', line 24

def contents
  @contents
end

#res ⇒ Object (readonly)

Message resource object.



28
29
30
 
# File 'lib/epubmaker/producer.rb', line 28

def res
  @res
end

Class Method Details

.load(file) ⇒ Object

Take YAML file and return parameter hash.



31
32
33
34
35
 
# File 'lib/epubmaker/producer.rb', line 31

def self.load(file)
  raise "Can't open #{file}." if file.nil? || !File.exist?(file)
  loader = ReVIEW::YAMLLoader.new
  loader.load_file(file)
end

Instance Method Details

#call_hook(filename, *params) ⇒ Object 



179
180
181
182
183
184
185
186
 
# File 'lib/epubmaker/producer.rb', line 179

def call_hook(filename, *params)
  return if !filename.present? || !File.exist?(filename) || !FileTest.executable?(filename)
  if ENV['REVIEW_SAFE_MODE'].to_i & 1 > 0
    warn 'hook is prohibited in safe mode. ignored.'
  else
    system(filename, *params)
  end
end

#colophon(wobj) ⇒ Object

Write colophon file to IO object wobj.



127
128
129
130
 
# File 'lib/epubmaker/producer.rb', line 127

def colophon(wobj)
  s = @epub.colophon
  wobj.puts s if !s.nil? && !wobj.nil?
end

#container(wobj) ⇒ Object

Write container file to IO object wobj.



106
107
108
109
 
# File 'lib/epubmaker/producer.rb', line 106

def container(wobj)
  s = @epub.container
  wobj.puts s if !s.nil? && !wobj.nil?
end

#cover(wobj) ⇒ Object

Write cover file to IO object wobj. If Producer#config is defined, it will be used for the cover image.



114
115
116
117
118
 
# File 'lib/epubmaker/producer.rb', line 114

def cover(wobj)
  type = @config['epubversion'] >= 3 ? 'cover' : nil
  s = @epub.cover(type)
  wobj.puts s if !s.nil? && !wobj.nil?
end

#coverimage ⇒ Object 



57
58
59
60
61
62
63
64
65
 
# File 'lib/epubmaker/producer.rb', line 57

def coverimage
  return nil unless config['coverimage']
  @contents.each do |item|
    if item.media.start_with?('image') && item.file =~ /#{config['coverimage']}\Z/
      return item.file
    end
  end
  nil
end

#import_imageinfo(path, base = nil, allow_exts = nil) ⇒ Object Also known as: importImageInfo

Add informations of figure files in path to contents array. base defines a string to remove from path name.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/epubmaker/producer.rb', line 140

def import_imageinfo(path, base = nil, allow_exts = nil)
  return nil unless File.exist?(path)
  allow_exts = @config['image_ext'] if allow_exts.nil?
  Dir.foreach(path) do |f|
    next if f.start_with?('.')
    if f =~ /\.(#{allow_exts.join('|')})\Z/i
      path.chop! if path =~ %r{/\Z}
      if base.nil?
        @contents.push(EPUBMaker::Content.new('file' => "#{path}/#{f}"))
      else
        @contents.push(EPUBMaker::Content.new('file' => "#{path.sub(base + '/', '')}/#{f}"))
      end
    end
    import_imageinfo("#{path}/#{f}", base) if FileTest.directory?("#{path}/#{f}")
  end
end

#isbn_hyphen ⇒ Object 



188
189
190
191
192
193
194
 
# File 'lib/epubmaker/producer.rb', line 188

def isbn_hyphen
  str = @config['isbn'].to_s

  return "#{str[0..0]}-#{str[1..5]}-#{str[6..8]}-#{str[9..9]}" if str =~ /\A\d{10}\Z/
  return "#{str[0..2]}-#{str[3..3]}-#{str[4..8]}-#{str[9..11]}-#{str[12..12]}" if str =~ /\A\d{13}\Z/
  nil
end

#load(file) ⇒ Object

Take YAML file and update parameter hash.



38
39
40
41
42
 
# File 'lib/epubmaker/producer.rb', line 38

def load(file)
  raise "Can't open #{file}." if file.nil? || !File.exist?(file)
  loader = ReVIEW::YAMLLoader.new
  merge_config(@config.deep_merge(loader.load_file(file)))
end

#merge_config(config) ⇒ Object

Update parameters by merging from new parameter hash config.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/epubmaker/producer.rb', line 68

def merge_config(config)
  @config.deep_merge!(config)
  complement

  unless @config['epubversion'].nil?
    case @config['epubversion'].to_i
    when 2
      @epub = EPUBMaker::EPUBv2.new(self)
    when 3
      @epub = EPUBMaker::EPUBv3.new(self)
    else
      raise "Invalid EPUB version (#{@config['epubversion']}.)"
    end
  end
  ReVIEW::I18n.locale = config['language'] if config['language']
  support_legacy_maker
end

#mimetype(wobj) ⇒ Object

Write mimetype file to IO object wobj.



87
88
89
90
 
# File 'lib/epubmaker/producer.rb', line 87

def mimetype(wobj)
  s = @epub.mimetype
  wobj.print s if !s.nil? && !wobj.nil?
end

#mytoc(wobj) ⇒ Object

Write own toc file to IO object wobj.



133
134
135
136
 
# File 'lib/epubmaker/producer.rb', line 133

def mytoc(wobj)
  s = @epub.mytoc
  wobj.puts s if !s.nil? && !wobj.nil?
end

#ncx(wobj, indentarray = []) ⇒ Object

Write ncx file to IO object wobj. indentarray defines prefix string for each level.



100
101
102
103
 
# File 'lib/epubmaker/producer.rb', line 100

def ncx(wobj, indentarray = [])
  s = @epub.ncx(indentarray)
  wobj.puts s if !s.nil? && !wobj.nil?
end

#opf(wobj) ⇒ Object

Write opf file to IO object wobj.



93
94
95
96
 
# File 'lib/epubmaker/producer.rb', line 93

def opf(wobj)
  s = @epub.opf
  wobj.puts s if !s.nil? && !wobj.nil?
end

#produce(epubfile, basedir = nil, tmpdir = nil) ⇒ Object

Produce EPUB file epubfile. basedir points the directory has contents (default: current directory.) tmpdir defines temporary directory.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/epubmaker/producer.rb', line 162

def produce(epubfile, basedir = nil, tmpdir = nil)
  current = Dir.pwd
  basedir = current if basedir.nil?

  new_tmpdir = tmpdir.nil? ? Dir.mktmpdir : tmpdir
  epubfile = "#{current}/#{epubfile}" if epubfile !~ %r{\A/}

  # FIXME: error check
  File.unlink(epubfile) if File.exist?(epubfile)

  begin
    @epub.produce(epubfile, basedir, new_tmpdir)
  ensure
    FileUtils.rm_r(new_tmpdir) if tmpdir.nil?
  end
end

#titlepage(wobj) ⇒ Object

Write title file (copying) to IO object wobj.



121
122
123
124
 
# File 'lib/epubmaker/producer.rb', line 121

def titlepage(wobj)
  s = @epub.titlepage
  wobj.puts s if !s.nil? && !wobj.nil?
end