jekyll-netlify-headers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 47b2009161230a67a29370e5901b8891b76c6b266c52007cb6959e13036befac
+  data.tar.gz: 9d8eb3ccd4b3fad8fc90ef1e91ab2f6e301c6622bae97338c71d2658dd16ad8a
+SHA512:
+  metadata.gz: e68acca94090ae4d16e8c078f2787dee73f90cbdee9f18e68e2b1f435b5ab217da727da67efb087c3b5df5d6734fd8f62499e35694916676ba95e39089f719b1
+  data.tar.gz: 955df56d1c5e9fa0a3f81f18cf330a5d01e0c5ff62ca60019f1f84c55559793470337b441395bbd21df8e5addef2b009806edeb6440cb33f468e7c290f8f12b9

data/.editorconfig

@@ -0,0 +1,14 @@
+# EditorConfig is awesome: http://EditorConfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_size = 2
+indent_style = space
+trim_trailing_whitespace = true
+
+[*.md]
+indent_size = 4
+indent_style = tab

data/.gitignore

@@ -0,0 +1,28 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+# Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+# .ruby-version
+# .ruby-gemset

data/.rubocop

@@ -0,0 +1,3 @@
+--display-style-guide
+--extra-details
+--parallel

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Metrics/LineLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/CONTRIBUTING.md

@@ -0,0 +1,50 @@
+# Contributing to jekyll-netlify-headers
+
+I'd love to have your help improving jekyll-netlify-headers! If you'd like to pitch in, you can do so in a number of ways:
+
+1. Look through open [Issues](https://github.com/jgarber623/jekyll-netlify-headers/issues).
+1. Review any open [Pull Requests](https://github.com/jgarber623/jekyll-netlify-headers/pulls).
+1. [Fork jekyll-netlify-headers](#get-set-up-to-contribute) and fix an open Issue or add your own feature.
+1. File new Issues if you have a good idea or see a bug and don't know how to fix it yourself. _Only do this after you've made sure the behavior or problem you're seeing isn't already documented in an open Issue._
+
+I definitely appreciate your interest in (and help improving) jekyll-netlify-headers. Thanks!
+
+## Installation
+
+jekyll-netlify-headers is written in [Ruby](https://www.ruby-lang.org) (version 2.5.1) and development dependencies are managed using the [Bundler](https://bundler.io) gem.
+
+I manage Ruby versions with [rbenv](https://github.com/rbenv/rbenv). I'd recommend you do the same or use a similar Ruby version manager ([chruby](https://github.com/postmodern/chruby) or [RVM](https://rvm.io) come to mind). Once you've installed Ruby 2.5.1 using your method of choice, install the project's gems by running:
+
+```sh
+bundle install
+```
+
+…from the root of the project.
+
+## Get set up to contribute
+
+Contributing to jekyll-netlify-headers is pretty straightforward:
+
+1. Fork the jekyll-netlify-headers repo and clone it.
+1. Install development dependencies as outlined [above](#installation).
+1. Create a feature branch for the issue or new feature you're looking to tackle: `git checkout -b your-descriptive-branch-name`.
+1. _Write some code!_
+1. Build (`bin/rake build`) and install (`bin/rake install`) your updated code.
+1. Commit your changes: `git commit -am 'Add some new feature or fix some issue'`.
+1. Push the branch to your fork of jekyll-netlify-headers: `git push origin your-descriptive-branch-name`.
+1. Create a new Pull Request and I'll give it a look!
+
+## Code Style
+
+Code styles are like opinions: Everyone's got one and yours is better than mine. Here's how jekyll-netlify-headers should be written:
+
+- Use two-space indentation in Ruby.
+- No trailing whitespace and blank lines should have whitespace removed.
+- Prefer single quotes over double quotes unless interpolating.
+- Follow the conventions you see in the existing source code as best as you can.
+
+jekyll-netlify-headers's formatting guidelines are defined in the `.editorconfig` file which uses the [EditorConfig](http://editorconfig.org) syntax. There are [a number of great plugins for a variety of editors](http://editorconfig.org/#download) that utilize the settings in the `.editorconfig` file. EditorConfig takes the hassle out of syntax-specific formatting.
+
+Additionally, [Rubocop](https://github.com/bbatsov/rubocop) can be used to help identify possible trouble areas in your code. Run `bin/rubocop` to generate Rubocop's static code analysis report.
+
+Your bug fix or feature addition won't be rejected if it runs afoul of any (or all) of these guidelines, but following the guidelines will definitely make everyone's lives a little easier.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll-netlify-headers.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jason Garber
+
+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,88 @@
+# jekyll-netlify-headers
+
+**A Ruby gem for generating a [Netlify](https://www.netlify.com) headers configuration from a [Jekyll](https://jekyllrb.com) configuration.**
+
+[![Gem](https://img.shields.io/gem/v/jekyll-netlify-headers.svg?style=for-the-badge)](https://rubygems.org/gems/jekyll-netlify-headers)
+[![Downloads](https://img.shields.io/gem/dt/jekyll-netlify-headers.svg?style=for-the-badge)](https://rubygems.org/gems/jekyll-netlify-headers)
+
+Netlify's HTTP headers configuration is _quite_ powerful. Netlify provides two options for configuring your Netlify-deployed website's rules: either in [a `netlify.toml` file](https://www.netlify.com/docs/netlify-toml-reference/) or in [a `_headers` file](https://www.netlify.com/docs/headers-and-basic-auth/).
+
+Both file formats are perfectly serviceable, but if you're anything like me, you prefer fewer configuration files cluttering up your project. jekyll-netlify-headers allows you to configure your Netlify-deployed website's HTTP headers configuration using your project's existing Jekyll configuration file.
+
+## Getting Started
+
+Before installing and using jekyll-netlify-headers, you'll want to familiarize yourself with [Jekyll](https://jekyllrb.com) (a fabulous static site generator written in [Ruby](https://www.ruby-lang.org)) and [Netlify](https://www.netlify.com) (a fabulous website hosting service). In particular, you'll want to read up on Netlify's [Headers and Basic Authentication documentation](https://www.netlify.com/docs/headers-and-basic-auth/).
+
+## Installation
+
+If you're using [Bundler](https://bundler.io), add jekyll-netlify-headers to your project's `Gemfile`:
+
+```rb
+source 'https://rubygems.org'
+
+group :jekyll_plugins do
+  gem 'jekyll-netlify-headers'
+end
+```
+
+…and hop over to your command prompt and run…
+
+```sh
+$ bundle install
+```
+
+## Usage
+
+With jekyll-netlify-headers added to your project's `Gemfile` and installed, add the following to your [Jekyll configuration file](https://jekyllrb.com/docs/configuration/) (typically `_config.yml`):
+
+```yaml
+netlify:
+  headers:
+    - paths:
+        - /templates/index.html
+      headers:
+        - "X-Frame-Options: DENY"
+        - "X-XSS-Protection: 1; mode=block"
+    - paths:
+        - /templates/index2.html
+        - /templates/index3.html
+      headers:
+        - "X-Frame-Options: SAMEORIGIN"
+```
+
+**Note:** Netlify supports a variety of HTTP header configuration options, so comb through their [Headers and Basic Authentication documentation](https://www.netlify.com/docs/headers-and-basic-auth/) for more on the syntax. You may also want to test your HTTP header configuration at [Netlify's Playground](https://play.netlify.com/headers).
+
+With this configuration added to `_config.yml` (or to your custom Jekyll configuration file), Jekyll will generate a properly-formatted `_headers` file in the destination directory when building your project.
+
+The example above will yield a `_headers` file that looks like:
+
+```txt
+/templates/index.html
+  X-Frame-Options: DENY
+  X-XSS-Protection: 1; mode=block
+/templates/index2.html
+  X-Frame-Options: SAMEORIGIN
+/templates/index3.html
+  X-Frame-Options: SAMEORIGIN
+```
+
+## Improving jekyll-netlify-headers
+
+Want to help make jekyll-netlify-headers better? Hell yeah! I like your enthusiasm. For more on how you can help, check out [CONTRIBUTING.md](https://github.com/jgarber623/jekyll-netlify-headers/blob/master/CONTRIBUTING.md).
+
+### Donations
+
+If diving into Ruby isn't your thing, but you'd still like to support jekyll-netlify-headers, consider making a donation! Any amount—large or small—is greatly appreciated. As a token of my gratitude, I'll add your name to the [Acknowledgments](#acknowledgments) below.
+
+[![Donate via Square Cash](https://img.shields.io/badge/square%20cash-$jgarber-28c101.svg?style=for-the-badge)](https://cash.me/$jgarber)
+[![Donate via Paypal](https://img.shields.io/badge/paypal-jgarber-009cde.svg?style=for-the-badge)](https://www.paypal.me/jgarber)
+
+## Acknowledgments
+
+jekyll-netlify-headers wouldn't exist without the hard work of all the folks involved in designing, building, and maintaining Jekyll and Netlify. High fives, y'all. 🙌🏻
+
+jekyll-netlify-headers is written and maintained by [Jason Garber](https://sixtwothree.org).
+
+## License
+
+jekyll-netlify-headers is freely available under the [MIT License](https://opensource.org/licenses/MIT). Use it, learn from it, fork it, improve it, change it, tailor it to your needs.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/jekyll-netlify-headers.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'jekyll/netlify/headers/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = ['>= 2.4.0', '< 2.6']
+
+  spec.name          = 'jekyll-netlify-headers'
+  spec.version       = Jekyll::Netlify::Headers::VERSION
+  spec.authors       = ['Jason Garber']
+  spec.email         = ['jason@sixtwothree.org']
+
+  spec.summary       = 'Generate a Netlify HTTP headers configuration from a Jekyll configuration.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/jgarber623/jekyll-netlify-headers'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec)/}) }
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16', '>= 1.16.2'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.1'
+  spec.add_development_dependency 'rubocop', '~> 0.57.2'
+
+  spec.add_runtime_dependency 'jekyll', '~> 3.8', '>= 3.8.3'
+end

data/lib/jekyll/netlify/headers.rb

@@ -0,0 +1,2 @@
+require 'jekyll/netlify/headers/version'
+require 'jekyll/netlify/headers/generator'

data/lib/jekyll/netlify/headers/generator.rb

@@ -0,0 +1,40 @@
+require 'jekyll'
+
+module Jekyll
+  module Netlify
+    module Headers
+      class Generator < Jekyll::Generator
+        safe true
+        priority :low
+
+        def generate(site)
+          headers = site.config['netlify'] && site.config['netlify']['headers']
+
+          raise 'No Netlify headers found in Jekyll configuration file(s)!' unless headers
+
+          page = PageWithoutAFile.new(site, __dir__, '', '_headers')
+          page.content = page_content(headers)
+
+          site.pages << page
+        end
+
+        private
+
+        def page_content(headers)
+          content = []
+
+          headers.each do |hash|
+            mapped_headers = hash['headers'].map { |header| "  #{header}" }
+
+            hash['paths'].each do |path|
+              content << path
+              content << mapped_headers
+            end
+          end
+
+          content.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/netlify/headers/version.rb

@@ -0,0 +1,7 @@
+module Jekyll
+  module Netlify
+    module Headers
+      VERSION = '0.1.0'.freeze
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-netlify-headers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Garber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-21 00:00:00.000000000 Z
+dependencies:
+- !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.16.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.57.2
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.8.3
+description: Generate a Netlify HTTP headers configuration from a Jekyll configuration.
+email:
+- jason@sixtwothree.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop"
+- ".rubocop.yml"
+- ".ruby-version"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-netlify-headers.gemspec
+- lib/jekyll/netlify/headers.rb
+- lib/jekyll/netlify/headers/generator.rb
+- lib/jekyll/netlify/headers/version.rb
+homepage: https://github.com/jgarber623/jekyll-netlify-headers
+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.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '2.6'
+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: Generate a Netlify HTTP headers configuration from a Jekyll configuration.
+test_files: []