jekyll_pocket 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d56376e07c5f3b086f04ab5f6ecf31b118b822b94a378c5d733b93976acb9bf
+  data.tar.gz: 3f9e34e10714523ff816f5c09b34103509922e750fcc4826eb42f86bf1d249b5
+SHA512:
+  metadata.gz: 22572ab23d9e63fc349ffe0ae5beddc0e97867402b029b425fd6915a960ded2d6ad2fdd63e456e40d6bbd8816afcc54306d0fe2418a8aa4c7c9a7c4f8754fd33
+  data.tar.gz: fc030777702aaeb18d073327ab229aec53951c2d33f12eb64e5f0afc1e563d7b6869d0f894f2f209dca0bd457b467c0414057cfeda3b0edbbc5e64507f836516

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+/test_build
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'vendor/bundle/**/*'
+    - 'spec/**/*'
+Style/DoubleNegation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Layout/EmptyComment:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 20
+Metrics/AbcSize:
+  Max: 20
+Metrics/LineLength:
+  IgnoredPatterns:
+    - 'warn'
+    - 'puts'
+    - 'raise'
+Style/RedundantSelf:
+  Enabled: false
+Layout/EmptyLineAfterGuardClause:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm: 2.5
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

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 at mn2802@columbia.edu. 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,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Marii
+
+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,47 @@
+# jekyll_pocket
+
+jekyll hook plugin for building a fully portable site 🎣💾👝
+
+[![Gem Version](https://badge.fury.io/rb/jekyll_pocket.svg)](https://badge.fury.io/rb/jekyll_pocket) ![License](https://img.shields.io/badge/license-MIT-yellowgreen.svg) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![Build Status](https://travis-ci.org/mnyrop/jekyll_pocket.svg?branch=master)](https://travis-ci.org/mnyrop/jekyll_pocket) [![](https://img.shields.io/librariesio/github/mnyrop/jekyll_pocket.svg)](https://libraries.io/github/mnyrop/jekyll_pocket)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll_pocket'
+```
+
+Then execute:
+
+```sh
+$ bundle
+```
+
+And add it as a jekyll plugin in your `_config.yml` file
+
+```yaml
+plugins:
+    - jekyll_pocket
+```
+
+## Usage
+
+Make sure all of your files are using file extensions by setting `permalink: none` in your `_config.yml` file and looking through any custom page-level permalinks.
+
+Then run jekyll build in pocket mode with:
+
+```
+$ bundle exec jekyll build JEKYLL_ENV=pocket
+```
+
+When the build is finished, you should be able to double click on your compiled index.html page and open up a fully functioning, serverless site in your browser. The links are all relative so you can move the site onto a thumbdrive and share it offline however you like.
+
+## 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 JekyllPocket project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jekyll_pocket/blob/master/CODE_OF_CONDUCT.md).

data/jekyll_pocket.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll_pocket/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll_pocket'
+  spec.version       = JekyllPocket::VERSION
+  spec.authors       = ['Marii']
+  spec.email         = ['m.nyrop@columbia.edu']
+
+  spec.summary       = 'jekyll hook plugin for building a fully portable site'
+  spec.homepage      = 'https://github.com/mnyrop/jekyll_pocket'
+  spec.license       = 'MIT'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  spec.bindir                 = 'exe'
+  spec.require_paths          = ['lib']
+  spec.required_ruby_version  = '~> 2.4'
+
+  spec.add_runtime_dependency 'html-proofer', '>= 3.8', '< 4.0'
+  spec.add_runtime_dependency('jekyll', '>= 3.7', '< 4.0')
+
+  spec.add_development_dependency 'bundler', '>= 1.16', '< 1.18'
+  spec.add_development_dependency 'colorize', '~> 0.8'
+  spec.add_development_dependency 'minima', '~> 2.5'
+  spec.add_development_dependency 'rspec', '>= 3.0', '< 4.0'
+  spec.add_development_dependency 'rubocop', '>= 0.60', '< 0.70'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

data/lib/jekyll_pocket.rb

@@ -0,0 +1,48 @@
+require 'jekyll'
+require 'yaml'
+
+require_relative 'jekyll_pocket/check'
+require_relative 'jekyll_pocket/utils'
+require_relative 'jekyll_pocket/site'
+
+#
+#
+module JekyllPocket
+  QUIET           = !ENV['DEBUG']
+  RUN_POCKET      = !!(ENV['JEKYLL_ENV'] == 'pocket').freeze
+  DEFAULT_ROOT    = '~~&&~~JEKYLL~~&&~POCKET~&&~~ROOT~~&&~~'.freeze
+  DEFAULT_CONFIG  = './_config.yml'.freeze
+
+  #
+  #
+  def self.quiet_stdout
+    if QUIET
+      begin
+        orig_stderr = $stderr.clone
+        orig_stdout = $stdout.clone
+        $stderr.reopen File.new('/dev/null', 'w')
+        $stdout.reopen File.new('/dev/null', 'w')
+        retval = yield
+      rescue StandardError => e
+        $stdout.reopen orig_stdout
+        $stderr.reopen orig_stderr
+        raise e
+      ensure
+        $stdout.reopen orig_stdout
+        $stderr.reopen orig_stderr
+      end
+      retval
+    else
+      yield
+    end
+  end
+
+  if RUN_POCKET
+    site = JekyllPocket::Site.new
+    site.reconfigure
+    Jekyll::Hooks.register :site, :post_write do |hook|
+      site.rewrite(hook)
+      puts "\nJekyllPocket::Success ~> Your pocket site was written to '#{hook.dest.gsub(`pwd`.strip, '')}'".cyan
+    end
+  end
+end

data/lib/jekyll_pocket/check.rb

@@ -0,0 +1,39 @@
+module JekyllPocket
+  #
+  #
+  module Check
+    #
+    #
+    def self.links(dir)
+      opts = { checks_to_ignore: %w[ImageCheck ScriptCheck] }
+      runner = JekyllPocket.quiet_stdout do
+        r = HTMLProofer.check_directory(dir, opts)
+        r.check_files
+        r
+      end
+
+      process_externals(runner.external_urls)
+      process_failures(runner.process_files)
+    end
+
+    #
+    #
+    def self.process_failures(files)
+      failures = files.map { |i| i[:failures] }.flatten
+      return if failures.empty?
+
+      warn "\nJekyllPocket::Error ~> The following broken links were detected:".red
+      failures.each do |failure|
+        warn "- link: '#{failure.content}'\n  in file: '#{failure.path.gsub(`pwd`.strip, '')}'\n  problem: '#{failure.desc}'"
+      end
+    end
+
+    def self.process_externals(externals)
+      return if externals.empty?
+      warn "\nJekyllPocket::Warning ~> The following external links will not work offline:".yellow
+      externals.each do |link, file|
+        warn "- link: '#{link}'\n  in file: '#{file.first.gsub(`pwd`.strip, '')}'"
+      end
+    end
+  end
+end

data/lib/jekyll_pocket/site.rb

@@ -0,0 +1,66 @@
+require 'html-proofer'
+require 'jekyll'
+
+module JekyllPocket
+  #
+  #
+  class Site
+    def initialize(conf = nil)
+      @config = self.config(conf)
+      @root   = self.unique_root
+    end
+
+    #
+    #
+    def reconfigure
+      Jekyll::Hooks.register :site, :after_init do |hook|
+        hook.config['baseurl']    = @root
+        hook.config['permalink']  = 'none'
+      end
+    end
+
+    #
+    #
+    def rewrite(hook)
+      JekyllPocket::Site.files(hook).each do |file|
+        content = File.read(file)
+        prefix  = JekyllPocket::Utils.depth_prefix(hook.dest, file)
+
+        JekyllPocket::Utils.matches(content, @root).each do |match|
+          result    = match.gsub(%r{/#{@root}/}, prefix).gsub(/["']/, '')
+          resolved  = JekyllPocket::Utils.resolve(result, file)
+
+          content.gsub!(match, resolved)
+        end
+
+        File.write(file, content)
+      end
+
+      JekyllPocket::Check.links(hook.dest)
+    end
+
+    #
+    #
+    def self.files(site)
+      Dir.glob("#{site.dest}/**/*").select { |f| File.file?(f) }
+    end
+
+    #
+    #
+    def unique_root
+      @config&.dig('jekyll_pocket', 'unique_root') || JekyllPocket::DEFAULT_ROOT
+    end
+
+    #
+    #
+    def config(conf)
+      if conf.is_a? Hash
+        conf
+      elsif File.exist? JekyllPocket::DEFAULT_CONFIG
+        YAML.safe_load(File.read(JekyllPocket::DEFAULT_CONFIG))
+      else
+        raise StandardError, 'JekyllPocket::Error ~> No valid config'.red
+      end
+    end
+  end
+end

data/lib/jekyll_pocket/utils.rb

@@ -0,0 +1,40 @@
+module JekyllPocket
+  #
+  #
+  module Utils
+    #
+    #
+    def self.depth_prefix(dest, file)
+      prefix  = ''
+      pdest   = Pathname.new(dest)
+      rpath   = Pathname.new(file).relative_path_from(pdest)
+      depth   = rpath.to_s.count('/')
+      depth.times { prefix.prepend('../') }
+      prefix
+    end
+
+    #
+    #
+    def self.matches(content, root)
+      single_quoted_matches = content.scan(/['].?#{root}[^']*[']/)
+      double_quoted_matches = content.scan(/["].?#{root}[^"]*["]/)
+      single_quoted_matches.concat double_quoted_matches
+    end
+
+    #
+    #
+    def self.resolve(result, file)
+      if File.extname(result).empty?
+        if result.empty? || result.end_with?('/')
+          result += 'index.html'
+        else
+          warn 'JekyllPocket::Warning ~> Missing File Extension'.yellow
+          warn "- link '#{result}'\n  in file: '#{file.gsub(`pwd`.strip, '')}'\n"
+          warn "  Auto-resolving as #{result}.html.\n".cyan
+          result += '.html'
+        end
+      end
+      result
+    end
+  end
+end

data/lib/jekyll_pocket/version.rb

@@ -0,0 +1,3 @@
+module JekyllPocket
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_pocket
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marii
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: html-proofer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.18'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: minima
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.60'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.60'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.70'
+- !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'
+description: 
+email:
+- m.nyrop@columbia.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- jekyll_pocket.gemspec
+- lib/jekyll_pocket.rb
+- lib/jekyll_pocket/check.rb
+- lib/jekyll_pocket/site.rb
+- lib/jekyll_pocket/utils.rb
+- lib/jekyll_pocket/version.rb
+homepage: https://github.com/mnyrop/jekyll_pocket
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: jekyll hook plugin for building a fully portable site
+test_files: []