bitclust-core 1.2.6 → 1.6.0

data/lib/bitclust/preprocessor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 #
 # bitclust/preprocessor.rb
 #
@@ -7,6 +8,7 @@
 # You can distribute/modify this program under the Ruby License.
 #
 
+require 'bitclust/compat'
 require 'bitclust/parseutils'
 require 'strscan'
 
@@ -39,15 +41,20 @@ module BitClust
 
 
   # Handle pragmas like #@todo, #@include, #@since, etc.
+  #
+  # bitclust#285: prefix は #% が正式(GitHub が #@since 等の @英字 を
+  # ユーザー mention として解釈してしまうため)。旧 prefix #@ も、凍結タグ
+  # (frozen-*)の旧ソースを再取込する場合に備えて引き続き受け付ける。
   class Preprocessor < LineFilter
 
     def self.read(path, params = {})
       if path.respond_to?(:gets)
+        # @type var path: File
         io = wrap(path, params)
       else
         io = wrap(fopen(path, 'r:UTF-8'), params)
       end
-      ret = ""
+      ret = +""
       while s = io.gets
         ret << s
       end
@@ -80,36 +87,48 @@ module BitClust
     def next_line(f)
       while line = f.gets
         case line
-        when /\A(?!\#@)/
+        when /\A(?!\#[@%])/
           if current_cond.processing?
             @buf.push line
             break
           end
-        when /\A\#@\#/   # preprocessor comment
+        when /\A\#[@%]\#/   # preprocessor comment
           ;
-        when /\A\#@todo/i
-          @buf.push line.gsub(/\A\#/, '') if current_cond.processing?
-        when /\A\#@include\s*\((.*?)\)/
+        when /\A\#[@%]todo/i
+          # 出力は prefix によらず @todo に正規化する(下流の表示処理は
+          # 従来どおり @todo だけを見ればよい)
+          @buf.push line.sub(/\A\#[@%]/, '@') if current_cond.processing?
+        when /\A\#[@%]include\s*\((.*?)\)/
           next unless current_cond.processing?
           begin
-            file = $1.strip
-            basedir = File.dirname(line.location.file)
-            @buf.concat Preprocessor.process("#{basedir}/#{file}", @params)
+            file = ($1 || raise).strip
+            basedir = File.dirname(line.location.file || raise)
+            path = "#{basedir}/#{file}"
+            # md ツリーのネイティブパース: 断片は .md 拡張子付きで保存されるが
+            # include ターゲットは元式の名前のまま（拡張子なしの pack-template、
+            # .rd 付きの fiddle/2.0/fiddle.lib.rd 等）。md 側の実ファイル名を試す
+            unless File.exist?(path)
+              cand = ["#{path}.md", path.sub(/\.rd\z/, '.md')].find { |c| File.exist?(c) }
+              path = cand if cand
+            end
+            @buf.concat Preprocessor.process(path, @params)
           rescue Errno::ENOENT => _err
             raise WrongInclude, "#{line.location}: \#@include'ed file not exist: #{file}"
           end
-        when /\A\#@since\b/
+        when /\A\#[@%]since\b/
           cond_stmt_begin line, build_cond_by_value(line, 'version >=')
-        when /\A\#@until\b/
+        when /\A\#[@%]until\b/
           cond_stmt_begin line, build_cond_by_value(line, 'version <')
-        when /\A\#@samplecode\b/
+        when /\A\#[@%]version\b/
+          cond_stmt_begin line, build_cond_by_range(line)
+        when /\A\#[@%]samplecode\b/
           samplecode_begin(line, samplecode_description_by_value(line))
-        when /\A\#@if\b/
-          cond_stmt_begin line, line.sub(/\A\#@if/, '').strip
-        when /\A\#@else\s*\z/
+        when /\A\#[@%]if\b/
+          cond_stmt_begin line, line.sub(/\A\#[@%]if/, '').strip
+        when /\A\#[@%]else\s*\z/
           parse_error "no matching \#@if", line  if cond_toplevel?
           cond_invert
-        when /\A\#@end\s*\z/
+        when /\A\#[@%]end\s*\z/
           if samplecode_processing?
             samplecode_end
           else
@@ -122,7 +141,7 @@ module BitClust
       end
       if @buf.empty?
         unless cond_toplevel?
-          parse_error "unterminated \#@if", @last_if
+          parse_error "unterminated \#@if", @last_if || raise
         end
       end
       @buf.shift
@@ -137,8 +156,27 @@ module BitClust
       end
     end
 
+    # 版範囲の省略記法(#285): #%version A...B は半開区間 [A, B)。
+    # Ruby の終端排他 Range リテラルに合わせて3点ドット(.. は終端を含むと
+    # 誤解しやすいため受け付けない)。A... は A 以上、...B は B 未満。
+    # 版はダブルクォート付きでもよい
+    VERSION_LITERAL = /"(\d+(?:\.\d+)*)"|(\d+(?:\.\d+)*)/
+    def build_cond_by_range(line)
+      raw = line.sub(/\A\#[@%]version\b/, '').strip
+      case raw
+      when /\A#{VERSION_LITERAL}\.\.\.#{VERSION_LITERAL}\z/o
+        %Q(version >= "#{$1 || $2}" and version < "#{$3 || $4}")
+      when /\A#{VERSION_LITERAL}\.\.\.\z/o
+        %Q(version >= "#{$1 || $2}")
+      when /\A\.\.\.#{VERSION_LITERAL}\z/o
+        %Q(version < "#{$1 || $2}")
+      else
+        parse_error "wrong version range (expected A...B / A... / ...B)", line
+      end
+    end
+
     def build_cond_by_value(line, left)
-      case ver = line.sub(/\A\#@\w+/, '').strip
+      case ver = line.sub(/\A\#[@%]\w+/, '').strip
       when /\A[\d\.]+\z/
         %Q(#{left} "#{ver}")
       when /\A"[\d\.]+"\z/
@@ -149,7 +187,7 @@ module BitClust
     end
 
     def current_cond
-      @state_stack.last
+      @state_stack.last || raise
     end
 
     def cond_init
@@ -161,13 +199,13 @@ module BitClust
     end
 
     def cond_push(bool)
-      last = @state_stack.last
+      last = @state_stack.last || raise
       @state_stack.push(last.next(bool, :condition))
     end
 
     def cond_invert
-      b = @state_stack.pop.processing?
-      last = @state_stack.last
+      b = (@state_stack.pop || raise).processing?
+      last = @state_stack.last || raise
       @state_stack.push(last.next(!b, :condition))
     end
 
@@ -228,10 +266,10 @@ module BitClust
     def eval_primary(s)
       s.skip(/\s+/)
       if t = s.scan(/\w+/)
-        unless @params.key?(t)
+        unless @params.key?(t) # steep:ignore
           scan_error "database property `#{t}' not exist"
         end
-        @params[t]
+        @params[t] # steep:ignore
       elsif t = s.scan(/".*?"/)
         eval(t)
       elsif t = s.scan(/'.*?'/)
@@ -247,17 +285,17 @@ module BitClust
       description = description.strip
       samplecode_push(description)
       return unless current_cond.processing?
-      @buf.push("//emlist[#{description}][ruby]{\n")
+      @buf.push(+"//emlist[#{description}][ruby]{\n")
     end
 
     def samplecode_end
       samplecode_pop
       return unless current_cond.processing?
-      @buf.push("//}\n")
+      @buf.push(+"//}\n")
     end
 
     def samplecode_push(description)
-      last = @state_stack.last
+      last = @state_stack.last || raise
       @state_stack.push(last.next(true, :samplecode))
     end
 
@@ -266,11 +304,11 @@ module BitClust
     end
 
     def samplecode_processing?
-      @state_stack.last.samplecode?
+      (@state_stack.last || raise).samplecode?
     end
 
     def samplecode_description_by_value(line)
-      line.sub(/\A\#@samplecode/, "")
+      line.sub(/\A\#[@%]samplecode/, "")
     end
 
     def scan_error(msg)
@@ -320,10 +358,10 @@ module BitClust
 
     def next_line(f)
       while line = f.gets
-        if /\A\#@include\s*\((.*?)\)/ =~ line
+        if /\A\#[@%]include\s*\((.*?)\)/ =~ line
           begin
-            file = $1.strip
-            basedir = File.dirname(line.location.file)
+            file = ($1 || raise).strip
+            basedir = File.dirname(line.location.file || raise)
             @buf.concat LineCollector.process("#{basedir}/#{file}")
           rescue Errno::ENOENT => _err
             raise WrongInclude, "#{line.location}: \#@include'ed file not exist: #{file}"

data/lib/bitclust/progress_bar.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 begin
   require 'progressbar'