{"action":"created","issue":{"url":"https://api.github.com/repos/osyo-manga/vital-over/issues/128","labels_url":"https://api.github.com/repos/osyo-manga/vital-over/issues/128/labels{/name}","comments_url":"https://api.github.com/repos/osyo-manga/vital-over/issues/128/comments","events_url":"https://api.github.com/repos/osyo-manga/vital-over/issues/128/events","html_url":"https://github.com/osyo-manga/vital-over/issues/128","id":68919505,"number":128,"title":"Base オブジェクトの要素名の仕様を決める","user":{"login":"osyo-manga","id":214488,"avatar_url":"https://avatars.githubusercontent.com/u/214488?v=3","gravatar_id":"","url":"https://api.github.com/users/osyo-manga","html_url":"https://github.com/osyo-manga","followers_url":"https://api.github.com/users/osyo-manga/followers","following_url":"https://api.github.com/users/osyo-manga/following{/other_user}","gists_url":"https://api.github.com/users/osyo-manga/gists{/gist_id}","starred_url":"https://api.github.com/users/osyo-manga/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/osyo-manga/subscriptions","organizations_url":"https://api.github.com/users/osyo-manga/orgs","repos_url":"https://api.github.com/users/osyo-manga/repos","events_url":"https://api.github.com/users/osyo-manga/events{/privacy}","received_events_url":"https://api.github.com/users/osyo-manga/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-04-16T13:05:39Z","updated_at":"2015-04-16T13:28:23Z","closed_at":null,"body":"ユーザ側で Base オブジェクトを拡張したい場合に仕様が曖昧だったので決めたいと思います。\r\n\r\n#### 問題点\r\n\r\nユーザ側で定義した要素が、将来的に Base オブジェクト側で定義される可能性がある。\r\n\r\n```vim\r\nlet s:cmdline = s:Commandline.make_standard(\"Input:> \")\r\n\" もしかしたらすでに is_exit() が定義されているかもしれない\r\nlet s:cmdline.is_exit = 0\r\n```\r\n\r\nこれを回避するために『○○○から始まる名前の要素は Base オブジェクトでは定義されない』みたいな仕様を決めたい。\r\n\r\n#### Base オブジェクトが持つ要素の種類\r\n\r\nBase オブジェクトで定義する要素は大まかにわけて以下のものがあると思います。\r\n\r\n* 関数参照や変数（`s:base.start()` や `s:base.variables` など）\r\n* ユーザ側から拡張される可能性のある関数（`on_leave()` など）\r\n\r\n#### 案\r\n\r\n次のような命名規則を決めようかと考えています。\r\n\r\n* `_` + 英数字から始まる要素は Base オブジェクトで定義されないことを保証する\r\n * e.g. `_is_exit`\r\n* 両端に `__` が付いてる、もしくは `on_` から始まる関数はユーザ側で拡張されることを想定している\r\n * `__execute__()` や `on_leave()`\r\n* それ以外の名前をユーザ側で定義した場合に動作を保証しない\r\n\r\n要約すると Base オブジェクト側で `_xxx` みたいな名前を使わないことを保証することで、ユーザ側は安全に変数を定義することができるという感じにしたいと考えています。\r\nまた、`__xxx__` みたいな関数は Base オブジェクトの処理を拡張したい事が結構あったので新しく追加しようかと考えています。\r\n\r\n#### 新しい書き方のイメージ\r\n\r\n```vim\r\nlet s:cmdline = s:Commandline.make_standard(\"/\")\r\n\r\n\" ユーザ側で使いたい変数は _ からはじめる\r\nlet s:cmdline._hoge = 10\r\nlet s:cmdline._foo  = \"bar\"\r\n\r\n\" 実行時の処理を拡張する関数\r\nfunction! s:cmdline.__execute__(command)\r\n\texecute \"/\" . a:command\r\nendfunction\r\n\r\n\" 内部で __execute__ が呼ばれる\r\ncall s:cmdline.execute(\"search_word\")\r\n\r\n```\r\n\r\nこの仕様で問題なさそうであれば適当なタイミングで書き直したいと思います。\r\n"},"comment":{"url":"https://api.github.com/repos/osyo-manga/vital-over/issues/comments/93733933","html_url":"https://github.com/osyo-manga/vital-over/issues/128#issuecomment-93733933","issue_url":"https://api.github.com/repos/osyo-manga/vital-over/issues/128","id":93733933,"user":{"login":"haya14busa","id":3797062,"avatar_url":"https://avatars.githubusercontent.com/u/3797062?v=3","gravatar_id":"","url":"https://api.github.com/users/haya14busa","html_url":"https://github.com/haya14busa","followers_url":"https://api.github.com/users/haya14busa/followers","following_url":"https://api.github.com/users/haya14busa/following{/other_user}","gists_url":"https://api.github.com/users/haya14busa/gists{/gist_id}","starred_url":"https://api.github.com/users/haya14busa/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/haya14busa/subscriptions","organizations_url":"https://api.github.com/users/haya14busa/orgs","repos_url":"https://api.github.com/users/haya14busa/repos","events_url":"https://api.github.com/users/haya14busa/events{/privacy}","received_events_url":"https://api.github.com/users/haya14busa/received_events","type":"User","site_admin":false},"created_at":"2015-04-16T13:28:23Z","updated_at":"2015-04-16T13:28:23Z","body":"ふむふむ，見た感じは便利そうだしその仕様でよさ気だと思います．一瞬vital-over側で`_`始まりのヘルパー関数定義しずらくなるかなと思いましたが開発の仕方の問題っぽいですし問題なさそう"}}