ruby_calendar 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6048b0b0dfc52fb9363ec4759390f68da7194378f601df9b81c2f17a18476957
-  data.tar.gz: 0b33bbd7beb16225d2808679a607ef34ccab1ee8dfe646493d6bf3b989133e21
+  metadata.gz: 7f96346081a190002a3559eea6c5f6c4c3686f52582ff8e2a34b5f384f902e03
+  data.tar.gz: d81ac7c027998558e4500d55efbb68545bf7d9478f1daf2f790ee8a733f8d212
 SHA512:
-  metadata.gz: 4dcc5f5d57e772f9baa753601ebc31976e1f1365996f81673ec370023a66a922a186d401b90be5415cd5f3af1ad0bca6c7836679d380fe4e136ca328ca94c668
-  data.tar.gz: b1b77df11e7cf6b51ff4a50d94a6663257358608df19ed5ed50f3bb897d9bb824e9736df8c99c0a9c34bc5da35fc3011c761b9b4008d492f4a9cb3827f9aad3a
+  metadata.gz: c7e5d49d0d22f0ab03e324504e970322c1811a29f5106bf39f4f3340cf31da57827db8c02ef474a1df687df45227b3827f4c3179c4a826e0caf9a6317da6e7d0
+  data.tar.gz: fb7cf0d34589dd45329078a85a369bf26b62a0b2bb2bc652d783921b24092402e6ff8dadf01049baf76801d7ec2d6f4fa39445ce89d83cb5d1e9975a9b35689c

data/.rubocop.yml

@@ -1,5 +1,46 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
-  TargetRubyVersion: 2.4
+  SuggestExtensions: false
+
+Documentation:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Description: 'Checks that `required_ruby_version` of gemspec is specified and equal to `TargetRubyVersion` of .rubocop.yml.'
+  Enabled: true
+  VersionAdded: '0.52'
+  VersionChanged: '1.22'
+  Include:
+    - '**/*.gemspec'
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/AbcSize:
+  Max: 100
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/CyclomaticComplexity:
+  Max: 15
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/AccessorMethodName:
+  Exclude:
+    - 'lib/ruby_calendar/calendar.rb'
+
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/ruby_calendar/month.rb'
+    - 'lib/ruby_calendar/year.rb'
 
 Style/StringLiterals:
   Enabled: true
@@ -9,5 +50,6 @@ Style/StringLiteralsInInterpolation:
   Enabled: true
   EnforcedStyle: double_quotes
 
-Layout/LineLength:
-  Max: 120
+Style/OptionalBooleanParameter:
+  Exclude:
+    - 'lib/ruby_calendar/calendar.rb'

data/CHANGELOG.md

@@ -1,5 +1,16 @@
-## [Unreleased]
+## [1.0.0] - 2022-1-16
 
-## [0.1.0] - 2021-09-15
+- Renewal module #4
+- Add spec, rubocop #5
+- Add GitHub workflow #6
+- Change inisialize value(calendar class) #7
+
+## [0.0.2] - 2021-10-13
+
+- Fixed gemspec #2
+- Change method #3
+- Add year method
+
+## [0.0.1] - 2021-09-15
 
 - Initial release

data/README.md

@@ -17,8 +17,8 @@ $ gem install ruby_calendar
 * Output calendars
 
 ```ruby
-calendar = RubyCalendar::Calendar.new
-puts calendar.month(2021,1)
+calendar = RubyCalendar::Calendar.new(2021, 1)
+puts calendar.month
 #     January 2021
 # Su Mo Tu We Th Fr Sa
 #                 1  2
@@ -30,36 +30,72 @@ puts calendar.month(2021,1)
 # => nil
 ```
 
-## Calendar class methods
+## Setting calendar methods
 
-### month(year, month, w=0, l=0)
+### set_year()
 
-Return a month’s calendar in a multi-line string.
-* w: it specifies the width of the date columns which are centered(default: 0).
-* l: it specifies the number of lines that each week will use(default: 0).
+It specifies the year for which the calendar is displayed.
+- default values
+  - year: Date.today.year
+  - month: Date.today.month
+  - firstweekday: 0
 
-### set_firstweekday()
+Change by giving a number to the argument.
+
+ex) 2021 -> 2022.
+```ruby
+calendar = RubyCalendar::Calendar.new(2021, 1)
+# => #<RubyCalendar::Calendar:0x00007f9a58161788 @year=2021, @month=1, @firstweekday=0>
+calendar.set_year(2022)
+# => #<RubyCalendar::Calendar:0x00007f9a58161788 @year=2022, @month=1, @firstweekday=0>
+```
 
+### set_month()
 
-* it set the first day of the week to Monday(1) or to any other weekday.
+It specifies the month to display(month method) the monthly calendar(default: January).
+Change by giving a number to the argument.
 
+ex) 1(January) -> 1(December).
 ```ruby
-# at initialization 0(Sunday).
-calendar = RubyCalendar::Calendar.new
-# => #<RubyCalendar::Calendar:0x00007fd334b9c0d0 @firstweekday=0>
+calendar = RubyCalendar::Calendar.new(2021, 1)
+# => #<RubyCalendar::Calendar:0x00007f9a58161788 @year=2021, @month=1, @firstweekday=0>
+calendar.set_month(12)
+# => #<RubyCalendar::Calendar:0x00007f9a58149598 @year=2021, @month=12, @firstweekday=0>
+```
 
-calendar.set_firstweekday(1) # set the first day of the week to Monday
-puts calendar.month(2021,1)
-#     January 2021
-# Mo Tu We Th Fr Sa Su
-#              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
-=> nil
+### set_firstweekday()
+
+It specifies the beginning of the week(default: Sunday).
+Change by giving a number to the argument.
+
+ex) 0(Sunday) -> 1(Monday).
+```ruby
+calendar = RubyCalendar::Calendar.new(2021, 1)
+# => #<RubyCalendar::Calendar:0x00007f9a58132460 @year=2021, @month=1, @firstweekday=0>
+calendar.set_firstweekday(1)
+# => #<RubyCalendar::Calendar:0x00007f9a58132460 @year=2021, @month=1, @firstweekday=1>
 ```
 
+## Output calendar methods
+
+### month(year, month, w:0, l:0)
+
+Return a month’s calendar in a multi-line string.
+
+- The following keyword arguments can be used.
+  - w: it specifies the width of the date columns which are centered(default: 0).
+  - l: it specifies the number of lines that each week will use(default: 0).
+
+### year(year, w:0, l:0, c:6, m:3)
+
+Return a year’s calendar in a multi-line string.
+
+- The following keyword arguments can be used.
+  - w: it specifies the width of the date columns which are centered(default: 0).
+  - l: it specifies the number of lines that each week will use(default: 0).
+  - c: it specifies the monthly calendar interval(default: 6).
+  - m: it specifies the number of months to display on one line(default: 3).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby_calendar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/saku888/ruby-calendar/blob/master/CODE_OF_CONDUCT.md).

data/lib/ruby_calendar/calendar.rb

@@ -1,82 +1,49 @@
+# frozen_string_literal: true
+
+require "ruby_calendar/month"
+require "ruby_calendar/year"
+
 module RubyCalendar
   class Calendar
+    include RubyCalendar::Month
+    include RubyCalendar::Year
+
     attr_accessor :firstweekday
 
     WEEK_DAY_NAME = %w[Sunday Monday Tuesday Wednesday Thursday Friday Saturday].freeze
-    MONTH_NAMES = %w[January February March April May June July August September October November December].freeze
 
-    def initialize
-      @firstweekday = 0
+    def initialize(year = today_year, month = today_month, firstweekday: 0)
+      @year = year
+      @month = month
+      @firstweekday = firstweekday
     end
 
-    def set_firstweekday(firstweekday)
-      @firstweekday = firstweekday
+    def set_year(year)
+      @year = year
+      self
     end
 
-    def month(year, month, w=0, l=0)
-      w = [2, w].max
-      l = [1, l].max
-      s = format_month_name(year, month, 7*(w+1)-1)
-      s = s.rstrip
-      s += "\n" * l
-      s += format_week_header(w).rstrip
-      s += "\n" * l
-      month_days_calendar(year, month).each_slice(7).to_a.each do |week|
-        s += format_week_name(week, w).rstrip
-        s += "\n" * l
-      end
-      s
+    def set_month(month)
+      @month = month
+      self
     end
 
-    def calendar(year, w=2, l=1, c=6, m=3)
-      w = [2, w].max
-      l = [1, l].max
-      c = [2, c].max
-      colwidth = 7*(w+1)-1
-      a = []
-      a.push(year.to_s.center(colwidth*m+c*(m-1)).rstrip)
-      a.push("\n"*l)
-      header = format_week_header(w)
-      MONTH_NAMES.each_slice(m).to_a.each do |months|
-        a.push(months.map{|month| format_month_name(year, month_to_i(month), colwidth, false) << (' '*c)}.join.rstrip)
-        a.push("\n"*l)
-        a.push(months.map{format_week_header(w) << (' '*c)}.join.rstrip)
-        a.push("\n"*l)
-        month_array = months.map{|month| month_days_calendar(year, month_to_i(month))}
-        slice_month_array = month_array.map{|array| array.each_slice(7).to_a}
-        max_element_count = slice_month_array.map{|array| array.length}.max - 1
-        replace_array = []
-        for num in 0..max_element_count do
-          replace_array.push(slice_month_array.map {|array| array[num].nil? ? [] : array[num]})
-        end
-        replace_array.each do |weeks|
-          a.push(weeks.map{|week| format_week_name(week, w) << (' '*c)}.join.rstrip)
-          a.push("\n"*l)
-        end
-      end
-      a
+    def set_firstweekday(firstweekday)
+      @firstweekday = firstweekday
+      self
     end
 
     private
 
-    def month_to_i(month)
-      MONTH_NAMES.index(month)+1
-    end
-
-    def localized_day(format)
-      days = []
-      for i in 1..7 do
-        days << (Date.new(2001,1,i).strftime(format))
-      end
-      days
+    def today_year
+      Date.today.year
     end
 
-    def format_day(day, width)
-      s = day.zero? ? '' : day.to_s.rjust(2)
-      s.center(width)
+    def today_month
+      Date.today.month
     end
 
-    def format_month_name(year, month, width, withyear=true)
+    def format_month_name(year, month, width, withyear = true)
       if withyear
         Date.new(year, month).strftime("%B #{year}").center(width)
       else
@@ -85,34 +52,39 @@ module RubyCalendar
     end
 
     def format_week_header(width)
-      format_week_day(width).map{|day| day.center(width) }.join(' ')
+      format_week_day(width).map { |day| day.center(width) }.join(" ")
     end
 
-    def format_week_day(width)
-      names = WEEK_DAY_NAME.rotate(@firstweekday)
-      if width >= 9
-        names
+    def format_week_name(week, width)
+      if week.empty?
+        Array.new(7) { 0 }.map { |day| format_day(day, width) }.join(" ")
       else
-        names.map{|name| name.slice(0, [3, width].min)} if width < 9
+        week.map { |day| format_day(day, width) }.join(" ")
       end
     end
 
+    def format_day(day, width)
+      s = day.zero? ? "" : day.to_s.rjust(2)
+      s.center(width)
+    end
+
     def month_days_calendar(year, month)
       firstday_wday = (Date.new(year, month, 1).wday - @firstweekday) % 7
       lastday_date = Date.new(year, month, -1).day
       lastday_wday = (6 + @firstweekday - Date.new(year, month, -1).wday) % 7
 
-      days = Array.new(firstday_wday){0}
+      days = Array.new(firstday_wday) { 0 }
       days.push(*1..lastday_date)
-      lastday_wday.times{ days.push(0) }
+      lastday_wday.times { days.push(0) }
       days
     end
 
-    def format_week_name(week, width)
-      if week.empty?
-        Array.new(7){0}.map{|day| format_day(day, width)}.join(' ')
+    def format_week_day(width)
+      names = WEEK_DAY_NAME.rotate(@firstweekday)
+      if width >= 9
+        names
       else
-        week.map{|day| format_day(day, width)}.join(' ')
+        names.map { |name| name.slice(0, [3, width].min) }
       end
     end
   end

data/lib/ruby_calendar/month.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RubyCalendar
+  module Month
+    def month(year = @year, month = @month, w: 0, l: 0)
+      w = [2, w].max
+      l = [1, l].max
+      s = format_month_name(year, month, 7 * (w + 1) - 1)
+      s = s.rstrip
+      s += "\n" * l
+      s += format_week_header(w).rstrip
+      s += "\n" * l
+      month_days_calendar(year, month).each_slice(7).to_a.each do |week|
+        s += format_week_name(week, w).rstrip
+        s += "\n" * l
+      end
+      s
+    end
+  end
+end

data/lib/ruby_calendar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyCalendar
-  VERSION = "0.0.2"
+  VERSION = "1.0.0"
 end

data/lib/ruby_calendar/year.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RubyCalendar
+  module Year
+    MONTH_NAMES = %w[January February March April May June July August September October November December].freeze
+
+    def year(year = @year, w: 2, l: 1, c: 6, m: 3)
+      w = [2, w].max
+      l = [1, l].max
+      c = [2, c].max
+      colwidth = 7 * (w + 1) - 1
+      calendar = []
+      calendar.push(year.to_s.center(colwidth * m + c * (m - 1)).rstrip)
+      calendar.push("\n" * l)
+      MONTH_NAMES.each_slice(m).to_a.each do |months|
+        calendar.push(months.map do |month|
+                        format_month_name(year, month_to_i(month), colwidth, false) << (" " * c)
+                      end.join.rstrip)
+        calendar.push("\n" * l)
+        calendar.push(months.map { format_week_header(w) << (" " * c) }.join.rstrip)
+        calendar.push("\n" * l)
+        month_array = months.map { |month| month_days_calendar(year, month_to_i(month)) }
+        slice_month_array = month_array.map { |array| array.each_slice(7).to_a }
+        max_element_count = slice_month_array.map(&:length).max - 1
+        replace_array = []
+        (0..max_element_count).each do |num|
+          replace_array.push(slice_month_array.map { |array| array[num].nil? ? [] : array[num] })
+        end
+        replace_array.each do |weeks|
+          calendar.push(weeks.map { |week| format_week_name(week, w) << (" " * c) }.join.rstrip)
+          calendar.push("\n" * l)
+        end
+      end
+      calendar.join.to_s
+    end
+
+    private
+
+    def month_to_i(month)
+      MONTH_NAMES.index(month) + 1
+    end
+  end
+end

data/lib/ruby_calendar.rb

@@ -1,6 +1,8 @@
-require 'date'
-require 'ruby_calendar/calendar'
-require 'ruby_calendar/version'
+# frozen_string_literal: true
+
+require "date"
+require "ruby_calendar/calendar"
+require "ruby_calendar/version"
 
 module RubyCalendar
   class Error < StandardError; end

data/ruby_calendar.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["saku888"]
   spec.email         = ["sakura.orn888@gmail.com"]
 
-  spec.summary       = %q{This is a calender of gem}
-  spec.description   = %q{This gem produces a calendar output similar to the Unix cal program}
+  spec.summary       = "This is a calender of gem"
+  spec.description   = "This gem produces a calendar output similar to the Unix cal program"
   spec.homepage      = "https://github.com/saku888/ruby-calendar"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.5.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
   spec.metadata["homepage_uri"] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_calendar
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - saku888
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-13 00:00:00.000000000 Z
+date: 2022-01-16 00:00:00.000000000 Z
 dependencies: []
 description: This gem produces a calendar output similar to the Unix cal program
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -30,7 +31,9 @@ files:
 - bin/setup
 - lib/ruby_calendar.rb
 - lib/ruby_calendar/calendar.rb
+- lib/ruby_calendar/month.rb
 - lib/ruby_calendar/version.rb
+- lib/ruby_calendar/year.rb
 - ruby_calendar.gemspec
 homepage: https://github.com/saku888/ruby-calendar
 licenses:
@@ -48,7 +51,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="