inline_fn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2aea4c765086fc66c89701e21aa1731b859d45b656c59e8eb68c9f4a1d7810fe
+  data.tar.gz: 7f07d0969719a474ed98e57968db739447c819cfa059ac4ed731ae05f0f2a4d3
+SHA512:
+  metadata.gz: 23106280f4efadad18a2d10ed4f0414bc05e604c9160a11e48f81a28725df4298efe69f20b9a89bc82e89ebf28f1d97a0220134b25363c9eea478b4fe9ed2f6d
+  data.tar.gz: 68f76f271fc300e4a7f442f881206c4b0dfdbc39772239312ec759d81273a0cbd950423e4f091385edb471958fa44eb3078842bac09a1f12918a545d240d9d65

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.2
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-08-25
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in inline_fn.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    inline_fn (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.19.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  inline_fn!
+  rake (~> 13.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.25

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Bernardo C.D.A. Vasconcelos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# InlineFn
+
+There are two methods that work on strings. Use `str.inline_mmd` for Multimarkdown style or `str.inline_pandoc` for Pandoc style footnotes.
+
+
+## MMD
+
+```ruby
+#!/usr/bin/env ruby
+# frozen_string_literal: false
+
+require 'inline_fn'
+
+text = %(Lorem ipsum dolor sit amet[^1], consectetur adipisicing elit[^2], sed...
+  [^1]: Text of fn 1
+  [^2]: Text of fn 2)
+
+puts text.inline_mmd
+```
+
+
+### Expected result
+
+```
+Lorem ipsum dolor sit amet[^Text of fn 1], consectetur adipisicing elit[^Text of fn 2], sed...
+```
+
+## Pandoc 
+
+```ruby
+#!/usr/bin/env ruby
+# frozen_string_literal: false
+
+require 'inline_fn'
+
+text = %(Lorem ipsum dolor sit amet[^1], consectetur adipisicing elit[^2], sed...
+  [^1]: Text of fn 1
+  [^2]: Text of fn 2)
+
+puts text.inline_pandoc
+```
+
+### Expected result
+
+```
+Lorem ipsum dolor sit amet^[Text of fn 1], consectetur adipisicing elit^[Text of fn 2], sed...
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inline_fn'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install inline_fn
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bcdavasconcelos/inline_fn
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "inline_fn"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/inline_fn.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/inline_fn/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "inline_fn"
+  spec.version       = InlineFn::VERSION
+  spec.authors       = ["Bernardo C.D.A. Vasconcelos"]
+  spec.email         = ["35749099+bcdavasconcelos@users.noreply.github.com"]
+
+  spec.summary       = "Change markdown footnotes format from `[^1]/[^1]:Note` to inline Pandoc or MMD style `^[Note]/[^Note]`."
+  spec.description   = "There are two methods that work on strings. Use `str.inline_mmd` for Multimarkdown style or `str.inline_pandoc` for Pandoc style footnotes."
+  spec.homepage      = "https://github.com/bcdavasconcelos/inline_fn"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/bcdavasconcelos/inline_fn.git"
+  spec.metadata["changelog_uri"] = "https://github.com/bcdavasconcelos/inline_fn/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/inline_fn/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module InlineFn
+  VERSION = "0.1.0"
+end

data/lib/inline_fn.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "inline_fn/version"
+
+module InlineFn
+  class Error < StandardError; end
+  class String
+    def inline_mmd
+      text = self
+      counter = 0
+      pandoc_mode = false
+      loop do
+        counter += 1
+        cite = "[^#{counter}]"
+        ref = "[^#{counter}]:"
+        ref_start = text.index(ref)
+        break if ref_start.nil?
+    
+        next_ref = "[^#{counter + 1}]:"
+        ref_end = text.index(next_ref).nil? ? -1 : text.index(next_ref) - 2
+        offset = counter.to_s.length + 5
+        note = pandoc_mode ? "^[#{text[ref_start + offset..ref_end].strip}]" : "[^#{text[ref_start + offset..ref_end].strip}]"
+    
+        text.gsub!(cite, note)
+      end
+    
+      if counter >= 1
+        text = pandoc_mode ? text.gsub(/\n\s*\^\[/, "\n^[") : text.gsub(/\n\s*\[\^/, "\n[^")
+        cut_point = pandoc_mode ? text.index("\n^") : text.index("\n[^")
+        text = text[0, cut_point]
+        # puts "#{counter -= 1} notes replaced."
+      end
+      puts text
+    end
+  
+    def inline_pandoc
+    text = self    
+    counter = 0
+    pandoc_mode = true
+    loop do
+      counter += 1
+      cite = "[^#{counter}]"
+      ref = "[^#{counter}]:"
+      ref_start = text.index(ref)
+      break if ref_start.nil?
+  
+      next_ref = "[^#{counter + 1}]:"
+      ref_end = text.index(next_ref).nil? ? -1 : text.index(next_ref) - 2
+      offset = counter.to_s.length + 5
+      note = pandoc_mode ? "^[#{text[ref_start + offset..ref_end].strip}]" : "[^#{text[ref_start + offset..ref_end].strip}]"
+  
+      text.gsub!(cite, note)
+    end
+  
+    if counter >= 1
+      text = pandoc_mode ? text.gsub(/\n\s*\^\[/, "\n^[") : text.gsub(/\n\s*\[\^/, "\n[^")
+      cut_point = pandoc_mode ? text.index("\n^") : text.index("\n[^")
+      text = text[0, cut_point]
+      # puts "#{counter -= 1} notes replaced."
+    end
+    puts text
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: inline_fn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bernardo C.D.A. Vasconcelos
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-05 00:00:00.000000000 Z
+dependencies: []
+description: There are two methods that work on strings. Use `str.inline_mmd` for
+  Multimarkdown style or `str.inline_pandoc` for Pandoc style footnotes.
+email:
+- 35749099+bcdavasconcelos@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- inline_fn.gemspec
+- lib/inline_fn.rb
+- lib/inline_fn/version.rb
+homepage: https://github.com/bcdavasconcelos/inline_fn
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bcdavasconcelos/inline_fn
+  source_code_uri: https://github.com/bcdavasconcelos/inline_fn.git
+  changelog_uri: https://github.com/bcdavasconcelos/inline_fn/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Change markdown footnotes format from `[^1]/[^1]:Note` to inline Pandoc or
+  MMD style `^[Note]/[^Note]`.
+test_files: []