codeless_code 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5154091052ec2023109ecdc022ec10fdfa3762dcec89f1dd2f6203acac57018d
-  data.tar.gz: f9eb3c12e08dd25885faf6d758d67e1020d324a8ce53ab7c77b486b001eeceb1
+  metadata.gz: c894ee4dd542acaa1728467fed14bb268637e7ff83b879b124f2b1c7648822f4
+  data.tar.gz: 0a7e08880e5a9f3391602f0a78519456f82b3dff75128ddc72ca50e043355d04
 SHA512:
-  metadata.gz: bba85e6463c19551a62b0064af87905f0bc1781bcaf198591c2513b4157ae514cc0fd17e31da864683be25c599c7d4170250ecfee8a098c45df9caab6d40600d
-  data.tar.gz: 4d8b4f45d6511bac204a88bb5b936a5303da0d5bbed221bdfa0531e03ee45193bcce7ae3f959c5d3c1b41f8ea75359598a5d010a09e98393dfa57dfd9a1de525
+  metadata.gz: 7f3696c7bdaafdd0da45751f727c48c1a2cf1aa258a66a5f430f759d09514c67f81f7dca8641d1a4f4d4ae645090561ea25346e5d4b4e6978c4a900b6c35b076
+  data.tar.gz: d5c134eac07fb092af685b8e547e07447b72d99301ae225b60168c3c4ef6232a755b699f7e66e2873f3ff8aef9cd9a203c97a9c10d04c6f9d5d9182f34965af8

data/.gitmodules

@@ -1,3 +1,3 @@
 [submodule "data/the-codeless-code"]
-	path = data/the-codeless-code
+	path = data
 	url = https://github.com/sangster/the-codeless-code.git

data/.reek.yml

@@ -8,6 +8,8 @@ detectors:
     enabled: false
   LongParameterList:
     max_params: 4
+  RepeatedConditional:
+    enabled: false
   UtilityFunction:
     exclude:
       - CodelessCode::Filters::Headers::Base

data/Gemfile

@@ -18,7 +18,6 @@
 source 'https://rubygems.org'
 
 gem 'colorize', '~> 0.8'
-gem 'mediacloth', '~> 0.6'
 gem 'nokogiri', '~> 1.8'
 gem 'slop', '~> 4.6'
 

data/Gemfile.lock

@@ -74,7 +74,6 @@ GEM
       rb-inotify (~> 0.9, >= 0.9.7)
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
-    mediacloth (0.6)
     method_source (0.9.0)
     mime-types (2.99.3)
     mini_portile2 (2.3.0)
@@ -161,7 +160,6 @@ DEPENDENCIES
   guard-reek (~> 1.2)
   guard-rubocop (~> 1.3)
   jeweler (~> 2.0)
-  mediacloth (~> 0.6)
   minitest (~> 5.11)
   minitest-reporters (~> 1.3)
   nokogiri (~> 1.8)

data/Guardfile

@@ -1,6 +1,6 @@
+# vim:ft=ruby:
 # frozen_string_literal: true
 
-# vim:ft=ruby:
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -16,18 +16,20 @@
 #
 # You should have received a copy of the GNU General Public License along with
 # this program. If not, see <https://www.gnu.org/licenses/>.
-guard :minitest, all_after_pass: true do
-  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
-  watch(%r{^test/helper\.rb$})           { 'test' }
-end
+group :everything, halt_on_fail: true do
+  guard :minitest, all_after_pass: true do
+    watch(%r{^test/(.*)\/?test_(.*)\.rb$})
+    watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+    watch(%r{^test/helper\.rb$})           { 'test' }
+  end
 
-guard :reek do
-  watch(%r{^lib/.+\.rb$})
-  watch('.reek.yml')
-end
+  guard :reek do
+    watch(%r{^lib/.+\.rb$})
+    watch('.reek.yml')
+  end
 
-guard :rubocop do
-  watch(/.+\.rb$/)
-  watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  guard :rubocop do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
 end

data/VERSION

@@ -1 +1 @@
-0.1.8
+0.2.0

data/codeless_code.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: codeless_code 0.1.8 ruby lib
+# stub: codeless_code 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "codeless_code".freeze
-  s.version = "0.1.8"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Jon Sangster".freeze]
-  s.date = "2018-11-09"
+  s.date = "2018-11-17"
   s.description = "http://thecodelesscode.com contains many humorous and interesting fables and koans. The authors have open-sourced these fables, and many tanslations, available at https://github.com/aldesantis/the-codeless-code. This tool provides a CLI to filter through these fables and view them.".freeze
   s.email = "jon@ertt.ca".freeze
   s.executables = ["codeless_code".freeze]
@@ -1495,13 +1495,13 @@ Gem::Specification.new do |s|
     "lib/codeless_code/filters/lang.rb",
     "lib/codeless_code/filters/translator.rb",
     "lib/codeless_code/formats/base.rb",
-    "lib/codeless_code/formats/parsers/base.rb",
-    "lib/codeless_code/formats/parsers/plain.rb",
-    "lib/codeless_code/formats/parsers/term.rb",
     "lib/codeless_code/formats/plain.rb",
     "lib/codeless_code/formats/raw.rb",
     "lib/codeless_code/formats/term.rb",
     "lib/codeless_code/language_set.rb",
+    "lib/codeless_code/markup/converter.rb",
+    "lib/codeless_code/markup/nodes.rb",
+    "lib/codeless_code/markup/parser.rb",
     "lib/codeless_code/options.rb",
     "lib/codeless_code/renderers/fable.rb",
     "lib/codeless_code/renderers/term_page.rb",
@@ -1511,8 +1511,12 @@ Gem::Specification.new do |s|
     "test/codeless_code/filters/test_builders.rb",
     "test/codeless_code/filters/test_composite.rb",
     "test/codeless_code/filters/test_date.rb",
-    "test/codeless_code/filters/test_langs.rb",
+    "test/codeless_code/filters/test_lang.rb",
     "test/codeless_code/filters/test_translator.rb",
+    "test/codeless_code/formats/test_plain.rb",
+    "test/codeless_code/formats/test_raw.rb",
+    "test/codeless_code/formats/test_term.rb",
+    "test/codeless_code/markup/test_parser.rb",
     "test/codeless_code/renderers/test_fable.rb",
     "test/codeless_code/renderers/test_term_page.rb",
     "test/codeless_code/test_catalog.rb",
@@ -1534,7 +1538,6 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<colorize>.freeze, ["~> 0.8"])
-      s.add_runtime_dependency(%q<mediacloth>.freeze, ["~> 0.6"])
       s.add_runtime_dependency(%q<nokogiri>.freeze, ["~> 1.8"])
       s.add_runtime_dependency(%q<slop>.freeze, ["~> 4.6"])
       s.add_development_dependency(%q<bundler>.freeze, ["~> 1.17"])
@@ -1554,7 +1557,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<yard>.freeze, ["~> 0.9"])
     else
       s.add_dependency(%q<colorize>.freeze, ["~> 0.8"])
-      s.add_dependency(%q<mediacloth>.freeze, ["~> 0.6"])
       s.add_dependency(%q<nokogiri>.freeze, ["~> 1.8"])
       s.add_dependency(%q<slop>.freeze, ["~> 4.6"])
       s.add_dependency(%q<bundler>.freeze, ["~> 1.17"])
@@ -1575,7 +1577,6 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<colorize>.freeze, ["~> 0.8"])
-    s.add_dependency(%q<mediacloth>.freeze, ["~> 0.6"])
     s.add_dependency(%q<nokogiri>.freeze, ["~> 1.8"])
     s.add_dependency(%q<slop>.freeze, ["~> 4.6"])
     s.add_dependency(%q<bundler>.freeze, ["~> 1.17"])

data/data/the-codeless-code/de-andrebogus/case-193.txt

@@ -51,4 +51,4 @@ aufgenommen werden können?"
 lieben?"
 
 
-{{*}} "Stealthy Wombat" spendete folgendes Gedicht:<p>Enkudu nahm zur Tausend-Meilen-Reise<br>Gehstock, Fisch -- und Navigationsgerät<br>wie glücklich die ersten zwei Schwestern,<br>dass Enkudu ihre Liebe nie schmäht.</p>
+{{*}} "Stealthy Wombat" spendete folgendes Gedicht:<p>Enkudu nahm zur Tausend-Meilen-Reise<br>Gehstock, Fisch -- und Navigationsgerät<br>wie glücklich die ersten zwei Schwestern,<br>dass Enkudu ihre Liebe nie schmäht.

data/data/the-codeless-code/de-andrebogus/case-74.txt

@@ -42,4 +42,4 @@ Schalen hässlich und seine Lager klein sind."
 ihrem Handtuch.  "Nun sitzt er in einem Haufen Perlen, und hungert nach 
 Austernfleisch."
 
-{{*}} "Stealthy Wombat" bietet uns dies Gedicht:<p> Yishi-Shing verliert seine Perle im Saal,<br> lässt Yíwen und Hwidah lang sie suchen,<br> Und Ahab quert die See, findet doch nicht den Wal,<br> und so bleibet ihm nichts als zu fluchen.</p>
+{{*}} "Stealthy Wombat" bietet uns dies Gedicht:<p> Yishi-Shing verliert seine Perle im Saal,<br> lässt Yíwen und Hwidah lang sie suchen,<br> Und Ahab quert die See, findet doch nicht den Wal,<br> und so bleibet ihm nichts als zu fluchen.

data/data/the-codeless-code/en-qi/case-194.txt

@@ -86,4 +86,4 @@ between order and chaos."
 
 Hearing these words, Zjing was enlightened.
 
-{{*}} Translator Andre Bogus offers the following poem:<p>The herd was still, the cattle grazed<br>Zjing saw them and was amazed<br>How full of harmony those cows<br>unlike her monks the meadow browse</p>
+{{*}} Translator Andre Bogus offers the following poem:<p>The herd was still, the cattle grazed<br>Zjing saw them and was amazed<br>How full of harmony those cows<br>unlike her monks the meadow browse

data/data/the-codeless-code/en-qi/case-74.txt

@@ -49,4 +49,4 @@ Hwídah from under her towel.  'Now, bedecked in orphan
 pearls, we will starve for want of oyster-meat."
 
 
-{{*}} "Stealthy Wombat" offers this poem:<p>Yíwen and Hwídah sift the yard for Yishi-Shing's pearl<br>In spring, he loses it again<br>Ahab searched the seas for the white whale<br>The whale was white, but oh! So broad the ocean!</p>
+{{*}} "Stealthy Wombat" offers this poem:<p>Yíwen and Hwídah sift the yard for Yishi-Shing's pearl<br>In spring, he loses it again<br>Ahab searched the seas for the white whale<br>The whale was white, but oh! So broad the ocean!

data/lib/codeless_code/cli.rb

@@ -32,7 +32,6 @@ module CodelessCode
       call_io(user_io)
     rescue Slop::Error => err
       warn format("%s\n\n%s", err, options.help)
-      exit 1
     ensure
       user_io&.close
     end
@@ -98,6 +97,7 @@ module CodelessCode
       end
     end
 
+    # @return [Random] with a seed value determined by the current date
     # :reek:UtilityFunction
     def date_random_generator
       Random.new(::Date.today.strftime('%Y%m%d').to_i)

data/lib/codeless_code/fable.rb

@@ -40,7 +40,7 @@ module CodelessCode
       @body_pos = 0
     end
 
-    # @return [String] the actual story, including MediaWiki markup
+    # @return [String] the actual story, including markup
     def body
       @body ||= read_body.freeze
     end

data/lib/codeless_code/formats/base.rb

@@ -15,7 +15,6 @@
 #
 # 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 'nokogiri'
 
 module CodelessCode
@@ -30,24 +29,8 @@ module CodelessCode
 
       protected
 
-      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 to_s
-        @doc.css('body > *').to_xhtml
+      def render_children(node)
+        node.children.map(&method(:render)).join
       end
     end
   end

data/lib/codeless_code/formats/plain.rb

@@ -15,39 +15,52 @@
 #
 # 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
     # Prints the {Fable} without any formatting, but removes the markup.
     class Plain < Base
+      include Markup::Nodes
+
       def call
-        raw.split("\n\n")
-           .map { |str| from_wiki(CleanupBody.new(str)) }
-           .join("\n\n")
+        main = Markup::Parser.new(raw).call
+        render(Markup::Converter.new(main).call).rstrip
       end
 
-      protected
+      private
 
-      def from_wiki(str)
-        super(XhtmlDoc.parse(str.to_s), :Plain)
+      def render(node)
+        render_leaf(node) || render_container(node) ||
+          raise(format('Unexpected %s: %p', node.class, node))
+      end
+
+      # :reek:UtilityFunction
+      def render_leaf(node)
+        case node
+        when String    then node
+        when LineBreak then "\n"
+        when Rule      then '- - - - - - - - -' + "\n\n"
+        end
+      end
+
+      def render_container(node)
+        case node
+        when Doc, Bold, Em, Link then render_children(node)
+        when Reference           then format('[%s]', render_children(node))
+        when Header              then render_header(node)
+        when Para                then render_children(node) + "\n\n"
+        when Quote               then render_quote(node)
+        end
       end
-    end
 
-    # Tidies up the mixed syntax found in fables
-    class CleanupBody
-      def initialize(body)
-        @body = body
+      def render_header(node)
+        inner = render_children(node)
+        format("%s\n%s", inner, '-' * inner.length) + "\n\n"
       end
 
-      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) }
+      def render_quote(node)
+        render_children(node).lines
+                             .map { |line| "\t" + line }
+                             .join + "\n\n"
       end
     end
   end

data/lib/codeless_code/formats/term.rb

@@ -16,39 +16,69 @@
 # 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 'colorized_string'
-require 'mediacloth'
 
 module CodelessCode
   module Formats
     # Renders the {Fable} using ANSI control characters for bold, italics,
     # colors, etc.
     class Term < Base
+      include Markup::Nodes
+
       def call
-        from_wiki
+        render(
+          Markup::Converter.new(
+            Markup::Parser.new(raw).call
+          ).call
+        ).strip
       end
 
-      # :reek:UtilityFunction
-      def color(str)
-        ColorizedString.new(str)
+      private
+
+      def render(node)
+        render_leaf(node) || render_container(node) || render_style(node) ||
+          raise(format('Unexpected %s: %p', node.class, node))
       end
 
-      protected
+      def render_leaf(node)
+        case node
+        when String    then node
+        when LineBreak then "\n"
+        when Rule      then format("%s\n\n", color('- - - - - - - - -').yellow)
+        end
+      end
 
-      def from_wiki
-        super(XhtmlDoc.parse(regex_raw), :Term)
+      def render_style(node)
+        case node
+        when Bold      then color(render_children(node)).bold
+        when Em        then color(render_children(node)).italic
+        when Reference then color(render_children(node)).yellow
+        end
       end
 
-      private
+      def render_container(node)
+        case node
+        when Doc    then render_children(node)
+        when Header then render_header(node)
+        when Link   then color(render_children(node)).underline
+        when Para   then render_children(node) + "\n\n"
+        when Quote  then render_quote(node)
+        end
+      end
+
+      def render_header(node)
+        inner = render_children(node)
+        color(format("%s\n%s", inner, '-' * inner.length)).blue + "\n\n"
+      end
 
-      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) }
+      def render_quote(node)
+        render_children(node).lines
+                             .map { |line| "\t" + color(line).green }
+                             .join + "\n\n"
+      end
+
+      # :reek:UtilityFunction
+      def color(str)
+        ColorizedString.new(str.to_s)
       end
     end
   end

data/lib/codeless_code/markup/converter.rb

@@ -0,0 +1,78 @@
+# 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 CodelessCode
+  module Markup
+    CONTAINER_HTML = {
+      'blockquote' => Nodes::Quote,
+      'b' => Nodes::Bold,
+      'div' => Nodes::Para,
+      'em' => Nodes::Em,
+      'h2' => Nodes::Header,
+      'i' => Nodes::Em,
+      'main' => Nodes::Doc,
+      'p' => Nodes::Para,
+      'span' => Nodes::Para,
+      'strong' => Nodes::Bold,
+      'sup' => Nodes::Reference,
+      'tt' => Nodes::Bold
+    }.freeze
+
+    # Converts {Nokogiri} elements to {Nodes::Node} elements
+    class Converter
+      def initialize(elem)
+        @elem = elem
+      end
+
+      # @return [Nodes::Node]
+      def call
+        convert_elem(@elem)
+      end
+
+      private
+
+      # :reek:FeatureEnvy
+      def convert_elem(elem)
+        if elem.text?
+          elem.content
+        elsif (type = CONTAINER_HTML[elem.name])
+          type.new(convert_children(elem))
+        else
+          convert_special(elem)
+        end
+      end
+
+      def convert_children(elem)
+        elem.children.map { |ch| self.class.new(ch).call }
+      end
+
+      def convert_special(elem)
+        case elem.name
+        when 'a' then convert_link(elem)
+        when 'br' then Nodes::LineBreak.new
+        when 'hr' then Nodes::Rule.new
+        else
+          raise format('Unexpected: %p', elem)
+        end
+      end
+
+      def convert_link(elem)
+        Nodes::Link.new(elem['href'], convert_children(elem))
+      end
+    end
+  end
+end

data/lib/codeless_code/markup/nodes.rb

@@ -0,0 +1,64 @@
+# 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 CodelessCode
+  module Markup
+    # Elements representing the markup of a Fable
+    # :reek:ModuleInitialize
+    module Nodes
+      ELEM_CONTAINERS = %i[Doc Para Quote Bold Em Reference Header].freeze
+      ELEM_VOID = %i[LineBreak Rule].freeze
+
+      # An element in the syntax tree
+      class Node
+        def initialize(children = nil)
+          @children = children
+        end
+
+        def to_s
+          children.map(&:to_s).join
+        end
+
+        def children
+          @children || []
+        end
+      end
+
+      ELEM_CONTAINERS.each do |name|
+        const_set(name, Class.new(Node))
+      end
+
+      ELEM_VOID.each do |name|
+        const_set(name, Class.new(Node) do
+          def initialize
+            super()
+          end
+        end)
+      end
+
+      # A hyperlink. Either +<a href=""></a>+, +[[label]]+, or +[[url|label]]+
+      class Link < Node
+        attr_reader :href
+
+        def initialize(href = nil, children = [])
+          super(children)
+          @href = href
+        end
+      end
+    end
+  end
+end