polites-nanoc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2e36f9557f220439f562271b7490f2864818ca7aa6942f6150910d13ecc8c3b4
+  data.tar.gz: 740db988f7f1cd5fc3970b39e60a2e74d7931f11c214665390bc00c685c7a5e6
+SHA512:
+  metadata.gz: c4233ba9d5089ed058daa1c9568d3bbc155a0aa67b6a5d0a3d81f266d6303368f4cfbf67d47caf57de3259816c6fffe2031d835dfce4eeeec74bb5120761e860
+  data.tar.gz: 72170642a9f068bf90ec1381efb95af4b68d0c8c948609dfd1339367896906908a6d4e7806e0a663ab958baa381c4af35de356b02ab8a58a09cf5093ee820075

data/lib/polites/nanoc.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative './nanoc/data_source'
+require_relative './nanoc/extract_file_filter'
+require_relative './nanoc/embedded_images_filter'
+
+module Polites
+  # The {Polites::Nanoc} module provides integration with the
+  # [Nanoc](https://nanoc.ws) static site generator. It allows you to
+  # configure a Polites external directory as a data source in a Nanoc site,
+  # so you can transform Polites files straight into HTML documents.
+  #
+  # This gem consists of the following parts:
+  #
+  # * {Polites::Nanoc::DataSource} implements the data source that reads .ulyz
+  #   files from disk and creates Nanoc HTML items from them.
+  # * {Polites::Nanoc::EmbeddedImagesFilter} implements a filter you can use to
+  #   transform the image paths in your HTML to the pats generated by your Nanoc
+  #   rules.
+  # * {Polites::Nanoc::ExtractFileFilter} is a filter that will extract embedded
+  #   files from the .ulyz zip file to actual output files on disk in your Nanoc
+  #   site.
+  #
+  # @example Nanoc configuration using Polites data source
+  #    # in nanoc.yaml
+  #    data_sources:
+  #      - type: polites
+  #        items_root: /articles/
+  #        path: path/to/articles
+  # @example Require Ulussyes::Nanoc in your site
+  #   # lib/default.rb
+  #   require 'polites/nanoc'
+  # @example Nanoc rule to compile Ulussyes articles
+  #   compile "/articles/*.ulyz" do
+  #     filter :polites_embedded_images
+  #     layout "/default.*"
+  #     write item.identifier.without_ext + "/index.html"
+  #   end
+  # @example Nanoc rule to extract embedded media
+  #   compile(%r{\A/articles/.+\.ulyz/media/.+\Z}) do
+  #     filter :extract_file
+  #     write item.identifier.to_s.sub(".ulyz", "")
+  #   end
+  module Nanoc
+  end
+end

data/lib/polites/nanoc/data_source.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'pathname'
+require_relative '../settings'
+require_relative '../parser'
+require_relative '../file'
+require_relative '../html_formatter'
+
+module Polites
+  module Nanoc
+    # A data source for Nanoc that creates Nanoc content items from Polites files
+    # in a particular directory.
+    class DataSource < ::Nanoc::DataSource
+      identifier :polites
+
+      def up
+        @root = Pathname(@config[:path])
+        @settings = Settings.from_directory(@root)
+        @extension = ".#{@settings['defaultPathExtensions']}"
+        @input_files = @root.glob("*#{@extension}")
+        @parser = Polites::Parser.new
+        @formatter = Polites::HtmlFormatter.new
+      end
+
+      def items
+        @input_files.flat_map do |input_file|
+          File.open(input_file) do |file|
+            sheet = @parser.parse_sheet(file.content)
+
+            inline_file_items = sheet.inline_files.map do |image|
+              build_file_item(file.media(image.image), image.image, input_file, image.filename)
+            end
+
+            file_items = sheet.attached_files.map do |id|
+              build_file_item(file.media(id), id, input_file)
+            end
+
+            [
+              new_item(
+                @formatter.call(sheet),
+                {
+                  keywords: sheet.keywords,
+                  image: sheet.attached_files.first,
+                  image_caption: sheet.notes.any? ? @formatter.call(sheet.notes.first) : nil,
+                  inline_file_items: inline_file_items,
+                  filename: input_file.to_s,
+                  mtime: input_file.mtime
+                },
+                identifier(input_file)
+              ),
+              *inline_file_items,
+              *file_items
+            ]
+          end
+        end
+      end
+
+      private
+
+      def build_file_item(entry, id, input_file, filename = nil)
+        p = filename ? Pathname(filename) : Pathname(entry.name).basename
+        i = "#{identifier(input_file)}/media#{identifier(p, p.extname)}"
+        new_item(
+          input_file.expand_path.to_s,
+          {
+            explicit_filename: filename,
+            id: id,
+            subpath: entry.name,
+            mtime: input_file.mtime
+          },
+          i,
+          binary: true
+        )
+      end
+
+      def identifier(path, extension = @extension)
+        "/#{path
+          .relative_path_from(@root)
+          .basename(extension)
+          .to_s
+          .then { |s| underscore(s) }}#{extension}"
+      end
+
+      def underscore(str)
+        str
+          .gsub(/[^a-zA-Z0-9\-_]/, '-')
+          .squeeze('-')
+          .gsub(/^-*|-*$/, '')
+          .downcase
+      end
+    end
+  end
+end

data/lib/polites/nanoc/embedded_images_filter.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Polites
+  module Nanoc
+    # Nanoc filter for replacing the Polites-generated filename to images with
+    # actual output filenames as generated by Nanoc.
+    class EmbeddedImagesFilter < ::Nanoc::Filter
+      identifier :polites_embedded_images
+
+      def run(content, _params = {})
+        return content unless @item[:inline_file_items]&.any?
+
+        @item[:inline_file_items].inject(content) do |acc, inline_file_item|
+          actual_item = @items.find do |item|
+            item.attributes[:id] == inline_file_item.attributes[:id]
+          end
+          acc.gsub(/(?<=src=")(#{actual_item.attributes[:explicit_filename]}|#{actual_item.attributes[:id]})(?=")/, actual_item.path)
+        end
+      end
+    end
+  end
+end

data/lib/polites/nanoc/extract_file_filter.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../file'
+
+module Polites
+  module Nanoc
+    # Nanoc binary filter to extract files from a zip file to a given output file.
+    # This allows a single Polites file to be linked to multiple Nanoc items,
+    # which are extracted when needed during the compilation process.
+    class ExtractFileFilter < ::Nanoc::Filter
+      identifier :extract_file
+      type :binary
+
+      def run(filename, _params = {})
+        File.open(filename) do |f|
+          f.extract_to(@item[:subpath], output_filename)
+        end
+      end
+    end
+  end
+end

data/polites-nanoc.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative 'lib/polites/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'polites-nanoc'
+  spec.version = Polites::VERSION
+  spec.authors = ['Arjan van der Gaag']
+  spec.email = ['arjan@arjanvandergaag.nl']
+
+  spec.summary = 'Integrate the Ulysess gem with Nanoc.'
+  spec.description = 'Use Polites\' .ulyz files as a data source in static sites generated with Nanoc.'
+  spec.homepage = 'https://github.com/avdgaag/polites'
+  spec.license = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/avdgaag/polites'
+  spec.metadata['changelog_uri'] = 'https://github.com/avdgaag/polites'
+
+  # 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)/}) }.grep(/nanoc/)
+  end
+  spec.require_paths = ['lib']
+  spec.add_dependency 'nanoc', '~> 4'
+  spec.add_dependency 'polites', "~> #{Polites::VERSION}"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: polites-nanoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Arjan van der Gaag
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nanoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: polites
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: Use Polites' .ulyz files as a data source in static sites generated with
+  Nanoc.
+email:
+- arjan@arjanvandergaag.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/polites/nanoc.rb
+- lib/polites/nanoc/data_source.rb
+- lib/polites/nanoc/embedded_images_filter.rb
+- lib/polites/nanoc/extract_file_filter.rb
+- polites-nanoc.gemspec
+homepage: https://github.com/avdgaag/polites
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/avdgaag/polites
+  source_code_uri: https://github.com/avdgaag/polites
+  changelog_uri: https://github.com/avdgaag/polites
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Integrate the Ulysess gem with Nanoc.
+test_files: []