inline_fn 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97196c903d4f26c43bc33c6c2879f01e04000584766f7574b8d6a50465e3f1b8
-  data.tar.gz: 3499746d2677a0c1038bff15fea12fdf96717c9c4b30f579fbd748c4b9e3347d
+  metadata.gz: 8d19738fc73f2dd8bd8e97ced36a0c455be956445cc79fb531f0265cc18adf2a
+  data.tar.gz: 25df06d45e878b673c2000aedbedd24ab62ac759e4658d55ed968139c47f218b
 SHA512:
-  metadata.gz: 885972e0d254e297a87867d45f99f6dfb926c1c5df388cca9ce187dc17fdb8e9510b4fb292b7363ae7d8459e8d1ee05ffe945238930f927d368f2c9bcd21df78
-  data.tar.gz: 934b9a12ea9d0c2cdabf108e7a4a7633a717826c5d85c9635783648b1e1f92e36e12d4b09f320764255888b126c4c3ab3a3293e37f73893cdbee08187c6ae69d
+  metadata.gz: 4b5a526ad0b24bc01a51edeead9b8bd7f6cb3cd7fbfce13c71f9710d6b5d3324d39deb613dc0c6ff864df8d20f4c14adc7addb64dc8d98887bf2c0658ebef56e
+  data.tar.gz: da1eded3fd310d43991fa7f8ec795e7543a202c02b41569cca3fd63d27a58f98cbcb9d3c75b4e83f54dbe86e83e1ba4e7f31c3cddb2ab5e2c8c3b49a6909fdaf

data/.idea/workspace.xml

@@ -5,6 +5,8 @@
   </component>
   <component name="ChangeListManager">
     <list default="true" id="ca42f8e7-82dc-4786-8148-99f859f55553" name="Changes" comment="2022-07-13-20-54">
+      <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/lib/inline_fn.rb" beforeDir="false" afterPath="$PROJECT_DIR$/lib/inline_fn.rb" afterDir="false" />
       <change beforePath="$PROJECT_DIR$/lib/inline_fn/version.rb" beforeDir="false" afterPath="$PROJECT_DIR$/lib/inline_fn/version.rb" afterDir="false" />
     </list>
     <option name="SHOW_DIALOG" value="false" />
@@ -32,7 +34,8 @@
     "SHARE_PROJECT_CONFIGURATION_FILES": "true",
     "nodejs_package_manager_path": "npm",
     "ruby.rails.projectView.checked": "true",
-    "settings.editor.selected.configurable": "terminal"
+    "settings.editor.selected.configurable": "terminal",
+    "vue.rearranger.settings.migration": "true"
   }
 }]]></component>
   <component name="RunManager" selected="Test::Unit/Shoulda/Minitest.test_inline_fn_mmd">
@@ -134,7 +137,8 @@
       <option name="number" value="Default" />
       <option name="presentableId" value="Default" />
       <updated>1657691753423</updated>
-      <workItem from="1657691754700" duration="3917000" />
+      <workItem from="1657691754700" duration="5726000" />
+      <workItem from="1675194856020" duration="190000" />
     </task>
     <task id="LOCAL-00001" summary="initial commit">
       <created>1657693651385</created>
@@ -181,8 +185,8 @@
     <option name="LAST_COMMIT_MESSAGE" value="2022-07-13-20-54" />
   </component>
   <component name="com.intellij.coverage.CoverageDataManagerImpl">
+    <SUITE FILE_PATH="coverage/inline_fn@test_inline_fn_mmd.rcov" NAME="test_inline_fn_mmd Coverage Results" MODIFIED="1657693593278" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="rcov" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" MODULE_NAME="inline_fn" />
     <SUITE FILE_PATH="coverage/inline_fn@test_inline_fn_pandoc.rcov" NAME="test_inline_fn_pandoc Coverage Results" MODIFIED="1657693539353" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="rcov" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" MODULE_NAME="inline_fn" />
     <SUITE FILE_PATH="coverage/inline_fn@inline_fn.rcov" NAME="inline_fn Coverage Results" MODIFIED="1657693319814" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="rcov" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" MODULE_NAME="inline_fn" />
-    <SUITE FILE_PATH="coverage/inline_fn@test_inline_fn_mmd.rcov" NAME="test_inline_fn_mmd Coverage Results" MODIFIED="1657693593278" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="rcov" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$" MODULE_NAME="inline_fn" />
   </component>
 </project>

data/README.md

@@ -1,4 +1,6 @@
-# InlineFn
+# Inline Markdown Footnotes
+
+[![Ruby](https://github.com/bcdavasconcelos/inline_fn/actions/workflows/main.yml/badge.svg)](https://github.com/bcdavasconcelos/inline_fn/actions/workflows/main.yml) [![Gem Version](https://badge.fury.io/rb/inline_fn.svg)](https://badge.fury.io/rb/inline_fn)
 
 There are two methods to change regular markdown footnotes to inline mmd/pandoc-style footnotes.
 

data/lib/inline_fn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InlineFn
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/lib/inline_fn.rb

@@ -6,11 +6,17 @@ require_relative 'inline_fn/version'
 module InlineFn
   class Error < StandardError; end
 
-  def inline_fn(str, style = :pandoc)
+  def inline_fn(text, style, *array_of_strs)
+    # str is the text to be processed
+    # style is the style of the inline footnote: :pandoc or :mmd
+    # text is an optional array of strings `%w{fn cf}` that need to be removed from the footnotes before processing. This is useful in case you are converting Scrivener footnotes (`[^fn1]` or `[^cf1]`).
     ref_start = ''
-    text = str
     counter = 0
 
+    array_of_strs.each do |str|
+      text = text.gsub(/\[\^#{str}/, '[^')
+    end
+
     until ref_start.nil?
       counter += 1
       cite      = "[^#{counter}]"
@@ -40,9 +46,17 @@ module InlineFn
         text = text.gsub(/\n\s*\^\[/, "\n^[")
         cut_point = text.index("\n^")
       end
+      # p text
+      error_msg = <<~EOF
+        ERROR: No cut point found.
+
+        Footnotes should be in the format `[^1]` AND NOT `[^fn1]` or `[^cf1]`. If you are converting Scrivener markdown, please use the `scrivener_to_pandoc` (== inline_fn(self, :pandoc, 'fn', 'cf')) or `scrivener_to_mmd` (== inline_fn(self, :mmd, 'fn', 'cf')) methods.
+
+        If you have footnotes in other formats, you can try the `inline_fn` method. It takes as arguments the text to be processed, the style of the inline footnote: :pandoc or :mmd, and an optional array of strings `%w{fn cf}` that need to be removed from the footnotes before processing.
+EOF
 
-      text = text[0, cut_point]
-      # puts "#{counter -= 1} notes replaced."
+      text = text[0, cut_point] rescue error_msg
+      puts "#{counter -= 1} notes replaced."
     end
     text
   end
@@ -51,9 +65,26 @@ module InlineFn
     inline_fn(self, :pandoc)
   end
 
+  def pandoc_fn
+    inline_fn_pandoc
+  end
+
   def inline_fn_mmd
     inline_fn(self, :mmd)
   end
+
+  def mmd_fn
+    inline_fn_mmd
+  end
+
+  def scrivener_to_pandoc
+    inline_fn(self, :pandoc, 'fn', 'cf')
+  end
+
+  def scrivener_to_mmd
+    inline_fn(self, :mmd, 'fn', 'cf')
+  end
+
 end
 
 class String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inline_fn
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Bernardo C.D.A. Vasconcelos
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-13 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -81,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.17
+rubygems_version: 3.3.22
 signing_key:
 specification_version: 4
 summary: Inline markdown footnotes