jekyll-git-hash 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0853535b5875d9f98666e3bf9a245318f8654c56f32f5519fc4199ff7dc97bcd'
+  data.tar.gz: 94f23b7d966ef780a41396acb25744c918fe0eadd0747b955b1d42b1c58ddc57
+SHA512:
+  metadata.gz: 61ec5946a9cb7c7b6765f8d4be58be3dc8539d9cdd1e45707ae88b3140e81c0d28d6c1440167dcdbffabbe9f5fdffdad8267c4f479411c7c8bddcf80898b81fb
+  data.tar.gz: 64f15f3d2b727e16f5605d3c1baf68d0cc3fd1b52487e51bc81f2406a127a08f384ca315c2078c10f7b28708983f2f630246f57796363a3a6877cc91dcaf602b

data/.0pdd.yml

@@ -0,0 +1,9 @@
+errors:
+  - yegor256@gmail.com
+# alerts:
+#   github:
+#     - yegor256
+
+tags:
+  - pdd
+  - bug

data/.github/workflows/rake.yml

@@ -0,0 +1,24 @@
+---
+name: rake
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  test:
+    name: test
+    strategy:
+      matrix:
+        os: [ubuntu-20.04, macos-12, windows-2022]
+        ruby: [2.7, 3.1]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - run: bundle update
+      - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+*.gem
+.bundle/
+.DS_Store

data/.pdd

@@ -0,0 +1,7 @@
+--source=.
+--verbose
+--exclude target/**/*
+--exclude src/main/resources/images/**/*
+--rule min-words:20
+--rule min-estimate:15
+--rule max-estimate:90

data/.rubocop.yml

@@ -0,0 +1,23 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+    - 'assets/**/*'
+  DisplayCopNames: true
+  TargetRubyVersion: '2.6'
+  NewCops: enable
+  SuggestExtensions: false
+
+Lint/RescueException:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 50
+Metrics/ClassLength:
+  Max: 150
+Metrics/AbcSize:
+  Max: 60
+Metrics/BlockLength:
+  Max: 50
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+Naming/FileName:
+  Enabled: false

data/.rultor.yml

@@ -0,0 +1,20 @@
+docker:
+  image: yegor256/rultor-image:1.21.0
+assets:
+  rubygems.yml: yegor256/home#assets/rubygems.yml
+install: |
+  pdd -f /dev/null
+  sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"
+release:
+  script: |-
+    bundle exec rake
+    rm -rf *.gem
+    sed -i "s/0\.0\.0/${tag}/g" jekyll-git-hash.gemspec
+    git add jekyll-git-hash.gemspec
+    git commit -m "version set to ${tag}"
+    gem build jekyll-git-hash.gemspec
+    chmod 0600 ../rubygems.yml
+    gem push *.gem --config-file ../rubygems.yml
+merge:
+  script: |-
+    bundle exec rake

data/Gemfile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2014-2023 Yegor Bugayenko
+#
+# 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.
+
+source 'https://rubygems.org'
+gemspec
+
+gem 'rake', '13.0.6', require: false
+gem 'rubocop', '1.51.0', require: false
+gem 'rubocop-rspec', '2.22.0', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright (c) 2014-2023 Yegor Bugayenko
+
+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 @@
+[![rake](https://github.com/yegor256/jekyll-git-hash/actions/workflows/rake.yml/badge.svg)](https://github.com/yegor256/jekyll-git-hash/actions/workflows/rake.yml)
+[![Gem Version](https://badge.fury.io/rb/jekyll-git-hash.svg)](http://badge.fury.io/rb/jekyll-git-hash)
+
+Install it first:
+
+```
+gem install jekyll-git-hash
+```
+
+With Jekyll 2, simply add the gem to your `_config.yml` gems list:
+
+```yaml
+gems: ['jekyll-git-hash', ... your other plugins]
+```
+
+Or for previous versions,
+create a plugin file within your Jekyll project's `_plugins` directory:
+
+```ruby
+# _plugins/jekyll-git-hash.rb
+require 'jekyll-git-hash'
+```
+
+Highly recommend to use Bundler. If you're using it, add this line
+to your `Gemfile`:
+
+```
+gem "jekyll-git-hash"
+```
+
+The plugin is compatible with 
+[Jekyll 3.9.3](https://jekyllrb.com/news/2023/01/29/jekyll-3-9-3-released/) and 
+[Jekyll 4.3.2](https://jekyllrb.com/news/2023/01/20/jekyll-4-3-2-released/). 
+
+Use `{{ site.data['hash']}}` inside your liquid template.
+
+When the site is being generated by Jekyll, the
+plugin retrieves Git hash of the source code and
+exposes it as a item in `site.data`. This feature
+is very helpful when you want your static resources (CSS, JS, etc.)
+be reloaded by end users every time you deploy a new
+version of the site.
+
+For example, in your `default.html`:
+
+```html
+<link rel="stylesheet" href="/css/layout.css?{{ site.data['hash'] }}"/>
+```
+
+The URL will be generated with a suffix at the end. This
+suffix doesn't change the URL (`layout.css` will still
+be accesible by the browser), but it makes the URL unique
+for the browser when you deploy a new Git revision. All browsers
+will reload this CSS.

data/Rakefile

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2014-2023 Yegor Bugayenko
+#
+# 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.
+
+require 'rubygems'
+require 'rake'
+require 'rdoc'
+require 'rake/clean'
+
+def name
+  @name ||= File.basename(Dir['*.gemspec'].first, '.*')
+end
+
+def version
+  Gem::Specification.load(Dir['*.gemspec'].first).version
+end
+
+task default: %i[clean rubocop copyright]
+
+require 'rdoc/task'
+desc 'Build RDoc documentation'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rubocop/rake_task'
+desc 'Run RuboCop on all directories'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.fail_on_error = true
+  task.requires << 'rubocop-rspec'
+end
+
+task :copyright do
+  sh "grep -q -r '2014-#{Date.today.strftime('%Y')}' \
+    --include '*.rb' \
+    --include '*.txt' \
+    --include 'Rakefile' \
+    ."
+end

data/jekyll-git-hash.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2014-2023 Yegor Bugayenko
+#
+# 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.
+
+require 'English'
+
+Gem::Specification.new do |s|
+  s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
+  s.required_ruby_version = '>= 2.6'
+  s.name = 'jekyll-git-hash'
+  s.version = '0.1.0'
+  s.license = 'MIT'
+  s.summary = 'Jekyll Git Hash'
+  s.description = 'Adds Git hash to the properties of the Jekyll site'
+  s.authors = ['Yegor Bugayenko']
+  s.email = 'yegor256@gmail.com'
+  s.homepage = 'https://github.com/yegor256/jekyll-git-hash'
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.rdoc_options = ['--charset=UTF-8']
+  s.extra_rdoc_files = %w[README.md LICENSE.txt]
+  s.add_runtime_dependency 'jekyll', '>=3.9.2'
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/jekyll-git-hash.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# (The MIT License)
+#
+# Copyright (c) 2014-2023 Yegor Bugayenko
+#
+# 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.
+
+# Jekyll plugin for generating Git hash
+#
+# Place this file in the _plugins directory and
+# use {{ site.data['hash'] }} in your Liquid templates
+#
+# Author: Yegor Bugayenko <yegor@tpc2.com>
+# Source: http://github.com/yegor256/jekyll-git-hash
+#
+# Distributed under the MIT license
+# Copyright Yegor Bugayenko, 2014
+
+# Main Jekyll module
+module Jekyll
+  # Our class generator
+  class GitHashGenerator < Generator
+    priority :high
+    safe true
+    def generate(site)
+      hash = `git rev-parse --short HEAD`.strip
+      site.data['hash'] = hash
+    end
+  end
+end

data/renovate.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ],
+  "ignorePaths": [
+    "jekyll-tests/jekyll-3/Gemfile",
+    "jekyll-tests/jekyll-4/Gemfile"
+  ]
+}

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-git-hash
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yegor Bugayenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.9.2
+description: Adds Git hash to the properties of the Jekyll site
+email: yegor256@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
+files:
+- ".0pdd.yml"
+- ".github/workflows/rake.yml"
+- ".gitignore"
+- ".pdd"
+- ".rubocop.yml"
+- ".rultor.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll-git-hash.gemspec
+- lib/jekyll-git-hash.rb
+- renovate.json
+homepage: https://github.com/yegor256/jekyll-git-hash
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Jekyll Git Hash
+test_files: []