jekyll-org 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9ca8bf2b1561648245687da19cec5ea812b400d3
-  data.tar.gz: 97432c814b9e297e35489cd04ecb122a3242cf12
+SHA256:
+  metadata.gz: e8867c7504d6f7a0543a5f9964076c2bda053cccf1cc2064eaa2625faf1a68b9
+  data.tar.gz: '087b4270646205c5c7a9129cc4a70df21c8904f8e44bbab81833a51af768435e'
 SHA512:
-  metadata.gz: debccea10bbe9a9bf2ffaaddf7297e80746149c14f818b5db3a22f2499ada538dfb265993c98fae8676de59fe79e46091b4095613d6f8857717dd957224ecf5c
-  data.tar.gz: 54b22764c592b1a60a75dde326183907d6135877c89eb0f0613938b96a73232fd59445701c128f07a378469a387e081cc62d6f467e6921791b33a7ef09f5e2ea
+  metadata.gz: 5125e60fff01be04c2023a0184a7700a66be2ab7b9ba8b72ebbcaf219233f46b932505335001d0c63a876270c19a23f28f931696bc27e0b340ff92c5d648850a
+  data.tar.gz: 6233e0e5100393fba66ec0457b209ea9ae385e3213f543228f421eca9d14559e28bbb24f1b58ea738c04181c34bfff526a7bdaad55324be9175766baedff2baa

data/README.org

@@ -37,7 +37,7 @@ following lines:
 source 'https://rubygems.org'
 
 gem 'jekyll' , '>= 3.0.0'
-gem 'jekyll-org', '>= 1.0.2'
+gem 'jekyll-org', '>= 1.1.0'
 #+end_src
 
 Install the gems with bundler:
@@ -49,7 +49,7 @@ bundle install
 To use the new converter add the following line to your ~_config.yml~:
 
 #+begin_src yml
-pulugins: 
+plugins:
   - jekyll-org
 #+end_src
 
@@ -65,12 +65,15 @@ with no lines:
 
 #+BEGIN_EXAMPLE
 #+TITLE: Jekyll and Org together
-#+LAYOUT: posts
-#+TAGS: jekyll org-mode
+#+LAYOUT: post
+#+TAGS: jekyll org-mode "tag with spaces"
 
 This is a blog post about Jekyll and Org mode.
 #+END_EXAMPLE
 
+The value of =#+TAGS= is parsed into a list by splitting it on spaces,
+tags containing spaces can be wrapped into quotes.
+
 ** Liquid templating
 
 By default the all content is exported to raw HTML with org-ruby, but
@@ -99,6 +102,17 @@ then you will get output like
 <p>2014-07-02T08:20:28+08:00</p>
 #+END_EXAMPLE
 
+*** Site wide config
+
+Alternatively, if you'd rather enable liquid by default for every
+org file being converted, you can enable it in your /_config.yml/
+file.
+
+#+BEGIN_EXAMPLE
+org:
+  liquid: true
+#+END_EXAMPLE
+
 ** Source code highlighting
 
 Add a source code block as you would in Org, for example Ruby:

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.1.0

data/jekyll-org.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: jekyll-org 1.0.2 ruby lib
+# stub: jekyll-org 1.1.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "jekyll-org".freeze
-  s.version = "1.0.2"
+  s.version = "1.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["eggcaker".freeze]
-  s.date = "2018-01-12"
+  s.date = "2019-12-11"
   s.description = "So you want org-mode support for Jekyll. Write your _posts in org-mode, then add 'gems: [jekyll-org]' to your _config.yml. Thats it!".freeze
   s.email = "eggcaker@gmail.com".freeze
   s.extra_rdoc_files = [
@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://eggcaker.github.io/jekyll-org".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "2.6.14".freeze
+  s.rubygems_version = "3.0.3".freeze
   s.summary = "Jekyll converter for org-mode files".freeze
 
   if s.respond_to? :specification_version then

data/lib/jekyll-org.rb

@@ -1,13 +1,13 @@
+require 'csv'
 require 'org-ruby'
 
-if Jekyll::VERSION < "3.0"
-  raise Jekyll::FatalException, "This version of jekyll-org is only compatible with Jekyll v3 and above."
+if Jekyll::VERSION < '3.0'
+  raise Jekyll::FatalException, 'This version of jekyll-org is only compatible with Jekyll v3 and above.'
 end
 
 module Jekyll
   class OrgConverter < Converter
     safe true
-
     priority :low
 
     def matches(ext)
@@ -15,7 +15,7 @@ module Jekyll
     end
 
     def output_ext(ext)
-      ".html"
+      '.html'
     end
 
     def convert(content)
@@ -31,65 +31,90 @@ module Jekyll
     end
   end
 
-  # This overrides having to use YAML in the posts.
-  # Instead use settings from Org mode.
-  class Document
-    DATELESS_FILENAME_MATCHER = %r!^(?:.+/)*(.*)(\.[^.]+)$!
-    DATE_FILENAME_MATCHER = %r!^(?:.+/)*(\d{4}-\d{2}-\d{2})-(.*)(\.[^.]+)$!
+  module OrgDocument
+    def org_file?
+      extname.eql?(".org")
+    end
 
-    alias :_orig_read :read
-    def read(opts = {})
-      unless relative_path.end_with?(".org")
-        return _orig_read(opts)
-      end
+    def site
+      @site ||= Jekyll.configuration({})
+    end
+
+    def org_config
+      site.config["org"] || Hash.new()
+    end
 
-      Jekyll.logger.debug "Reading:", relative_path
+    # see https://github.com/bdewey/org-ruby/blob/master/lib/org-ruby/parser.rb
+    def _org_parser_options
+      org_config.fetch("_org_parser_options", { markup_file: 'html.tags.yml' })
+    end
+
+    ## override: read file & parse YAML... in this case, don't parse YAML
+    # see also: https://github.com/jekyll/jekyll/blob/master/lib/jekyll/document.rb
+    def read_content(opts = {})
+      return super unless org_file? # defer to default behaviour when not org file
 
       self.content = File.read(path, Utils.merged_file_read_opts(site, opts))
-      self.data ||= {}
-      liquid_enabled = false
 
-      org_text = Orgmode::Parser.new(content, { markup_file: "html.tags.yml" })
+      org_text = Orgmode::Parser.new(content, _org_parser_options)
+      @liquid_enabled = org_config.fetch("liquid", false)
+
       org_text.in_buffer_settings.each_pair do |key, value|
         # Remove #+TITLE from the buffer settings to avoid double exporting
         org_text.in_buffer_settings.delete(key) if key =~ /title/i
-        buffer_setting = key.downcase
+        org_assign_setting(key, value)
+      end
 
-        if buffer_setting == 'liquid'
-          liquid_enabled = true
-        end
+      self.content = _org_buffer_handle_liquid(org_text)
+    end
 
-        self.data[buffer_setting] = value
-      end
-      # set default slug
-      # copy and edit frmo jekyll:lib/jekyll/document.rb -- populate_title
-      if relative_path =~ DATE_FILENAME_MATCHER
-        date, slug, ext = Regexp.last_match.captures
-        modify_date(date)
-      elsif relative_path =~ DATELESS_FILENAME_MATCHER
-        slug, ext = Regexp.last_match.captures
+    def org_assign_setting(key, value)
+      key = key.downcase
+
+      case key
+      when "liquid"
+        value = _parse_boolean_value(value, "unknown LIQUID setting")
+        @liquid_enabled = value unless value.nil?
+      when "tags", "categories"
+        # Parse a string of tags separated by spaces into a list.
+        # Tags containing spaces can be wrapped in quotes,
+        # e.g. '#+TAGS: foo "with spaces"'.
+        #
+        # The easiest way to do this is to use rubys builtin csv parser
+        # and use spaces instead of commas as column separator.
+        self.data[key] = CSV::parse_line(value, col_sep: ' ')
+      else
+        value_bool = _parse_boolean_value(value)
+        self.data[key] = (value_bool.nil?) ? value : value_bool
       end
-      self.data["title"] ||= Utils.titleize_slug(slug)
-      self.data["slug"]  ||= slug
-      self.data["ext"]   ||= ext
-
-      # Disable Liquid tags from the output by default or enabled with liquid_enabled tag
-      if liquid_enabled
-        self.content = org_text.to_html
-        self.content = self.content.gsub("&#8216;","'")
-        self.content = self.content.gsub("&#8217;", "'")
+    end
+
+    # format the org buffer text by enabling or disabling
+    # the presence of liquid tags.
+    def _org_buffer_handle_liquid(org_text)
+      if @liquid_enabled
+        org_text.to_html.gsub("&#8216;", "'").gsub("&#8217;", "'")
       else
-        self.content = [
-          '{% raw %}',
-          org_text.to_html,
-          '{% endraw %}'
-        ].join(" ")
+        '{% raw %} ' + org_text.to_html + ' {% endraw %}'
       end
-      begin
-        self.data
-        rescue => e
-          puts "Error converting file #{relative_path}: #{e.message} #{e.backtrace}"
+    end
+
+    @@truthy_regexps = [/enabled/,  /yes/, /true/]
+    @@falsy_regexps  = [/disabled/, /no/,  /false/]
+
+    def _parse_boolean_value(value, error_msg=nil)
+      case value.downcase
+      when *@@truthy_regexps
+        true
+      when *@@falsy_regexps
+        false
+      else
+        unless error_msg.nil?
+          Jekyll.logger.warn("OrgDocument:", error_msg + ": #{value}")
+        end
       end
     end
   end
 end
+
+Jekyll::Document.prepend(Jekyll::OrgDocument)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-org
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - eggcaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-12 00:00:00.000000000 Z
+date: 2019-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: org-ruby
@@ -178,8 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Jekyll converter for org-mode files