bibsonomy-jekyll 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6189658aacd6fe9a752e12500841ac771c474fb08a8bc9b9833e1a2f595ab8f9
-  data.tar.gz: 6410ac4082b59666035be76c81bc48dda4c591f25027b1e08c19d688f9e40d05
+  metadata.gz: f124868f854e218c2f2f2fdc7ef9d4ae07f2bd9ea00effa0486fbb1f03ca4246
+  data.tar.gz: d64a9ecee82384fd16dc4defe06772d1aace8f6664e025cc5c89475e447ebcd3
 SHA512:
-  metadata.gz: 58fbe90a4d60d0110a74402f42338d8c4060976371510b562939baa8e264f1c64541d6e98e06497df6a597a89600a8e38e8a1e5bbee38cfaf4ecf0c22dbe329d
-  data.tar.gz: 8e02ebd778233507fcbcacf5984cdc861929d72d070d9c66963c01c3497cfbbae8e67869f94b185e38f999a73dd83719b361d86ecf5e571390ffe7eedb4eab6a
+  metadata.gz: e41882bb229e7dac6486d2136619ebb540e92205e0ddadb51c9ef0ff379ebea28454e0f3849a72fa7aa60281d78d2a0f0aab8d850732ab6d7e2168f9f5ab0020
+  data.tar.gz: acba91e497107ec8655d815349cc99fd5d6f5c324a5291b123c55644e4d2981c7f36b51ac0f46c1bb3890c6fb2b45e7235790b938b8a92f72acc50c01a046d2d

data/lib/bibsonomy-jekyll.rb

@@ -7,7 +7,7 @@ require 'bibsonomy/csl'
 #
 # Jekyll Tag to render posts from BibSonomy.
 #
-# Usage: {% bibsonomy GROUPING NAME TAG1 TAG2 ... TAGN COUNT %}
+# Usage: {% bibsonomy [:OPTKEY OPTVAL] GROUPING NAME TAG1 TAG2 ... TAGN COUNT %}
 #   where
 #     GROUPING is either "user" or "group" and specifies the type of NAME
 #     NAME is the name of the group or user
@@ -15,6 +15,8 @@ require 'bibsonomy/csl'
 #     COUNT is an integer, the number of posts to return
 #
 # Changes:
+# 2026-06-02 (rja)
+# - added generic setting (and override) of csl configuration options
 # 2018-10-08 (rja)
 # - added liquid expansion
 # 2017-05-31 (rja)
@@ -24,23 +26,23 @@ require 'bibsonomy/csl'
 module Jekyll
 
   class BibSonomyPostList < Liquid::Tag
+
+    # these bibsonomy/csl configuration options are supported
+    CONFIG_OPTS = ['pdf_dir', 'altmetric_badge_type', 'style', 'year_headings', 'css_class']
+
     def initialize(tag_name, text, tokens)
       super
       @input = text
     end
 
+
     def render(context)
-      # expand liquid variables
       rendered_input = Liquid::Template.parse(@input).render(context)
-
-      bib_config = context.registers[:site].config['bibsonomy'].clone
-      #bib_config = site.config['bibsonomy']
-
-      # parse parameters
       parts = rendered_input.split(/\s+/)
-      # parameters starting with : can override configuration options
-      override_config(bib_config, parts)
 
+      # parameters starting with : can override csl configuration options
+      opts = get_opts(parts)
+      # use (remaining/actual) parameters
       grouping = parts.shift
       name = parts.shift
       # the last element is the number of posts
@@ -48,21 +50,10 @@ module Jekyll
       # everything else are the tags
       tags = parts
 
-      # extract config
-      site = context.registers[:site]
-
-      # user name and API key for BibSonomy
-      csl = BibSonomy::CSL.new(bib_config['user'], bib_config['apikey'])
-
-      # target directory for PDF documents
-      csl.pdf_dir = bib_config['document_directory']
-
-      # Altmetric badge type
-      csl.altmetric_badge_type = bib_config['altmetric_badge_type']
-
-      # CSL style for rendering
-      csl.style = bib_config['style']
-      csl.year_headings = bib_config['year_headings'].to_s.downcase == "true"
+      # configure CSL
+      config = context.registers[:site].config['bibsonomy']
+      csl = BibSonomy::CSL.new(config['user'], config['apikey'])
+      configure(csl, config, opts)
 
       html = csl.render(grouping, name, tags, count)
 
@@ -72,12 +63,35 @@ module Jekyll
       return html
     end
 
-    def override_config(config, parts)
+
+    def get_opts(parts)
+      opts = {}
       # parameters starting with : can override configuration options
       # only at the beginning → the first string without : stops loop
       while parts[0].start_with?(':')
-        config[parts.shift[1..]] = parts.shift
+        opts[parts.shift[1..]] = parts.shift
       end
+      return opts
+    end
+
+
+    #
+    # set values in csl from config, possibly overriden by opts
+    #
+    def configure(csl, config, opts)
+      # work on a copy of the configuration and override using opts
+      config = config.clone.merge(opts)
+      # set values from config in CSL
+      (CONFIG_OPTS & config.keys()).each do |key|
+        # TODO: access attribute by string → ok or hack?
+        csl.instance_variable_set('@' + key, config[key])
+      end
+
+      # HACK: convert the only (so far) boolean variable to boolean
+      if csl.year_headings.is_a?(String)
+         csl.year_headings = csl.year_headings.downcase == "true"
+      end
+
     end
   end
 

data/lib/version.rb

@@ -1,3 +1,3 @@
 module BibSonomyJekyll
-  VERSION = "0.2.3"
+  VERSION = "0.2.5"
 end

data/spec/fixtures/page_other_style.md

@@ -5,4 +5,4 @@ layout: default
 
 ** Jekyll BibSonomy Plugin **
 
-{% bibsonomy :style apa :year_headings false user bibsonomy-ruby test 1 %}
+{% bibsonomy :style iso690-numeric-en :year_headings false user bibsonomy-ruby test 1 %}

data/spec/spec_helper.rb

@@ -40,7 +40,7 @@ RSpec.configure do |config|
     site_config = Jekyll.configuration(CONFIG_DEFAULTS.merge(options))
     # get api key and user name from environment (configured via
     # .travis.yml on Travis or manually when testing locally)
-    site_config["bibsonomy"] = {"user" => ENV['BIBSONOMY_USER_NAME'], "apikey" => ENV['BIBSONOMY_API_KEY'], "style" => "springer-lecture-notes-in-computer-science", "year_headings" => "true"}
+    site_config["bibsonomy"] = {"user" => ENV['BIBSONOMY_USER_NAME'], "apikey" => ENV['BIBSONOMY_API_KEY'], "style" => "springer-lecture-notes-in-computer-science"}
     Jekyll::Site.new(site_config)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bibsonomy-jekyll
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.5
 platform: ruby
 authors:
 - Robert Jäschke