rake-jekyll 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b24b1b646810e6d3ccfad8ae77f5e169936b1ae
+  data.tar.gz: 6f954130217f2c8678edf4c1ca878eaf900527bf
+SHA512:
+  metadata.gz: c0be582d3f7ca2959c362cce605e3783e2ef75219c7b5ebf1e5c452c73502247c6f2496163ae494bf098a9a2945936a1a4bddd6d97181f6c688f5612aeccf8dd
+  data.tar.gz: cf4cc0211472ba961570535003f6638fba566fdeca8e39bb10cf532d753760868343d53dce8207eb9d1f8fa11d79aa570c72ad581e72b2dad3987020eefb352d

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright 2015 Jakub Jirutka <jakub@jirutka.cz>.
+
+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.adoc

@@ -0,0 +1,162 @@
+= Rake tasks for Jekyll
+Jakub Jirutka <https://github.com/jirutka[@jirutka]>
+:page-layout: base
+:idprefix:
+ifdef::env-github[:idprefix: user-content-]
+:idseparator: -
+// custom
+:gem-name: rake-jekyll
+:gh-name: jirutka/{gem-name}
+:gh-branch: master
+:badge-style: flat
+
+image:https://inch-ci.org/github/{gh-name}.svg?branch={gh-branch}&style={badge-style}[Inline docs, link="http://inch-ci.org/github/{gh-name}"]
+image:https://img.shields.io/gem/v/{gem-name}.svg?style={badge-style}[Gem Version, link="https://rubygems.org/gems/{gem-name}"]
+image:https://img.shields.io/badge/yard-docs-blue.svg?style={badge-style}[Yard Docs, link="http://www.rubydoc.info/github/{gh-name}/frames"]
+
+
+== Installation
+
+Add this line to your application’s Gemfile:
+
+  gem 'rake-jekyll'
+
+and then execute:
+
+  $ bundle
+
+
+== Tasks
+
+=== Deploy to Git
+
+This task builds the Jekyll site and deploys it to a remote Git repository.
+
+==== Usage
+
+The most simple usage suitable for GitHub and Travis CI:
+
+[source, ruby]
+----
+require 'rake-jekyll'
+
+Rake::Jekyll::GitDeployTask.new
+----
+
+This listing introduces all the configurable options with their default values:
+
+[source, ruby]
+----
+require 'rake-jekyll'
+
+Rake::Jekyll::GitDeployTask.new(:deploy) do |t|
+
+  # Description of the rake task.
+  t.description = 'Generate the site and push changes to remote repository'
+
+  # Overrides the *author* of the commit being created with author of the
+  # source commit (i.e. HEAD in the current branch).
+  t.author = -> {
+    `git log -n 1 --format='%aN <%aE>'`.strip
+  }
+  # Overrides the *author date* of the commit being created with date of the
+  # source commit.
+  t.author_date = -> {
+    `git log -n 1 --format='%aD'`.strip
+  }
+  # The commit message will contain hash of the source commit.
+  t.commit_message = -> {
+    "Built from #{`git rev-parse --short HEAD`.strip}"
+  }
+  # Use 'Jekyll' as the default *committer* name (with empty email) when the
+  # user.name is not set in git config.
+  t.committer = 'Jekyll'
+
+  # Deploy the built site into remote branch named 'gh-pages'. It will be
+  # automatically created if not exist yet.
+  t.deploy_branch = 'gh-pages'
+
+  # Run this command to build the site.
+  t.jekyll_build = ->(dest_dir) {
+    system "bundle exec jekyll build --destination #{dest_dir}"
+  }
+  # Use the default committer (configured in git) when available.
+  t.override_committer = false
+
+  # Use URL of the 'origin' remote to fetch/push the built site into. If env.
+  # variable GH_TOKEN is set, then it adds it as a userinfo to the URL.
+  t.remote_url = -> {
+    `git config remote.origin.url`.strip.gsub(/^git:/, 'https:').tap do |url|
+      url.gsub!(%r{^https://}, "https://#{ENV['GH_TOKEN']}@") if ENV.key? 'GH_TOKEN'
+    end
+  }
+  # Skip commit and push when building a pull request or env. variable
+  # SKIP_COMMIT represents truthy.
+  t.skip_commit = -> {
+    ENV['TRAVIS_PULL_REQUEST'].to_i > 0 ||
+      %w[yes y true 1].include?(ENV['SKIP_COMMIT'].to_s.downcase)
+  }
+end
+----
+
+Note: All options except `name` and `description` accepts both String and Proc as a value.
+
+
+==== Setup for GitHub Pages and Travis CI
+
+. Create or edit file `Rakefile` in your Jekyll repository:
++
+[source, ruby]
+----
+require 'rake-jekyll'
+
+Rake::Jekyll::GitDeployTask.new(:deploy)
+----
+. Install travis gem:
++
+  $ gem install travis
++
+. Create file `.travis.yml` in the root of your Jekyll repository:
++
+[source, yaml]
+----
+language: ruby
+sudo: false
+rvm: 2.2.0
+script: bundle exec rake deploy
+----
+. Enable Travis CI for your Jekyll repository:
+.. open your https://travis-ci.org/profile/[profile page] on Travis,
+.. find the repository and turn on the switch,
+.. then click on repository settings (next to the switch) and enable “Build only if .travis.yml is present.”
+. Generate a new personal access token on GitHub:
+.. open https://github.com/settings/tokens/new[this page] to generate a new personal access token,
+.. select the scope _public_repo_, fill some description and confirm.
+. Encrypt the token and add it to your `.travis.yml`:
+.. replace `<token>` with the GitHub token and execute:
++
+  $ travis encrypt GH_TOKEN=<token> --add env.global
++
+.. and check that it added something like the following to `.travis.yml`:
++
+[source, yaml]
+----
+env:
+  global:
+    secure: YOUR-ENCRYPTED-TOKEN
+----
+. Commit changes, push to GitHub and check that Travis has started the job and finished it successfully.
+
+
+== Contributing
+
+1. Fork it.
+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.
+
+
+== License
+
+This project is licensed under http://opensource.org/licenses/MIT/[MIT License]. For the full text of the license, see the link:LICENSE[LICENSE] file.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'yard'
+  # options are defined in .yardopts
+  YARD::Rake::YardocTask.new(:yard)
+rescue LoadError => e
+  warn "#{e.path} is not available"
+end

data/lib/rake-jekyll.rb

@@ -0,0 +1,2 @@
+require 'rake-jekyll/version'
+require 'rake-jekyll/git_deploy_task'

data/lib/rake-jekyll/git_deploy_task.rb

@@ -0,0 +1,270 @@
+require 'rake/tasklib'
+require 'tmpdir'
+
+module Rake::Jekyll
+  ##
+  # This task builds the Jekyll site and deploys it to a remote Git repository.
+  class GitDeployTask < ::Rake::TaskLib
+
+    ##
+    # @private
+    # Functions that wraps calls to +git+ command.
+    module GitCommands
+
+      def any_changes?
+        ! `git status --porcelain`.empty?
+      end
+
+      def clone_repo(url)
+        sh "git clone '#{url}' ."
+      end
+
+      def checkout_remote_branch(name)
+        sh "git checkout --track #{name}"
+      end
+
+      def commit_all(message, author = '', date = '')
+        opts = [ "--message='#{message}'" ]
+        opts << "--author='#{author}'" unless author.empty?
+        opts << "--date='#{date}'" unless date.empty?
+
+        sh "git add --all && git commit #{opts.join(' ')}"
+      end
+
+      def config_set?(key)
+        ! `git config --get #{key}`.empty?
+      end
+
+      def config_user_set(name_email)
+        name, email = parse_name_email(name_email)
+        sh "git config --local user.name '#{name}'"
+        sh "git config --local user.email '#{email}'"
+      end
+
+      def create_orphan_branch(name)
+        sh "git checkout --orphan #{name}"
+        sh 'git rm -rf . &>/dev/null || true'
+      end
+
+      # @return [String] name of the current active branch.
+      def current_branch
+        `git symbolic-ref --short -q HEAD`.strip
+      end
+
+      def push(remote_url, branch)
+        sh "git push -q #{remote_url} #{branch}:#{branch}"
+      end
+
+      private
+
+      def parse_name_email(str)
+        if matched = str.match(/^([^<]*)(?:<([^>]*)>)?$/)
+          matched[1..2].map do |val|
+            val.strip.empty? ? nil : val.strip if val
+          end
+        end
+      end
+    end
+
+    include GitCommands
+
+    ##
+    # @private
+    # Defines attribute accessor with optional default value.
+    # When attribute's value is a +Proc+ with arity 0, then the attribute
+    # reader calls it and returns the result.
+    #
+    # @param attr_name [#to_s] name of the attribute to define.
+    # @param default_value [Object] the default value (optional).
+    # @yield When the block is given, then it's used as a default value.
+    #   It takes precedence over +default_value+.
+    def self.callable_attr(attr_name, default_value = nil, &default_block)
+      var_name = "@#{attr_name}".sub('?', '').to_sym
+
+      define_method attr_name do
+        value = instance_variable_get(var_name)
+        if value.nil? && default_block
+          do_in_working_dir &default_block
+        elsif value.nil?
+          default_value
+        elsif value.is_a?(Proc) && value.arity.zero?
+          do_in_working_dir &value
+        else
+          value
+        end
+      end
+
+      attr_writer attr_name.to_s.sub('?', '')
+    end
+
+    # @return [#to_sym] name of the task.
+    attr_accessor :name
+
+    # @return [#to_s] description of the task.
+    attr_accessor :description
+
+    ##
+    # @!attribute author
+    # Overrides the _author_ of the commit being created in {#deploy_branch}.
+    # Defaults to author of the HEAD in the current (i.e. source) branch.
+    #
+    # @return [String, Proc] author name and email in the standard mail format,
+    #   e.g. Kevin Flynn <kevin@flynn.com>, or empty string to not override.
+    #
+    callable_attr :author do
+      `git log -n 1 --format='%aN <%aE>'`.strip
+    end
+
+    ##
+    # @!attribute author_date
+    # Overrides the _author date_ of the commit being created in
+    # {#deploy_branch}. Defaults to date of the HEAD in the current
+    # (i.e. source) branch.
+    #
+    # @return [String, Proc] date in any format supported by git (i.e. Git
+    #   internal format, RFC 2822, or RFC 8601).
+    #
+    callable_attr :author_date do
+      `git log -n 1 --format='%aD'`.strip
+    end
+
+    ##
+    # @!attribute commit_message
+    # @return [String, Proc] the commit message. Defaults to +Built from {REV}+,
+    #   where +{REV}+ is hash of the HEAD in the current (i.e. source) branch.
+    callable_attr :commit_message do
+      hash = `git rev-parse --short HEAD`.strip
+      "Built from #{hash}"
+    end
+
+    ##
+    # @!attribute committer
+    # Defines the default _committer_ to be used when the +user.name+ is not
+    # set in git config and/or {#override_committer?} is +true+.
+    #
+    # @return [String, Proc] author name and email in the standard mail format,
+    #   e.g. Kevin Flynn <kevin@flynn.com>. (default: +Jekyll+).
+    #
+    callable_attr :committer, 'Jekyll'
+
+    ##
+    # @!attribute deploy_branch
+    # Defines name of the remote branch to deploy the built site into.
+    # If the remote branch doesn't exist yet, then it's automatically created
+    # as an orphan branch.
+    #
+    # @return [String, Proc] name of the remote branch (default: +gh-pages+).
+    #
+    callable_attr :deploy_branch, 'gh-pages'
+
+    ##
+    # @!attribute jekyll_build
+    # Defines a function that executes Jekyll to build the site.
+    # Defaults to:
+    #   sh "bundle exec jekyll build --destination #{dest_dir}"
+    #
+    # @return [Proc] a Proc that accepts one argument; the destination
+    #   directory to generate the site into.
+    #
+    callable_attr :jekyll_build, ->(dest_dir) {
+      system "bundle exec jekyll build --destination #{dest_dir}"
+    }
+
+    ##
+    # @!attribute override_committer?
+    # @return [Boolean, Proc] +true+ to always use {#committer}, +false+ to use
+    #   the default committer (configured in git) when available.
+    callable_attr :override_committer?, false
+
+    ##
+    # @!attribute remote_url
+    # @return [String, Proc] URL of the remote git repository to fetch and push
+    #   the built site into. The default is to use URL of the +origin+ remote,
+    #   replace +git:+ schema with +https:+ and add environment variable
+    #   +GH_TOKEN+ as an userinfo (if exists).
+    callable_attr :remote_url do
+      `git config remote.origin.url`.strip.gsub(/^git:/, 'https:').tap do |url|
+        url.gsub!(%r{^https://}, "https://#{ENV['GH_TOKEN']}@") if ENV.key? 'GH_TOKEN'
+      end
+    end
+
+    ##
+    # @!attribute [w] skip_commit
+    # Whether to skip the commit and push phase.
+    # Default is to return +false+ when env variable +TRAVIS_PULL_REQUEST+
+    # is an integer value greater than 0 or +SKIP_COMMIT+ represents truthy
+    # (i.e. contains yes, y, true, or 1).
+    #
+    # @return [Boolean, Proc]
+    #
+    callable_attr :skip_commit? do
+      ENV['TRAVIS_PULL_REQUEST'].to_i > 0 ||
+        %w[yes y true 1].include?(ENV['SKIP_COMMIT'].to_s.downcase)
+    end
+
+
+    ##
+    # @param name [#to_sym] name of the task to define.
+    # @yield The block to configure this task.
+    def initialize(name = :deploy)
+      @name = name
+      @description = 'Generate the site and push changes to remote repository'
+      @working_dir = Dir.pwd
+
+      yield self if block_given?
+
+      define_task!
+    end
+
+    private
+
+    def define_task!
+      desc description.to_s
+
+      task name.to_sym do
+        @working_dir = Dir.pwd
+
+        Dir.mktmpdir do |temp_dir|
+          Dir.chdir temp_dir do
+            clone_repo remote_url
+
+            if current_branch != deploy_branch
+              begin
+                checkout_remote_branch "origin/#{deploy_branch}"
+              rescue RuntimeError
+                puts "\nBranch #{deploy_branch} doesn't exist yet, initializing..."
+                create_orphan_branch deploy_branch
+              end
+            end
+          end
+
+          puts "\nRunning Jekyll..."
+          jekyll_build[temp_dir]
+
+          Dir.chdir temp_dir do
+            unless any_changes?
+              puts 'Nothing to commit.'; next
+            end
+
+            if skip_commit?
+              puts 'Skipping commit.'; next
+            end
+
+            if override_committer? || !config_set?('user.name')
+              config_user_set committer
+            end
+
+            commit_all commit_message, author, author_date
+            push remote_url, deploy_branch
+          end
+        end
+      end
+    end
+
+    def do_in_working_dir
+      Dir.chdir @working_dir do
+        yield
+      end
+    end
+  end
+end

data/lib/rake-jekyll/version.rb

@@ -0,0 +1,5 @@
+module Rake
+  module Jekyll
+    VERSION = '1.0.2'
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: rake-jekyll
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Jakub Jirutka
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Tasks for deploying Jekyll site to Git etc.
+email: jakub@jirutka.cz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.adoc
+- Rakefile
+- lib/rake-jekyll.rb
+- lib/rake-jekyll/git_deploy_task.rb
+- lib/rake-jekyll/version.rb
+homepage: https://github.com/jirutka/rake-jekyll
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Rake tasks for Jekyll.
+test_files: []
+has_rdoc: yard