bitclust-core 1.3.0 → 1.6.1

data/test/test_preprocessor.rb

@@ -1,6 +1,7 @@
 require 'test/unit'
 require 'bitclust/preprocessor'
 require 'stringio'
+require 'tmpdir'
 
 class TestPreprocessor < Test::Unit::TestCase
   include BitClust
@@ -313,4 +314,218 @@ HERE
       assert_equal(expected, ret.join)
     end
   end
+
+  # bitclust#285: GitHub が #@since 等をユーザー mention として解釈してしまう
+  # 問題への対応で、@ を含まない新 prefix #% を導入する。旧 #@ も凍結タグの
+  # 旧ソース再取込のため引き続き受け付ける(両対応)
+  sub_test_case("percent prefix (#285)") do
+
+    def test_percent_eval_cond
+      params = { 'version' => '1.8.7' }
+
+      [
+       ['#%if( version > "1.8.0")',  true ],
+       ['#%if( version < "1.8.0")',  false],
+       ['#%since 1.8.0', true ],
+       ['#%since 1.8.7', true ],
+       ['#%until 1.8.7', false],
+       ['#%until 1.9.0', true ],
+      ].each{|cond, expected_result|
+        s = <<HERE
+#{cond}
+a
+#%else
+b
+#%end
+HERE
+        ret = Preprocessor.wrap(StringIO.new(s), params).to_a
+        if expected_result
+          assert_equal(["a\n"], ret)
+        else
+          assert_equal(["b\n"], ret)
+        end
+      }
+    end
+
+    def test_percent_comment
+      params = { 'version' => '1.8.7' }
+      src = <<HERE
+a
+#%# preprocessor comment
+b
+HERE
+      ret = Preprocessor.wrap(StringIO.new(src), params).to_a
+      assert_equal(["a\n", "b\n"], ret)
+    end
+
+    def test_percent_todo_normalized
+      params = { 'version' => '1.8.7' }
+      src = <<HERE
+--- puts(str) -> String
+#%todo
+description
+HERE
+      expected = <<HERE
+--- puts(str) -> String
+@todo
+description
+HERE
+      ret = Preprocessor.wrap(StringIO.new(src), params).to_a
+      assert_equal(expected, ret.join)
+    end
+
+    def test_percent_samplecode
+      params = { 'version' => '1.9.2' }
+      src = <<HERE
+#%samplecode description
+puts("xxx")
+#%since 1.9.2
+puts("zzz")
+#%end
+#%end
+HERE
+      expected = <<HERE
+//emlist[description][ruby]{
+puts("xxx")
+puts("zzz")
+//}
+HERE
+      ret = Preprocessor.wrap(StringIO.new(src), params).to_a
+      assert_equal(expected, ret.join)
+    end
+
+    def test_mixed_prefixes
+      # 移行期は同一ファイル内で新旧 prefix が混在しうる
+      params = { 'version' => '2.0.0' }
+      src = <<HERE
+#%since 1.9.3
+a
+\#@since 2.4.0
+b
+#%end
+\#@end
+c
+HERE
+      expected = <<HERE
+a
+c
+HERE
+      ret = Preprocessor.wrap(StringIO.new(src), params).to_a
+      assert_equal(expected, ret.join)
+    end
+
+    def test_percent_unknown_directive
+      params = { 'version' => '1.8.7' }
+      src = <<HERE
+#%nosuch
+HERE
+      assert_raise(BitClust::ParseError) do
+        Preprocessor.wrap(StringIO.new(src), params).to_a
+      end
+    end
+
+    def test_percent_include
+      Dir.mktmpdir do |dir|
+        File.write("#{dir}/inc.rd", "included\n")
+        File.write("#{dir}/main.rd", <<~HERE)
+          before
+          #%include(inc.rd)
+          after
+        HERE
+        ret = Preprocessor.process("#{dir}/main.rd", { 'version' => '1.8.7' })
+        assert_equal("before\nincluded\nafter\n", ret.join)
+      end
+    end
+
+    def test_at_include_still_works
+      Dir.mktmpdir do |dir|
+        File.write("#{dir}/inc.rd", "included\n")
+        File.write("#{dir}/main.rd", <<~HERE)
+          before
+          \#@include(inc.rd)
+          after
+        HERE
+        ret = Preprocessor.process("#{dir}/main.rd", { 'version' => '1.8.7' })
+        assert_equal("before\nincluded\nafter\n", ret.join)
+      end
+    end
+  end
+
+  # bitclust#285: 版範囲の省略記法 #%version A...B(半開区間 [A, B))。
+  # Ruby の終端排他 Range リテラルに合わせて3点ドット。
+  # A... は A 以上(#%since 相当)、...B は B 未満(#%until 相当)
+  sub_test_case("version range (#285)") do
+
+    def process(src, version)
+      Preprocessor.wrap(StringIO.new(src), { 'version' => version }).to_a.join
+    end
+
+    def gated(cond)
+      <<HERE
+#{cond}
+in
+#%else
+out
+#%end
+HERE
+    end
+
+    def test_bounded_range
+      src = gated('#%version 3.1...3.4')
+      assert_equal "out\n", process(src, '3.0')
+      assert_equal "in\n",  process(src, '3.1')   # 始端は含む
+      assert_equal "in\n",  process(src, '3.2')
+      assert_equal "out\n", process(src, '3.4')   # 終端は含まない
+      assert_equal "out\n", process(src, '4.0')
+    end
+
+    def test_endless_range
+      src = gated('#%version 3.1...')
+      assert_equal "out\n", process(src, '3.0')
+      assert_equal "in\n",  process(src, '3.1')
+      assert_equal "in\n",  process(src, '4.1')
+    end
+
+    def test_beginless_range
+      src = gated('#%version ...3.1')
+      assert_equal "in\n",  process(src, '3.0')
+      assert_equal "out\n", process(src, '3.1')
+    end
+
+    def test_quoted_versions
+      src = gated('#%version "3.1"..."3.4"')
+      assert_equal "in\n",  process(src, '3.1')
+      assert_equal "out\n", process(src, '3.4')
+    end
+
+    def test_old_prefix
+      src = gated("\#@version 3.1...3.4")
+      assert_equal "in\n", process(src, '3.2')
+    end
+
+    def test_nesting_with_since
+      src = <<HERE
+#%version 3.1...4.0
+#%since 3.3
+both
+#%end
+#%end
+HERE
+      assert_equal "both\n", process(src, '3.3')
+      assert_equal "",       process(src, '3.2')
+      assert_equal "",       process(src, '4.0')
+    end
+
+    def test_two_dot_range_is_error
+      # .. (終端を含む Range)は誤解を招くため受け付けない(#285)
+      assert_raise(BitClust::ParseError) { process(gated('#%version 3.1..3.4'), '3.2') }
+    end
+
+    def test_malformed_ranges_are_error
+      assert_raise(BitClust::ParseError) { process(gated('#%version'), '3.2') }
+      assert_raise(BitClust::ParseError) { process(gated('#%version ...'), '3.2') }
+      assert_raise(BitClust::ParseError) { process(gated('#%version 3.1....3.4'), '3.2') }
+      assert_raise(BitClust::ParseError) { process(gated('#%version 3.1...3.4...4.0'), '3.2') }
+    end
+  end
 end