ghpages_deploy 1.4.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e256ce54aa9b6f69a8f1163048dc3a6dd841c23
-  data.tar.gz: b965eb7cf16e65ca7928124dbca1401e11123f41
+  metadata.gz: 74af19bd981f4e4bd25b8892fac9aa98b8dd6615
+  data.tar.gz: 5780df2c62671a09c6b2038a6199a3f3e6bc53dc
 SHA512:
-  metadata.gz: fa2bf185c2cb72ea7b30c8b8a08136000bad71fd65d9cdd0f9c8ed57fbf123be376490395fbc9ae60d2b63f6826b8a088c6b8bb85fb282fabf8502819efb2052
-  data.tar.gz: 7008712e2a72d18622ddd78fcdae18b951c95478ed992c7bb0d2ea0d37afda63488ffa0dfdd22824923a795f1479fe8b218efeabbc0e0db972494485f9116f5f
+  metadata.gz: ba1f2b3445e81f42aa5cc050544a5178bec9213c98fe96a4e6d30efb0e48ef19c636c88cbefa1f8987a0ce3efb636b355d5bd91c8e2d038c219c5a9a536f9719
+  data.tar.gz: e6b1c0a838548c8c9215d4545d4523c5c067d5b9993f42e2610ddb285778f645a54e6119a3329716ec0bd5b3d26adbb967bb3b0bf06db1d898f3bc5fae0fa29f

data/.gitignore

@@ -1,4 +1,5 @@
-Gemfile*.lock
+Gemfile.lock
+
 /.bundle/
 /vendor/bundle/
 

data/Gemfile

@@ -4,9 +4,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-group :dev do
-  gem 'rake', require: false
-
-  gem 'rubocop', '>= 0.36.0', require: false
-end

data/Rakefile

@@ -1,17 +1,8 @@
 # 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)
+require 'rideliner/tasks'

data/ghpages_deploy.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'git'
+
+  spec.add_development_dependency 'rideliner'
 end

data/lib/ghpages_deploy/deployer.rb

@@ -6,22 +6,24 @@ require 'ghpages_deploy/git_manager'
 
 module GithubPages
   class Deployer
-    def initialize(git, source, destinations, handler)
+    def initialize(git, source, destination, message, handler)
       @git = git
       @source = source
-      @destinations = destinations
+      @destination = destination
       @handler = handler
+      @message = message || "Deployed to '#{@destination}'."
     end
 
     def deploy
-      @destinations.keep_if { |dest| deploy_site_to(dest) }
+      deploy_site_to(@destination)
 
       @git.stage @handler.on_deploy.flatten.uniq if @handler
 
       if @git.staged_modifications('.').empty?
         $stderr.puts 'No changes detected, not commiting.'
       else
-        @git.commit_and_push message
+        @git.commit_and_push @message
+        $stdout.puts "Commit made with message: #{@message}"
       end
     end
 
@@ -54,9 +56,6 @@ module GithubPages
       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)
@@ -70,21 +69,5 @@ module GithubPages
 
       @git.stage files
     end
-
-    def message
-      return 'Handler updates' if @destinations.empty?
-
-      # 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

@@ -6,22 +6,25 @@ require 'logger'
 
 module GithubPages
   class GitManager
-    def initialize(remote, preserved_dir)
+    def initialize(remote, preserved_dir, repo = nil, branch = nil)
       @preserved = preserved_dir
       @remote = remote
-      @repo = `git config remote.#{remote}.url`.gsub(/^git:/, 'https:')
-      @branch =
-        if @repo =~ /\.github\.(?:com|io)\.git$/
-          'master'
-        else
-          'gh-pages'
-        end
+      @repo = repo || `git config remote.#{remote}.url`.gsub(/^git:/, 'https:')
+      @branch = branch || default_branch
 
       @git = Git.open(Dir.pwd)
 
       setup
     end
 
+    def default_branch
+      if @repo =~ /\.github\.(?:com|io)\.git$/
+        'master'
+      else
+        'gh-pages'
+      end
+    end
+
     def self.open(*args, &block)
       git = new(*args, &block)
       yield git
@@ -76,8 +79,10 @@ module GithubPages
 
     def setup_repo
       @git.add_remote(remote, repo) unless @git.remote(remote)
-      @git.config("remote.#{remote}.fetch",
-                  "+refs/heads/*:refs/remotes/#{remote}/*")
+      @git.config(
+        "remote.#{remote}.fetch",
+        "+refs/heads/*:refs/remotes/#{remote}/*"
+      )
       @git.remote(remote).fetch
     end
 

data/lib/ghpages_deploy/rake/json.rb

@@ -2,69 +2,53 @@
 # Copyright (c) 2016 Nathan Currier
 
 require 'json'
+require 'set'
 
 require 'ghpages_deploy/rake/task'
 
 module GithubPages
   module JsonRakeExt
-    # designed for a documentation sitemap
-    # best used with a format similar to the following:
-    #
-    # tag/
-    #   v1.0.0/
-    #     _index.html
-    #     ...
-    #   v1.1.0/
-    #     index.html
-    #     _index.html
-    #     ...
-    #   ...
-    # branch/
-    #   master/
-    #     index.html
-    #     ...
-    #   ...
-    #
-
-    # if update_sitemap is being called, excluded directories should be relative to './'
+    class << self
+      def directory_sitemap(files)
+        directory_mash.tap { |root| files.each { |path| map_file(root, path) } }
+      end
 
-    def self.update_sitemap(excluded)
-      mapping = directory_sitemap('.', excluded).last
+      def map_file(marker, path)
+        *dirs, file = path.split('/')
+        dirs.each { |dir| marker = marker[:dirs][dir] }
+        marker[:files] << file
+      end
 
-      File.open('sitemap.json', 'w+') do |file|
-        file.write mapping.to_json
+      def sanitize_list(list)
+        list.each_with_object(Set.new) { |glob, set| set.merge(Dir[glob]) }
       end
-    end
 
-    def self.directory_sitemap(dir, excluded)
-      mapping =
-        Dir.foreach(dir).flat_map do |file|
-          file_dir = File.join(dir, file)
-          next [] if excluded.include?(file_dir)
-          next [] if %w(.git . ..).include?(file)
-          next [] unless Dir.exist?(file_dir)
+      def expand_lists(directory, whitelist, blacklist)
+        Dir.chdir(directory) do
+          lists = [whitelist, blacklist].map { |list| sanitize_list(list) }
+          lists.reduce(&:-).select { |f| File.file?(f) }
+        end
+      end
 
-          index =
-            %w(index.html _index.html).find do |html|
-              File.exist?(File.join(file_dir, html))
-            end
+      def directory_mash
+        Hash[dirs: mash, files: []]
+      end
 
-          next [File.basename(file_dir), index] if index
+      def mash
+        Hash.new { |h, k| h[k] = directory_mash }
+      end
+    end
 
-          map = directory_sitemap(file_dir, excluded)
-          next [] if !map || map.empty?
-          map
-        end
+    def generate_json_map(
+      directory: '.', output: 'sitemap.json',
+      whitelist: ['**/*'], blacklist: []
+    )
+      files = self.class.expand_lists(directory, whitelist, blacklist)
+      map = self.class.directory_sitemap(files)
 
-      return nil if mapping.empty?
-      [File.basename(dir), Hash[*mapping]]
-    end
+      File.open(output, 'w+') { |f| f.puts map.to_json }
 
-    def json_sitemap(excluded = [])
-      handler.handle_deploy do
-        JsonRakeExt.update_sitemap(excluded)
-        ['sitemap.json']
-      end
+      [output]
     end
   end
 

data/lib/ghpages_deploy/rake/task.rb

@@ -12,35 +12,30 @@ module GithubPages
   class DeployTask < ::Rake::TaskLib
     def initialize(*args)
       @args = args
-      @destinations = []
       @handler = GithubPages::Handler.new
 
       yield self if block_given?
 
       @source &&= @source.gsub(%r{^#{Dir.pwd}[\/]?}, '')
 
+      @destination ||= '.'
       @source ||= '.'
       @remote ||= 'origin'
 
-      @destinations << '.' if @destinations.empty?
-
       define
     end
 
-    attr_accessor :remote, :source
+    attr_accessor :remote, :source, :destination
+    attr_accessor :repo, :branch
+    attr_accessor :message
     attr_reader :handler
 
-    def register(destination)
-      @destinations << destination
-    end
-
     private
 
     def define
       task(*@args) do
-        GitManager.open(@remote, @source) do |git|
-          deployer = Deployer.new(git, @source, @destinations, @handler)
-          deployer.deploy
+        GitManager.open(@remote, @source, @repo, @branch) do |git|
+          Deployer.new(git, @source, @destination, @message, @handler).deploy
         end
       end
     end

data/lib/ghpages_deploy/version.rb

@@ -2,5 +2,5 @@
 # Copyright (c) 2016 Nathan Currier
 
 module GithubPages
-  VERSION = '1.4.2'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ghpages_deploy
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Nathan Currier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+- !ruby/object:Gem::Dependency
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+  type: :development
+  name: rideliner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Deploy to Github Pages
 email:
 - nathan.currier@gmail.com
@@ -67,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: Deploy your site to Github Pages