md2review 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b0c25dd78674626ae763d7e22a3d0f3bb0d1bbe
-  data.tar.gz: a20ad0bfc4b7a8cc8911fe45e62c463b9a6e809c
+  metadata.gz: 8c560a9be30a083529292ae26d7a45d9fced085d
+  data.tar.gz: 7ab713f3fda9726c9d138bfe418ef52c57ae2d56
 SHA512:
-  metadata.gz: b6f7e6c11a967266328ad668175f77c3c8e66664e57a77d7a421a2037ffaf54ca8af49090dfd69ac8084258a3bef3db913e0cb4f6e8abee1b17ec8e97cb2c48c
-  data.tar.gz: 839647f7b807bff78490e84b5f2665cffb33c83fb298f446a9a31d18b5b6affd1b09c581532147d17930182c4f1fb6d162a468b205b4c6abccb1e10c94e2811f
+  metadata.gz: '00689ab7e51fca52eae36f9137fbed5fde4f90d142b6bdc0e241301023caafb31996441ec4caa7eca3b2ebabc6fa457ba8cafd9607d4bac0cad37f0c7a57b4dd'
+  data.tar.gz: 352be9cc2485f702ddfae7ebddaf941175e7e3f9e3aa93ab53bd3843111634eb9cd343ed953421e0482bdd0954b31f7d1758338c741c479cb23fc3fa13cd9517

data/.rubocop.yml

@@ -0,0 +1,87 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisabledByDefault: true
+
+Style/HashSyntax:
+  Enabled: true
+
+Style/EmptyLines:
+  Enabled: true
+
+Style/TrailingBlankLines:
+  Enabled: true
+
+Style/TrailingWhitespace:
+  Enabled: true
+
+Style/MethodDefParentheses:
+  Enabled: true
+
+
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+  Enabled: true
+
+# EnforcedStyle: empty_lines => 16 offenses
+# EnforcedStyle: no_empty_lines => 0 offense
+Style/EmptyLinesAroundBlockBody:
+  EnforcedStyle: no_empty_lines
+  Enabled: true
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+  Enabled: true
+
+Style/MethodName:
+  EnforcedStyle: snake_case
+  Enabled: true
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBraces: no_space
+  Enabled: true
+
+Style/SpaceInsideStringInterpolation:
+  EnforcedStyle: no_space
+  Enabled: true
+
+Style/VariableName:
+  EnforcedStyle: snake_case
+  Enabled: true
+
+Style/MissingElse:
+  EnforcedStyle: case
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+
+Lint/DefEndAlignment:
+  Enabled: true
+
+Lint/DeprecatedClassMethods:
+  Enabled: true
+
+Lint/DuplicateCaseCondition:
+  Enabled: true
+
+Lint/DuplicateMethods:
+  Enabled: true
+
+Lint/DuplicatedKey:
+  Enabled: true
+
+Lint/ElseLayout:
+  Enabled: true
+
+Lint/EndInMethod:
+  Enabled: true
+
+Lint/HandleExceptions:
+  Enabled: true
+
+Lint/ImplicitStringConcatenation:
+  Enabled: true
+
+Lint/MultipleCompare:
+  Enabled: true

data/.travis.yml

@@ -1,6 +1,11 @@
 language: ruby
 sudo: false
 
+
+before_install:
+  - gem update --system
+  - gem update bundler
+
 rvm:
   - 2.0
   - 2.1

data/Gemfile

@@ -2,4 +2,4 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem "redcarpet", :git => 'git://github.com/gnue/redcarpet.git', :branch => 'denden'
+gem "redcarpet", git: 'https://github.com/gnue/redcarpet.git', branch: 'denden'

data/README.md

@@ -1,6 +1,7 @@
 # md2review
 
-[![Build Status](https://api.travis-ci.org/takahashim/md2review.png)](https://travis-ci.org/takahashim/md2review)
+[![Gem Version](https://badge.fury.io/rb/md2review.svg)](https://badge.fury.io/rb/md2review)
+[![Build Status](https://secure.travis-ci.org/takahashim/md2review.svg)](https://travis-ci.org/takahashim/md2review)
 
 md2review is a CLI tool to convert from Markdown into Re:VIEW (http://reviewml.org/ ).
 This command uses Redcarpet gem to parse markdown.
@@ -23,6 +24,7 @@ You can use the commmand md2review as:
 * `--render-table-cation`: support table caption before table like `Table: some captions`
 * `--parse-no-intra-emphasis`: do not parse emphasis inside of words.
 * `--parse-autolink`: parse links even when they are not enclosed in `<>` characters.
+* `--render-empty-image-caption`: use `//image` with caption and use `//indepimage` without caption
 
 
 ## Installation
@@ -41,34 +43,45 @@ Or install it yourself as:
 
 ## History
 
-* 1.10.0
-    * add: option --image-table to support `//imgtable` with `![Table:foo](...)`
-    * fix: olist before/after ulist
-* 1.9.0
-    * fix: fix math support for complex cases
-* 1.8.0
-    * add: option --version
-    * add: option --render-math to support `@<m>{...}` and `//texequation{\n...\n}\n`
-    * add: option --render-table-caption to support `Table: caption`
-* 1.7.0
-    * fix: when href in emphasis (@hanachin)
-    * fix: spaces before image block (@hanachin)
-    * fix: remove inline markup in href content (@hanachin)
-* 1.6.0
-    * special attribute in header need a separator(U+0020) to distinguish from Re:VIEW inline markup
-      (reported by @himajin315 and @yasulab)
-* 1.5.0
-    * support language on code block
-    * add option --render-enable-cmd
-* 1.4.0
-    * fix handling empty cell in //table
-    * support header attributes in PHP Markdown Extra
-* 1.3.0
-    * allow images in list items (with @<icon>)
-    * add option --disable-image-caption
-    * allow 6th header level
-    * add option --render-link-in-footnote (by @masarakki)
-    * support inline markup in footnote (by @hamano)
+### v1.11.0
+* add: option --empty-image-caption: switch to use `//image` or `//indepimage` with caption
+
+### v1.10.0
+* add: option --image-table to support `//imgtable` with `![Table:foo](...)`
+* fix: olist before/after ulist
+
+### v1.9.0
+* fix: fix math support for complex cases
+
+### v1.8.0
+* add: option --version
+* add: option --render-math to support `@<m>{...}` and `//texequation{\n...\n}\n`
+* add: option --render-table-caption to support `Table: caption`
+
+### v1.7.0
+* fix: when href in emphasis (@hanachin)
+* fix: spaces before image block (@hanachin)
+* fix: remove inline markup in href content (@hanachin)
+
+### v1.6.0
+* special attribute in header need a separator(U+0020) to distinguish from Re:VIEW inline markup
+  (reported by @himajin315 and @yasulab)
+
+### v1.5.0
+* support language on code block
+* add option --render-enable-cmd
+
+### v1.4.0
+* fix handling empty cell in `//table`
+* support header attributes in PHP Markdown Extra
+
+### v1.3.0
+* allow images in list items (with `@<icon>`)
+* add option --disable-image-caption
+* allow 6th header level
+* add option --render-link-in-footnote (by @masarakki)
+* support inline markup in footnote (by @hamano)
+
 
 ## Contributing
 

data/Rakefile

@@ -1,10 +1,13 @@
 require "bundler/gem_tasks"
-
 require 'rake/testtask'
+require 'rubocop/rake_task'
+
 Rake::TestTask.new('test:unit') do |t|
   t.test_files = FileList['test/*_test.rb']
 end
 
-task :default => :test
+RuboCop::RakeTask.new
+
+task default: [:test, :rubocop]
 
-task :test => ['test:unit']
+task test: ['test:unit']

data/lib/md2review/version.rb

@@ -1,3 +1,3 @@
 module MD2ReVIEW
-  VERSION = "1.10.0"
+  VERSION = "1.11.0"
 end

data/lib/redcarpet/render/review.rb

@@ -11,6 +11,12 @@ module Redcarpet
         @header_offset = 0
         @link_in_footnote = render_extensions[:link_in_footnote]
         @image_caption = !render_extensions[:disable_image_caption]
+        if render_extensions[:empty_image_caption]
+          @image_caption = false
+          @empty_image_caption = true
+        else
+          @empty_image_caption = false
+        end
         @image_table = render_extensions[:image_table]
         if render_extensions[:header_offset]
           @header_offset = render_extensions[:header_offset]
@@ -165,7 +171,7 @@ module Redcarpet
         if @image_table && alt_text =~ /\ATable:\s*(.*)/
           caption = $1
           "//imgtable[#{filename}][#{caption}]{\n//}\n"
-        elsif @image_caption
+        elsif @image_caption || (@empty_image_caption && alt_text.to_s.size > 0)
           "//image[#{filename}][#{alt_text}]{\n//}\n"
         else
           "//indepimage[#{filename}]\n"

data/md2review.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |gem|
   gem.add_dependency('redcarpet', '>2.0.0')
   gem.add_development_dependency "rake"
   gem.add_development_dependency "test-unit"
+  gem.add_development_dependency "rubocop"
 end

data/test/review_test.rb

@@ -37,7 +37,7 @@ class ReVIEWTest < Test::Unit::TestCase
 
   def test_href_in_footnote
     text = %Q[aaa [foo](http://example.jp/foo), [bar](http://example.jp/bar), [foo2](http://example.jp/foo)]
-    rd = MD2ReVIEW::Markdown.new({:link_in_footnote => true},{}).render(text)
+    rd = MD2ReVIEW::Markdown.new({link_in_footnote: true},{}).render(text)
     assert_equal %Q|\n\naaa foo@<fn>{3ccd7167b80081c737b749ad1c27dcdc}, bar@<fn>{9dcab303478e38d32d83ae19daaea9f6}, foo2@<fn>{3ccd7167b80081c737b749ad1c27dcdc}\n\n\n//footnote[3ccd7167b80081c737b749ad1c27dcdc][http://example.jp/foo]\n\n//footnote[9dcab303478e38d32d83ae19daaea9f6][http://example.jp/bar]\n|, rd
   end
 
@@ -88,12 +88,22 @@ class ReVIEWTest < Test::Unit::TestCase
   end
 
   def test_indepimage
-    rev = render_with({}, "![test](path/to/image.jpg)\n",{:disable_image_caption => true})
+    rev = render_with({}, "![test](path/to/image.jpg)\n", {disable_image_caption: true})
     assert_equal "\n\n//indepimage[image]\n\n\n", rev
   end
 
+  def test_indepimage_empty
+    rev = render_with({}, "![](path/to/image.jpg)\n", {empty_image_caption: true})
+    assert_equal "\n\n//indepimage[image]\n\n\n", rev
+  end
+
+  def test_indepimage_not_empty
+    rev = render_with({}, "![test](path/to/image.jpg)\n", {empty_image_caption: true})
+    assert_equal "\n\n//image[image][test]{\n//}\n\n\n", rev
+  end
+
   def test_image_table
-    rev = render_with({}, "![Table:test](path/to/image.jpg)\n",{:image_table => true})
+    rev = render_with({}, "![Table:test](path/to/image.jpg)\n", {image_table: true})
     assert_equal "\n\n//imgtable[image][test]{\n//}\n\n\n", rev
   end
 
@@ -123,12 +133,12 @@ class ReVIEWTest < Test::Unit::TestCase
   end
 
   def test_table_with_empty_cell
-    rd = render_with({:tables => true}, %Q[\n\n| a  |  b |  c |\n|----|----|----|\n| A  | B  | C  |\n|    | B  |  C |\n| .A | B  |  C |\n\n])
+    rd = render_with({tables: true}, %Q[\n\n| a  |  b |  c |\n|----|----|----|\n| A  | B  | C  |\n|    | B  |  C |\n| .A | B  |  C |\n\n])
     assert_equal "//table[tbl1][]{\na\tb\tc\n-----------------\nA\tB\tC\n.\tB\tC\n..A\tB\tC\n//}\n", rd
   end
 
   def test_table_with_caption
-    rd = render_with({:tables => true}, <<-EOB, {:table_caption => true})
+    rd = render_with({tables: true}, <<-EOB, {table_caption: true})
 
 Table: caption test
 
@@ -150,7 +160,7 @@ EOB
   end
 
   def test_code_fence_with_caption
-    rd = render_with({:fenced_code_blocks => true}, %Q[~~~ {caption="test"}\ndef foo\n  p "test"\nend\n~~~\n])
+    rd = render_with({fenced_code_blocks: true}, %Q[~~~ {caption="test"}\ndef foo\n  p "test"\nend\n~~~\n])
     assert_equal %Q[\n//emlist[test]{\ndef foo\n  p "test"\nend\n//}\n], rd
   end
 
@@ -160,41 +170,41 @@ EOB
   end
 
   def test_code_fence_with_lang
-    rd = render_with({:fenced_code_blocks => true}, %Q[~~~ruby\ndef foo\n  p "test"\nend\n~~~\n])
+    rd = render_with({fenced_code_blocks: true}, %Q[~~~ruby\ndef foo\n  p "test"\nend\n~~~\n])
     assert_equal %Q[\n//emlist[][ruby]{\ndef foo\n  p "test"\nend\n//}\n], rd
   end
 
   def test_code_fence_with_console
-    rd = render_with({:fenced_code_blocks => true}, %Q[~~~console\ndef foo\n  p "test"\nend\n~~~\n])
+    rd = render_with({fenced_code_blocks: true}, %Q[~~~console\ndef foo\n  p "test"\nend\n~~~\n])
     assert_equal %Q[\n//emlist[][console]{\ndef foo\n  p "test"\nend\n//}\n], rd
-    rd = render_with({:fenced_code_blocks => true},
+    rd = render_with({fenced_code_blocks: true},
                       %Q[~~~console\ndef foo\n  p "test"\nend\n~~~\n],
-                     {:enable_cmd => true})
+                     {enable_cmd: true})
     assert_equal %Q[\n//cmd{\ndef foo\n  p "test"\nend\n//}\n], rd
   end
 
   def test_group_ruby
-    rd = render_with({:ruby => true}, "{電子出版|でんししゅっぱん}を手軽に\n")
+    rd = render_with({ruby: true}, "{電子出版|でんししゅっぱん}を手軽に\n")
     assert_equal %Q[\n\n@<ruby>{電子出版,でんししゅっぱん}を手軽に\n\n], rd
   end
 
   def test_tcy
-    rd = render_with({:tcy => true}, "昭和^53^年\n")
+    rd = render_with({tcy: true}, "昭和^53^年\n")
     assert_equal %Q[\n\n昭和@<tcy>{53}年\n\n], rd
   end
 
   def test_math
-    rd = render_with({}, "その結果、$$y=ax^2+bx+c$$の式が得られます。",{:math => true})
+    rd = render_with({}, "その結果、$$y=ax^2+bx+c$$の式が得られます。",{math: true})
     assert_equal %Q[\n\nその結果、@<m>{y=ax^2+bx+c}の式が得られます。\n\n], rd
   end
 
   def test_multi_math
-    rd = render_with({}, "その結果、$$y=a_2x^2+b_2x+c_2$$の式が得られます。$$a_2$$は2次の係数、$$b_2$$は1次の係数、$$c_2$$は定数です。",{:math => true})
+    rd = render_with({}, "その結果、$$y=a_2x^2+b_2x+c_2$$の式が得られます。$$a_2$$は2次の係数、$$b_2$$は1次の係数、$$c_2$$は定数です。",{math: true})
     assert_equal %Q[\n\nその結果、@<m>{y=a_2x^2+b_2x+c_2}の式が得られます。@<m>{a_2}は2次の係数、@<m>{b_2}は1次の係数、@<m>{c_2}は定数です。\n\n], rd
   end
 
   def test_math2
-    rd = render_with({}, <<-'EOB',{:math => true})
+    rd = render_with({}, <<-'EOB',{math: true})
 $$X = \{ {x_1}, \cdots ,{x_n} \}$$、$$m$$、$${\mu _X}$$、$$\sigma _X^2$$、$$\{ {\hat x_1}, \cdots ,{\hat x_n} \}$$
 
 $$\mathbf{W} = ({w_1}, \cdots ,{w_n})$$、$$\sqrt {w_1^2 + \cdots  + w_n^2} $$、$$\left| {w_1^{}} \right| + \left| {w_2^{}} \right| +  \cdots  + \left| {w_n^{}} \right|$$。
@@ -212,12 +222,12 @@ EOB
   end
 
   def test_no_math
-    rd = render_with({}, "その結果、$$y=ax^2+bx+c$$の式が得られます。",{:math => false})
+    rd = render_with({}, "その結果、$$y=ax^2+bx+c$$の式が得られます。",{math: false})
     assert_equal %Q[\n\nその結果、$$y=ax^2+bx+c$$の式が得られます。\n\n], rd
   end
 
   def test_math_block
-    rd = render_with({:fenced_code_blocks => true}, <<-EOB,{:math => true})
+    rd = render_with({fenced_code_blocks: true}, <<-EOB,{math: true})
 求める式は以下のようになります。
 
 ```math
@@ -237,12 +247,12 @@ EOB
   end
 
   def test_footnote
-    rd = render_with({:footnotes=>true}, "これは*脚注*付き[^1]の段落です。\n\n\n[^1]: そして、これが脚注です。\n")
+    rd = render_with({footnotes: true}, "これは*脚注*付き[^1]の段落です。\n\n\n[^1]: そして、これが脚注です。\n")
     assert_equal %Q|\n\nこれは@<b>{脚注}付き@<fn>{1}の段落です。\n\n\n//footnote[1][そして、これが脚注です。]\n|, rd
   end
 
   def test_autolink
-    rd = render_with({:autolink => true}, "リンクの[テスト](http://example.jp/test)です。\nhttp://example.jp/test2/\n")
+    rd = render_with({autolink: true}, "リンクの[テスト](http://example.jp/test)です。\nhttp://example.jp/test2/\n")
     assert_equal %Q[\n\nリンクの@<href>{http://example.jp/test,テスト}です。\n@<href>{http://example.jp/test2/}\n\n], rd
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: md2review
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - takahashim
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: a converter from Markdown to Re:VIEW. It uses redcarpet.
 email:
 - takahashimm@gmail.com
@@ -61,6 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt