jekyll_push 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 636044e92b2da03bc6f0ba61b2138608abd9e0278ed167ab9524d71636328349
-  data.tar.gz: '09b919f4384d22765314f959ad9e8328b2ee7dd0733c339274b7861203a7306f'
+  metadata.gz: b0a8a44d8be31ec91a15c4c3b1a0865a64a66348f2ea250e1a1903ab4f362c84
+  data.tar.gz: 7e6ad00bad5aa41806c3a6e1297c03370620f9a4af61861d86d84145c2c8ce3f
 SHA512:
-  metadata.gz: 1abed319e1c23c713e4eb058e15ea01aa92537de7867cde43e99f836c777f0c39f0acae19e3d6e3c05406c30fc2bbe10ec4d63ef9574022c33e0f2bd5adc6113
-  data.tar.gz: a3d5de256787e99b9d00b6bb9eab8601f540f5b14eeb4f151839ab4439b0a2368a16ffa891ea8fc8c2848caa2c16428e5b91ffcb9accab6c1d01a1375d73b773
+  metadata.gz: 3998d73d53be927fa7835148b24b0b372bc8434643a0fa96993fdb70919cc1a3638dca5ddac7f1c018860c8e28da7d4a693ef567f21018cc1a2eb29161c96ee5
+  data.tar.gz: b4a18d3bbd4d5942e50da728abef94f2387a5931cda4c6dce419fc7ffa32ec7171b5d6c1f29e42fbdc800d1ff7d3e603b2aae336c6d0b64de9b572a5526bb812

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+/test/
+Gemfile.lock

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
 Layout/EmptyComment:
   Enabled: false
 Metrics/LineLength:
@@ -15,4 +15,9 @@ Style/DoubleNegation:
 Metrics/AbcSize:
   Max: 23
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
+Style/AndOr:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -8,5 +8,17 @@ before_install:
   - gem update --system
   - gem install bundler
 script:
-  - bundle exec rspec
   - bundle exec rubocop
+  - bundle exec rspec
+
+# code climate
+
+env:
+  global:
+    - CC_TEST_REPORTER_ID=09f760621cf09a9165e0202f5714ca6ca751a4a5a5e108cc50e488131390e7ac
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -3,4 +3,8 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'rubocop'
+# dev/test utilities
+gem 'minima', require: false
+gem 'rubocop', require: false
+gem 'simplecov', require: false
+gem 'yard', require: false

data/README.md

@@ -1,26 +1,57 @@
 # JekyllPush
-Jekyll gem plugin to push a compiled site to a GitHub branch. Works locally or on Travis CI if you add an access token.
+
+[![Build Status](https://travis-ci.org/mnyrop/jekyll_push.svg?branch=master)](https://travis-ci.org/mnyrop/jekyll_push) [![Gem Version](https://badge.fury.io/rb/jekyll_push.svg)](https://badge.fury.io/rb/jekyll_push) [![Gem Downloads](https://img.shields.io/gem/dt/jekyll_push.svg?color=046d0b)](https://badge.fury.io/rb/jekyll_push) [![Maintainability](https://api.codeclimate.com/v1/badges/25dfeec93e298350ce50/maintainability)](https://codeclimate.com/github/mnyrop/jekyll_push/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/25dfeec93e298350ce50/test_coverage)](https://codeclimate.com/github/mnyrop/jekyll_push/test_coverage) [![docs](http://img.shields.io/badge/docs-rdoc.info-blue.svg?style=flat)](https://www.rubydoc.info/github/mnyrop/jekyll_push/)  ![License](https://img.shields.io/github/license/mnyrop/jekyll_push.svg?color=c6a1e0) 
+
+__Jekyll gem plugin to push a compiled Jekyll site to a GitHub branch.__ Works locally or on Travis CI if you add an access token to your Travis build. Great for keeping archived copies or getting to use Jekyll Plugins and still host on GitHub pages.
+
+![push pop gif](https://media1.giphy.com/media/RI41Y0H0osVYQ/giphy.gif)
+ 
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add `jekyll_push` to your Jekyll sites's Gemfile within the `:jekyll_plugins` group:
 
 ```ruby
-gem 'jekyll_push'
+group :jekyll_plugins do
+ gem 'jekyll_push'
+end
 ```
 
 And then execute:
 
     $ bundle
-
-Or install it yourself as:
-
-    $ gem install jekyll_push
+    
+Make sure you also add `jekyll_push` as a `plugin` to your `_config.yml` file:
+```yml
+plugins:
+ - jekyll_push
+```
 
 ## Usage
 
 `$ jekyll push <branch_name>` or `$ bundle exec jekyll push <branch_name>`
 
+## Configuration
+
+### For GitHub pages
+
+If you run `jekyll push gh-pages` to use __GitHub pages publishing__, `JekyllPush` will look for a `repo_name` variable in your `_config.yml` file and try to construct a `baseurl` from it.
+
+For example, if you have a repository named `my_site` just add:
+
+```yaml
+repo_name: my_site
+```
+
+to your `_config.yml` file and `JekyllPush` will rebuild your site using `/my_site` as the `baseurl` before pushing it to the `gh-pages` branch. This lets you use `JekyllPush` for multiple branches and publish targets, with differing (base)url patterns.
+
+### When run locally
+
+[ TO DO ]
+
+### When run via Travis-CI
+
+[ TO DO ]
 
 ## Contributing
 

data/jekyll_push.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = 'jekyll_push'
-  spec.version       = '0.1.0'
+  spec.version       = '0.1.1'
   spec.authors       = ['marii']
   spec.email         = ['m.s.nyrop@gmail.com']
 
@@ -19,7 +19,5 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'jekyll', '> 3.0', '< 4.0'
   spec.add_runtime_dependency 'rainbow', '~> 3.0'
-
-  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/lib/jekyll_push/branch.rb

@@ -6,8 +6,7 @@ module JekyllPush
   class Branch
     attr_reader :target
 
-    # @param target [String]  the name of the Git branch to deploy to
-    # @param time   [String]  message with the time of deployment
+    # @param target [String] the name of the Git branch to deploy to
     def initialize(target)
       @target = JekyllPush::Utils.slugify target
       @time   = Time.now.strftime('%H:%M on %Y-%m-%d')
@@ -23,25 +22,25 @@ module JekyllPush
     end
 
     #
-    #
+    # @return [Boolean]
     def on_travis?
       !!ENV.fetch('CI', false)
     end
 
     #
-    #
+    # @return [Boolean]
     def local?
       !on_travis?
     end
 
     #
-    #
+    # @return [Array]
     def git_commands
       ['git init && git add .', "git commit -m '#{@commit}'", "git remote add origin #{@origin}", "git push origin master:refs/heads/#{@target} --force"]
     end
 
     #
-    #
+    # @return [Nil]
     def push(dir)
       files = Dir.glob "#{dir}/**/*"
       raise JekyllPush::Error::NoFilesBuilt, "Found no files inside site directory '#{dir}' to push." if files.empty?
@@ -57,13 +56,13 @@ module JekyllPush
     end
 
     #
-    #
+    # @return [Nil]
     def pretty_list(items)
       items.each { |i| puts "\t+ #{i.strip}" }
     end
 
     #
-    #
+    # @return [Nil]
     def system_try(command)
       puts Rainbow("\nTrying `#{command}`").cyan
       success = system command

data/lib/jekyll_push/command.rb

@@ -9,18 +9,10 @@ module JekyllPush
         prog.command(:push) do |c|
           c.syntax 'push [args]'
           c.description 'pushes compiled site to specified github branch'
-          c.action do |args, _options|
+          c.action do |args, _opts|
             raise Error::MissingBranch, "You must specify a target branch name after 'jekyll push'." if args.empty?
 
-            site   = JekyllPush::Site.new
-            branch = JekyllPush::Branch.new args.first
-
-            warn Rainbow('Warning: Building the site without a baseurl is not recommended if using GitHub pages.').yellow if site.baseurl.empty? && branch.target == 'gh-pages'
-
-            site.rebuild
-            branch.push site.dir
-
-            puts Rainbow("\nDone ✓").green
+            args.each { |a| JekyllPush.run_command a }
           end
         end
       end

data/lib/jekyll_push/error.rb

@@ -3,13 +3,14 @@
 module JekyllPush
   module Error
     #
-    #
+    # @param msg [String] the custom error message
     class RainbowError < StandardError
       def initialize(msg = '')
         super Rainbow(msg).magenta
       end
     end
 
+    class InvalidConfig < RainbowError; end
     class MissingBranch < RainbowError; end
     class NoFilesBuilt  < RainbowError; end
     class NoOrigin      < RainbowError; end

data/lib/jekyll_push/local.rb

@@ -5,19 +5,19 @@ module JekyllPush
   #
   module Local
     #
-    #
+    # @return [String]
     def commit
       "Updated via JekyllPush local task at #{@time}"
     end
 
     #
-    #
+    # @return [String]
     def origin
       `git config --get remote.origin.url`.strip
     end
 
     #
-    #
+    # @return [String]
     def msg
       "\nDeploying to branch '#{@target}' from local task."
     end

data/lib/jekyll_push/site.rb

@@ -4,38 +4,46 @@ module JekyllPush
   #
   #
   class Site
-    attr_reader :baseurl, :dir
-    #
+    attr_reader :baseurl, :repo, :dir
     #
+    # @param config [Hash] a site configuration hash
     def initialize(config = nil)
-      @config   = config || config_from_file
-      @baseurl  = @config.fetch 'baseurl', ''
-      @dir      = compiled_site_dir
+      @config   = config || JekyllPush.config_from_file
+      @baseurl  = @config.fetch :baseurl, ''
+      @repo     = @config.fetch :repo_name, ''
+      @dir      = site_dir
+    rescue TypeError => e
+      raise JekyllPush::Error::InvalidConfig, "An invalid (non-Hash) config was provided.\n#{e}"
     end
 
-    #
-    #
-    def config_from_file
-      YAML.load_file "#{`pwd`.strip}/_config.yml"
+    # @return [String]
+    def site_dir
+      File.join `pwd`.strip, '_site'
     end
 
+    # Use the repostory name as the baseurl when
+    # publishing to GitHub pages if available
     #
-    #
-    def compiled_site_dir
-      File.join `pwd`.strip, '_site'
+    # @return [String]
+    def gh_baseurl
+      if @repo.empty?
+        warn Rainbow("Warning: Building the site without the 'repo_name' baseurl is not recommended when using GitHub pages.").yellow if @baseurl.empty?
+        @baseurl
+      else
+        puts Rainbow("Rebuilding with baseurl '/#{@repo}'").cyan
+        "/#{@repo}"
+      end
     end
 
-    # Rebuild the Jekyll site with @baseurl
+    # Rebuild the Jekyll site
     # @return [Nil]
-    def rebuild
+    def rebuild(target)
+      @baseurl = gh_baseurl if target == 'gh-pages'
+
       FileUtils.rm_r @dir if File.directory? @dir
-      opts = {
-        destination: @dir,
-        baseurl: @baseurl
-      }
-      opts['source'] = @config.dig 'source_dir' if @config.key? 'source'
 
-      Jekyll::Site.new(Jekyll.configuration(opts)).process
+      opts = Jekyll.configuration destination: @dir, baseurl: @baseurl
+      Jekyll::Site.new(opts).process
     end
   end
 end

data/lib/jekyll_push/travis.rb

@@ -5,13 +5,13 @@ module JekyllPush
   #
   module Travis
     #
-    #
+    # @return [String]
     def commit
       "Updated via JekyllPush Travis \"#{ENV['TRAVIS_COMMIT']}\" at #{@time}."
     end
 
     #
-    #
+    # @return [String]
     def origin
       @repo_slug = ENV['TRAVIS_REPO_SLUG']
       @user      = @repo_slug.split('/').first
@@ -21,7 +21,7 @@ module JekyllPush
     end
 
     #
-    #
+    # @return [String]
     def msg
       "\nDeploying to branch '#{@target}' from Travis as #{@user}."
     end

data/lib/jekyll_push/utils.rb

@@ -5,7 +5,7 @@ module JekyllPush
   #
   module Utils
     #
-    #
+    # @return [String]
     def self.slugify(str)
       safe = str.to_s.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
       warn Rainbow("Warning: '#{str}' is not an acceptable branch name. Using '#{safe}' instead.").orange unless safe.eql?(str)

data/lib/jekyll_push.rb

@@ -15,4 +15,30 @@ require_relative 'jekyll_push/utils'
 
 #
 #
-module JekyllPush; end
+module JekyllPush
+  #
+  # @return [Nil]
+  def self.run_command(arg)
+    site   = JekyllPush::Site.new
+    branch = JekyllPush::Branch.new arg
+
+    site.rebuild branch.target
+    branch.push site.dir
+
+    puts Rainbow("\nDone ✓").green
+  end
+
+  #
+  # @return [String]
+  def self.config_path
+    "#{`pwd`.strip}/_config.yml"
+  end
+
+  #
+  # @return [Hash]
+  def self.config_from_file(path = config_path)
+    YAML.load_file path
+  rescue StandardError => e
+    raise JekyllPush::Error::InvalidConfig, "Could not load config file from path '#{path}'\n#{e}"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_push
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - marii
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-24 00:00:00.000000000 Z
+date: 2019-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -44,20 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -85,7 +71,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - jekyll_push.gemspec

data/Gemfile.lock

@@ -1,103 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jekyll_push (0.1.0)
-      jekyll (> 3.0, < 4.0)
-      rainbow (~> 3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
-    ast (2.4.0)
-    colorator (1.1.0)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    em-websocket (0.5.1)
-      eventmachine (>= 0.12.9)
-      http_parser.rb (~> 0.6.0)
-    eventmachine (1.2.7)
-    ffi (1.11.1)
-    forwardable-extended (2.6.0)
-    http_parser.rb (0.6.0)
-    i18n (0.9.5)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.3)
-    jekyll (3.8.6)
-      addressable (~> 2.4)
-      colorator (~> 1.0)
-      em-websocket (~> 0.5)
-      i18n (~> 0.7)
-      jekyll-sass-converter (~> 1.0)
-      jekyll-watch (~> 2.0)
-      kramdown (~> 1.14)
-      liquid (~> 4.0)
-      mercenary (~> 0.3.3)
-      pathutil (~> 0.9)
-      rouge (>= 1.7, < 4)
-      safe_yaml (~> 1.0)
-    jekyll-sass-converter (1.5.2)
-      sass (~> 3.4)
-    jekyll-watch (2.2.1)
-      listen (~> 3.0)
-    kramdown (1.17.0)
-    liquid (4.0.3)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    mercenary (0.3.6)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    pathutil (0.16.2)
-      forwardable-extended (~> 2.6)
-    public_suffix (3.1.1)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
-      ffi (~> 1.0)
-    rouge (3.7.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    rubocop (0.73.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.6)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    ruby_dep (1.5.0)
-    safe_yaml (1.0.5)
-    sass (3.7.4)
-      sass-listen (~> 4.0.0)
-    sass-listen (4.0.0)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-    unicode-display_width (1.6.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  jekyll_push!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop
-
-BUNDLED WITH
-   2.0.1