jekyll-copyr 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 90eb1672594e9af2a7a669387b0c24fa126c06d9e86a5c10c9cfc1d9c04b265b
+  data.tar.gz: f37a92f37974365ae1af5c446f2bf540109f22132dcf09bd4a0efe7bad9628eb
+SHA512:
+  metadata.gz: 2309aed0ff26672b6430a589268d3e9c6f13a2a5200a2fadee49e4bb31ed447e5d0ef0e351905eebf69d66fd01f0d60e4c5914d41064cf400510e0ef7027ed85
+  data.tar.gz: ffc39dcb66989229ac5dbbef8d5cf0b5395b8795bdaa97ccc3f356b0d12b3aad4631dce4d95f934be5f8dee8021a2a54180f292081e1e5a3b1e9d48ca594bb70

data/.gitignore

@@ -0,0 +1,25 @@
+*.gem
+*.rbc
+*.sassc
+.bundle
+.config
+.yardoc
+.rvmrc
+.rspec
+.rspec_status
+.sass-cache
+.DS_Store
+Gemfile.lock # gem projects only!
+InstalledFiles
+_yardoc
+doc/
+coverage
+lib/bundler/man
+capybara-*.html
+pkg
+rdoc
+spec/reports
+spec/tmp
+test/tmp
+test/version_tmp
+tmp

data/.rubocop.yml

@@ -0,0 +1,17 @@
+require: rubocop-jekyll
+inherit_gem:
+  rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - vendor/**/*
+
+Layout/LineLength:
+  Exclude:
+    - spec/**/*
+    - jekyll-copyr.gemspec
+
+Layout/BlockLength:
+  Exclude:
+    - spec/**/* 

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "jekyll", ENV["JEKYLL_VERSION"] if ENV["JEKYLL_VERSION"]

data/Gemfile.lock

@@ -0,0 +1,111 @@
+PATH
+  remote: .
+  specs:
+    jekyll-copyr (1.0.0)
+      jekyll (>= 3.3, < 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.6)
+    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.12.2)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.6.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    jekyll (4.0.0)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (>= 0.9.5, < 2)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.3.3)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 1.8)
+    jekyll-sass-converter (2.1.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.1.0)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.3.6)
+    parallel (1.19.1)
+    parser (2.7.0.5)
+      ast (~> 2.4.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (4.0.3)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.4)
+    rouge (3.17.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-jekyll (0.11.0)
+      rubocop (>= 0.68.0, < 0.81.0)
+      rubocop-performance (~> 1.2)
+    rubocop-performance (1.5.2)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    safe_yaml (1.0.5)
+    sassc (2.2.1)
+      ffi (~> 1.9)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0.2)
+  jekyll-copyr!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop-jekyll (~> 0.11.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Danger Cove
+
+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,54 @@
+# Jekyll Copyr
+
+[![Gem Version](https://badge.fury.io/rb/jekyll-copyr.svg)](https://badge.fury.io/rb/jekyll-copyr)
+
+A Jekyll plugin that taps into `FileUtils.cp_r` from your `_config.yml`. Easily copy files from anywhere into your site.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+# Gemfile
+
+gem 'jekyll-copyr'
+```
+
+And then add this line to your application's `_config.yml`:
+
+```yml
+# _config.yml
+
+plugins:
+  - jekyll-copyr
+
+jekyll-copyr:
+  enabled: true # Optional, defaults to true
+  tasks:
+    - from: "./node_modules/@fortawesome/fontawesome-free/webfonts/."
+      to: "./_site/assets/webfonts/"
+```
+
+## Usage
+
+Add the `from` and `to` path of the files you want to copy into the array below `tasks`. You can add as many tasks as you want. The task above copies all the webfonts from fontawesome into the `_site` directory.
+
+## Purpose
+
+I've built this plugin to work around the need to ship my entire `node_modules` folder just to use some webfonts from Font Awesome.
+
+You can also copy files from outside your project folder into your site. This allows you to share files between projects.
+
+## Development
+
+After checking out the repo, run `script/bootstrap` to install dependencies. Then, run `rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `lib/jekyll-copyr/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/boyvanamstel/jekyll-copyr. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to behave appropriately.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/jekyll-copyr.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-copyr/version"
+
+Gem::Specification.new do |spec|
+  spec.name         = "jekyll-copyr"
+  spec.version      = Jekyll::Copyr::VERSION
+  spec.authors      = ["Boy van Amstel"]
+
+  spec.summary      = "A plugin for Jekyll to easily copy files."
+  spec.homepage     = "https://www.github.com/dangercove/jekyll-copyr"
+  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["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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_dependency "jekyll", ">= 3.3", "< 5.0"
+  spec.add_development_dependency "bundler", "~> 2.0.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop-jekyll", "~> 0.11.0"
+end

data/lib/jekyll/hooks/copyr.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Jekyll::Hooks.register :site, :post_write do |site|
+  copier = Jekyll::Copyr::Copier.new site.config.fetch "jekyll-copyr", nil
+  copier.process_post_write
+end

data/lib/jekyll-copyr/copier.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "fileutils"
+
+module Jekyll
+  module Copyr
+    class Copier
+      DEFAULTS = { "enabled" => true, "tasks" => [] }.freeze
+
+      def initialize(config = {})
+        if config.is_a?(Hash)
+          @config = Utils.deep_merge_hashes DEFAULTS, config
+        else
+          @config = nil
+          Jekyll.logger.warn "Copyr:", "Expected a hash but got #{config.inspect}"
+          Jekyll.logger.warn "", "Files will not be copied for this site."
+        end
+        @enabled = @config["enabled"]
+        @tasks = @config["tasks"].map { |task_hash| Task.new task_hash }
+      end
+
+      def process_post_write
+        return unless @enabled == true
+
+        @tasks.each { |task| process task }
+      end
+
+      private
+
+      def process(task)
+        FileUtils.mkdir_p task.to
+        FileUtils.cp_r task.from, task.to
+      end
+    end
+  end
+end

data/lib/jekyll-copyr/task.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Copyr
+    class Task
+      attr_accessor :from, :to
+
+      def initialize(task_hash = {})
+        @from = File.expand_path task_hash.fetch "from", nil
+        @to = File.expand_path task_hash.fetch "to", nil
+      end
+    end
+  end
+end

data/lib/jekyll-copyr/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Copyr
+    VERSION = "1.0.0"
+  end
+end

data/lib/jekyll-copyr.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll-copyr/version"
+require "jekyll-copyr/copier"
+require "jekyll-copyr/task"
+require "jekyll/hooks/copyr"
+
+module Jekyll
+  module Copyr
+  end
+end

data/script/bootstrap

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

data/script/cibuild

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+set -ex
+
+bundle exec rspec
+bundle exec rubocop -S -D
+bundle exec gem build jekyll-copyr.gemspec

data/script/release

@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -ex
+
+bundle exec rake release

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-copyr
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Boy van Amstel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-copyr.gemspec
+- lib/jekyll-copyr.rb
+- lib/jekyll-copyr/copier.rb
+- lib/jekyll-copyr/task.rb
+- lib/jekyll-copyr/version.rb
+- lib/jekyll/hooks/copyr.rb
+- script/bootstrap
+- script/cibuild
+- script/release
+homepage: https://www.github.com/dangercove/jekyll-copyr
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://www.github.com/dangercove/jekyll-copyr
+  changelog_uri: https://www.github.com/dangercove/jekyll-copyr
+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.3
+signing_key: 
+specification_version: 4
+summary: A plugin for Jekyll to easily copy files.
+test_files: []