calendario 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9291a462c911bf262155797e6e486d8732c9b5e71072e62786400f8fe2a9255c
-  data.tar.gz: a97194dcf9e9a4d26e5cf8dd549980da27d614a5056eec1c3dec5f133c29b768
+  metadata.gz: 89a09aa1117a1ad2bac868c40efd513e14fb6de0fb7d5954956af9c2071b9c8d
+  data.tar.gz: 003dabc70ca610796204de8ec3efad4357ec75090b352b6c7a20d7e72476be73
 SHA512:
-  metadata.gz: 7bd0eae6c396824afcb80847c5fce30fbf7f05b4cc209376c855450cd453b12234060ef0efb241122f4a738830696731a45da4d686852ad5c2b72150a8b5d49a
-  data.tar.gz: 436d795f293c0ec6fdcc08218e9826a8d1f725ebb6dcae03b94963aded5dcff0d3c76e688a9d84641d6f4b0f0303b1fb0e843c9d24bb261bdfc562dce0d375e3
+  metadata.gz: 1fd1c4568c21d9278bdcadf849ab13bdd4b83cb5b9be5a84a741c6ab7e3097b71500a598758b4f7ca8e0f42d5d96c1692f7d534c49789b6dafd0dbd9320181cc
+  data.tar.gz: 8e23336cd1bbc7aef8317374464b7cb7e701ebcd4d5665911d36ae4bdc3391dd51e791e48713339963575da7780db6ddfae65b630e2ed123c10eae1ad2d21467

data/.overcommit.yml

@@ -22,6 +22,8 @@ PreCommit:
 
   TrailingWhitespace:
     enabled: true
+    exclude:
+      - '**/*.snap'
 
 #PostCheckout:
 #  ALL: # Special hook name that customizes all hooks of this type

data/CHANGELOG.md

@@ -4,9 +4,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - 2020-06-29
+### Changed
+- Split the year rendering into 4 classes: `YearRenderer`, `RenderedYear`, `MonthRenderer` and `RenderedMonth`
+- Refactored the renderers to remove magic strings and numbers
+- Refactored the renderers to create the basis for different column layouts
+
+### Fixed
+- Fixed the usage documentation
+
 ## [0.1.0] - 2020-06-25
 ### Added
 - Initial core functionality
 - Codebase maintenance tools
 
+[0.2.0]: https://github.com/wilsonsilva/tuga/compare/v0.1.0...v0.2.0
 [0.1.0]: https://github.com/wilsonsilva/tuga/compare/15adab8...v0.1.0

data/README.md

@@ -1,11 +1,11 @@
 # Calendario
 
-[![Gem Version](https://badge.fury.io/rb/caendario.svg)](https://badge.fury.io/rb/caendario)
-[![Build Status](https://travis-ci.org/wilsonsilva/caendario.svg?branch=master)](https://travis-ci.org/wilsonsilva/caendario)
-[![Maintainability](https://api.codeclimate.com/v1/badges/7afec90a09db3956b7dc/maintainability)](https://codeclimate.com/github/wilsonsilva/caendario/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/7afec90a09db3956b7dc/test_coverage)](https://codeclimate.com/github/wilsonsilva/caendario/test_coverage)
-[![Security](https://hakiri.io/github/wilsonsilva/caendario/master.svg)](https://hakiri.io/github/wilsonsilva/caendario/master)
-[![Inline docs](http://inch-ci.org/github/wilsonsilva/caendario.svg?branch=master)](http://inch-ci.org/github/wilsonsilva/caendario)
+[![Gem Version](https://badge.fury.io/rb/calendario.svg)](https://badge.fury.io/rb/calendario)
+[![Build Status](https://travis-ci.org/wilsonsilva/calendario.svg?branch=master)](https://travis-ci.org/wilsonsilva/calendario)
+[![Maintainability](https://api.codeclimate.com/v1/badges/98a431421f7754ffe8fc/maintainability)](https://codeclimate.com/github/wilsonsilva/calendario/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/98a431421f7754ffe8fc/test_coverage)](https://codeclimate.com/github/wilsonsilva/calendario/test_coverage)
+[![Security](https://hakiri.io/github/wilsonsilva/calendario/master.svg)](https://hakiri.io/github/wilsonsilva/calendario/master)
+[![Inline docs](http://inch-ci.org/github/wilsonsilva/calendario.svg?branch=master)](http://inch-ci.org/github/wilsonsilva/calendario)
 
 A cal-like calendar.
 
@@ -75,7 +75,7 @@ You can also customize what to display on each day. For example, this code wil d
 ```ruby
 calendar = Calendario::Calendar.new
 rendered_calendar = calendar.render_current_year do |date|
-  if date.wday == 5 ||  if date.wday == 6
+  if date.wday == 5 || date.wday == 6
     'WE'
   else
     date.day.to_s.rjust(2)

data/lib/calendario/calendar.rb

@@ -39,7 +39,7 @@ module Calendario
     #    end
     #  end
     #
-    # @return [String]
+    # @return [RenderedYear]
     #
     def render_current_year(&block)
       year = Year.new(Date.today.year)

data/lib/calendario/month.rb

@@ -36,7 +36,7 @@ module Calendario
     # @param [Integer] year_number The primitive numeric representation of a year
     # @param [Integer] month_number The month's number from 1 to 12
     #
-    def initialize(year_number = 2020, month_number = 1)
+    def initialize(year_number, month_number)
       @year_number = year_number
       @month_number = month_number
       @days = (first_day..last_day).to_a

data/lib/calendario/rendered_month.rb

@@ -0,0 +1,75 @@
+module Calendario
+  # A cal-like representation of a month:
+  #
+  #       January
+  # Su Mo Tu We Th Fr Sa
+  #           1  2  3  4
+  #  5  6  7  8  9 10 11
+  # 12 13 14 15 16 17 18
+  # 19 20 21 22 23 24 25
+  # 26 27 28 29 30 31
+  #
+  class RenderedMonth
+    # A list of lines representing a month. The month name, the weekday initials and 4 to 5 lines of weeks
+    #
+    # @api private
+    # @return [Array<String>]
+    #
+    attr_reader :lines
+
+    # Initializes a rendered month
+    #
+    # @api private
+    # @param [Array<String>] lines List of lines representing a month. The month name, the weekday
+    # initials and 4 to 5 lines of weeks
+    #
+    def initialize(lines)
+      @lines = lines
+    end
+
+    # Returns the textual representation of a month
+    #
+    # @api private
+    # @return [String]
+    #
+    def to_s
+      lines.join("\n")
+    end
+
+    # The centered name of the month
+    #
+    # @api private
+    # @return [String]
+    #
+    def name
+      lines[0]
+    end
+
+    # The list of weekday initials (Su Mo Tu We Th Fr Sa)
+    #
+    # @api private
+    # @return [String]
+    #
+    def weekdays
+      lines[1]
+    end
+
+    # Returns 4 or 5 rows of weeks
+    #
+    # @api private
+    # @return [Array<String>]
+    #
+    def weeks
+      lines[2..-1]
+    end
+
+    # Finds one or more lines of the rendered month
+    #
+    # @api private
+    # @return [Array<String>]
+    #
+    def [](index)
+      lines.public_send(:[], index)
+    end
+  end
+end

data/lib/calendario/rendered_year.rb

@@ -0,0 +1,66 @@
+module Calendario
+  # A cal-like representation of a year:
+  #
+  #                             2020
+  #       January               February               March
+  # Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+  #           1  2  3  4                     1   1  2  3  4  5  6  7
+  #  5  6  7  8  9 10 11   2  3  4  5  6  7  8   8  9 10 11 12 13 14
+  # 12 13 14 15 16 17 18   9 10 11 12 13 14 15  15 16 17 18 19 20 21
+  # 19 20 21 22 23 24 25  16 17 18 19 20 21 22  22 23 24 25 26 27 28
+  # 26 27 28 29 30 31     23 24 25 26 27 28 29  29 30 31
+  #
+  #
+  #        April                  May                   June
+  # Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+  #           1  2  3  4                  1  2      1  2  3  4  5  6
+  #  5  6  7  8  9 10 11   3  4  5  6  7  8  9   7  8  9 10 11 12 13
+  # 12 13 14 15 16 17 18  10 11 12 13 14 15 16  14 15 16 17 18 19 20
+  # 19 20 21 22 23 24 25  17 18 19 20 21 22 23  21 22 23 24 25 26 27
+  # 26 27 28 29 30        24 25 26 27 28 29 30  28 29 30
+  #                       31
+  #
+  #         July                 August              September
+  # Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+  #           1  2  3  4                     1         1  2  3  4  5
+  #  5  6  7  8  9 10 11   2  3  4  5  6  7  8   6  7  8  9 10 11 12
+  # 12 13 14 15 16 17 18   9 10 11 12 13 14 15  13 14 15 16 17 18 19
+  # 19 20 21 22 23 24 25  16 17 18 19 20 21 22  20 21 22 23 24 25 26
+  # 26 27 28 29 30 31     23 24 25 26 27 28 29  27 28 29 30
+  #                       30 31
+  #
+  #       October               November              December
+  # Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+  #              1  2  3   1  2  3  4  5  6  7         1  2  3  4  5
+  #  4  5  6  7  8  9 10   8  9 10 11 12 13 14   6  7  8  9 10 11 12
+  # 11 12 13 14 15 16 17  15 16 17 18 19 20 21  13 14 15 16 17 18 19
+  # 18 19 20 21 22 23 24  22 23 24 25 26 27 28  20 21 22 23 24 25 26
+  # 25 26 27 28 29 30 31  29 30                 27 28 29 30 31
+  #
+  class RenderedYear
+    # A list of lines representing a year
+    #
+    # @api private
+    # @return [Array<String>]
+    #
+    attr_reader :lines
+
+    # Initializes a rendered year
+    #
+    # @api private
+    # @param [Array<String>] lines List of lines representing a year
+    #
+    def initialize(lines)
+      @lines = lines
+    end
+
+    # Returns the textual representation of a year
+    #
+    # @api private
+    # @return [String]
+    #
+    def to_s
+      lines.join("\n")
+    end
+  end
+end

data/lib/calendario/renderers/month_renderer.rb

@@ -0,0 +1,120 @@
+require 'calendario/month'
+require 'calendario/rendered_month'
+
+module Calendario
+  module Renderers
+    # Renders a month line by line
+    #
+    # @api private
+    #
+    class MonthRenderer
+      # The space of an empty day
+      # @return [String]
+      EMPTY_DAY_SPACES = '  '.freeze
+
+      # Initials of each week day
+      # @return [String]
+      WEEKDAY_INITIALS = 'Su Mo Tu We Th Fr Sa'.freeze
+
+      # Width of a rendered month
+      # @return [Integer]
+      MONTH_WIDTH = 20
+
+      # A proc to be executed on each date to define what is displayed on each day
+      #
+      # @api private
+      # @return [Proc]
+      #
+      attr_accessor :filter
+
+      # Initializes a month renderer
+      #
+      # @api private
+      #
+      def initialize
+        @filter = proc { |date| date.day.to_s.rjust(2) }
+      end
+
+      # Renders a month
+      #
+      # @api private
+      # @param [Month] month The month to be rendered
+      # @return [RenderedMonth]
+      #
+      def render(month)
+        weeks = build_weeks(month).map { |week| week.join(' ') }
+
+        lines = [
+          center_name(month),
+          WEEKDAY_INITIALS,
+          *weeks
+        ]
+
+        RenderedMonth.new(lines)
+      end
+
+      private
+
+      # Builds all weeks in a month, applying a filter on every date
+      #
+      # @api private
+      # @param [Month] month The month containing the weeks
+      # @return [Array<Date|String>]
+      #
+      def build_weeks(month)
+        weeks = month.weeks
+
+        add_leading_spaces(month.weeks.first)
+        add_trailing_spaces(month.weeks.last)
+
+        weeks << [EMPTY_DAY_SPACES] * 7 if month.weeks.size == 5
+        weeks.map do |week|
+          week.map(&method(:apply_filter))
+        end
+      end
+
+      # Applies a filter on a date or a blank space
+      #
+      # @api private
+      # @param [Date|String] date_or_string A date or a string to be parsed by a filter
+      # @return [Date|String]
+      #
+      def apply_filter(date_or_string)
+        date_or_string.is_a?(Date) ? filter.call(date_or_string) : date_or_string
+      end
+
+      # Prepends leading spaces in a week until the first day of the week is found
+      #
+      # @api private
+      # @param [Array<Date>] week A list of days in a week
+      # @return [void]
+      #
+      def add_leading_spaces(week)
+        first_day_is_sunday = week.first.wday.zero?
+        return if first_day_is_sunday
+
+        week.first.wday.times { week.unshift(EMPTY_DAY_SPACES) }
+      end
+
+      # Appends trailing spaces in a week until it has 7 items
+      #
+      # @api private
+      # @param [Array<Date>] week A list of days in a week
+      # @return [void]
+      #
+      def add_trailing_spaces(week)
+        (6 - week.last.wday).abs.times { week.push(EMPTY_DAY_SPACES) }
+      end
+
+      # Centers the month's name horizontally
+      #
+      # @api private
+      # @param [Month] month The month to be centered
+      # @return [String]
+      #
+      def center_name(month)
+        month.name.center(MONTH_WIDTH)
+      end
+    end
+  end
+end

data/lib/calendario/renderers/year_renderer.rb

@@ -1,147 +1,83 @@
-require 'calendario/month'
+require 'calendario/rendered_year'
+require 'calendario/renderers/month_renderer'
 
 module Calendario
   module Renderers
-    # Formats a year, line by line, in a table of 3 columns by 4 rows
+    # Renders a year, line by line, in a table of 3 columns by 4 rows
     class YearRenderer
-      # The space of an empty day (3 = 2 digits + 1 space between digits)
-      EMPTY_DAY_SPACES = ' ' * 3
+      # The space of an empty day
+      # @return [String]
+      EMPTY_DAY_SPACES = '  '.freeze
 
-      # The space to add on the 6th row of a month when that row is empty
-      EMPTY_WEEK_SPACES = ' ' * 20
+      # Number of month columns to display
+      # @return [Integer]
+      NUMBER_OF_MONTH_COLUMNS = 3
 
-      # Formats a year, line by line, in a table of 3 columns by 4 rows like this:
-      #
-      #                             2020                                  | Title, centered
-      #       January               February               March          | Names of months, centered
-      # Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  | Weekday initials
-      #           1  2  3  4                     1   1  2  3  4  5  6  7  | Rows of weeks
-      #  5  6  7  8  9 10 11   2  3  4  5  6  7  8   8  9 10 11 12 13 14  |
-      # 12 13 14 15 16 17 18   9 10 11 12 13 14 15  15 16 17 18 19 20 21  |
-      # 19 20 21 22 23 24 25  16 17 18 19 20 21 22  22 23 24 25 26 27 28  |
-      # 26 27 28 29 30 31     23 24 25 26 27 28 29  29 30 31              | Add spaces after the last day of the
-      #                                                                   | month until the first day of the week of
-      #                                                                   | the month of the following month on the
-      #        April                  May                   June          | same row.
-      # Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  |
-      #           1  2  3  4                  1  2      1  2  3  4  5  6  | Add spaces before the first day of the
-      #  5  6  7  8  9 10 11   3  4  5  6  7  8  9   7  8  9 10 11 12 13  | month unless it is a Sunday.
-      # 12 13 14 15 16 17 18  10 11 12 13 14 15 16  14 15 16 17 18 19 20  |
-      # 19 20 21 22 23 24 25  17 18 19 20 21 22 23  21 22 23 24 25 26 27  |
-      # 26 27 28 29 30        24 25 26 27 28 29 30  28 29 30              |
-      #                       31                                          | Add spaces before a day on the second
-      #                                                                   | or third month columns if the first or
-      #         July                 August              September        | second columns month are empty.
-      # Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  |
-      #           1  2  3  4                     1         1  2  3  4  5  |
-      #  5  6  7  8  9 10 11   2  3  4  5  6  7  8   6  7  8  9 10 11 12  |
-      # 12 13 14 15 16 17 18   9 10 11 12 13 14 15  13 14 15 16 17 18 19  |
-      # 19 20 21 22 23 24 25  16 17 18 19 20 21 22  20 21 22 23 24 25 26  |
-      # 26 27 28 29 30 31     23 24 25 26 27 28 29  27 28 29 30           |
-      #                       30 31                                       |
-      #                                                                   |
-      #       October               November              December        |
-      # Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  |
-      #              1  2  3   1  2  3  4  5  6  7         1  2  3  4  5  |
-      #  4  5  6  7  8  9 10   8  9 10 11 12 13 14   6  7  8  9 10 11 12  |
-      # 11 12 13 14 15 16 17  15 16 17 18 19 20 21  13 14 15 16 17 18 19  |
-      # 18 19 20 21 22 23 24  22 23 24 25 26 27 28  20 21 22 23 24 25 26  |
-      # 25 26 27 28 29 30 31  29 30                 27 28 29 30 31        |
+      # Initializes a year renderer
       #
       # @api private
-      # @param [Year] year The year to be formatted.
-      # @return [String]
+      # @param [MonthRenderer] month_renderer A service to render a month line by line
       #
-      def render(year)
-        output = centered_year_line(year)
-
-        # Display months in
-        year.months.each_slice(3).with_index do |group_of_3_months, month_row|
-          output << month_names_line(group_of_3_months)
-          output << weekdays_initials_line
-
-          # Display 6 rows of days. Each row is a week.
-          0.upto(5) do |week_number|
-            # Display
-            group_of_3_months.each_with_index do |month, index|
-              # Correct the position for the first date of the first week
-              output << EMPTY_DAY_SPACES * month.first_day.wday if week_number.zero?
-
-              # Display a complete row of week days
-              output << (month.weeks[week_number] || []).map do |date|
-                if block_given?
-                  yield(date)
-                else
-                  date.day.to_s.rjust(2)
-                end
-              end.join(' ') + '  '
-
-              # Correct the position for the first date of the following month
-              output << lead_space_after_last_day(month) if last_week_of_the_month?(month, week_number)
+      def initialize(month_renderer = MonthRenderer.new)
+        @month_renderer = month_renderer
+      end
 
-              # Correct the position of the dates on empty rows (usually the last week)
-              output << EMPTY_WEEK_SPACES if week_number == 5 && group_of_3_months[index - 1].weeks[week_number].nil?
-            end
+      # Formats a year, line by line, in a table of 3 columns by 4 rows
+      #
+      # @api private
+      # @param [Year] year The year to be rendered.
+      # @return [RenderedYear]
+      #
+      def render(year, &block)
+        month_renderer.filter = block if block_given?
 
-            # End of the week row. Start the next one on the next line
-            output << "\n"
-          end
+        lines = [center_year_number(year)]
+        rendered_months = render_months(year.months)
 
-          # Separate rows of months
-          output << "\n" if month_row < 3
+        rendered_months.each_slice(NUMBER_OF_MONTH_COLUMNS) do |months|
+          0.upto(7) { |month_line| lines << take_row(month_line, months) }
+          lines.push('') # Separate rows of months
         end
 
-        output
+        RenderedYear.new(lines)
       end
 
       private
 
-      # Adds blank spaces to fill the empty week days on the last week row of the month
-      #
-      # @api private
-      # @param [Month] month
-      # @return [String]
-      #
-      def lead_space_after_last_day(month)
-        EMPTY_DAY_SPACES * (6 - month.last_day.wday)
-      end
-
-      # Centers the year in the middle of the calendar
+      # A service to render a month line by line
       #
       # @api private
-      # @param [Year] year The year to be displayed at the top of the calendar
-      # @return [String]
+      # @return [Calendario::Renderers::MonthRenderer]
       #
-      def centered_year_line(year)
-        year.year_number.to_s.center(61) + "\n"
-      end
+      attr_accessor :month_renderer
 
-      # Displays 3 columns of month names in a line
+      # Extracts a row from a group of months
       #
       # @api private
-      # @param [Array<Month>] group_of_3_months The list of months whose names will be displayed
-      # @return [String]
+      # @return [Array<String>]
       #
-      def month_names_line(group_of_3_months)
-        group_of_3_months.map { |month| month.name.center(20) }.join(' ') + " \n"
+      def take_row(month_line, months)
+        months.map { |month| month[month_line] }.join(EMPTY_DAY_SPACES)
       end
 
-      # Displays 3 columns of weekdays initials in a line
+      # Centers the year in the middle of the calendar
       #
       # @api private
+      # @param [Year] year The year to be displayed at the top of the calendar
       # @return [String]
       #
-      def weekdays_initials_line
-        "Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa  \n"
+      def center_year_number(year)
+        year.year_number.to_s.center(61)
       end
 
-      # Whether the week is the last week of the month
+      # Renders a list of months
       #
       # @api private
-      # @return [Boolean]
+      # @param [Array<Month>] months The list of months to be rendered
+      # @return [Array<RenderedMonth>]
       #
-      def last_week_of_the_month?(month, week_number)
-        month.weeks[week_number] == month.weeks.last
+      def render_months(months)
+        months.map { |month| month_renderer.render(month) }
       end
     end
   end

data/lib/calendario/version.rb

@@ -1,3 +1,3 @@
 module Calendario
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendario
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wilson Silva
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -291,6 +291,9 @@ files:
 - lib/calendario.rb
 - lib/calendario/calendar.rb
 - lib/calendario/month.rb
+- lib/calendario/rendered_month.rb
+- lib/calendario/rendered_year.rb
+- lib/calendario/renderers/month_renderer.rb
 - lib/calendario/renderers/year_renderer.rb
 - lib/calendario/version.rb
 - lib/calendario/year.rb