jekyll-org 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8867c7504d6f7a0543a5f9964076c2bda053cccf1cc2064eaa2625faf1a68b9
-  data.tar.gz: '087b4270646205c5c7a9129cc4a70df21c8904f8e44bbab81833a51af768435e'
+  metadata.gz: e1a71621e8118cb1ed2812a8925490ae238e3819aff428b35d251293fdc1ef5c
+  data.tar.gz: b95fd5972b6f8ce745a8dd9bc6b876952579b406e3df83e986cb59d677b80479
 SHA512:
-  metadata.gz: 5125e60fff01be04c2023a0184a7700a66be2ab7b9ba8b72ebbcaf219233f46b932505335001d0c63a876270c19a23f28f931696bc27e0b340ff92c5d648850a
-  data.tar.gz: 6233e0e5100393fba66ec0457b209ea9ae385e3213f543228f421eca9d14559e28bbb24f1b58ea738c04181c34bfff526a7bdaad55324be9175766baedff2baa
+  metadata.gz: 91ff1246f7f50cbc49582c3f045ef249195e55cb38c955b4af07d09268fb459edec4db31c43de6f98aeb810b20d50a80daf7d624472699c3dd24e5ad1a8b62fe
+  data.tar.gz: 5ec57394490ade2960cdc7b6de5c551b201246e1b98b6365da49d449297a9254bf67aa75177476a0aa67d7fd2a3455f9d60c41a78aeaaa1aa843728d3a218534

data/README.org

@@ -53,6 +53,8 @@ plugins:
   - jekyll-org
 #+end_src
 
+warning: If you are using Jekyll < 3.5.0 use the gems key instead of plugins.
+
 ** Usage
 
 Create a new file with =.org= extension in =_posts=, and write the post
@@ -69,6 +71,32 @@ with no lines:
 #+TAGS: jekyll org-mode "tag with spaces"
 
 This is a blog post about Jekyll and Org mode.
+
+** org-table demo 
+
+   | a | b | c | d | e |
+   |---+---+---+---+---|
+   | 1 | 2 | 3 | 4 | 5 |
+
+** Liquid demo 
+   #+liquid: enabled
+   #+foo: hello world
+   {{ page.foo }}
+
+   or
+
+   {{ site.time | date_to_xmlschema }}
+   
+** Code highlighting
+   Jekyll-org also offers powerful support for code snippets:
+   #+begin_src  ruby 
+     def print_hi(name)
+       puts "Hi, #{name}"
+     end
+     print_hi('Tom')
+
+     #=> prints 'Hi, Tom' to STDOUT.
+   #+end_src
 #+END_EXAMPLE
 
 The value of =#+TAGS= is parsed into a list by splitting it on spaces,

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

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.1.0 ruby lib
+# stub: jekyll-org 1.1.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "jekyll-org".freeze
-  s.version = "1.1.0"
+  s.version = "1.1.1"
 
   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 = "2019-12-11"
+  s.date = "2019-12-14"
   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 = [
@@ -27,6 +27,8 @@ Gem::Specification.new do |s|
     "VERSION",
     "jekyll-org.gemspec",
     "lib/jekyll-org.rb",
+    "lib/jekyll-org/converter.rb",
+    "lib/jekyll-org/utils.rb",
     "script/bootstrap",
     "script/cibuild",
     "script/console",

data/lib/jekyll-org.rb

@@ -1,52 +1,21 @@
-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.'
 end
 
-module Jekyll
-  class OrgConverter < Converter
-    safe true
-    priority :low
-
-    def matches(ext)
-      ext =~ /org/i
-    end
-
-    def output_ext(ext)
-      '.html'
-    end
-
-    def convert(content)
-      content
-    end
-  end
+require_relative './jekyll-org/converter'
 
+module Jekyll
   module Filters
-    def restify(input)
-      site = @context.registers[:site]
-      converter = site.find_converter_instance(Jekyll::OrgConverter)
+    def orgify(input)
+      site      = @context.registers[:site]
+      converter = site.find_converter_instance(Jekyll::Converters::Org)
       converter.convert(input)
     end
   end
 
   module OrgDocument
     def org_file?
-      extname.eql?(".org")
-    end
-
-    def site
-      @site ||= Jekyll.configuration({})
-    end
-
-    def org_config
-      site.config["org"] || Hash.new()
-    end
-
-    # 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' })
+      Jekyll::Converters::Org.matches(extname)
     end
 
     ## override: read file & parse YAML... in this case, don't parse YAML
@@ -55,66 +24,67 @@ module Jekyll
       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))
+      converter = site.find_converter_instance(Jekyll::Converters::Org)
+      parser, settings = converter.parse_org(self.content)
 
-      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
-        org_assign_setting(key, value)
-      end
+      @data = Utils.deep_merge_hashes(self.data, settings)
+      self.content = converter.actually_convert(parser)
+    end
+  end
 
-      self.content = _org_buffer_handle_liquid(org_text)
+  module OrgPage
+    # Don't parse YAML blocks when working with an org file, parse it as
+    # an org file and then extracts the settings from there.
+    def read_yaml(base, name, opts = {})
+      extname  = File.extname(name)
+      return super unless Jekyll::Converters::Org.matches(extname)
+      filename = File.join(base, name)
+
+      self.data ||= Hash.new()
+      self.content = File.read(@path || site.in_source_dir(base, name),
+                               Utils.merged_file_read_opts(site, opts))
+      converter = site.find_converter_instance(Jekyll::Converters::Org)
+      parser, settings = converter.parse_org(self.content)
+
+      self.content = converter.actually_convert(parser)
+      self.data = Utils.deep_merge_hashes(self.data, settings)
     end
+  end
 
-    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
+  class Collection
+    # make jekyll collections aside from _posts also convert org files.
+    def read
+      filtered_entries.each do |file_path|
+        full_path = collection_dir(file_path)
+        next if File.directory?(full_path)
+
+        if Utils.has_yaml_header?(full_path) ||
+           Jekyll::Converters::Org.matches_path(full_path)
+          read_document(full_path)
+        else
+          read_static_file(file_path, full_path)
+        end
       end
+
+      # TODO remove support for jekyll 3 on 4s release
+      (Jekyll::VERSION < '4.0') ? docs.sort! : sort_docs!
     end
+  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
-        '{% raw %} ' + org_text.to_html + ' {% endraw %}'
-      end
+  class Reader
+    def retrieve_org_files(dir, files)
+      retrieve_pages(dir, files)
     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
+    # don't interpret org files without YAML as static files.
+    def retrieve_static_files(dir, files)
+      org_files, static_files = files.partition(&Jekyll::Converters::Org.method(:matches_path))
+
+      retrieve_org_files(dir, org_files) unless org_files.empty?
+      site.static_files.concat(StaticFileReader.new(site, dir).read(static_files))
     end
   end
 end
 
 Jekyll::Document.prepend(Jekyll::OrgDocument)
+Jekyll::Page.prepend(Jekyll::OrgPage)

data/lib/jekyll-org/converter.rb

@@ -0,0 +1,125 @@
+require 'csv'
+require 'org-ruby'
+require_relative './utils'
+
+module Jekyll
+  module Converters
+    class Org < Converter
+      include Jekyll::OrgUtils
+
+      safe     true
+      priority :low
+
+      # true if current file is an org file
+      def self.matches(ext)
+        ext =~ /org/i
+      end
+
+      # matches, but accepts complete path
+      def self.matches_path(path)
+        matches(File.extname(path))
+      end
+
+      def matches(ext)
+        self.class.matches ext
+      end
+
+      def output_ext(ext)
+        '.html'
+      end
+
+      # because by the time an org file reaches the
+      # converter... it will have already been converted.
+      def convert(content)
+        content
+      end
+
+      def actually_convert(content)
+        case content
+        when Orgmode::Parser
+          if liquid_enabled?(content)
+            content.to_html.gsub("&#8216;", "'").gsub("&#8217;", "'")
+          else
+            '{% raw %} ' + content.to_html + ' {% endraw %}'
+          end
+        else
+          parser, variables = parse_org(content)
+          convert(parser)
+        end
+      end
+
+      def parse_org(content)
+        parser   = Orgmode::Parser.new(content, parser_options)
+        settings = { :liquid => org_config.fetch("liquid", false) }
+
+        parser.in_buffer_settings.each_pair do |key, value|
+          # Remove #+TITLE from the buffer settings to avoid double exporting
+          parser.in_buffer_settings.delete(key) if key =~ /title/i
+          assign_setting(key, value, settings)
+        end
+
+        return parser, settings
+      end
+
+      private
+
+      def config_liquid_enabled?
+        org_config.fetch("liquid", false)
+      end
+
+      def liquid_enabled?(parser)
+        tuple = parser.in_buffer_settings.each_pair.find do |key, _|
+          key =~ /liquid/i
+        end
+
+        if tuple.nil?
+            config_liquid_enabled? # default value, as per config
+        else
+            _parse_boolean(tuple[1], "unknown LIQUID setting")
+        end
+      end
+
+      # see https://github.com/bdewey/org-ruby/blob/master/lib/org-ruby/parser.rb
+      def parser_options
+        org_config.fetch("parser_options", { markup_file: 'html.tags.yml' })
+      end
+
+      def assign_setting(key, value, settings)
+        key = key.downcase
+
+        case key
+        when "liquid"
+          value = _parse_boolean(value, "unknown LIQUID setting")
+          settings[:liquid] = 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.
+          settings[key] = CSV::parse_line(value, col_sep: ' ')
+        else
+          value_bool = _parse_boolean(value)
+          settings[key] = (value_bool.nil?) ? value : value_bool
+        end
+      end
+
+      @@truthy_regexps = [/enabled/,  /yes/, /true/]
+      @@falsy_regexps  = [/disabled/, /no/,  /false/]
+
+      def _parse_boolean(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
+end

data/lib/jekyll-org/utils.rb

@@ -0,0 +1,19 @@
+module Jekyll
+  module OrgUtils
+    def self.site
+      @@site ||= Jekyll.configuration({})
+    end
+
+    def self.org_config
+      site["org"] || Hash.new()
+    end
+
+    def site
+      OrgUtils.site
+    end
+
+    def org_config
+      OrgUtils.org_config
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-org
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - eggcaker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-11 00:00:00.000000000 Z
+date: 2019-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: org-ruby
@@ -153,6 +153,8 @@ files:
 - VERSION
 - jekyll-org.gemspec
 - lib/jekyll-org.rb
+- lib/jekyll-org/converter.rb
+- lib/jekyll-org/utils.rb
 - script/bootstrap
 - script/cibuild
 - script/console