usmu-github-pages 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9eac8a8597e25ceb9e1edcf6e78245f95f89785a
-  data.tar.gz: de6e31fe794731809f85c423fee35ca480802286
+  metadata.gz: e8de3a318b1cc72d1f2861d3b4fbee68f9f8b7da
+  data.tar.gz: 10e7765259b32a2e7b3ce9397bee9a4cd43ad58c
 SHA512:
-  metadata.gz: 37fd1c37f5f4c788ac6a07c3d5cbc5372409805e389c8541a98594bb0a4c313e66638a5be965f4e43c845f90e550d56618a712b2ba168dc71e300b33d1627ff1
-  data.tar.gz: 685c5588abe097d531f9984dc2132f97c814c4e2762ca267b746a454adcec18472cea1a160d3faf7293fb00df6e4298d9a8fc042a88d25e083de2e00a09cc47b
+  metadata.gz: 7517767aaed9757dbeeb2b1e4822e62d34d89be78afcbc90fa10cc437231f585e3efad95f07aad56317ca4a0b72e2dbaea33a5fc9810ceb30e7bc3c73f124508
+  data.tar.gz: ca383f949175e377aea5b425223daa94755143081e6ce0b52524518e987930dee07ae26d677cc57387d1e60f7ab132c42aa0bafad9240d880bf2d4e36d4e05ba

data/Guardfile

@@ -3,7 +3,7 @@
 
 guard :rspec, cmd: 'rspec', spec_paths: ['spec'] do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/usmu/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/usmu/github/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^spec/support})      { 'spec' }
   watch('spec/spec_helper.rb')  { 'spec' }
 

data/Rakefile

@@ -16,7 +16,7 @@ desc 'Run all test scripts'
 task :test => [:clean, :spec, :mutant]
 
 desc 'Run mutation tests'
-task :mutant, [:target] => [:clean] do |t,args|
+task :mutant, [:target] => [:clean] do |_, args|
   old = ENV.delete('CODECLIMATE_REPO_TOKEN')
   if `which mutant 2>&1 > /dev/null; echo \$?`.to_i != 0
     puts 'Mutant isn\'t supported on your platform. Please run these tests on MRI <= 2.1.5.'
@@ -67,7 +67,7 @@ end
 
 # (mostly) borrowed from: https://gist.github.com/mcansky/802396
 desc 'generate changelog with nice clean output'
-task :changelog, :since_c, :until_c do |t,args|
+task :changelog, :since_c, :until_c do |_, args|
   since_c = args[:since_c] || `git tag | egrep '^[0-9]+\\.[0-9]+\\.[0-9]+\$' | sort -Vr | head -n 1`.chomp
   until_c = args[:until_c]
   cmd=`git log --pretty="format:%ci::::%an <%ae>::::%s::::%H" #{since_c}..#{until_c}`
@@ -76,16 +76,15 @@ task :changelog, :since_c, :until_c do |t,args|
   changelog_content = "\#\# #{Usmu::Github::Pages::VERSION}\n\n"
 
   cmd.lines.each do |entry|
-    date, author, subject, hash = entry.chomp.split('::::')
+    _date, author, subject, hash = entry.chomp.split('::::')
     entries[author] = Array.new unless entries[author]
-    day = date.split(' ').first
     entries[author] << "#{subject} (#{hash})" unless subject =~ /Merge/
   end
 
   # generate clean output
   entries.keys.each do |author|
     changelog_content += author + "\n\n"
-    entries[author].reverse.each { |entry| changelog_content += "* #{entry}\n" }
+    entries[author].reverse_each { |entry| changelog_content += "* #{entry}\n" }
   end
 
   puts changelog_content

data/lib/usmu/github/pages.rb

@@ -3,141 +3,42 @@
   uri
   usmu/github/pages/version
   usmu/github/pages/configuration
+  usmu/github/pages/commands
 }.each {|f| require f }
 
-module Usmu
-  module Github
-    class Pages
-      def initialize
-        @log = Logging.logger[self]
-        @log.debug("Initializing usmu-github-pages v#{VERSION}")
-      end
-
-      # @see Usmu::Plugin::CoreHooks#commands
-      def commands(ui, c)
-        @log.debug('Adding commands from usmu-github-pages.')
-        @ui = ui
-
-        c.command(:'gh-pages init') do |command|
-          command.syntax = 'usmu gh-pages init'
-          command.description = 'Ensures that your repository is compatible and setup correctly for Github Pages.'
-          command.action &method(:command_init)
-        end
-
-        c.command(:'gh-pages deploy') do |command|
-          command.syntax = 'usmu gh-pages deploy'
-          command.description = 'Generates a site and commits it to Github.'
-          command.action &method(:command_deploy)
-        end
-      end
-
-      def command_init(args, options)
-        config = Configuration.new(@ui.configuration['plugin', 'github-pages', default: {}])
-
-        # Ensure git (>= 2.5).
-        git_version = `git version 2>&1`.split(' ').last
-        if Gem::Version.new(git_version) < Gem::Version.new('2.5.0')
-          @log.fatal('The Github Pages plugin requires at least git version 2.5.0')
-          exit 1
-        end
-
-        # Work out what the correct gh-pages branch is.
-        remote = config['remote', default: 'origin']
-        branch = config['branch', default: config.default_branch(remote)]
-        @log.info("Configuring to deploy to #{remote}/#{branch}.")
-
-        # Ensure destination is gitignored.
-        destination = @ui.configuration['destination', default: 'site']
-        gitignore_path = File.expand_path './.gitignore', @ui.configuration.config_dir
-        gitignore = File.read(gitignore_path).lines.map(&:chomp)
-        if gitignore.grep(%r{^/?#{File.basename destination}$}).empty?
-          @log.info("Adding #{destination} to gitignore at #{gitignore_path}")
-          gitignore.push("#{File.basename destination}")
-          File.write gitignore_path, gitignore.join("\n") + "\n"
-        end
-
-        # Ensure the destination directory is configured correctly.
-        destination = @ui.configuration.destination_path
-        if File.exist? destination
-          unless File.file? File.expand_path('./.git', destination)
-            if File.exist? File.expand_path('./.git', destination)
-              @log.fatal('Destination directory looks like a git clone not a worktree: ' + destination)
-            else
-              @log.fatal('Destination directory exists but doesn\'t look like it is controlled by git: ' + destination)
-            end
-            exit 1
-          end
-        else
-          @log.info("Configuring git worktree at: #{destination}")
-          `git worktree prune 2>&1`
-          `git worktree add #{Shellwords.escape destination} HEAD 2>&1`
-        end
-
-        # Check if branch exists locally and remotely.
-        branches = `git branch -a`.lines.map{|l| l[2..-1]}.map(&:chomp)
-        local = !branches.select{|b| b == branch }.empty?
-        remote = !branches.select{|b| b == "remotes/#{remote}/#{branch}" }.empty?
-        if !local && !remote
-          Dir.chdir destination do
-            `git checkout -f --orphan #{Shellwords.escape branch} 2>&1`
-            `git rm -r . 2>&1`
-          end
-        else
-          Dir.chdir destination do
-            `git checkout -f #{Shellwords.escape branch} 2>&1`
-          end
-        end
-      end
-
-      def command_deploy(args, options)
-        @configuration = @ui.configuration
-        config = Configuration.new(@ui.configuration['plugin', 'github-pages', default: {}])
-        remote = config['remote', default: 'origin']
-        branch = config['branch', default: config.default_branch(remote)]
-        destination = @ui.configuration.destination_path
+class Usmu::Github::Pages
+  def initialize
+    @log = Logging.logger[self]
+    @log.debug("Initializing usmu-github-pages v#{VERSION}")
+  end
 
-        # Ensure we're deploying a complete commit.
-        sha = `git rev-parse HEAD`.chomp[0, 7]
-        unless `git diff HEAD --name-only`.lines.count == 0
-          @log.fatal("Found unsaved changes in your git repository. Please commit these changes and try again.")
-          exit 1
-        end
+  # @see Usmu::Plugin::CoreHooks#commands
+  def commands(ui, c)
+    @log.debug('Adding commands from usmu-github-pages.')
+    @ui = ui
 
-        # Ensure clean worktree.
-        @log.info("Cleaning output directory.")
-        Dir.chdir destination do
-          `git fetch #{Shellwords.escape remote} 2>&1`
-          `git reset --hard #{Shellwords.escape remote}/#{Shellwords.escape branch} 2>&1`
-        end
+    c.command(:'gh-pages init') do |command|
+      command.syntax = 'usmu gh-pages init'
+      command.description = 'Ensures that your repository is compatible and setup correctly for Github Pages.'
+      command.action(&method(:command_init))
+    end
 
-        # Regenerate site.
-        Usmu.plugins[Usmu::Plugin::Core].command_generate({}, options)
+    c.command(:'gh-pages deploy') do |command|
+      command.syntax = 'usmu gh-pages deploy'
+      command.description = 'Generates a site and commits it to Github.'
+      command.action(&method(:command_deploy))
+    end
+  end
 
-        Dir.chdir destination do
-          # Commit results.
-          `git add . 2>&1`
-          if `git diff HEAD --name-only`.lines.count == 0
-            @log.info "Detected no changes - deploy aborted."
-            exit 0
-          end
-          `git commit -a -m "Update created by usmu-github-pages from revision #{sha}." 2>&1`
-          if $?.exitstatus != 0
-            @log.fatal "Unable to create a new commit. Please check the destination folder for more information."
-            exit 1
-          end
+  def config
+    @config ||= Configuration.new(@ui.configuration['plugin', 'github-pages', default: {}])
+  end
 
-          # Push branch to remote.
-          @log.info("Deploying to Github...")
-          `git push #{Shellwords.escape remote} #{Shellwords.escape branch} 2>&1`
-        end
+  def command_init(args, options)
+    Usmu::Github::Pages::Commands::Init.new(args, options).run(config)
+  end
 
-        cname_file = File.expand_path('./CNAME', destination)
-        if File.exist? cname_file
-          @log.success("Your site should be available shortly at http://#{File.read(cname_file).chomp}/")
-        else
-          @log.success("Deploy completed successfully.")
-        end
-      end
-    end
+  def command_deploy(args, options)
+    Usmu::Github::Pages::Commands::Deploy.new(args, options).run(config)
   end
 end

data/lib/usmu/github/pages/commands.rb

@@ -0,0 +1,7 @@
+module Usmu::Github::Pages::Commands
+end
+
+%w{
+  usmu/github/pages/commands/deploy
+  usmu/github/pages/commands/init
+}.each {|f| require f }

data/lib/usmu/github/pages/commands/deploy.rb

@@ -0,0 +1,68 @@
+
+class Usmu::Github::Pages::Commands::Deploy
+  def initialize(*)
+    @log = Logging.logger[self]
+  end
+
+  def run(ui, config)
+    remote = config['remote', default: 'origin']
+    branch = config['branch', default: config.default_branch(remote)]
+    destination = ui.configuration.destination_path
+
+    # Ensure we're deploying a complete commit.
+    sha = `git rev-parse HEAD`.chomp[0, 7]
+    unless working_dir_clean?
+      @log.fatal("Found unsaved changes in your git repository. Please commit these changes and try again.")
+      exit 1
+    end
+
+    # Ensure clean worktree.
+    @log.info("Cleaning output directory.")
+    clean_destination(destination, remote, branch)
+
+    # Regenerate site.
+    Usmu.plugins[Usmu::Plugin::Core].command_generate({}, options)
+
+    # Commit results.
+    create_commit!(destination, "Update created by usmu-github-pages from revision #{sha}.")
+
+    # Push branch to remote.
+    @log.info("Deploying to Github...")
+    `git push #{Shellwords.escape remote} #{Shellwords.escape branch} 2>&1`
+
+    cname_file = File.expand_path('./CNAME', destination)
+    if File.exist? cname_file
+      @log.success("Your site should be available shortly at http://#{File.read(cname_file).chomp}/")
+    else
+      @log.success("Deploy completed successfully.")
+    end
+  end
+
+  protected
+
+  def working_dir_clean?
+    `git diff HEAD --name-only`.lines.count == 0
+  end
+
+  def clean_destination(destination, remote, branch)
+    Dir.chdir destination do
+      remote = Shellwords.escape remote
+      branch = Shellwords.escape branch
+      `(git fetch #{remote} && git reset --hard #{remote}/#{branch}) 2>&1`
+    end
+  end
+
+  def create_commit!(destination, message)
+    Dir.chdir destination do
+      if working_dir_clean?
+        @log.info "Detected no changes - deploy aborted."
+        exit 0
+      end
+      `(git add . && git commit -a -m #{Shellwords.escape message}) 2>&1`
+      if $?.exitstatus != 0
+        @log.fatal "Unable to create a new commit. Please check the destination folder for more information."
+        exit 1
+      end
+    end
+  end
+end

data/lib/usmu/github/pages/commands/init.rb

@@ -0,0 +1,81 @@
+
+class Usmu::Github::Pages::Commands::Init
+  def initialize(*)
+    @log = Logging.logger[self]
+  end
+
+  def run(ui, config)
+    # Ensure git (>= 2.5).
+    ensure_git!
+
+    # Work out what the correct gh-pages branch is.
+    remote = config['remote', default: 'origin']
+    branch = config['branch', default: config.default_branch(remote)]
+    @log.info("Configuring to deploy to #{remote}/#{branch}")
+
+    # Ensure destination is gitignored.
+    destination = ui.configuration['destination', default: 'site']
+    gitignore_path = File.expand_path './.gitignore', ui.configuration.config_dir
+    gitignore = File.read(gitignore_path).lines.map(&:chomp)
+    if gitignore.grep(%r{^/?#{File.basename destination}$}).empty?
+      @log.info("Adding #{destination} to gitignore at #{gitignore_path}")
+      gitignore.push("#{File.basename destination}")
+      File.write gitignore_path, gitignore.join("\n") + "\n"
+    end
+
+    # Ensure the destination directory is configured correctly.
+    destination = ui.configuration.destination_path
+    ensure_destination! destination
+
+    # Check if branch exists locally and remotely.
+    branches = `git branch -a`.lines.map{|l| l[2..-1]}.map(&:chomp)
+    local = !branches.select{|b| b == branch }.empty?
+    remote = !branches.select{|b| b == "remotes/#{remote}/#{branch}" }.empty?
+    if !local && !remote
+      create_destination_branch destination, branch
+    else
+      checkout_destination_branch destination, branch
+    end
+  end
+
+  protected
+
+  def ensure_git!
+    git_version = `git version 2>&1`.split(' ').last
+    if Gem::Version.new(git_version) < Gem::Version.new('2.5.0')
+      @log.fatal('The Github Pages plugin requires at least git version 2.5.0')
+      exit 1
+    end
+  end
+
+  def ensure_destination!(destination)
+    if File.exist? destination
+      unless File.file? File.expand_path('./.git', destination)
+        if File.exist? File.expand_path('./.git', destination)
+          @log.fatal('Destination directory looks like a git clone not a worktree: ' + destination)
+        else
+          @log.fatal('Destination directory exists but doesn\'t look like it is controlled by git: ' + destination)
+        end
+        exit 1
+      end
+    else
+      @log.info("Configuring git worktree at: #{destination}")
+      `git worktree prune 2>&1`
+      `git worktree add #{Shellwords.escape destination} HEAD 2>&1`
+    end
+  end
+
+  def create_destination_branch(destination, branch)
+    Dir.chdir destination do
+      `git checkout -f --orphan #{Shellwords.escape branch} 2>&1`
+      `git rm -r . 2>&1`
+      `git clean -fd 2>&1`
+    end
+  end
+
+  def checkout_destination_branch(destination, branch)
+    Dir.chdir destination do
+      `git checkout -f #{Shellwords.escape branch} 2>&1`
+    end
+  end
+end

data/lib/usmu/github/pages/version.rb

@@ -3,7 +3,7 @@ module Usmu
   module Github
     class Pages
       # The current version string for the gem
-      VERSION = '1.0.1'
+      VERSION = '1.0.2'
     end
   end
 end

data/spec/pages/configuration_spec.rb

@@ -0,0 +1,12 @@
+require 'usmu/github/pages/configuration'
+require 'ostruct'
+
+RSpec.describe Usmu::Github::Pages::Configuration do
+  context '#initialize' do
+    it 'indexes the configuration parameter' do
+      values = {foo: 'bar'}
+      conf = described_class.new(values)
+      expect(conf[:foo]).to eq('bar')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usmu-github-pages
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Matthew Scharley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: usmu
@@ -175,8 +175,12 @@ files:
 - Rakefile
 - circle.yml
 - lib/usmu/github/pages.rb
+- lib/usmu/github/pages/commands.rb
+- lib/usmu/github/pages/commands/deploy.rb
+- lib/usmu/github/pages/commands/init.rb
 - lib/usmu/github/pages/configuration.rb
 - lib/usmu/github/pages/version.rb
+- spec/pages/configuration_spec.rb
 - spec/spec_helper.rb
 - usmu-github-pages.gemspec
 homepage: https://github.com/usmu/usmu-github-pages
@@ -204,5 +208,6 @@ signing_key:
 specification_version: 4
 summary: Github Pages publishing plugin for Usmu.
 test_files:
+- spec/pages/configuration_spec.rb
 - spec/spec_helper.rb
 has_rdoc: