codeless_code 0.1.7 → 0.1.8

data/lib/codeless_code.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,6 +17,7 @@
 # this program. If not, see <https://www.gnu.org/licenses/>.
 require 'pathname'
 
+# +CodelessCode+ filters and renders {Fable fables}.
 module CodelessCode
   autoload  :Catalog,      'codeless_code/catalog'
   autoload  :Cli,          'codeless_code/cli'
@@ -24,20 +27,28 @@ module CodelessCode
   autoload  :LanguageSet,  'codeless_code/language_set'
   autoload  :Options,      'codeless_code/options'
 
+  # The "main" methods this applications supports
   module Commands
     autoload  :FilterFables,      'codeless_code/commands/filter_fables'
     autoload  :ListTranslations,  'codeless_code/commands/list_translations'
   end
 
+  # The methods in which {Fable fables} may be rendered as text.
   module Formats
     autoload  :Base,            'codeless_code/formats/base'
     autoload  :Plain,           'codeless_code/formats/plain'
-    autoload  :PlainGenerator,  'codeless_code/formats/plain_generator'
     autoload  :Raw,             'codeless_code/formats/raw'
     autoload  :Term,            'codeless_code/formats/term'
-    autoload  :TermGenerator,   'codeless_code/formats/term_generator'
+
+    # 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
   end
 
+  # The methods in which a {Fable fables's} body may be rendered as text.
   module Renderers
     autoload  :Fable,     'codeless_code/renderers/fable'
     autoload  :TermPage,  'codeless_code/renderers/term_page'
@@ -45,7 +56,7 @@ module CodelessCode
 
   VERSION = Pathname.new(__dir__).join('..', 'VERSION').read.strip.freeze
   DEFAULT_DATA = Pathname.new(__dir__)
-                     .join('..', 'data', 'the-codeless-code').freeze
+                         .join('..', 'data', 'the-codeless-code').freeze
 
   BANNERS = [
     '%<cmd>s [INFO]',
@@ -53,108 +64,110 @@ module CodelessCode
     '%<cmd>s [OPTION]... [FILTER]... [NUMBER]'
   ].freeze
 
-  OPTIONS = proc do |cmd, o|
-    banner = [[BANNERS[0]] + BANNERS[1..-1].map { |s| "\n       #{s}" }].join
-
-    o.banner = format("Usage: #{banner}", cmd: cmd)
-    o.separator ''
-    o.separator 'Print or filter Codeless Code fables.'
-
-    o.separator ''
-    o.separator 'Info'
-    o.boolean '-h', '--help'
-    o.boolean '--list-translations'
-    o.boolean '--version'
-
-    o.separator ''
-    o.separator 'Options'
-    o.boolean '-c', '--columns', 'when listing fables, format the output ' \
-                                 'into columns'
-    o.array '-e', '--headers', 'headers to include in the list output. ' \
-                               'may be repeated'
-    o.string '-f', '--format', 'one of: raw, plain, or term (default)'
-    o.string '-o', '--output', 'write to the given file. "-" for STDOUT'
-    o.string '-p', '--path', 'path to directory of fables. ' \
-                             'see github.com/aldesantis/the-codeless-code'
-    o.boolean '--random', 'select one fable, randomly, from the filtered list'
-    o.string '--random-set', 'select n fables, randomly, from the filtered list'
-    o.boolean '--daily', 'select one fable, randomly, from the filtered list' \
-                         'based on today\'s date'
-    o.boolean '--trace', 'print full error message if a fable fails to parse'
-
-    o.string '-s', '--sort', 'when listing fables, sort by the given header'
-    o.boolean '-r', '--reverse', 'when listing fables, reverse the order'
-
-    o.separator ''
-    o.separator 'Series Filters'
-    o.string '-S', '--series'
-    o.string '-Ss', '--series-start', 'series starts with'
-    o.string '-Se', '--series-end', 'series ends with'
-    o.boolean '-hS', '--has-series', 'has series listed'
-    o.boolean '-nS', '--no-series', 'no series listed'
-
-    o.separator ''
-    o.separator 'Title Filters'
-    o.string '-T', '--title'
-    o.string '-Ts', '--title-start', 'title starts with'
-    o.string '-Te', '--title-end', 'title ends with'
-    o.boolean '-hT', '--has-title', 'has title listed'
-    o.boolean '-nT', '--no-title', 'no title listed'
-
-    o.separator ''
-    o.separator 'Number Filters'
-    o.string '-N', '--number', 'number (this is the default argument)'
-    o.string '-Ng', '--number-gte', 'number or greater'
-    o.string '-Nl', '--number-lte', 'number or lower'
-    o.boolean '-hN', '--has-number', 'has number listed'
-    o.boolean '-nN', '--no-number', 'no number listed'
-
-    o.separator ''
-    o.separator 'Language Filters'
-    o.string '-L', '--lang', 'language code (default: en)'
-
-    o.separator ''
-    o.separator 'Translator Filters'
-    o.string '-R', '--translator', 'translator\'s name (default: first ' \
-      'one, alphabetically)'
-    o.string '-Rx', '--translator-exact', 'translator\'s name, ' \
-      'case-sensitive (default: first one, alphabetically)'
-
-    o.separator ''
-    o.separator 'Date Filters'
-    o.string '-D', '--date', 'publish date'
-    o.string '-Da', '--date-after', 'publish date or after'
-    o.string '-Db', '--date-before', 'publish date or before'
-    o.boolean '-nD', '--no-date', 'no publish date listed'
-
-    o.separator ''
-    o.separator 'Geekiness Filters'
-    o.string '-G', '--geekiness', 'geekiness rating'
-    o.string '-Gg', '--geekiness-gte', 'geekiness rating or greater'
-    o.string '-Gl', '--geekiness-lte', 'geekiness rating or lower'
-    o.boolean '-nG', '--no-geekiness', 'no geekiness rating'
-
-    o.separator ''
-    o.separator 'Name Filters'
-    o.string '-A', '--name'
-    o.string '-As', '--name-start', 'name starts with'
-    o.string '-Ae', '--name-end', 'name ends with'
-    o.boolean '-nA', '--no-name', 'no name listed'
-
-    o.separator ''
-    o.separator 'Credits Filters'
-    o.string '-C', '--credits'
-    o.string '-Cs', '--credits-start', 'credits starts with'
-    o.string '-Ce', '--credits-end', 'credits ends with'
-    o.boolean '-hC', '--has-credits', 'has credits listed'
-    o.boolean '-nC', '--no-credits', 'no credits listed'
-
-    o.separator ''
-    o.separator 'Tagline Filters'
-    o.string '-I', '--tagline'
-    o.string '-Is', '--tagline-start', 'tagline starts with'
-    o.string '-Ie', '--tagline-end', 'tagline ends with'
-    o.boolean '-hI', '--has-tagline', 'has tagline listed'
-    o.boolean '-nI', '--no-tagline', 'no tagline listed'
+  OPTIONS = proc do |cmd, opt|
+    banner =
+      [[BANNERS[0]] + BANNERS[1..-1].map { |str| "\n       #{str}" }].join
+
+    opt.banner = format("Usage: #{banner}", cmd: cmd)
+    opt.separator ''
+    opt.separator 'Print or filter Codeless Code fables.'
+
+    opt.separator ''
+    opt.separator 'Info'
+    opt.boolean '-h', '--help'
+    opt.boolean '--list-translations'
+    opt.boolean '--version'
+
+    opt.separator ''
+    opt.separator 'Options'
+    opt.boolean '-c', '--columns', 'when listing fables, format the output ' \
+                                   'into columns'
+    opt.array '-e', '--headers', 'headers to include in the list output. ' \
+                                 'may be repeated'
+    opt.string '-f', '--format', 'one of: raw, plain, or term (default)'
+    opt.string '-o', '--output', 'write to the given file. "-" for STDOUT'
+    opt.string '-p', '--path', 'path to directory of fables. ' \
+                               'see github.com/aldesantis/the-codeless-code'
+    opt.boolean '--random', 'select one random fable from the filtered list'
+    opt.string '--random-set', 'select n random fables from the filtered list'
+    opt.boolean '--daily', 'select one fable, randomly, from the filtered ' \
+                           'list based on today\'s date'
+    opt.boolean '--trace', 'print full error message if a fable fails to parse'
+
+    opt.string '-s', '--sort', 'when listing fables, sort by the given header'
+    opt.boolean '-r', '--reverse', 'when listing fables, reverse the order'
+
+    opt.separator ''
+    opt.separator 'Series Filters'
+    opt.string '-S', '--series'
+    opt.string '-Ss', '--series-start', 'series starts with'
+    opt.string '-Se', '--series-end', 'series ends with'
+    opt.boolean '-hS', '--has-series', 'has series listed'
+    opt.boolean '-nS', '--no-series', 'no series listed'
+
+    opt.separator ''
+    opt.separator 'Title Filters'
+    opt.string '-T', '--title'
+    opt.string '-Ts', '--title-start', 'title starts with'
+    opt.string '-Te', '--title-end', 'title ends with'
+    opt.boolean '-hT', '--has-title', 'has title listed'
+    opt.boolean '-nT', '--no-title', 'no title listed'
+
+    opt.separator ''
+    opt.separator 'Number Filters'
+    opt.string '-N', '--number', 'number (this is the default argument)'
+    opt.string '-Ng', '--number-gte', 'number or greater'
+    opt.string '-Nl', '--number-lte', 'number or lower'
+    opt.boolean '-hN', '--has-number', 'has number listed'
+    opt.boolean '-nN', '--no-number', 'no number listed'
+
+    opt.separator ''
+    opt.separator 'Language Filters'
+    opt.string '-L', '--lang', 'language code (default: en)'
+
+    opt.separator ''
+    opt.separator 'Translator Filters'
+    opt.string '-R', '--translator', 'translator\'s name (default: first ' \
+                                     'one, alphabetically)'
+    opt.string '-Rx', '--translator-exact',
+               'translator\'s name, case-sensitive (default: first one, ' \
+               'alphabetically)'
+
+    opt.separator ''
+    opt.separator 'Date Filters'
+    opt.string '-D', '--date', 'publish date'
+    opt.string '-Da', '--date-after', 'publish date or after'
+    opt.string '-Db', '--date-before', 'publish date or before'
+    opt.boolean '-nD', '--no-date', 'no publish date listed'
+
+    opt.separator ''
+    opt.separator 'Geekiness Filters'
+    opt.string '-G', '--geekiness', 'geekiness rating'
+    opt.string '-Gg', '--geekiness-gte', 'geekiness rating or greater'
+    opt.string '-Gl', '--geekiness-lte', 'geekiness rating or lower'
+    opt.boolean '-nG', '--no-geekiness', 'no geekiness rating'
+
+    opt.separator ''
+    opt.separator 'Name Filters'
+    opt.string '-A', '--name'
+    opt.string '-As', '--name-start', 'name starts with'
+    opt.string '-Ae', '--name-end', 'name ends with'
+    opt.boolean '-nA', '--no-name', 'no name listed'
+
+    opt.separator ''
+    opt.separator 'Credits Filters'
+    opt.string '-C', '--credits'
+    opt.string '-Cs', '--credits-start', 'credits starts with'
+    opt.string '-Ce', '--credits-end', 'credits ends with'
+    opt.boolean '-hC', '--has-credits', 'has credits listed'
+    opt.boolean '-nC', '--no-credits', 'no credits listed'
+
+    opt.separator ''
+    opt.separator 'Tagline Filters'
+    opt.string '-I', '--tagline'
+    opt.string '-Is', '--tagline-start', 'tagline starts with'
+    opt.string '-Ie', '--tagline-end', 'tagline ends with'
+    opt.boolean '-hI', '--has-tagline', 'has tagline listed'
+    opt.boolean '-nI', '--no-tagline', 'no tagline listed'
   end
 end

data/test/codeless_code/commands/test_filter_fables.rb

@@ -0,0 +1,89 @@
+# 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 'minitest/mock'
+
+module Commands
+  class TestFilterFables < UnitTest
+    def setup
+      @pager = ENV.delete('PAGER')
+    end
+
+    def teardown
+      ENV['PAGER'] = @pager
+    end
+
+    def test_call_default
+      expected = ['00123  Test Case', '00234  Test Case 2', ''].join("\n")
+      assert_output(expected) { command.call }
+    end
+
+    def test_call_single_by_number
+      [
+        "    Test Case\n" \
+        "==================\n" \
+        "Number: 123\n" \
+        "  Date: 2018-12-23\n" \
+        "------------------\n" \
+        "\n" \
+        "body\n"
+      ].each { |expected| assert_output(expected) { command('123').call } }
+    end
+
+    def test_call_match_none
+      assert_output(nil, "None found.\n") { command('9999').call }
+    end
+
+    def test_call_reverse
+      expected = ['00234  Test Case 2', '00123  Test Case', ''].join("\n")
+      assert_output(expected) { command('-r').call }
+    end
+
+    def test_call_sort
+      expected = ['00234  Test Case 2', '00123  Test Case', ''].join("\n")
+      assert_output(expected) { command('-s', 'Date').call }
+    end
+
+    private
+
+    def command(*args)
+      opts = options(*args)
+      opts.instance_variable_set(:@data_dir, fake_fs)
+      Commands::FilterFables.new(catalog, opts)
+    end
+
+    def fake_fs # rubocop:disable Metrics/MethodLength
+      FakeDir.new('/').tap do |fs|
+        fs.create_path('en-test/case-123.txt', <<-FABLE)
+          Title: Test Case
+          Number: 123
+          Date: 2018-12-23
+
+          body
+        FABLE
+        fs.create_path('en-test/case-234.txt', <<-FABLE)
+          Title: Test Case 2
+          Number: 234
+          Date: 2000-12-23
+
+          body 2
+        FABLE
+      end
+    end
+  end
+end

data/test/codeless_code/filters/headers/test_integer.rb

@@ -0,0 +1,86 @@
+# 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 Filters
+  module Headers
+    class TestInteger < UnitTest
+      def test_enabled?
+        refute_predicate filter('Test'), :enabled?
+        refute_predicate filter('Test', exclude: false), :enabled?
+
+        assert_predicate filter('Test', exact: 1), :enabled?
+        assert_predicate filter('Test', min: 1), :enabled?
+        assert_predicate filter('Test', max: 1), :enabled?
+        assert_predicate filter('Test', exclude: true), :enabled?
+      end
+
+      def test_call_exact
+        assert_filter(exact: 100)
+
+        refute_filter(exact: 123)
+      end
+
+      def test_call_min
+        assert_filter(min: 99)
+        assert_filter(min: 100)
+
+        refute_filter(min: 101)
+      end
+
+      def test_call_max
+        assert_filter(max: 100)
+        assert_filter(max: 101)
+
+        refute_filter(max: 99)
+      end
+
+      def test_call_exclude
+        assert_filter('MissingHeader', exclude: true)
+
+        refute_filter(exclude: true)
+      end
+
+      private
+
+      def filter(key, **opts)
+        Filters::Headers::Integer.new(key, **opts)
+      end
+
+      def assert_filter(key = 'Test', **opts)
+        fab = create_fable
+        filt = filter(key, **opts)
+        assert filt.call(fab), format('Expected %p to match %p', opts, fab)
+      end
+
+      def refute_filter(key = 'Test', **opts)
+        fab = create_fable
+        filt = filter(key, **opts)
+        refute filt.call(fab), format('Expected %p not to match %p', opts, fab)
+      end
+
+      def create_fable
+        mock_fable(<<-BODY.strip)
+          Test: 100
+
+          body
+        BODY
+      end
+    end
+  end
+end

data/test/codeless_code/filters/headers/test_string.rb

@@ -0,0 +1,86 @@
+# 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 Filters
+  module Headers
+    class TestString < UnitTest
+      def test_enabled?
+        refute_predicate filter('Test'), :enabled?
+        refute_predicate filter('Test', exclude: false), :enabled?
+
+        assert_predicate filter('Test', exact: 'foo'), :enabled?
+        assert_predicate filter('Test', start_with: 'foo'), :enabled?
+        assert_predicate filter('Test', end_with: 'foo'), :enabled?
+        assert_predicate filter('Test', exclude: true), :enabled?
+      end
+
+      def test_call_exact
+        assert_filter(exact: 'some text')
+
+        refute_filter(exact: 'something else')
+      end
+
+      def test_call_start_with
+        assert_filter(start_with: 'some')
+        assert_filter(start_with: '')
+
+        refute_filter(start_with: 'something else')
+      end
+
+      def test_call_end_with
+        assert_filter(end_with: 'text')
+        assert_filter(end_with: '')
+
+        refute_filter(end_with: 'something else')
+      end
+
+      def test_call_exclude
+        assert_filter('MissingHeader', exclude: true)
+
+        refute_filter(exclude: true)
+      end
+
+      private
+
+      def filter(key, **opts)
+        Filters::Headers::String.new(key, **opts)
+      end
+
+      def assert_filter(key = 'Test', **opts)
+        fab = create_fable
+        filt = filter(key, **opts)
+        assert filt.call(fab), format('Expected %p to match %p', opts, fab)
+      end
+
+      def refute_filter(key = 'Test', **opts)
+        fab = create_fable
+        filt = filter(key, **opts)
+        refute filt.call(fab), format('Expected %p not to match %p', opts, fab)
+      end
+
+      def create_fable
+        mock_fable(<<-BODY.strip)
+          Test: some text
+
+          body
+        BODY
+      end
+    end
+  end
+end

data/test/codeless_code/filters/test_builders.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -19,13 +21,13 @@ module Filters
   class TestBuilders < UnitTest
     def test_header_integer_filter
       assert_kind_of Class, Filters::Builders.header_integer_filter('FooOne')
-      assert_kind_of Filters::HeaderInteger,
+      assert_kind_of Filters::Headers::Integer,
                      Filters::Builders.header_integer_filter('FooTwo').new
     end
 
     def test_header_string_filter
       assert_kind_of Class, Filters::Builders.header_string_filter('BarOne')
-      assert_kind_of Filters::HeaderString,
+      assert_kind_of Filters::Headers::String,
                      Filters::Builders.header_string_filter('BarTwo').new
     end
   end

data/test/codeless_code/filters/test_composite.rb

@@ -0,0 +1,70 @@
+# 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 Filters
+  class TestComposite < UnitTest
+    def test_enabled?
+      assert_predicate filter(matching_filter), :enabled?
+      assert_predicate filter(matchless_filter), :enabled?
+      assert_predicate filter(filter(matching_filter)), :enabled?
+    end
+
+    def test_not_enabled?
+      refute_predicate filter, :enabled?
+      refute_predicate filter(filter(filter)), :enabled?
+    end
+
+    def test_call_matching
+      assert filter(matching_filter).call(create_fable),
+             'Expected composite filter to match'
+    end
+
+    def test_call_matchless
+      refute filter(matchless_filter).call(create_fable),
+             'Expected composite filter to match'
+    end
+
+    def test_call_empty
+      refute filter.call(create_fable),
+             'Expected an empty composite to match nothing'
+    end
+
+    private
+
+    def filter(*filters)
+      Filters::Composite.new(*filters)
+    end
+
+    def matching_filter
+      Filters::Number.new(exact: 123)
+    end
+
+    def matchless_filter
+      Filters::Date.new(exact: '2018')
+    end
+
+    def create_fable
+      mock_fable(<<-BODY.strip)
+        Number: 123
+
+        body
+      BODY
+    end
+  end
+end