koyomi 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2424c6cda5e48fb64ecee69b6fb8b292b0a13e3a
-  data.tar.gz: b21e94aff1c9fe720a79ce9bd7bd076d679749d3
+  metadata.gz: 8ae7adb3bc47e5ebb1cea544a321182ab5106fb1
+  data.tar.gz: 6638ed782cae88821e1ba1fb6b18b518759e0d93
 SHA512:
-  metadata.gz: da9ef2356634f30e02edd0794a6e12d0a3ca0c762611a2a4aae879755f85849a57141c3e53def14b6293289cd6ddc112b3bad36aa68e5f4c8a81860f9c14f389
-  data.tar.gz: a90d16687d127b8182c082859e8ad78e30c5c97227a80de6d03bf7ca93ba69e15b886c4ceae56b3682129db01a9f6b168230e1e2955085289a85c942c88e6526
+  metadata.gz: d045c99a50eb34a4cf763cbb7df3b1d30eba817ed69f807f0866ee762a1688ab9ca62da43fa0051f8888d0845f425237484a458cae20aed3fc1f5aa8bd51eb19
+  data.tar.gz: 0d8ff0eb4086862779caa7fefe8df57574273ee906a5ad5ed48c92c00529e1561f79f965c308af708f2037ed6cbdabda5281ace1964d4efb7e1998f5da89d9db

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 vendor/bundle
 log
 log/*.log
+Gemfile.lock

data/README.md

@@ -18,64 +18,60 @@ Or install it yourself as:
 
 ## Usage
 
-Handling calendar by this gem.
-
-(japanese) カレンダーを取り扱うための gem です。
-
-	require "koyomi"
-	cal = Koyomi::Calendar.new(2012, 12, :mon)
-	cal.first.to_s # => "2012-11-26"
-
-	cal.first.week_end? # => false
-	cal.first.week_end?(:tue) # => true
-
-	month = cal.the_month
-	month.first.to_s # => "2012-12-01"
-
-	week = Koyomi::Week.new(month.first, :tue)
-	week.first.to_s # => "2012-11-27"
-
-	# weeks and week days.
-
-	# nth week day.
-	#
-	# Version 0.0.5 or later, NOT compatible version 0.0.4.x.
-	# To get version 0.0.4 compatible result, use Koyomi::Month#nth_wday.
-	#
-	# (japanese)
-	# バージョン 0.0.5 以上では、バージョン 0.0.4.x と互換性がありません。
-	# 以前のバージョンと同様の結果を得るためには、 Koyomi::Month#nth_wday メソッドを利用して下さい。
-	#
-	cal.nth_wday(1, :sat).to_s
-	# => "2012-12-01"
-	cal.nth_wday(1, :tue).to_s
-	# => "2012-11-27"
-	cal.the_month.nth_wday(1, :tue).to_s
-	# => "2012-12-04"
-
-	# cycle: every monday.
-	# (japanese) 周期：毎週月曜
-	cal.cycles(:every, :mon).collect { |d| d.to_s }
-	# => ["2012-11-26", "2012-12-03", "2012-12-10", "2012-12-17", "2012-12-24", "2012-12-31"]
-	#
-	# Version 0.0.5 or later, NOT compatible version 0.0.4.x.
-	# To get version 0.0.4 compatible result, use Koyomi::Month#cycles.
-	#
-	# (japanese)
-	# バージョン 0.0.5 以上では、バージョン 0.0.4.x と互換性がありません。
-	# 以前のバージョンと同様の結果を得るためには、 Koyomi::Month#cycles メソッドを利用して下さい。
-	#
-	cal.the_month.cycles(:every, :mon).collect { |d| d.to_s }
-	# => ["2012-12-03", "2012-12-10", "2012-12-17", "2012-12-24", "2012-12-31"]
-
-	# cycle: 1st, 3rd week's tuesday or friday.
-	# (japanese) 周期：第１、第３の火曜と金曜
-	#
-	cal.cycles([1, 3], [:tue, :fri]).collect { |d| d.to_s }
-	# => ["2012-11-27", "2012-11-30", "2012-12-11", "2012-12-14"]
-	cal.the_month.cycles([1, 3], [:tue, :fri]).collect { |d| d.to_s }
-	# => ["2012-12-04", "2012-12-07", "2012-12-18", "2012-12-21"]
+``` ruby
+require "koyomi"
 
+## Koyomi::Calendar
+cal = Koyomi::Calendar.new(2015, 12, :mon)
+# The calendar starts monday.
+# 30  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  1  2  3
+
+cal.first.class
+# => Date
+
+cal.first.week_end?
+# => false
+
+cal.first.week_end?(:tue)
+# => true
+
+cal.first.to_s
+# => "2015-11-30"
+
+cal.range.first.to_s
+# => "2015-11-30"
+
+cal.range.last.to_s
+# => "2016-01-03"
+
+## Koyomi::Month
+month = cal.the_month
+# The month
+#     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
+
+month.first.class
+# => Date
+
+month.first.to_s
+# => "2015-12-01"
+
+## searching dates
+cal.nth_wday(1, :mon)
+# => #<Date: 2015-11-30 ((2457357j,0s,0n),+0s,2299161j)>
+month.nth_wday(1, :mon)
+# => #<Date: 2015-12-07 ((2457364j,0s,0n),+0s,2299161j)>
+
+```
+
+Some examples in [Wiki](wiki/examples).
 
 ## Contributing
 

data/lib/koyomi/calendar.rb

@@ -18,7 +18,7 @@ class Koyomi::Calendar < Koyomi::Period
 
   #--------------------#
   # instance methods
-  attr_accessor :week_start
+  attr_reader :week_start
   attr_reader :year, :month, :koyomi_month
   attr_reader :weeks
 
@@ -28,19 +28,14 @@ class Koyomi::Calendar < Koyomi::Period
   # @param  [Integer] month optional, use instance create date.
   # @param  [Object] week_start weekday which week starts with. optional, use DEFAULT_WEEK_START.
   def initialize(year = nil, month = nil, week_start = Koyomi::Week::DEFAULT_START)
-    super()
-    self.year = year||self.created_at.year
-    self.month = month||self.created_at.month
-    self.koyomi_month = Koyomi::Month.new(self.month, self.year)
-    self.week_start = week_start
-  end
-
-  # set week_start
-  #
-  # @param  [Object]  value
-  def week_start=(value)
-    self.setup_week_start(value)
-    @week_start
+    _today = Date.today
+    @year = year||_today.year
+    @month = month||_today.month
+    @koyomi_month = Koyomi::Month.new(@month, @year)
+    
+    _week = Koyomi::Week.new(@koyomi_month.first, @week_start)
+    super(_week.first, _week.last)
+    setup_week_start(week_start)
   end
 
   # first date of the calendar (NOT first date of the MONTH)
@@ -57,11 +52,12 @@ class Koyomi::Calendar < Koyomi::Period
     Koyomi::Week.new(self.koyomi_month.last, self.week_start).last
   end
 
-  # range of the calendar.
+  # set week_start
   #
-  # @return [Range]
-  def range
-    Range.new(self.first, self.last)
+  # @param  [Object]  value
+  def week_start=(value)
+    setup_week_start(value)
+    @week_start
   end
 
   # Koyomi::Month of the calendar's month.
@@ -109,12 +105,15 @@ class Koyomi::Calendar < Koyomi::Period
 
   attr_writer :year, :month, :koyomi_month
 
+  #--------------------#
+  private
+
   # setup week start
   #
   # @param  [Object]  value
   def setup_week_start(value)
     @week_start = self.class.windex(value)
-    self.setup_weeks(@week_start)
+    setup_weeks(@week_start)
   end
 
   # setup weeks of the calendar.
@@ -132,9 +131,6 @@ class Koyomi::Calendar < Koyomi::Period
     @weeks
   end
 
-  #--------------------#
-  private
-
   # cycle weeks filter
   #
   # @param  [Object]  weeks

data/lib/koyomi/month.rb

@@ -15,11 +15,27 @@ class Koyomi::Month < Koyomi::Period
     self.new(date.month, date.year)
   end
 
+  # a date next month of the date
+  #
+  # @param  [Date]  date
+  # @return [Date]
+  def self.a_date_of_next_month(date)
+    date + 32
+  end
+
+  # first date of next month
+  #
+  # @param  [Date]  date
+  # @return [Date]
+  def self.first_date_of_next_month(date)
+    a_date = self.a_date_of_next_month(date)
+    Date.new(a_date.year, a_date.month, 1)
+  end
+
   #--------------------#
   # instance methods
 
   attr_reader :year, :month
-  attr_reader :first, :last
 
   # initialize instance.
   #
@@ -27,11 +43,10 @@ class Koyomi::Month < Koyomi::Period
   # @param  [Integer] year  optional, default use the year of instance created.
   def initialize(month = nil, year = nil)
     super()
-    @year   = year||self.created_at.year
-    @month  = month||self.created_at.month
-    @first  = Date.new(self.year, self.month, 1)
-    @last   = (first_date_of_next_month - 1)
-    @range  = Range.new(self.first, self.last)
+    @year   = year||created_at.year
+    @month  = month||created_at.month
+    @first  = Date.new(@year, @month, 1)
+    @last   = (self.class.first_date_of_next_month(@first) - 1)
   end
 
   # next month
@@ -164,23 +179,6 @@ class Koyomi::Month < Koyomi::Period
     _weeks
   end
 
-  # a date next month of the date
-  #
-  # @param  [Date]  date
-  # @return [Date]
-  def a_date_of_next_month
-    self.first + 32
-  end
-
-  # first date of next month
-  #
-  # @param  [Date]  date
-  # @return [Date]
-  def first_date_of_next_month
-    a_date = a_date_of_next_month
-    Date.new(a_date.year, a_date.month, 1)
-  end
-
   # maximumn of weeks
   #
   # @return [Integer]

data/lib/koyomi/period.rb

@@ -3,25 +3,27 @@
 require "date"
 
 class Koyomi::Period
-  attr_reader :range
-  
+  attr_reader :first, :last
+
   #--------------------#
   # instance methods
-  
-  def initialize
+
+  def initialize(first = nil, last = nil)
     super()
-    self.created_at = Date.today
+    @created_at = Date.today
+    @first = first||@created_at
+    @last = last||@created_at
   end
-  
-  #--------------------#
-  protected
-  
-  attr_accessor :created_at
-  attr_writer :range
-  
+
+  def range
+    (first .. last)
+  end
+
   #--------------------#
   private
-  
+
+  attr_reader :created_at
+
   # throw uniplemeted method to self range.
   def method_missing(name, *args, &block)
     begin
@@ -30,4 +32,4 @@ class Koyomi::Period
       super
     end
   end
-end
+end

data/lib/koyomi/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Koyomi
-  VERSION = "0.2.0"
+  VERSION = "0.2.2"
 end

data/lib/koyomi/week.rb

@@ -73,8 +73,8 @@ class Koyomi::Week < Koyomi::Period
   # @param  [Object]  start_wday  optionail, default use Koyomi::Week::DEFAULT_START
   def initialize(date = nil, start_wday = DEFAULT_START)
     super()
-    self.date = date||self.created_at
-    self.start_wday = start_wday
+    @start_wday = start_wday
+    setup_range(date||created_at)
   end
 
   # sepified week day
@@ -84,48 +84,27 @@ class Koyomi::Week < Koyomi::Period
   def wday(wday_name)
     diff = self.class.windex(wday_name) - self.class.windex(self.start_wday)
     factor = diff + ((diff < 0) ? DAYS : 0)
-    self.range.first + factor
+    first + factor
   end
 
-  # start date
-  #
-  # @return [Date]  date
-  def starts
-    self.range.first
-  end
-
-  # end date
-  #
-  # @return [Date]  date
-  def ends
-    self.range.last
-  end
+  alias_method :starts, :first
+  alias_method :ends,   :last
 
   #--------------------#
   protected
 
-  attr_accessor :date
   attr_reader :start_wday
 
-  # set week starts
-  #
-  # @param  [Object]  value
-  def start_wday=(value)
-    @start_wday = value
-    self.setup_range
-    @start_wday
-  end
+  #--------------------#
+  private
 
   # setup week range with given week start
-  def setup_range
-    diff = self.date.wday - self.class.windex(self.start_wday)
-    starts = self.date - (diff + ((diff < 0) ? DAYS : 0))
-    @range = Range.new(starts, starts + DAYS - 1)
+  def setup_range(date)
+    diff = date.wday - self.class.windex(start_wday)
+    @first  = date - (diff + ((diff < 0) ? DAYS : 0))
+    @last   = @first + DAYS - 1
   end
 
-  #--------------------#
-  private
-
   def method_missing(name, *args, &block)
     case
     when WDAYS.include?(name.to_s.to_sym)

data/lib/koyomi/year.rb

@@ -18,7 +18,6 @@ class Koyomi::Year < Koyomi::Period
   # instance methods
 
   attr_reader :year
-  attr_reader :first, :last
 
   # initialize instance.
   #
@@ -28,7 +27,6 @@ class Koyomi::Year < Koyomi::Period
     @year   = year||created_at.year
     @first  = Date.new(@year,  1,  1)
     @last   = Date.new(@year, 12, 31)
-    @range  = (@first .. @last)
   end
 
   (1..12).each do |m|

data/spec/lib/koyomi/calendar_spec.rb

@@ -12,6 +12,13 @@ describe Koyomi::Calendar do
     its(:month) { is_expected.to eq date.month }
   end
 
+  context "initialized with 2015-12-01, week start monday." do
+    subject { described_class.new(*given) }
+    let(:given) { [2015, 12, :mon] }
+    its(:first) { is_expected.to eq Date.new(2015, 11, 30) }
+    its(:last)  { is_expected.to eq Date.new(2016,  1,  3) }
+  end
+
   describe "#koyomi_month" do
     subject { calendar.koyomi_month }
 

data/spec/lib/koyomi/month_spec.rb

@@ -1,8 +1,9 @@
 require "koyomi_helper"
 
 describe Koyomi::Month do
-  let(:month) { described_class.new(today.month, today.year) }
+  let(:month) { described_class.new(date.month, date.year) }
   let!(:today) { Date.today }
+  let(:date) { today }
 
   describe "#range" do
     subject { month.range }

data/spec/lib/koyomi/period_spec.rb

@@ -0,0 +1,37 @@
+require "koyomi_helper"
+
+describe Koyomi::Period do
+  let(:period) { described_class.new(*initialize_with) }
+
+  describe ".new" do
+    subject { period }
+
+    context "no arguments given" do
+      let(:initialize_with) { nil }
+      it { expect { subject }.not_to raise_error }
+
+      describe "#range" do
+        subject{ period.range }
+        its("count") { is_expected.to eq 1 }
+        its("first") { is_expected.to be_kind_of Date}
+      end
+    end
+
+    context "first and last given" do
+      let(:initialize_with) { [Date.new(2015, 12, 1), Date.new(2015, 12, 31)] }
+      it { expect { subject }.not_to raise_error }
+    end
+  end
+
+  context "initialized normaly" do
+    let(:initialize_with) { [first, last] }
+    let(:first) { Date.new(2015, 12, 1) }
+    let(:last)  { Date.new(2015, 12, 31) }
+
+    describe "#range" do
+      subject { period.range }
+      its("first")  { is_expected.to eq first }
+      its("last")   { is_expected.to eq last }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: koyomi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.2
 platform: ruby
 authors:
 - sekizo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2015-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -63,7 +63,6 @@ files:
 - ".rspec"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
@@ -90,6 +89,7 @@ files:
 - spec/lib/koyomi/date_spec.rb
 - spec/lib/koyomi/month_cycle_spec.rb
 - spec/lib/koyomi/month_spec.rb
+- spec/lib/koyomi/period_spec.rb
 - spec/lib/koyomi/version_spec.rb
 - spec/lib/koyomi/week_spec.rb
 - spec/lib/koyomi/year_spec.rb
@@ -126,6 +126,7 @@ test_files:
 - spec/lib/koyomi/date_spec.rb
 - spec/lib/koyomi/month_cycle_spec.rb
 - spec/lib/koyomi/month_spec.rb
+- spec/lib/koyomi/period_spec.rb
 - spec/lib/koyomi/version_spec.rb
 - spec/lib/koyomi/week_spec.rb
 - spec/lib/koyomi/year_spec.rb

data/Gemfile.lock

@@ -1,73 +0,0 @@
-PATH
-  remote: .
-  specs:
-    koyomi (0.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.0)
-    diff-lcs (1.2.5)
-    ffi (1.9.10)
-    formatador (0.2.5)
-    guard (2.13.0)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, <= 4.0)
-      lumberjack (~> 1.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.6.4)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    listen (3.0.4)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.9)
-    method_source (0.8.2)
-    nenv (0.2.0)
-    notiffany (0.0.8)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rb-fsevent (0.9.6)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.0)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-its (1.2.0)
-      rspec-core (>= 3.0.0)
-      rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.0)
-    shellany (0.0.1)
-    slop (3.6.0)
-    thor (0.19.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  guard-rspec
-  koyomi!
-  rspec
-  rspec-its
-
-BUNDLED WITH
-   1.10.6