github_pages_rake_tasks 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c1c26a1c1d2a2f421fb63e5ee55069934e330b5
+  data.tar.gz: ae3f9ed9b8e1382f75c76927e64b4b0d7f01cf35
+SHA512:
+  metadata.gz: 7f922d47b730f6b7366001dbe3d966ba528724ba1f4d49515fc806ffedfaff9bb484b2f3a0065a8bce1a568c1fba02447e05da9d2bd49b1d3257c8b56c16e25c
+  data.tar.gz: bec3b910b62b6e85783933d66972b8682587f42e6a5d78a56871092afece607dd0977b0ded31fbfdce539aa0d072d55c4d204c36d90c092251dfb3237e2b449d

data/.gitignore

@@ -0,0 +1,23 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# rubocop
+rubocop-report.json
+
+# yardstick
+measurements
+
+Gemfile.lock
+
+# JetBrains files
+*.iml
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+AllCops:
+  # Output extra information for each offense to make it easier to diagnose:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  # Rubocop enforces rules depending on the oldest version of Ruby which
+  # your project supports:
+  TargetRubyVersion: 2.5
+
+# The default max line length for this project
+Metrics/LineLength:
+  Max: 100
+
+# The DSL for RSpec and the gemspec file make it very hard to limit block length:
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+    - "*.gemspec"
+
+# All Ruby files are required to have a Copyright notice.
+# Run `rubocop -a` to automatically add missing copyright notices.
+Style/Copyright:
+  Enabled: true
+  Notice: 'Copyright (\(c\) )?2019 James Couball'
+  AutocorrectNotice: "# Copyright (c) 2019 James Couball\n"

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+
+cache: bundler
+
+rvm:
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+
+before_install: gem install bundler -v 2.0.1
+
+deploy:
+  provider: rubygems
+  api_key:
+    secure: HA1sMG5jqnSSpcIEi0Ej3HDAzff5dMNvGeb1FK5BAnfV+C5pHTkUU26+fEUmrr31nDeU3hgEv+rDdz7+Udt5hO9NGIF3bRhlqBYkkaIwLfOragaoROyq+tAPag7Mm5VKfzbXYE7dqEDZSQLjHIiY3UxksNnV3kQ+VvXL1eHg5n765EnwJP2F+FYWd7NBaq+QitdKEUZlY1Xktyq+5Isk7g0mYKZEf8K1S7MU79m4vHLI6GAT2sTCxGSsAAJejL7OYNF7Yo/8DcIsyqQjjJmkZVbHfIgpw9GrQVILNeP+4tA4LdZ9us/uk+VyM5iWMdAvQk9MW3Sl3VNo2fj9IYkOtTpqPiHoWD/zKdjI0qeDFLhaj7inSvLsXRL3IAibGV0zaNi7pNg5bwL4jKcXQDeJri4m0eKfYZQKOXQ9NqbnAHUiSrpdgJxbzmaZvMfIEI18aBXa3xdKKdBQk0ogeh2FvqIL7dCHamMsyAZRWIqOLiKwNnZ2o/4JvCgnELPo/nhmvdAE08KV4i3TE8eHBipY6ZLIThVMNURGAF9Le4bcFrGcCvPVEvzPXHV9QE91cQ8mN9NM9Rz3SZuqvSIwLGDAmor5oyxnWr9Vwm2S/7OAxdD2X2l+sTks0U/EXQ+I+axEexMUgCOgUChSz8pAHxujc+/nRLJ4VE/MZ1ZO7KMAMok=
+  gem: github_pages_rake_tasks
+  on:
+    repo: jcouball/github_pages_rake_tasks

data/.yardopts

@@ -0,0 +1,3 @@
+--no-private
+--hide-void-return
+--markup markdown

data/Gemfile

@@ -0,0 +1,7 @@
+# Copyright (c) 2019 James Couball
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in github_pages_rake_tasks.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 James Couball
+
+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.md

@@ -0,0 +1,63 @@
+# Publish Documentation to GitHub Pages
+
+[![Build Status](https://travis-ci.com/jcouball/github_pages_rake_tasks.svg?branch=master)](https://travis-ci.com/jcouball/github_pages_rake_tasks)
+
+The `github_pages_rake_tasks` gem creates a rake task that pushes the contents
+from a local documentation directory to a remote Git repository branch.
+
+By default, the rake task `github-pages:publish` is created which pushes the `doc`
+directory within the local copy of your repository to the same repository's
+`gh-pages` branch.  The contents of the branch are completely replaced by the
+contents of the documentation directory.
+
+This task is useful for publishing `rdoc` or `yard` documentation using
+[GitHub Pages](https://pages.github.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'github_pages_rake_tasks'
+
+And then execute:
+
+    $ bundle
+
+Or install it directly with the `gem` command line:
+
+    $ gem install github_pages_rake_tasks
+
+## Usage
+
+Add the `github-pages:publish` task to Rake by adding the following lines in your Rakefile:
+
+```Ruby
+require 'github_pages_rake_tasks'
+GitHubPagesRakeTasks.Tasks.new
+```
+
+You can also configure the task by providing a block during initialization:
+
+```Ruby
+require 'github_pages_rake_tasks'
+GitHubPagesRakeTasks.Tasks.new do |task|
+  task.doc_dir = 'documentation'
+  task.repo_url = 'https://github.com/jcouball/github_pages_documentation'
+  task.branch_name = 'master'
+end
+```
+
+See [the full usage documentation](https://github.com/pages/jcouball/guthub_pages_rake_tasks) for more details.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+To release a new version, update the version number in `version.rb`, and then run 
+`bundle exec rake release`, which will create a git tag for the version, push git 
+commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jcouball/github_pages_rake_tasks.

data/Rakefile

@@ -0,0 +1,41 @@
+# Copyright (c) 2019 James Couball
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+CLOBBER << 'Gemfile.lock'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+CLEAN << '.rspec_status'
+CLEAN << 'coverage'
+
+require 'bundler/audit/task'
+Bundler::Audit::Task.new
+
+require 'bump/tasks'
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new do |t|
+  t.options = %w[--format progress --format json --out rubocop-report.json]
+end
+CLEAN << 'rubocop-report.json'
+
+require 'yard'
+YARD::Rake::YardocTask.new
+CLEAN << '.yardoc'
+CLEAN << 'doc'
+
+require 'yardstick/rake/verify'
+require 'yaml'
+Yardstick::Rake::Verify.new('yardstick:verify')
+
+require 'yardstick/rake/measurement'
+Yardstick::Rake::Measurement.new('yardstick:measure')
+CLEAN << 'measurements'
+
+desc 'Run yardstick to check yard docs'
+task :yardstick do
+  sh "yardstick 'lib/**/*.rb'"
+end
+
+task default: [:spec, 'bundle:audit', :rubocop, :yard, :build]

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2019 James Couball
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'github_pages_rake_tasks'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+# Copyright (c) 2019 James Couball
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/github_pages_rake_tasks.gemspec

@@ -0,0 +1,54 @@
+# Copyright (c) 2019 James Couball
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github_pages_rake_tasks/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'github_pages_rake_tasks'
+  spec.version       = GithubPagesRakeTasks::VERSION
+  spec.authors       = ['James Couball']
+  spec.email         = ['jcouball@yahoo.com']
+
+  spec.summary       = 'Rake tasks for publishing documentation to GitHub Pages'
+  spec.description   = <<~DESCRIPTION
+    A Rake task to publish documentation like yard or mkdocs to GitHub Pages.
+
+    The rake task copies all files from the src_dir and pushes them to the
+    GitHub repository and branch identified by repo_url and branch_name.
+
+    The contents of the branch are completely overwritten by the contents of src_dir.
+  DESCRIPTION
+
+  spec.homepage = 'https://github.com/jcouball/github_pages_rake_tasks'
+  spec.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = spec.homepage
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bump', '~> 0.8'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'bundler-audit', '~> 0.6'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rubocop', '~> 0.70'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+  spec.add_development_dependency 'simplecov-lcov', '~> 0.7'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'yardstick', '~> 0.9'
+end

data/lib/github_pages_rake_tasks.rb

@@ -0,0 +1,8 @@
+# Copyright (c) 2019 James Couball
+
+# frozen_string_literal: true
+
+require 'github_pages_rake_tasks/version'
+require 'github_pages_rake_tasks/interface'
+require 'github_pages_rake_tasks/publish_task'
+require 'github_pages_rake_tasks/state'

data/lib/github_pages_rake_tasks/interface.rb

@@ -0,0 +1,77 @@
+# Copyright (c) 2019 James Couball
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'rake'
+
+module GithubPagesRakeTasks
+  # Whenever the publish task has to interact with things outside of itself,
+  # it uses an instance of the interface class.  This makes the tests easy to
+  # mock.
+  #
+  # @example
+  #   interface = Interface.new
+  #   interface.chdir(path) do |path|
+  #     interface.sh('git clone https://github.com/jcouball/project')
+  #   end
+  #
+  # Inject an object into an instance of PublishTask in order to mock the
+  # task's interaction with the outside world.
+  #
+  # @example
+  #   PublishTask.new do |t|
+  #     t.interface = Object.new
+  #       def chdir(path); end
+  #       ...
+  #     end
+  #   end
+  #
+  # @see https://docs.ruby-lang.org/en/2.6.0/Dir.html Dir documentation
+  # @see https://docs.ruby-lang.org/en/2.6.0/File.html File documentation
+  # @see https://docs.ruby-lang.org/en/2.6.0/FileUtils.html FileUtils documentation
+  #
+  # @api public
+  #
+  class Interface
+    extend Forwardable
+
+    def_delegators :@file_utils, :chdir, :rm_rf, :cp_r, :sh, :verbose
+    def_delegators :@dir, :mktmpdir
+    def_delegator  :@dir, :exist?, :dir_exist?
+    def_delegators :@file, :expand_path
+    def_delegator  :@file, :write, :file_write
+
+    # Creates a new interface object
+    #
+    # This object will delegate methods to the objects passed in as defined in
+    # the Forwardable def_delegators above.
+    #
+    # @example
+    #   interface = GithubPagesRakeTasks.new
+    #   interface.chdir('test') do
+    #     interface.cp_r(src, dest)
+    #   end
+    #
+    # @return [void]
+    #
+    def initialize
+      @file_utils = Rake::FileUtilsExt
+      @dir = Dir
+      @file = File
+    end
+
+    # Delegates call to Kernel::`
+    #
+    # @example
+    #   interface = GithubPagesRakeTasks::Interface.new
+    #   project_root = interface.send(:`, 'git rev-parse --show-toplevel').chomp
+    #
+    # @param cmd the command to run
+    #
+    # @return [String] the output of the command
+    #
+    def `(cmd)
+      super
+    end
+  end
+end

data/lib/github_pages_rake_tasks/publish_task.rb

@@ -0,0 +1,182 @@
+# Copyright (c) 2019 James Couball
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'rake'
+require 'rake/tasklib'
+require 'tmpdir'
+
+require 'github_pages_rake_tasks/interface'
+require 'github_pages_rake_tasks/state'
+
+module GithubPagesRakeTasks
+  # Instantiate this class to create a Rake task that pushes the contents from a
+  # local documentation directory to a GitHub repository branch.
+  #
+  # See {GithubPagesRakeTasks::PublishTask#initialize} for more details.
+  #
+  # @api public
+  #
+  class PublishTask < ::Rake::TaskLib
+    extend Forwardable
+
+    def_delegators(
+      :@state,
+      :interface, :interface=, :project_root, :project_root=, :rake_namespace, :rake_namespace=,
+      :doc_dir, :doc_dir=, :remote_name, :remote_name=, :repo_url, :repo_url=,
+      :staging_dir, :staging_dir=, :branch_name, :branch_name=,
+      :quiet, :quiet=, :verbose, :verbose=
+    )
+
+    # Create the publish task
+    #
+    # By default, the rake task `github-pages:publish` is created which pushes the `doc`
+    # directory within the local copy of your repository to the same repository's
+    # `gh-pages` branch.  The contents of the branch are completely replaced by the
+    # contents of the documentation directory.
+    #
+    # @example with default options
+    #   require 'github_pages_rake_tasks'
+    #   GitHubPagesRakeTasks.Tasks.new
+    #   task default: 'github-pages:publish'
+    #
+    # An initialization block can be passed to the initializer to set attributes
+    # to customize the behavior of the rake task created.  {GithubPagesRakeTasks::State}
+    # details all the attributes which can be set and what effect they have on the task.
+    #
+    # @example with an initialization block
+    #   require 'github_pages_rake_tasks'
+    #   GitHubPagesRakeTasks.Tasks.new do |task|
+    #     task.doc_dir = 'documentation'
+    #     task.verbose = true
+    #   end
+    #   task default: 'github-pages:publish'
+    #
+    # @param [Array<Object>] task_args arguments to pass to the task initialization
+    #   block.
+    #
+    # @param initialization_block If given, the task initialization will yield to
+    #   this block with the `task_args` to perform user initialization of the publish
+    #   task.
+    #
+    # @yield yields to the passed `initialization_block` for user initialization of this task.
+    # @yieldparam state [GithubPagesRakeTasks::State] the configuration state of this task. See
+    #   {State} for a description of the configuration attributes that can be set.
+    # @yieldparam task_args [Array<Object>] any args passed to this initializer
+    #   are passed to the yielded block.
+    #
+    def initialize(*task_args, &initialization_block)
+      @state = State.new
+
+      # Allow user to override defaults
+      #
+      yield(*[@state, task_args].slice(0, initialization_block.arity)) if initialization_block
+
+      namespace rake_namespace do
+        desc "Publish #{doc_dir} to #{repo_url}##{branch_name}"
+        task :publish do
+          display_header
+          publish
+          display_footer
+        end
+      end
+    end
+
+    private
+
+    # @!visibility private
+
+    def display_header
+      print "Publishing #{doc_dir} to #{repo_url}##{branch_name}..." unless quiet
+      puts if verbose
+    end
+
+    def display_footer
+      puts 'SUCCESS' unless quiet
+    end
+
+    def publish
+      interface.verbose(verbose) do
+        initialize_staging_dir
+        copy_doc_dir_to_staging_dir
+        commit_and_push_staging_dir
+        clean_staging_dir
+      end
+    end
+
+    def checkout_existing_branch
+      # only download the needed branch from GitHub
+      interface.sh("git fetch '#{remote_name}' '#{branch_name}'")
+      interface.sh("git checkout '#{branch_name}'")
+    end
+
+    def create_new_branch
+      interface.sh("git checkout --orphan '#{branch_name}'")
+      interface.file_write('index.html', 'Future home of documentation')
+      interface.sh('git add .')
+      interface.sh("git commit -m 'Create the documentation branch'")
+      interface.sh("git push '#{remote_name}' '#{branch_name}'")
+    end
+
+    def remote_branch_exists?
+      cmd = "git ls-remote --exit-code --heads '#{repo_url}' '#{branch_name}'"
+      interface.sh(cmd) do |branch_exists, _process_status|
+        branch_exists
+      end
+    end
+
+    def initialize_staging_repo
+      interface.mkdir_p(staging_dir) unless interface.dir_exist?(staging_dir)
+
+      interface.sh('git init')
+      interface.sh("git remote add '#{remote_name}' '#{repo_url}'")
+    end
+
+    # Creates `staging_dir` (if needed), clones the remote repository to it, and checks
+    # out `branch_name`.  Creates `branch_name` in the remote is needed.
+    #
+    # Finally, removes all files using git rm
+    #
+    def initialize_staging_dir
+      initialize_staging_repo
+      if remote_branch_exists?
+        checkout_existing_branch
+      else
+        create_new_branch
+      end
+      remove_staging_files
+    end
+
+    def clean_staging_dir
+      interface.rm_rf staging_dir
+    end
+
+    def absolute_doc_dir
+      @absolute_doc_dir ||= interface.expand_path(doc_dir, project_root)
+    end
+
+    def commit_message
+      @commit_message ||= 'Updating documentation'
+    end
+
+    def remove_staging_files
+      interface.chdir staging_dir do
+        interface.sh('git rm -r .') do
+          # ignore failure
+        end
+      end
+    end
+
+    def copy_doc_dir_to_staging_dir
+      interface.cp_r(File.join(absolute_doc_dir, '.'), staging_dir)
+    end
+
+    def commit_and_push_staging_dir
+      interface.chdir staging_dir do
+        interface.sh('git add .')
+        interface.sh("git commit -m '#{commit_message}'")
+        interface.sh("git push --set-upstream #{remote_name} #{branch_name}")
+      end
+    end
+  end
+end

data/lib/github_pages_rake_tasks/state.rb

@@ -0,0 +1,171 @@
+# Copyright (c) 2019 James Couball
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'rake'
+require 'rake/tasklib'
+require 'tmpdir'
+require 'github_pages_rake_tasks/interface'
+
+module GithubPagesRakeTasks
+  # Keeps all attributes for {GithubPagesRakeTasks::PublishTask}.  These attributes control
+  # how the task works.
+  #
+  # All attributes have sensible defaults which will cause {GithubPagesRakeTasks::PublishTask}
+  # to completely overwrite the project's `gh-pages` branch with the contents of the project's
+  # `doc` directory.
+  #
+  # Most used attributes are {doc_dir}, {project_root}, {repo_url}, and {branch_name}.
+  #
+  class State
+    # The directory, relative to {project_root}, that contains the documentation to
+    # publish to GitHub.
+    #
+    # The default value is 'doc'
+    #
+    # @return [String] directory
+    #
+    def doc_dir
+      @doc_dir ||= 'doc'
+    end
+    attr_writer :doc_dir
+
+    # The absolute path to the project's Git repository. {doc_dir} is relative to this
+    # path.
+    #
+    # The default value is the value returned from `git rev-parse --show-toplevel` when
+    # run in the current working directory
+    #
+    # @return [String] directory
+    #
+    def project_root
+      @project_root ||= interface.send(:`, 'git rev-parse --show-toplevel').chomp
+    end
+    attr_writer :project_root
+
+    # The URL to the remote repository to push documentation.
+    #
+    # The default value is the value returned from `git config --get remote.origin.url`
+    #
+    # @return [String] url
+    #
+    def repo_url
+      @repo_url ||= Dir.chdir(project_root) do |_path|
+        interface.send(:`, "git config --get remote.#{remote_name}.url").chomp
+      end
+    end
+    attr_writer :repo_url
+
+    # The branch to push documentation to.
+    #
+    # The default value is 'gh-pages'
+    #
+    # @return [String] the branch name
+    #
+    def branch_name
+      @branch_name ||= 'gh-pages'
+    end
+    attr_writer :branch_name
+
+    # The directory where the documentation is staged prior to pushing to the Git remote.
+    # All files are copied from {doc_dir} to {staging_dir} where the push to the Git remote is
+    # done.
+    #
+    # @note This directory is deleted at the end of the publish task.
+    #
+    # The default value is a temporary directory created with
+    # [Dir.mktmpdir](https://ruby-doc.org/stdlib-2.6.3/libdoc/tmpdir/rdoc/Dir.html)
+    # with the prefix 'github-pages-publish-'
+    #
+    # @return [String] a temporary directory.
+    #
+    def staging_dir
+      @staging_dir ||= interface.mktmpdir('github-pages-publish-')
+    end
+    attr_writer :staging_dir
+
+    # @!attribute quiet
+    # Silence all output from the `github-pages:publish` task.
+    #
+    # When {quiet} is true, the `github-pages:publish` task will not emit any output
+    #   unless there is an error.
+    #
+    # Setting {quiet} to true will also set {verbose} to false.
+    #
+    # The default value is false
+    #
+    # @return [Boolean] the quiet flag value
+    #
+    def quiet
+      return @quiet if instance_variable_defined?(:@quiet)
+
+      @quiet = false
+    end
+
+    def quiet=(value)
+      @quiet = value
+      @verbose = false if quiet
+    end
+
+    # @!attribute verbose
+    # Make the `github-pages:publish` emit extra output.
+    #
+    # When {verbose} is true, the `github-pages:publish` task will emit extra output
+    #   that is useful for debugging.
+    #
+    # Setting {verbose} to true will also set {quiet} to false.
+    #
+    # The default value is false
+    #
+    # @return [Boolean] the verbose flag value
+    #
+    def verbose
+      return @verbose if instance_variable_defined?(:@verbose)
+
+      @verbose = false
+    end
+
+    def verbose=(value)
+      @verbose = value
+      @quiet = false if verbose
+    end
+
+    # The name of the Git remote to use for pushing documentation.
+    #
+    # The default value is 'origin'
+    #
+    # @return [String] the Git remote name
+    #
+    def remote_name
+      @remote_name ||= 'origin'
+    end
+    attr_writer :remote_name
+
+    # An object that implements all methods that touch the world outside of
+    # the PublishTask class.  This includes dealing with the file system, issuing
+    # shell commands, etc.
+    #
+    # The default value is a new instance of {GithubPagesRakeTasks::Interface}
+    #
+    # @note {interface} is used for mocking during testing of this gem and is probably
+    #   not useful for users of this gem.
+    #
+    # @return [GithubPagesRakeTasks::Instance] an interface object
+    #
+    def interface
+      @interface ||= Interface.new
+    end
+    attr_writer :interface
+
+    # The Rake namespace for the publish task.
+    #
+    # The default value is 'github-pages'
+    #
+    # @return [String] Rake namespace
+    #
+    def rake_namespace
+      @rake_namespace ||= 'github-pages'
+    end
+    attr_writer :rake_namespace
+  end
+end

data/lib/github_pages_rake_tasks/version.rb

@@ -0,0 +1,7 @@
+# Copyright (c) 2019 James Couball
+# frozen_string_literal: true
+
+module GithubPagesRakeTasks
+  # Version of this module
+  VERSION = '0.1.1'
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: github_pages_rake_tasks
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- James Couball
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bump
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yardstick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: |
+  A Rake task to publish documentation like yard or mkdocs to GitHub Pages.
+
+  The rake task copies all files from the src_dir and pushes them to the
+  GitHub repository and branch identified by repo_url and branch_name.
+
+  The contents of the branch are completely overwritten by the contents of src_dir.
+email:
+- jcouball@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- github_pages_rake_tasks.gemspec
+- lib/github_pages_rake_tasks.rb
+- lib/github_pages_rake_tasks/interface.rb
+- lib/github_pages_rake_tasks/publish_task.rb
+- lib/github_pages_rake_tasks/state.rb
+- lib/github_pages_rake_tasks/version.rb
+homepage: https://github.com/jcouball/github_pages_rake_tasks
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jcouball/github_pages_rake_tasks
+  source_code_uri: https://github.com/jcouball/github_pages_rake_tasks
+  changelog_uri: https://github.com/jcouball/github_pages_rake_tasks
+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.6.14.4
+signing_key: 
+specification_version: 4
+summary: Rake tasks for publishing documentation to GitHub Pages
+test_files: []