jekyll-datapage-generator 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bba553a47ad814f379fc05e7b454227e93e43bf4b1fe2ffa2eb95b06e46bb1d9
-  data.tar.gz: 6aeb8866d0691fb14ff460860a7b0015f7a566042c3c56f00947cce5b691d034
+  metadata.gz: 2c4222dd94a2eb9d6d1bfeb4720e3290cede06d8fcd5b26c5f486971ad5637eb
+  data.tar.gz: 5b9ede0b2e57e72530407ee918fcfab1eafee4e62d31695d1dc3643408b06bf6
 SHA512:
-  metadata.gz: 491b6c004362ee4e46eb7c9ac6165cd7c7c72b7b10250cf8a6a25207e8cf7a31906c8faa41c45ec07d6728d64e1d3b7aa3a1d0490c2f96d9eb83477c9c7b8fe4
-  data.tar.gz: 02bb49160d57ea8c93d567c20413080420f4295cea46c491b36aca93e25b7d71d0bb37cdcfaec256a8c076c316479d64f957ed3e64384e026f6e32c09b710018
+  metadata.gz: a25d45ab2887639d335c0b9cd693076f6d53ad3a20f35e3beb649fee97484dd65c513271d6c740a48c075fe1549d1a078ecd09a7aaf4780e8721fb465cf93e68
+  data.tar.gz: 945584ac766e1b0dfbb28966a07730a2f6575686b4af130315f1aa4fa0652d1ae33545675fa5f122f3965008389dcb04ff349bdd9f9694b21eb93d9c31c3104e

data/lib/jekyll-datapage-generator.rb

@@ -1,6 +1,6 @@
 # coding: utf-8
 # Generate pages from individual records in yml files
-# (c) 2014-2016 Adolfo Villafiorita
+# (c) 2014-2020 Adolfo Villafiorita
 # Distributed under the conditions of the MIT License
 
 module Jekyll
@@ -26,15 +26,28 @@ module Jekyll
     #
     # - `index_files` specifies if we want to generate named folders (true) or not (false)
     # - `dir` is the default output directory
-    # - `data` is the data defined in `_data.yml` of the record for which we are generating a page
+    # - `page_data_prefix` is the prefix used to output the page data
+    # - `data` is the data of the record for which we are generating a page
     # - `name` is the key in `data` which determines the output filename
     # - `name_expr` is an expression for generating the output filename
+    # - `title` is the key in `data` which determines the page title
+    # - `title_expr` is an expression for generating the page title
     # - `template` is the name of the template for generating the page
     # - `extension` is the extension for the generated file
-    def initialize(site, base, index_files, dir, data, name, name_expr, template, extension)
+    def initialize(site, base, index_files, dir, page_data_prefix, data, name, name_expr, title, title_expr, template, extension, debug)
       @site = site
       @base = base
 
+      if debug
+        puts "debug (datapage-gen) Record read:"
+        puts ">> #{data}"
+
+        puts "debug (datapage-gen) Configuration variables:"
+        [:index_files, :dir, :page_data_prefix, :name, :name_expr, :title, :title_expr, :template, :extension].each do |variable|
+          puts ">> #{variable}: #{eval(variable.to_s)}"
+        end
+      end
+
       # @dir is the directory where we want to output the page
       # @name is the name of the page to generate
       # @name_expr is an expression for generating the name of the page
@@ -45,15 +58,34 @@ module Jekyll
         record = data
         raw_filename = eval(name_expr)
         if raw_filename == nil
-          puts "error (datapage_gen). name_expr '#{name_expr}' generated an empty value in record #{data}"
+          puts "error (datapage-gen). name_expr '#{name_expr}' generated an empty value in record #{data}"
           return
         end
+        puts "debug (datapage-gen). using name_expr: '#{raw_filename}' (sanitized) will be used as the filename" if debug
       else
         raw_filename = data[name]
         if raw_filename == nil
-          puts "error (datapage_gen). empty value for field '#{name}' in record #{data}"
+          puts "error (datapage-gen). empty value for field '#{name}' in record #{data}"
+          return
+        end
+        puts "debug (datapage-gen). using name field: '#{raw_filename}' (sanitized) will be used as the filename" if debug
+      end
+
+      if title_expr
+        record = data
+        raw_title = eval(title_expr)
+        if raw_title == nil
+          puts "error (datapage-gen). title_expr '#{title_expr}' generated an empty value in record #{data}"
           return
         end
+        puts "debug (datapage-gen). using title_expr: '#{raw_title}' will be used the page title" if debug
+      else
+        raw_title = data[title]
+        if raw_title == nil
+          raw_title = raw_filename # for backwards compatibility
+          puts "debug (datapage-gen). empty title field: falling back to filename for the page title" if debug
+        end
+          puts "debug (datapage-gen). will use '#{raw_title}' as the page title" if debug
       end
 
       filename = sanitize_filename(raw_filename).to_s
@@ -63,47 +95,59 @@ module Jekyll
 
       self.process(@name)
       self.read_yaml(File.join(base, '_layouts'), template + ".html")
-      self.data['title'] = raw_filename
+      self.data['title'] = raw_title
+
       # add all the information defined in _data for the current record to the
       # current page (so that we can access it with liquid tags)
-
-      if data.key?('name')
-        data['_name'] = data['name']
+      if page_data_prefix
+        self.data[page_data_prefix] = data
+      else
+        if data.key?('name')
+          data['_name'] = data['name']
+        end
+        self.data.merge!(data)
       end
 
-      self.data.merge!(data)
     end
   end
 
   class JekyllDatapageGenerator < Generator
     safe true
 
-    # the function ~generate~ loops over _config.yml/page_gen invoking the DataPage
-    # constructor for each record for which we want to generate a page
+    # the function =generate= loops over the =_config.yml/page_gen=
+    # specification, determining what sets of pages have to be generated,
+    # reading the data for each set and invoking the =DataPage=
+    # constructor for each record found in the data
 
     def generate(site)
-      # page_gen_dirs determines whether we want to generate index pages
-      # (name/index.html) or standard files (name.html). This information
-      # is passed to the DataPage constructor, which sets the @dir variable
-      # as required by this directive
+      # page_gen-dirs is a global option which determines whether we want to
+      # generate index pages (name/index.html) or HTML files (name.html) for
+      # all sets
       index_files = site.config['page_gen-dirs'] == true
 
-      # data contains the specification of the data for which we want to generate
-      # the pages (look at the README file for its specification)
+      # data contains the specification of all the datasets for which we want
+      # to generate individual pages (look at the README file for its documentation)
       data = site.config['page_gen']
       if data
         data.each do |data_spec|
           index_files_for_this_data = data_spec['index_files'] != nil ? data_spec['index_files'] : index_files
-          template = data_spec['template'] || data_spec['data']
-          name = data_spec['name']
-          name_expr = data_spec['name_expr']
-          dir = data_spec['dir'] || data_spec['data']
-          extension = data_spec['extension'] || "html"
-
-          if site.layouts.key? template
-            # records is the list of records defined in _data.yml
-            # for which we want to generate different pages
+          template         = data_spec['template'] || data_spec['data']
+          name             = data_spec['name']
+          name_expr        = data_spec['name_expr']
+          title            = data_spec['title']
+          title_expr       = data_spec['title_expr']
+          dir              = data_spec['dir'] || data_spec['data']
+          extension        = data_spec['extension'] || "html"
+          page_data_prefix = data_spec['page_data_prefix']
+          debug            = data_spec['debug']
+          
+          if not site.layouts.key? template
+            puts "error (datapage-gen). could not find template #{template}. Skipping dataset #{name}."
+          else
+            # records is the list of records for which we want to generate
+            # individual pages
             records = nil
+
             data_spec['data'].split('.').each do |level|
               if records.nil?
                 records = site.data[level]
@@ -117,15 +161,15 @@ module Jekyll
 
             # apply filtering conditions:
             # - filter requires the name of a boolean field
-            # - filter_condition evals a ruby expression
-            records = records.select { |r| r[data_spec['filter']] } if data_spec['filter']
+            # - filter_condition evals a ruby expression which can use =record= as argument
+            records = records.select { |record| record[data_spec['filter']] } if data_spec['filter']
             records = records.select { |record| eval(data_spec['filter_condition']) } if data_spec['filter_condition']
 
+            # we now have the list of all records for which we want to generate individual pages
+            # iterate and call the constructor
             records.each do |record|
-              site.pages << DataPage.new(site, site.source, index_files_for_this_data, dir, record, name, name_expr, template, extension)
+              site.pages << DataPage.new(site, site.source, index_files_for_this_data, dir, page_data_prefix, record, name, name_expr, title, title_expr, template, extension, debug)
             end
-          else
-            puts "error (datapage_gen). could not find template #{template}" if not site.layouts.key? template
           end
         end
       end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-datapage-generator
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Adolfo Villafiorita
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies: []
-description: 
+description:
 email:
 - adolfo.villafiorita@ict4g.net
 executables: []
@@ -18,12 +18,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/jekyll-datapage-generator.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata:
   source_code_uri: https://github.com/avillafiorita/jekyll-datapage_gen
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -38,8 +38,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !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: Generate one page per yaml record in Jekyll sites.
 test_files: []