Class: ReVIEW::Book::Base
Instance Attribute Summary collapse
-
#basedir ⇒ Object
readonly
Returns the value of attribute basedir.
- #catalog ⇒ Object
-
#config ⇒ Object
Returns the value of attribute config.
- #parts ⇒ Object
Class Method Summary collapse
Instance Method Summary collapse
- #appendix ⇒ Object
- #bib_exist? ⇒ Boolean
- #bib_file ⇒ Object
- #chapter(id) ⇒ Object
- #chapter_index ⇒ Object
- #chapters ⇒ Object
- #contentdir ⇒ Object
- #contents ⇒ Object
- #each_chapter(&block) ⇒ Object
- #each_chapter_r(&block) ⇒ Object
- #each_part(&block) ⇒ Object
- #ext ⇒ Object
- #htmlversion ⇒ Object
- #image_types ⇒ Object
- #image_types=(types) ⇒ Object
- #imagedir ⇒ Object
-
#initialize(basedir = '.') ⇒ Base
constructor
A new instance of Base.
- #load_config(filename) ⇒ Object
- #next_chapter(chapter) ⇒ Object
- #page_metric ⇒ Object
- #part(n) ⇒ Object
- #part_exist? ⇒ Boolean
- #parts_in_file ⇒ Object
- #postscripts ⇒ Object
- #prefaces ⇒ Object
- #prev_chapter(chapter) ⇒ Object
- #read_appendix ⇒ Object
- #read_bib ⇒ Object
- #read_chaps ⇒ Object
- #read_part ⇒ Object
- #read_postdef ⇒ Object
- #read_predef ⇒ Object
- #reject_file ⇒ Object
- #update_rubyenv ⇒ Object
- #volume ⇒ Object
Constructor Details
#initialize(basedir = '.') ⇒ Base
Returns a new instance of Base.
25 26 27 28 29 30 31 32 33 34 35 |
# 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 @warn_old_files = {} # XXX for checking CHAPS, PREDEF, POSTDEF @basedir_seen = {} update_rubyenv end |
Instance Attribute Details
#basedir ⇒ Object (readonly)
Returns the value of attribute basedir.
19 20 21 |
# File 'lib/review/book/base.rb', line 19 def basedir @basedir end |
#catalog ⇒ Object
188 189 190 191 192 193 194 195 196 197 198 199 |
# 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, 'rt:BOM|utf-8') { |f| Catalog.new(f) } end if @catalog @catalog.validate!(@config, basedir) end @catalog end |
#config ⇒ Object
Returns the value of attribute config.
16 17 18 |
# File 'lib/review/book/base.rb', line 16 def config @config end |
#parts ⇒ Object
97 98 99 |
# File 'lib/review/book/base.rb', line 97 def parts @parts ||= read_parts end |
Class Method Details
.load(dir = '.') ⇒ Object
21 22 23 |
# File 'lib/review/book/base.rb', line 21 def self.load(dir = '.') new(dir) end |
Instance Method Details
#appendix ⇒ Object
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 |
# File 'lib/review/book/base.rb', line 272 def appendix if catalog names = catalog.appendix chaps = names.each_with_index.map { |name, number| Chapter.mkchap_ifexist(self, name, number + 1) }.compact return Part.mkpart(chaps) end begin postdef_file = filename_join(@basedir, config['postdef_file']) if File.file?(postdef_file) Part.mkpart_from_namelistfile(self, postdef_file) end rescue FileNotFound => e raise FileNotFound, "postscript #{e.}" end end |
#bib_exist? ⇒ Boolean
253 254 255 |
# File 'lib/review/book/base.rb', line 253 def bib_exist? File.exist?(File.join(contentdir, bib_file)) end |
#bib_file ⇒ Object
47 48 49 |
# File 'lib/review/book/base.rb', line 47 def bib_file config['bib_file'] end |
#chapter(id) ⇒ Object
151 152 153 |
# File 'lib/review/book/base.rb', line 151 def chapter(id) chapter_index[id].content end |
#chapter_index ⇒ Object
137 138 139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/review/book/base.rb', line 137 def chapter_index return @chapter_index if @chapter_index @chapter_index = ChapterIndex.new each_chapter do |chap| @chapter_index.add_item(Index::Item.new(chap.id, chap.number, chap)) end parts.each do |prt| if prt.id.present? @chapter_index.add_item(Index::Item.new(prt.id, prt.number, prt)) end end @chapter_index end |
#chapters ⇒ Object
125 126 127 |
# File 'lib/review/book/base.rb', line 125 def chapters parts.map(&:chapters).flatten end |
#contentdir ⇒ Object
71 72 73 74 75 76 77 |
# File 'lib/review/book/base.rb', line 71 def contentdir if !config['contentdir'].present? || config['contentdir'] == '.' @basedir else File.join(@basedir, config['contentdir']) end end |
#contents ⇒ Object
116 117 118 119 120 121 122 123 |
# File 'lib/review/book/base.rb', line 116 def contents # TODO: includes predef, appendix, postdef if parts.present? chapters + parts else chapters end end |
#each_chapter(&block) ⇒ Object
129 130 131 |
# File 'lib/review/book/base.rb', line 129 def each_chapter(&block) chapters.each(&block) end |
#each_chapter_r(&block) ⇒ Object
133 134 135 |
# File 'lib/review/book/base.rb', line 133 def each_chapter_r(&block) chapters.reverse_each(&block) end |
#each_part(&block) ⇒ Object
112 113 114 |
# File 'lib/review/book/base.rb', line 112 def each_part(&block) parts.each(&block) end |
#ext ⇒ Object
55 56 57 |
# File 'lib/review/book/base.rb', line 55 def ext config['ext'] end |
#htmlversion ⇒ Object
89 90 91 92 93 94 95 |
# File 'lib/review/book/base.rb', line 89 def htmlversion if config['htmlversion'].blank? nil else config['htmlversion'].to_i end end |
#image_types ⇒ Object
63 64 65 |
# File 'lib/review/book/base.rb', line 63 def image_types config['image_types'] end |
#image_types=(types) ⇒ Object
67 68 69 |
# File 'lib/review/book/base.rb', line 67 def image_types=(types) config['image_types'] = types end |
#imagedir ⇒ Object
59 60 61 |
# File 'lib/review/book/base.rb', line 59 def imagedir File.join(@basedir, config['imagedir']) end |
#load_config(filename) ⇒ Object
183 184 185 186 |
# 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) ⇒ Object
155 156 157 158 159 160 161 162 163 164 |
# 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 ⇒ Object
79 80 81 82 83 84 85 86 87 |
# File 'lib/review/book/base.rb', line 79 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) ⇒ Object
108 109 110 |
# File 'lib/review/book/base.rb', line 108 def part(n) parts.detect { |part| part.number == n } end |
#part_exist? ⇒ Boolean
241 242 243 244 245 246 247 |
# File 'lib/review/book/base.rb', line 241 def part_exist? if catalog catalog.parts.present? else File.exist?(File.join(@basedir, config['part_file'])) end end |
#parts_in_file ⇒ Object
101 102 103 104 105 106 |
# File 'lib/review/book/base.rb', line 101 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 ⇒ Object
289 290 291 292 293 |
# File 'lib/review/book/base.rb', line 289 def postscripts if catalog Part.mkpart_from_namelist(self, catalog.postdef) end end |
#prefaces ⇒ Object
257 258 259 260 261 262 263 264 265 266 267 268 269 270 |
# File 'lib/review/book/base.rb', line 257 def prefaces if catalog return Part.mkpart_from_namelist(self, catalog.predef) end begin predef_file = filename_join(@basedir, config['predef_file']) if File.file?(predef_file) Part.mkpart_from_namelistfile(self, predef_file) end rescue FileNotFound => e raise FileNotFound, "preface #{e.}" end end |
#prev_chapter(chapter) ⇒ Object
166 167 168 169 170 171 172 173 174 175 |
# 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 ⇒ Object
217 218 219 220 221 222 223 |
# File 'lib/review/book/base.rb', line 217 def read_appendix if catalog catalog.appendix else read_file(config['postdef_file']).split("\n") # for backward compatibility end end |
#read_bib ⇒ Object
249 250 251 |
# File 'lib/review/book/base.rb', line 249 def read_bib File.read(File.join(contentdir, bib_file)) end |
#read_chaps ⇒ Object
201 202 203 204 205 206 207 |
# File 'lib/review/book/base.rb', line 201 def read_chaps if catalog catalog.chaps else read_file(config['chapter_file']).split("\n") end end |
#read_part ⇒ Object
233 234 235 236 237 238 239 |
# File 'lib/review/book/base.rb', line 233 def read_part if catalog catalog.parts else File.read(File.join(@basedir, config['part_file'])).split("\n") end end |
#read_postdef ⇒ Object
225 226 227 228 229 230 231 |
# File 'lib/review/book/base.rb', line 225 def read_postdef if catalog catalog.postdef else [] end end |
#read_predef ⇒ Object
209 210 211 212 213 214 215 |
# File 'lib/review/book/base.rb', line 209 def read_predef if catalog catalog.predef else read_file(config['predef_file']).split("\n") end end |
#reject_file ⇒ Object
51 52 53 |
# File 'lib/review/book/base.rb', line 51 def reject_file config['reject_file'] end |
#update_rubyenv ⇒ Object
37 38 39 40 41 42 43 44 45 |
# File 'lib/review/book/base.rb', line 37 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.(File.join(@basedir, 'review-ext.rb'))) end end end |