codeless_code 0.1.8 → 0.2.0

data/lib/codeless_code/markup/parser.rb

@@ -0,0 +1,152 @@
+# 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 'nokogiri'
+
+module CodelessCode
+  module Markup
+    # Parses the body of a {Fable}, including HTML, MediaWiki syntax, and custom
+    # syntax, and returns it as an HTML DOM.
+    class Parser
+      # [[href|title]] or [[title]]
+      LINK_PATTERN = /\[\[(?:([^|]+)\|)?([^\]]+)\]\]/.freeze
+
+      ITALIC_PATTERN = %r{/([^/]+)/}.freeze        # /some text/
+      SUP_PATTERN = /{{([^}]+)}}/.freeze           # {{*}}
+      HR_PATTERN = /^- - -(?: -)*$/.freeze         # - - -
+      BR_PATTERN = %r{\s*//\s*(?:\n|$)}m.freeze    # end of line //
+
+      attr_reader :doc
+
+      def initialize(str)
+        @doc = Nokogiri::HTML(format('<main>%s</main>', str))
+      end
+
+      # @return [Nokogiri::XML::Element] The body of the fable, with non-HTML
+      #   markup converted into HTML
+      def call
+        new_elem(:main).tap do |main|
+          paragraphs.each do |para|
+            main << parse_paragraph(para) unless para.inner_html.empty?
+          end
+        end
+      end
+
+      private
+
+      def paragraphs
+        @paragraphs ||=
+          doc.css('main')
+             .flat_map(&method(:split_double_newline))
+             .reject { |node| node.inner_html.empty? }
+      end
+
+      def split_double_newline(para)
+        body = para.text? ? para.to_s : para.inner_html
+
+        case body.split(/\n\n+/).size
+        when 0 then new_elem(:span) << ''
+        when 1 then split_single_line(para)
+        else
+          str_node_set(format('<p>%s</p>', body.gsub(/\n\n+/, '</p><p>')))
+        end
+      end
+
+      def split_single_line(para)
+        case para.name
+        when 'p'    then para
+        when 'main' then new_elem(:p) << para.children
+        else
+          new_elem(:p) << para
+        end
+      end
+
+      def new_elem(name)
+        Nokogiri::XML::Element.new(name.to_s, doc)
+      end
+
+      def str_node_set(str)
+        doc = Nokogiri::HTML(format('<main>%s</main>', str))
+        doc.css('body > main').tap { |ns| ns.document = doc }.children
+      end
+
+      def parse_paragraph(para)
+        html = para.inner_html
+
+        if HR_PATTERN.match?(html)
+          new_elem(:hr)
+        elsif blockquote?(html)
+          new_blockquote(html)
+        elsif html.lstrip.start_with?('== ')
+          new_elem(:h2) << html.lstrip[3..-1]
+        else
+          parse_node(para)
+        end
+      end
+
+      # Does every line start with the same number of spaces?
+      # :reek:UtilityFunction
+      def blockquote?(html)
+        match = /^\s+/.match(html)
+        return unless match
+
+        lines = html.lines
+        lines.size > 1 && lines.all? { |line| line.start_with?(match[0]) }
+      end
+
+      def new_blockquote(html)
+        match = /^\s+/.match(html)
+        len = match[0].length
+        span = new_elem(:span) << html.lines.map { |line| line[len..-1] }.join
+        new_elem(:blockquote) << parse_node(span.child)
+      end
+
+      # @return [NodeSet]
+      def parse_node(node)
+        return parse_text(node) if node.text?
+
+        node.children
+            .map(&method(:parse_node))
+            .inject(new_elem(node.name)) { |elem, child| elem << child }
+      end
+
+      def parse_text(text_node)
+        str_node_set(
+          gsub_links(
+            parse_slashes(text_node.content.dup)
+            .gsub(BR_PATTERN) { new_elem(:br) }
+            .gsub(SUP_PATTERN) { new_elem(:sup) << Regexp.last_match(1) }
+          ).tr("\n", ' ')
+        )
+      end
+
+      def parse_slashes(text)
+        text.split(BR_PATTERN).map do |str|
+          str.gsub(ITALIC_PATTERN) { new_elem(:em) << Regexp.last_match(1) }
+        end.join("//\n")
+      end
+
+      def gsub_links(text)
+        text.gsub(LINK_PATTERN) do
+          (new_elem(:a) << Regexp.last_match(2)).tap do |link|
+            link['href'] = Regexp.last_match(1) if Regexp.last_match(1)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/codeless_code/renderers/term_page.rb

@@ -95,7 +95,7 @@ module CodelessCode
 
     # Ask an external application how wide our terminal is
     class TermWidth
-      def initialize(cmd = 'tputs cols')
+      def initialize(cmd = 'tput cols')
         @cmd = cmd
       end
 

data/lib/codeless_code.rb

@@ -27,7 +27,7 @@ module CodelessCode
   autoload  :LanguageSet,  'codeless_code/language_set'
   autoload  :Options,      'codeless_code/options'
 
-  # The "main" methods this applications supports
+  # The "main" methods this applications supports.
   module Commands
     autoload  :FilterFables,      'codeless_code/commands/filter_fables'
     autoload  :ListTranslations,  'codeless_code/commands/list_translations'
@@ -39,13 +39,13 @@ module CodelessCode
     autoload  :Plain,           'codeless_code/formats/plain'
     autoload  :Raw,             'codeless_code/formats/raw'
     autoload  :Term,            'codeless_code/formats/term'
+  end
 
-    # Custom parsers for the syntax tree generated by the +MediaCloth+ gem.
-    module Parsers
-      autoload  :Base, 'codeless_code/formats/parsers/base'
-      autoload  :Plain,  'codeless_code/formats/parsers/plain'
-      autoload  :Term,   'codeless_code/formats/parsers/term'
-    end
+  # Parses the markup in a {Fable}
+  module Markup
+    autoload  :Converter,  'codeless_code/markup/converter'
+    autoload  :Nodes,      'codeless_code/markup/nodes'
+    autoload  :Parser,     'codeless_code/markup/parser'
   end
 
   # The methods in which a {Fable fables's} body may be rendered as text.

data/test/codeless_code/formats/test_plain.rb

@@ -0,0 +1,74 @@
+# 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 'helper'
+
+module Formats
+  class TestPlain < UnitTest
+    def test_basic_html
+      assert_equal 'italic text', plain('<i>italic</i> text')
+      assert_equal 'bold text', plain('<b>bold</b> text')
+      assert_equal 'link text', plain('<a href="url">link</a> text')
+    end
+
+    def test_basic_html__not_across_paragraphs
+      assert_equal ['not italic', 'text across paragraphs'].join("\n\n"),
+                   plain(['not <i>italic',
+                          'text</i> across paragraphs'].join("\n\n"))
+    end
+
+    def test_custom_syntax
+      assert_equal 'italic text', plain('/italic/ text')
+    end
+
+    def test_custom_syntax__not_across_paragraphs
+      input = ['not/italic', 'text/across paragraphs'].join("\n\n")
+      assert_equal input, plain(input)
+    end
+
+    def test_line_breaks
+      assert_equal "line\nbreaks", plain("line //\nbreaks")
+    end
+
+    def test_remove_bad_html
+      assert_equal 'bad html', plain('<a>bad html</b>')
+      assert_equal 'bad html', plain('<a>bad html')
+    end
+
+    def test_rule
+      assert_equal '- - - - - - - - -', plain('- - - - -')
+    end
+
+    def test_reference
+      assert_equal '[ref]', plain('{{ref}}')
+    end
+
+    def test_header
+      assert_equal "Some Header\n-----------", plain('== Some Header')
+    end
+
+    def test_quote
+      assert_equal "\tQuote Lines", plain("    Quote\n    Lines")
+    end
+
+    private
+
+    def plain(body)
+      Formats::Plain.new(body).call
+    end
+  end
+end

data/{lib/codeless_code/formats/parsers/plain.rb → test/codeless_code/formats/test_raw.rb}

@@ -15,35 +15,13 @@
 #
 # 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'
+require 'helper'
 
-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
+module Formats
+  class TestRaw < UnitTest
+    def test_call
+      input = 'Some body content'
+      assert_same input, Formats::Raw.new(input).call
     end
   end
 end

data/test/codeless_code/formats/test_term.rb

@@ -0,0 +1,72 @@
+# 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 'helper'
+require 'colorized_string'
+
+module Formats
+  class TestTerm < UnitTest
+    def test_basic_html
+      assert_equal color('italic').italic + ' text',
+                   term('<i>italic</i> text')
+      assert_equal color('bold').bold + ' text',
+                   term('<b>bold</b> text')
+      assert_equal color('link').underline + ' text',
+                   term('<a href="url">link</a> text')
+    end
+
+    def test_custom_syntax
+      assert_equal color('italic').italic + ' text', term('/italic/ text')
+    end
+
+    def test_custom_syntax__not_across_paragraphs
+      input = ['not/italic', 'text/across paragraphs'].join("\n\n")
+      assert_equal input, term(input)
+    end
+
+    def test_line_breaks
+      assert_equal "line\nbreaks", term("line //\nbreaks")
+    end
+
+    def test_rule
+      assert_equal color('- - - - - - - - -').yellow, term('- - - - -')
+    end
+
+    def test_reference
+      assert_equal color('ref').yellow, term('{{ref}}')
+    end
+
+    def test_header
+      assert_equal color("Some Header\n-----------").blue,
+                   term('== Some Header')
+    end
+
+    def test_quote
+      assert_equal color('Quote Lines').green, term("    Quote\n    Lines")
+    end
+
+    private
+
+    def term(body)
+      Formats::Term.new(body).call.to_s
+    end
+
+    def color(str)
+      ColorizedString.new(str)
+    end
+  end
+end

data/test/codeless_code/markup/test_parser.rb

@@ -0,0 +1,177 @@
+# 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 'helper'
+
+module Markup
+  class TestParser < UnitTest # rubocop:disable Metrics/ClassLength
+    def test_name_is_main
+      assert_equal 'main', parse.name
+    end
+
+    def test_anchor
+      para = parse('[[label]]').child
+
+      assert_equal 'p', para.name
+      assert_equal 'a', para.child.name
+      assert_equal 'label', para.child.content
+    end
+
+    def test_link
+      link = parse('[[url|label]]').child.child
+
+      assert_equal 'a', link.name
+      assert_equal 'label', link.content
+      assert_equal 'url', link['href']
+    end
+
+    def test_italic
+      para = parse('/italic/').child
+
+      assert_equal 'p', para.name
+      assert_equal 'em', para.child.name
+      assert_equal 'italic', para.child.content
+    end
+
+    def test_sup
+      para = parse('{{ref}}').child
+
+      assert_equal 'p', para.name
+      assert_equal 'sup', para.child.name
+      assert_equal 'ref', para.child.content
+    end
+
+    def test_hr
+      rule = parse('- - - -').child
+
+      assert_equal 'hr', rule.name
+    end
+
+    def test_br
+      para = parse("first //\nsecond").child
+
+      assert_equal 'p', para.name
+      children = para.children
+      assert_equal 'first', children[0].content
+      assert_equal 'br', children[1].name
+      assert_equal 'second', children[2].content
+    end
+
+    def test_quote
+      quote = parse("    Quote\n    Lines").child
+
+      assert_equal 'blockquote', quote.name
+      assert_equal 'Quote Lines', quote.content
+    end
+
+    private
+
+    def parse(body = nil)
+      Markup::Parser.new(body || fable.body).call
+    end
+
+    def fable(dir = 'en-test', fable = 'case-123.txt', root: fake_fs)
+      (@fable ||= {})["#{dir}/#{fable}"] ||=
+        Fable.new(root.glob(dir).first.glob(fable).first)
+    end
+
+    def fake_fs
+      FakeDir.new('/').tap do |fs|
+        fs.create_path('en-test/case-123.txt', fable_text)
+      end
+    end
+
+    def fable_text
+      <<-FABLE.gsub(/^ {8}/, '')
+        Date: 2013-12-28
+        Number: 125
+        Geekiness: 0
+        Title: Power
+        Names: Subashikoi, Shinpuru, Spider Clan
+        Topics: power, promotion, management, work-life balance
+        Illus.0.src: Vine.jpg
+        Illus.0.title: Even a garden needs a little debugging now and then.
+
+        It is the function of the Temple abbots to direct the
+        activities of their respective clans: choosing projects,
+        setting deadlines, apportioning tasks, and employing
+        whatever means are necessary to ensure that schedules are
+        met.  It is for these powers that the abbots are both envied
+        and despised.  Indeed, it is rare for abbot and monk to
+        cross paths without the latter finding himself more
+        miserable for the experience.
+
+        Thus it was with no great joy that the elder monk
+        [[Shinpuru]] found himself visited by the new head abbot of
+        the [[Spider Clan]].
+
+        - - -
+
+        Shinpuru was in the temple greenhouse, tending the plants of
+        a small winter garden that he kept as a hobby, when the
+        head abbot approached and bowed low, saying: "Have I the good
+        fortune of being in the presence of the monk Shinpuru, whose
+        code is admired throughout the Temple?"
+
+        "This miserable soul is he," said Shinpuru, returning the bow.
+
+        "I have come to ask if you have given any thought to the
+        future," said the abbot.
+
+        "Tomorrow I expect the sun shall rise," answered Shinpuru.
+        "Unless I am wrong, in which case it will not."
+
+        "I was thinking of your future, specifically," replied the
+        abbot.
+
+        The head abbot frowned.  "What would Shinpuru think of a
+        seed that refused to sprout, or a tree that refused to yield
+        fruit?  What else should I think of a monk who so quickly
+        declines an opportunity for growth, for command, for power?"
+
+        Shinpuru set aside his shears to tie up the vine.  "Define
+        power," he said.
+
+        "The ability to do as one wishes," said the abbot.
+
+        "Well, then," said Shinpuru.  "Tomorrow I wish to greet the
+        sunrise with my little bowl.  Then I wish to take some hot
+        tea at my workstation as I read the technical sites I find
+        most illuminating, after which I look forward to a fruitful
+        day of coding interrupted only by some pleasant exchanges
+        with my fellows and a midday meal at this very spot, tending
+        my garden.  When night falls I wish to find myself in my
+        cozy room with a belly full of rice, a cup full of hot sake,
+        a purse full of coins sufficient to buy more seeds, and a
+        mind empty of all other cares."
+
+        The abbot bowed.  "I expect that Shinpuru has all the power
+        he could desire, then.  Unless he is wrong."
+
+        "I am seldom wrong about such things," said Shinpuru,
+        picking up his shears again as another yellow leaf caught
+        his eye.  "In a world where even the sunrise is uncertain, a
+        man may be excused for not knowing a great many things.  But
+        to not know my own heart?  I hope to never be so hopeless
+        a fool."
+
+
+        {{*}} As documented in cases [[#61|61]], [[#62|62]], [[#67|67]], [[#120|120]], and probably others besides.  Abbots in the Spider Clan have the average life expectancy of a dolphin in the Gobi desert.
+      FABLE
+    end
+  end
+end

data/test/codeless_code/test_cli.rb

@@ -18,7 +18,7 @@
 require 'helper'
 require 'minitest/mock'
 
-class TestCli < UnitTest
+class TestCli < UnitTest # rubocop:disable Metrics/ClassLength
   def setup
     @pager = ENV.delete('PAGER')
   end
@@ -27,11 +27,29 @@ class TestCli < UnitTest
     ENV['PAGER'] = @pager
   end
 
+  def test_bad_arguments
+    assert_output(nil, /unknown option `--unknown-flag'/) do
+      cli('--unknown-flag').call
+    end
+    assert_output(nil, /Usage: test_app/) do
+      cli('--unknown-flag').call
+    end
+  end
+
+  def test_bad_number
+    assert_raises(ArgumentError) { cli('--random-set', 'string').call }
+  end
+
   def test_call_default
     expected = "00123  Test Case\n00234  Test Case 2\n"
     assert_output(expected) { cli.call }
   end
 
+  def test_force_stdout
+    expected = "00123  Test Case\n00234  Test Case 2\n"
+    assert_output(expected) { cli('-o', '-').call }
+  end
+
   def test_call_single_by_number
     [
       "    Test Case\n" \
@@ -56,6 +74,42 @@ class TestCli < UnitTest
     assert_output("en  test\n") { cli('--list-translations').call }
   end
 
+  def test_random_stability
+    create_cases(10)
+    cli = cli('--random')
+
+    first  = capture_io { Random.srand(0) && cli.call }
+    second = capture_io { Random.srand(1) && cli.call }
+    third  = capture_io { Random.srand(0) && cli.call }
+
+    assert_equal first, third
+    refute_equal first, second
+  end
+
+  def test_random_set_stability
+    create_cases(10)
+    cli = cli('--random-set', '10')
+
+    first  = capture_io { Random.srand(0) && cli.call }
+    second = capture_io { Random.srand(1) && cli.call }
+    third  = capture_io { Random.srand(0) && cli.call }
+
+    assert_equal first, third
+    refute_equal first, second
+  end
+
+  def test_daily_stability
+    create_cases(10)
+    cli = cli('--daily')
+
+    first  = capture_io { stub_today('2018-12-23') { cli.call } }
+    second = capture_io { stub_today('2000-11-11') { cli.call } }
+    third  = capture_io { stub_today('2018-12-23') { cli.call } }
+
+    assert_equal first, third
+    refute_equal first, second
+  end
+
   private
 
   def cli(*args)
@@ -64,7 +118,11 @@ class TestCli < UnitTest
     end
   end
 
-  def fake_fs # rubocop:disable Metrics/MethodLength
+  def fake_fs
+    @fake_fs ||= create_fake_fs
+  end
+
+  def create_fake_fs # rubocop:disable Metrics/MethodLength
     FakeDir.new('/').tap do |fs|
       fs.create_path('en-test/case-123.txt', <<-FABLE)
         Title: Test Case
@@ -82,4 +140,19 @@ class TestCli < UnitTest
       FABLE
     end
   end
+
+  def create_cases(count)
+    (100..(100 + count)).each do |num|
+      fake_fs.create_path("en/test/case-#{num}.txt", <<-FABLE)
+        Title: Case #{num}
+        Number: #{num}
+
+        Case #{num}
+      FABLE
+    end
+  end
+
+  def stub_today(date, &blk)
+    Date.stub(:today, Date.parse(date), &blk)
+  end
 end

data/test/support/fs.rb

@@ -1,5 +1,20 @@
 # 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/>.
 module Support
   class FakeFile
     attr_reader :name, :path, :body, :parent