md_to_bbcode 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30246a88b518806835d54cc211033ee2204fc1e970c78e446cae7e6b97d3c7c2
+  data.tar.gz: 7ca2a66301454a044269065b8e49366f533ba9cd4f0600ac8003341e704bcdf8
+SHA512:
+  metadata.gz: 2c3008f40d593f396206c92a4254aa6fedc2e81fcc23e255d78f470a142c144eac82076ee6847e1b51d1a19c6b3937383deee37fc0084b206d4c6c9ebe085239
+  data.tar.gz: 99ed4f207dcb62f868e85b2f81758a898b07ff733a19cc9a470c6e22ff087a07dad458a3f5c07059ba9c1d2be2686a9af82fd22dd2742fa19e5a39a01328feeb

data/bin/md_to_bbcode

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+require 'md_to_bbcode'
+require 'md_to_bbcode/version'
+require 'optparse'
+
+markdown_file = nil
+bbcode_file = nil
+opts_parser = OptionParser.new do |opts|
+  opts.banner = 'Usage: md_to_bbcode [options]'
+  opts.on('-h', '--help', 'Display this help') do
+    puts opts
+    exit 0
+  end
+  opts.on('-i', '--input MARKDOWN_FILE', 'Specify the input Markdown file to convert (mandatory)') do |file|
+    markdown_file = file
+  end
+  opts.on('-o', '--output BBCODE_FILE', 'Specify the output BBCode file to write (outputs to stdout if not specified') do |file|
+    bbcode_file = file
+  end
+  opts.on('-v', '--version', 'Display version') do
+    puts "md_to_bbcode v#{MdToBbcode::VERSION}"
+    exit 0
+  end
+end
+opts_parser.parse!
+
+if !ARGV.empty? || markdown_file.nil?
+  puts opts_parser
+  exit 1
+end
+
+unless File.exist?(markdown_file)
+  puts "Missing file #{markdown_file}"
+  exit 2
+end
+
+bbcode = File.read(markdown_file).md_to_bbcode
+if bbcode_file.nil?
+  puts bbcode
+else
+  File.write(bbcode_file, bbcode)
+end

data/lib/md_to_bbcode.rb

@@ -0,0 +1,61 @@
+require 'md_to_bbcode/core_extensions/string/md_to_bbcode'
+
+module MdToBbcode
+
+  # Convert a Markdown string to Bbcode
+  #
+  # Parameters::
+  # * *markdown* (String): The Markdown string
+  # Result::
+  # * String: BBCode converted string
+  def self.md_to_bbcode(markdown)
+    bbcode_lines = []
+    already_in_list = false
+    markdown.
+      # Images (do this gsub before links and any single tags, like bold, headings...)
+      gsub(/!\[(.*?)\]\((.*?)\)/, '[img]\2[/img]').
+      # Links
+      gsub(/\[(.*?)\]\((.*?)\)/, '[url=\2]\1[/url]').
+      # Bold
+      gsub(/\*\*(.*?)\*\*/m, '[b]\1[/b]').
+      # Heading 1
+      gsub(/^# (.*?)$/, '[size=6][b]\1[/b][/size]').
+      # Heading 2
+      gsub(/^## (.*?)$/, '[size=6]\1[/size]').
+      # Heading 3
+      gsub(/^### (.*?)$/, '[size=5][b]\1[/b][/size]').
+      # Heading 4
+      gsub(/^#### (.*?)$/, '[size=5]\1[/size]').
+      # Code blocks (do this before in-line code)
+      gsub(/```(.*?)\n(.*?)```/m, "[code]\\2[/code]").
+      # In-line code
+      gsub(/`(.*?)`/, '[b][font=Courier New]\1[/font][/b]').
+      # Perform lists transformations
+      split("\n").each do |line|
+        if line =~ /^\* (.+)$/
+          # Single bullet line
+          bbcode_lines << '[list]' unless already_in_list
+          bbcode_lines << "[*]#{$1}"
+          already_in_list = true
+        elsif line =~ /^\d\. (.+)$/
+          # Single numbered line
+          bbcode_lines << '[list=1]' unless already_in_list
+          bbcode_lines << "[*]#{$1}"
+          already_in_list = true
+        else
+          if already_in_list && !(line =~ /^  (.*)$/)
+            bbcode_lines << '[/list]'
+            already_in_list = false
+          end
+          bbcode_lines << line
+        end
+      end
+    bbcode_lines << '[/list]' if already_in_list
+    bbcode_lines << '' if markdown.end_with?("\n")
+    bbcode_lines.join("\n")
+  end
+
+end
+
+# Add the functionality to the String class
+String.include MdToBbcode::CoreExtensions::String::MdToBbcode

data/lib/md_to_bbcode/core_extensions/string/md_to_bbcode.rb

@@ -0,0 +1,23 @@
+module MdToBbcode
+
+  module CoreExtensions
+
+    module String
+
+      module MdToBbcode
+
+        # Convert a string representation of self from Markdown to Bbcode
+        #
+        # Result::
+        # * String: BBCode converted text
+        def md_to_bbcode
+          ::MdToBbcode.md_to_bbcode(self.to_s)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/md_to_bbcode/version.rb

@@ -0,0 +1,5 @@
+module MdToBbcode
+
+  VERSION = '1.0.0'
+
+end

data/spec/api_spec.rb

@@ -0,0 +1,261 @@
+describe MdToBbcode do
+
+  it 'converts heading 1' do
+    expect('# Heading 1'.md_to_bbcode).to eq '[size=6][b]Heading 1[/b][/size]'
+  end
+
+  it 'converts heading 2' do
+    expect('## Heading 2'.md_to_bbcode).to eq '[size=6]Heading 2[/size]'
+  end
+
+  it 'converts heading 3' do
+    expect('### Heading 3'.md_to_bbcode).to eq '[size=5][b]Heading 3[/b][/size]'
+  end
+
+  it 'converts heading 4' do
+    expect('#### Heading 4'.md_to_bbcode).to eq '[size=5]Heading 4[/size]'
+  end
+
+  it 'converts bold text' do
+    expect('**Bold text**'.md_to_bbcode).to eq '[b]Bold text[/b]'
+  end
+
+  it 'converts links' do
+    expect('[Link text](https://my.domain.com/path)'.md_to_bbcode).to eq '[url=https://my.domain.com/path]Link text[/url]'
+  end
+
+  it 'converts inline code' do
+    expect('`in-line code`'.md_to_bbcode).to eq '[b][font=Courier New]in-line code[/font][/b]'
+  end
+
+  it 'converts images' do
+    expect('![Image text](https://my.domain.com/image.jpg)'.md_to_bbcode).to eq '[img]https://my.domain.com/image.jpg[/img]'
+  end
+
+  it 'converts bold text on several lines' do
+    md = <<~EOS
+    **Bold
+    text
+    on
+    multi-line**
+    EOS
+    expect(md.md_to_bbcode).to eq(<<~EOS)
+    [b]Bold
+    text
+    on
+    multi-line[/b]
+    EOS
+  end
+
+  it 'converts bullets list' do
+    md = <<~EOS
+      * List item 1
+      * List item 2
+      * List item 3
+    EOS
+    expect(md.md_to_bbcode).to eq(<<~EOS)
+      [list]
+      [*]List item 1
+      [*]List item 2
+      [*]List item 3
+      [/list]
+    EOS
+  end
+
+  it 'converts numbered list' do
+    md = <<~EOS
+      1. List item 1
+      2. List item 2
+      3. List item 3
+    EOS
+    expect(md.md_to_bbcode).to eq(<<~EOS)
+      [list=1]
+      [*]List item 1
+      [*]List item 2
+      [*]List item 3
+      [/list]
+    EOS
+  end
+
+  it 'converts multi-line numbered list' do
+    md = <<~EOS
+      1. List item 1
+        And another line 1
+        
+      2. List item 2
+        And another line 2
+        
+      3. List item 3
+        And another line 3
+    EOS
+    expect(md.md_to_bbcode).to eq(<<~EOS)
+      [list=1]
+      [*]List item 1
+        And another line 1
+        
+      [*]List item 2
+        And another line 2
+        
+      [*]List item 3
+        And another line 3
+      [/list]
+    EOS
+  end
+
+  it 'converts code blocks' do
+    md = <<~EOS
+      ```ruby
+      def hello
+        puts 'Hello world'
+      end
+      hello
+      $stdin.gets
+      ```
+    EOS
+    expect(md.md_to_bbcode).to eq(<<~EOS)
+      [code]def hello
+        puts 'Hello world'
+      end
+      hello
+      $stdin.gets
+      [/code]
+    EOS
+  end
+
+  it 'converts a whole text mixing markups' do
+    md = <<~EOS
+      # Heading h1
+
+      Normal text
+
+      **Bold text**
+
+      Not bold followed by **bold and followed by** not bold.
+
+      Not bold followed by **bold and
+      followed
+      by** not bold on multi-lines.
+
+      **Bold text including a [link to Google](https://www.google.com).**
+
+      This is a bullet list:
+      * Bullet item 1
+      * Bullet item 2
+      * Bullet item 3
+
+      ## Heading h2
+
+      Here is a link to [Google](https://www.google.com/) in a middle of a line.
+
+      An inline code block `this is code` to be inserted.
+
+      ### Heading h3
+
+      #### Heading h4 with `embedded code`
+
+      Here is a code block in json:
+      ```json
+      {
+        "my_json": {
+          "is": "super",
+          "great": "and",
+          "useful": true
+        }
+      }
+      ```
+
+      This is a numbered list:
+      1. Numbered item 1
+      2. Numbered item 2
+      3. Numbered item 3
+
+      This is a numbered list with 1 item:
+      1. Numbered item 1
+
+      This is a numbered list multi-line:
+      1. Numbered item 1
+        Additional content 1
+      2. Numbered item 2
+        Additional content 2
+        
+      3. Numbered item 3
+        Additional content 3
+
+      Here is an inserted image:
+      ![Example of image](https://x-aeon.com/muriel.jpg)
+
+      And ending text
+    EOS
+    expect(md.md_to_bbcode).to eq(<<~EOS)
+      [size=6][b]Heading h1[/b][/size]
+      
+      Normal text
+      
+      [b]Bold text[/b]
+      
+      Not bold followed by [b]bold and followed by[/b] not bold.
+      
+      Not bold followed by [b]bold and
+      followed
+      by[/b] not bold on multi-lines.
+
+      [b]Bold text including a [url=https://www.google.com]link to Google[/url].[/b]
+      
+      This is a bullet list:
+      [list]
+      [*]Bullet item 1
+      [*]Bullet item 2
+      [*]Bullet item 3
+      [/list]
+      
+      [size=6]Heading h2[/size]
+      
+      Here is a link to [url=https://www.google.com/]Google[/url] in a middle of a line.
+      
+      An inline code block [b][font=Courier New]this is code[/font][/b] to be inserted.
+      
+      [size=5][b]Heading h3[/b][/size]
+      
+      [size=5]Heading h4 with [b][font=Courier New]embedded code[/font][/b][/size]
+      
+      Here is a code block in json:
+      [code]{
+        "my_json": {
+          "is": "super",
+          "great": "and",
+          "useful": true
+        }
+      }
+      [/code]
+      
+      This is a numbered list:
+      [list=1]
+      [*]Numbered item 1
+      [*]Numbered item 2
+      [*]Numbered item 3
+      [/list]
+
+      This is a numbered list with 1 item:
+      [list=1]
+      [*]Numbered item 1
+      [/list]
+      
+      This is a numbered list multi-line:
+      [list=1]
+      [*]Numbered item 1
+        Additional content 1
+      [*]Numbered item 2
+        Additional content 2
+        
+      [*]Numbered item 3
+        Additional content 3
+      [/list]
+      
+      Here is an inserted image:
+      [img]https://x-aeon.com/muriel.jpg[/img]
+      
+      And ending text
+    EOS
+  end
+
+end

data/spec/md_to_bbcode_test.rb

@@ -0,0 +1,4 @@
+require 'md_to_bbcode'
+
+module MdToBbcodeTest
+end

data/spec/spec_helper.rb

@@ -0,0 +1,102 @@
+require 'md_to_bbcode_test.rb'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: md_to_bbcode
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Muriel Salvan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides an API and an executable to convert Markdown text to BBCode
+  format
+email:
+- muriel@x-aeon.com
+executables:
+- md_to_bbcode
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/md_to_bbcode
+- lib/md_to_bbcode.rb
+- lib/md_to_bbcode/core_extensions/string/md_to_bbcode.rb
+- lib/md_to_bbcode/version.rb
+- spec/api_spec.rb
+- spec/md_to_bbcode_test.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Muriel-Salvan/md_to_bbcode
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Convert Markdown text to Bbcode
+test_files: []