codeless_code 0.1.7 → 0.1.8

data/lib/codeless_code/filters.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -14,15 +16,21 @@
 # You should have received a copy of the GNU General Public License along with
 # this program. If not, see <https://www.gnu.org/licenses/>.
 module CodelessCode
+  # Functors which test whether a given {Fable} matches some criteria.
   module Filters
-    autoload  :Builders,       'codeless_code/filters/builders'
-    autoload  :Composite,      'codeless_code/filters/composite'
-    autoload  :Date,           'codeless_code/filters/date'
-    autoload  :FromOptions,    'codeless_code/filters/from_options'
-    autoload  :HeaderInteger,  'codeless_code/filters/header_integer'
-    autoload  :Lang,           'codeless_code/filters/lang'
-    autoload  :HeaderString,   'codeless_code/filters/header_string'
-    autoload  :Translator,     'codeless_code/filters/translator'
+    autoload  :Builders,     'codeless_code/filters/builders'
+    autoload  :Composite,    'codeless_code/filters/composite'
+    autoload  :Date,         'codeless_code/filters/date'
+    autoload  :FromOptions,  'codeless_code/filters/from_options'
+    autoload  :Lang,         'codeless_code/filters/lang'
+    autoload  :Translator,   'codeless_code/filters/translator'
+
+    # Filters which inspect a {Fable fable's} headers
+    module Headers
+      autoload  :Base,     'codeless_code/filters/headers/base'
+      autoload  :Integer,  'codeless_code/filters/headers/integer'
+      autoload  :String,   'codeless_code/filters/headers/string'
+    end
 
     extend Builders
 

data/lib/codeless_code/formats/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -18,8 +20,9 @@ require 'nokogiri'
 
 module CodelessCode
   module Formats
+    # Abstract base class for all formats.
     class Base
-      attr_accessor :raw
+      attr_reader :raw
 
       def initialize(raw)
         @raw = raw
@@ -27,14 +30,24 @@ module CodelessCode
 
       protected
 
-      def to_xhtml(str)
-        # MediaCloth expects XHTML-ish pages and chokes on ommited end tags
-        Nokogiri::HTML(str).css('body > *').to_xhtml
+      def from_wiki(doc, parser_name)
+        parser = Parsers.const_get(parser_name).new(self)
+        MediaCloth.wiki_to_html(doc.to_s, generator: parser)
+      end
+    end
+
+    # MediaCloth expects XHTML-ish pages and chokes on ommited end tags
+    class XhtmlDoc
+      def self.parse(html)
+        new(Nokogiri::HTML(html))
+      end
+
+      def initialize(doc)
+        @doc = doc
       end
 
-      def from_wiki(str, generator)
-        return "" if str.length == 0
-        MediaCloth::wiki_to_html(str, generator: generator)
+      def to_s
+        @doc.css('body > *').to_xhtml
       end
     end
   end

data/lib/codeless_code/formats/parsers/base.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# codeless_code filters and prints fables from http://thecodelesscode.com
+# Copyright (C) 2018  Jon Sangster
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program. If not, see <https://www.gnu.org/licenses/>.
+require 'mediacloth'
+
+module CodelessCode
+  module Formats
+    module Parsers
+      # An abstract base class for the custom parsers for the syntax tree
+      # generated by the +MediaCloth+ gem.
+      class Base < MediaWikiWalker
+        # Reimplement these
+        #
+        # @example
+        #   def parse_paragraph(ast)
+        #     parse_wiki_ast(ast)
+        #   end
+        ABSTRACT_METHODS = %i[
+          parse_paragraph
+          parse_paste
+          parse_formatted
+          parse_list_item
+          parse_list_term
+          parse_list_definition
+          parse_preformatted
+          parse_section
+          parse_link
+          parse_internal_link
+          parse_internal_link_item
+          parse_table
+          parse_table_row
+          parse_table_cell
+          parse_element
+          parse_template
+          parse_category
+          parse_keyword
+        ].freeze
+
+        attr_reader :ctx
+
+        def initialize(ctx)
+          @ctx = ctx
+        end
+
+        protected
+
+        def parse_wiki_ast(ast)
+          super(ast).join
+        end
+
+        ABSTRACT_METHODS.each do |meth|
+          define_method(meth) { |ast| parse_wiki_ast(ast) }
+        end
+
+        # Reimplement this
+        # :reek:UtilityFunction
+        def parse_text(ast)
+          ast.contents
+        end
+
+        # Reimplement this
+        def parse_list(ast)
+          ast.children.map(&method(:parse_list_child))
+        end
+
+        # Reimplement this
+        def parse_resource_link(ast)
+          ast.children.map do |child|
+            parse_internal_link_item(child) if child.is_a?(InternalLinkItemAST)
+          end
+        end
+
+        # Reimplement this
+        def parse_category_link(ast)
+          ast.children.map do |child|
+            parse_internal_link_item(child) if child.is_a?(InternalLinkItemAST)
+          end
+        end
+
+        private
+
+        def parse_list_child(child)
+          case child
+          when ListItemAST       then parse_list_item(child)
+          when ListTermAST       then parse_list_term(child)
+          when ListDefinitionAST then parse_list_definition(child)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/codeless_code/formats/parsers/plain.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# codeless_code filters and prints fables from http://thecodelesscode.com
+# Copyright (C) 2018  Jon Sangster
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program. If not, see <https://www.gnu.org/licenses/>.
+require 'mediacloth'
+
+module CodelessCode
+  module Formats
+    module Parsers
+      # A custom parser for the syntax tree generated by the +MediaCloth+ gem
+      # which removes all formatting such that the rendered document should
+      # appear as plain text.
+      class Plain < Base
+        protected
+
+        def parse_section(ast)
+          parse_wiki_ast(ast).strip
+        end
+
+        def parse_internal_link(ast)
+          text = parse_wiki_ast(ast)
+          !text.empty? ? text : ast.locator
+        end
+
+        def parse_element(ast)
+          str = parse_wiki_ast(ast)
+          if ast.name == 'pre'
+            ctx.generate(str.gsub(/\A\n*(.*?)\n*\z/m, '\1'))
+          else
+            str
+          end
+        end
+      end
+    end
+  end
+end

data/lib/codeless_code/formats/parsers/term.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# codeless_code filters and prints fables from http://thecodelesscode.com
+# Copyright (C) 2018  Jon Sangster
+#
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, either version 3 of the License, or (at your option) any later
+# version.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program. If not, see <https://www.gnu.org/licenses/>.
+require 'mediacloth'
+
+module CodelessCode
+  module Formats
+    module Parsers
+      # A custom parser for the syntax tree generated by the +MediaCloth+ gem
+      # which formats a document using ANSI codes for color, bold, italics, and
+      # other styles.
+      class Term < Base
+        protected
+
+        def parse_formatted(ast)
+          if ast.formatting == :Bold
+            color(parse_wiki_ast(ast)).bold
+          else
+            color(parse_wiki_ast(ast)).italic
+          end
+        end
+
+        def parse_preformatted(ast)
+          color(parse_wiki_ast(ast)).green
+        end
+
+        def parse_section(ast)
+          color(parse_wiki_ast(ast).strip).blue
+        end
+
+        def parse_link(ast)
+          color(parse_wiki_ast(ast)).underline
+        end
+
+        def parse_internal_link(ast)
+          text = parse_wiki_ast(ast)
+          color(!text.empty? ? text : ast.locator).underline
+        end
+
+        def parse_element(ast)
+          str = parse_wiki_ast(ast)
+          if ast.name == 'pre'
+            color(ctx.generate(str.gsub(/\A\n*(.*?)\n*\z/m, '\1'))).red
+          else
+            str
+          end
+        end
+
+        def parse_template(ast)
+          color(ast.template_name).yellow
+        end
+
+        def parse_keyword(ast)
+          color(parse_wiki_ast(ast)).underline
+        end
+
+        private
+
+        def color(str)
+          ctx.color(str)
+        end
+      end
+    end
+  end
+end

data/lib/codeless_code/formats/plain.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -21,24 +23,31 @@ module CodelessCode
     class Plain < Base
       def call
         raw.split("\n\n")
-           .map { |str| from_wiki(to_xhtml(regex(str))) }
+           .map { |str| from_wiki(CleanupBody.new(str)) }
            .join("\n\n")
       end
 
-      private
+      protected
 
-      def regex(str)
-        [
-          [/\/\/\w*$/, ''],
-          [/<i>([^<]+)<\/i>/mi, '\1'],
-          [/<b>([^<]+)<\/b>/mi, '\1'],
-          [/<a[^>]+>([^<]+)<\/a>/mi, '\1'],
-          [/\/(\w+)\//, '\1'],
-        ].inject(str) { |str, args| str = str.gsub(*args) }
+      def from_wiki(str)
+        super(XhtmlDoc.parse(str.to_s), :Plain)
+      end
+    end
+
+    # Tidies up the mixed syntax found in fables
+    class CleanupBody
+      def initialize(body)
+        @body = body
       end
 
-      def from_wiki(str)
-        super(str, PlainGenerator.new(self))
+      def to_s
+        [
+          [%r{//\w*$}, ''],
+          [%r{<i>([^<]+)</i>}mi, '\1'],
+          [%r{<b>([^<]+)</b>}mi, '\1'],
+          [%r{<a[^>]+>([^<]+)</a>}mi, '\1'],
+          [%r{/(\w+)/}, '\1']
+        ].inject(@body) { |str, args| str.gsub(*args) }
       end
     end
   end

data/lib/codeless_code/formats/raw.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #

data/lib/codeless_code/formats/term.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -15,7 +17,6 @@
 # this program. If not, see <https://www.gnu.org/licenses/>.
 require 'colorized_string'
 require 'mediacloth'
-require 'nokogiri'
 
 module CodelessCode
   module Formats
@@ -23,26 +24,31 @@ module CodelessCode
     # colors, etc.
     class Term < Base
       def call
-        from_wiki(to_xhtml(regex(raw)))
+        from_wiki
       end
 
-      def regex(str)
-        [
-          [/\/\/\w*$/, ''],
-          [/^\|   .*/, c('\\0').green],
-          [/<i>([^<]+)<\/i>/mi, "''\\1''"],
-          [/<b>([^<]+)<\/b>/mi, "'''\\1'''"],
-          [/<a[^>]+>([^<]+)<\/a>/mi, '[[\1]]'],
-          [/\/(\w+)\//, "''\\1''"],
-        ].inject(str) { |str, args| str = str.gsub(*args) }
+      # :reek:UtilityFunction
+      def color(str)
+        ColorizedString.new(str)
       end
 
-      def from_wiki(str)
-        super(str, TermGenerator.new(self))
+      protected
+
+      def from_wiki
+        super(XhtmlDoc.parse(regex_raw), :Term)
       end
 
-      def c(str)
-        ColorizedString.new(str)
+      private
+
+      def regex_raw
+        [
+          [%r{//\w*$}, ''],
+          [/^\|   .*/, ColorizedString.new('\\0').green],
+          [%r{<i>([^<]+)</i>}mi, "''\\1''"],
+          [%r{<b>([^<]+)</b>}mi, "'''\\1'''"],
+          [%r{<a[^>]+>([^<]+)</a>}mi, '[[\1]]'],
+          [%r{/(\w+)/}, "''\\1''"]
+        ].inject(raw) { |str, args| str.gsub(*args) }
       end
     end
   end

data/lib/codeless_code/language_set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -22,16 +24,17 @@ module CodelessCode
     extend Forwardable
     include Enumerable
 
+    # If the requested language set doesn't exist
     NotFoundError = Class.new(StandardError)
 
-    LANG_PATTERN = '%s-*'.freeze
+    LANG_PATTERN = '%s-*'
 
-    attr_accessor :lang, :root_dir
+    attr_reader :lang, :root_dir
     def_delegator :fable_sets, :each
 
     def initialize(lang, root_dir:)
-      self.lang = lang
-      self.root_dir = root_dir
+      @lang = lang
+      @root_dir = root_dir
     end
 
     def fable_sets

data/lib/codeless_code/options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -62,9 +64,9 @@ module CodelessCode
       args = [@command_name] + @argv
       opts = CodelessCode::OPTIONS.curry[@command_name]
 
-      Slop.parse(args, suppress_errors: suppress_errors, &opts).tap do |o|
-        if !suppress_errors && o.arguments.size > MAX_ARGS + 1
-          raise format('too many arguments: %p', o.arguments[1..-1])
+      Slop.parse(args, suppress_errors: suppress_errors, &opts).tap do |opt|
+        if !suppress_errors && opt.arguments.size > MAX_ARGS + 1
+          raise format('too many arguments: %p', opt.arguments[1..-1])
         end
       end
     end

data/lib/codeless_code/renderers/fable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -24,7 +26,7 @@ module CodelessCode
           page.title = best_title
           page.body = render_with(format, fallback: fallback)
 
-          headers_no_best_title.map { |k, v| page.add_header(k, v) }
+          headers_no_best_title.map { |key, val| page.add_header(key, val) }
         end
       end
 
@@ -42,14 +44,17 @@ module CodelessCode
       private
 
       def render_slice(keys)
-        headers.slice(*keys).map {|k, v| format('%s: %p', k, v) }.join(', ')
+        headers.slice(*keys)
+               .map { |key, val| format('%s: %p', key, val) }
+               .join(', ')
       end
 
       def render_with(format, fallback:)
         format.new(body).call
-      rescue => e
-        raise e unless fallback
-        warn format('Error parsing %s: %s', file, e.message.strip)
+      rescue StandardError => err
+        raise err unless fallback
+
+        warn format('Error parsing %s: %s', file, err.message.strip)
         fallback.new(body).call
       end
 
@@ -58,13 +63,13 @@ module CodelessCode
       end
 
       def headers_no_best_title
-        sorted_headers.dup.delete_if { |_, v| v&.strip == title&.strip }
+        sorted_headers.dup.delete_if { |_, val| val&.strip == title&.strip }
       end
 
       def sorted_headers
         Hash[
-          headers.each_with_index.sort_by do |(k,_), i|
-            HEADER_SORT.index(k) || HEADER_SORT.size + i
+          headers.each_with_index.sort_by do |(key, _), index|
+            HEADER_SORT.index(key) || HEADER_SORT.size + index
           end.map(&:first)
         ]
       end

data/lib/codeless_code/renderers/term_page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -24,16 +26,21 @@ module CodelessCode
         '%<title>s', '%<sep1>s', '%<headers>s', '%<sep2>s', '', '%<body>s'
       ].join("\n").freeze
 
+      # :reek:Attribute
       attr_accessor :title, :body
+      attr_reader :headers
+
+      # :reek:ControlParameter
+      def initialize(max_width: nil, width_func: nil)
+        @max_width = max_width
+        @max_width ||= (width_func || TermWidth.new).call
 
-      def initialize(max_width: nil)
-        @max_width = max_width || term_width
         @headers = {}
         @key_width = 0
       end
 
       def to_s
-        format(PAGER_FORMAT, title: title.center(width),
+        format(PAGER_FORMAT, title: title.center(width).rstrip,
                              sep1: seperator('='), sep2: seperator('-'),
                              headers: header_section, body: body)
       end
@@ -45,38 +52,31 @@ module CodelessCode
 
       private
 
-      def term_width
-        if (w = %x[tput cols].strip&.to_i)&.positive?
-          w
-        end
-      rescue Errno::ENOENT
-        nil
-      end
-
-      def seperator(ch = '=')
-        (@seperator ||= {})[ch] ||= ch * width
+      def seperator(char = '=')
+        (@seperator ||= {})[char] ||= char * width
       end
 
       def header_section
-        lines = @headers.map { |k, v| format_header(k, v, wrap: true) }
-        max_line_width = lines.join("\n").lines.map { |s| s.size }.max
+        lines = format_header_section
+        max_line_width = lines.join("\n").lines.map(&:size).max || 0
         padding = [0, (width - max_line_width)].max / 2
 
-        lines.map { |s| [' ' * padding, s].join }.join("\n")
+        lines.map { |line| [' ' * padding, line].join }.join("\n")
       end
 
-      def format_header(k, v, wrap: false)
-        line =
-          if wrap
-            v.chars
-             .each_slice(width - @key_width - 2)
-             .map { |s| s.join.strip }
-             .inject { |str, s| str << "\n" << ' ' * (@key_width + 2) << s }
-          else
-            v
-          end
-
-        format("% #{@key_width}s: %s", k, line)
+      def format_header_section
+        headers.map { |key, value| format_header(key, wrap_header(value)) }
+      end
+
+      def format_header(key, value)
+        format("% #{@key_width}s: %s", key, value)
+      end
+
+      def wrap_header(head)
+        head.chars
+            .each_slice(width - @key_width - 2)
+            .map { |str| str.join.strip }
+            .inject { |str, part| str + "\n" + ' ' * (@key_width + 2) + part }
       end
 
       def width
@@ -85,12 +85,27 @@ module CodelessCode
 
       def content_width
         [
-          body.lines.map do |s|
-            ColorizedString[s].uncolorize.strip.size
+          body.lines.map do |line|
+            ColorizedString[line].uncolorize.strip.size
           end.max || 0,
-          @headers.map(&method(:format_header)).map(&:size).max || 0
+          headers.map(&method(:format_header)).map(&:size).max || 0
         ].max
       end
     end
+
+    # Ask an external application how wide our terminal is
+    class TermWidth
+      def initialize(cmd = 'tputs cols')
+        @cmd = cmd
+      end
+
+      def call
+        if (tput_width = `#{@cmd}`.strip.to_i).positive?
+          tput_width
+        end
+      rescue Errno::ENOENT
+        nil
+      end
+    end
   end
 end