gh-diff 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a06727c1dc58fa3d5a219d7b2f6f720f8d0cec2
-  data.tar.gz: 004961bbb8b9e19793d79b5e3bfef515289c97e5
+  metadata.gz: a745e31a129cad4e300637e38f2f5f7fa1b76a16
+  data.tar.gz: 874b614d0be82a3e9ca16af514489c57936b6c1c
 SHA512:
-  metadata.gz: 1ea9453e4b55cabb64dd3f819601d29d0e9e1bb0182086b6e7bd9969ef663ac6d25c55460434d88e23ea2c3eb723022b1be0871de23cb0da81af16251bfceeca
-  data.tar.gz: c322447f5a99d1f35e6299e2055454d7c1548032c4b0cd16666d90a2adb240e41408edac92727d34b9de1ebf5a1841ccb28a2637ed3c8d506bcee135412f7245
+  metadata.gz: 0193890b04eebd909a04501bf5411bc51fa2fc60f06a965e5337d7fa9d80be6b029f7b952b379f2c0141fd4652f1ba86c58ca103b5c99d2cfdc35d305a513657
+  data.tar.gz: d56807813c65b3b77a8229e3294cbbbf7ac786ec3f70f58e83925d3faad209ae000e6eef6a757b294f1c4fba2c15afa283713cc588473a58eb2cbc4e80dfadf8

data/lib/gh-diff/cli.rb

@@ -32,7 +32,7 @@ module GhDiff
       gh = init_ghdiff(opts[:repo], opts[:revision], opts[:dir])
       if opts[:ref]
         ref = gh.ref(opts[:revision], repo:opts[:repo])
-        print "Base revision: #{ref[:object][:sha]}[#{ref[:ref]}]\n"
+        print ref_format(ref)
       end
       print gh.get(file)
     rescue ::Octokit::NotFound
@@ -79,12 +79,7 @@ module GhDiff
 
       diffs.each do |(f1, f2), diff|
         next if file_not_found?(f1, f2, diff)
-        header = <<-EOS
-Base revision: #{ref[:object][:sha]}[#{ref[:ref]}]
---- #{f1}
-+++ #{f2}
-
-        EOS
+        header = "#{ref_format(ref)}--- #{f1}\n+++ #{f2}\n\n"
         diff_form = "#{f1} <-> #{f2} [%s:%s]" %
                     [ref[:object][:sha][0,7], ref[:ref].match(/\w+$/).to_s]
 
@@ -120,6 +115,11 @@ Base revision: #{ref[:object][:sha]}[#{ref[:ref]}]
     option :save_dir,
             default:'diff',
             desc:'save directory'
+    option :ref,
+           aliases:'-f',
+           default:false,
+           type: :boolean,
+           desc:'Add reference data into YAML front-matter of a file to be saved'
     def dir_diff(dir)
       opts = Option.new(options).with_env
       github_auth(opts[:username], opts[:password], opts[:token])
@@ -136,6 +136,10 @@ Base revision: #{ref[:object][:sha]}[#{ref[:ref]}]
             added.each do |f|
               path = File.join(dir, f)
               content = gh.get(path)
+              if opts[:ref]
+                content = add_reference(gh, opts[:revision],
+                                            opts[:repo], content)
+              end
               unless content.empty?
                 save(content, opts[:save_dir], path, File.extname(path))
               end
@@ -187,6 +191,20 @@ Base revision: #{ref[:object][:sha]}[#{ref[:ref]}]
         print "\e[32mFile saved at '#{path}'\e[0m\n"
       end
 
+      def add_reference(ghdiff, revision, repo, content)
+        ref = ghdiff.ref(revision, repo:repo)
+        yfm_re = /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
+        if md = content.match(yfm_re)
+          md[1] + ref_format(ref, 'base_revision:') + md[2] + md.post_match
+        else
+          ref_format(ref) + content
+        end
+      end
+
+      def ref_format(ref, head="Base revision:")
+        "#{head} #{ref[:object][:sha]}[#{ref[:ref]}]\n"
+      end
+
       def file_not_found?(f1, f2, content)
         case content
         when :RemoteNotFound

data/lib/gh-diff/version.rb

@@ -1,3 +1,3 @@
 module GhDiff
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/cassettes/save-dir-diff-ref.yml

@@ -0,0 +1,218 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.github.com/repos/melborne/gh-diff/contents/bin?ref=master
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json
+      User-Agent:
+      - Octokit Ruby Gem 3.1.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Thu, 17 Jul 2014 01:12:52 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '57'
+      X-Ratelimit-Reset:
+      - '1405562975'
+      Cache-Control:
+      - public, max-age=60, s-maxage=60
+      Last-Modified:
+      - Sun, 06 Jul 2014 14:29:03 GMT
+      Etag:
+      - '"a98e37e86a4246a85b31e0297c2b068b"'
+      Vary:
+      - Accept
+      - Accept-Encoding
+      X-Github-Media-Type:
+      - github.v3; format=json
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - deny
+      Content-Security-Policy:
+      - default-src 'none'
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset,
+        X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Github-Request-Id:
+      - DE962F8B:18CC:D6BE1AF:53C72314
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains
+      X-Content-Type-Options:
+      - nosniff
+      X-Served-By:
+      - 971af40390ac4398fcdd45c8dab0fbe7
+    body:
+      encoding: UTF-8
+      string: '[{"name":"gh-diff","path":"bin/gh-diff","sha":"97f13c6aafe6520b33960b32c398e4c8bbeb4bf7","size":64,"url":"https://api.github.com/repos/melborne/gh-diff/contents/bin/gh-diff?ref=master","html_url":"https://github.com/melborne/gh-diff/blob/master/bin/gh-diff","git_url":"https://api.github.com/repos/melborne/gh-diff/git/blobs/97f13c6aafe6520b33960b32c398e4c8bbeb4bf7","type":"file","_links":{"self":"https://api.github.com/repos/melborne/gh-diff/contents/bin/gh-diff?ref=master","git":"https://api.github.com/repos/melborne/gh-diff/git/blobs/97f13c6aafe6520b33960b32c398e4c8bbeb4bf7","html":"https://github.com/melborne/gh-diff/blob/master/bin/gh-diff"}}]'
+    http_version: 
+  recorded_at: Thu, 17 Jul 2014 01:12:52 GMT
+- request:
+    method: get
+    uri: https://api.github.com/repos/melborne/gh-diff/contents/bin/gh-diff?ref=master
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json
+      User-Agent:
+      - Octokit Ruby Gem 3.1.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Thu, 17 Jul 2014 01:12:53 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '56'
+      X-Ratelimit-Reset:
+      - '1405562975'
+      Cache-Control:
+      - public, max-age=60, s-maxage=60
+      Last-Modified:
+      - Wed, 16 Jul 2014 01:47:46 GMT
+      Etag:
+      - '"ea0aae4ec6b8ddf249d9c8f9c21e8f90"'
+      Vary:
+      - Accept
+      - Accept-Encoding
+      X-Github-Media-Type:
+      - github.v3; format=json
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - deny
+      Content-Security-Policy:
+      - default-src 'none'
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset,
+        X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Github-Request-Id:
+      - DE962F8B:18CE:146187F4:53C72314
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains
+      X-Content-Type-Options:
+      - nosniff
+      X-Served-By:
+      - 62a1303ae95931e56e387e87d354bb24
+    body:
+      encoding: UTF-8
+      string: '{"name":"gh-diff","path":"bin/gh-diff","sha":"97f13c6aafe6520b33960b32c398e4c8bbeb4bf7","size":64,"url":"https://api.github.com/repos/melborne/gh-diff/contents/bin/gh-diff?ref=master","html_url":"https://github.com/melborne/gh-diff/blob/master/bin/gh-diff","git_url":"https://api.github.com/repos/melborne/gh-diff/git/blobs/97f13c6aafe6520b33960b32c398e4c8bbeb4bf7","type":"file","content":"IyEvdXNyL2Jpbi9lbnYgcnVieQoKcmVxdWlyZSAnZ2gtZGlmZicKCkdoRGlm\nZjo6Q0xJLnN0YXJ0KEFSR1YpCg==\n","encoding":"base64","_links":{"self":"https://api.github.com/repos/melborne/gh-diff/contents/bin/gh-diff?ref=master","git":"https://api.github.com/repos/melborne/gh-diff/git/blobs/97f13c6aafe6520b33960b32c398e4c8bbeb4bf7","html":"https://github.com/melborne/gh-diff/blob/master/bin/gh-diff"}}'
+    http_version: 
+  recorded_at: Thu, 17 Jul 2014 01:12:53 GMT
+- request:
+    method: get
+    uri: https://api.github.com/repos/melborne/gh-diff/git/refs/heads/master
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json
+      User-Agent:
+      - Octokit Ruby Gem 3.1.2
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Thu, 17 Jul 2014 01:12:54 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '60'
+      X-Ratelimit-Remaining:
+      - '55'
+      X-Ratelimit-Reset:
+      - '1405562975'
+      Cache-Control:
+      - public, max-age=60, s-maxage=60
+      Last-Modified:
+      - Sun, 06 Jul 2014 14:29:03 GMT
+      Etag:
+      - '"b767d7ca62d9eed4ecdf0699cf8578db"'
+      X-Poll-Interval:
+      - '300'
+      Vary:
+      - Accept
+      - Accept-Encoding
+      X-Github-Media-Type:
+      - github.v3; format=json
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - deny
+      Content-Security-Policy:
+      - default-src 'none'
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset,
+        X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
+      Access-Control-Allow-Origin:
+      - "*"
+      X-Github-Request-Id:
+      - DE962F8B:18CD:113BE344:53C72315
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains
+      X-Content-Type-Options:
+      - nosniff
+      X-Served-By:
+      - 132026e9262a0093e437f99db5f1e499
+    body:
+      encoding: UTF-8
+      string: '{"ref":"refs/heads/master","url":"https://api.github.com/repos/melborne/gh-diff/git/refs/heads/master","object":{"sha":"3c8be5d3895da32a363bee90f0dab6cdda10fb42","type":"commit","url":"https://api.github.com/repos/melborne/gh-diff/git/commits/3c8be5d3895da32a363bee90f0dab6cdda10fb42"}}'
+    http_version: 
+  recorded_at: Thu, 17 Jul 2014 01:12:54 GMT
+recorded_with: VCR 2.9.2

data/spec/cli_spec.rb

@@ -143,6 +143,20 @@ describe GhDiff::CLI do
           expect(File.read path).to match(/require.*gh-diff/)
         end
       end
+
+      context "with ref option" do
+        it "add base revision number in the YAML front-matter" do
+          VCR.use_cassette('save-dir-diff-ref') do
+            ARGV.replace %w(dir_diff bin
+                            --repo=melborne/gh-diff
+                            --save --ref)
+            GhDiff::CLI.start
+            path = "diff/bin/gh-diff"
+            expect(File.exist? path).to be true
+            expect(File.read path).to match(/Base revision: 3c8be5d3/)
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gh-diff
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - kyoendo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-16 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: togglate
@@ -197,6 +197,7 @@ files:
 - spec/cassettes/ref.yml
 - spec/cassettes/save-diff.yml
 - spec/cassettes/save-diffs.yml
+- spec/cassettes/save-dir-diff-ref.yml
 - spec/cassettes/save-dir-diff.yml
 - spec/cli_spec.rb
 - spec/fixtures/docs/migrations.md
@@ -240,6 +241,7 @@ test_files:
 - spec/cassettes/ref.yml
 - spec/cassettes/save-diff.yml
 - spec/cassettes/save-diffs.yml
+- spec/cassettes/save-dir-diff-ref.yml
 - spec/cassettes/save-dir-diff.yml
 - spec/cli_spec.rb
 - spec/fixtures/docs/migrations.md