2015/01/13


今まで golang で変数名や関数名のリネームには gofmt の -r オプションを使ってきましたが、これからは gorename を使いましょう。

文法を解析して正しくリネームしてくれるので、gofmt で起き得た誤爆も心配ありません。インストールは以下の様に実行します。

$ go get golang.org/x/tools/cmd/gorename

使用方法は以下の通り。

gorename: precise type-safe renaming of identifiers in Go source code.

Usage:

 gorename (-from <spec> | -offset <file>:#<byte-offset>) -to <name> [-force]

You must specify the object (named entity) to rename using the -offset
or -from flag.  Exactly one must be specified.

Flags:

-offset    specifies the filename and byte offset of an identifier to rename.
           This form is intended for use by text editors.

-from      specifies the object to rename using a query notation;
           This form is intended for interactive use at the command line.
           A legal -from query has one of the following forms:

  "encoding/json".Decoder.Decode        method of package-level named type
  (*"encoding/json".Decoder).Decode     ditto, alternative syntax
  "encoding/json".Decoder.buf           field of package-level named struct type
  "encoding/json".HTMLEscape            package member (const, func, var, type)
  "encoding/json".Decoder.Decode::x     local object x within a method
  "encoding/json".HTMLEscape::x         local object x within a function
  "encoding/json"::x                    object x anywhere within a package
  json.go::x                            object x within file json.go

           For methods, the parens and '*' on the receiver type are both
           optional.

           Double-quotes may be omitted for single-segment import paths
           such as fmt.  They may need to be escaped when writing a
           shell command.

           It is an error if one of the ::x queries matches multiple
           objects.

-to        the new name.

-force     causes the renaming to proceed even if conflicts were reported.
           The resulting program may be ill-formed, or experience a change
           in behaviour.

           WARNING: this flag may even cause the renaming tool to crash.
           (In due course this bug will be fixed by moving certain
           analyses into the type-checker.)

-dryrun    causes the tool to report conflicts but not update any files.

-v         enables verbose logging.

gorename automatically computes the set of packages that might be
affected.  For a local renaming, this is just the package specified by
-from or -offset, but for a potentially exported name, gorename scans
the workspace ($GOROOT and $GOPATH).

gorename rejects renamings of concrete methods that would change the
assignability relation between types and interfaces.  If the interface
change was intentional, initiate the renaming at the interface method.

gorename rejects any renaming that would create a conflict at the point
of declaration, or a reference conflict (ambiguity or shadowing), or
anything else that could cause the resulting program not to compile.


Examples:

% gorename -offset file.go:#123 -to foo

  Rename the object whose identifier is at byte offset 123 within file file.go.

% gorename -from '"bytes".Buffer.Len' -to Size

  Rename the "Len" method of the *bytes.Buffer type to "Size".

---- TODO ----

Correctness:
- handle dot imports correctly
- document limitations (reflection, 'implements' algorithm).
- sketch a proof of exhaustiveness.

Features:
- support running on packages specified as *.go files on the command line
- support running on programs containing errors (loader.Config.AllowErrors)
- allow users to specify a scope other than "global" (to avoid being
  stuck by neglected packages in $GOPATH that don't build).
- support renaming the package clause (no object)
- support renaming an import path (no ident or object)
  (requires filesystem + SCM updates).
- detect and reject edits to autogenerated files (cgo, protobufs)
  and optionally $GOROOT packages.
- report all conflicts, or at least all qualitatively distinct ones.
  Sometimes we stop to avoid redundancy, but
  it may give a disproportionate sense of safety in -force mode.
- support renaming all instances of a pattern, e.g.
  all receiver vars of a given type,
  all local variables of a given type,
  all PkgNames for a given package.
- emit JSON output for other editors and tools.

go-runewidth で試してみます。

https://github.com/mattn/go-runewidth/blob/master/runewidth.go#L192-L199

runewidth パッケージの、IsAmbiguousWidth という関数の中にある、iv という変数名を ヒノノニトン にリネームしたいと思います。

$ gorename -from '"github.com/mattn/go-runewidth".IsAmbiguousWidth::iv' -to ヒノノニトン

Windows だと以下の様に実行します。

gorename -from """github.com/mattn/go-runewidth""".IsAmbiguousWidth::iv -to ヒノノニトン

git diff を見ると

diff --git a/runewidth.go b/runewidth.go
index 1050395..5f2c1b0 100644
--- a/runewidth.go
+++ b/runewidth.go
@@ -190,8 +190,8 @@ func RuneWidth(r rune) int {
 
 // IsAmbiguousWidth returns whether is ambiguous width or not.
 func IsAmbiguousWidth(r rune) bool {
-   for _, iv := range ambiguous {
-       if iv.first <= r && r <= iv.last {
+   for _, ヒノノニトン := range ambiguous {
+       if ヒノノニトン.first <= r && r <= ヒノノニトン.last {
            return true
        }
    }

正しくリネームされているのが分かります。この他にも、構造体のメンバ名、関数名、メソッド名、ローカル変数名を置換出来るだけでなく、ファイル名を指定し、かつオフセット位置を指定して、「ここにある何か」という指定方法も出来る為、今後 IDE との連携により一層便利になるのではないかと思います。

Posted at by



2014/12/15


この記事は Go Advent Calendar 2014 16日の記事ではありません
docomo Developer support | NTTドコモ

Docomo が公開する API など開発者向けの情報を提供します。アプリケーションの開発にご活用ください

https://dev.smt.docomo.ne.jp/
DocomoruでBOTと雑に会話する - Qiita

docomoが提供している雑談対話APIを利用し...

http://qiita.com/r7kamura/items/55f398624dbce1c6dc14

DoCoMo が雑談対話APIというのを出していたのでサクッっとlingr botを書いてみた。

mattn/go-docomo - GitHub
https://github.com/mattn/go-docomo

lingr の vim 部屋上に vimgirl という名前の bot として動いています。

Vimgirl lingrbot

Vimgirl lingrbot これは これは、NTT DoCoMo が提供する雑談対話 API を利用して実装されたチャットサービス lingr の bot です。

http://mattn.tonic-water.com/vimgirl/

キャラクタは orgachem さんが描いている絵を使わせて頂きました。(CC BY)

vimgirl: こんにちわ この様に vimgirl: のプレフィックスを付けて会話すると
vimgirl

適当な会話をしてくれます。ご活用下さい。

Posted at by



2014/12/08


GoLangでJavaのenumっぽいライブラリ作った話 - おいぬま日報

なんとかなるわけなんだけど、これを毎回書くのは面倒なので...

もっと良いやり方があったらぜひ教えて欲しいところです。

http://oinume.hatenablog.com/entry/introducing-goenum

golang でユーザ型の値を文字列化する場合 Stringer というインタフェースを実装します。具体的には

func (l Lang) String() string {
    switch l {
    case Go:
        return "Go"
    case Python:
        return "Python"
    case Ruby:
        return "Ruby"
    }
    panic("Unknown value")
}

上記サイトで書かれている様に String() という関数を実装します。実は golang のオフィシャルから stringer という、その名の通りのツールが提供されています。

まず、Stringer を実装していないコードを書きます。

package main

import (
    "fmt"
)

type Fruit int

const (
    Apple Fruit = iota
    Orange
    Banana
)

func main() {
    var fruit Fruit = Apple
    fmt.Println(fruit)
}

このまま実行すると 0 と表示されます。ここで以下の様にして stringer というツールをインストールします。

$ go get golang.org/x/tools/cmd/stringer

そしてソースコードと同じディレクトリで以下の様に実行します。

$ stringer -type Fruit fruit.go

すると fruit_string.go というファイル名の以下のコードが生成されます。

// generated by stringer -type Fruit fruit.go; DO NOT EDIT

package main

import "fmt"

const _Fruit_name = "AppleOrangeBanana"

var _Fruit_index = [...]uint8{51117}

func (i Fruit) String() string {
    if i < 0 || i >= Fruit(len(_Fruit_index)) {
        return fmt.Sprintf("Fruit(%d)", i)
    }
    hi := _Fruit_index[i]
    lo := uint8(0)
    if i > 0 {
        lo = _Fruit_index[i-1]
    }
    return _Fruit_name[lo:hi]
}

あとはこのソースも含めてビルドし、再度実行してみると今度は Apple と表示される様になります。便利ですね。

尚、const で iota を使う場合ですが、上記の様に型を指定しておくと違う型の変数へ Apple を代入する際にエラーが出て便利です。

package main

import (
    "fmt"
)

type Fruit int
type Animal int

const (
    Apple Fruit = iota
    Orange
    Banana
)

const (
    Monkey Animal = iota
    Elephant
    Pig
)

func main() {
    var fruit Fruit = Apple
    fmt.Println(fruit)

    fruit = Elephant
    fmt.Println(fruit)
}
./fruit.go:26: cannot use Elephant (type Animal) as type Fruit in assignment
Posted at by