jekyll_push 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 636044e92b2da03bc6f0ba61b2138608abd9e0278ed167ab9524d71636328349
+  data.tar.gz: '09b919f4384d22765314f959ad9e8328b2ee7dd0733c339274b7861203a7306f'
+SHA512:
+  metadata.gz: 1abed319e1c23c713e4eb058e15ea01aa92537de7867cde43e99f836c777f0c39f0acae19e3d6e3c05406c30fc2bbe10ec4d63ef9574022c33e0f2bd5adc6113
+  data.tar.gz: a3d5de256787e99b9d00b6bb9eab8601f540f5b14eeb4f151839ab4439b0a2368a16ffa891ea8fc8c2848caa2c16428e5b91ffcb9accab6c1d01a1375d73b773

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+AllCops:
+  TargetRubyVersion: 2.4
+Layout/EmptyComment:
+  Enabled: false
+Metrics/LineLength:
+  Exclude:
+    - '*.gemspec'
+  IgnoredPatterns:
+    - 'raise'
+    - 'puts'
+    - 'warn'
+    - 'git'
+Style/DoubleNegation:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 23
+Metrics/MethodLength:
+  Max: 15

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4
+  - 2.5
+  - 2.6
+before_install:
+  - gem update --system
+  - gem install bundler
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec
+
+gem 'rubocop'

data/Gemfile.lock

@@ -0,0 +1,103 @@
+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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Marii Nyrop
+
+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,35 @@
+# 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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll_push'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jekyll_push
+
+## Usage
+
+`$ jekyll push <branch_name>` or `$ bundle exec jekyll push <branch_name>`
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mnyrop/jekyll_push. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the JekyllPush project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mnyrop/jekyll_push/blob/master/CODE_OF_CONDUCT.md).

data/jekyll_push.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll_push'
+  spec.version       = '0.1.0'
+  spec.authors       = ['marii']
+  spec.email         = ['m.s.nyrop@gmail.com']
+
+  spec.summary       = 'gem to push a compiled jekyll site to a github branch'
+  spec.description   = 'gem to push a compiled jekyll site to a github branch'
+  spec.homepage      = 'https://github.com/mnyrop/jekyll_push'
+  spec.license       = 'MIT'
+
+  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.require_paths = ['lib']
+
+  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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+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
+    def initialize(target)
+      @target = JekyllPush::Utils.slugify target
+      @time   = Time.now.strftime('%H:%M on %Y-%m-%d')
+
+      (class << self; include JekyllPush::Travis; end) if on_travis?
+      (class << self; include JekyllPush::Local; end)  if local?
+
+      @commit = commit
+      @origin = origin
+      @msg    = msg
+
+      raise JekyllPush::Error::NoOrigin, 'No remote origin was found for the project GitHub repository.' if @origin.empty?
+    end
+
+    #
+    #
+    def on_travis?
+      !!ENV.fetch('CI', false)
+    end
+
+    #
+    #
+    def local?
+      !on_travis?
+    end
+
+    #
+    #
+    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
+
+    #
+    #
+    def push(dir)
+      files = Dir.glob "#{dir}/**/*"
+      raise JekyllPush::Error::NoFilesBuilt, "Found no files inside site directory '#{dir}' to push." if files.empty?
+
+      puts Rainbow("\nFound the following _site files:").cyan
+      pretty_list files
+      puts Rainbow(@msg).cyan
+
+      Dir.chdir dir
+      File.open('.info', 'w') { |f| f.write @time }
+
+      git_commands.each { |cmd| system_try cmd }
+    end
+
+    #
+    #
+    def pretty_list(items)
+      items.each { |i| puts "\t+ #{i.strip}" }
+    end
+
+    #
+    #
+    def system_try(command)
+      puts Rainbow("\nTrying `#{command}`").cyan
+      success = system command
+      return if success
+
+      raise JekyllPush::Error::SystemCall, Rainbow("JekyllPush Failed on command '#{command}'.")
+    end
+  end
+end

data/lib/jekyll_push/command.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module JekyllPush
+  #
+  #
+  class Command < Jekyll::Command
+    class << self
+      def init_with_program(prog)
+        prog.command(:push) do |c|
+          c.syntax 'push [args]'
+          c.description 'pushes compiled site to specified github branch'
+          c.action do |args, _options|
+            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
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll_push/error.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module JekyllPush
+  module Error
+    #
+    #
+    class RainbowError < StandardError
+      def initialize(msg = '')
+        super Rainbow(msg).magenta
+      end
+    end
+
+    class MissingBranch < RainbowError; end
+    class NoFilesBuilt  < RainbowError; end
+    class NoOrigin      < RainbowError; end
+    class SystemCall    < RainbowError; end
+  end
+end

data/lib/jekyll_push/local.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module JekyllPush
+  #
+  #
+  module Local
+    #
+    #
+    def commit
+      "Updated via JekyllPush local task at #{@time}"
+    end
+
+    #
+    #
+    def origin
+      `git config --get remote.origin.url`.strip
+    end
+
+    #
+    #
+    def msg
+      "\nDeploying to branch '#{@target}' from local task."
+    end
+  end
+end

data/lib/jekyll_push/site.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module JekyllPush
+  #
+  #
+  class Site
+    attr_reader :baseurl, :dir
+    #
+    #
+    def initialize(config = nil)
+      @config   = config || config_from_file
+      @baseurl  = @config.fetch 'baseurl', ''
+      @dir      = compiled_site_dir
+    end
+
+    #
+    #
+    def config_from_file
+      YAML.load_file "#{`pwd`.strip}/_config.yml"
+    end
+
+    #
+    #
+    def compiled_site_dir
+      File.join `pwd`.strip, '_site'
+    end
+
+    # Rebuild the Jekyll site with @baseurl
+    # @return [Nil]
+    def rebuild
+      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
+    end
+  end
+end

data/lib/jekyll_push/travis.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module JekyllPush
+  #
+  #
+  module Travis
+    #
+    #
+    def commit
+      "Updated via JekyllPush Travis \"#{ENV['TRAVIS_COMMIT']}\" at #{@time}."
+    end
+
+    #
+    #
+    def origin
+      @repo_slug = ENV['TRAVIS_REPO_SLUG']
+      @user      = @repo_slug.split('/').first
+      @token     = ENV['ACCESS_TOKEN']
+
+      "https://#{@user}:#{@token}@github.com/#{@repo_slug}.git"
+    end
+
+    #
+    #
+    def msg
+      "\nDeploying to branch '#{@target}' from Travis as #{@user}."
+    end
+  end
+end

data/lib/jekyll_push/utils.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module JekyllPush
+  #
+  #
+  module Utils
+    #
+    #
+    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)
+      safe
+    end
+  end
+end

data/lib/jekyll_push.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# 3rd party
+require 'jekyll'
+require 'rainbow'
+
+# relative
+require_relative 'jekyll_push/branch'
+require_relative 'jekyll_push/command'
+require_relative 'jekyll_push/error'
+require_relative 'jekyll_push/local'
+require_relative 'jekyll_push/site'
+require_relative 'jekyll_push/travis'
+require_relative 'jekyll_push/utils'
+
+#
+#
+module JekyllPush; end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_push
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- marii
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: gem to push a compiled jekyll site to a github branch
+email:
+- m.s.nyrop@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- jekyll_push.gemspec
+- lib/jekyll_push.rb
+- lib/jekyll_push/branch.rb
+- lib/jekyll_push/command.rb
+- lib/jekyll_push/error.rb
+- lib/jekyll_push/local.rb
+- lib/jekyll_push/site.rb
+- lib/jekyll_push/travis.rb
+- lib/jekyll_push/utils.rb
+homepage: https://github.com/mnyrop/jekyll_push
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: gem to push a compiled jekyll site to a github branch
+test_files: []