gh-diff 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57381a1e6b18fb6aee1e3d881b2324f1be6ee15e
+  data.tar.gz: 2120094ff604d63f3aa8ac071316b3dda1abb3cb
+SHA512:
+  metadata.gz: cf9cc0e90cde40fdcfc5074fdad3e20c58d576a42356dfc18f653837915aa2711cee81388b47b343217a0c0cf0a45e2f75d132b98735c463645fb7036e11d04b
+  data.tar.gz: 2dc8e5c0340c7d36e145b09a6db08098cc9931d58ebde0b6ed2c5448a05ddc9d135a80132ae4cffb445e6acaf3599dc4b992f11297bb2e6adfe71279e652731e

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.env
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gh-diff.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 kyoendo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.ja.md

@@ -0,0 +1,298 @@
+# Gh-Diff
+
+<!--original
+# Gh-Diff
+-->
+
+`Gh-Diff`は、ローカルとGitHubリポジトリのファイルの差分を取ります。
+
+<!--original
+Take diffs between local and a github repository files.
+-->
+
+## インストール
+
+<!--original
+## Installation
+-->
+
+アプリケーションのGemfileに以下を追加します。
+
+<!--original
+Add this line to your application's Gemfile:
+-->
+
+    gem 'gh-diff'
+
+
+<!--original
+    gem 'gh-diff'
+
+-->
+
+そして以下を実行します。
+
+<!--original
+And then execute:
+-->
+
+    $ bundle
+
+
+<!--original
+    $ bundle
+
+-->
+
+または、自身で次のようにインストールします。
+
+<!--original
+Or install it yourself as:
+-->
+
+    $ gem install gh-diff
+
+
+<!--original
+    $ gem install gh-diff
+
+-->
+
+## 利用方法
+
+<!--original
+## Usage
+-->
+
+Gh-Diffには`gh-diff`というターミナルコマンドが付いています。
+
+<!--original
+Gh-Diff have `gh-diff` terminal command.
+-->
+
+```bash
+% gh-diff
+Commands:
+  gh-diff diff LOCAL_FILE [REMOTE_FILE]  # Compare FILE(s) between local and remote repository. LOCAL_FILE can be DIRECTORY.
+  gh-diff dir_diff DIRECTORY  # Print added and removed files in remote repository
+  gh-diff get FILE            # Get FILE content from github repository
+  gh-diff help [COMMAND]      # Describe available commands or one specific command
+
+Options:
+  -g, [--repo=REPO]          # target repository
+  -r, [--revision=REVISION]  # target revision
+                             # Default: master
+  -p, [--dir=DIR]            # target file directory
+      [--username=USERNAME]  # github username
+      [--password=PASSWORD]  # github password
+      [--token=TOKEN]        # github API access token
+```
+
+<!--original
+```bash
+% gh-diff
+Commands:
+  gh-diff diff LOCAL\_FILE [REMOTE\_FILE]  # Compare FILE(s) between local and remote repository. LOCAL_FILE can be DIRECTORY.
+  gh-diff dir_diff DIRECTORY  # Print added and removed files in remote repository
+  gh-diff get FILE            # Get FILE content from github repository
+  gh-diff help [COMMAND]      # Describe available commands or one specific command
+
+Options:
+  -g, [--repo=REPO]          # target repository
+  -r, [--revision=REVISION]  # target revision
+                             # Default: master
+  -p, [--dir=DIR]            # target file directory
+      [--username=USERNAME]  # github username
+      [--password=PASSWORD]  # github password
+      [--token=TOKEN]        # github API access token
+```
+-->
+
+'melborne/tildoc'レポジトリの`README.md`を比較するには、こうします。
+
+<!--original
+To take diff of `README.md` for 'melborne/tildoc' repo, do this;
+-->
+
+```bash
+% gh-diff diff README.md --repo=melborne/tildoc
+Diff found on README.md <-> README.md [6147df8:master]
+```
+
+<!--original
+```bash
+% gh-diff diff README.md --repo=melborne/tildoc
+Diff found on README.md <-> README.md [6147df8:master]
+```
+-->
+
+`--name_only`オプションをfalseにセットすれば、その差分がプリントアウトされます。
+
+<!--original
+By setting `--name_only` option false, the diff will be print out.
+-->
+
+```bash
+% gh-diff diff README.md --repo=melborne/tildoc --no-name_only
+Base revision: 6147df8378545a4807a2ed73c9e55f8d7204c14c[refs/heads/master]
+--- README.md
++++ README.md
+
+
+ Add String#~ for removing leading margins of heredocs.
+
+-Added this line to local.
+-
+ ## Installation
+
+ Add this line to your application's Gemfile:
+```
+
+<!--original
+```bash
+% gh-diff diff README.md --repo=melborne/tildoc --no-name_only
+Base revision: 6147df8378545a4807a2ed73c9e55f8d7204c14c[refs/heads/master]
+--- README.md
++++ README.md
+
+
+ Add String#~ for removing leading margins of heredocs.
+
+-Added this line to local.
+-
+ ## Installation
+
+ Add this line to your application's Gemfile:
+```
+-->
+
+差分の結果を保存する場合は、`--save`オプションをdiffコマンドに追加します。
+
+<!--original
+To save the result of diff, put `--save` option to diff command.
+-->
+
+### 翻訳などのプロジェクトのために
+
+<!--original
+### For Translation-like project
+-->
+
+HTMLコメントタグを使って原文が挿入された翻訳ファイルがあり、この原文とリモートのオリジナルとを比較したい場合には、`commentout`オプションが役立つでしょう。
+
+<!--original
+If you have translated files in which original text inserted with
+html comment tags, and want to compare the original with the remote,
+`commentout` option helps you.
+-->
+
+    % gh-diff diff README.ja.md README.md --commentout
+
+
+<!--original
+    % gh-diff diff README.ja.md README.md --commentout
+
+-->
+
+これは、`README.ja.md`からコメントテキストを抽出し、リモートの`README.md`と比較します。
+
+<!--original
+This extract commented text in `README.ja.md`, then compare it with remote `README.md`.
+-->
+
+より詳細は`gh-diff help diff`を見てください。
+
+<!--original
+See `gh-diff help diff` for more info.
+-->
+
+### 環境変数ENVにおけるオプション
+
+<!--original
+### Options in ENV
+-->
+
+これらのオプションは、接頭辞`GH_`を使って環境変数にプリセットできます。
+
+<!--original
+These options can be preset as ENV variables with prefix `GH_`
+-->
+
+    % export GH_USERNAME=melborne
+    % export GH_PASSWORD=xxxxxxxx
+    % export GH_TOKEN=1234abcd5678efgh
+
+
+<!--original
+    % export GH_USERNAME=melborne
+    % export GH_PASSWORD=xxxxxxxx
+    % export GH_TOKEN=1234abcd5678efgh
+
+-->
+
+また、プロジェクトルートの`.env`ファイルに設定することもできます。
+
+<!--original
+Also, you can set them in `.env` file in the root of your project.
+-->
+
+    #.env
+    REPO=jekyll/jekyll
+    DIR=site
+
+
+<!--original
+    #.env
+    REPO=jekyll/jekyll
+    DIR=site
+
+-->
+
+`.env`の環境変数は、`GH_`で始まるグローバル環境変数を上書きします。
+
+<!--original
+ENVs in `.env` overwrite global ENVs with prefix `GH_`.
+-->
+
+GitHub APIにはアクセス制限があります。ベーシック認証（usernameとpassword）または[個人用のAPIトークン](https://github.com/blog/1509-personal-api-tokens "Personal API tokens")でこれを引き上げることができるので、それらを設定するとよいでしょう。
+
+<!--original
+There is rate limit for accessing GitHub API. While you can make it
+up with Basic Authentication(username and password) or [Personal API tokens](https://github.com/blog/1509-personal-api-tokens "Personal API tokens"), 
+setting them are preferable.
+-->
+
+## 感謝
+
+<!--original
+## Thank you
+-->
+
+`Gh-Diff`は[jekyllrb-ja](https://github.com/jekyllrb-ja/jekyllrb-ja.github.io)プロジェクトという、[Jekyllサイト](http://jekyllrb.com/)の日本語版の提供を目的としたプロジェクトで生まれました。`Gh-Diff`の基本的なアイディアはこのプロジェクトのRakefileの中にある`togglate task`から来ており、これはgosyujin(kk_Ataka)により作られました。彼に感謝します。
+
+<!--original
+`Gh-Diff` is born through [jekyllrb-ja](https://github.com/jekyllrb-ja/jekyllrb-ja.github.io) project,
+whose aim is to provide a [Jekyll site](http://jekyllrb.com/) in Japanese.
+The basic idea of `Gh-Diff` is from `togglate task in Rakefile` of the project
+which is created by gosyujin(kk_Ataka). I want to thank him.
+-->
+
+## 貢献
+
+<!--original
+## Contributing
+-->
+
+1. Fork it ( https://github.com/[my-github-username]/gh-diff/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+<!--original
+1. Fork it ( https://github.com/[my-github-username]/gh-diff/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+-->

data/README.md

@@ -0,0 +1,113 @@
+# Gh-Diff
+
+Take diffs between local and a github repository files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gh-diff'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gh-diff
+
+## Usage
+
+Gh-Diff have `gh-diff` terminal command.
+
+```bash
+% gh-diff
+Commands:
+  gh-diff diff LOCAL_FILE [REMOTE_FILE]  # Compare FILE(s) between local and remote repository. LOCAL_FILE can be DIRECTORY.
+  gh-diff dir_diff DIRECTORY  # Print added and removed files in remote repository
+  gh-diff get FILE            # Get FILE content from github repository
+  gh-diff help [COMMAND]      # Describe available commands or one specific command
+
+Options:
+  -g, [--repo=REPO]          # target repository
+  -r, [--revision=REVISION]  # target revision
+                             # Default: master
+  -p, [--dir=DIR]            # target file directory
+      [--username=USERNAME]  # github username
+      [--password=PASSWORD]  # github password
+      [--token=TOKEN]        # github API access token
+```
+
+To take diff of `README.md` for 'melborne/tildoc' repo, do this;
+
+```bash
+% gh-diff diff README.md --repo=melborne/tildoc
+Diff found on README.md <-> README.md [6147df8:master]
+```
+
+By setting `--name_only` option false, the diff will be print out.
+
+```bash
+% gh-diff diff README.md --repo=melborne/tildoc --no-name_only
+Base revision: 6147df8378545a4807a2ed73c9e55f8d7204c14c[refs/heads/master]
+--- README.md
++++ README.md
+
+
+ Add String#~ for removing leading margins of heredocs.
+
+-Added this line to local.
+-
+ ## Installation
+
+ Add this line to your application's Gemfile:
+```
+
+To save the result of diff, put `--save` option to diff command.
+
+### For Translation-like project
+
+If you have translated files in which original text inserted with
+html comment tags, and want to compare the original with the remote,
+`commentout` option helps you.
+
+    % gh-diff diff README.ja.md README.md --commentout
+
+This extract commented text in `README.ja.md`, then compare it with remote `README.md`.
+
+See `gh-diff help diff` for more info.
+
+### Options in ENV
+
+These options can be preset as ENV variables with prefix `GH_`
+
+    % export GH_USERNAME=melborne
+    % export GH_PASSWORD=xxxxxxxx
+    % export GH_TOKEN=1234abcd5678efgh
+
+Also, you can set them in `.env` file in the root of your project.
+
+    #.env
+    REPO=jekyll/jekyll
+    DIR=site
+
+ENVs in `.env` overwrite global ENVs with prefix `GH_`.
+
+There is rate limit for accessing GitHub API. While you can make it
+up with Basic Authentication(username and password) or [Personal API tokens](https://github.com/blog/1509-personal-api-tokens "Personal API tokens"), 
+setting them are preferable.
+
+## Thank you
+
+`Gh-Diff` is born through [jekyllrb-ja](https://github.com/jekyllrb-ja/jekyllrb-ja.github.io) project,
+whose aim is to provide a [Jekyll site](http://jekyllrb.com/) in Japanese.
+The basic idea of `Gh-Diff` is from `togglate task in Rakefile` of the project
+which is created by gosyujin(kk_Ataka). I want to thank him.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/gh-diff/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request