review 1.6.0 → 1.7.0

data/.travis.yml

@@ -1,9 +1,18 @@
+language: ruby
+sudo: false
+
 rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.*
   - 2.2.*
+  - ruby-head
 
 branches:
   only:
     - master
+
+script:
+  - bundle exec rake test
+  - bundle exec rubocop
+

data/ChangeLog

@@ -1,3 +1,7 @@
+Thu Oct 29 13:58:22 2015  KADO Masanori  <kdmsnr@gmail.com>
+
+	* Release 1.7.0
+
 Mon Jun 29 18:16:06 2015  KADO Masanori  <kdmsnr@gmail.com>
 
 	* Release 1.6.0

data/Dockerfile

@@ -0,0 +1,22 @@
+# This file is a sample Dockerfile to build Re:VIEW documents.
+#
+# Build:
+#   $ docker build -t review .
+#
+# Usage:
+#   $ cd path/to/review/project
+#   $ docker run -it --rm -v `pwd`:/work review rake pdf
+#
+# cf. https://github.com/vvakame/docker-review/blob/master/Dockerfile
+
+FROM debian:sid
+MAINTAINER takahashim
+
+RUN apt-get update \
+	&& apt-get install -y --no-install-recommends git-core ruby locales zip \
+    && apt-get install -y --no-install-recommends texlive-lang-cjk texlive-lang-japanese texlive-fonts-recommended texlive-latex-extra ghostscript \
+	&& rm -rf /var/lib/apt/lists/*
+RUN gem install review rake bundler --no-rdoc --no-ri
+
+VOLUME ["/work"]
+WORKDIR /work

data/README.rdoc

@@ -78,4 +78,4 @@ LGPL. See COPYING file.
 
 == Copyright
 
-Copyright (c) 2006-2014 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.
+Copyright (c) 2006-2015 Minero Aoki, Kenshi Muto, Masayoshi Takahashi, Masanori Kado.

data/Rakefile

@@ -12,7 +12,7 @@ require 'rake/clean'
 task :default => [:test]
 
 Rake::TestTask.new("test") do |t|
-  t.libs   << "test"
+  t.libs << "test"
   t.test_files = Dir.glob("test/**/test_*.rb")
   t.verbose = true
 end

data/bin/review-check

@@ -31,12 +31,7 @@ rescue Errno::EPIPE
 end
 
 def main
-  $KCODE = 'UTF-8' unless defined?(Encoding)
   @config = ReVIEW::Configure.values
-  @config.merge!({
-    "inencoding" => "UTF-8",
-    "outencoding" => "UTF-8"
-  })
   @book = ReVIEW::Book::Base.load
   @book.config = @config
 
@@ -44,12 +39,6 @@ def main
   files = ARGV unless ARGV.empty?
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
-  opts.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and SJIS)') {|enc|
-    @config["inencoding"] = enc
-  }
-  opts.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC, JIS, and SJIS)') {|enc|
-    @config["outencoding"] = enc
-  }
   opts.on('-a', '--all-chapters', 'Check all chapters.') {
     files = @book.chapters.map {|ent| ent.path }
   }
@@ -95,11 +84,11 @@ def check_text(files)
       each_paragraph(f) do |para, lineno|
         s = para.join('')
         if m = re.match(s)
-          next if m[0] == $ReVIEW_utils_word_ok
+          next if m[0] == @review_utils_word_ok
           next if neg and neg =~ s
           str, offset = find_line(para, re)
           out = sprintf("%s:%d: %s\n", path, lineno + offset, str)
-          print convert_outencoding(out, @config["outencoding"])
+          print out
         end
       end
     }
@@ -109,14 +98,14 @@ end
 def find_line(lines, re)
   # single line?
   lines.each_with_index do |line, idx|
-    return line.gsub(re, '<<<\&>>>'), idx  if re =~ line
+    return line.gsub(re, '<<<\&>>>'), idx if re =~ line
   end
 
   # multiple lines?
   i = 0
   while i < lines.size - 1
     str = lines[i] + lines[i+1]
-    return str.gsub(re, '<<<\&>>>'), i  if re =~ str
+    return str.gsub(re, '<<<\&>>>'), i if re =~ str
     i += 1
   end
 
@@ -127,7 +116,7 @@ def words_re(rc)
   words = []
   nega = []
   File.foreach(rc) do |line|
-    next  if line[0,1] == '#'
+    next if line[0,1] == '#'
     if / !/ =~ line
       line, n = *line.split(/!/, 2)
       nega.push n.strip
@@ -139,13 +128,11 @@ def words_re(rc)
 end
 
 def each_paragraph(f)
-  $ReVIEW_utils_word_ok = nil
+  @review_utils_word_ok = nil
   while line = f.gets
-    line = convert_inencoding(line, @config["inencoding"])
-
     case line
     when /\A\#@ok\((.*)\)/
-      $ReVIEW_utils_word_ok = $1
+      @review_utils_word_ok = $1
     when /\A\#@/
       ;
     when %r[\A//caption\{(.*?)//\}]
@@ -168,7 +155,7 @@ def each_paragraph(f)
         buf.push line.strip
       end
       yield buf, lineno
-      $ReVIEW_utils_word_ok = nil
+      @review_utils_word_ok = nil
     end
   end
 end

data/bin/review-compile

@@ -34,8 +34,6 @@ rescue Errno::EPIPE
 end
 
 def _main
-  $KCODE = 'UTF-8' unless defined?(Encoding)
-
   mode = :files
   basedir = nil
   if /\Areview2/ =~ File.basename($0)
@@ -48,16 +46,14 @@ def _main
 
   config = ReVIEW::Configure.values
   config.merge!({
-    "secnolevel" => 2,    # for IDGXML and HTML
-    "tableopt" => nil,    # for IDGXML
-    "nolf" => nil,        # for IDGXML
-    "chapref" => nil,     # for IDGXML
+    "secnolevel" => 2, # for IDGXML and HTML
+    "tableopt" => nil, # for IDGXML
+    "nolf" => nil, # for IDGXML
+    "chapref" => nil, # for IDGXML
     "structuredxml" => nil, # for IDGXML
-    "inencoding" => "UTF-8",
-    "outencoding" => "UTF-8",
-    "stylesheet" => [],   # for HTML
-    "mathml" => nil,      # for HTML
-    "language" => "ja",   # for HTML
+    "stylesheet" => [], # for HTML
+    "mathml" => nil, # for HTML
+    "language" => "ja", # for HTML
     "deprecated-blocklines" => nil,
     "footnotetext" => false,
     "htmlext" => "html",
@@ -71,8 +67,6 @@ def _main
     require 'yaml'
     config = config.merge(YAML.load_file(yaml))
   end
-  opts.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and SJIS)') {|enc| config["inencoding"] = enc }
-  opts.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC, JIS, and SJIS)') {|enc| config["outencoding"] = enc }
   opts.on('-c', '--check', 'Check manuscript') { check_only = true }
   opts.on('--level=LVL', 'Section level to append number.') {|lvl| config["secnolevel"] = lvl.to_i }
   opts.on('--toclevel=LVL', 'Section level to append number.') {|lvl| config["toclevel"] = lvl.to_i }
@@ -173,12 +167,12 @@ def _main
       compiler = ReVIEW::Compiler.new(load_strategy_class(target, check_only))
       book.chapters.each do |chap|
         str = compiler.compile(chap)
-        write "#{chap.name}#{compiler.strategy.extname}", str  unless check_only
+        write "#{chap.name}#{compiler.strategy.extname}", str unless check_only
       end
       # PART
       book.parts_in_file.each do |part|
         str = compiler.compile(part)
-        write "#{part.name}#{compiler.strategy.extname}", str  unless check_only
+        write "#{part.name}#{compiler.strategy.extname}", str unless check_only
       end
     else
       raise "must not happen: #{mode}"

data/bin/review-epubmaker-legacy

@@ -28,7 +28,7 @@ require 'review/i18n'
 require 'review/htmlutils'
 include ReVIEW::HTMLUtils
 
-$essential_files = ['top', 'toc', 'colophon']
+@essential_files = ['top', 'toc', 'colophon']
 def main
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
@@ -57,7 +57,7 @@ def main
   yamlfile = ARGV[0]
   values = ReVIEW::Configure.values.merge(YAML.load_file(yamlfile))
   bookname = values["bookname"]
-  $essential_files <<= bookname
+  @essential_files <<= bookname
   tmp = values["debug"].nil? ? Dir.mktmpdir : "."
   @bookdir = "#{tmp}/#{bookname}-epub"
   @epubversion = values["epubversion"] || 2
@@ -774,8 +774,8 @@ end
 
 def output_chaps_by_file(l, values)
   file_id = File.basename(l.chomp.strip,".*")
-  if (idx = $essential_files.index(file_id))
-    if idx == $essential_files.size - 1
+  if (idx = @essential_files.index(file_id))
+    if idx == @essential_files.size - 1
       STDERR.puts "#{file_id} is book name. Please rename #{l.chomp.strip}."
     else
       STDERR.puts "#{file_id} is special name. Please rename #{l.chomp.strip}."
@@ -800,8 +800,8 @@ def include_mathml?(filename)
     }
     return false
   }
-  rescue
-    false
+rescue
+  false
 end
 
 def getFigId(filename)

data/bin/review-index

@@ -32,25 +32,14 @@ rescue Errno::EPIPE
 end
 
 def _main
-  $KCODE = 'UTF-8' unless defined?(Encoding)
-
   printer_class = ReVIEW::TextTOCPrinter
   source = nil
   upper = ReVIEW::TOCPrinter.default_upper_level
-  param = {
-    "inencoding" => "UTF-8",
-    "outencoding" => "UTF-8"
-  }
+  param = {}
   book = ReVIEW::Book::Base.load
 
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
-  opts.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and SJIS)') {|enc|
-    param["inencoding"] = enc
-  }
-  opts.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC, JIS, and SJIS)') {|enc|
-    param["outencoding"] = enc
-  }
   opts.on('-a', '--all', 'print all chapters.') {
     begin
       source = book
@@ -71,7 +60,7 @@ def _main
   }
   opts.on('-l', '--level N', 'list upto N level (1..4, default=4)') {|n|
     upper = Integer(n)
-    unless (0..4).include?(upper)  # 0 is hidden option
+    unless (0..4).include?(upper) # 0 is hidden option
       $stderr.puts "-l/--level option accepts only 1..4"
       exit 1
     end

data/bin/review-preproc

@@ -35,25 +35,12 @@ rescue Errno::EPIPE
 end
 
 def main
-  $KCODE = 'UTF-8' unless defined?(Encoding)
-
-  param = {
-    "inencoding" => "UTF-8",
-    "outencoding" => "UTF-8",
-  }
+  param = {}
 
   mode = :output
   opts = OptionParser.new
   opts.version = ReVIEW::VERSION
   opts.banner = "Usage: #{File.basename($0)} [-c|-d|-s|--replace] [<file>...]"
-  opts.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and
-SJIS)') {|enc|
-    param["inencoding"] = enc
-  }
-  opts.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC
-, JIS, and SJIS)') {|enc|
-    param["outencoding"] = enc
-  }
   opts.on('-c', '--check', 'Check if preprocess is needed.') {
     mode = :check
   }

data/bin/review-validate

@@ -15,7 +15,7 @@ colcount = 0
 ln = 0
 
 ARGF.each {|line|
-  ln = ln + 1
+  ln += 1
   if line =~ /\A\/\/([a-z]+).+\{/
     # block
     _block = $1

data/bin/review-vol

@@ -21,13 +21,7 @@ require 'optparse'
 include ReVIEW::TextUtils
 
 def main
-  $KCODE = 'UTF-8' unless defined?(Encoding)
-
   @config = ReVIEW::Configure.values
-  @config.merge!({
-    "inencoding" => "UTF-8",
-    "outencoding" => "UTF-8"
-  })
 
   part_sensitive = false
   basedir = nil
@@ -40,12 +34,6 @@ def main
   opts.on('-P', '--part-sensitive', 'Prints volume of each parts.') {
     part_sensitive = true
   }
-  opts.on('--inencoding=ENCODING', 'Set input encoding. (UTF-8, EUC, JIS, and SJIS)') {|enc|
-    @config["inencoding"] = enc
-  }
-  opts.on('--outencoding=ENCODING', 'Set output encoding. (UTF-8[default], EUC, JIS, and SJIS)') {|enc|
-    @config["outencoding"] = enc
-  }
   opts.on('--directory=DIR', 'Compile all chapters in DIR.') {|path|
     basedir = path
   }
@@ -95,7 +83,7 @@ end
 
 def print_chapter_volume(chap)
   vol = chap.volume
-  title = convert_outencoding(chap.title, @config["outencoding"])
+  title = chap.title
   printf "%s %3dKB %6dC %5dL %3dP %s %-s\n",
          chapnumstr(chap.number), vol.kbytes, vol.chars, vol.lines, vol.page,
          "#{chap.name} ".ljust(25, '.'), title

data/doc/NEWS.ja.md

@@ -1,3 +1,25 @@
+# Version 1.7.0の主な変更点
+
+## 全般
+* Rubocopの設定の追加とそれに伴うリファクタリングを実施しました
+* 内部の文字コードをUTF-8に統一しました ([#399])
+* Dockerfileを追加しました
+
+## バグ修正
+* コードハイライト無効時に、htmlbuilderでlistnumおよびemlistnumにおいて行番号が表示されないバグを修正しました ([#449])
+
+## ビルダーとメーカー
+
+### epubmaker
+* 綴じ方向を設定する``direction``パラメータをサポートしました ([#435])
+
+## コードコントリビュータ
+* [@snoozer05](https://github.com/snoozer05)
+
+[#399]: https://github.com/kmuto/review/pull/399
+[#435]: https://github.com/kmuto/review/pull/435
+[#449]: https://github.com/kmuto/review/issues/449
+
 # Version 1.6.0の主な変更点
 
 ## 全般

data/doc/NEWS.md

@@ -1,3 +1,25 @@
+# Version 1.7.0
+
+## In general
+* Set up Rubocop settings and refactor code with the settings
+* Change the internal encoding to UTF-8 altogether ([#399])
+* Add a Dockerfile
+
+## Bug Fix
+* Fix htmlbuilder to display line numbers with listnum/emlistnum under a syntax highlighting environment ([#449])
+
+## Builders and Makers
+
+### epubmaker
+* Support ``direction`` parameter to set binding direction ([#435])
+
+## Code contributors
+* [@snoozer05](https://github.com/snoozer05)
+
+[#399]: https://github.com/kmuto/review/pull/399
+[#435]: https://github.com/kmuto/review/pull/435
+[#449]: https://github.com/kmuto/review/issues/449
+
 # Version 1.6.0
 
 ## In general

data/doc/quickstart.ja.md

@@ -161,7 +161,7 @@ sample.re を HTML に変換すると、次のようになります。
 </html>
 ```
 
-Re:VIEW フォーマットについての詳細は、 [format.rdoc](https://github.com/kmuto/review/blob/master/doc/format.rdoc) を参照してください。
+Re:VIEW フォーマットについての詳細は、 [format.ja.md](https://github.com/kmuto/review/blob/master/doc/format.ja.md) を参照してください。
 
 review-compile を含め、ほとんどのコマンドは `--help` オプションを付けるとオプションについてのヘルプが表示されます。`review-compile` には多数のオプションがあるので確認してください。
 

data/doc/quickstart.md

@@ -191,7 +191,7 @@ You can get HTML file as follows:
 </html>
 ```
 
-For more information about Re:VIEW format, see [format.rdoc](https://github.com/kmuto/review/blob/master/doc/format.rdoc).
+For more information about Re:VIEW format, see [format.md](https://github.com/kmuto/review/blob/master/doc/format.md).
 
 review-compile and other commands in Re:VIEW has `--help` option to output help.  `review-compile` has many options, so you may see them.
 

data/lib/epubmaker/content.rb

@@ -60,12 +60,12 @@ module EPUBMaker
       complement
     end
 
-    def ==(obj)
-      if self.class != obj.class
+    def ==(other)
+      if self.class != other.class
         return false
       end
       [self.id, self.file, self.media, self.title, self.level, self.notoc, self.chaptype, self.properties] ==
-        [obj.id, obj.file, obj.media, obj.title, obj.level, obj.notoc, obj.chaptype, obj.properties]
+        [other.id, other.file, other.media, other.title, other.level, other.notoc, other.chaptype, other.properties]
     end
 
     private