jekyll-git_metadata 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84e075d40c99adec303ec67563ac8c95c9d14027
-  data.tar.gz: 33c02709deea74dd3f1c36d16b2a9d45974d8146
+  metadata.gz: 342bad72e62590b3b7e30da46bcf49d1f2ca0f3e
+  data.tar.gz: 24cb75d6bdef4bdeffc284bbb9ef97729cd6a363
 SHA512:
-  metadata.gz: cc811eeb6b0f2a1349df70eba61715ed429f5761fd2bfcb39c75c4deb3beebf28c7c074db8de9fbc4dfc78d558f30ce22d24bfe244594f1ba43d2c9d24208ae6
-  data.tar.gz: 89fdf17ad935f296fc5f699ceec19018419c9332427f69daeec608dd5c0ab16383fe7d86174a42cb0074d451f5452c1002de13c6f3cbba46c5e5761c07ac4440
+  metadata.gz: 1cee24552d6e323f2c88ca4f9efcfbd497639f218accab9c764cfa2820d66c1aae6daf0ae6991ea5f7cd1579a24e1d0edce9d5a18a3147e1402c133290cca948
+  data.tar.gz: a9b28fb433038e6333691eb27589356c159e01acd6fd7e7392249cad6f2593f87a0633442aadd274ed6dc8013c7a9fe4b5a699e4d4a5398ed4a741e814af87a7

data/README.md

@@ -1,24 +1,62 @@
 # Jekyll::GitMetadata
 
-TODO: Write a gem description
+Expose Git metadata to Jekyll. Just like how Github exposes [repository metadata](https://help.github.com/articles/repository-metadata-on-github-pages), this plugin will expose information about your git repository for your templates. For example:
+
+```
+{{site.git.total_commits}} # => Will return the total number of commits for your Jekyll repository
+```
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add to your `Gemfile`:
 
-    gem 'jekyll-git_metadata'
+```
+gem 'jekyll-autolink_email'
+```
 
-And then execute:
+Add to your `_config.yml`:
 
-    $ bundle
+```yml
+gems:
+  - jekyll-autolink_email
+```
 
-Or install it yourself as:
+## Usage
 
-    $ gem install jekyll-git_metadata
+This plugin adds a hash of git information to the `site` and `page` variables. The hash looks something like this:
 
-## Usage
+```
+{"authors"=>
+  [
+   {"commits"=>2, "name"=>"Ivan Tse", "email"=>"ivan@example.com"},
+   {"commits"=>5, "name"=>"John Smith", "email"=>"john@example.com"}
+  ],
+ "total_commits"=>7,
+ "total_additions"=>57,
+ "total_subtractions"=>22,
+ "first_commit"=>
+  {"short_sha"=>"d15cbe8",
+   "long_sha"=>"d15cbe8d0f4d4db9efda7a3daabbe966c21f3848",
+   "author_name"=>"John Smith",
+   "author_email"=>"john@example.com",
+   "author_date"=>"Thu Jan 16 23:36:00 2014 -0500",
+   "commit_name"=>"John Smith",
+   "commit_email"=>"john@example.com",
+   "commit_date"=>"Thu Jan 16 23:36:00 2014 -0500",
+   "message"=>"A commit!"},
+ "last_commit"=>
+  {"short_sha"=>"f88ca3b",
+   "long_sha"=>"f88ca3bff630efb6cdb356fad3d640534b109572",
+   "author_name"=>"Ivan Tse",
+   "author_email"=>"ivan@example.com",
+   "author_date"=>"Mon Jul 14 04:04:47 2014 -0400",
+   "commit_name"=>"John Smith",
+   "commit_email"=>"john@example.com",
+   "commit_date"=>"Mon Jul 14 04:04:47 2014 -0400",
+   "message"=>"Fix some stuff"}}
+```
 
-TODO: Write usage instructions here
+To access this hash, use either `page.git` or `site.git`. `page.git` contains the git information about that particuliar page/file. `site.git` contains the git information for the entire git repository. `site.git` also includes `total_files` and `project_name` variables.
 
 ## Contributing
 
@@ -27,3 +65,5 @@ TODO: Write usage instructions here
 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
+
+Suggestions for more git metadata are welcomed!

data/Rakefile

@@ -1,2 +1,8 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
 
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/test_*.rb']
+  t.verbose = true
+end

data/jekyll-git_metadata.gemspec

@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "shoulda"
+  spec.add_development_dependency "mocha"
 end

data/lib/jekyll/git_metadata/generator.rb

@@ -11,10 +11,7 @@ module Jekyll
 
         Dir.chdir(site.source) do
           site.config['git'] = site_data
-          site.pages.each do |page|
-            page.data['git'] = page_data(page.relative_path)
-          end
-          site.posts.each do |page|
+          (site.pages + site.posts).each do |page|
             page.data['git'] = page_data(page.relative_path)
           end
         end
@@ -22,21 +19,13 @@ module Jekyll
       end
 
       def site_data
-        authors = self.authors
-        lines = self.lines
         {
           'project_name' => project_name,
-          'files_count' => files_count,
-          'authors' => authors,
-          'total_commits' => authors.inject(0) { |sum, h| sum += h['commits'] },
-          'total_additions' => lines.inject(0) { |sum, h| sum += h['additions'] },
-          'total_subtractions' => lines.inject(0) { |sum, h| sum += h['subtractions'] },
-          'first_commit' => commit(lines.last['sha']),
-          'last_commit' => commit(lines.first['sha'])
-        }
+          'files_count' => files_count
+        }.merge!(page_data)
       end
 
-      def page_data(relative_path)
+      def page_data(relative_path = nil)
         authors = self.authors(relative_path)
         lines = self.lines(relative_path)
         {
@@ -53,7 +42,7 @@ module Jekyll
         results = []
         cmd = 'git shortlog -se'
         cmd << " -- #{file}" if file
-        result = %x{#{cmd}}
+        result = %x{ #{cmd} }
         result.lines.each do |line|
           commits, name, email = line.scan(/(.*)\t(.*)<(.*)>/).first.map(&:strip)
           results << { 'commits' => commits.to_i, 'name' => name, 'email' => email }
@@ -64,32 +53,39 @@ module Jekyll
       def lines(file = nil)
         cmd = "git log --numstat --format='%h'"
         cmd << " -- #{file}" if file
-        result = %x{#{cmd}}
-        results = result.scan(/(.*)\n\n(.*)\t(.*)\t(.*)\n/)
-        results.map { |a| a[1] = a[1].to_i; a[2] = a[2].to_i }
+        result = %x{ #{cmd} }
+        results = result.scan(/(.*)\n\n((?:.*\t.*\t.*\n)*)/)
+        results.map do |line|
+          files = line[1].scan(/(.*)\t(.*)\t(.*)\n/)
+          line[1] = files.inject(0){|s,a| s+=a[0].to_i}
+          line[2] = files.inject(0){|s,a| s+=a[1].to_i}
+        end
         results.map do |line|
-          { 'sha' => line[0], 'additions' => line[1], 'subtractions' => line[2], 'file' => line[3] }
+          { 'sha' => line[0], 'additions' => line[1], 'subtractions' => line[2] }
         end
       end
 
       def commit(sha)
-        result = %x{git show --format=fuller -q #{sha}}
-        author_name, author_email, author_date, commit_name, commit_email, commit_date, message = result
-          .scan(/.*Author:(.*)<(.*)>\nAuthorDate:(.*)\nCommit:(.*)<(.*)>\nCommitDate:(.*)\n\n(.*)/)
+        result = %x{ git show --format=fuller -q #{sha} }
+        long_sha, author_name, author_email, author_date, commit_name, commit_email, commit_date, message = result
+          .scan(/commit (.*)\nAuthor:(.*)<(.*)>\nAuthorDate:(.*)\nCommit:(.*)<(.*)>\nCommitDate:(.*)\n\n(.*)/)
           .first
           .map(&:strip)
         {
+          'short_sha' => sha,
+          'long_sha' => long_sha,
           'author_name' => author_name,
           'author_email' => author_email,
           'author_date' => author_date,
           'commit_name' => commit_name,
+          'commit_email' => commit_email,
           'commit_date' => commit_date,
           'message' => message
         }
       end
 
       def project_name
-        File.basename(%x{git rev-parse --show-toplevel}.strip)
+        File.basename(%x{ git rev-parse --show-toplevel }.strip)
       end
 
       def files_count
@@ -97,8 +93,8 @@ module Jekyll
       end
 
       def git_installed?
-        void = RbConfig::CONFIG['host_os'] =~ /msdos|mswin|djgpp|mingw/ ? 'NUL' : '/dev/null'
-        system "git --version >>#{void} 2>&1"
+        null = RbConfig::CONFIG['host_os'] =~ /msdos|mswin|djgpp|mingw/ ? 'NUL' : '/dev/null'
+        system "git --version >>#{null} 2>&1"
       end
     end
   end

data/lib/jekyll/git_metadata/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module GitMetadata
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'shoulda'
+require 'mocha/mini_test'
+require 'jekyll'
+require 'jekyll-git_metadata'
+
+class Minitest::Test
+  def jekyll_test_repo_path
+    File.join(File.dirname(__FILE__), 'test_repo')
+  end
+
+  def dot_git_path
+    File.join(jekyll_test_repo_path, 'dot_git')
+  end
+
+  def real_dot_git_path
+    File.join(jekyll_test_repo_path, '.git')
+  end
+
+  def create_temp_git_dir
+    FileUtils.cp_r(dot_git_path, real_dot_git_path)
+  end
+
+  def remove_temp_git_dir
+    FileUtils.rm_rf(real_dot_git_path)
+  end
+end

data/test/test_git_metadata.rb

@@ -0,0 +1,158 @@
+require 'helper'
+
+class Jekyll::GitMetadataTest < Minitest::Test
+  context 'GitMetadata' do
+
+    setup do
+      create_temp_git_dir
+      Jekyll.instance_variable_set(:@logger, Jekyll::LogAdapter.new(Jekyll::Stevenson.new, :error))
+
+      config = Jekyll.configuration(
+        :source => jekyll_test_repo_path,
+        :destination => File.join(jekyll_test_repo_path, '_site'))
+      @site = Jekyll::Site.new(config)
+      @site.read
+      @site.generate
+    end
+
+    teardown do
+      remove_temp_git_dir
+    end
+
+    context 'site data' do
+      setup do
+        @site_data = @site.config['git']
+      end
+
+      should 'have correct project name' do
+        assert_equal 'test_repo', @site_data['project_name']
+      end
+
+      should 'have correct files count' do
+        assert_equal 13, @site_data['files_count']
+      end
+
+      should 'have correct totals count' do
+        assert_equal 5, @site_data['total_commits']
+        assert_equal 670, @site_data['total_additions']
+        assert_equal 11, @site_data['total_subtractions']
+      end
+
+      should 'have correct authors data' do
+        assert_equal 2, @site_data['authors'].count
+        assert @site_data['authors'].include?({"commits"=>4, "name"=>"Ivan Tse", "email"=>"ivan.tse1@gmail.com"})
+        assert @site_data['authors'].include?({"commits"=>1, "name"=>"LeBron James", "email"=>"lbj@example.com"})
+      end
+
+      should 'have correct first commit data' do
+        assert_equal '7884565', @site_data['first_commit']['short_sha']
+        assert_equal '78845656f899d0bfd86d2806b85b0c54adddd3c8', @site_data['first_commit']['long_sha']
+        assert_equal 'Ivan Tse', @site_data['first_commit']['author_name']
+        assert_equal 'ivan.tse1@gmail.com', @site_data['first_commit']['author_email']
+        assert_equal 'Mon Jul 14 02:01:29 2014 -0400', @site_data['first_commit']['author_date']
+        assert_equal 'Ivan Tse', @site_data['first_commit']['commit_name']
+        assert_equal 'ivan.tse1@gmail.com', @site_data['first_commit']['commit_email']
+        assert_equal 'Mon Jul 14 02:01:29 2014 -0400', @site_data['first_commit']['commit_date']
+        assert_equal 'First commit with jekyll scaffold', @site_data['first_commit']['message']
+      end
+
+      should 'have correct last commit data' do
+        assert_equal '25d62f6', @site_data['last_commit']['short_sha']
+        assert_equal '25d62f6feeb7190483f81564f4a76c1ec33d5118', @site_data['last_commit']['long_sha']
+        assert_equal 'LeBron James', @site_data['last_commit']['author_name']
+        assert_equal 'lbj@example.com', @site_data['last_commit']['author_email']
+        assert_equal 'Mon Jul 14 02:12:31 2014 -0400', @site_data['last_commit']['author_date']
+        assert_equal 'Ivan Tse', @site_data['last_commit']['commit_name']
+        assert_equal 'ivan.tse1@gmail.com', @site_data['last_commit']['commit_email']
+        assert_equal 'Mon Jul 14 02:12:31 2014 -0400', @site_data['last_commit']['commit_date']
+        assert_equal 'Be more friendly', @site_data['last_commit']['message']
+      end
+    end
+
+    context 'page data' do
+      setup do
+        @about_page = @site.pages.select{|p| p.name == 'about.md'}.first
+        @page_data = @about_page.data['git']
+      end
+
+      should 'have correct totals count' do
+        assert_equal 3, @page_data['total_commits']
+        assert_equal 14, @page_data['total_additions']
+        assert_equal 5, @page_data['total_subtractions']
+      end
+
+      should 'have correct authors data' do
+        assert_equal 2, @page_data['authors'].count
+        assert @page_data['authors'].include?({"commits"=>2, "name"=>"Ivan Tse", "email"=>"ivan.tse1@gmail.com"})
+        assert @page_data['authors'].include?({"commits"=>1, "name"=>"LeBron James", "email"=>"lbj@example.com"})
+      end
+
+      should 'have correct first commit data' do
+        assert_equal '7884565', @page_data['first_commit']['short_sha']
+        assert_equal '78845656f899d0bfd86d2806b85b0c54adddd3c8', @page_data['first_commit']['long_sha']
+        assert_equal 'Ivan Tse', @page_data['first_commit']['author_name']
+        assert_equal 'ivan.tse1@gmail.com', @page_data['first_commit']['author_email']
+        assert_equal 'Mon Jul 14 02:01:29 2014 -0400', @page_data['first_commit']['author_date']
+        assert_equal 'Ivan Tse', @page_data['first_commit']['commit_name']
+        assert_equal 'ivan.tse1@gmail.com', @page_data['first_commit']['commit_email']
+        assert_equal 'Mon Jul 14 02:01:29 2014 -0400', @page_data['first_commit']['commit_date']
+        assert_equal 'First commit with jekyll scaffold', @page_data['first_commit']['message']
+      end
+
+      should 'have correct last commit data' do
+        assert_equal '25d62f6', @page_data['last_commit']['short_sha']
+        assert_equal '25d62f6feeb7190483f81564f4a76c1ec33d5118', @page_data['last_commit']['long_sha']
+        assert_equal 'LeBron James', @page_data['last_commit']['author_name']
+        assert_equal 'lbj@example.com', @page_data['last_commit']['author_email']
+        assert_equal 'Mon Jul 14 02:12:31 2014 -0400', @page_data['last_commit']['author_date']
+        assert_equal 'Ivan Tse', @page_data['last_commit']['commit_name']
+        assert_equal 'ivan.tse1@gmail.com', @page_data['last_commit']['commit_email']
+        assert_equal 'Mon Jul 14 02:12:31 2014 -0400', @page_data['last_commit']['commit_date']
+        assert_equal 'Be more friendly', @page_data['last_commit']['message']
+      end
+    end
+
+    context 'post data' do
+      setup do
+        @welcome_post = @site.posts.select{|p| p.name == '2014-07-14-welcome-to-jekyll.markdown'}.first
+        @page_data = @welcome_post.data['git']
+      end
+
+      should 'have correct totals count' do
+        assert_equal 2, @page_data['total_commits']
+        assert_equal 28, @page_data['total_additions']
+        assert_equal 0, @page_data['total_subtractions']
+      end
+
+      should 'have correct authors data' do
+        assert_equal 1, @page_data['authors'].count
+        assert @page_data['authors'].include?({"commits"=>2, "name"=>"Ivan Tse", "email"=>"ivan.tse1@gmail.com"})
+      end
+
+      should 'have correct first commit data' do
+        assert_equal '7884565', @page_data['first_commit']['short_sha']
+        assert_equal '78845656f899d0bfd86d2806b85b0c54adddd3c8', @page_data['first_commit']['long_sha']
+        assert_equal 'Ivan Tse', @page_data['first_commit']['author_name']
+        assert_equal 'ivan.tse1@gmail.com', @page_data['first_commit']['author_email']
+        assert_equal 'Mon Jul 14 02:01:29 2014 -0400', @page_data['first_commit']['author_date']
+        assert_equal 'Ivan Tse', @page_data['first_commit']['commit_name']
+        assert_equal 'ivan.tse1@gmail.com', @page_data['first_commit']['commit_email']
+        assert_equal 'Mon Jul 14 02:01:29 2014 -0400', @page_data['first_commit']['commit_date']
+        assert_equal 'First commit with jekyll scaffold', @page_data['first_commit']['message']
+      end
+
+      should 'have correct last commit data' do
+        assert_equal '8365a44', @page_data['last_commit']['short_sha']
+        assert_equal '8365a44c640d5c7cafc8788607a274dfd91b89bb', @page_data['last_commit']['long_sha']
+        assert_equal 'Ivan Tse', @page_data['last_commit']['author_name']
+        assert_equal 'ivan.tse1@gmail.com', @page_data['last_commit']['author_email']
+        assert_equal 'Mon Jul 14 02:10:03 2014 -0400', @page_data['last_commit']['author_date']
+        assert_equal 'Ivan Tse', @page_data['last_commit']['commit_name']
+        assert_equal 'ivan.tse1@gmail.com', @page_data['last_commit']['commit_email']
+        assert_equal 'Mon Jul 14 02:10:03 2014 -0400', @page_data['last_commit']['commit_date']
+        assert_equal 'Edit first post', @page_data['last_commit']['message']
+      end
+    end
+
+  end
+end

data/test/test_repo/.gitignore

@@ -0,0 +1 @@
+_site

data/test/test_repo/_config.yml

@@ -0,0 +1,12 @@
+# Site settings
+title: Jekyll Test Site for Jekyll::GitMetadata
+email: ivan.tse1@gmail.com
+description: "This is a test jekyll site with git contents to properly test the Jekyll::GitMetadata generator"
+baseurl: ""
+url: "http://tseivan.com"
+twitter_username: ivan_tse
+github_username:  ivantsepp
+
+# Build settings
+markdown: kramdown
+permalink: pretty

data/test/test_repo/_includes/footer.html

@@ -0,0 +1,61 @@
+<footer class="site-footer">
+
+  <div class="wrap">
+
+    <h2 class="footer-heading">{{ site.title }}</h2>
+
+    <div class="footer-col-1 column">
+      <ul>
+        <li>{{ site.title }}</li>
+        <li><a href="mailto:{{ site.email }}">{{ site.email }}</a></li>
+      </ul>
+    </div>
+
+    <div class="footer-col-2 column">
+      <ul>
+        {% if site.github_username %}<li>
+          <a href="https://github.com/{{ site.github_username }}">
+            <span class="icon github">
+              <svg version="1.1" class="github-icon-svg" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+                 viewBox="0 0 16 16" enable-background="new 0 0 16 16" xml:space="preserve">
+                <path fill-rule="evenodd" clip-rule="evenodd" fill="#C2C2C2" d="M7.999,0.431c-4.285,0-7.76,3.474-7.76,7.761
+                c0,3.428,2.223,6.337,5.307,7.363c0.388,0.071,0.53-0.168,0.53-0.374c0-0.184-0.007-0.672-0.01-1.32
+                c-2.159,0.469-2.614-1.04-2.614-1.04c-0.353-0.896-0.862-1.135-0.862-1.135c-0.705-0.481,0.053-0.472,0.053-0.472
+                c0.779,0.055,1.189,0.8,1.189,0.8c0.692,1.186,1.816,0.843,2.258,0.645c0.071-0.502,0.271-0.843,0.493-1.037
+                C4.86,11.425,3.049,10.76,3.049,7.786c0-0.847,0.302-1.54,0.799-2.082C3.768,5.507,3.501,4.718,3.924,3.65
+                c0,0,0.652-0.209,2.134,0.796C6.677,4.273,7.34,4.187,8,4.184c0.659,0.003,1.323,0.089,1.943,0.261
+                c1.482-1.004,2.132-0.796,2.132-0.796c0.423,1.068,0.157,1.857,0.077,2.054c0.497,0.542,0.798,1.235,0.798,2.082
+                c0,2.981-1.814,3.637-3.543,3.829c0.279,0.24,0.527,0.713,0.527,1.437c0,1.037-0.01,1.874-0.01,2.129
+                c0,0.208,0.14,0.449,0.534,0.373c3.081-1.028,5.302-3.935,5.302-7.362C15.76,3.906,12.285,0.431,7.999,0.431z"/>
+              </svg>
+            </span>
+            <span class="username">{{ site.github_username }}</span>
+          </a>
+        </li>{% endif %}
+        {% if site.twitter_username %}<li>
+          <a href="https://twitter.com/{{ site.twitter_username }}">
+            <span class="icon twitter">
+              <svg version="1.1" class="twitter-icon-svg" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+                 viewBox="0 0 16 16" enable-background="new 0 0 16 16" xml:space="preserve">
+                <path fill="#C2C2C2" d="M15.969,3.058c-0.586,0.26-1.217,0.436-1.878,0.515c0.675-0.405,1.194-1.045,1.438-1.809
+                c-0.632,0.375-1.332,0.647-2.076,0.793c-0.596-0.636-1.446-1.033-2.387-1.033c-1.806,0-3.27,1.464-3.27,3.27
+                c0,0.256,0.029,0.506,0.085,0.745C5.163,5.404,2.753,4.102,1.14,2.124C0.859,2.607,0.698,3.168,0.698,3.767
+                c0,1.134,0.577,2.135,1.455,2.722C1.616,6.472,1.112,6.325,0.671,6.08c0,0.014,0,0.027,0,0.041c0,1.584,1.127,2.906,2.623,3.206
+                C3.02,9.402,2.731,9.442,2.433,9.442c-0.211,0-0.416-0.021-0.615-0.059c0.416,1.299,1.624,2.245,3.055,2.271
+                c-1.119,0.877-2.529,1.4-4.061,1.4c-0.264,0-0.524-0.015-0.78-0.046c1.447,0.928,3.166,1.469,5.013,1.469
+                c6.015,0,9.304-4.983,9.304-9.304c0-0.142-0.003-0.283-0.009-0.423C14.976,4.29,15.531,3.714,15.969,3.058z"/>
+              </svg>
+            </span>
+            <span class="username">{{ site.twitter_username }}</span>
+          </a>
+        </li>{% endif %}
+      </ul>
+    </div>
+
+    <div class="footer-col-3 column">
+      <p class="text">{{ site.description }}</p>
+    </div>
+
+  </div>
+
+</footer>