jekyll-lunr 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90eef74feddc378ae3003d595921774aa577af3878613eaeb0fa3f455dc6b8f5
-  data.tar.gz: 25d9fec540c555b582dda9e7c6ab7988365e941a64632f7816251987a8928c42
+  metadata.gz: e18aceb9b02aa376f8c9006f399c0135362db2cdf2c429876e7e4a5856b560d8
+  data.tar.gz: e3fed8cb38dd1610db828a54ae1b3a9361b795e9b816f2df4c8826f72d566bd6
 SHA512:
-  metadata.gz: c521546e2bf208f63a5f8564806bdbbc8fbbe148bea463a99cbe1a0417eddceb0348cc62a3fafacf1232a426c69462c906505b2cd16a7d97071fca67eef141ee
-  data.tar.gz: cd683d7daafda7439be1d6458bb7432d0fcf121052bdb5554bf3bf3972218a76e1e56bff6cef550392cb4b11d34791bbff3f1acfc97b632c38e794299ab872de
+  metadata.gz: 530ec545d0ce6d20ed562534d2e77f0d6abdac0510e816f525fd12196d05d675fd0286190944aaebed329399af744451115324a43aa285062b8c92e04f4409d3
+  data.tar.gz: 88a4ef07c75174d03aaa89ebf0834b1665b53c3219c0c89a3d72e36915149270142b76d7ee9aa630c947dcb2b68a0cc4ad65195fee35761345c707513f11540f

data/lib/jekyll-lunr.rb

@@ -1,11 +1,12 @@
 require 'jekyll/lunr'
 
 Jekyll::Hooks.register :site, :pre_render do |site|
-  lunr = Jekyll::Lunr::Indexer.new site: site
-
   Jekyll.logger.info 'Generating data.json'
-  lunr.write
+  site.indexer.write
 
   Jekyll.logger.info 'Generating idx.json'
-  lunr.index
+  site.indexer.index
+
+  Jekyll.logger.info 'Freeing memory'
+  site.indexer.free
 end

data/lib/jekyll/lunr.rb

@@ -9,60 +9,81 @@ module Jekyll
     # Error
     class Error < StandardError; end
 
+    module IndexableSite
+      def self.included(base)
+        base.class_eval do
+          def indexer
+            @indexer ||= Jekyll::Lunr::Indexer.new self
+          end
+        end
+      end
+    end
+
+    module IndexableDocument
+      def self.included(base)
+        base.class_eval do
+          def to_data
+            data
+              .slice(*site.indexer.fields)
+              .transform_values { |value| extract_data_recursively(value) }
+              .merge('content' => Loofah.fragment(content).to_text,
+                     'url' => url,
+                     'id' => url,
+                     'year' => date&.year)
+          end
+
+          def extract_data_recursively(value)
+            case value
+            when Array then value.map { |v| extract_data(v) }
+            when Hash then value.transform_values { |v| extract_data(v) }
+            when Jekyll::Document then extract_data(value)
+            when Jekyll::Page then extract_data(value)
+            else value
+            end
+          end
+
+          def extract_data(value)
+            value.respond_to?(:to_data) ? value.to_data : value
+          end
+        end
+      end
+    end
+
     # Generates a Lunr index from documents
     class Indexer
-      attr_reader :site, :lang, :fields
+      attr_reader :site
 
-      def initialize(site:)
+      def initialize(site)
         @site = site
       end
 
       # The data is the register where Lunr looks for results.
       # TODO: Write a single data file per doc?
       def data
-        @data ||= documents.map do |doc|
-          doc.data.dup
-            .keep_if { |k,_| fields.include? k }
-            .merge(content: Loofah.fragment(doc.content).to_text,
-                   url: doc.url,
-                   id: doc.url,
-                   year: doc.date.year)
-        end.compact
+        @data ||= site.documents.map(&:to_data)
       end
 
       def data_file
-        @data_file ||= Jekyll::StaticFile.new(
-          site,
-          site.source,
-          '.',
-          'data.json'
-        )
+        @data_file ||= Jekyll::StaticFile.new(site, site.source, '.', 'data.json')
       end
 
       # Convert data to strings since Lunr can't index objects
-      # TODO: make elegant
       def indexable_data
         @indexable_data ||= data.map do |d|
           d.transform_values do |v|
-            if v.is_a? Array
-              if v.first.is_a? Hash
-                v = v.map(&:values).join(', ')
-              else
-                v.join(', ')
-              end
-            elsif v.is_a? Hash
-              v.values.join(', ')
-            else
-              v.to_s
+            case v
+            when Array then v.join(', ')
+            when Hash then v.values.join(', ')
+            else v.to_s
             end
           end
         end
       end
 
       def write
-        df = File.new(data_file.path, 'w')
-        df.write data.to_json
-        df.close
+        File.open(data_file.path, 'w') do |df|
+          df.write data.to_json
+        end
 
         site.static_files << data_file
       end
@@ -72,28 +93,27 @@ module Jekyll
       end
 
       def index_file
-        @index_file ||= Jekyll::StaticFile.new(
-          site,
-          site.source,
-          '.',
-          'idx.json'
-        )
+        @index_file ||= Jekyll::StaticFile.new(site, site.source, '.', 'idx.json')
       end
 
       def indexer
-        "NODE_PATH=#{site.source}/node_modules node #{dir}/lib/assets/javascript/indexer.js #{lang}"
+        @indexer ||= ['node', File.join(dir, 'lib', 'assets', 'javascript', 'indexer.js'), lang].freeze
+      end
+
+      def env
+        @env ||= { 'NODE_PATH' => File.join(site.source, 'node_modules') }
       end
 
       def index
-        Open3.popen2(indexer) do |stdin, stdout, wait|
+        Open3.popen2(env, *indexer) do |stdin, stdout, wait|
           indexable_data.each do |data|
             stdin.puts data.to_json
           end
           stdin.close
 
-          idx = File.new(index_file.path, 'w')
-          idx.write(stdout.read)
-          idx.close
+          File.open(index_file.path, 'w') do |idx|
+            idx.write(stdout.read)
+          end
 
           site.static_files << index_file
 
@@ -103,23 +123,22 @@ module Jekyll
 
       # Site lang
       def lang
-        @lang ||= site.config.dig('lang')
+        @lang ||= site.config.dig('lang').freeze
       end
 
       # Indexable fields
       def fields
-        @fields ||= ((site.config.dig('jekyll-lunr', 'fields') || []) + default_fields).uniq
+        @fields ||= Set.new((site.config.dig('jekyll-lunr', 'fields') || []) + %w[title description]).freeze
       end
 
-      def default_fields
-        %w[title description]
-      end
-
-      # Indexable documents
-      # TODO: make configurable
-      def documents
-        site.collections.values.map(&:docs).flatten
+      def free
+        @data = nil
+        @indexable_data = nil
       end
     end
   end
 end
+
+Jekyll::Site.include Jekyll::Lunr::IndexableSite
+Jekyll::Document.include Jekyll::Lunr::IndexableDocument
+Jekyll::Page.include Jekyll::Lunr::IndexableDocument

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-lunr
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - f
-autorequire: 
-bindir: exe
+autorequire:
+bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2020-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: loofah
@@ -57,46 +57,48 @@ email:
 - f@sutty.nl
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE.txt
 files:
-- ".gitignore"
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- jekyll-lunr.gemspec
 - lib/assets/javascript/indexer.js
 - lib/jekyll-lunr.rb
 - lib/jekyll/lunr.rb
-- lib/jekyll/lunr/version.rb
 homepage: https://0xacab.org/sutty/jekyll/jekyll-lunr
 licenses:
 - GPL-3.0
 metadata:
-  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://0xacab.org/sutty/jekyll/jekyll-lunr/issues
   homepage_uri: https://0xacab.org/sutty/jekyll/jekyll-lunr
   source_code_uri: https://0xacab.org/sutty/jekyll/jekyll-lunr
-  changelog_uri: https://0xacab.org/sutty/jekyll/jekyll-lunr
-post_install_message: 
-rdoc_options: []
+  changelog_uri: https://0xacab.org/sutty/jekyll/jekyll-lunr/-/blob/master/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/jekyll-lunr
+post_install_message:
+rdoc_options:
+- "--title"
+- jekyll-lunr - Lunr indexer for Jekyll
+- "--main"
+- README.md
+- "--line-numbers"
+- "--inline-source"
+- "--quiet"
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Lunr indexer for Jekyll
 test_files: []

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-/node_modules/

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at f@sutty.nl. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-gemspec

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-task default: :test

data/bin/console

@@ -1,15 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require 'bundler/setup'
-require 'jekyll/lunr'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/jekyll-lunr.gemspec

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'jekyll/lunr/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'jekyll-lunr'
-  spec.version       = Jekyll::Lunr::VERSION
-  spec.authors       = ['f']
-  spec.email         = ['f@sutty.nl']
-
-  spec.summary       = 'Lunr indexer for Jekyll'
-  spec.description   = 'Builds the LunrJS index and data documents during site generation'
-  spec.homepage      = 'https://0xacab.org/sutty/jekyll/jekyll-lunr'
-  spec.license       = 'GPL-3.0'
-
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = spec.homepage
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_dependency 'loofah', '~> 2.4'
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-end

data/lib/jekyll/lunr/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Lunr
-    VERSION = '0.1.2'.freeze
-  end
-end