ghpages_deploy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e73a6dfd2d85194171c33b2efe0fac59a9454ae9
+  data.tar.gz: 996ebf3a6adf3d7b547478875b12757938b7b7b0
+SHA512:
+  metadata.gz: 5f7e5e07bdef4625689b6a6550036409fada7c1fe7cf60e7dcf8bd2640638283a530c0ee25d78c56c55d13cacc6c7940ca48824533d11b54b2e4647ce943f7f0
+  data.tar.gz: 13fb1a221a429d4f97a36befd7e6e2b4a1c819928f56d4d6f31192dd88c2faec5c03ea5863dc92a0d379fc34d073c673f0e9008ec079db1fc7a9a6b70e026c8d

data/Gemfile

@@ -0,0 +1,12 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :dev do
+  gem 'rake', require: false
+
+#  gem 'rubocop', '>= 0.36.0', require: false
+end

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2013-2016, Nathan Currier
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of the <organization> nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,17 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup(:default, :development)
+
+require 'bundler/gem_tasks'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.fail_on_error = false
+end
+task('rubocop:auto_correct').clear
+
+task default: %i(rubocop)

data/ghpages_deploy.gemspec

@@ -0,0 +1,24 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+require './lib/ghpages_deploy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ghpages_deploy'
+  spec.version       = GithubPages::VERSION
+  spec.authors       = ['Nathan Currier']
+  spec.email         = ['nathan.currier@gmail.com']
+  spec.license       = 'BSD-3-Clause'
+
+  spec.description   = 'Deploy to Github Pages'
+  spec.summary       = 'Deploy your site to Github Pages'
+  spec.homepage      = 'https://github.com/rideliner/ghpages_deploy'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'bundler', '>= 1.11.2'
+end

data/lib/ghpages_deploy/compress.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+require 'zlib'
+
+require 'ghpages_deploy/util'
+
+module GithubPages
+  class SiteCompressor
+    def initialize(directory)
+      @directory = directory
+      @level = Zlib::BEST_COMPRESSION
+    end
+
+    attr_accessor :level
+
+    def compress
+      GithubPages.all_nested_files(@directory).each do |item|
+        compress_file(item) if can_compress?(item) && !compressed?(item)
+      end
+    end
+
+    private
+
+    def compress_file(filename)
+      Zlib::GzipWriter.open("#{filename}.gz", @level) do |gz|
+        gz.mtime = File.mtime(filename)
+        gz.orig_name = filename
+        gz.write File.binread(filename)
+      end
+      File.rename("#{filename}.gz", filename)
+    end
+
+    def can_compress?(filename)
+      ext = File.extname(filename)
+      return false if ext.empty?
+      %i(css js html).include?(ext[1..-1].to_sym)
+    end
+
+    GZIP_MAGIC = ['1F8B'].pack('H*')
+
+    def compressed?(filename)
+      File.open(filename) do |f|
+        f.readpartial(2) == GZIP_MAGIC
+      end
+    rescue EOFError
+      false
+    end
+  end
+end

data/lib/ghpages_deploy/deployer.rb

@@ -0,0 +1,72 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+require 'ghpages_deploy/compress'
+require 'ghpages_deploy/git_manager'
+
+module GithubPages
+  class Deployer
+    def initialize(git, source, destinations)
+      @git = git
+      @source = source
+      @destinations = destinations
+    end
+
+    def deploy
+      SiteCompressor.new(@source).compress
+
+      @destinations.keep_if { |dest| deploy_site_to(dest) }
+
+      if @destinations.empty?
+        puts 'No changes detected, not commiting.'
+      else
+        @git.commit_and_push message
+      end
+    end
+
+    private
+
+    # @return [Boolean] true if there were changes to the destination
+    def deploy_site_to(dest)
+      # create the full path to the destination
+      FileUtils.mkdir_p(dest)
+
+      # remove files that are already cached in the destination directory
+      @git.ls_files(dest).each { |file| File.delete(file) }
+
+      # recursively copy all files from @source into dest
+      FileUtils.cp_r("#{@source}/.", dest)
+
+      stage_destination_files(dest)
+
+      # check if any changes were made to the destination
+      !@git.staged_modifications(dest).empty?
+    end
+
+    def stage_destination_files(dest)
+      files = GithubPages.all_nested_files(@source)
+      files.keep_if { |file| File.file?(file) }
+
+      files.map! do |file|
+        simple = file.sub(%r{^#{@source}/?}, '')
+        File.join(dest, simple)
+      end
+
+      @git.stage files
+    end
+
+    def message
+      # English join
+      msg =
+        if @destinations.length == 1
+          @destinations.first
+        elsif @destinations.length == 2
+          @destinations.join ' and '
+        else
+          @destinations[0..-2].join(', ') + ", and #{@destinations.last}"
+        end
+
+      "Deployed to #{msg}."
+    end
+  end
+end

data/lib/ghpages_deploy/git_manager.rb

@@ -0,0 +1,107 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+require 'git'
+
+module GithubPages
+  class GitManager
+    def initialize(remote)
+      @remote = remote
+      @repo = `git config remote.#{remote}.url`.gsub(/^git:/, 'https:')
+      @branch =
+        if @repo =~ /\.github\.(?:com|io)\.git$/
+          'master'
+        else
+          'gh-pages'
+        end
+
+      @git = Git.open(Dir.pwd)
+      @original_branch = @git.lib.branch_current
+
+      setup
+    end
+
+    def self.open(remote)
+      git = new(remote)
+      yield git
+      git.cleanup
+    end
+
+    def cleanup
+      cleanup_credentials
+      restore_state
+    end
+
+    def stage(files)
+      @git.add files
+    end
+
+    def staged_modifications(dir)
+      cached_files('diff --name-only', dir)
+    end
+
+    def ls_files(dir)
+      cached_files('ls-files', dir)
+    end
+
+    def commit_and_push(msg)
+      @git.commit(msg)
+      @git.push(@git.remote(remote))
+    end
+
+    private
+
+    attr_reader :remote, :branch, :repo
+
+    def cached_files(cmd, dir)
+      git("#{cmd} --cached -z #{dir}").split("\0")
+    end
+
+    CREDENTIALS_FILE = '.git/credentials'.freeze
+
+    def git(command)
+      `git #{command}`
+    end
+
+    def setup
+      setup_repo
+      setup_user
+      setup_credentials
+      setup_branch
+    end
+
+    def setup_repo
+      @git.add_remote(remote, repo) unless @git.remote(remote)
+      @git.remote(remote).fetch
+    end
+
+    def setup_user
+      @git.config('user.name', ENV['GIT_NAME']) if ENV['GIT_NAME']
+      @git.config('user.email', ENV['GIT_EMAIL']) if ENV['GIT_EMAIL']
+    end
+
+    def setup_branch
+      if @git.is_local_branch?(branch) || @git.is_remote_branch?(branch)
+        @git.branch(branch).checkout
+      else
+        git "checkout --orphan #{branch}"
+      end
+    end
+
+    def setup_credentials
+      @git.config('credential.helper', "store --file=#{CREDENTIALS_FILE}")
+      File.open(CREDENTIALS_FILE, 'w') do |file|
+        token = ENV['GITHUB_OAUTH_TOKEN']
+        file.write "https://#{token}:x-oauth-basic@github.com"
+      end
+    end
+
+    def cleanup_credentials
+      # TODO
+    end
+
+    def restore_state
+      @git.checkout(@original_branch)
+    end
+  end
+end

data/lib/ghpages_deploy/rake_task.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+require 'rake'
+require 'rake/tasklib'
+
+require 'ghpages_deploy/deployer'
+require 'ghpages_deploy/git_manager'
+
+module GithubPages
+  class DeployTask < ::Rake::TaskLib
+    def initialize(name = :deploy)
+      @name = name
+      @destinations = []
+
+      yield self if block_given?
+
+      @source ||= '.'
+      @remote ||= 'origin'
+
+      @destinations << '.' if @destinations.empty?
+
+      define
+    end
+
+    attr_accessor :name
+
+    attr_accessor :remote, :source
+
+    def register(destination)
+      @destinations << destination
+    end
+
+    private
+
+    def define
+      task @name do
+        GitManager.open(@remote) do |git|
+          deployer = Deployer.new(git, @source, @destinations)
+          deployer.deploy
+        end
+      end
+    end
+  end
+end

data/lib/ghpages_deploy/util.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+module GithubPages
+  def all_nested_files(dir)
+    files = Dir.glob("#{dir}/**/*", File::FNM_DOTMATCH)
+    files.delete_if { |file| file =~ %r{(^|/)?\.?\.$} }
+  end
+  module_function :all_nested_files
+end

data/lib/ghpages_deploy/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+module GithubPages
+  VERSION = '1.0.0'.freeze
+end

data/lib/ghpages_deploy.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+# Copyright (c) 2016 Nathan Currier
+
+require 'ghpages_deploy/compress'
+require 'ghpages_deploy/deployer'
+require 'ghpages_deploy/git_manager'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: ghpages_deploy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nathan Currier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  name: bundler
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.11.2
+description: Deploy to Github Pages
+email:
+- nathan.currier@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- Rakefile
+- ghpages_deploy.gemspec
+- lib/ghpages_deploy.rb
+- lib/ghpages_deploy/compress.rb
+- lib/ghpages_deploy/deployer.rb
+- lib/ghpages_deploy/git_manager.rb
+- lib/ghpages_deploy/rake_task.rb
+- lib/ghpages_deploy/util.rb
+- lib/ghpages_deploy/version.rb
+homepage: https://github.com/rideliner/ghpages_deploy
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Deploy your site to Github Pages
+test_files: []