calendario 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89a09aa1117a1ad2bac868c40efd513e14fb6de0fb7d5954956af9c2071b9c8d
-  data.tar.gz: 003dabc70ca610796204de8ec3efad4357ec75090b352b6c7a20d7e72476be73
+  metadata.gz: dc383b592c482fbab67e016507b402e7ee9c0a66553e8e306ca4ce54b53b22dd
+  data.tar.gz: '08888fb132751ed44cda84da8c1f3f24b3230c4c7e89216bc153f1a6d77c09d9'
 SHA512:
-  metadata.gz: 1fd1c4568c21d9278bdcadf849ab13bdd4b83cb5b9be5a84a741c6ab7e3097b71500a598758b4f7ca8e0f42d5d96c1692f7d534c49789b6dafd0dbd9320181cc
-  data.tar.gz: 8e23336cd1bbc7aef8317374464b7cb7e701ebcd4d5665911d36ae4bdc3391dd51e791e48713339963575da7780db6ddfae65b630e2ed123c10eae1ad2d21467
+  metadata.gz: d27a34fe68a5839f9729466e337e494322be699a436995aa7fd86a22079bb39bd752f12f9c67f1efb0b137afc448301b561f08d589ac0932398a831ce60b59be
+  data.tar.gz: ee1d9868cf5cf3a62d8f580fb240bc18c75a0fab205dd2508fdd8d1edb2c65f01c683250a794ef45e202943fda6e7d17fef46f634a1594c3139124f7bcedc7da

data/CHANGELOG.md

@@ -4,6 +4,10 @@ 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.3.0] - 2020-06-30
+### Added
+- Added the concept of `Interval`. Intervals are groups of one or more months and can span multiple years
+
 ## [0.2.0] - 2020-06-29
 ### Changed
 - Split the year rendering into 4 classes: `YearRenderer`, `RenderedYear`, `MonthRenderer` and `RenderedMonth`
@@ -18,5 +22,5 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - 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
+[0.2.0]: https://github.com/wilsonsilva/calendario/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/wilsonsilva/calendario/compare/15adab8...v0.1.0

data/README.md

@@ -65,6 +65,9 @@ Or install it yourself as:
 
 ## Usage
 
+__WARNING:__ The API is experimental until the gem reaches the version 1.0.
+
+### Rendering a year
 Rendering the current year:
 ```ruby
 calendar = Calendario::Calendar.new
@@ -85,6 +88,46 @@ end
 puts rendered_calendar
 ```
 
+### Rendering a custom time interval
+
+You can render a custom interval in any given number of columns. In the example below, we're rendering 5 months in
+2 columns and as many rows as necessary:
+
+```ruby
+interval = Calendario::Interval.new(2020, 2, 2020, 6)
+renderer = Calendario::Renderers::IntervalRenderer.new
+
+rendered_year = renderer.render(interval, columns: 2)
+puts rendered_year
+
+#       February               March
+# Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+#                    1   1  2  3  4  5  6  7
+#  2  3  4  5  6  7  8   8  9 10 11 12 13 14
+#  9 10 11 12 13 14 15  15 16 17 18 19 20 21
+# 16 17 18 19 20 21 22  22 23 24 25 26 27 28
+# 23 24 25 26 27 28 29  29 30 31
+#
+#
+#        April                  May
+# Su Mo Tu We Th Fr Sa  Su Mo Tu We Th Fr Sa
+#           1  2  3  4                  1  2
+#  5  6  7  8  9 10 11   3  4  5  6  7  8  9
+# 12 13 14 15 16 17 18  10 11 12 13 14 15 16
+# 19 20 21 22 23 24 25  17 18 19 20 21 22 23
+# 26 27 28 29 30        24 25 26 27 28 29 30
+#                       31
+#
+#         June
+# 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
+#
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies, configure git hooks and create support files.

data/lib/calendario/interval.rb

@@ -0,0 +1,32 @@
+require 'calendario/month'
+
+module Calendario
+  # A list of one or more months
+  class Interval
+    include Comparable
+
+    # Array of all months in the period
+    #
+    # @api private
+    # @return [Array<Month>]
+    #
+    attr_reader :months
+
+    # Initialize a time interval
+    #
+    # @api private
+    #
+    # @param [Integer] first_year The primitive representation of the first year
+    # @param [Integer] first_month The primitive representation of the first month
+    # @param [Integer] last_year The primitive representation of the last year
+    # @param [Integer] last_month The primitive representation of the last month
+    #
+    def initialize(first_year, first_month, last_year, last_month)
+      @first_year = first_year
+      @first_month = first_month
+      @last_year = last_year
+      @last_month = last_month
+      @months = (Month.new(first_year, first_month)..Month.new(last_year, last_month)).to_a
+    end
+  end
+end

data/lib/calendario/month.rb

@@ -79,5 +79,28 @@ module Calendario
     def name
       MONTH_NAMES[month_number]
     end
+
+    # The following month
+    #
+    # @api private
+    # @return [Month]
+    #
+    def succ
+      if month_number == 12
+        self.class.new(year_number + 1, 1)
+      else
+        self.class.new(year_number, month_number + 1)
+      end
+    end
+
+    # Operator to sorts months in chronological order
+    #
+    # @api private
+    # @param [Month] other
+    # @return [Integer]
+    #
+    def <=>(other)
+      (year_number <=> other.year_number).nonzero? || month_number <=> other.month_number
+    end
   end
 end

data/lib/calendario/rendered_interval.rb

@@ -0,0 +1,38 @@
+module Calendario
+  # A cal-like representation of an interval:
+  #
+  #       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
+  #
+  class RenderedInterval
+    # A list of lines representing an interval
+    #
+    # @api private
+    # @return [Array<String>]
+    #
+    attr_reader :lines
+
+    # Initializes a rendered interval
+    #
+    # @api private
+    # @param [Array<String>] lines List of lines representing an interval
+    #
+    def initialize(lines)
+      @lines = lines
+    end
+
+    # Returns the textual representation of an interval
+    #
+    # @api private
+    # @return [String]
+    #
+    def to_s
+      lines.join("\n")
+    end
+  end
+end

data/lib/calendario/renderers/interval_renderer.rb

@@ -0,0 +1,71 @@
+require 'calendario/interval'
+require 'calendario/rendered_interval'
+require 'calendario/renderers/month_renderer'
+
+module Calendario
+  module Renderers
+    # Renders a time interval, line by line, in a table
+    class IntervalRenderer
+      # The space of an empty day
+      # @return [String]
+      EMPTY_DAY_SPACES = '  '.freeze
+
+      # Initializes a interval renderer
+      #
+      # @api private
+      # @param [MonthRenderer] month_renderer A service to render a month line by line
+      #
+      def initialize(month_renderer = MonthRenderer.new)
+        @month_renderer = month_renderer
+      end
+
+      # Formats a time interval, line by line, in a table
+      #
+      # @api private
+      # @param [Interval] interval The time interval to be rendered.
+      # @return [RenderedInterval]
+      #
+      def render(interval, columns:, &block)
+        month_renderer.filter = block if block_given?
+
+        lines = []
+        rendered_months = render_months(interval.months)
+
+        rendered_months.each_slice(columns) do |months|
+          0.upto(7) { |month_line| lines << take_row(month_line, months) }
+          lines.push('') # Separate rows of months
+        end
+
+        RenderedInterval.new(lines)
+      end
+
+      private
+
+      # A service to render a month line by line
+      #
+      # @api private
+      # @return [Calendario::Renderers::MonthRenderer]
+      #
+      attr_accessor :month_renderer
+
+      # Extracts a row from a group of months
+      #
+      # @api private
+      # @return [Array<String>]
+      #
+      def take_row(month_line, months)
+        months.map { |month| month[month_line] }.join(EMPTY_DAY_SPACES)
+      end
+
+      # Renders a list of months
+      #
+      # @api private
+      # @param [Array<Month>] months The list of months to be rendered
+      # @return [Array<RenderedMonth>]
+      #
+      def render_months(months)
+        months.map { |month| month_renderer.render(month) }
+      end
+    end
+  end
+end

data/lib/calendario/renderers/year_renderer.rb

@@ -1,27 +1,15 @@
 require 'calendario/rendered_year'
 require 'calendario/renderers/month_renderer'
+require 'calendario/renderers/interval_renderer'
 
 module Calendario
   module Renderers
     # Renders a year, line by line, in a table of 3 columns by 4 rows
-    class YearRenderer
-      # The space of an empty day
-      # @return [String]
-      EMPTY_DAY_SPACES = '  '.freeze
-
+    class YearRenderer < IntervalRenderer
       # Number of month columns to display
       # @return [Integer]
       NUMBER_OF_MONTH_COLUMNS = 3
 
-      # Initializes a year renderer
-      #
-      # @api private
-      # @param [MonthRenderer] month_renderer A service to render a month line by line
-      #
-      def initialize(month_renderer = MonthRenderer.new)
-        @month_renderer = month_renderer
-      end
-
       # Formats a year, line by line, in a table of 3 columns by 4 rows
       #
       # @api private
@@ -44,22 +32,6 @@ module Calendario
 
       private
 
-      # A service to render a month line by line
-      #
-      # @api private
-      # @return [Calendario::Renderers::MonthRenderer]
-      #
-      attr_accessor :month_renderer
-
-      # Extracts a row from a group of months
-      #
-      # @api private
-      # @return [Array<String>]
-      #
-      def take_row(month_line, months)
-        months.map { |month| month[month_line] }.join(EMPTY_DAY_SPACES)
-      end
-
       # Centers the year in the middle of the calendar
       #
       # @api private
@@ -69,16 +41,6 @@ module Calendario
       def center_year_number(year)
         year.year_number.to_s.center(61)
       end
-
-      # Renders a list of months
-      #
-      # @api private
-      # @param [Array<Month>] months The list of months to be rendered
-      # @return [Array<RenderedMonth>]
-      #
-      def render_months(months)
-        months.map { |month| month_renderer.render(month) }
-      end
     end
   end
 end

data/lib/calendario/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendario
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Wilson Silva
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-28 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -290,9 +290,12 @@ files:
 - calendario.gemspec
 - lib/calendario.rb
 - lib/calendario/calendar.rb
+- lib/calendario/interval.rb
 - lib/calendario/month.rb
+- lib/calendario/rendered_interval.rb
 - lib/calendario/rendered_month.rb
 - lib/calendario/rendered_year.rb
+- lib/calendario/renderers/interval_renderer.rb
 - lib/calendario/renderers/month_renderer.rb
 - lib/calendario/renderers/year_renderer.rb
 - lib/calendario/version.rb