jekyll-meilisearch 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ea5866f93ee6d60be594b225c5c161329787250f6ead78082f141cd723e1e27
-  data.tar.gz: 9e3b6508edcbd98d94d302369246f4984463019e3bb21909e8263b185d3cd072
+  metadata.gz: 4ac85d23f98262c0435458e1e8dfb102fd8339055082e9148f3baccf94ff6323
+  data.tar.gz: 0fec3f6b8f11663d4fe3dc09245a4cfe364bba94f387c8aab0eabbb2af977f28
 SHA512:
-  metadata.gz: 55858897684e4042eb808f737d892c902d2c0d9be925fb6421da478224f75a2ceae2af59a699a097c1d6fa9f9641e4ccbf29264b3a60bf86837f4fdc50aac04c
-  data.tar.gz: 7b2ac53a64ef94ea33294c240560b6e1df667d4625e3416ce8221dd1efc43d8e78320caa4665d3fad22dbdad50d8d7d6c69a954c05394d347a352da69312cb1b
+  metadata.gz: e03b3235366de8406732eb8f4be82540b9b74594538b5bb12cdc0a100c0d90244387ba3fcf66a22f16e51c4114ffa72e5f1bc9e2be2ad8bfed16055a1083a7c1
+  data.tar.gz: 48acdf958bc540cafb1893fb47f98392348b6e2b38c0f8444a4fa3ddc4a5ed3a73746a871724b7439a929f501cecb312c681409ab3f1edbab3e60c37ec3265eb

data/README.md

@@ -1,6 +1,9 @@
 # Jekyll Meilisearch Plugin
+
 A Jekyll plugin that indexes your site’s content into Meilisearch, a fast and lightweight search engine. This plugin supports incremental indexing, ensuring efficient updates by only syncing changes between your Jekyll site and Meilisearch.
 
+[![Continuous Integration](https://github.com/unicolored/jekyll-meilisearch/actions/workflows/ruby.yml/badge.svg)](https://github.com/unicolored/jekyll-meilisearch/actions/workflows/ruby.yml) [![Gem Version](https://badge.fury.io/rb/jekyll-meilisearch.svg)](https://badge.fury.io/rb/jekyll-meilisearch)
+
 ## Features
 - Indexes Jekyll collections (e.g., posts, pages) into Meilisearch.
 - Incremental updates: adds new documents, deletes obsolete ones, and skips unchanged content.
@@ -9,22 +12,18 @@ A Jekyll plugin that indexes your site’s content into Meilisearch, a fast and
 - Pagination support for large sites.
 
 ## Installation
-Add the gem to your Jekyll site’s Gemfile:
-
-```shell
-gem "jekyll-meilisearch", "~> 0.2.0"
-```
 
-Then run:
+Add the gem to your Jekyll site’s Gemfile:
 
-```shell
-bundle install
+```ruby
+gem "jekyll-meilisearch"
 ```
 
-Alternatively, install it directly:
+And then add this line to your site's `_config.yml`:
 
-```shell
-gem install jekyll-meilisearch
+```yml
+plugins:
+  - jekyll-meilisearch
 ```
 
 ## Configuration
@@ -44,15 +43,15 @@ meilisearch:
 ```
 
 ## Configuration Options
-- url: The Meilisearch server URL (required).
-- api_key: The Meilisearch API key (required). Recommended: use a dedicated api key for your index, not the admin one.
-- index_name: The name of the Meilisearch index (optional, defaults to jekyll_documents).
-- collections: A hash of Jekyll collections to index.
-  - fields: Array of fields to extract from each document (e.g., title, content, url, date).
-  - id_format: How to generate document IDs:
-    - "default" | "id": Uses collection-name-number if a number field exists, otherwise sanitizes the document ID.
-    - "url": Uses the document’s URL, sanitized.
-    - fallback: if "number" exists, uses "collection_name" + "number"
+* `url`: The Meilisearch server URL (required).
+* `api_key`: The Meilisearch API key (required). Recommended: use a dedicated api key for your index, not the admin one.
+* `index_name`: The name of the Meilisearch index (optional, defaults to jekyll_documents).
+* `collections`: A hash of Jekyll collections to index.
+  * `fields`: Array of fields to extract from each document (e.g., title, content, url, date).
+  * `id_format`: How to generate document IDs:
+    * "default" | "id": Uses collection-name-number if a number field exists, otherwise sanitizes the document ID.
+    * "url": Uses the document’s URL, sanitized.
+    * fallback: if "number" exists, uses "collection_name" + "number"
 
 Run your Jekyll build:
 
@@ -115,39 +114,20 @@ Include the following for adding search to your front :
 
 ```
 
-## Requirements
-- Ruby >= 2.7  
-- Jekyll >= 3.0, < 5.0  
-- Meilisearch server (local or hosted)
-
-## Dependencies:
-- httparty (for HTTP requests)  
-
-These are automatically installed when you add the gem to your Gemfile.
-
-## Development
-To contribute or modify the plugin:
+## Skip development
 
-- Clone the repository: git clone https://github.com/unicolored/jekyll-meilisearch.git cd jekyll-meilisearch
-- Install dependencies: bundle install
-- Make changes and test locally: gem build jekyll-meilisearch.gemspec gem install ./jekyll-meilisearch-0.1.0.gem
+Use `disable_in_development: true` if you want to turn off meilisearch indexation when `jekyll.environment == "development"`,
+but don't want to remove the plugin (so you don't accidentally commit the removal). Default value is `false`.
 
-## Releasing a New Version
-- Update the version in jekyll-meilisearch.gemspec.
-- Build the gem: gem build jekyll-meilisearch.gemspec
-- Push to RubyGems: gem push jekyll-meilisearch-x.x.x.gem
-
-## License
-This project is licensed under the MIT License.
+```yml
+meilisearch:
+  disable_in_development: true
+```
 
 ## Contributing
-Feel free to open issues or submit pull requests on GitHub.
 
-```shell
-bundle install
-# Update version in ./jekyll-meilisearch.gemspec
-# Build the gem
-gem build jekyll-meilisearch.gemspec
-# Push the gem
-gem push jekyll-meilisearch-${version}.gem
-```
+1. Fork it (https://github.com/unicolored/jekyll-meilisearch/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/lib/jekyll-meilisearch/generator.rb

@@ -12,7 +12,7 @@ module JekyllMeilisearch
         Jekyll.logger.info "Jekyll Meilisearch:", "Skipping meilisearch indexation in development"
         return
       end
-      Jekyll.logger.info 'Starting Meilisearch incremental indexing...'
+      Jekyll.logger.info "Starting Meilisearch incremental indexing..."
       return unless validate_config
 
       @documents = build_documents
@@ -27,12 +27,12 @@ module JekyllMeilisearch
     end
 
     def validate_config
-      unless config['url']
-        Jekyll.logger.info 'Error: Meilisearch URL not set in config. Skipping indexing.'
+      unless config["url"]
+        Jekyll.logger.info "Error: Meilisearch URL not set in config. Skipping indexing."
         return false
       end
-      unless config['api_key']
-        Jekyll.logger.info 'Error: Meilisearch API key not set in config. Skipping indexing.'
+      unless config["api_key"]
+        Jekyll.logger.info "Error: Meilisearch API key not set in config. Skipping indexing."
         return false
       end
       true
@@ -40,34 +40,34 @@ module JekyllMeilisearch
 
     def build_headers(api_key)
       {
-        'Content-Type' => 'application/json',
-        'Authorization' => "Bearer #{api_key}"
+        "Content-Type"  => "application/json",
+        "Authorization" => "Bearer #{api_key}",
       }
     end
 
     def build_documents
       documents = []
-      collections_config = config['collections'] || { 'posts' => { 'fields' => %w[title content url date] } }
+      collections_config = config["collections"] || { "posts" => { "fields" => %w(title content url date) } }
 
       collections_config.each do |collection_name, collection_settings|
         collection = @site.collections[collection_name]
         if collection
           Jekyll.logger.info "Processing collection: '#{collection_name}'..."
-          fields_to_index = collection_settings['fields'] || %w[title content url date]
-          id_format = collection_settings['id_format'] || :default
+          fields_to_index = collection_settings["fields"] || %w(title content url date)
+          id_format = collection_settings["id_format"] || :default
 
           collection_docs = collection.docs.map do |doc|
             sanitized_id = generate_id(doc, collection_name, id_format)
             doc_data = {
-              'id' => sanitized_id,
-              'content' => doc.content.strip,
-              'url' => doc.url
+              "id"      => sanitized_id,
+              "content" => doc.content.strip,
+              "url"     => doc.url,
             }
             fields_to_index.each do |field|
-              next if %w[id content url].include?(field)
+              next if %w(id content url).include?(field)
 
               value = doc.data[field]
-              doc_data[field] = field == 'date' && value ? value.strftime('%Y-%m-%d') : value
+              doc_data[field] = field == "date" && value ? value.strftime("%Y-%m-%d") : value
             end
             doc_data
           end
@@ -78,7 +78,7 @@ module JekyllMeilisearch
       end
 
       if documents.empty?
-        Jekyll.logger.info "No documents found across configured collections: #{collections_config.keys.join(', ')}. Cleaning up index..."
+        Jekyll.logger.info "No documents found across configured collections: #{collections_config.keys.join(", ")}. Cleaning up index..."
       end
       documents
     end
@@ -86,11 +86,10 @@ module JekyllMeilisearch
     def generate_id(doc, collection_name, id_format)
       # Helper method to normalize strings
       normalize = lambda do |str|
-        str.gsub('/', '-')
-           .gsub(/[^a-zA-Z0-9_-]/, '-')
-           .gsub(/-+/, '-')
-           .downcase
-           .slice(0, 100)
+        str.tr("/", "-")
+          .gsub(%r![^a-zA-Z0-9_-]!, "-").squeeze("-")
+          .downcase
+          .slice(0, 100)
       end
 
       case id_format
@@ -99,26 +98,26 @@ module JekyllMeilisearch
       when :url
         normalize.call(doc.url)
       else
-        doc.data['number'] ? "#{collection_name}-#{doc.data['number']}" : normalize.call(doc.id)
+        doc.data["number"] ? "#{collection_name}-#{doc.data["number"]}" : normalize.call(doc.id)
       end
     end
 
     def sync_with_meilisearch
-      headers = build_headers(config['api_key'])
-      index_name = config['index_name'] || 'jekyll_documents'
-      create_index_if_missing(config['url'], index_name, headers)
+      headers = build_headers(config["api_key"])
+      index_name = config["index_name"] || "jekyll_documents"
+      create_index_if_missing(config["url"], index_name, headers)
 
-      meili_docs = fetch_all_documents(config['url'], index_name, headers)
+      meili_docs = fetch_all_documents(config["url"], index_name, headers)
       if meili_docs.nil?
-        Jekyll.logger.info 'Failed to fetch existing documents. Falling back to full indexing.'
-        return full_index(config['url'], index_name, @documents, headers)
+        Jekyll.logger.info "Failed to fetch existing documents. Falling back to full indexing."
+        return full_index(config["url"], index_name, @documents, headers)
       end
 
-      meili_ids = meili_docs.map { |doc| doc['id'] }
-      jekyll_ids = @documents.map { |doc| doc['id'] }
+      meili_ids = meili_docs.map { |doc| doc["id"] }
+      jekyll_ids = @documents.map { |doc| doc["id"] }
 
-      delete_obsolete_documents(config['url'], index_name, meili_ids - jekyll_ids, headers)
-      index_new_documents(config['url'], index_name, @documents, headers) if @documents.any?
+      delete_obsolete_documents(config["url"], index_name, meili_ids - jekyll_ids, headers)
+      index_new_documents(config["url"], index_name, @documents, headers) if @documents.any?
     end
 
     def fetch_all_documents(url, index_name, headers)
@@ -127,15 +126,15 @@ module JekyllMeilisearch
       limit = 1000
       loop do
         response = attempt_request(
-          -> {
-            HTTParty.get("#{url}/indexes/#{index_name}/documents?limit=#{limit}&offset=#{offset}", headers: headers,
-                                                                                                   timeout: 30)
+          lambda {
+            HTTParty.get("#{url}/indexes/#{index_name}/documents?limit=#{limit}&offset=#{offset}", :headers => headers,
+                                                                                                   :timeout => 30)
           },
-          'fetching documents'
+          "fetching documents"
         )
         return nil unless response&.success?
 
-        results = JSON.parse(response.body)['results']
+        results = JSON.parse(response.body)["results"]
         documents.concat(results)
         break if results.size < limit
 
@@ -145,18 +144,18 @@ module JekyllMeilisearch
     end
 
     def delete_obsolete_documents(url, index_name, ids_to_delete, headers)
-      return Jekyll.logger.info 'No documents to delete from Meilisearch.' if ids_to_delete.empty?
+      return Jekyll.logger.info "No documents to delete from Meilisearch." if ids_to_delete.empty?
 
       Jekyll.logger.info "Deleting #{ids_to_delete.size} obsolete documents from Meilisearch..."
       response = attempt_request(
-        -> {
-          HTTParty.post("#{url}/indexes/#{index_name}/documents/delete-batch", body: ids_to_delete.to_json, headers: headers,
-                                                                               timeout: 30)
+        lambda {
+          HTTParty.post("#{url}/indexes/#{index_name}/documents/delete-batch", :body => ids_to_delete.to_json, :headers => headers,
+                        :timeout => 30)
         },
-        'deleting documents'
+        "deleting documents"
       )
       if response&.success?
-        Jekyll.logger.info 'Delete task queued successfully.'
+        Jekyll.logger.info "Delete task queued successfully."
       elsif response
         Jekyll.logger.info "Failed to delete obsolete documents: #{response.code} - #{response.body}"
       end
@@ -167,20 +166,20 @@ module JekyllMeilisearch
       batch_size = 1000
       documents.each_slice(batch_size) do |batch|
         response = attempt_request(
-          -> {
-            HTTParty.post("#{url}/indexes/#{index_name}/documents", body: batch.to_json, headers: headers, timeout: 30)
+          lambda {
+            HTTParty.post("#{url}/indexes/#{index_name}/documents", :body => batch.to_json, :headers => headers, :timeout => 30)
           },
-          'indexing documents'
+          "indexing documents"
         )
         if response&.code == 202
           if response.body
             task = JSON.parse(response.body)
-            Jekyll.logger.info "Task queued: UID #{task['taskUid']}. Check status at #{url}/tasks/#{task['taskUid']}"
+            Jekyll.logger.info "Task queued: UID #{task["taskUid"]}. Check status at #{url}/tasks/#{task["taskUid"]}"
           else
-            Jekyll.logger.info 'Task queued (202), but no response body received.'
+            Jekyll.logger.info "Task queued (202), but no response body received."
           end
         elsif response.nil?
-          Jekyll.logger.info 'Failed to queue indexing task: No response received from Meilisearch.'
+          Jekyll.logger.info "Failed to queue indexing task: No response received from Meilisearch."
         else
           Jekyll.logger.info "Failed to queue indexing task: #{response.code} - #{response.body}"
         end
@@ -189,14 +188,14 @@ module JekyllMeilisearch
 
     def create_index_if_missing(url, index_name, headers)
       Jekyll.logger.info "Checking if index '#{index_name}' exists..."
-      response = HTTParty.get("#{url}/indexes/#{index_name}", headers: headers, timeout: 30)
+      response = HTTParty.get("#{url}/indexes/#{index_name}", :headers => headers, :timeout => 30)
       return if response.success?
 
       if response.code == 404
         Jekyll.logger.info "Index '#{index_name}' not found. Creating it..."
         response = attempt_request(
-          -> { HTTParty.post("#{url}/indexes", body: { 'uid' => index_name }.to_json, headers: headers, timeout: 30) },
-          'creating index'
+          -> { HTTParty.post("#{url}/indexes", :body => { "uid" => index_name }.to_json, :headers => headers, :timeout => 30) },
+          "creating index"
         )
         if response&.success? || response&.code == 202
           Jekyll.logger.info "Index '#{index_name}' created successfully."
@@ -209,14 +208,14 @@ module JekyllMeilisearch
     end
 
     def full_index(url, index_name, documents, headers)
-      Jekyll.logger.info 'Performing full index reset as fallback...'
+      Jekyll.logger.info "Performing full index reset as fallback..."
       response = attempt_request(
-        -> { HTTParty.delete("#{url}/indexes/#{index_name}/documents", headers: headers, timeout: 30) },
-        'resetting index'
+        -> { HTTParty.delete("#{url}/indexes/#{index_name}/documents", :headers => headers, :timeout => 30) },
+        "resetting index"
       )
       unless response&.success? || response&.code == 404
         if response.nil?
-          Jekyll.logger.info 'Failed to reset index: No response received from Meilisearch.'
+          Jekyll.logger.info "Failed to reset index: No response received from Meilisearch."
         else
           Jekyll.logger.info "Failed to reset index: #{response.code} - #{response.body}"
         end

data/lib/jekyll-meilisearch/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Meilisearch
-    VERSION = "0.3.0"
+    VERSION = "0.4.1"
   end
 end

data/lib/jekyll-meilisearch.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require "jekyll"
-require 'httparty'
-require 'json'
-require 'logger'
+require "httparty"
+require "json"
+require "logger"
 require "jekyll-meilisearch/generator"
 
 module JekyllMeilisearch
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-meilisearch
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - unicolored
@@ -86,18 +86,32 @@ dependencies:
         version: 1.6.6
 - !ruby/object:Gem::Dependency
   name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -112,6 +126,54 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: This plugin incrementally indexes Jekyll collections into Meilisearch
   for fast search capabilities.
 email: hello@gilles.dev