codeless_code 0.1.2

data/README.md

@@ -0,0 +1,172 @@
+# codeless_code
+
+Search and print [The Codeless Code](http://thecodelesscode.com/contents)
+fables.
+
+## Installation
+
+```sh
+gem install codeless_code
+```
+
+## Usage
+
+The main use-case is to filter through the fables available in a given language.
+If multiple results are returned, their numbers and titles will be listed. If
+only one result is found, it will be show to you.
+
+When showing a single fable, it will be shown via your `PAGER`, if set. You may
+force writing do STDOUT, by providing the `-o -` argument.
+
+### Basic Examples
+
+```sh
+codeless_code           # list the fables for the default language (en)
+codeless_code 123       # print the fable numbered as "123"
+codeless_code --daily   # print the daily fable
+codeless_code --random  # print a random fable
+codeless_code -h        # get help
+```
+
+### Choosing a Data Set
+
+There are different translations available, but different people
+
+```sh
+codeless_code --list-translations  # see what languages you can use
+codeless_code -L zh                # list fables translated into Chinese
+codeless_code -L ru -R edro        # list fables translated into Russian by edro
+
+codeless_code -L fr --daily        # Print today's French fable
+```
+
+### Filtering
+
+You can combine many filters together. Only those fables which match every term
+will be returned.
+
+```sh
+# Find fables written on or after 2014, with at least a geekiness rating of 2,
+# and isn't part of a series
+codeless_code -Da 2014 -Gg 2 -nS
+```
+
+### Current Options
+
+```
+Usage: codeless_code [INFO]
+
+       codeless_code [OPTION]... [FILTER]... [NUMBER]
+
+Print or filter Codeless Code fables.
+
+Info
+    -h, --help
+    --list-translations
+    --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
+
+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
+
+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
+
+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
+
+Language Filters
+    -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)
+
+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
+
+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
+
+Name Filters
+    -A, --name
+    -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
+
+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
+```
+
+## 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.
+  * Check out the issue tracker to make sure someone already hasn't requested
+    it and/or contributed it.
+  * Fork the project.
+  * Start a feature/bugfix branch.
+  * Commit and push until you are happy with your contribution.
+  * Make sure to add tests for it. This is important so I don't break it in a
+    future version unintentionally.
+  * Please try not to mess with the Rakefile, version, or history. If you want
+    to have your own version, or is otherwise necessary, that is fine, but
+    please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+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](LICENSE) of the GNU General Public License
+along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+The data this application uses by default, [*The Codeless
+Code*](http://www.thecodelesscode.com/about) by Qi is licensed under a
+[Creative Commons Attribution-NonCommercial 3.0 Unported
+License](https://creativecommons.org/licenses/by-nc/3.0/deed.en_US).

data/Rakefile

@@ -0,0 +1,98 @@
+# encoding: utf-8
+# 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/>.
+$LOAD_PATH.unshift(File.join(__dir__, 'lib'))
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'jeweler'
+require 'pathname'
+require 'pry-byebug'
+require 'rake'
+require 'rake/testtask'
+require 'reek/rake/task'
+require 'yard'
+
+require 'codeless_code'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "codeless_code"
+  gem.homepage = "https://github.com/sangster/codeless_code"
+  gem.license = "GPL-3.0"
+  gem.summary = 'Search and print The Codeless Code fables'
+  gem.description = <<-DESC.gsub(/\s+/m, ' ').strip
+    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.
+  DESC
+  gem.email = "jon@ertt.ca"
+  gem.authors = ["Jon Sangster"]
+  gem.files.include('data/**/*.txt')
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+Reek::Rake::Task.new do |t|
+  t.fail_on_error = true
+  t.verbose = false
+  t.source_files = 'lib/**/*.rb'
+end
+
+YARD::Rake::YardocTask.new
+
+Rake::Task['console'].clear
+desc 'Start Pry with all runtime dependencies loaded'
+task :console do
+  include CodelessCode
+  pry
+end
+
+namespace :readme do
+  readme = Pathname.new(__dir__).join('README.md')
+
+  desc 'Update README with the app\'s options'
+  task :options do
+    help = CodelessCode::Options.new('codeless_code', []).help.gsub(/ +$/, '')
+    readme.write(
+      readme.read.gsub(/(^\s*#+ Current Options).+?(^\s*#)/m,
+                       format("\\1\n\n```\n%s```\n\\2", help))
+    )
+  end
+end
+
+task default: :test

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/bin/codeless_code

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# vim: ft=ruby:
+
+require 'pathname'
+require 'pry-byebug' if ENV.key?('DEBUG')
+
+$LOAD_PATH << Pathname.new(__dir__).join('..', 'lib')
+require 'codeless_code'
+
+CodelessCode::Cli.new(File.basename($0), ARGV).call