Class: ReVIEW::Configure

Inherits:
Hash show all
Defined in:
lib/review/configure.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Hash

#deep_merge, #deep_merge!

Instance Attribute Details

#maker ⇒ Object

Returns the value of attribute maker.



5
6
7
 
# File 'lib/review/configure.rb', line 5

def maker
  @maker
end

Class Method Details

.values ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/review/configure.rb', line 7

def self.values
  conf = Configure[
    # These parameters can be overridden by YAML file.
    'bookname' => 'example', # it defines epub file name also
    'booktitle' => 'Re:VIEW Sample Book',
    'title' => nil,
    'aut' => nil, # author
    'prt' => nil, # printer(publisher)
    'asn' => nil, # associated name
    'ant' => nil, # bibliographic antecedent
    'clb' => nil, # Collaborator
    'edt' => nil, # Editor
    'dsr' => nil, # Designer
    'ill' => nil, # Illustrator
    'pht' => nil, # Photographer
    'trl' => nil, # Translator
    'date' => Time.now.strftime('%Y-%m-%d'), # publishing date
    'rights' => nil, # Copyright messages
    'description' => nil, # Description
    'urnid' => "urn:uid:#{SecureRandom.uuid}", # Identifier
    'stylesheet' => 'stylesheet.css', # stylesheet file
    'coverfile' => nil, # content file of body of cover page
    'mytoc' => nil, # whether make own table of contents or not
    'params' => '', # specify review2html parameters
    'toclevel' => 3, # level of toc
    'secnolevel' => 2, # level of section #
    'epubversion' => 3,
    'titlepage' => true, # Use title page
    'toc' => nil, # Use table of contents in body
    'colophon' => nil, # Use colophon
    'debug' => nil, # debug flag
    'catalogfile' => 'catalog.yml',
    'language' => 'ja', # XXX default language should be JA??
    'mathml' => nil, # for HTML
    'imgmath' => nil, # for HTML
    'htmlext' => 'html',
    'htmlversion' => 5,
    'imagedir' => 'images',
    'image_ext' => %w[png gif jpg jpeg svg ttf woff otf],
    'fontdir' => 'fonts',
    'chapter_file' => 'CHAPS',
    'part_file' => 'PART',
    'reject_file' => 'REJECT',
    'predef_file' => 'PREDEF',
    'postdef_file' => 'POSTDEF',
    'page_metric' => ReVIEW::Book::PageMetric::A5,
    'ext' => '.re',
    'image_dir' => 'images',
    'image_types' => %w[.ai .psd .eps .pdf .tif .tiff .png .bmp .jpg .jpeg .gif .svg],
    'image_scale2width' => true, # for LaTeX
    'bib_file' => 'bib.re',
    'colophon_order' => %w[aut csl trl dsr ill cov edt pbl contact prt],
    'externallink' => true,
    'tableopt' => nil,      # for IDGXML
    'listinfo' => nil,      # for IDGXML
    'nolf' => true,         # for IDGXML
    'chapref' => nil,       # for IDGXML
    'structuredxml' => nil, # for IDGXML
    'pt_to_mm_unit' => 0.3528, # for IDGXML (DTP: 1pt = 0.3528mm, JIS: 1pt = 0.3514mm)

    'footnotetext' => nil, # for LaTeX
    'texcommand' => 'uplatex', # for LaTeX
    'texdocumentclass' => ['jsbook', 'uplatex,oneside'], # for LaTeX
    'dvicommand' => 'dvipdfmx', # for LaTeX
    'dvioptions' => '-d 5', # for LaTeX

    'pdfmaker' => {
      'makeindex' => nil, # Make index page
      'makeindex_command' => 'mendex', # works only when makeindex is true
      'makeindex_options' => '-f -r -I utf8',
      'makeindex_sty' => nil,
      'makeindex_dic' => nil,
      'makeindex_mecab' => true,
      'makeindex_mecab_opts' => '-Oyomi'
    }
  ]
  conf.maker = nil
  conf
end

Instance Method Details

#[](key) ⇒ Object 



87
88
89
90
91
92
 
# File 'lib/review/configure.rb', line 87

def [](key)
  maker = self.maker
  return self.fetch(maker).fetch(key, nil) if maker && self.key?(maker) && self.fetch(maker) && self.fetch(maker).key?(key)
  return self.fetch(key) if self.key?(key)
  nil
end

#check_version(version) ⇒ Object

Raises:



94
95
96
97
98
99
100
101
 
# File 'lib/review/configure.rb', line 94

def check_version(version)
  raise ReVIEW::ConfigError, 'configuration file has no review_version property.' unless self.key?('review_version')

  return true if self['review_version'].blank?

  raise ReVIEW::ConfigError, 'major version of configuration file is different.' if self['review_version'].to_i != version.to_i ## major version
  raise ReVIEW::ConfigError, "Re:VIEW version '#{version}' is older than configuration file's version '#{self['review_version']}'." if self['review_version'].to_f > version.to_f ## minor version
end

#name_of(key) ⇒ Object 



103
104
105
106
107
108
109
110
111
 
# File 'lib/review/configure.rb', line 103

def name_of(key)
  if self[key].is_a?(Array)
    self[key].join(',') # i18n?
  elsif self[key].is_a?(Hash)
    self[key]['name']
  else
    self[key]
  end
end

#names_of(key) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/review/configure.rb', line 113

def names_of(key)
  if self[key].is_a?(Array)
    self[key].map do |a|
      if a.is_a?(Hash)
        a['name']
      else
        a
      end
    end
  elsif self[key].is_a?(Hash)
    [self[key]['name']]
  else
    [self[key]]
  end
end