txt2tags 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fecbe0959b04275d7354f5a2d617310e30a0f7e0
+  data.tar.gz: 0937dcbff35c0858a45706680113af8dafd96e5a
+SHA512:
+  metadata.gz: 7961821fb564a19e8766a93c25849e65096c5eb7ec5c718afc88649ac4681e0c98d62a798cf6892ccaa9475ccfe1b891723c48d40b508c4ca4c7991c5e00c050
+  data.tar.gz: 3ef986140a6f4103ec696d08e00bf0e95c970a428708a058e8e2f8ea00ada9ce3a3c6893b0e2bec474b0cd9fc79d45a117b2a622adf0346c989f56e3296d5478

data/bin/txt2tags-rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'txt2tags'
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = 'Usage: txt2tags [options]'
+
+  options[:input] = nil
+  opts.on('-i', '--input FILENAME') do |file|
+    options[:input] = file
+  end
+
+  options[:output] = nil
+  opts.on('-o', '--output FILENAME') do |file|
+    options[:output] = file
+  end
+
+  opts.on('-h', '--help', 'Display this screen') do
+    puts opts
+    exit
+  end
+
+  opts.on('-l', '--list', 'List available formats') do
+    puts Txt2Tags.new('').formats.join(' ')
+    exit
+  end
+
+  options[:format] = nil
+  opts.on('-f', '--format FORMAT', 'Use this format for output') do |format|
+    txt2tags = Txt2Tags.new('')
+    abort('Unknown format') unless txt2tags.formats.include?(format)
+    require_relative "../lib/txt2tags/#{format}"
+    options[:format] = Object.const_get(format.capitalize)
+  end
+end
+
+optparse.parse!
+
+abort('Please, the format (-f/--format option)!') if options[:format].nil?
+
+input = STDIN unless options[:input]
+input = File.open(options[:input], 'r') if options[:input]
+
+output = STDOUT unless options[:output]
+output = File.open(options[:output], 'w') if options[:output]
+
+output.write Txt2Tags.new(input).output(options[:format]).to_a.join

data/lib/txt2tags.rb

@@ -0,0 +1,160 @@
+require 'stringio'
+
+# TXT2Tags - Converts t2t files to another formats
+class Txt2Tags
+  attr_reader :BEAUTIFIERS, :TITLES, :BLOCKS
+
+  # The basic transformations
+  #
+  # One regexp by mark, the content must be in a group: (.*?)
+  BEAUTIFIERS = {
+    monospace: Regexp.new('``(.*?)``'),
+    bold: Regexp.new('\*\*(.*?)\*\*'),
+    italic: Regexp.new('//(.*?)//'),
+    underline: Regexp.new('__(.*?)__'),
+    strike: Regexp.new('--(.*?)--')
+  }.freeze
+
+  # Only one linners transformations
+  #
+  # One regexp by mark, the content must be in a group: (.*?)
+  TITLES = {
+    title1: Regexp.new('\A= (.*?) ='),
+    title2: Regexp.new('\A== (.*?) =='),
+    title3: Regexp.new('\A=== (.*?) ===')
+  }.freeze
+
+  # Define blocks os lines transformation
+  #
+  # - begin_re          -> identify the begin of a blocks
+  # - end_re            -> identify the end of a blocks
+  # - apply_inline      -> can apply the BEAUTIFIERS and TITLES transformations?
+  # - strip             -> can strip spaces from line begin?
+  # - ignore_match_line -> begin and end lines will be discarded?
+  BLOCKS = {
+    quote: {
+      begin_re: Regexp.new('\A\s+'),
+      end_re: Regexp.new('\A\Z'),
+      apply_inline: true,
+      strip: true,
+      ignore_match_line: false
+    },
+    verbatim: {
+      begin_re: Regexp.new('\A```\Z'),
+      end_re: Regexp.new('\A```\Z'),
+      apply_inline: false,
+      strip: false,
+      ignore_match_line: true
+    }
+  }.freeze
+
+  # Save input type
+  def initialize(input)
+    if input.respond_to?(:read)
+      @input = input
+    elsif input.respond_to?(:to_s)
+      @input = StringIO.new(input.to_s)
+    else
+      raise 'Cannot read this.'
+    end
+  end
+
+  # Process conform 'format' and return a iterator with processed input
+  def output(format)
+    block = nil
+    ignore_line = false
+
+    Enumerator.new do |y|
+      # We can this multiples times
+      begin
+        @input.rewind
+      rescue Errno::ESPIPE
+      end
+
+      # Comments are discarded (lines beginnig with %)
+      @input.readlines.reject { |l| l.start_with?('%') }.each do |line|
+        # right space are discarded (line terminators, tabs and spaces)
+        line.rstrip!
+
+        # We are already inside a block?
+        if !block.nil?
+          # We find the end of a block?
+          if BLOCKS[block][:end_re].match line
+            # Send the end mark for this format
+            y.yield format::BLOCKS[block][:end]
+
+            # We can ignore the actual line?
+            if BLOCKS[block][:ignore_match_line]
+              block = nil
+              next
+            end
+          end
+        else
+          # Searching for a new block...
+          BLOCKS.keys.each do |m|
+            # No...
+            next unless BLOCKS[m][:begin_re].match line
+
+            # Yes!
+            block = m
+            # We can ignore the actual line?
+            ignore_line = BLOCKS[block][:ignore_match_line]
+
+            # Send the begin mark for this format
+            y.yield format::BLOCKS[block][:begin]
+
+            # We already figured out what to do, we do not have to keep looking
+            break
+          end
+        end
+
+        # Ignore this line? The others we'll find out.
+        if ignore_line
+          # The next line we still do not know if we ignore
+          ignore_line = false
+          next
+        end
+
+        # We can strip spaces from the begin of this line?
+        line.strip! if !block.nil? && BLOCKS[block][:strip]
+
+        # an apply the BEAUTIFIERS and TITLES transformations?
+        if block.nil? || (!block.nil? && BLOCKS[block][:apply_inline])
+          apply_marks!(format, line)
+        end
+
+        # More on line!
+        y.yield line
+      end
+
+      # There are a close block pending?
+      y.yield format::BLOCKS[block][:end] unless block.nil?
+    end
+  end
+
+  # Apply the basic conversions (no BLOCKS) to a line
+  def apply_marks!(conversion, line)
+    [:BEAUTIFIERS, :TITLES].each do |type|
+      type_array = Txt2Tags.const_get(type)
+      type_array.keys.each do |rule|
+        line.gsub!(type_array[rule], conversion.const_get(type)[rule])
+      end
+    end
+  end
+
+  # Discover available formats
+  def formats
+    format_list = []
+    Dir[File.join(__dir__, 'txt2tags', '*.rb')].each do |format|
+      format_list.push File.basename(format, '.rb')
+    end
+
+    format_list
+  end
+
+  # Require the format using a string as reference
+  def load_format(name)
+    require "txt2tags/#{name}"
+    Object.const_get(File.basename(name, '.rb').capitalize!)
+  end
+end

data/lib/txt2tags/html5.rb

@@ -0,0 +1,23 @@
+require_relative '../txt2tags'
+
+# HTML5 driver
+class Html5
+  BEAUTIFIERS = {
+    monospace: '<pre>\1</pre>',
+    bold: '<strong>\1</strong>',
+    italic: '<em>\1</em>',
+    underline: '<span style="text-decoration: underline;">\1</span>',
+    strike: '<span style="text-decoration: line-through;">\1</span>'
+  }.freeze
+
+  TITLES = {
+    title1: '<h2>\1</h2>',
+    title2: '<h3>\1</h3>',
+    title3: '<h4>\1</h4>'
+  }.freeze
+
+  BLOCKS = {
+    quote: { begin: '<blockquote>', end: '</blockquote>' },
+    verbatim: { begin: '<pre>', end: '</pre>' }
+  }.freeze
+end

data/lib/txt2tags/null.rb

@@ -0,0 +1,29 @@
+require_relative '../txt2tags'
+
+# Null format
+#
+# This format is a template and base for basic test_files.
+# Copy and paste this file for a new format.
+#
+# This contain the replace part of a regexp
+# "\1" is the group from the search part og regexps in main class
+class Null
+  BEAUTIFIERS = {
+    monospace: 'm_\1_m',
+    bold: 'b_\1_b',
+    italic: 'i_\1_i',
+    underline: 'u_\1_u',
+    strike: 's_\1_s'
+  }.freeze
+
+  TITLES = {
+    title1: 'T1_\1_T1',
+    title2: 'T2_\1_T2',
+    title3: 'T3_\1_T3'
+  }.freeze
+
+  BLOCKS = {
+    quote: { begin: 'BEGIN_QUOTE', end: 'END_QUOTE' },
+    verbatim: { begin: 'BEGIN_VERBATIM', end: 'END_VERBATIM' }
+  }.freeze
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: txt2tags
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paulo Henrique Rodrigues Pinheiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: htmlentities
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Converts a text file with minimal markup to various formats
+email: paulohrpinheiro@gmail.com
+executables:
+- txt2tags-rb
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/txt2tags-rb
+- lib/txt2tags.rb
+- lib/txt2tags/html5.rb
+- lib/txt2tags/null.rb
+homepage: https://github.com/paulohrpinheiro/ruby-txt2tags
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby txt2tags implementation.
+test_files: []