codeless_code 0.1.7 → 0.1.8

data/lib/codeless_code/fable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -23,27 +25,43 @@ module CodelessCode
 
     HEADER_PATTERN = /([^:\s]+)\s*:\s*(.+)\s*$/.freeze
 
-    attr_reader :file, :read_headers
+    RAW_ATTRS     = %w[Title Tagline Credits].freeze
+    INTEGER_ATTRS = %w[Number Geekiness].freeze
+    LIST_ATTRS    = %w[Names Topics].freeze
+
+    attr_reader :file, :has_read_headers
 
-    alias_method :read_headers?, :read_headers
+    alias read_headers? has_read_headers
     def_delegators :headers, :[], :fetch, :key?
 
     def initialize(file)
       @file = file
-      @read_headers = false
-      @body_pos = nil
+      @has_read_headers = false
+      @body_pos = 0
     end
 
     # @return [String] the actual story, including MediaWiki markup
     def body
       @body ||= read_body.freeze
     end
-    alias_method :to_s, :body
+    alias to_s body
+
+    # Read, or re-read, the body of the fable from the disk
+    # @see #body
+    def read_body
+      headers unless read_headers?
+
+      io = file.open
+      io.seek @body_pos
+      io.read.strip
+    ensure
+      io&.close
+    end
 
     # @return [Hash<String, String>] the story's metadata
     def headers
       @headers ||= begin
-                     @read_headers = true
+                     @has_read_headers = true
                      read_headers.freeze
                    end
     end
@@ -52,11 +70,6 @@ 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
@@ -66,70 +79,46 @@ module CodelessCode
       @translator ||= dir_parts.last
     end
 
-    def title
-      self['Title']
-    end
-
-    def tagline
-      self['Tagline']
+    RAW_ATTRS.each do |attr|
+      define_method(attr.downcase.to_sym) { self[attr] }
     end
 
-    def credits
-      self['Credits']
+    INTEGER_ATTRS.each do |attr|
+      define_method(attr.downcase.to_sym) { self[attr].to_i }
     end
 
-    def number
-      self['Number'].to_i
-    end
-
-    def geekiness
-      self['Geekiness'].to_i
-    end
-
-    def names
-      list('Names')
-    end
-
-    def topics
-      list('Topics')
+    LIST_ATTRS.each do |attr|
+      define_method(attr.downcase.to_sym) { list(attr) }
     end
 
     private
 
-    def read_body
-      headers unless read_headers?
-
+    def read_headers
       io = file.open
-      io.seek @body_pos
-      io.read.strip
+      parse_headers(io)
     ensure
       io&.close
     end
 
-    def read_headers
-      io = file.open
+    # :reek:FeatureEnvy
+    def parse_headers(io, head = {})
+      until io.eof?
+        @body_pos = io.pos
+        match = HEADER_PATTERN.match(io.gets)
+        break if match.nil?
 
-      {}.tap do |head|
-        until io.eof?
-          @body_pos = io.pos
-          if (m = HEADER_PATTERN.match(io.gets))
-            head[m[1].strip] = m[2]&.strip
-          else
-            break
-          end
-        end
-
-        massage_headers(head)
+        head[match[1].strip] = match[2]&.strip
       end
-    ensure
-      io&.close
+      massage_headers(head)
     end
 
+    # :reek:UtilityFunction
     def massage_headers(head)
       if head.key?('Series')
         head['Series'] = head['Title']
         head['Title'] = head.delete('Subtitle')
       end
+      head
     end
 
     def list(key)

data/lib/codeless_code/fable_set.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -22,14 +24,14 @@ module CodelessCode
     extend Forwardable
     include Enumerable
 
-    FILE_PATTERN = '*.txt'.freeze
-    LANG_SEP = '-'.freeze
+    FILE_PATTERN = '*.txt'
+    LANG_SEP = '-'
 
-    attr_accessor :dir
+    attr_reader :dir
     def_delegator :fables, :each
 
     def initialize(dir)
-      self.dir = dir
+      @dir = dir
     end
 
     def lang
@@ -41,11 +43,11 @@ module CodelessCode
     end
 
     def fables
-      @fables ||= files.map { |f| Fable.new(f) }.sort_by(&:number)
+      @fables ||= files.map { |file| Fable.new(file) }.sort_by(&:number)
     end
 
     def filter(filt)
-      select { |f| filt.call(f) }
+      select { |fable| filt.call(fable) }
     end
 
     private

data/lib/codeless_code/filters/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
 #
@@ -20,11 +22,11 @@ module CodelessCode
       module_function
 
       def header_integer_filter(name)
-        subclass_filter(HeaderInteger, name)
+        subclass_filter(Headers::Integer, name)
       end
 
       def header_string_filter(name)
-        subclass_filter(HeaderString, name)
+        subclass_filter(Headers::String, name)
       end
 
       def subclass_filter(klass, name)

data/lib/codeless_code/filters/composite.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -35,7 +37,7 @@ module CodelessCode
       end
 
       def call(fable)
-        select(&:enabled?).all? { |filter| filter.call(fable) }
+        any? && select(&:enabled?).all? { |filter| filter.call(fable) }
       end
     end
   end

data/lib/codeless_code/filters/date.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -17,43 +19,40 @@ require 'date'
 
 module CodelessCode
   module Filters
-    class Date
+    # Matches {Fable fables} that were published on, before, or after a given
+    # date.
+    class Date < Headers::Base
+      # :reek:BooleanParameter
       def initialize(exact: nil, min: nil, max: nil, exclude: false)
-        @exact = exact
-        @min = min
-        @max = max
-        @exclude = exclude
+        super('Date', exclude, [Matcher.parse(exact), :==],
+                               [Matcher.parse(min),   :<=],
+                               [Matcher.parse(max),   :>=])
       end
 
-      def enabled?
-        @exact || @min || @max || @exclude
+      # :reek:UtilityFunction
+      def parse(val)
+        ::Date.parse(val)
       end
 
-      def call(fable)
-        if (val = fable.date)
-          return false unless @exact.nil? || @exact == val
-          return false unless @min.nil? || @min <= val
-          return false unless @max.nil? || @max >= val
-          true
-        else
-          @exclude
-        end
+      def test_single(val, operator, test)
+        test.send(operator, val)
       end
 
+      # Wraps a {::Date} and matches it against "date substrings". ie:
+      # +2010-12+ will matches any dates in December, 2010 and +2010+ will
+      # match any dates in that year.
       class Matcher
         # param str [String] A date like +2010+, +2010-12+, or +2010-12-23+
         def self.parse(str)
-          match = :day
+          return nil unless str
 
           if str.size == 4
-            str = "#{str}-01-01"
-            match = :year
+            new(::Date.parse("#{str}-01-01"), match: :year)
           elsif str.size == 7
-            str = "#{str}-01"
-            match = :month
+            new(::Date.parse("#{str}-01"), match: :month)
+          else
+            new(::Date.parse(str), match: :day)
           end
-
-          new(::Date.parse(str), match: match)
         end
 
         def initialize(date, match:)
@@ -62,27 +61,38 @@ module CodelessCode
         end
 
         def ==(other)
-          cmp(@date, other, :==, @match)
+          compare(@date, other, :==, @match)
         end
 
         def >=(other)
-          cmp(@date, other, :>=, @match)
+          compare(@date, other, :>=, @match)
         end
 
         def <=(other)
-          cmp(@date, other, :<=, @match)
+          compare(@date, other, :<=, @match)
         end
 
         private
 
-        def cmp(a, b, op, match)
+        # :reek:ControlParameter
+        # :reek:FeatureEnvy
+        def compare(first, second, operator, match)
           case match
           when :year
-            a.year.send(op, b.year)
+            first.year.send(operator, second.year)
           when :month
-            a.year == b.year ? a.month.send(op, b.month) : cmp(a, b, op, :year)
+            compare_month(first, second, operator)
+          else
+            first.send(operator, second)
+          end
+        end
+
+        # :reek:FeatureEnvy
+        def compare_month(first, second, operator)
+          if first.year == second.year
+            first.month.send(operator, second.month)
           else
-            a.send(op, b)
+            compare(first, second, operator, :year)
           end
         end
       end

data/lib/codeless_code/filters/from_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # codeless_code filters and prints fables from http://thecodelesscode.com
 # Copyright (C) 2018  Jon Sangster
 #
@@ -37,28 +39,46 @@ module CodelessCode
       end
 
       def filters
-        @filters ||= [
-          Filters::Lang.new(exact: lang),
+        @filters ||=
+          string_filters +
+          integer_filters +
+          [
+            filter(:Date, :date),
+            new_filter(:Lang, exact: lang),
+            number_filter,
+            translator_filter
+          ]
+      end
 
-          Filters::Translator.new(exact: @opts[:translator_exact],
-                                  casecmp: @opts[:translator]),
+      private
 
-          Filters::Credits.new(**str_args(:credits)),
-          Filters::Name.new(**str_args(:name)),
-          Filters::Series.new(**str_args(:series)),
-          Filters::Tagline.new(**str_args(:tagline)),
-          Filters::Title.new(**str_args(:title)),
+      def string_filters
+        %i[Credits Name Tagline Title Series].map { |name| filter(name, :str) }
+      end
 
-          Filters::Geekiness.new(**int_args(:geekiness)),
-          Filters::Number.new(**int_args(:number).tap do |n|
-            n[:exact] ||= @opts.args.last&.to_i
-          end),
+      def integer_filters
+        %i[Geekiness].map { |name| filter(name, :int) }
+      end
 
-          Filters::Date.new(**date_args),
-        ]
+      def number_filter
+        filter(:Number, :int) { |args| args[:exact] ||= @opts.args.last&.to_i }
       end
 
-      private
+      def translator_filter
+        new_filter(:Translator, exact: @opts[:translator_exact],
+                                casecmp: @opts[:translator])
+      end
+
+      def filter(name, type, &blk)
+        new_filter(name,
+                   **send(:"#{type.downcase}_args", name.to_s.downcase.to_s),
+                   &blk)
+      end
+
+      def new_filter(name, **args)
+        yield args if block_given?
+        Filters.const_get(name).new(**args)
+      end
 
       def fallback_lang
         lang = ENV['LANG']&.split(/_|\./)&.first&.downcase&.to_sym
@@ -66,13 +86,14 @@ module CodelessCode
       end
 
       def non_defaults_enabled?
-        filters.reject { |f| f.is_a?(Filters::Lang) }.any?(&:enabled?)
+        filters.reject { |filter| filter.is_a?(Filters::Lang) }.any?(&:enabled?)
       end
 
       def str_args(name)
         Hash[
           %i[exact start_with end_with exclude].zip(
-            @opts.slice(*%I[#{name} #{name}_start #{name}_end no_#{name}]).values
+            @opts.slice(:"#{name}", :"#{name}_start", :"#{name}_end",
+                        :"no_#{name}").values
           )
         ].tap do |args|
           args[:start_with] ||= '' if @opts[:"has_#{name}"]
@@ -82,7 +103,7 @@ module CodelessCode
       def int_args(name)
         Hash[
           %i[exact min max exclude].zip(
-            @opts.slice(*%I[#{name} #{name}_gte #{name}_lte])
+            @opts.slice(:"#{name}", :"#{name}_gte", :"#{name}_lte")
                  .values
                  .map { |num| num&.to_i }
                  .push(@opts[:"no_#{name}"])
@@ -90,18 +111,14 @@ module CodelessCode
         ]
       end
 
-      def date_args
+      def date_args(name)
         {
-          exact: date(@opts[:date]),
-          min: date(@opts[:date_gte]),
-          max: date(@opts[:date_lte]),
-          exclude: @opts[:no_date],
+          exact: @opts[:"#{name}"],
+          min: @opts[:"#{name}_after"],
+          max: @opts[:"#{name}_before"],
+          exclude: @opts[:"no_#{name}"]
         }
       end
-
-      def date(arg)
-        arg && Filters::Date::Matcher.parse(arg)
-      end
     end
   end
 end

data/lib/codeless_code/filters/headers/base.rb

@@ -0,0 +1,61 @@
+# 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 Filters
+    module Headers
+      # Abstract base class for all generic filters that test a {Fable fable's}
+      # headers.
+      class Base
+        def initialize(key, exclude, *tests)
+          @key = key
+          @exclude = exclude
+          @tests ||= tests.select(&:first).freeze
+        end
+
+        def enabled?
+          @tests.any? || @exclude
+        end
+
+        def call(fable)
+          if fable.header?(@key)
+            @tests.any? ? test(parse(fable[@key])) : !@exclude
+          else
+            @exclude
+          end
+        end
+
+        protected
+
+        # :reek:UtilityFunction
+        def parse(val)
+          val
+        end
+
+        def test_single(val, operator, test)
+          val.send(operator, test)
+        end
+
+        private
+
+        def test(val)
+          @tests.any? { |(test, op)| test_single(val, op, test) }
+        end
+      end
+    end
+  end
+end

data/lib/codeless_code/filters/{header_integer.rb → headers/integer.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,27 +17,22 @@
 # this program. If not, see <https://www.gnu.org/licenses/>.
 module CodelessCode
   module Filters
-    class HeaderInteger
-      def initialize(key, exact: nil, min: nil, max: nil, exclude: false)
-        @key = key
-        @exact = exact
-        @min = min
-        @max = max
-        @exclude = exclude
-      end
+    module Headers
+      # Matches {Fable fables} that have an integer header equal to, less than,
+      # or greater than the given parameters.
+      class Integer < Base
+        # :reek:BooleanParameter
+        def initialize(key, exact: nil, min: nil, max: nil, exclude: false)
+          super(key, exclude, [exact, :==],
+                              [min,   :>=],
+                              [max,   :<=])
+        end
 
-      def enabled?
-        @exact || @min || @max || @exclude
-      end
+        protected
 
-      def call(fable)
-        if fable.header?(@key) && (val = fable[@key]&.to_i)
-          return false unless @exact.nil? || val == @exact
-          return false unless @min.nil? || val >= @min.to_i
-          return false unless @max.nil? || val <= @max.to_i
-          !@exclude
-        else
-          @exclude
+        # :reek:UtilityFunction
+        def parse(val)
+          val.to_i
         end
       end
     end

data/lib/codeless_code/filters/{header_string.rb → headers/string.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,28 +17,16 @@
 # this program. If not, see <https://www.gnu.org/licenses/>.
 module CodelessCode
   module Filters
-    class HeaderString
-      def initialize(key, exact: nil, start_with: nil, end_with: nil,
-                          exclude: false)
-        @key = key
-        @exact = exact
-        @start_with = start_with
-        @end_with = end_with
-        @exclude = exclude
-      end
-
-      def enabled?
-        @exact || @start_with || @end_with || @exclude
-      end
-
-      def call(fable)
-        if fable.header?(@key) && (val = fable[@key])
-          return false unless @exact.nil? || val == @exact
-          return false unless @start_with.nil? || val.start_with?(@start_with)
-          return false unless @end_with.nil? || val.end_with?(@end_with)
-          !@exclude
-        else
-          @exclude
+    module Headers
+      # Matches {Fable fables} that have an string header equal to, that starts
+      # with, or ends with the given parameters.
+      class String < Base
+        # :reek:BooleanParameter
+        def initialize(key, exact: nil, start_with: nil, end_with: nil,
+                       exclude: false)
+          super(key, exclude, [exact,      :==],
+                              [start_with, :start_with?],
+                              [end_with,   :end_with?])
         end
       end
     end

data/lib/codeless_code/filters/lang.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/>.
 module CodelessCode
   module Filters
+    # Matches {Fable fables} in the given language (code).
     class Lang
       def initialize(exact: nil)
         @exact = exact

data/lib/codeless_code/filters/translator.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/>.
 module CodelessCode
   module Filters
+    # Matches {Fable fables} translated by the person with the given name.
     class Translator
       def initialize(exact: nil, casecmp: nil)
         @exact = exact
@@ -26,8 +29,10 @@ module CodelessCode
       end
 
       def call(fable)
-        return false unless @exact.nil? || @exact == fable.translator
-        @casecmp.nil? || @casecmp.casecmp?(fable.translator)
+        trans = fable.translator
+        return false unless @exact.nil? || @exact == trans
+
+        @casecmp.nil? || @casecmp.casecmp?(trans)
       end
     end
   end