jekyll-securitytxt 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bf9a7a8e9e9da7610cf4042947f62bdfe74f4cf8d0346e4b32c2e6adef048a1
-  data.tar.gz: 004f60509c00a3a22c80a28636f0413b7034f2a45c7c2f91d511c3d1a7c01bc4
+  metadata.gz: 781ad29a0ac4d924c4d237b028a7cd8648602af05b70f73de7137871e842cc11
+  data.tar.gz: e0d92992aa601f7eb4a594fee6b234311f97c349a103349af280f7bf1750b866
 SHA512:
-  metadata.gz: 4f0e1a912d63253b091fdcb7f6411ab2461eb6838be97cf17f218332be32c0a440e804eb03bfac2ef53bc44658f8faf697c0ef5ea31c749afe1be71635074c02
-  data.tar.gz: 85013374e4bf966f87642e2bcbe35160baa6cb161b44d601e317a70e1fc1669ca7cb1b84ddfafbfe0b350fc1e7326d1e0c387b8dbf67f7a9c2d69aaa74d8fccc
+  metadata.gz: 591fd1598c32a33d526676be6054e48534af2f5c139fba07aad1208fe7453cafc011717d319f0ea2028ac4c0a6e03501dd3bd1a0b32053bd727630c48edefc37
+  data.tar.gz: a22ddad70f618567683069828b0bf4a39328e234538512fb22fc341b2de369c58a7533a5a24785b9fbb5b942c4f75c108a945138ff91dcaaccf05a721b7d1fd6

data/jekyll-securitytxt.gemspec

@@ -8,14 +8,15 @@ Gem::Specification.new do |spec|
   spec.authors = ["HAHWUL"]
   spec.email = ["hahwul@gmail.com"]
 
-  spec.summary = "Jekyll plugin for security.txt"
-  spec.description = "Jekyll plugin for security.txt"
+  spec.summary = "A Jekyll plugin for generating security.txt files"
+  spec.description = "This plugin helps you generate security.txt files for your Jekyll site, " \
+                     "providing security contact information and policies."
   spec.homepage = "https://github.com/hahwul/jekyll-securitytxt"
   spec.required_ruby_version = ">= 2.6.0"
   spec.license = "MIT"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/hahwul/jekyll-securitytxt"
 
   spec.files = Dir.chdir(__dir__) do
     `git ls-files -z`.split("\x0").reject do |f|
@@ -26,5 +27,6 @@ Gem::Specification.new do |spec|
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.add_dependency "jekyll"
+
+  spec.add_runtime_dependency "jekyll", "~> 4.0"
 end

data/lib/jekyll/securitytxt/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Securitytxt
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

data/lib/jekyll/securitytxt.rb

@@ -5,7 +5,7 @@ require "jekyll"
 
 module Jekyll
   module Securitytxt
-    # Jekyll plugin for security.txt
+    # Jekyll plugin for generating security.txt
     class Generator < Jekyll::Generator
       safe true
       priority :lowest
@@ -13,35 +13,38 @@ module Jekyll
       # Plugin entry point.
       def generate(site)
         @site = site
-        @site.pages << verification_file unless a_verification_file_exist?
+        @site.pages << create_security_txt_file unless security_txt_file_exists?
       end
 
       private
 
       # Check if a security.txt file already exists in the source tree.
-      def a_verification_file_exist?
+      def security_txt_file_exists?
         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 "Jekyll-securitytxt", warn_msg if exists
+        if exists
+          Jekyll.logger.warn "Jekyll-securitytxt",
+                             "Found a security.txt file in source tree matching",
+                             "/#{file_pattern.source}/; not generating one..."
+        end
         exists
       end
 
       # Get path of the template file.
-      def source_path(file = "template.html")
-        File.expand_path file.to_s, __dir__
+      def template_file_path(file = "template.html")
+        File.expand_path(file.to_s, __dir__)
       end
 
       # Path of the security.txt file.
-      def securitytxt_path
+      def security_txt_file_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 "Jekyll-securitytxt", "Generating #{securitytxt_path}"
-        page = PageWithoutAFile.new(@site, __dir__, "", securitytxt_path)
-        page.content = File.read(source_path)
+      def create_security_txt_file
+        Jekyll.logger.info "Jekyll-securitytxt", "Generating #{security_txt_file_path}"
+        page = PageWithoutAFile.new(@site, __dir__, "", security_txt_file_path)
+        page.content = File.read(template_file_path)
         page.data["layout"] = nil
         page
       end

metadata

@@ -1,30 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-securitytxt
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - HAHWUL
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-18 00:00:00.000000000 Z
+date: 2024-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Jekyll plugin for security.txt
+        version: '4.0'
+description: This plugin helps you generate security.txt files for your Jekyll site,
+  providing security contact information and policies.
 email:
 - hahwul@gmail.com
 executables: []
@@ -61,8 +62,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
-summary: Jekyll plugin for security.txt
+summary: A Jekyll plugin for generating security.txt files
 test_files: []