Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove #(at)since 1.8.x because they are always true #1989

Merged
merged 1 commit into from
Aug 18, 2019

Conversation

pocke
Copy link
Member

@pocke pocke commented Aug 14, 2019

るりまではRuby 1.8以前のドキュメントは既に生成していないので、#@since 1.8.xの条件文を全て削除します。

#1981 の続きです。

条件文の削除は次のコードを使っています。
https://gist.github.com/pocke/49249b217f89f1d275c9316af7b34c4a

デバッグコードとかもそのままで分かりづらくてすみません🙏

次のようなステップで変換しています。

  1. ドキュメントのプリプロセッサをパースしてASTを構築
  2. ASTから #@since 1.8.xを探し出して削除したASTを返す
  3. 修正されたASTをソースコードに変換

次のように実行するとこの変換が実行できます

$ ruby rurema-converter.rb $(git grep -F --name-only '#@since 1.8')

この変換の結果、出力に変化がないことをrake generate statichtmlした後に、それぞれのディレクトリをdiffコマンドで比べることによって確認しています。
ただし、bitclustに問題があって差分が出てしまっていたので、その問題を直したものを取り込んだ上で確認をしています。。
詳しくは rurema/bitclust#66 に書いています。

note

ちなみに、diffが +2 になっていて増えている行があるのは、末尾に空白がある#@end があったものの空白を消したためです。基本的に空白も含めて元のコードを維持するように変換プログラムを書きましたが、ここだけ面倒でサボっていたので差分が出ています🙏

Copy link
Member

@sho-h sho-h left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bitclustの修正後に差分がないということと、LIBRARIESといくつかのファイルを見る分に気になる点がないのでいいと思いました。ありがとうございます!(消した方がいいファイルがいくつかあったのとそういえば ruby 1.7 feature な行も消せそうだとも思ったのですがそれは別途でよさそうですね

@@ -450,10 +450,8 @@ ASCIIコード順で連続する文字列は間に `-' を置いて /[a-c]/ の

先頭(あるいは否定の "^" の直後)にある "]" は、文字クラスの終りではなく
"]" そのものを表します。
#@since 1.8.0
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

この分岐削除するよりこのファイルそのものと refm/doc/spec/regexp.rd での分岐を削除したらよさそうですけど、それはまた別のPRがよさそうですね。

@@ -1,4 +1,3 @@
#@since 1.8.1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

xsd/*も1.9以降で使えないのでファイルごと削除(今後)でよさそうですね。

@sho-h sho-h merged commit 506ce00 into rurema:master Aug 18, 2019
@sho-h
Copy link
Member

sho-h commented Aug 18, 2019

この変換の結果、出力に変化がないことを rake generate statichtml した後に、それぞれのディレクトリをdiffコマンドで比べることによって確認しています。

このお話があったのでbitclustの新しいgemが出てからマージにしようかなと思ってたのですが、よく考えたら現段階で3ネストあるものが2ネストになって表示が正しくなる方向に差が現れると思ったのでマージしました。

@pocke pocke deleted the remove-since-1.8 branch August 18, 2019 14:46
@pocke
Copy link
Member Author

pocke commented Aug 18, 2019

レビューありがとうございます!🙏🙏

そういえば ruby 1.7 feature な行も消せそうだとも思ったのですがそれは別途でよさそうですね

おー、そんな記述もあったんですね。確かに消せそうです:+1:


1.8 向けのドキュメントも全部バッサリ切るなら色々できそうですね。。

このお話があったのでbitclustの新しいgemが出てからマージにしようかなと思ってたのですが、よく考えたら現段階で3ネストあるものが2ネストになって表示が正しくなる方向に差が現れると思ったのでマージしました。

その通りで、このPRで表示が正しくなる方に変わるはずです。その辺ちゃんと説明しておけばよかったですね🙏

@sho-h
Copy link
Member

sho-h commented Aug 19, 2019

ruby 1.7 feature は確認したところ、表示されてるものはもうあまりなかったので、それほど気にしなくてもいいかもしれません。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants