Merge pull request rurema#3341 from znz/version-range-adoption

版範囲の #%if を #%version 記法に置き換え (refs rurema/bitclust#285)

Author: znz

Gemfile.lock

@@ -1,6 +1,5 @@
-GIT
-  remote: https://github.com/rurema/bitclust.git
-  revision: 3c9999411372b350a4ae0e55c2de669390cadc10
+PATH
+  remote: ../bitclust
   specs:
     bitclust-core (1.5.0)
       drb

docs/ReferenceManualFormatDigest.md

@@ -295,9 +295,24 @@ Ruby 3.2 にはこの機能が含まれません 〜〜〜
 #%end
 ```
 
+### #%version
+
+バージョン範囲(半開区間)にあてはまる文章を書くのに使います。
+`A...B` は「A 以上 B 未満」です(Ruby の終端排他 Range リテラルと同じ 3 点ドット。
+`..` は使えません)。`A...`(A 以上)、`...B`(B 未満)も書けます。
+
+```
+#%version 3.1...3.4
+Ruby 3.1 以上 3.4 未満では 〜〜
+#%end
+```
+
+`#%since` / `#%until` / `#%version` / `#%if` は `#%else` と組み合わせられます。
+
 ### #%if
 
 Ruby の特定のバージョンにあてはまる文章を書くのに使います。条件には比較式のみ書けます。
+範囲の条件は `#%if` ではなく上の `#%version` で書いてください。
 
 ```
 #%if (version >= "3.1")

manual/api/_builtin/Module.md

@@ -1300,13 +1300,13 @@ class Factory
   private_class_method :foo
 end
 
-#%if("3.4" <= version)
+#%version 3.4...
 Factory.foo # NoMethodError: private method 'foo' called for class Factory
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 Factory.foo # NoMethodError: private method `foo' called for class Factory
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 Factory.foo # NoMethodError: private method `foo' called for Factory:Class
 #%end
 
@@ -1841,13 +1841,13 @@ end
 
 account = Account.new
 p account.foo1          # => 1
-#%if("3.4" <= version)
+#%version 3.4...
 account.foo2            # => private method 'foo2' called for an instance of Account (NoMethodError)
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 account.foo2            # => private method `foo2' called for an instance of Account (NoMethodError)
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 account.foo2            # => private method `foo2' called for #<Account:0x401b7628> (NoMethodError)
 #%end
 ```
@@ -1902,13 +1902,13 @@ p foo             # => 1
 # the toplevel default is private
 # (Ruby 2.7 以降、レシーバが self そのものの呼び出しは private でも可能なため
 #  self.foo はエラーにならない。別のオブジェクトをレシーバにすると呼び出せない)
-#%if("3.4" <= version)
+#%version 3.4...
 Object.new.foo    # => private method 'foo' called for an instance of Object (NoMethodError)
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 Object.new.foo    # => private method `foo' called for an instance of Object (NoMethodError)
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 Object.new.foo    # => private method `foo' called for #<Object:0x401c83b0> (NoMethodError)
 #%end
 

manual/api/_builtin/NameError.md

@@ -7,13 +7,13 @@ library: _builtin
 
 ```ruby title="例"
 bar
-#%if("3.4" <= version)
+#%version 3.4...
 # ~> NameError: undefined local variable or method 'bar' for main
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 # ~> NameError: undefined local variable or method `bar' for main
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 # ~> NameError: undefined local variable or method `bar' for main:Object
 #%end
 ```
@@ -51,13 +51,13 @@ p err.name  # => "foo"
 begin
   foobar
 rescue NameError => err
-#%if("3.4" <= version)
+#%version 3.4...
 p err       # => #<NameError: undefined local variable or method 'foobar' for main>
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 p err       # => #<NameError: undefined local variable or method `foobar' for main>
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 p err       # => #<NameError: undefined local variable or method `foobar' for main:Object>
 #%end
   p err.name  # => :foobar
@@ -72,15 +72,15 @@ end
 begin
   foobar
 rescue NameError => err
-#%if("3.4" <= version)
+#%version 3.4...
 p err       # => #<NameError: undefined local variable or method 'foobar' for main>
 p err.to_s  # => "undefined local variable or method 'foobar' for main"
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 p err       # => #<NameError: undefined local variable or method `foobar' for main>
 p err.to_s  # => "undefined local variable or method `foobar' for main"
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 p err       # => #<NameError: undefined local variable or method `foobar' for main:Object>
 p err.to_s  # => "undefined local variable or method `foobar' for main:Object"
 #%end

manual/api/_builtin/NoMethodError.md

@@ -7,13 +7,13 @@ library: _builtin
 
 ```ruby title="例"
 self.bar
-#%if("3.4" <= version)
+#%version 3.4...
 # => -:1: undefined method 'bar' for main (NoMethodError)
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 # => -:1: undefined method `bar' for main (NoMethodError)
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 # => -:1: undefined method `bar' for main:Object (NoMethodError)
 #%end
 ```
@@ -22,13 +22,13 @@ self.bar
 
 ```ruby title="例"
 "".puts
-#%if("3.4" <= version)
+#%version 3.4...
 # => -:1:in '<main>': private method 'puts' called for an instance of String (NoMethodError)
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 # => -:1:in `<main>': private method `puts' called for an instance of String (NoMethodError)
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 # => -:1:in `<main>': private method `puts' called for "":String (NoMethodError)
 #%end
 ```
@@ -37,13 +37,13 @@ self.bar
 
 ```ruby title="例"
 bar
-#%if("3.4" <= version)
+#%version 3.4...
 # => -:1: undefined local variable or method 'bar' for main (NameError)
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 # => -:1: undefined local variable or method `bar' for main (NameError)
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 # => -:1: undefined local variable or method `bar' for main:Object (NameError)
 #%end
 ```
@@ -88,13 +88,13 @@ rescue NoMethodError
   p $!.args
 end
 
-#%if("3.4" <= version)
+#%version 3.4...
 # => #<NoMethodError: undefined method 'foobar' for main>
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 # => #<NoMethodError: undefined method `foobar' for main>
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 # => #<NoMethodError: undefined method `foobar' for main:Object>
 #%end
 # => :foobar

manual/api/_builtin/RubyVM__InstructionSequence.md

@@ -79,7 +79,7 @@ p RubyVM::InstructionSequence.compile_file("/tmp/hello.rb")
 命令シーケンスのコンパイル時のデフォルトの最適化オプションを Hash で返
 します。
 
-#%if("3.4" <= version)
+#%version 3.4...
 
 ```ruby title="例"
 require "pp"
@@ -98,7 +98,7 @@ pp RubyVM::InstructionSequence.compile_option
 ```
 
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 
 ```ruby title="例"
 require "pp"
@@ -117,7 +117,7 @@ pp RubyVM::InstructionSequence.compile_option
 ```
 
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 
 ```ruby title="例"
 require "pp"
@@ -158,7 +158,7 @@ options で指定します。
     * :operands_unification
     * :peephole_optimization
     * :specialized_instruction
-#%if(version < "3.3")
+#%version ...3.3
     * :stack_caching
 #%end
     * :tailcall_optimization

manual/api/_builtin/RubyVM__YJIT.md

@@ -34,7 +34,7 @@ Ruby 3.2 で「実験的」の位置づけが外れ、Ruby 3.3 では実行時
 `RubyVM::ZJIT` という別のモジュールで提供されており、
 `RubyVM::YJIT` とは別物です。
 
-#%if(version < "3.3")
+#%version ...3.3
 - **SEE** [c:RubyVM::MJIT]
 #%end
 
@@ -80,13 +80,13 @@ JIT の有効・無効はコマンドラインオプションや環境変数な
 - **SEE** [m:RubyVM::YJIT.runtime_stats], [m:RubyVM::YJIT.stats_enabled?]
 
 #%since 3.3
-#%if("4.0" <= version)
+#%version 4.0...
 ### def enable(stats: false, log: false, mem_size: nil, call_threshold: nil) -> bool
 #%end
-#%if("3.4" <= version and version < "4.0")
+#%version 3.4...4.0
 ### def enable(stats: false, log: false) -> bool
 #%end
-#%if(version < "3.4")
+#%version ...3.4
 ### def enable(stats: false) -> bool
 #%end
 
@@ -134,13 +134,13 @@ Marshal 形式で `filename` にダンプします。ダンプしたファイル
 #%#noexample 実行環境に依存するため
 #%end
 
-#%if("3.4" <= version)
+#%version 3.4...
 ### def runtime_stats(key = nil) -> Hash | object | nil
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 ### def runtime_stats(context: false) -> Hash | nil
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 ### def runtime_stats -> Hash | nil
 #%end
 
@@ -153,7 +153,7 @@ Marshal 形式で `filename` にダンプします。ダンプしたファイル
   対応する値を返します。統計収集が無効な場合は `nil` を返します。
 - **raise** `TypeError` -- `key` に Symbol 以外(`nil` を除く)を指定した場合に発生します。
 #%else
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 - **param** `context` -- true を指定すると、コンパイルコンテキストに関する統計も含めます。
 #%end
 - **return** -- 統計情報のハッシュを返します。統計収集が無効な場合は `nil` を返します。

manual/api/did_you_mean.md

@@ -7,13 +7,13 @@ category: Development
 
 ```ruby
 "Yuki".starts_with?("Y")
-#%if("3.4" <= version)
+#%version 3.4...
 # ~> NoMethodError: undefined method 'starts_with?' for an instance of String
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 # ~> NoMethodError: undefined method `starts_with?' for an instance of String
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 # ~> NoMethodError: undefined method `starts_with?' for "Yuki":String
 #%end
 #    Did you mean?  start_with?

manual/api/singleton.md

@@ -31,13 +31,13 @@ end
 a = SomeSingletonClass.instance
 b = SomeSingletonClass.instance # a and b are same object
 p [a,b] # => [#<SomeSingletonClass:0x0000562e6e18ddd0>, #<SomeSingletonClass:0x0000562e6e18ddd0>]
-#%if("3.4" <= version)
+#%version 3.4...
 a = SomeSingletonClass.new  # ~> NoMethodError: private method 'new' called for class SomeSingletonClass
 #%end
-#%if("3.3" <= version and version < "3.4")
+#%version 3.3...3.4
 a = SomeSingletonClass.new  # ~> NoMethodError: private method `new' called for class SomeSingletonClass
 #%end
-#%if(version < "3.3")
+#%version ...3.3
 a = SomeSingletonClass.new  # ~> NoMethodError: private method `new' called for SomeSingletonClass:Class
 #%end
 ```

manual/api/socket/Socket.md

@@ -413,11 +413,11 @@ sockets でサーバソケットを受け取り、接続を待ち受け、
 
 ローカルの IP アドレスを配列で返します。
 
-#%if("4.0" <= version)
+#%version 4.0...
 ### def tcp(host, port, local_host=nil, local_port=nil, connect_timeout: nil, resolv_timeout: nil, open_timeout: nil, fast_fallback: true) -> Socket
 ### def tcp(host, port, local_host=nil, local_port=nil, connect_timeout: nil, resolv_timeout: nil, open_timeout: nil, fast_fallback: true) {|socket| ... } -> object
 #%end
-#%if("3.4" <= version and version < "4.0")
+#%version 3.4...4.0
 ### def tcp(host, port, local_host=nil, local_port=nil, connect_timeout: nil, resolv_timeout: nil, fast_fallback: true) -> Socket
 ### def tcp(host, port, local_host=nil, local_port=nil, connect_timeout: nil, resolv_timeout: nil, fast_fallback: true) {|socket| ... } -> object
 #%end
@@ -438,10 +438,10 @@ local_host や local_port を指定した場合、ソケットをそこにバイ
 - **param** `local_port` -- 接続元のポート番号
 - **param** `connect_timeout` -- 接続確立のタイムアウトを秒数で指定します。
 - **param** `resolv_timeout` -- 名前解決のタイムアウトを秒数で指定します。
-#%if (version >= "4.0")
+#%version 4.0...
 - **param** `open_timeout` -- 名前解決から接続確立までのタイムアウトを秒数で指定します。
 #%end
-#%if (version >= "3.4")
+#%version 3.4...
 - **param** `fast_fallback` -- Happy Eyeballs Version 2 ([RFC 8305](https://datatracker.ietf.org/doc/html/rfc8305)) を有効にします。
 #%end
 - **return** -- ブロック付きで呼ばれた場合はブロックが返した値です。