Skip to content

Latest commit

 

History

History
180 lines (139 loc) · 18.8 KB

design.md

File metadata and controls

180 lines (139 loc) · 18.8 KB

日本語モードの基本設計(標準の形)

🆕 Smalruby 独自 — upstream に存在しない、Smalruby のために新規追加された機能

方針は policy.md。この文書は、その方針をどう画面と変換に落とすかを決めたもの。

1. 日本語タブを Ruby とは別にする

日本語は「Ruby の表し方の 1 つ」ではなく、別の言葉として扱う。

  • 新しく 日本語タブ を作る。ルビータブにある「日本語」ボタンは外し、ルビータブは ふりがな・Ruby の 2 つにする。
  • 日本語タブからルビータブに移ったときは、いまと同じく Ruby で見える(自動で Ruby になるのは変えない)。
  • Ruby とちがう言葉であることを、見た目で伝える:
    • タブの色: 日本語は緑、ルビーは赤。
    • エディタの上の帯: 「日本語(共通テスト用プログラム表記)」のように言葉の名前を出す。
    • エディタの地: 淡い紙の色。行番号は (01) の形(ルビーは 1, 2, 3)。
  • 日本語タブにいるあいだは、コードタブのブロックを日本語で書けるものに絞る(いまの日本語モードと同じ)。 日本語タブから離れたら戻す。

2. テキストと見た目を分ける

試験のプログラムは、行番号と、左の縦線・L 字の罫線が付いた形で示される。この形をそのまま テキストとして書かせると、1 行足すたびに行番号を振り直し、| や ⎿ を手で打つことになり、 読む練習の前に入力でつまずく。そこで、2 つの層に分ける。

層 中身
テキスト(人が書くもの・エディタに入っている文字) 字下げと、見出しの行の終わりの : でブロックを表す。行番号と罫線は書かない
問題の形(エディタが描く見た目) 行番号 (01) を行の左に、縦線と L 字を字下げの位置に描く。公式の新しい年度の問題と同じに見える

書くときと眺めるときの切りかえ

  • エディタにフォーカスがあるあいだは、全体を テキスト で見せる。半角の空白で字下げして、そのまま打てる。
  • フォーカスを外すか、「できた」ボタンを押すと、全体を 問題の形 で見せる。
  • 理想は「いまの行だけテキスト、ほかの行は問題の形」だが、実装が難しいので、まずは全体の切りかえにする。

コピーと貼り付け

  • コピーは 2 通り: テキストのまま/問題の形(行番号と罫線を文字で付けた形)。
  • 貼り付けはなるべく広く受け付ける。貼り付けた内容を調べて、テキストの形(字下げ + :)に直して取り込む。 いろいろなところ(問題の PDF・Web・教材)から気軽に写して動かせるようにする。
    • 行番号: (01) (1) ( 1 ) 01、無し
    • 罫線: | │ | ⎿ └ L、字下げだけ
    • 全角の記号・空白、: ,、「…」 の文字列
    • 冒頭の説明文(前提の文): 「配列の添字は 1 から始まる」などを見つけたら、設定として取り込む(4 章)
    • 取り込めない行は、どの行が取り込めなかったかを示す

3. 記法ごとの書き方

「書く」はブロックや Ruby から日本語にするときに出す形、「読む」は受け付ける形。根拠は方針の決め方の番号(① 例題、 ② 例題に無いものは DNCL の言葉と例題の見た目、③ 揺れは新しい年度・DNCL、④ DNCL か Ruby に近いもの、⑤ 非公式の多数派か Ruby)。

| 記法 | 書く | 読む(受け付ける) | 根拠 | | ---------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------- | ---------------------------- | --- | | 行番号 | テキストには書かない。問題の形で (01) | (01) (1) ( 1 ) 無し | ① 新しい年度は (01) | | ブロック | 字下げ(テキストは空白 4 つ)。問題の形で縦線と L 字 | 字下げだけ、| ⎿ │ | └ | ① | | if/else の閉じ方 | 問題の形: 最後の枝だけ L 字。途中の枝は縦線のまま そうでなければ: で区切る | 枝ごとの L 字も読む | ① 例示・R7 追試 | | 開始の記号 | 半角 : | : :、無し(DNCL 風の形) | ① | | 代入 | =。1 行に複数の代入は , | , , | ① | | 表示 | 表示する(a, b) | 表示する(…)、, の後の空白の有無 | ① 新しい年度は , | | 入力 | 答えをそのまま使うときは 【外部からの入力】、整数にするときは 【整数を入力】 | 【外部からの入力】 【整数を入力】 【文字列を入力】 | ①・③ | | 算術 | + - * /、商 ÷、余り %(全角)、べき乗 ** | 半角 %、全角 + − ×、引き算の − – | ① 公式の説明は全角 % | | 比較 | == != < > <= >= | ≠ ≧ ≦ < > | ① | | 論理 | いつも and or not | かつ または でない(DNCL 風の形) | ① | | 分岐 | もし 条件 ならば: / そうでなくもし 条件 ならば: / そうでなければ: | DNCL 風の を実行する | ①(そうでなくもし は例示) | | 数える繰り返し | i を 1 から n まで 1 ずつ増やしながら繰り返す:(減らしながら も) | 「繰り返す」を省いた形 | ①。差分が 1 以外は ② | | 条件の繰り返し | 条件 の間繰り返す: | 「繰り返す」を省いた形 | ① | | 後判定の繰り返し | 出さない(ブロックに後判定が無い) | エラー | — | | 繰り返しを抜ける | 出さない(ブロックに無い。いまもエラー) | エラー | — | | 配列 | A = [1, 2, 3]、A[i]。添字の始まりは設定 | [ ] | ① | | 2 次元配列 | 出さない(Scratch のリストは 1 次元) | エラー | — | | 要素数 | 要素数(A) | — | ① | | 要素の追加 | A に 値 を追加する(最後に足す) | — | ⑤ | | 関数の定義 | 関数 名前(引数): と字下げ。と定義する の行は置かない | DNCL 風の と定義する | ② | | 戻り値 | 値 を返す | — | ⑤ | | コメント | 設定(既定 #) | #、設定が // のときは // | ① 例示 | | 文字列 | "…" | 「…」 '…' | ① | | 変数名 | ブロックの名前のまま(日本語の名前も) | いまと同じ | — |

DNCL 風の形

  • いまの「DNCL 風の形」(を実行する・かつ など)は、読み込み(貼り付け)だけ残す。表示は標準の形だけにする。
  • 既存の教材や、DNCL 風で写したプログラムを貼っても動く。

4. 設定と冒頭の説明文

設定にするのは、意味が変わるもの・問題文で約束されるものだけ(方針)。

設定 選べる値 既定 冒頭の説明文(公式の問題文の型)
添字の始まり 0 から / 1 から 0 から(例示の既定) すべての配列の添字は 0 から始まる。
コメントの記号 # / // # 「#」から行の終わりまでは,処理の対象とならない。
論理演算子の説明 書く / 書かない 書かない 「and」は「かつ」を意味する論理演算子であり,左右の式がともに真のときにだけ真となる。 ほか
  • 論理演算子は、書き方を変えない(いつも and / or)。設定は、問題文と同じ説明を冒頭に置くかどうかだけ。
  • // をコメントにしたときは、// を整数の商に使えない(商は ÷)。

設定は冒頭の説明文そのものから読む

  • 冒頭の説明文は、そのプログラムのコメントの行として書く。例(添字 1 から・#):

    # すべての配列の添字は 1 から始まる。
    # 「and」は「かつ」を意味する論理演算子であり,左右の式がともに真のときにだけ真となる。
    
  • 設定を別の場所に保存しない。Ruby のコメントはブロックのコメントとして作品に残るので、ブロックに直して保存しても、 次に開いたときに同じ説明文が戻り、設定も戻る(作品ごと・スプライトごとの設定になる)。 実装の前に、この往復を確かめる。

  • 説明文が無いプログラムは、既定(例示の形)とみなす。

  • 決まった文だけを設定として読む。それ以外の文は普通のコメント。

  • 設定を変えるのは、ツールバーのメニュー(パターンを選ぶ)。選ぶと冒頭の説明文を書きかえ、プログラムをその設定で表し直す。 説明文を手で書きかえてもよい。

よくある設定のパターン

専門的でない受験者は、パターンを選ぶだけで済むようにする。

パターン 添字 コメント 論理演算子の説明
例示の形(既定) 0 から # 書かない
添字が 1 から始まる問題 1 から # 書く

添字が 1 から始まる設定の変換

  • 日本語の A[i] を Ruby の @A[i - 1] にする(ブロックのリストは 1 から数えるので、ブロックは A[i] の i 番目と同じ要素を読む)。Ruby から日本語に戻すときは - 1 を外す(@A[i - 1] → A[i]、@A[0] → A[1])。
  • いまの「貼り付け時の添字の書き換え」(1 から始まる注釈のあるテキストの添字を 1 減らす)は、設定に置きかえる。 貼り付けで注釈を見つけたら、書き換えではなく、その設定(冒頭の説明文)として取り込む。
  • 範囲外の添字の警告は、設定に合わせて判定する。

5. 拡張機能: コンソールだけを足す

拡張機能は極力作らない。日本語のプログラムは Scratch で動かし、ブロックにしたときに 「Scratch ではこう表すのか」が分かることに価値がある。配列・÷・関数の値などは、いまのブロックで表す。

ただし 表示 と 入力 だけは問題がある。Scratch には「キャラクターが言う」「聞いて待つ」しかないが、 Ruby や日本語のプログラムの 表示する は、キャラクターの吹き出しではなくコンソールへの出力を意味する。 そこで、コンソール拡張機能 を 1 つだけ足す。

  • ブロック: 表示する(コンソールに 1 行出す)と 入力する(コンソールで答えを受け取る)。 【外部からの入力】 と 【整数を入力】 はこの入力ブロックで表す(整数にするときは整数にするブロックと組み合わせる)。
  • 画面: ステージの上にコンソールボタンを置き、押すとステージがコンソールに切りかわる。
    • 日本語のプログラムではキャラクターをそもそも動かさないので、日本語タブではステージがコンソールになるのが最善。
    • 「聞いて待つ」もコンソールの入力として振る舞う。
  • コンソールでのやりとりを主にするのは日本語タブだけ。Ruby の puts / gets はコンソールのブロックに対応させない。 Ruby タブは Scratch の部分集合(Scratch でできることを Ruby で書く)なので、コンソールのブロックを Ruby で書く形は足さない。
    • 将来の案: Ruby タブに「コンソールモード」のような切りかえを置き、そのときだけ puts / gets がコンソールを使う。いまは作らない。

要素の追加

  • 日本語の A に 値 を追加する で書けるようにする。
  • ブロックは、Scratch の基本のブロック 「(値) を (A) に追加する」(data_addtolist)で表す。拡張機能は使わない。
    • Ruby の A.push(値) / A << 値 もこのブロックになるので、日本語・ブロック・Ruby の 3 つがそろう。
    • 先頭に足す書き方は、例題に無いので足さない(要るときは基本のブロック「(1) 番目に挿入する」で表せる)。

6. いまの形からの移り方

  1. 読み込みは、標準の形と DNCL 風の形の両方を受け付けたまま、書き出しを標準の形に切り替える。
    • 作品はブロックとして保存されているので、表示の形を変えても作品は壊れない(日本語のテキストは保存していない)。
  2. 生成AI に相談の質問文・答えの形を標準の形にする。
  3. 教材・docs(docs/smalruby-dncl-spec.ja.md、docs/dncl/README.md、レッスン)を書きかえる。
  4. DNCL 風の形は、読み込みだけ残す(貼り付け・既存の教材が動く)。

7. 作る順番(実装の sub-issue)

順 中身 支える読み方
1 日本語タブ: ルビータブから日本語ボタンを外し、新しいタブにする。緑の帯・紙の色、ブロックの絞り込み —
2 書き出しを標準の形にする(字下げ + :、and / or、そうでなくもし、表示する(a, b)、%、入力の書き分け など) ①
3 問題の形の見た目: 行番号 (01) と罫線を描く。フォーカスと「できた」ボタンで切りかえ。エラーや説明を行番号で出す。問題の形でコピー ①・②
4 貼り付けを広く受け付ける(行番号・罫線・全角・前提の文) ①
5 冒頭の説明文と設定(添字・コメント・論理演算子の説明)、パターンを選ぶメニュー、添字が 1 から始まる設定の変換 —
6 コンソール拡張機能(表示する・入力する、ステージのコンソールボタン) —
7 要素の追加(日本語の を追加する を基本のブロック「リストに追加する」にする) —
8 生成AI に相談・教材・docs の切り替え —
9 トレース(変数の値の変化)と実行回数(別の EPIC にする見込み) ③・④
  • テストと教材には、センターの問題ではなく、記法をまねた自作のプログラムを使う。