codeless_code 0.1.2

data/lib/codeless_code/cli.rb

@@ -0,0 +1,110 @@
+# 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 'date'
+require 'slop'
+
+module CodelessCode
+  class Cli
+    def initialize(command_name = $0, args = ARGV)
+      @command_name = command_name
+      @args = args
+    end
+
+    def call
+      io = io_open
+
+      if options.key?(:help)
+        (io || $stdout).puts options.help
+      elsif options.key?(:version)
+        (io || $stdout).puts version_str
+      elsif options.key?(:list_translations)
+        Commands::ListTranslations.new(io: io).call
+      else
+        filter_fables(io)
+      end
+
+    rescue Slop::Error => e
+      warn format("%s\n\n%s", e, options.help)
+      exit 1
+    ensure
+      io&.close
+    end
+
+    private
+
+    def filter_fables(io)
+      filter = Filters::FromOptions.new(options)
+      fallback = options[:trace] ? nil : Formats::Raw
+
+      Commands::FilterFables.new(filter, output_format, io: io,
+                                 fallback_filter: fallback)
+                            .call(&method(:select))
+    end
+
+    def options
+      @options ||= Options.new(@command_name, @args)
+    end
+
+    def io_open
+      if (path = options[:output])
+        path == '-' ? $stdout.dup : File.open(path, 'w')
+      end
+    end
+
+    def output_format
+      case options[:format]
+      when 'raw' then Formats::Raw
+      else Formats::Term
+      end
+    end
+
+    def select(fables)
+      select_rand(fables)
+    end
+
+    def select_rand(fables)
+      if options[:daily]
+        fables.sample(1, random: Random.new(Date.today.strftime('%Y%m%d').to_i))
+      elsif (count = options[:random_set])
+        if count&.to_i&.to_s != count
+          raise ArgumentError, format('not a number %p', count)
+        end
+        fables.sample(count&.to_i)
+      elsif options[:random]
+        fables.sample(1)
+      else
+        fables
+      end
+    end
+
+    def version_str
+      format("%s %s\n\n%s\n\nSee <%s>", @command_name, VERSION,
+             copyright_summary, 'https://github.com/sangster/codeless_code')
+    end
+
+    def copyright_summary
+      template = [
+        'Copyright (C) %<date>d  Jon Sangster',
+        'License GPL-3.0: GNU General Public License v3.0 <%<url>s>',
+        'This is free software: you are free to change and redistribute it.',
+        'There is NO WARRANTY, to the extent permitted by law.',
+      ].join("\n")
+
+      format(template, date: ::Date.today.year,
+                       url: 'http://gnu.org/licenses/gpl.html')
+    end
+  end
+end

data/lib/codeless_code/commands/filter_fables.rb

@@ -0,0 +1,78 @@
+# 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 Commands
+    class FilterFables
+      # @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
+        @io = io
+        @fallback_filter = fallback_filter
+      end
+
+      def call
+        fables = filtered_fables
+        fables = yield fables if block_given?
+
+        case fables.size
+        when 0
+          warn 'None found.'
+        when 1
+          show(fables.first)
+        else
+          list(fables)
+        end
+      end
+
+      private
+
+      # @return [Enumerable<Fable>]
+      def filtered_fables
+        Catalog.new.select(@filter)
+      end
+
+      def show(fable)
+        if @io.nil? && ENV.key?('PAGER')
+          pager(ENV['PAGER'], fable)
+        else
+          puts render(fable).for_pager(@format, fallback: @fallback_filter)
+        end
+      end
+
+      def pager(cmd, fable)
+        io = open format('|%s', cmd), 'w'
+        pid = io.pid
+
+        io.write render(fable).for_pager(@format, fallback: @fallback_filter)
+        io.close
+      end
+
+      def list(fables)
+        fables.each { |fable| puts render(fable).for_list }
+      end
+
+      def render(fable)
+        Renderers::Fable.new(fable)
+      end
+
+      def puts(str)
+        (@io || $stdout).puts(str)
+      end
+    end
+  end
+end

data/lib/codeless_code/commands/list_translations.rb

@@ -0,0 +1,39 @@
+# 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 Commands
+    class ListTranslations
+      # @param io [IO] if given, the output will be written to this stream,
+      #   otherwise STDOUT will be used
+      def initialize(io: nil)
+        @io = io
+      end
+
+      def call
+        Catalog.new.language_sets.each do |set|
+          translators = set.fable_sets.map(&:translator).sort
+          puts format('%s  %s', set.lang, translators.join(', '))
+        end
+      end
+
+      private
+
+      def puts(str)
+        (@io || $stdout).puts(str)
+      end
+    end
+  end
+end

data/lib/codeless_code/fable.rb

@@ -0,0 +1,139 @@
+# 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 'forwardable'
+require 'date'
+
+module CodelessCode
+  class Fable
+    extend Forwardable
+
+    HEADER_PATTERN = /([^:\s]+)\s*:\s*(.+)\s*$/.freeze
+
+    attr_accessor :file
+    attr_reader :read_headers
+
+    alias_method :read_headers?, :read_headers
+    def_delegators :headers, :[], :fetch, :key?
+
+    def initialize(file)
+      self.file = file
+      @read_headers = false
+      @body_pos = nil
+    end
+
+    def body
+      @body ||= read_body.freeze
+    end
+    alias_method :to_s, :body
+
+    def headers
+      @headers ||= begin
+                     @read_headers = true
+                     read_headers.freeze
+                   end
+    end
+
+    def header?(key)
+      headers.key?(key)
+    end
+
+    def date
+      ::Date.parse(self['Date']) if header?('Date')
+    end
+
+    def lang
+      @lang ||= dir_parts.first.to_sym
+    end
+
+    def translator
+      @translator ||= dir_parts.last
+    end
+
+    def title
+      self['Title']
+    end
+
+    def tagline
+      self['Tagline']
+    end
+
+    def credits
+      self['Credits']
+    end
+
+    def number
+      self['Number'].to_i
+    end
+
+    def geekiness
+      self['Geekiness'].to_i
+    end
+
+    def names
+      list('Names')
+    end
+
+    def topics
+      list('Topics')
+    end
+
+    private
+
+    def read_body
+      headers unless read_headers?
+
+      io = file.open
+      io.seek @body_pos
+      io.read.strip
+    ensure
+      io&.close
+    end
+
+    def read_headers
+      io = file.open
+
+      {}.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)
+      end
+    ensure
+      io&.close
+    end
+
+    def massage_headers(head)
+      if head.key?('Series')
+        head['Series'] = head['Title']
+        head['Title'] = head.delete('Subtitle')
+      end
+    end
+
+    def list(key)
+      fetch(key, '').split(',').map(&:strip)
+    end
+
+    def dir_parts
+      file.parent.basename.to_s.split('-')
+    end
+  end
+end

data/lib/codeless_code/fable_set.rb

@@ -0,0 +1,56 @@
+# 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 'forwardable'
+
+module CodelessCode
+  class FableSet
+    extend Forwardable
+    include Enumerable
+
+    attr_accessor :dir
+    def_delegator :fables, :each
+
+    def initialize(dir)
+      self.dir = dir
+    end
+
+    def lang
+      @lang ||= name_parts.first.to_sym
+    end
+
+    def translator
+      @translator ||= name_parts.last
+    end
+
+    def fables
+      @fables ||= files.map { |f| Fable.new(f) }.sort_by(&:number)
+    end
+
+    def filter(filt)
+      select { |f| filt.call(f) }
+    end
+
+    private
+
+    def files
+      dir.glob('*.txt')
+    end
+
+    def name_parts
+      dir.basename.to_s.split('-')
+    end
+  end
+end

data/lib/codeless_code/filters/builders.rb

@@ -0,0 +1,38 @@
+# 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 Builders
+      module_function
+
+      def header_integer_filter(name)
+        subclass_filter(HeaderInteger, name)
+      end
+
+      def header_string_filter(name)
+        subclass_filter(HeaderString, name)
+      end
+
+      def subclass_filter(klass, name)
+        const_set(name, Class.new(klass) do
+          def initialize(*args)
+            super(self.class.name.split(':').last, *args)
+          end
+        end)
+      end
+    end
+  end
+end

data/lib/codeless_code/filters/composite.rb

@@ -0,0 +1,40 @@
+# 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 'forwardable'
+
+module CodelessCode
+  module Filters
+    class Composite
+      extend Forwardable
+      include Enumerable
+
+      attr_reader :filters
+      def_delegators :filters, :push, :<<, :[], :each
+
+      def initialize(*filters)
+        @filters = filters.flatten
+      end
+
+      def enabled?
+        any?(&:enabled?)
+      end
+
+      def call(fable)
+        select(&:enabled?).all? { |filter| filter.call(fable) }
+      end
+    end
+  end
+end

data/lib/codeless_code/filters/date.rb

@@ -0,0 +1,91 @@
+# 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 'date'
+
+module CodelessCode
+  module Filters
+    class Date
+      def initialize(exact: nil, min: nil, max: nil, exclude: false)
+        @exact = exact
+        @min = min
+        @max = max
+        @exclude = exclude
+      end
+
+      def enabled?
+        @exact || @min || @max || @exclude
+      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
+      end
+
+      class Matcher
+        # param str [String] A date like +2010+, +2010-12+, or +2010-12-23+
+        def self.parse(str)
+          match = :day
+
+          if str.size == 4
+            str = "#{str}-01-01"
+            match = :year
+          elsif str.size == 7
+            str = "#{str}-01"
+            match = :month
+          end
+
+          new(::Date.parse(str), match: match)
+        end
+
+        def initialize(date, match:)
+          @date = date
+          @match = match
+        end
+
+        def ==(other)
+          cmp(@date, other, :==, @match)
+        end
+
+        def >=(other)
+          cmp(@date, other, :>=, @match)
+        end
+
+        def <=(other)
+          cmp(@date, other, :<=, @match)
+        end
+
+        private
+
+        def cmp(a, b, op, match)
+          case match
+          when :year
+            a.year.send(op, b.year)
+          when :month
+            a.year == b.year ? a.month.send(op, b.month) : cmp(a, b, op, :year)
+          else
+            a.send(op, b)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/codeless_code/filters/from_options.rb

@@ -0,0 +1,100 @@
+# 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 'forwardable'
+require 'slop'
+
+module CodelessCode
+  module Filters
+    class FromOptions < Composite
+      extend Forwardable
+
+      def initialize(opts)
+        @opts = opts
+        @filters = nil
+      end
+
+      def lang
+        @opts[:lang]&.to_sym || :en
+      end
+
+      def enabled?
+        @opts.key?(:lang) || non_defaults_enabled?
+      end
+
+      def filters
+        @filters ||= [
+          Filters::Lang.new(exact: lang),
+
+          Filters::Translator.new(exact: @opts[:translator_exact],
+                                  casecmp: @opts[:translator]),
+
+          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)),
+
+          Filters::Geekiness.new(**int_args(:geekiness)),
+          Filters::Number.new(**int_args(:number).tap do |n|
+            n[:exact] ||= @opts.args.last&.to_i
+          end),
+
+          Filters::Date.new(**date_args),
+        ]
+      end
+
+      private
+
+      def non_defaults_enabled?
+        filters.reject { |f| f.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
+          )
+        ].tap do |args|
+          args[:start_with] ||= '' if @opts[:"has_#{name}"]
+        end
+      end
+
+      def int_args(name)
+        Hash[
+          %i[exact min max exclude].zip(
+            @opts.slice(*%I[#{name} #{name}_gte #{name}_lte])
+                 .values
+                 .map { |num| num&.to_i }
+                 .push(@opts[:"no_#{name}"])
+          )
+        ]
+      end
+
+      def date_args
+        {
+          exact: date(@opts[:date]),
+          min: date(@opts[:date_gte]),
+          max: date(@opts[:date_lte]),
+          exclude: @opts[:no_date],
+        }
+      end
+
+      def date(arg)
+        arg && Filters::Date::Matcher.parse(arg)
+      end
+    end
+  end
+end