class ReVIEW::Book::Base
Attributes
basedir[R]
catalog[W]
config[RW]
parts[W]
Public Class Methods
load(dir = '.')
click to toggle source
# File lib/review/book/base.rb, line 21 def self.load(dir = '.') new(dir) end
new(basedir = '.')
click to toggle source
# File lib/review/book/base.rb, line 25 def initialize(basedir = '.') @basedir = basedir @logger = ReVIEW.logger @parts = nil @chapter_index = nil @config = ReVIEW::Configure.values @catalog = nil @read_part = nil @warn_old_files = {} # XXX for checking CHAPS, PREDEF, POSTDEF @basedir_seen = {} update_rubyenv end
Public Instance Methods
appendix()
click to toggle source
# File lib/review/book/base.rb, line 274 def appendix if catalog names = catalog.appendix.split("\n") chaps = names.each_with_index.map { |n, idx| mkchap_ifexist(n, idx) }.compact return mkpart(chaps) end begin postdef_file = filename_join(@basedir, config['postdef_file']) if File.file?(postdef_file) mkpart_from_namelistfile(postdef_file) end rescue FileNotFound => e raise FileNotFound, "postscript #{e.message}" end end
bib_exist?()
click to toggle source
# File lib/review/book/base.rb, line 255 def bib_exist? File.exist?(File.join(contentdir, bib_file)) end
bib_file()
click to toggle source
# File lib/review/book/base.rb, line 48 def bib_file config['bib_file'] end
catalog()
click to toggle source
# File lib/review/book/base.rb, line 188 def catalog return @catalog if @catalog.present? catalogfile_path = filename_join(@basedir, config['catalogfile']) if File.file? catalogfile_path @catalog = File.open(catalogfile_path, 'r:BOM|utf-8') { |f| Catalog.new(f) } end if @catalog @catalog.validate!(@config, basedir) end @catalog end
chapter(id)
click to toggle source
# File lib/review/book/base.rb, line 151 def chapter(id) chapter_index[id] end
chapter_index()
click to toggle source
# File lib/review/book/base.rb, line 138 def chapter_index return @chapter_index if @chapter_index contents = chapters # TODO: contents += parts.find_all { |prt| prt.id.present? } parts.each do |prt| if prt.id.present? contents << prt end end @chapter_index = ChapterIndex.new(contents) end
chapters()
click to toggle source
# File lib/review/book/base.rb, line 126 def chapters parts.map(&:chapters).flatten end
contentdir()
click to toggle source
# File lib/review/book/base.rb, line 72 def contentdir if !config['contentdir'].present? || config['contentdir'] == '.' @basedir else File.join(@basedir, config['contentdir']) end end
contents()
click to toggle source
# File lib/review/book/base.rb, line 117 def contents # TODO: includes predef, appendix, postdef if parts.present? chapters + parts else chapters end end
each_chapter(&block)
click to toggle source
# File lib/review/book/base.rb, line 130 def each_chapter(&block) chapters.each(&block) end
each_chapter_r(&block)
click to toggle source
# File lib/review/book/base.rb, line 134 def each_chapter_r(&block) chapters.reverse_each(&block) end
each_part(&block)
click to toggle source
# File lib/review/book/base.rb, line 113 def each_part(&block) parts.each(&block) end
ext()
click to toggle source
# File lib/review/book/base.rb, line 56 def ext config['ext'] end
htmlversion()
click to toggle source
# File lib/review/book/base.rb, line 90 def htmlversion if config['htmlversion'].blank? nil else config['htmlversion'].to_i end end
image_types()
click to toggle source
# File lib/review/book/base.rb, line 64 def image_types config['image_types'] end
image_types=(types)
click to toggle source
# File lib/review/book/base.rb, line 68 def image_types=(types) config['image_types'] = types end
imagedir()
click to toggle source
# File lib/review/book/base.rb, line 60 def imagedir File.join(@basedir, config['imagedir']) end
load_config(filename)
click to toggle source
# File lib/review/book/base.rb, line 183 def load_config(filename) new_conf = YAML.load_file(filename) @config.merge!(new_conf) end
next_chapter(chapter)
click to toggle source
# File lib/review/book/base.rb, line 155 def next_chapter(chapter) finded = false each_chapter do |c| return c if finded if c == chapter finded = true end end nil # not found end
page_metric()
click to toggle source
# File lib/review/book/base.rb, line 80 def page_metric if config['page_metric'].respond_to?(:downcase) && config['page_metric'].upcase =~ /\A[A-Z0-9_]+\Z/ ReVIEW::Book::PageMetric.const_get(config['page_metric'].upcase) elsif config['page_metric'].is_a?(Array) && config['page_metric'].size == 5 ReVIEW::Book::PageMetric.new(*config['page_metric']) else config['page_metric'] end end
part(n)
click to toggle source
# File lib/review/book/base.rb, line 109 def part(n) parts.detect { |part| part.number == n } end
part_exist?()
click to toggle source
# File lib/review/book/base.rb, line 243 def part_exist? if catalog catalog.parts.present? else File.exist?(File.join(@basedir, config['part_file'])) end end
parts()
click to toggle source
# File lib/review/book/base.rb, line 98 def parts @parts ||= read_parts end
parts_in_file()
click to toggle source
# File lib/review/book/base.rb, line 102 def parts_in_file # TODO: should be `parts.find_all{|part| part.present? and part.file?}` ? parts.find_all do |part| part if part.present? and part.file? end end
postscripts()
click to toggle source
# File lib/review/book/base.rb, line 291 def postscripts if catalog mkpart_from_namelist(catalog.postdef.split("\n")) end end
prefaces()
click to toggle source
# File lib/review/book/base.rb, line 259 def prefaces if catalog return mkpart_from_namelist(catalog.predef.split("\n")) end begin predef_file = filename_join(@basedir, config['predef_file']) if File.file?(predef_file) mkpart_from_namelistfile(predef_file) end rescue FileNotFound => e raise FileNotFound, "preface #{e.message}" end end
prev_chapter(chapter)
click to toggle source
# File lib/review/book/base.rb, line 166 def prev_chapter(chapter) finded = false each_chapter_r do |c| return c if finded if c == chapter finded = true end end nil # not found end
read_appendix()
click to toggle source
# File lib/review/book/base.rb, line 217 def read_appendix if catalog catalog.appendix else read_file(config['postdef_file']) # for backward compatibility end end
read_bib()
click to toggle source
# File lib/review/book/base.rb, line 251 def read_bib File.read(File.join(contentdir, bib_file)) end
read_chaps()
click to toggle source
# File lib/review/book/base.rb, line 201 def read_chaps if catalog catalog.chaps else read_file(config['chapter_file']) end end
read_part()
click to toggle source
# File lib/review/book/base.rb, line 233 def read_part return @read_part if @read_part if catalog @read_part = catalog.parts else @read_part = File.read(File.join(@basedir, config['part_file'])) end end
read_postdef()
click to toggle source
# File lib/review/book/base.rb, line 225 def read_postdef if catalog catalog.postdef else '' end end
read_predef()
click to toggle source
# File lib/review/book/base.rb, line 209 def read_predef if catalog catalog.predef else read_file(config['predef_file']) end end
reject_file()
click to toggle source
# File lib/review/book/base.rb, line 52 def reject_file config['reject_file'] end
update_rubyenv()
click to toggle source
# File lib/review/book/base.rb, line 38 def update_rubyenv if File.file?(File.join(@basedir, 'review-ext.rb')) if ENV['REVIEW_SAFE_MODE'].to_i & 2 > 0 @logger.warn 'review-ext.rb is prohibited in safe mode. ignored.' else Kernel.load(File.expand_path(File.join(@basedir, 'review-ext.rb'))) end end end
volume()
click to toggle source
# File lib/review/book/base.rb, line 177 def volume vol = Volume.sum(chapters.map(&:volume)) vol.page_per_kbyte = page_metric.page_per_kbyte vol end
Private Instance Methods
filename_join(*args)
click to toggle source
# File lib/review/book/base.rb, line 411 def filename_join(*args) File.join(args.reject(&:nil?)) end
mkchap(name, number = nil)
click to toggle source
# File lib/review/book/base.rb, line 373 def mkchap(name, number = nil) name += ext if File.extname(name).empty? path = File.join(contentdir, name) raise FileNotFound, "file not exist: #{path}" unless File.file?(path) Chapter.new(self, number, name, path) end
mkchap_ifexist(name, idx = nil)
click to toggle source
# File lib/review/book/base.rb, line 380 def mkchap_ifexist(name, idx = nil) name += ext if File.extname(name).empty? path = File.join(contentdir, name) if File.file?(path) idx += 1 if idx Chapter.new(self, idx, name, path) end end
mkpart(chaps)
click to toggle source
# File lib/review/book/base.rb, line 369 def mkpart(chaps) chaps.empty? ? nil : Part.new(self, nil, chaps) end
mkpart_from_namelist(names)
click to toggle source
# File lib/review/book/base.rb, line 365 def mkpart_from_namelist(names) mkpart(names.map { |n| mkchap_ifexist(n) }.compact) end
mkpart_from_namelistfile(path)
click to toggle source
# File lib/review/book/base.rb, line 353 def mkpart_from_namelistfile(path) chaps = [] File.read(path, mode: 'r:BOM|utf-8').split.each_with_index do |name, idx| if path =~ /PREDEF/ chaps << mkchap(name) else chaps << mkchap(name, idx + 1) end end mkpart(chaps) end
parse_chapters()
click to toggle source
return Array of Part
, not Chapter
# File lib/review/book/base.rb, line 316 def parse_chapters part = 0 num = 0 if catalog return catalog.parts_with_chaps.map do |entry| if entry.is_a?(Hash) chaps = entry.values.first.map do |chap| chap = Chapter.new(self, num += 1, chap, File.join(contentdir, chap)) chap end Part.new(self, part += 1, chaps, read_part.split("\n")[part - 1]) else chap = Chapter.new(self, num += 1, entry, File.join(contentdir, entry)) if chap.number num = chap.number else num -= 1 end Part.new(self, nil, [chap]) end end end chap = read_chaps. strip.lines.map(&:strip).join("\n").split(/\n{2,}/). map do |part_chunk| chaps = part_chunk.split.map { |chapid| Chapter.new(self, num += 1, chapid, File.join(contentdir, chapid)) } if part_exist? && read_part.split("\n").size > part Part.new(self, part += 1, chaps, read_part.split("\n")[part - 1]) else Part.new(self, nil, chaps) end end chap end
read_file(filename)
click to toggle source
# File lib/review/book/base.rb, line 389 def read_file(filename) unless @warn_old_files[filename] @warn_old_files[filename] = true if caller.none? { |item| item =~ %r{/review/test/test_} } @logger.warn "!!! #{filename} is obsoleted. please use catalog.yml." end end res = '' File.open(filename_join(@basedir, filename), 'r:BOM|utf-8') do |f| f.each_line do |line| next if /\A#/ =~ line line.gsub!(/#.*\Z/, '') res << line end end res rescue Errno::ENOENT Dir.glob("#{@basedir}/*#{ext}").sort.join("\n") rescue Errno::EISDIR '' end
read_parts()
click to toggle source
# File lib/review/book/base.rb, line 299 def read_parts list = parse_chapters # NOTE: keep this = style to work this logic. if pre = prefaces list.unshift pre end if app = appendix list.push app end if post = postscripts list.push post end list end