jekyll-securitytxt 0.1.0.pre.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d2447b077d669e477795a699abc17da5efa9c94cc1e77ae59fca029e10477127
+  data.tar.gz: e59865c8ecb4cebb2d0383b4bbdddd58373f00e9da057f597d7916cc993922b5
+SHA512:
+  metadata.gz: 669eca2228b1063dd4a1879ec3ad32de75994f4fc86fabac5517834dcad886aff9bd214b538dc81d1a4c9dbdb6f8e349d5c4679b6d4429933e2965a0bbbb34f3
+  data.tar.gz: 259b25ccf40e9f143b430015031f5568ed7b8f9c26a3aa9525c3e7690f6571de7994fb7599bef9ea6473fe9406afe7ac27402153598170fb8fb239dabcb5f7a6

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/README.md

@@ -0,0 +1,31 @@
+# Jekyll::Securitytxt
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/jekyll/securitytxt`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, 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/[USERNAME]/jekyll-securitytxt.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/jekyll-securitytxt.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll/securitytxt/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-securitytxt"
+  spec.version = Jekyll::Securitytxt::VERSION
+  spec.authors = ["HAHWUL"]
+  spec.email = ["hahwul@gmail.com"]
+
+  spec.summary = "Jekyll plugin for security.txt"
+  spec.description = "Jekyll plugin for security.txt"
+  spec.homepage = "https://github.com/hahwul/jekyll-securitytxt"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "jekyll", "~> 3.8.0"
+end

data/lib/jekyll/securitytxt/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Securitytxt
+    VERSION = "0.1.0-pre"
+  end
+end

data/lib/jekyll/securitytxt.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "securitytxt/version"
+require "jekyll"
+
+module Jekyll
+  module Securitytxt
+    # Jekyll plugin for security.txt
+    class Generator < Jekyll::Generator
+      safe true
+      priority :lowest
+
+      # Plugin entry point.
+      def generate(site)
+        @site = site
+        @site.pages << verification_file unless a_verification_file_exist?
+      end
+
+      private
+
+      # Check if a security.txt file already exists in the source tree.
+      def a_verification_file_exist?
+        file_pattern = %r{.well-known/security\.txt?}
+        exists = @site.static_files.any? { |p| p.url =~ file_pattern }
+        warn_msg = "Found a security.txt file in source tree matching /#{file_pattern.source}/; not generating one..."
+        Jekyll.logger.warn LOG_TAG, warn_msg if exists
+        exists
+      end
+
+      # Get path of the template file.
+      def source_path(file = "template.html")
+        File.expand_path "../#{file}", __dir__
+      end
+
+      # Path of the security.txt file.
+      def securitytxt_path
+        ".well-known/security.txt"
+      end
+
+      # Construct a file object from a template with content that can be added to generated pages
+      def verification_file
+        Jekyll.logger.info LOG_TAG, "Generating #{securitytxt_path}"
+        page = PageWithoutAFile.new(@site, __dir__, "", securitytxt_path)
+        page.content = File.read(source_path)
+        page.data["layout"] = nil
+        page
+      end
+    end
+  end
+end

data/sig/jekyll/securitytxt.rbs

@@ -0,0 +1,6 @@
+module Jekyll
+  module Securitytxt
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-securitytxt
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.pre
+platform: ruby
+authors:
+- HAHWUL
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.8.0
+description: Jekyll plugin for security.txt
+email:
+- hahwul@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- jekyll-securitytxt.gemspec
+- lib/jekyll/securitytxt.rb
+- lib/jekyll/securitytxt/version.rb
+- sig/jekyll/securitytxt.rbs
+homepage: https://github.com/hahwul/jekyll-securitytxt
+licenses: []
+metadata:
+  homepage_uri: https://github.com/hahwul/jekyll-securitytxt
+  source_code_uri: https://github.com/hahwul/jekyll-securitytxt
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Jekyll plugin for security.txt
+test_files: []