terminal_calendar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 99295fbd7c1284f599d3c5d27f8dab36af0fc2e008043ec74c5bbeb863db29c4
+  data.tar.gz: 0ed40e47d4b06ed40068542aed1d51502fdbf7b4651db9db4345606d4460cfad
+SHA512:
+  metadata.gz: 75270fedc4e87641e91ae3b675b15a305a2abaf6e8ae675be96f9a62a3aec534876389e0650cb8c5b5521c5b709ce20a982ebd16c2ed3dfa3d8c0369f31468ab
+  data.tar.gz: 63dfa4c82044092d8bfa360a91d789dc8fb4a47f52fb532fd93095d10bbb7a3d2787efabd6081c7341869cfacdec86b0aa4b84a4fad83cd17b895af773df7684

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.0.3

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2023 Michael Cordell (https://mikecordell.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+# TerminalCalendar
+
+[![CircleCI](https://dl.circleci.com/status-badge/img/gh/mcordell/terminal_calendar/tree/master.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/mcordell/terminal_calendar/tree/master)
+[![Coverage Status](https://coveralls.io/repos/github/mcordell/terminal_calendar/badge.svg)](https://coveralls.io/github/mcordell/terminal_calendar)
+[![Gem Version](https://badge.fury.io/rb/terminal_calendar.svg)](https://badge.fury.io/rb/terminal_calendar)
+
+> A ruby calendar and day picker for the terminal
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add terminal_calendar
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install terminal_calendar
+
+## Usage
+
+`terminal_calendar` can be used to render a calendar page similar to the linux tool `cal`:
+
+```ruby
+require 'terminal_calendar'
+# this will render a calendar for the current month to the comma(nd line
+puts TerminalCalendar.cal
+```
+
+![cal screenshot](./_doc/cal-screenshot.png) 
+
+`terminal_calendar` can also be used as a date picker to select days from a calendar:
+
+![picker gif](./_doc/date-picker.gif)
+
+In the above GIF, the following code allows dates to be picked:
+
+```ruby
+require 'terminal_calendar'
+
+dates = TerminalCalendar.date_picker
+
+# where dates is an Array of Date objects
+```
+
+When the calendar pops up the cursor is navigated with standard error keys, `Tab` toggles a day as selected, and `Enter` will end the picking session
+
+## 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, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mcordell/terminal_calendar.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/license/mit/).
+
+## Copyright
+
+Copyright (c) 2023 Michael Cordell. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/certs/mcordell.pem

@@ -0,0 +1,26 @@
+-----BEGIN CERTIFICATE-----
+MIIEeDCCAuCgAwIBAgIBATANBgkqhkiG9w0BAQsFADBBMQ0wCwYDVQQDDARtaWtl
+MRswGQYKCZImiZPyLGQBGRYLbWlrZWNvcmRlbGwxEzARBgoJkiaJk/IsZAEZFgNj
+b20wHhcNMjMwODI2MjMzMjA0WhcNMjQwODI1MjMzMjA0WjBBMQ0wCwYDVQQDDARt
+aWtlMRswGQYKCZImiZPyLGQBGRYLbWlrZWNvcmRlbGwxEzARBgoJkiaJk/IsZAEZ
+FgNjb20wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQC+VmaK9CnkHyuD
+AaIbhJyccOe6ANaQFeKrI6BZ4ZpWogi96KIAhPqnjt1GZ+DJIg9tDJbSDdRThG6O
+Il5jEijiBO5yQs16aVMaOlVvZLouwhCCd+6hhJFBFGzfs6jmdutBb17VFaO0jaGP
+cWyoChe/cUg2B0gGmyigjexQhmHPR6nGRbJ19P/bXNkAES8UptBLR9NNyWVataaw
+P8B+v+hBa8k6jDX+sRHm2wUOhotAHHmIS4bOKSGL6VX2yLwID47svyws4f0JAuqc
+V9aWJgZx0NNP/mUYfbSIV9dAJeLUyPqZbB1Ba+XDyYhVYqGKcanEmDn5dFxHfLRA
+cfAU/Lt8APm/i8x7y0NWoPBL0+OiRbOxCv/Nu5P32O1JUo4/MCB6Dd0y9uzbcqye
+DBYNeVPYfitBm4JrJChtG9iQ6uGhx48rE8TkJ/iDgAXPIL75dJnQvsMQOKshrcs9
+FpHC52pmL8lgqgBWNyNca5jyGhH1MqD9iKwiOHFJ2DHlzqFqM/0CAwEAAaN7MHkw
+CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFAuiXkk79ZpM4+khmt7l
+WEP+htJ1MB8GA1UdEQQYMBaBFG1pa2VAbWlrZWNvcmRlbGwuY29tMB8GA1UdEgQY
+MBaBFG1pa2VAbWlrZWNvcmRlbGwuY29tMA0GCSqGSIb3DQEBCwUAA4IBgQBIUKXJ
+t8raDTY43e69HgHETL6V5AY1ExQcLGAqtqV1UqhseekAAiO804LrrSsp4FcZyDL3
+EL16Emfe0/80rfQIA3fQAoazUbYm2ndjeSMza5CWDMZ8hSvSqQAu1a10wInim5ya
+Q3F8I8i8fLVZk5JE0zBqJUJgtCuE7dI6v9eNcMqvA0Cubn3PMVve0vz4hArOdylr
+OCoZ2UW7pZexQLyjYnokultRyAhvdGGL+stDksXaoJtcCzwfleqMsIBT35QYIc/r
+Hp06A67kCqMavH70GYYej3HdahEu8CjuwGMykA/jww0F+p60QvoGZOcg3hkQRUdT
+oD3LQJLiK+oNexJ0i/rh1pbCMAq1sjGFGyv2ACBn+KEmmLzkDgldJfDyyOtOgomB
+sHCLzDW9qhsvbL8U+XYT0o7iwdtzH6ql3vTd5mxENXSOC9rVMI2amNAJkuwpJvCA
+ZDG8uvZdWY9MZGDjweK0/9rt/PItld9RW4EQJxwgyu/yU1giVs/0wZib+Uw=
+-----END CERTIFICATE-----

data/lib/date_extensions.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+require 'date'
+
+# Useful extensions copied from ActiveSupport::CoreExt
+module DateExtensions
+  COMMON_YEAR_DAYS_IN_MONTH = [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31].freeze
+
+  module ClassMethods
+    def days_in_month(month, year)
+      if month == 2 && ::Date.gregorian_leap?(year)
+        29
+      else
+        COMMON_YEAR_DAYS_IN_MONTH[month]
+      end
+    end
+  end
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def beginning_of_month
+    self.class.new(
+      year,
+      month,
+      1
+    )
+  end
+
+  def end_of_month
+    self.class.new(
+      year,
+      month,
+      self.class.days_in_month(month, year)
+    )
+  end
+end
+
+Date.include(DateExtensions)

data/lib/terminal_calendar/date_picker.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+class TerminalCalendar
+  class DatePicker
+    extend Forwardable
+
+    def self.pick(month: TerminalCalendar::Month.this_month)
+      new(month).pick
+    end
+
+    attr_reader :month, :reader, :cursor
+
+    # @return [TerminalCalendar::Selection::Selector]
+    # @api private
+    attr_reader :selector
+
+    def initialize(month, input: $stdin, output: $stdout, env: ENV, interrupt: :error,
+                   track_history: true)
+      @current_page = Selection::MonthPage.build(month)
+      @month_pages = [[month, @current_page]].to_h
+      @reader = TTY::Reader.new(
+        input: input,
+        output: output,
+        interrupt: interrupt,
+        track_history: track_history,
+        env: env
+      )
+      @output = output
+      @cursor = TTY::Cursor
+      @pastel = Pastel.new
+    end
+
+    def pick
+      @output.print(@cursor.hide)
+      render
+
+      selection_loop
+
+      month_pages.values.flat_map { |p| p.selection_grid.selected_cells.map(&:date) }
+    ensure
+      @output.print(@cursor.show)
+    end
+
+    def render
+      @output.print(current_page.render)
+    end
+
+    private
+
+    # rubocop:disable Metrics/MethodLength
+    def selection_loop
+      loop do
+        press = reader.read_keypress
+        kp = TTY::Reader::Keys.keys.fetch(press) { press }
+
+        case kp
+        when :up, :down, :left, :right
+          move(kp)
+          redraw
+        when :tab
+          toggle!
+        when :return
+          unless selector&.on_header?
+            break
+          end
+
+          select_month
+        end
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    def toggle!
+      return if selector&.on_header?
+
+      selector&.toggle_selected!
+      redraw
+    end
+
+    def select_month
+      clear_page_lines
+      new_date = TerminalCalendar::Selection::MonthYearDialog.new(
+        output: @output,
+        start_at: current_page.month.start_of_month
+      ).select
+      new_month = TerminalCalendar::Month.new(new_date.month, new_date.year)
+      set_new_page(new_month)
+      clear_selection_dialog
+      initialize_selector(:bottom)
+      render
+      @output.print(@cursor.hide)
+      redraw
+    end
+
+    def clear_full_page!
+      @output.print(refresh(current_page.line_count))
+    end
+
+    def clear_page_lines
+      @output.print(refresh(current_page.redraw_lines.length))
+    end
+
+    def clear_selection_dialog
+      @output.print(refresh(2))
+    end
+
+    attr_reader :current_page, :month_pages
+
+    def_delegators(:current_page, :selection_grid)
+
+    def redraw
+      lines = current_page.redraw_lines
+      @output.print(refresh(lines.length) + lines.join("\n"))
+    end
+
+    def refresh(lines)
+      @cursor.clear_lines(lines)
+    end
+
+    # Moves the selector in the specified direction.
+    # @param direction [Symbol] The direction to move the selector in.
+    #   Valid values are :up, :down, :left, and :right.
+    #
+    # @return [TerminalCalendar::Selection::Selector]
+    def move(direction)
+      return initialize_selector(direction) unless selector
+
+      case selector.move(direction)
+      when :off_left
+        new_month = @current_page.month.previous_month
+        set_new_page(new_month)
+      when :off_right
+        new_month = @current_page.month.next_month
+        set_new_page(new_month)
+      end
+    end
+
+    def set_new_page(new_month)
+      clear_full_page!
+      @current_page = month_pages.fetch(new_month) do
+        month_pages[new_month] = Selection::MonthPage.build(new_month)
+      end
+      initialize_selector(:bottom)
+      render
+    end
+
+    # Initializes the selector based on the given direction.
+    #
+    # @param direction [Symbol] The direction to initialize the selector.
+    #   Must be one of :up, :left, :down, or :right.
+    #
+    # @return [TerminalCalendar::Selection::Selector]
+    #
+    # @api private
+    def initialize_selector(direction)
+      position = %i(up left).include?(direction) ? :bottom : :top
+      @selector = TerminalCalendar::Selection::Selector.build(current_page, position)
+    end
+  end
+end

data/lib/terminal_calendar/month/calendar_day.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+class TerminalCalendar
+  class Month
+    class CalendarDay
+      # @return [Pastel] The pastel object to use for decorating text
+      attr_reader :pastel
+
+      # @return [Date] The date for this calendar day
+      attr_reader :date
+
+      # @param date [Date] The date to be assigned to this calendar day
+      # @param pastel [Pastel] The pastel object to use for decorating text
+      def initialize(date, pastel=Pastel.new)
+        @date = date
+        @pastel = pastel
+      end
+
+      # Renders the day as a string.
+      # @return [String] the day as a string
+      def render
+        as_string = day.to_s
+        as_string = " #{as_string}" if as_string.length == 1
+        as_string = pastel.red(as_string) if today?
+        as_string
+      end
+
+      alias to_s render
+
+      # Determines if the given date is today.
+      #
+      # @return [Boolean] Returns true if the date is today, false otherwise.
+      def today?
+        date == Date.today
+      end
+
+      # Returns whether the object is null or not.
+      #
+      # @return [false] Returns false.
+      def null?
+        false
+      end
+
+      # Returns the day of the date.
+      #
+      # @return [Integer] The day of the date.
+      def day
+        date.day
+      end
+    end
+
+    class NullDay < CalendarDay
+      def initialize
+        super(nil)
+      end
+
+      def render
+        '  '
+      end
+      alias to_s render
+
+      # Returns whether the object is null or not.
+      #
+      # @return [true] Returns true.
+      def null?
+        true
+      end
+    end
+  end
+end

data/lib/terminal_calendar/month.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+require 'terminal_calendar/month/calendar_day'
+
+class TerminalCalendar
+  class Month
+    # Returns an array of rows representing the data.
+    # @return [Array<Array>] an array of arrays, where each inner array represents a row of data
+    attr_reader :as_rows
+
+    attr_reader :month, :year, :start_of_month, :end_of_month
+
+    DAYS_IN_THE_WEEK = 7
+
+    def self.this_month
+      new(Date.today.month, Date.today.year)
+    end
+
+    def self.new(*arguments, &block)
+      month = arguments[0].to_i
+      fail ArgumentError.new('Month number must be 1-12') unless month >= 1 && month <= 12
+
+      year = arguments[1].to_i
+      key = [year, month]
+
+      TerminalCalendar.all_months.fetch(key) do
+        instance = allocate
+        instance.send(:initialize, *arguments, &block)
+        TerminalCalendar.all_months[key] = instance.freeze
+      end
+    end
+
+    def initialize(month, year)
+      @month = month.to_i
+      @year = year.to_i
+      @start_of_month = Date.new(year, month, 1)
+      @end_of_month = @start_of_month.end_of_month
+      @as_rows ||= build_rows
+    end
+
+    def next_month
+      new_month = month == 12 ? 1 : month + 1
+      new_year = new_month == 1 ? year + 1 : year
+      self.class.new(new_month, new_year)
+    end
+
+    def previous_month
+      new_month = month == 1 ? 12 : month - 1
+      new_year = new_month == 12 ? year - 1 : year
+      self.class.new(new_month, new_year)
+    end
+
+    def ==(other)
+      eql?(other)
+    end
+
+    def eql?(other)
+      other.month == month && other.year == year
+    end
+
+    def hash
+      [month, year].hash
+    end
+
+    def render
+      TerminalCalendar::Selection::MonthPage.new(self).render
+    end
+
+    private
+
+    # rubocop:disable Metrics/AbcSize
+    def build_rows
+      current_row = empty_week
+      [].tap do |rows|
+        (start_of_month..end_of_month).each do |d|
+          if d.wday.zero? && !current_row.empty?
+            rows.push(current_row)
+            current_row = empty_week
+          end
+          current_row[d.wday] = CalendarDay.new(d, pastel).freeze
+        end
+        rows.push(current_row) unless current_row.empty?
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def null_date
+      @null_date ||= NullDay.new.freeze
+    end
+
+    def empty_week
+      Array.new(DAYS_IN_THE_WEEK) { null_date }
+    end
+
+    def pastel
+      @pastel ||= Pastel.new(enabled: true)
+    end
+  end
+end

data/lib/terminal_calendar/selection/cell.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+class TerminalCalendar
+  module Selection
+    DEFAULT_SELECTED_STYLE = 'XX'
+
+    class Cell
+      # @return [Object] the object that this cell wraps
+      attr_reader(:underlying_object)
+      # @return [Boolean] whether this cell is currently selected
+      attr_reader(:selected)
+      # @return [String] the rendered style of a cell that is selected
+      attr_reader(:selected_style)
+
+      # Builds a new cell object based on the given object. If the
+      # underlying object is Null, a NullCell will be returned
+      # @param obj [Object] The object to build the cell from.
+      # @return [Cell] The newly built cell object.
+      def self.build(obj)
+        obj.null? ? NullCell.new(obj) : new(obj)
+      end
+
+      def initialize(underlying_object, selected: false, selected_style: DEFAULT_SELECTED_STYLE)
+        @underlying_object = underlying_object
+        @selected = selected
+        @selected_style = selected_style
+      end
+
+      # Renders the selected_style string if it is selected, otherwise
+      # returns the result of rendering the underlying object.
+      #
+      # @return [String] The cell's rendered content
+      def render
+        return underlying_object.render unless selected?
+
+        selected_style
+      end
+
+      # Checks if the object is null.
+      #
+      # @return [Boolean] Returns false.
+      def null?
+        false
+      end
+
+      # Toggles the selected state of the object.
+      # @return [Boolean] the new selected state of the object
+      def toggle_selected!
+        @selected = !@selected
+      end
+
+      alias_method  :selected?, :selected
+
+      # Calls the missing method on the underlying object.
+      #
+      # @param method [Symbol] the name of the missing method
+      # @param args [Array] the arguments passed to the missing method
+      # @param block [Proc] the block passed to the missing method
+      # @return [Object] the result of calling the missing method on the underlying object
+      # @raise [NoMethodError] if the underlying object does not respond to the missing method
+      def method_missing(method, *args, &block)
+        underlying_object.send(method, *args, &block)
+      end
+
+      # Checks if the underlying object responds to the missing method.
+      #
+      # @param method [Symbol] the name of the missing method
+      # @param include_all [Boolean] whether to include private methods in the check
+      # @return [Boolean] true if the underlying object responds to the missing method, super otherwise
+      def respond_to_missing?(method, include_all)
+        underlying_object.respond_to?(method) || super
+      end
+    end
+  end
+end