tcelfer 1.0.1

data/README.md

@@ -0,0 +1,58 @@
+# Tcelfer
+
+### [t]cel-fer:
+  - A fun way to keep track of simple summaries of your months.
+
+## Requirements
+* Ruby 2.5.0+ (Tested with 2.6.0 mostly)
+* Sqlite3
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tcelfer', '~> 1.0'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+Or install it yourself as:
+```bash
+$ gem install tcelfer
+```
+
+## Setup
+```bash
+# Configure with one of the following:
+# Just change the db location
+export TCELFER_SQLITE_PATH=path/to/some_file.db
+# Or copy `config/tcelfer.example.yml` and use:
+export TCELFER_CONF=~/.config/tcelfer/my_conf.yml
+# Initialize the database
+$ bin/db_init
+```
+
+## Usage
+
+```bash
+# TODO: Find a better way to do this
+# export TCELFER_SQLITE_PATH TCELFER_CONF from above
+# Record your day
+$ tcelfer day [-d 2018-12-31]
+
+# Reflect on your month
+$ tcelfer report [-y|--year=)YEAR] -m|--month=MON [--legend]
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, and push git commits and tags
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/agargiulo/tcelfer.

data/Rakefile

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2018  Anthony Gargiulo <anthony@agargiulo.com>
+#
+# 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 <http://www.gnu.org/licenses/>.
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]
+
+task :clean do
+  FileUtils.rm_rf(Dir['tmp/*'], verbose: true)
+end

data/exe/tcelfer

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Copyright (C) 2018  Anthony Gargiulo <anthony@agargiulo.com>
+#
+# 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 <http://www.gnu.org/licenses/>.
+require 'tcelfer/cli'
+
+Tcelfer::CLI::Base.start

data/lib/tcelfer.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2018  Anthony Gargiulo <anthony@agargiulo.com>
+#
+# 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 <http://www.gnu.org/licenses/>.
+require 'tcelfer/config'
+require 'tcelfer/errors'
+require 'tcelfer/storage'
+require 'tcelfer/version'
+
+# Main man Tcelfer himself
+module Tcelfer
+  # Found these on Reddit
+  DAY_RATINGS = [
+    'Amazing, Fantastic Day',
+    'Really Good, Happy Day',
+    'Normal, Average Day',
+    'Exhausted, Tired Day',
+    'Stressed-Out, Frantic Day',
+    'Frustrated, Angry Day',
+    'Depressed, Sad Day'
+  ].freeze
+
+  # Separate because reasons that used to make sense and fixing is not worth at the moment
+  RATING_TO_COLOR_MAP = DAY_RATINGS.zip(
+    # ordering taking from a mix of examples on reddit
+    # and my own preferences.
+    # '#4B0082' is indigo and :green != 'green' :(
+    ['maroon', :green, 'peru', '#4B0082', :red, 'orange', :blue]
+    # based on ColorPicker generic RGB on macOS if you want those
+    # %w[#ca4674 #6ba089 #cca04d #4b0082 #bd2d26 #fb9f09 #5a86ac]
+  ).to_h.freeze
+
+  def self.config
+    @config ||= Config.new
+    @config.validate!
+  end
+end

data/lib/tcelfer/cli.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2018  Anthony Gargiulo <anthony@agargiulo.com>
+#
+# 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 <http://www.gnu.org/licenses/>.
+require 'date'
+require 'paint'
+require 'thor'
+require 'tty-prompt'
+
+require 'tcelfer'
+require 'tcelfer/cli/report'
+
+module Tcelfer
+  module CLI
+    # Thor CLI for Tcelfer
+    class Base < Thor
+      def initialize(*_args)
+        # Quit on Ctrl-C please
+        @prompt = TTY::Prompt.new(interrupt: :exit)
+
+        super
+      end
+
+      # Useful return codes are nice, of course
+      def self.exit_on_failure?
+        true
+      end
+
+      # Set up debug things I guess? This could be messy
+      class_option(:verbose, aliases: %w[-v], type: :boolean, default: false)
+
+      desc 'version', 'Prints the current version'
+      def version
+        puts Tcelfer::VERSION
+      end
+
+      method_option(:date, aliases: %w[-d], desc: 'Any format valid for ruby Date e.g. 2019-10-31', required: false)
+      desc 'day', 'record info for a day'
+      def day
+        Tcelfer.config.debug = options[:debug]
+        store  = Tcelfer::Storage.new
+        tc_day = rec_day! store
+        @prompt.say("Recorded [#{tc_day.date}]: #{Paint[tc_day.rating, :bold]}")
+      rescue Tcelfer::Error => err
+        @prompt.error("[#{err.class}]", err)
+      end
+
+      method_option(:month, aliases: %w[-m], type: :numeric)
+      method_option(:legend, aliases: %w[-k -l], type: :boolean, default: false)
+      method_option(:year, aliases: %w[-y], type: :numeric, default: Date.today.year)
+      desc 'report', 'generate a report'
+      def report
+        Tcelfer.config.debug = options[:debug]
+        rep = Report.new
+        @prompt.say(gen_report(rep, options['month'], options['year'], options['legend']))
+      rescue Tcelfer::Error => err
+        @prompt.error("[#{err.class}]", err)
+      end
+
+      private
+
+      # Heavy lifting for `tcelfer day ...`
+      # returns an instance of the Day model representing the users choices.
+      # @return [Tcelfer::Models::Day]
+      def rec_day!(store)
+        user_date            = options.key?('date') ? Date.parse(options['date']) : Date.today
+
+        rate_prompt_settings = { required: true, filter: true, per_page: DAY_RATINGS.length }
+        rating               = @prompt.select('How was your day?', DAY_RATINGS, **rate_prompt_settings)
+        notes                = @prompt.ask('Any additional notes?')
+        store.rec_day(rating, notes, user_date)
+      end
+
+      # Heavy lifting for `tcelfer report ...`
+      # Returns a string report to print to the console
+      # @param [Tcelfer::CLI::Report] rep Report object
+      # @param [Integer] month
+      # @param [Integer] year
+      # @param [Boolean] legend do we want to include the legend in the report?
+      # @return [String]
+      def gen_report(rep, month, year, legend)
+        if month && legend
+          rep.month_with_legend(month, year)
+        elsif month
+          rep.generate_month_report(month, year)
+        elsif legend
+          Report.legend
+        else
+          raise Tcelfer::ReportError, 'Please provide either -m, -k/-l, or both'
+        end
+      end
+    end
+  end
+end

data/lib/tcelfer/cli/report.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2018  Anthony Gargiulo <anthony@agargiulo.com>
+#
+# 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 <http://www.gnu.org/licenses/>.
+require 'terminal-table'
+
+require 'tcelfer'
+
+module Tcelfer
+  module CLI
+    # Generate reports with day/week/month/year granularity.
+    class Report
+      def initialize
+        @store = Tcelfer::Storage.new
+      end
+
+      # Takes a month and year and returns a pretty formatted Terminal::Table
+      # with days colored according to Tcelfer::RATING_TO_COLOR_MAP
+      # @param [Integer] month
+      # @param [Integer] year
+      # @return [Terminal::Table]
+      def generate_month_report(month, year)
+        mon_by_wday = @store.by_month(month, year).group_by { |day| day.date.wday }
+        if mon_by_wday.length < 7
+          raise ReportError, "Unable to process #{Date::MONTHNAMES[month]}, please have at least 7 days of data first"
+        end
+
+        pad_month_start!(mon_by_wday)
+        weeks = color_month(mon_by_wday)
+        Terminal::Table.new(rows: weeks, style: { all_separators: true }, headings: Date::ABBR_DAYNAMES)
+      end
+
+      # Same as generate_month_report except it includes a color legend
+      # @param [Integer] month
+      # @param [Integer] year
+      # @return [Terminal::Table]
+      def month_with_legend(month, year)
+        tab = generate_month_report month, year
+        Terminal::Table.new(rows: [[tab, Report.legend]]).tap do |combined|
+          combined.style    = { border_x: '', border_y: '', border_i: '', width: `tput cols`.to_i }
+          combined.headings = ["== #{Date::MONTHNAMES[month]} - #{year} ==", '== Legend ==']
+        end
+      end
+
+      # Formats Tcelfer::RATING_TO_COLOR_MAP into a pretty legend Terminal::Table
+      # @return [Terminal::Table]
+      def self.legend
+        leg = Tcelfer::RATING_TO_COLOR_MAP.map do |rating, color|
+          [Paint['    ', :inverse, color], rating]
+        end
+        Terminal::Table.new(rows: leg, headings: %w[Rating Color].map { |head| Paint[head, :bold] })
+      end
+
+      private
+
+      # Takes a hash with keys from 0 to 6 (ostensibly)
+      # and adds `nil` so the first of the month is the first
+      # colored day in that week row
+      # @param [Hash] mon_by_wday
+      # @return [Nil]
+      def pad_month_start!(mon_by_wday)
+        mon_by_wday.keys.sort.each do |wd|
+          dates = mon_by_wday[wd]
+          break unless dates.first.date.day != 1
+
+          dates.unshift(nil)
+        end
+      end
+
+      # convert a Tcelfer::Day object
+      # to an ANSI colored space
+      # @param [Tcelfer::Day] day
+      # @return [String]
+      def color_day(day)
+        return '  ' unless day
+
+        color = Tcelfer::RATING_TO_COLOR_MAP[day.rating]
+        Paint['   ', :inverse, color]
+      end
+
+      # Returns an array of arrays of colored "dates" based on #color_day
+      # @param [Hash] mon_by_wday
+      # @return [Array]
+      def color_month(mon_by_wday)
+        mon_by_wday[0].zip(*mon_by_wday.values_at(*(1..6))).map { |week| week.map(&method(:color_day)) }
+      end
+    end
+  end
+end

data/lib/tcelfer/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2018  Anthony Gargiulo <anthony@agargiulo.com>
+#
+# 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 <http://www.gnu.org/licenses/>.
+require 'anyway'
+
+module Tcelfer
+  # Configuration for tcelfer, thanks to anyway_config
+  class Config < Anyway::Config
+    config_name :tcelfer
+    attr_config(
+      :sqlite_path,
+      debug: false,
+      update_existing: false
+    )
+
+    def validate!
+      raise Tcelfer::StorageError, 'TCELFER_SQLITE_PATH not defined, cannot continue' if sqlite_path.nil?
+
+      self
+    end
+  end
+end

data/lib/tcelfer/errors.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2018  Anthony Gargiulo <anthony@agargiulo.com>
+#
+# 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 <http://www.gnu.org/licenses/>.
+
+module Tcelfer
+  # Base error class, extend this one please
+  class Error < StandardError; end
+
+  # Issues with Storage
+  class StorageError < Error; end
+
+  # When we have a dupe and weren't asked to overwrite
+  class DuplicateDayError < StorageError
+    # The return value here is used by Sinatra's error handling
+    # It leads into the `error 4XX {...}` blocks
+    def http_status
+      409
+    end
+  end
+
+  # Issues with reports
+  class ReportError < Error; end
+end

data/lib/tcelfer/models/day.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# Copyright (C) 2018  Anthony Gargiulo <anthony@agargiulo.com>
+#
+# 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 <http://www.gnu.org/licenses/>.
+require 'sequel'
+
+module Tcelfer
+  module Models
+    # Day model
+    class Day < Sequel::Model(:days)
+      # Pretty format for a Day model
+      # 2019-01-17: Normal, Average Day
+      # @return [String]
+      def to_s
+        str = "#{date}: #{rating}"
+        str += " || Notes: #{notes}" unless notes.nil?
+        str
+      end
+    end
+  end
+end