org-ruby 0.9.12 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b108b7dfb32d9349c8db4a682cf3fce9fd1d6a34
-  data.tar.gz: 68e543a03733225f7f52d6926357dfe900efb514
+SHA256:
+  metadata.gz: 44fcdd4424ed21e279e00aa90e6f5b12f9b328137e19421d15e08dfb1a8b4bba
+  data.tar.gz: 134e3c2d9785c25da86c1085987b9b54ec861e6e3f94db3d9e7232618f0c483f
 SHA512:
-  metadata.gz: 9b488291798de175e1b2f27961cd47080674e192ad374de93100f332728d630300539389d1409f629da93a4d0d939fd7640a1d8af277bef7e9331e8c1a1fa9e6
-  data.tar.gz: 82291ac7147f88d4672804bd1b0dee0ab394afa9a87ae67ba82d89a799cebf94bf2cb57f39aefe9ff57c87e4150eb4413b562947ce1b753ecba26d6ed53f0e97
+  metadata.gz: 53fdc3e9be14d71ad68b85ef4f81a58ec168b93dc71f924106ced76762a28c2f6f084f4e51ba51e09d84dbfd1632fd542dfeaadfa1ba178c3ce6ef727e646d6d
+  data.tar.gz: 1dfc76204e15dc8d02524c02fd24396f90c46e34a320d1fcff43e918d904008ef77044ad59ca7d8c2ddfcd5a3520412a57afa635d1988ffc78d72ceb08456026

data/History.org

@@ -2,6 +2,32 @@
 #+title:   Changelog
 #+startup: showeverything
 
+* 0.10.1 / 2026-10-09
+
+- Escape custom TODO keywords containing regexp special characters
+  (by [[https://github.com/mockra][@mockra]])
+
+* 0.10.0 / 2026-10-09
+
+- Requires Ruby >= 3.1 (tested on Ruby 3.1 through 4.0)
+- Upgrade =rubypants= dependency to =~> 0.7=
+- Add =logger= as a runtime dependency (no longer a default gem as of Ruby 4.0)
+- Replace =File.exists?= (removed in Ruby 3.2) with =File.exist?=
+- Support =file+emacs= and =file+sys= links
+- Handle continued numbered lists
+- Recognize =js2= source blocks as JavaScript and =ipython= source blocks as Python
+- Support relative links to svg/svgz files as inline images
+- Change emphasis border regexp to match org.el
+- Improve footnote HTML export: better anchoring between references and
+  definitions, no HTML escaping of footnote content, fix missing closing
+  paragraph tag
+- Require =pathname= explicitly and default properties hash to empty
+- Replace Travis CI with GitHub Actions
+
+* 0.9.12 / 2014-12-22
+
+- Remove duplicated hash keys
+
 * 0.9.10 / 2014-12-09
 
 - Add option to disable Rubypants

data/README.org

@@ -2,7 +2,7 @@
 
 * OrgRuby
 
-[[https://secure.travis-ci.org/wallyqs/org-ruby.png?branch=master]]
+[[https://github.com/wallyqs/org-ruby/actions/workflows/ci.yml][https://github.com/wallyqs/org-ruby/actions/workflows/ci.yml/badge.svg]]
 
 An [[http://orgmode.org][Org-mode]] parser written in Ruby.
 

data/lib/org-ruby/headline.rb

@@ -97,7 +97,7 @@ module Orgmode
       words = @headline_text.split
       if words.length > 0 && words[0] =~ re then
         @keyword = words[0]
-        @headline_text.sub!(Regexp.new("^#{@keyword}\s*"), "")
+        @headline_text.sub!(Regexp.new("^#{Regexp.escape(@keyword)}\s*"), "")
       end
     end
   end                           # class Headline

data/lib/org-ruby/html_output_buffer.rb

@@ -59,9 +59,9 @@ module Orgmode
     # Output buffer is entering a new mode. Use this opportunity to
     # write out one of the block tags in the HtmlBlockTag constant to
     # put this information in the HTML stream.
-    def push_mode(mode, indent)
-      super(mode, indent)
-
+    def push_mode(mode, indent, properties={})
+      @logger.debug "Properties: #{properties}"
+      super(mode, indent, properties)
       if HtmlBlockTag[mode]
         unless ((mode_is_table?(mode) and skip_tables?) or
                 (mode == :src and !@options[:skip_syntax_highlight] and defined? Pygments))
@@ -77,12 +77,17 @@ module Orgmode
                       when @options[:decorate_title]
                         " class=\"title\""
                       end
-
           add_paragraph unless @new_paragraph == :start
           @new_paragraph = true
 
           @logger.debug "#{mode}: <#{HtmlBlockTag[mode]}#{css_class}>"
-          @output << "<#{HtmlBlockTag[mode]}#{css_class}>"
+          # Check to see if we need to restart numbering from a
+          # previous interrupted li
+          if mode_is_ol?(mode) && properties.key?(HtmlBlockTag[:list_item])
+            @output << "<#{HtmlBlockTag[mode]} start=#{properties[HtmlBlockTag[:list_item]]}#{css_class}>"
+          else
+            @output << "<#{HtmlBlockTag[mode]}#{css_class}>"
+          end
           # Entering a new mode obliterates the title decoration
           @options[:decorate_title] = nil
         end
@@ -202,15 +207,18 @@ module Orgmode
     end
 
     def output_footnotes!
+      # Only footnotes defined in the footnote (i.e., [fn:0:this is the footnote definition]) will be automatically
+      # added to a separate Footnotes section at the end of the document. All footnotes that are defined separately
+      # from their references will be rendered where they appear in the original Org document.
       return false unless @options[:export_footnotes] and not @footnotes.empty?
 
       @output << "\n<div id=\"footnotes\">\n<h2 class=\"footnotes\">Footnotes:</h2>\n<div id=\"text-footnotes\">\n"
-
-      @footnotes.each do |name, defi|
+      @footnotes.each do |name, (defi, content)|
         @buffer = defi
-        @output << "<p class=\"footnote\"><sup><a class=\"footnum\" name=\"fn.#{name}\" href=\"#fnr.#{name}\">#{name}</a></sup>" \
+        @output << "<div class=\"footdef\"><sup><a id=\"fn.#{name}\" href=\"#fnr.#{name}\">#{name}</a></sup>" \
+                << "<p class=\"footpara\">" \
                 << inline_formatting(@buffer) \
-                << "</p>\n"
+                << "</p></div>\n"
       end
 
       @output << "</div>\n</div>"
@@ -235,6 +243,10 @@ module Orgmode
        mode == :table_separator or mode == :table_header)
     end
 
+    def mode_is_ol?(mode)
+      mode == :ordered_list
+    end
+
     # Escapes any HTML content in string
     def escape_string! str
       str.gsub!(/&/, "&amp;")
@@ -299,7 +311,7 @@ module Orgmode
         [link, defi].compact.each do |text|
           # We don't support search links right now. Get rid of it.
           text.sub!(/\A(file:[^\s]+)::[^\s]*?\Z/, "\\1")
-          text.sub!(/\Afile:(?=[^\s]+\Z)/, "")
+          text.sub!(/\Afile(|\+emacs|\+sys):(?=[^\s]+\Z)/, "")
         end
 
         # We don't add a description for images in links, because its
@@ -331,10 +343,14 @@ module Orgmode
       end
 
       if @options[:export_footnotes] then
+        @re_help.rewrite_footnote_definition str do |name, content|
+          quote_tags("<sup><a id=\"fn.#{name}\" class=\"footnum\" href=\"#fnr.#{name}\">") +
+            name + quote_tags("</a></sup> ") + content
+        end
+
         @re_help.rewrite_footnote str do |name, defi|
-          # TODO escape name for url?
           @footnotes[name] = defi if defi
-          quote_tags("<sup><a class=\"footref\" name=\"fnr.#{name}\" href=\"#fn.#{name}\">") +
+          quote_tags("<sup><a id=\"fnr.#{name}\" class=\"footref\" href=\"#fn.#{name}\">") +
             name + quote_tags("</a></sup>")
         end
       end
@@ -353,6 +369,10 @@ module Orgmode
       case lang
       when 'emacs-lisp', 'common-lisp', 'lisp'
         'scheme'
+      when 'ipython'
+        'python'
+      when 'js2'
+        'javascript'
       when ''
         'text'
       else

data/lib/org-ruby/line.rb

@@ -36,6 +36,7 @@ module Orgmode
       @properties = { }
       determine_paragraph_type
       determine_major_mode
+      extract_properties
       @indent = $&.length unless blank?
     end
 
@@ -115,8 +116,25 @@ module Orgmode
       check_assignment_or_regexp(:ordered_list, OrderedListRegexp)
     end
 
+    ContinuedOrderedListRegexp = /^\[@(\d+)\]\s+/
+
     def strip_ordered_list_tag
-      @line.sub(OrderedListRegexp, "")
+      line = @line.sub(OrderedListRegexp, "")
+      if line =~ ContinuedOrderedListRegexp
+        line = line.sub(ContinuedOrderedListRegexp, "")
+      end
+      return line
+    end
+
+    def extract_properties
+      if @line =~ OrderedListRegexp
+        line_without_number =  @line.sub(OrderedListRegexp, "")
+        if line_without_number =~ ContinuedOrderedListRegexp
+          # Extract the start of the ordered list and store it in
+          # properties
+          @properties["li"] = line_without_number.match(ContinuedOrderedListRegexp)[1]
+        end
+      end
     end
 
     HorizontalRuleRegexp = /^\s*-{5,}\s*$/

data/lib/org-ruby/markdown_output_buffer.rb

@@ -15,8 +15,8 @@ module Orgmode
       end
     end
 
-    def push_mode(mode, indent)
-      super(mode, indent)
+    def push_mode(mode, indent, properties={})
+      super(mode, indent, properties)
     end
 
     def pop_mode(mode = nil)

data/lib/org-ruby/output_buffer.rb

@@ -46,7 +46,8 @@ module Orgmode
       @mode_stack.last
     end
 
-    def push_mode(mode, indent)
+
+    def push_mode(mode, indent, properties={})
       @mode_stack.push(mode)
       @list_indent_stack.push(indent)
     end
@@ -136,7 +137,7 @@ module Orgmode
     end
 
     def do_custom_markup
-      if File.exists? @options[:markup_file]
+      if File.exist? @options[:markup_file]
         load_custom_markup
         if @custom_blocktags.empty?
           no_valid_markup_found
@@ -234,10 +235,11 @@ module Orgmode
             mode_is_block? current_mode)
           # Opens the major mode of line if it exists
           if @list_indent_stack.last != line.indent or mode_is_block? current_mode
-            push_mode(line.major_mode, line.indent) if line.major_mode
+            push_mode(line.major_mode, line.indent, line.properties) if line.major_mode
           end
           # Opens tag that precedes text immediately
-          push_mode(line.paragraph_type, line.indent) unless line.end_block?
+          push_mode(line.paragraph_type, line.indent,
+                    line.properties) unless line.end_block?
         end
       end
     end

data/lib/org-ruby/parser.rb

@@ -129,7 +129,7 @@ module Orgmode
 
     # Check include file availability and permissions
     def check_include_file(file_path)
-      can_be_included = File.exists? file_path
+      can_be_included = File.exist? file_path
 
       if not ENV['ORG_RUBY_INCLUDE_ROOT'].nil?
         # Ensure we have full paths

data/lib/org-ruby/regexp_helper.rb

@@ -46,7 +46,7 @@ module Orgmode
       # Set up the emphasis regular expression.
       @pre_emphasis = ' \t\(\'"\{'
       @post_emphasis = '- \t\.,:!\?;\'"\)\}\\\\'
-      @border_forbidden = '\s,"\''
+      @border_forbidden = ' \t\r\n'
       @body_regexp = '.*?'
       @max_newlines = 1
       @body_regexp = "#{@body_regexp}" +
@@ -58,7 +58,8 @@ module Orgmode
       build_org_emphasis_regexp
       build_org_link_regexp
       @org_subp_regexp = /([_^])\{(.*?)\}/
-      @org_footnote_regexp = /\[fn:(.+?)(:(.*?))?\]/
+      @org_footnote_regexp = /\[fn:(.+?)(:(.*))?\]/
+      @org_footnote_def_regexp = /^\[fn:(.+?)(:(.*))?\]( (.+))?/
     end
 
     # Finds all emphasis matches in a string.
@@ -124,6 +125,12 @@ module Orgmode
       end
     end
 
+    def rewrite_footnote_definition str
+      str.gsub! @org_footnote_def_regexp do |match|
+        yield $1, $5
+      end
+    end
+
     # = Summary
     #
     # Rewrite org-mode links in a string to markup suitable to the
@@ -185,7 +192,7 @@ module Orgmode
                              ([^\]\[]+) # This is the friendly text
                           \])?\]/x
       @org_angle_link_text_regexp = /<(\w+:[^\]\s<>]+)>/
-      @org_image_file_regexp = /\.(gif|jpe?g|p(?:bm|gm|n[gm]|pm)|svg|tiff?|x[bp]m)/i
+      @org_image_file_regexp = /\.(gif|jpe?g|p(?:bm|gm|n[gm]|pm)|svgz?|tiff?|x[bp]m)/i
     end
   end                           # class Emphasis
 end                             # module Orgmode

data/lib/org-ruby/textile_output_buffer.rb

@@ -11,8 +11,8 @@ module Orgmode
       @footnotes = []
     end
 
-    def push_mode(mode, indent)
-      super(mode, indent)
+    def push_mode(mode, indent, properties={})
+      super(mode, indent, properties)
       @output << "bc. " if mode_is_code? mode
       if mode == :center or mode == :quote
         @add_paragraph = false

data/lib/org-ruby/version.rb

@@ -1,3 +1,3 @@
 module OrgRuby
-  VERSION = '0.9.12'
+  VERSION = '0.10.1'
 end

data/lib/org-ruby.rb

@@ -1,5 +1,3 @@
-$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
-
 # internal requires
 require 'org-ruby/version'
 require 'org-ruby/parser'

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: org-ruby
 version: !ruby/object:Gem::Version
-  version: 0.9.12
+  version: 0.10.1
 platform: ruby
 authors:
 - Brian Dewey
 - Waldemar Quevedo
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubypants
@@ -17,14 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
 description: An Org mode parser written in Ruby.
 email: waldemar.quevedo@gmail.com
 executables:
@@ -54,8 +67,8 @@ files:
 homepage: https://github.com/wallyqs/org-ruby
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/wallyqs/org-ruby
 rdoc_options: []
 require_paths:
 - lib
@@ -63,16 +76,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: org-ruby
-rubygems_version: 2.2.2
-signing_key: 
-specification_version: 3
+rubygems_version: 4.0.17
+specification_version: 4
 summary: This gem contains Ruby routines for parsing org-mode files.
 test_files: []