jekyll-server-side-redirects 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 74d0db5a60bef8efed746b530acafd98ec7516510cfb39c3519cf7d694e5d66d
+  data.tar.gz: 44fb17ef5b55b31d0e3f297ee0086225dc1f3db3f637ff60e55034d64b277d40
+SHA512:
+  metadata.gz: 83e50d23e0d8eb818079d1b5e9f3a493c5f8155782300abf2df8eacc5f3beb4f9baa79e2b5beebfebfc4594a2c567763e33886e066f7355d3d4d3556bb13d04e
+  data.tar.gz: 19e6aa05b93ceb88fa2020e48752785f8b2c8be76c33f024b1ac2b706ad603fcee23459f738cc6c2a1c1fbc9989b48799a1c89320bf7ba20793cc32834415581

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Aline Marques
+
+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,100 @@
+# Jekyll Server-Side Redirects
+
+A Jekyll plugin that generates server-specific redirection files (e.g., `.htaccess` or `firebase.json`) to improve SEO by allowing you to create server-side redirects with appropriate HTTP status codes.
+
+## Features
+
+- **Server Support**: Generate redirect configuration for:
+  - Firebase Hosting (`firebase.json`)
+  - Apache (`.htaccess`)
+- **SEO Optimization**: Properly inform search engines about page moves using HTTP status codes.
+- **Jekyll Integration**: Define redirects directly in your Jekyll pages and posts using `redirect_from` in the frontmatter.
+
+## Installation
+
+### As a Ruby Gem
+1. Add the gem to your `Gemfile`:
+
+   ```ruby
+   gem 'jekyll-server-side-redirects'
+   ```
+
+2. Run `bundle install` to install the gem.
+
+### Manually
+
+If you're not using Bundler, you can install the gem manually:
+
+```ruby
+gem install jekyll-server-side-redirects
+```
+
+Then, add it to your _config.yml file:
+
+```yaml
+plugins:
+  - jekyll-server-side-redirects
+```
+
+
+## Configuration
+
+Add the following configuration to your _config.yml file:
+
+
+```yaml
+server_redirects:
+  server: 'apache' # Options: 'firebase', 'apache'
+```
+
+## Usage
+
+### Add Redirects in Frontmatter
+
+Define redirects in the redirect_from frontmatter field for your pages or posts:
+```yaml
+---
+title: "My New Page"
+redirect_from:
+  - /old-page1/
+  - /another-old-page/
+redirect_type: 302 # Optional: Defaults to 301 (permanent redirect)
+---
+
+```
+
+### Build Your Jekyll Site
+
+When you build your site, the plugin will automatically generate the appropriate redirection file based on the configured server:
+
+For Firebase, a firebase.json file will be created or updated.
+For Apache, a .htaccess file will be created or updated.
+
+
+## Examples
+
+### Firebase
+
+A firebase.json file will be generated as follows:
+
+```json
+{
+  "hosting": {
+    "redirects": [
+      { "source": "/old-page1/", "destination": "/new-page1/", "type": 301 },
+      { "source": "/old-page2/", "destination": "/new-page2/", "type": 302 }
+    ]
+  }
+}
+```
+
+### Apache
+
+A .htaccess file will be generated as follows:
+
+```
+# .htaccess file generated by Jekyll Server-Side Redirects
+
+Redirect 301 /old-page1/ /new-page1/
+Redirect 302 /old-page2/ /new-page2/
+```

data/lib/jekyll-server-side-redirects/generator.rb

@@ -0,0 +1,22 @@
+require_relative './servers/firebase'
+require_relative './servers/apache'
+
+module Jekyll
+    module RedirectGenerator
+      def self.get_server(site)
+        config = site.config['server_redirects']
+        return unless config
+        server = config['server']
+        
+        case server
+        when 'firebase'
+            Jekyll::ServerSideRedirects::Firebase.generate_redirects(site)
+        when 'apache' 
+            Jekyll::ServerSideRedirects::Apache.generate_redirects(site)
+        else
+            raise 'Invalid server specified'
+        end
+      end
+    end
+end
+  

data/lib/jekyll-server-side-redirects/servers/apache.rb

@@ -0,0 +1,73 @@
+module Jekyll
+    module ServerSideRedirects
+        module Apache
+            def self.generate_redirects(site)
+                redirects_data = []
+
+                redirects_data += process_redirects(site.pages)
+                redirects_data += process_redirects(site.posts.docs)
+                generate_htaccess(redirects_data)
+
+                redirects_data
+            end
+
+            def self.generate_htaccess(redirects_data)
+                file_path = ".htaccess"
+                existing_redirects = []
+
+                if File.exist?(file_path)
+                    existing_redirects = parse_existing_redirects(file_path)
+                end
+
+                all_redirects = (existing_redirects + redirects_data).uniq { |r| r['source'] }
+
+                File.open(file_path, "w") do |file|
+                    file.puts "# .htaccess file generated by Jekyll Server-Side Redirects"
+                    file.puts ""
+
+                    all_redirects.each do |redirect|
+                        file.puts "Redirect #{redirect['type']} #{redirect['source']} #{redirect['destination']}"
+                    end
+                end
+            end
+
+            def self.parse_existing_redirects(file_path)
+                redirects = []
+
+                File.readlines(file_path).each do |line|
+                    next unless line.strip.start_with?("Redirect")
+
+                    if line =~ /^Redirect\s+(\d{3})\s+(\S+)\s+(\S+)/
+                        type, source, destination = $1.to_i, $2, $3
+                        redirects << {
+                            'source' => source,
+                            'destination' => destination,
+                            'type' => type
+                        }
+                    end
+                end
+
+                redirects
+            end
+
+            def self.process_redirects(data)
+                redirects = []
+                data.each do |item|
+                    next unless item.data['redirect_from']
+
+                    redirect_from = item.data['redirect_from']
+                    redirect_from = [redirect_from] unless redirect_from.is_a?(Array)
+
+                    redirect_from.each do |source|
+                        redirects << {
+                            'source' => source,
+                            'destination' => item.permalink,
+                            'type' => item.data['redirect_type'] || 301 
+                        }
+                    end
+                end
+                redirects
+            end
+        end
+    end
+end

data/lib/jekyll-server-side-redirects/servers/firebase.rb

@@ -0,0 +1,57 @@
+module Jekyll
+    module ServerSideRedirects
+        module Firebase
+            def self.generate_redirects(site)
+                redirects_data = []
+
+                redirects_data += process_redirects(site.pages)
+                redirects_data += process_redirects(site.posts.docs)
+                generate_firebase_json(redirects_data)
+
+                redirects_data
+            end
+
+            def self.generate_firebase_json(redirects_data)
+                file_path = "firebase.json"
+                firebase_content = {}
+
+                if File.exist?(file_path)
+                    file_content = File.read(file_path)
+                    firebase_content = JSON.parse(file_content)
+                else
+                    firebase_content["hosting"] = { "redirects" => [] }
+                end
+
+                valid_keys = ['source', 'destination', 'type']
+                existing_redirects = firebase_content["hosting"]["redirects"].map do |redirect|
+                    redirect.select { |key, _| valid_keys.include?(key) }
+                end
+
+                firebase_content["hosting"]["redirects"] = (existing_redirects + redirects_data).uniq { |r| r["source"] }
+
+                File.open(file_path, "w") do |file|
+                    file.write(JSON.pretty_generate(firebase_content))
+                end
+            end
+
+            def self.process_redirects(data)
+                redirects = []
+                data.each do |item|
+                    next unless item.data['redirect_from']
+
+                    redirect_from = item.data['redirect_from']
+                    redirect_from = [redirect_from] unless redirect_from.is_a?(Array)
+
+                    redirect_from.each do |source|
+                        redirects << {
+                            'source' => source,
+                            'destination' => item.permalink,
+                            'type' => item.data['redirect_type'] || 301 
+                        }
+                    end
+                end
+                redirects
+            end
+        end
+    end
+end

data/lib/jekyll-server-side-redirects.rb

@@ -0,0 +1,4 @@
+module Jekyll
+    module RedirectGenerator
+    end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-server-side-redirects
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aline Marques
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+description: Generates server-specific files for handling redirects (e.g., .htaccess,
+  firebase.json).
+email:
+- alinem_oliveira@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll-server-side-redirects.rb
+- lib/jekyll-server-side-redirects/generator.rb
+- lib/jekyll-server-side-redirects/servers/apache.rb
+- lib/jekyll-server-side-redirects/servers/firebase.rb
+homepage: https://github.com/marquesaline/jekyll-server-side-redirects
+licenses:
+- MIT
+metadata: {}
+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.4.19
+signing_key:
+specification_version: 4
+summary: Jekyll plugin to generate server-side redirects
+test_files: []