codeless_code 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9db33a7d878ec62fe6764ac8c19e36c54e79b27bd6a5a27c74c2ddf3ac339105
-  data.tar.gz: 02c2096353f43e96970ab65b9f38de50f0f27cb3c4e018cb4beae317241c29eb
+  metadata.gz: cd5da6b3ee3fd39beace9072dc41a2247da1ed39f27ff050a3cbedc89ff18754
+  data.tar.gz: cdc34c935081bbbcbab8be9165997483adfb0a4bdc8c7b1bc69b5050fb940669
 SHA512:
-  metadata.gz: 11f14612021cd8c058a288094f8da15aebc7468406eae664c2f9a92a79f444b2fda2fd2b9e608b7ba57b38c29ef0a64a6c1c7e418369753874ceeb4489423b9e
-  data.tar.gz: 6c1c83e013f53e93494a92b18a0c2348eeda737d095b4598dd5dde37ca32a2b44b4f04da2e7a8099726801c186f3fbe460564ce93778ed2873fecfac06098e55
+  metadata.gz: c1b00ec239abfdee2b0cc4fb81355e5336ddace39dd71bf924946e4f147c4ba33503c0ab9c603e393a54b2dda09e14e455ec7f39f3920db8365dee99ef469eea
+  data.tar.gz: 3d2e674fe69b5185acbc12e7de1549e56b9c364429751197445cc853744e7c4d3f386e283e0cda31fc31a5d19dd62c506a13357beed869d44dfd3d34c4308b8d

data/Gemfile

@@ -31,6 +31,6 @@ group :development do
   gem 'rake', '~> 12.3'
   gem 'rdoc', '~> 6.0'
   gem 'reek', '~> 5.2'
-  gem 'simplecov', '~> 0.16'
+  gem 'simplecov', '~> 0.16', require: false
   gem 'yard', '~> 0.9'
 end

data/README.md

@@ -52,6 +52,18 @@ will be returned.
 codeless_code -Da 2014 -Gg 2 -nS
 ```
 
+### Listing
+
+If the given filter returns more than one fable, they will be printed as a
+list. By default, only the Number header and title of each fable will be
+printed, one per line. You may use `-e` to specify additional headers to print.
+Note that not every fable will have an entry for every header.
+
+```sh
+codeless_code -e Names,Geekiness
+codeless_code -D 2015-06 -e Date -e Topics
+```
+
 ### Current Options
 
 ```
@@ -67,76 +79,92 @@ Info
     --version
 
 Options
-    -o, --output            write to the given file. "-" for STDOUT
-    -f, --format            one of: raw, term (default)
-    -p, --path              path to directory of fables. see github.com/aldesantis/the-codeless-code
-    --random                select one fable, randomly, from the filtered list
-    --random-set            select n fables, randomly, from the filtered list
-    --daily                 select one fable, randomly, from the filtered listbased on today's date
-    --trace                 print full error message if a fable fails to parse
+    -c, --columns            when listing fables, format the output into columns
+    -e, --headers            headers to include in the list output. may be repeated
+    -f, --format             one of: raw, plain, or term (default)
+    -o, --output             write to the given file. "-" for STDOUT
+    -p, --path               path to directory of fables. see github.com/aldesantis/the-codeless-code
+    --random                 select one fable, randomly, from the filtered list
+    --random-set             select n fables, randomly, from the filtered list
+    --daily                  select one fable, randomly, from the filtered listbased on today's date
+    --trace                  print full error message if a fable fails to parse
+    -s, --sort               when listing fables, sort by the given header
+    -r, --reverse            when listing fables, reverse the order
 
 Series Filters
     -S, --series
-    -Ss, --series-start     series starts with
-    -Se, --series-end       series ends with
-    -hS, --has-series       has series listed
-    -nS, --no-series        no series listed
+    -Ss, --series-start      series starts with
+    -Se, --series-end        series ends with
+    -hS, --has-series        has series listed
+    -nS, --no-series         no series listed
 
 Title Filters
     -T, --title
-    -Ts, --title-start      title starts with
-    -Te, --title-end        title ends with
-    -hT, --has-title        has title listed
-    -nT, --no-title         no title listed
+    -Ts, --title-start       title starts with
+    -Te, --title-end         title ends with
+    -hT, --has-title         has title listed
+    -nT, --no-title          no title listed
 
 Number Filters
-    -N, --number            number (this is the default argument)
-    -Ng, --number-gte       number or greater
-    -Nl, --number-lte       number or lower
-    -hN, --has-number       has number listed
-    -nN, --no-number        no number listed
+    -N, --number             number (this is the default argument)
+    -Ng, --number-gte        number or greater
+    -Nl, --number-lte        number or lower
+    -hN, --has-number        has number listed
+    -nN, --no-number         no number listed
 
 Language Filters
-    -L, --lang              language code (default: en)
+    -L, --lang               language code (default: en)
 
 Translator Filters
-    -r, --translator        translator's name (default: first one, alphabetically)
-    -R, --translator-exact  translator's name, case-sensitive (default: first one, alphabetically)
+    -R, --translator         translator's name (default: first one, alphabetically)
+    -Rx, --translator-exact  translator's name, case-sensitive (default: first one, alphabetically)
 
 Date Filters
-    -D, --date              publish date
-    -Da, --date-after       publish date or after
-    -Db, --date-before      publish date or before
-    -nD, --no-date          no publish date listed
+    -D, --date               publish date
+    -Da, --date-after        publish date or after
+    -Db, --date-before       publish date or before
+    -nD, --no-date           no publish date listed
 
 Geekiness Filters
-    -G, --geekiness         geekiness rating
-    -Gg, --geekiness-gte    geekiness rating or greater
-    -Gl, --geekiness-lte    geekiness rating or lower
-    -nG, --no-geekiness     no geekiness rating
+    -G, --geekiness          geekiness rating
+    -Gg, --geekiness-gte     geekiness rating or greater
+    -Gl, --geekiness-lte     geekiness rating or lower
+    -nG, --no-geekiness      no geekiness rating
 
 Name Filters
     -A, --name
-    -As, --name-start       name starts with
-    -Ae, --name-end         name ends with
-    -nA, --no-name          no name listed
+    -As, --name-start        name starts with
+    -Ae, --name-end          name ends with
+    -nA, --no-name           no name listed
 
 Credits Filters
     -C, --credits
-    -Cs, --credits-start    credits starts with
-    -Ce, --credits-end      credits ends with
-    -hC, --has-credits      has credits listed
-    -nC, --no-credits       no credits listed
+    -Cs, --credits-start     credits starts with
+    -Ce, --credits-end       credits ends with
+    -hC, --has-credits       has credits listed
+    -nC, --no-credits        no credits listed
 
 Tagline Filters
     -I, --tagline
-    -Is, --tagline-start    tagline starts with
-    -Ie, --tagline-end      tagline ends with
-    -hI, --has-tagline      has tagline listed
-    -nI, --no-tagline       no tagline listed
+    -Is, --tagline-start     tagline starts with
+    -Ie, --tagline-end       tagline ends with
+    -hI, --has-tagline       has tagline listed
+    -nI, --no-tagline        no tagline listed
+```
+
+## Development
+
+### Testing
+
+```sh
+bundle exec rake test
+COVERAGE=surewhynot bundle exec rake test
+
+bundle exec guard
+COVERAGE=1 bundle exec guard
 ```
 
-## Contributing to codeless_code
+### Contributing to codeless_code
 
   * Check out the latest master to make sure the feature hasn't been
     implemented or the bug hasn't been fixed yet.

data/Rakefile

@@ -60,6 +60,7 @@ Rake::TestTask.new(:test) do |test|
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
+Rake::Task[:build].prerequisites << :test
 
 desc "Code coverage detail"
 task :simplecov do

data/VERSION

@@ -1 +1 @@
-0.1.5
+0.1.6

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.5 ruby lib
+# stub: codeless_code 0.1.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "codeless_code".freeze
-  s.version = "0.1.5"
+  s.version = "0.1.6"
 
   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-04"
+  s.date = "2018-11-05"
   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]
@@ -1500,10 +1500,12 @@ Gem::Specification.new do |s|
     "lib/codeless_code/language_set.rb",
     "lib/codeless_code/options.rb",
     "lib/codeless_code/renderers/fable.rb",
-    "lib/codeless_code/renderers/page.rb",
+    "lib/codeless_code/renderers/term_page.rb",
+    "test/codeless_code/test_catalog.rb",
     "test/codeless_code/test_fable.rb",
     "test/codeless_code/test_fable_set.rb",
     "test/codeless_code/test_language_set.rb",
+    "test/codeless_code/test_options.rb",
     "test/helper.rb",
     "test/test_codeless_code.rb"
   ]

data/lib/codeless_code/catalog.rb

@@ -14,14 +14,17 @@
 # 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
+  # The entire collection of fables available to the application from a given
+  # data directory.
   class Catalog
-    # extend Forwardable
     include Enumerable
 
+    # @param root_dir [Pathname] A directory that contains {Fable} files
     def initialize(root_dir)
       @root_dir = root_dir
     end
 
+    # @return [Enumerable<Symbol>] the codes of all available languages
     def languages
       @languages ||= @root_dir.glob('*-*')
                               .select(&:directory?)
@@ -31,10 +34,11 @@ module CodelessCode
                               .sort
     end
 
+    # @param lang [Symbol]
     # @return [LanguageSet]
     def fetch(lang)
       if languages.include?(lang)
-        LanguageSet.new(lang)
+        LanguageSet.new(lang, root_dir: @root_dir)
       else
         raise LanguageSet::NotFoundError,
               format("No fables for language %p", lang)

data/lib/codeless_code/cli.rb

@@ -24,36 +24,28 @@ module CodelessCode
     end
 
     def call
-      io = io_open
+      user_io = io_open
 
       if options.key?(:help)
-        (io || $stdout).puts options.help
+        (user_io || $stdout).puts options.help
       elsif options.key?(:version)
-        (io || $stdout).puts version_str
+        (user_io || $stdout).puts version_str
       elsif options.key?(:list_translations)
-        Commands::ListTranslations.new(catalog, io: io).call
+        Commands::ListTranslations.new(catalog, io: user_io).call
       else
-        filter_fables(io)
+        Commands::FilterFables.new(catalog, options, io: user_io)
+                              .call(&method(:select))
       end
 
     rescue Slop::Error => e
       warn format("%s\n\n%s", e, options.help)
       exit 1
     ensure
-      io&.close
+      user_io&.close
     end
 
     private
 
-    def filter_fables(io)
-      filter = Filters::FromOptions.new(options)
-      fallback = options[:trace] ? nil : Formats::Raw
-
-      cmd = Commands::FilterFables.new(filter, output_format, io: io,
-                                       fallback_filter: fallback)
-      cmd.call(catalog, &method(:select))
-    end
-
     def options
       @options ||= Options.new(@command_name, @args)
     end
@@ -62,24 +54,19 @@ module CodelessCode
       @catalog ||= Catalog.new(options.data_dir)
     end
 
+    # @return [IO,nil] the user's chosen output stream. +nil+ if unspecified
     def io_open
       if (path = options[:output])
         path == '-' ? $stdout.dup : File.open(path, 'w')
       end
     end
 
-    def output_format
-      case options[:format]
-      when 'plain' then Formats::Plain
-      when 'raw'   then Formats::Raw
-      else              Formats::Term
-      end
-    end
-
     def select(fables)
       select_rand(fables)
     end
 
+    # @return [Enumerable<Fable>] a random subset of the given collection, as
+    #   specified by {#options}
     def select_rand(fables)
       if options[:daily]
         fables.sample(1, random: Random.new(Date.today.strftime('%Y%m%d').to_i))

data/lib/codeless_code/commands/filter_fables.rb

@@ -15,19 +15,25 @@
 # this program. If not, see <https://www.gnu.org/licenses/>.
 module CodelessCode
   module Commands
+    # Filters down a {Catalog} of {Fable Fables} with criteria specified via
+    # the CLI. The results will be listed line-by-line, unless only one fable
+    # is found. In that case, it will be printed out.
     class FilterFables
+      attr_reader :options
+
       # @param io [IO] if given, the output will be written to this stream,
       #   otherwise we will attempt to invoke the user's PAGER app
-      def initialize(filter, format, io: nil, fallback_filter: Formats::Raw)
-        @filter = filter
-        @format = format
+      def initialize(catalog, options, io: nil)
+        @catalog = catalog
+        @options = options
         @io = io
-        @fallback_filter = fallback_filter
       end
 
-      def call(catalog)
-        fables = catalog.select(@filter)
+      def call
+        filter = Filters::FromOptions.new(options)
+        fables = @catalog.select(filter)
         fables = yield fables if block_given?
+        fables = sort(fables)
 
         case fables.size
         when 0
@@ -41,11 +47,19 @@ module CodelessCode
 
       private
 
+      def sort(fables)
+        if options.key?(:sort)
+          fables = fables.sort_by { |f| f[options[:sort]] || "\uffff" }
+        end
+        fables = fables.reverse if options[:reverse]
+        fables
+      end
+
       def show(fable)
         if @io.nil? && ENV.key?('PAGER')
           pager(ENV['PAGER'], fable)
         else
-          puts render(fable).for_pager(@format, fallback: @fallback_filter)
+          puts for_pager(fable)
         end
       end
 
@@ -53,12 +67,41 @@ module CodelessCode
         io = open format('|%s', cmd), 'w'
         pid = io.pid
 
-        io.write render(fable).for_pager(@format, fallback: @fallback_filter)
-        io.close
+        io.puts for_pager(fable)
+      ensure
+        io&.close
+      end
+
+      def for_pager(fable)
+        render(fable).for_pager(output_format, fallback: fallback_filter)
+      end
+
+      def output_format
+        case options[:format]
+        when 'plain' then Formats::Plain
+        when 'raw'   then Formats::Raw
+        else              Formats::Term
+        end
+      end
+
+      def fallback_filter
+        options[:trace] ? nil : Formats::Raw
       end
 
       def list(fables)
-        fables.each { |fable| puts render(fable).for_list }
+        width = title_width(fables)
+
+        fables.each do |fable|
+          puts render(fable).for_list(options[:headers], title_width: width)
+        end
+      end
+
+      def title_width(fables)
+        if options[:columns]
+          -fables.map { |f| render(f).best_title.size }.compact.max
+        else
+          ''
+        end
       end
 
       def render(fable)

data/lib/codeless_code/fable.rb

@@ -17,28 +17,30 @@ require 'forwardable'
 require 'date'
 
 module CodelessCode
+  # Model/Adapter for a "Codeless Code" fable stored in a text file.
   class Fable
     extend Forwardable
 
     HEADER_PATTERN = /([^:\s]+)\s*:\s*(.+)\s*$/.freeze
 
-    attr_accessor :file
-    attr_reader :read_headers
+    attr_reader :file, :read_headers
 
     alias_method :read_headers?, :read_headers
     def_delegators :headers, :[], :fetch, :key?
 
     def initialize(file)
-      self.file = file
+      @file = file
       @read_headers = false
       @body_pos = nil
     end
 
+    # @return [String] the actual story, including MediaWiki markup
     def body
       @body ||= read_body.freeze
     end
     alias_method :to_s, :body
 
+    # @return [Hash<String, String>] the story's metadata
     def headers
       @headers ||= begin
                      @read_headers = true
@@ -50,10 +52,12 @@ module CodelessCode
       headers.key?(key)
     end
 
+    # @return [::Date, nil]
     def date
       ::Date.parse(self['Date']) if header?('Date')
     end
 
+    # @return [Symbol]
     def lang
       @lang ||= dir_parts.first.to_sym
     end

data/lib/codeless_code/fable_set.rb

@@ -16,10 +16,15 @@
 require 'forwardable'
 
 module CodelessCode
+  # An {Enumerable collection} of {Fable fables} in a given language, all
+  # translated by the same person.
   class FableSet
     extend Forwardable
     include Enumerable
 
+    FILE_PATTERN = '*.txt'.freeze
+    LANG_SEP = '-'.freeze
+
     attr_accessor :dir
     def_delegator :fables, :each
 
@@ -46,11 +51,11 @@ module CodelessCode
     private
 
     def files
-      dir.glob('*.txt')
+      dir.glob(FILE_PATTERN)
     end
 
     def name_parts
-      dir.basename.to_s.split('-')
+      dir.basename.to_s.split(LANG_SEP)
     end
   end
 end

data/lib/codeless_code/filters/builders.rb

@@ -15,6 +15,7 @@
 # this program. If not, see <https://www.gnu.org/licenses/>.
 module CodelessCode
   module Filters
+    # Module functions to generate filter subclasses.
     module Builders
       module_function
 

data/lib/codeless_code/filters/composite.rb

@@ -17,6 +17,8 @@ require 'forwardable'
 
 module CodelessCode
   module Filters
+    # A filter that containers a collection of other filters. It will only
+    # match a {Fable} if it's matched by each contained filter.
     class Composite
       extend Forwardable
       include Enumerable

data/lib/codeless_code/filters/from_options.rb

@@ -18,9 +18,11 @@ require 'slop'
 
 module CodelessCode
   module Filters
+    # A {Composite} filter build from the arguments supplied via the CLI.
     class FromOptions < Composite
       extend Forwardable
 
+      # @param opts [Options]
       def initialize(opts)
         @opts = opts
         @filters = nil

data/lib/codeless_code/formats/plain.rb

@@ -17,6 +17,7 @@ require 'mediacloth'
 
 module CodelessCode
   module Formats
+    # Prints the {Fable} without any formatting, but removes the markup.
     class Plain < Base
       def call
         raw.split("\n\n")

data/lib/codeless_code/formats/raw.rb

@@ -15,6 +15,7 @@
 # this program. If not, see <https://www.gnu.org/licenses/>.
 module CodelessCode
   module Formats
+    # Prints the body of the {Fable} verbatim
     class Raw < Base
       def call
         raw

data/lib/codeless_code/formats/term.rb

@@ -19,11 +19,11 @@ require 'nokogiri'
 
 module CodelessCode
   module Formats
+    # Renders the {Fable} using ANSI control characters for bold, italics,
+    # colors, etc.
     class Term < Base
       def call
-        raw.split("\n\n")
-           .map { |str| from_wiki(to_xhtml(regex(str))) }
-           .join("\n\n")
+        from_wiki(to_xhtml(regex(raw)))
       end
 
       def regex(str)

data/lib/codeless_code/language_set.rb

@@ -16,12 +16,16 @@
 require 'forwardable'
 
 module CodelessCode
+  # An {Enumerable collection} of {FableSet fable sets} in a given language, but
+  # possibly translated by the different people.
   class LanguageSet
     extend Forwardable
     include Enumerable
 
     NotFoundError = Class.new(StandardError)
 
+    LANG_PATTERN = '%s-*'.freeze
+
     attr_accessor :lang, :root_dir
     def_delegator :fable_sets, :each
 
@@ -34,8 +38,10 @@ module CodelessCode
       dirs.map { |dir| FableSet.new(dir) }
     end
 
+    private
+
     def dirs
-      root_dir.glob(format('%s-*', lang)).select(&:directory?)
+      root_dir.glob(format(LANG_PATTERN, lang)).select(&:directory?)
     end
   end
 end

data/lib/codeless_code/options.rb

@@ -17,10 +17,14 @@ require 'forwardable'
 require 'slop'
 
 module CodelessCode
+  # Adapter class for ARGV which exposes the command-line arguments as data
+  # types.
   class Options
     extend Forwardable
     include Enumerable
 
+    MAX_ARGS = 1 # --number flag may be passed as argument +cmd 3+ vs +cmd -N 3+
+
     def_delegators :opts, :to_hash, :[]
     def_delegators :to_hash, :each, :slice
 
@@ -29,34 +33,40 @@ module CodelessCode
       @argv = argv
     end
 
-    def opts(suppress: false)
-      @opts ||=
-        begin
-          args = [@command_name] + @argv
-          opts = CodelessCode::OPTIONS.curry[@command_name]
-
-          Slop.parse(args, suppress_errors: suppress, &opts).tap do |opt|
-            if !suppress && opt.arguments.size > 2
-              raise format('too many arguments: %p', opt.arguments[1..-1])
-            end
-          end
-        end
+    def opts
+      @opts ||= parse_opts(suppress_errors: false)
+    end
+
+    def args
+      opts.arguments[1..-1]
     end
 
     def key?(key)
       !!self[key]
     end
 
+    # @return [Pathname] Where on the file system to search for fables. Will
+    #   default to {CodelessCode.DEFAULT_DATA} if unspecified
     def data_dir
       @data_dir ||= self[:path] ? Pathname.new(self[:path]) : DEFAULT_DATA
     end
 
+    # @return [String] a description of the supported command-line options
     def help
-      opts(suppress: true).to_s
+      parse_opts(suppress_errors: true).to_s
     end
 
-    def args
-      opts.arguments[1..-1]
+    private
+
+    def parse_opts(suppress_errors:)
+      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])
+        end
+      end
     end
   end
 end

data/lib/codeless_code/renderers/fable.rb

@@ -15,11 +15,12 @@
 # this program. If not, see <https://www.gnu.org/licenses/>.
 module CodelessCode
   module Renderers
+    # Prints a {Fable} is various ways.
     class Fable < SimpleDelegator
       HEADER_SORT = %w[Tagline Number Date].freeze
 
       def for_pager(format, fallback: nil)
-        Page.new.tap do |page|
+        TermPage.new.tap do |page|
           page.title = best_title
           page.body = render_with(format, fallback: fallback)
 
@@ -27,12 +28,23 @@ module CodelessCode
         end
       end
 
-      def for_list
-        format('%s  %s', wide_number, best_title)
+      def for_list(head_keys = [], title_width: '')
+        format("%s  %#{title_width}s    %s",
+               wide_number, best_title, render_slice(head_keys)).strip
+      end
+
+      def best_title
+        return title_with_subtitle if title&.size&.positive?
+
+        self['Name'] || self['Tagline'] || inspect
       end
 
       private
 
+      def render_slice(keys)
+        headers.slice(*keys).map {|k, v| format('%s: %p', k, v) }.join(', ')
+      end
+
       def render_with(format, fallback:)
         format.new(body).call
       rescue => e
@@ -41,12 +53,6 @@ module CodelessCode
         fallback.new(body).call
       end
 
-      def best_title
-        return title_with_subtitle if title&.size&.positive?
-
-        self['Name'] || self['Tagline'] || inspect
-      end
-
       def title_with_subtitle
         [self['Series'], title, self['Subtitle']].compact.join(': ')
       end

data/lib/codeless_code/renderers/{page.rb → term_page.rb}

@@ -17,7 +17,9 @@ require 'colorized_string'
 
 module CodelessCode
   module Renderers
-    class Page
+    # Attempts to format the output for the +PAGER+ such that it fits within
+    # the bounds of the terminal window.
+    class TermPage
       PAGER_FORMAT = [
         '%<title>s', '%<sep1>s', '%<headers>s', '%<sep2>s', '', '%<body>s'
       ].join("\n").freeze

data/lib/codeless_code.rb

@@ -39,8 +39,8 @@ module CodelessCode
   end
 
   module Renderers
-    autoload  :Fable,  'codeless_code/renderers/fable'
-    autoload  :Page,   'codeless_code/renderers/page'
+    autoload  :Fable,     'codeless_code/renderers/fable'
+    autoload  :TermPage,  'codeless_code/renderers/term_page'
   end
 
   VERSION = Pathname.new(__dir__).join('..', 'VERSION').read.strip.freeze
@@ -68,8 +68,12 @@ module CodelessCode
 
     o.separator ''
     o.separator 'Options'
-    o.string '-o', '--output', 'write to the given file. "-" for STDOUT'
+    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'
@@ -78,6 +82,9 @@ module CodelessCode
                          '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'
@@ -108,9 +115,9 @@ module CodelessCode
 
     o.separator ''
     o.separator 'Translator Filters'
-    o.string '-r', '--translator', 'translator\'s name (default: first ' \
+    o.string '-R', '--translator', 'translator\'s name (default: first ' \
       'one, alphabetically)'
-    o.string '-R', '--translator-exact', 'translator\'s name, ' \
+    o.string '-Rx', '--translator-exact', 'translator\'s name, ' \
       'case-sensitive (default: first one, alphabetically)'
 
     o.separator ''

data/test/codeless_code/test_catalog.rb

@@ -0,0 +1,68 @@
+# 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'
+
+class TestCatalog < UnitTest
+  def test_languages
+    assert_kind_of Enumerable, catalog.languages
+
+    catalog.languages.each do |lang|
+      assert_kind_of Symbol, lang
+    end
+  end
+
+  def test_fetch
+    assert_kind_of LanguageSet, catalog.fetch(:en)
+    assert_equal :en, catalog.fetch(:en).lang
+  end
+
+  def test_fetch_not_found
+    assert_raises(LanguageSet::NotFoundError) { catalog.fetch(:unknown) }
+  end
+
+  def test_language_sets
+    assert_kind_of Enumerable, catalog.language_sets
+    catalog.language_sets.each { |set| assert_kind_of LanguageSet, set }
+  end
+
+  def test_fable_sets
+    assert_kind_of Enumerable, catalog.fable_sets
+    catalog.fable_sets.each { |set| assert_kind_of FableSet, set }
+  end
+
+  def test_fables
+    assert_kind_of Enumerable, catalog.fables
+    catalog.fables.each { |fable| assert_kind_of Fable, fable }
+  end
+
+  def test_select
+    all_filter = ->(fable) { true }
+    none_filter = ->(fable) { false }
+
+    assert_kind_of Enumerable, catalog.select(all_filter)
+    catalog.select(all_filter).each { |fable| assert_kind_of Fable, fable }
+
+    assert_equal catalog.fables.size, catalog.select(all_filter).size
+    assert_equal 0, catalog.select(none_filter).size
+  end
+
+  private
+
+  def catalog(dir = DEFAULT_DATA)
+    (@catalog ||= {})[dir] ||= Catalog.new(dir)
+  end
+end
+

data/test/codeless_code/test_fable.rb

@@ -56,8 +56,8 @@ class TestFable < UnitTest
     assert_kind_of Enumerable, fable.names
   end
 
-  def test_names
-    assert_kind_of Enumerable, fable.names
+  def test_topics
+    assert_kind_of Enumerable, fable.topics
   end
 
   private

data/test/codeless_code/test_fable_set.rb

@@ -17,21 +17,34 @@ require 'helper'
 
 class TestFableSet < UnitTest
   def test_lang
+    assert_kind_of Symbol, set.lang
+
     assert_equal :en, set('en-*').lang
     assert_equal :zh, set('zh-*').lang
   end
 
   def test_translator
+    assert_kind_of String, set.translator
+
     assert_equal 'qi',     set('*-qi').translator
     assert_equal 'hanzik', set('*-hanzik').translator
   end
 
-  def test_files
-    assert_kind_of Enumerable, set.files
+  def test_fables
+    assert_kind_of Enumerable, set.fables
+
+    set.fables.each { |fable| assert_kind_of Fable, fable }
+  end
+
+  def test_filter
+    all_filter = ->(fable) { true }
+    none_filter = ->(fable) { false }
+
+    assert_kind_of Enumerable, set.filter(all_filter)
+    set.filter(all_filter).each { |fable| assert_kind_of Fable, fable }
 
-    set.files.each do |entry|
-      flunk format('%p is not a file', entry) unless entry.file?
-    end
+    assert_equal set.fables.size, set.filter(all_filter).size
+    assert_equal 0, set.filter(none_filter).size
   end
 
   private

data/test/codeless_code/test_language_set.rb

@@ -16,14 +16,6 @@
 require 'helper'
 
 class TestLanguageSet < UnitTest
-  def test_class_available_languages
-    assert_kind_of Enumerable, LanguageSet.available_languages
-
-    LanguageSet.available_languages.each do |lang|
-      assert_kind_of Symbol, lang
-    end
-  end
-
   def test_lang
     assert_equal :en, set(:en).lang
     assert_equal :zh, set(:zh).lang
@@ -32,23 +24,14 @@ class TestLanguageSet < UnitTest
   def test_fable_sets
     assert_kind_of Enumerable, set.fable_sets
     refute_empty set.fable_sets
-    assert_equal set.fable_sets.size, set.dirs.size
 
     set.fable_sets.each { |set| assert_kind_of FableSet, set }
   end
 
-  def test_dirs
-    assert_kind_of Enumerable, set.dirs
-
-    set.dirs.each do |entry|
-      flunk format('%p is not a directory', entry) unless entry.directory?
-    end
-  end
-
   private
 
   def set(lang = :en)
-    (@set ||= {})[lang] ||= LanguageSet.new(lang)
+    (@set ||= {})[lang] ||= LanguageSet.new(lang, root_dir: DEFAULT_DATA)
   end
 end
 

data/test/codeless_code/test_options.rb

@@ -0,0 +1,65 @@
+# 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'
+
+class TestOptions < UnitTest
+  def test_opts
+    assert_kind_of Slop::Result, options.opts
+  end
+
+  def test_opts_does_not_accept_bad_options
+    assert_raises { options('--unknown-argument').opts }
+  end
+
+  def test_args
+    assert_empty options.args
+    assert_empty options('--daily').args
+    assert_equal ['123'], options('-D', '2015', '123').args
+  end
+
+  def test_args_too_many
+    assert_raises { options('first', 'second').opts }
+  end
+
+  def test_help
+    assert_kind_of String, options.help
+  end
+
+  def test_help_accepts_bad_options
+    options('--unknown-argument').help
+    pass 'did not raise'
+  end
+
+  def test_key?
+    assert options('--help').key?(:help), '--help should supply :help key'
+    assert options('-h').key?(:help),     '-h should supply :help key'
+  end
+
+  def test_data
+    assert_equal Pathname.new('/foo'), options('-p', '/foo').data_dir
+  end
+
+  def test_data_dir_default
+    assert_equal DEFAULT_DATA, options.data_dir
+  end
+
+  private
+
+  def options(*args)
+    (@options ||= {})[args] ||= Options.new('codeless_code', args)
+  end
+end
+

data/test/helper.rb

@@ -23,12 +23,13 @@ end
 
 SimpleCov.configure do
   clean_filters
-  load_adapter 'test_frameworks'
+  load_profile 'test_frameworks'
 end
 
 ENV['COVERAGE'] && SimpleCov.start do
-  add_filter '/.rvm/'
+  add_filter %r{/\..*/}
 end
+
 require 'rubygems'
 require 'bundler'
 begin
@@ -45,7 +46,6 @@ require 'minitest/autorun'
 
 Minitest::Reporters.use!(Minitest::Reporters::SpecReporter.new)
 
-$LOAD_PATH.unshift(__dir__)
 $LOAD_PATH.unshift(File.join(__dir__, '..', 'lib'))
 require 'pry-byebug'
 require 'codeless_code'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeless_code
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Jon Sangster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-04 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -1726,10 +1726,12 @@ files:
 - lib/codeless_code/language_set.rb
 - lib/codeless_code/options.rb
 - lib/codeless_code/renderers/fable.rb
-- lib/codeless_code/renderers/page.rb
+- lib/codeless_code/renderers/term_page.rb
+- test/codeless_code/test_catalog.rb
 - test/codeless_code/test_fable.rb
 - test/codeless_code/test_fable_set.rb
 - test/codeless_code/test_language_set.rb
+- test/codeless_code/test_options.rb
 - test/helper.rb
 - test/test_codeless_code.rb
 homepage: https://github.com/sangster/codeless_code