koyomi 0.0.2.2 → 0.0.3

data/README.md

@@ -1,6 +1,6 @@
 # Koyomi
 
-TODO: Write a gem description
+Extends Date class to handling with calendar.
 
 ## Installation
 
@@ -18,7 +18,20 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Handling calendar by this gem.
+
+	require "koyomi"
+	cal = Koyomi::Calendar.new(2012, 12, :mon)
+	cal.first.to_s # => "2012-11-26"
+	
+	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"
+	
+	cal.first.week_end? # => false
+	cal.first.week_end?(:tue) # => true
 
 ## Contributing
 

data/Rakefile

@@ -1,9 +1,21 @@
+# encoding: utf-8
 require "bundler/gem_tasks"
+require "rake/testtask"
 
 $: << File.expand_path("../lib", __FILE__)
 
-desc "Test units"
-task :test do |t|
-  require File.expand_path("../test/init", __FILE__)
-  require File.expand_path("../test/units", __FILE__)
+task :default do
+  sh "rake -T"
 end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+namespace :test do
+  Rake::TestTask.new(:units) do |t|
+    t.libs << "test"
+    t.test_files = FileList["test/units/**/test_*.rb"]
+  end
+end

data/koyomi.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{Extends Date class to handling with calendar.}
   gem.summary       = %q{Add some classes to handle year, month, period.}
   gem.homepage      = ""
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/koyomi.rb

@@ -5,6 +5,7 @@ require "koyomi/version"
 
 require "koyomi/period"
 require "koyomi/month"
+require "koyomi/week"
 require "koyomi/calendar"
 require "koyomi/helper"
 

data/lib/koyomi/calendar.rb

@@ -2,17 +2,10 @@
 
 require "koyomi/period"
 require "koyomi/month"
+require "koyomi/helper/week"
 
 class Koyomi::Calendar < Koyomi::Period
-  #--------------------#
-  # constant
-  DEFAULT_WEEK_START = :mon
-  WEEK_DAYS = 7
-  WEEK_START_RANGE = (0..6)
-  WEEK_START_STRING = [:sun, :mon, :tue, :wed, :thu, :fri, :sat]
-  
-  #--------------------#
-  # class methods
+  include Koyomi::Helper::Week
   
   # create Koyomi::Calendar instance from date.
   #
@@ -23,35 +16,6 @@ class Koyomi::Calendar < Koyomi::Period
     self.new(date.year, date.month, week_start)
   end
   
-  # week index
-  #
-  # @param  [Object]  value
-  # @return [Integer]
-  def self.windex(value)
-    case value
-    when Numeric
-      index = value
-    when Date
-      index = value.wday
-    when String, Symbol
-      value = value.to_s.downcase[0, 3].to_sym
-      raise "Range invalid, required #{WEEK_START_STRING}." unless WEEK_START_STRING.include?(value)
-      index = WEEK_START_STRING.index(value)
-    else
-      index = value.to_s.to_i
-    end
-    raise "Range overflow, required (#{WEEK_START_RANGE})." unless WEEK_START_RANGE.cover?(index)
-    index
-  end
-  
-  # week label
-  #
-  # @param  [Object]  value
-  # @return [Symbol]
-  def self.wlabel(value)
-    WEEK_START_STRING.at(self.windex(value))
-  end
-  
   #--------------------#
   # instance methods
   attr_reader :year, :month, :koyomi_month
@@ -82,14 +46,14 @@ class Koyomi::Calendar < Koyomi::Period
   #
   # @return [Date]
   def first
-    week_starts(self.koyomi_month.first, self.week_start)
+    Koyomi::Week.new(self.koyomi_month.first, self.week_start).first
   end
   
   # last date of the calendar (NOT last date of the MONTH)
   #
   # @return [Date]
   def last
-    week_ends(self.koyomi_month.last, self.week_start)
+    Koyomi::Week.new(self.koyomi_month.last, self.week_start).last
   end
   
   # range of the calendar.
@@ -110,27 +74,4 @@ class Koyomi::Calendar < Koyomi::Period
   protected
   
   attr_writer :year, :month, :koyomi_month
-  
-  #--------------------#
-  private
-  
-  # week start date
-  #
-  # @param  [Date]  date
-  # @param  [Object]  week_start
-  # @return [Date]
-  def week_starts(date, week_start = nil)
-    week_start ||= self.week_start
-    diff = date.wday - self.class.windex(week_start)
-    date - diff - (diff < 0 ? WEEK_DAYS : 0)
-  end
-  
-  # week end date
-  #
-  # @param  [Date]  date
-  # @param  [Object]  week_start
-  # @return [Date]
-  def week_ends(date, week_start = nil)
-    week_starts(date, week_start) + WEEK_DAYS - 1
-  end
 end

data/lib/koyomi/helper.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 
 require "koyomi/helper/init"
+require "koyomi/helper/week"
 require "koyomi/helper/date"
 
 module Koyomi::Helper

data/lib/koyomi/helper/date.rb

@@ -1,28 +1,31 @@
 # encoding: utf-8
 
 require "date"
-require "koyomi/calendar"
-
-module Koyomi::Helper::Date
-  # check week end?
-  #
-  # @param  [Date]  date
-  # @param  [Object]  week_start
-  # @return [Boolean]
-  def week_ends?(date, week_start = nil)
-    week_start ||= Koyomi::Calendar::DEFAULT_WEEK_START
-    (date + 1).wday == Koyomi::Calendar.windex(week_start)
-  end
-end
+require "koyomi/helper/init"
+require "koyomi/helper/week"
 
 class Date
-  include Koyomi::Helper::Date
+  include Koyomi::Helper::Week
   
   # check week end?
   #
   # @param  [Object]  week_start
   # @return [Boolean]
   def week_end?(week_start = nil)
-    week_ends?(self, week_start)
+    self.class.week_ends?(self, week_start)
+  end
+  
+  # week day index
+  #
+  # @return [Integer]
+  def windex
+    self.class.windex(self)
+  end
+  
+  # week day name
+  #
+  # @return [Symbol]
+  def wday_name
+    self.class.wday_name(self)
   end
 end

data/lib/koyomi/helper/week.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require "koyomi/helper/init"
+require "koyomi/week"
+
+module Koyomi::Helper::Week
+  DEFAULT_WEEK_START = Koyomi::Week::DEFAULT_START
+  WEEK_WDAYS = Koyomi::Week::WDAYS
+  WEEK_DAYS = Koyomi::Week::DAYS
+  WEEK_START_RANGE = Koyomi::Week::START_RANGE
+  
+  def self.included(mod)
+    mod.class_eval do
+      extend Koyomi::Helper::Week::ClassMethod
+    end
+  end
+  
+  module ClassMethod
+    # week index
+    #
+    # @param  [Object]  value
+    # @return [Integer]
+    def windex(value)
+      Koyomi::Week.windex(value)
+    end
+    
+    # week day name
+    #
+    # @param  [Object]  value
+    # @return [Symbol]
+    def wday_name(value)
+      Koyomi::Week.wday_name(value)
+    end
+    
+    # week end?
+    #
+    # @param  [Date]  date
+    # @param  [Object]  week_start  week start
+    # @return [Boolean]
+    def week_ends?(date, week_start = nil)
+      Koyomi::Week.ends?(date, week_start)
+    end
+  end
+end

data/lib/koyomi/version.rb

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

data/lib/koyomi/week.rb

@@ -0,0 +1,139 @@
+# encoding: utf-8
+
+require "koyomi/period"
+
+class Koyomi::Week < Koyomi::Period
+  #--------------------#
+  # constants
+  
+  DEFAULT_START = :mon
+  WDAYS = [:sun, :mon, :tue, :wed, :thu, :fri, :sat]
+  DAYS = WDAYS.size
+  START_RANGE = (0..(DAYS - 1))
+  
+  #--------------------#
+  # attributes
+  
+  #--------------------#
+  # class methods
+  
+  # week index
+  #
+  # @param  [Object]  value
+  # @return [Integer]
+  def self.windex(value)
+    case value
+    when Numeric
+      index = value
+    when Date
+      index = value.wday
+    when String, Symbol
+      value = value.to_s.downcase[0, 3].to_sym
+      raise "Range invalid, required #{WDAYS}." unless WDAYS.include?(value)
+      index = WDAYS.index(value)
+    else
+      index = value.to_s.to_i
+    end
+    raise "Range overflow, required (#{START_RANGE})." unless START_RANGE.cover?(index)
+    index
+  end
+  
+  # week day name
+  #
+  # @param  [Object]  value
+  # @return [Symbol]
+  def self.wday_name(value)
+    WDAYS.at(self.windex(value))
+  end
+  
+  # week starts?
+  #
+  # @param  [Date]  date
+  # @param  [Object]  start_wday  week start
+  # @return [Boolean]
+  def self.starts?(date, start_wday = nil)
+    start_wday ||= DEFAULT_START
+    (date).wday == self.windex(start_wday)
+  end
+  
+  # week end?
+  #
+  # @param  [Date]  date
+  # @param  [Object]  start_wday  week start
+  # @return [Boolean]
+  def self.ends?(date, start_wday = nil)
+    start_wday ||= DEFAULT_START
+    (date + 1).wday == self.windex(start_wday)
+  end
+  
+  #--------------------#
+  # instance methods
+  
+  # initialize method
+  #
+  # @param  [Date]  date optional, default use Date.today.
+  # @param  [Object]  start_wday  optionail, default use Koyomi::Week::DEFAULT_START
+  def initialize(date = nil, start_wday = nil)
+    super()
+    self.date = date||self.created_at
+    self.start_wday = start_wday||DEFAULT_START
+  end
+  
+  # sepified week day
+  #
+  # @param  [Object]  wday_name
+  # @return [Date]
+  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
+  end
+  
+  # start date
+  #
+  # @return [Date]  date
+  def starts
+    self.range.first
+  end
+  
+  # end date
+  #
+  # @return [Date]  date
+  def ends
+    self.range.last
+  end
+  
+  #--------------------#
+  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
+  
+  # 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)
+  end
+  
+  #--------------------#
+  private
+  
+  def method_missing(name, *args, &block)
+    case
+    when WDAYS.include?(name.to_s.to_sym)
+      self.wday(name,*args, &block)
+    else
+      super
+    end
+  end
+end

data/test/{init.rb → test_helper.rb}

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
-require "test/unit"
 require "shoulda"
-
-$: << File.expand_path("../test", __FILE__)
 require File.expand_path("../../lib/koyomi", __FILE__)
+
+require "test/unit"

data/test/units/test_calendar.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require "test_helper"
+
 class TestKoyomiCalendar < Test::Unit::TestCase
   context "Koyomi::Calendar" do
     setup do

data/test/units/test_date.rb

@@ -1,10 +1,12 @@
 # encoding: utf-8
 
+require "test_helper"
+
 class TestKoyomiDate < Test::Unit::TestCase
   context "Koyomi::Date" do
     setup do
       @date = Date.new(2012, 12, 16)
-      @wdays = Koyomi::Calendar::WEEK_START_STRING
+      @wdays = Date::WEEK_WDAYS
     end # setup
     
     should "correct week end" do

data/test/units/test_month.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require "test_helper"
+
 class TestKoyomiMonth < Test::Unit::TestCase
   context "Koyomi::Month" do
     

data/test/units/test_week.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require "test_helper"
+
+class TestKoyomiWeek < Test::Unit::TestCase
+  context "Koyomi::Week" do
+    
+    setup do
+      @today = Date.today
+      @year = @today.year
+      @month = @today.month
+    end # setup  
+    
+    should "generate week instance" do
+      assert_nothing_raised(Exception) do
+        @week = Koyomi::Week.new(@today, Koyomi::Week::DEFAULT_START)
+      end
+    end # should "generate week instance"
+    
+    should "calcurate windex" do
+      date = Date.new(2012, 12, 23)
+      assert(Koyomi::Week.windex(:sun) == (date).wday)
+      assert(Koyomi::Week.windex(:mon) == (date + 1).wday)
+      assert(Koyomi::Week.windex(:tue) == (date + 2).wday)
+      assert(Koyomi::Week.windex(:wed) == (date + 3).wday)
+      assert(Koyomi::Week.windex(:thu) == (date + 4).wday)
+      assert(Koyomi::Week.windex(:fri) == (date + 5).wday)
+      assert(Koyomi::Week.windex(:sat) == (date + 6).wday)
+    end
+    
+    should "start specified week day" do
+      date = Date.new(2012, 12, 23)
+      Koyomi::Week::WDAYS.each do |wday|
+        assert_equal(Koyomi::Week.windex(wday), Koyomi::Week.new(date, wday).range.first.wday)
+      end
+    end
+    
+    should "respond date to request of week day" do
+      date = Date.new(2012, 12, 23)
+      Koyomi::Week::WDAYS.each do |wday|
+        assert_equal(Koyomi::Week.windex(wday), Koyomi::Week.new(date, wday).__send__(wday).wday)
+      end
+    end
+    
+  end # context "Koyomi::Week"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: koyomi
 version: !ruby/object:Gem::Version
-  version: 0.0.2.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2012-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
@@ -45,17 +45,20 @@ files:
 - lib/koyomi/helper.rb
 - lib/koyomi/helper/date.rb
 - lib/koyomi/helper/init.rb
+- lib/koyomi/helper/week.rb
 - lib/koyomi/init.rb
 - lib/koyomi/month.rb
 - lib/koyomi/period.rb
 - lib/koyomi/version.rb
-- test/init.rb
-- test/units.rb
+- lib/koyomi/week.rb
+- test/test_helper.rb
 - test/units/test_calendar.rb
 - test/units/test_date.rb
 - test/units/test_month.rb
+- test/units/test_week.rb
 homepage: ''
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -79,9 +82,9 @@ signing_key:
 specification_version: 3
 summary: Add some classes to handle year, month, period.
 test_files:
-- test/init.rb
-- test/units.rb
+- test/test_helper.rb
 - test/units/test_calendar.rb
 - test/units/test_date.rb
 - test/units/test_month.rb
+- test/units/test_week.rb
 has_rdoc: 

data/test/units.rb

@@ -1,5 +0,0 @@
-# encoding: utf-8
-
-require File.expand_path("../units/test_month", __FILE__)
-require File.expand_path("../units/test_calendar", __FILE__)
-require File.expand_path("../units/test_date", __FILE__)