koyomi 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+._*
+.DSStore
+.project

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in koyomi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 sekizo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Koyomi
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'koyomi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install koyomi
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+$: << 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__)
+end

data/koyomi.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'koyomi/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "koyomi"
+  gem.version       = Koyomi::VERSION
+  gem.authors       = ["sekizo"]
+  gem.email         = ["sekizoworld@mac.com"]
+  gem.description   = %q{Extends Date class to handling with calendar.}
+  gem.summary       = %q{Add some classes to handle year, month, period.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  #--------------------#
+  # additionals
+  gem.add_development_dependency "shoulda"
+  
+end

data/lib/koyomi.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require "koyomi/init"
+require "koyomi/version"
+
+require "koyomi/period"
+require "koyomi/month"
+require "koyomi/calendar"
+
+module Koyomi
+end

data/lib/koyomi/calendar.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+
+require "koyomi/period"
+require "koyomi/month"
+
+class Koyomi::Calendar < Koyomi::Period
+  #--------------------#
+  # constant
+  DEFAULT_WEEK_START = :mon
+  WEEK_START_RANGE = (0..6)
+  WEEK_START_STRING = [:sun, :mon, :tue, :wed, :thu, :fri, :sat]
+  
+  #--------------------#
+  # 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 #{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
+  attr_accessor :week_start
+  
+  # initialize instance
+  #
+  # @param  [Integer] year optional, use instance create date.
+  # @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 = nil)
+    super()
+    self.year = year||self.created_at.year
+    self.month = month||self.created_at.month
+    self.week_start = week_start||DEFAULT_WEEK_START
+    
+    self.koyomi_month = Koyomi::Month.new(self.month, self.year)
+  end
+  
+  # set week_start
+  #
+  # @param  [Object]  value
+  def week_start=(value)
+    @week_start = self.class.windex(value)
+  end
+  
+  # first date of the calendar (NOT first date of the MONTH)
+  #
+  # @return [Date]
+  def first
+    week_starts(self.koyomi_month.first, self.week_start)
+  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)
+  end
+  
+  # range of the calendar.
+  #
+  # @return [Range]
+  def range
+    Range.new(self.first, self.last)
+  end
+  
+  # Koyomi::Month of the calendar's month.
+  #
+  # @return [Koyomi::Month]
+  def the_month
+    self.koyomi_month
+  end
+  
+  #--------------------#
+  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 ? 7 : 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) + 6
+  end
+end

data/lib/koyomi/init.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+lib = File.expand_path('../../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# Define base module
+module Koyomi
+end

data/lib/koyomi/month.rb

@@ -0,0 +1,85 @@
+# encoding: utf-8
+
+require "koyomi/period"
+
+class Koyomi::Month < Koyomi::Period
+  
+  #--------------------#
+  # class methods
+  
+  # create instance from date
+  #
+  # @param  [Date]  date
+  # @return [Koyomi::Month]
+  def self.of(date)
+    self.new(date.month, date.year)
+  end
+  
+  #--------------------#
+  # instance methods
+  
+  attr_reader :year, :month
+  attr_reader :first, :last
+  
+  # initialize instance.
+  #
+  # @param  [Integer] month optional, default use the month of instance created.
+  # @param  [Integer] year  optional, default use the year of instance created.
+  def initialize(month = nil, year = nil)
+    super()
+    self.range = self.initialize_range(month, year) 
+  end
+  
+  # next month
+  #
+  # @return [Koyomi::Month]
+  def next
+    self.class.of(self.last + 1)
+  end
+  
+  # previous month
+  #
+  # @return [Koyomi::Month]
+  def prev
+    self.class.of(self.first - 1)
+  end
+  
+  #--------------------#
+  protected
+  
+  attr_writer :year, :month
+  attr_writer :first, :last
+  
+  # initialize range
+  #
+  # @param  [Integer] month optional, default use the month of instance created.
+  # @param  [Integer] year  optional, default use the year of instance created.
+  # @return [Range]
+  def initialize_range(month = nil, year = nil)
+    self.year = year||self.created_at.year
+    self.month = month||self.created_at.month
+    self.first = Date.new(self.year, self.month, 1)
+    self.last = (first_date_next_month(self.first) - 1)
+    Range.new(self.first, self.last)
+  end
+  
+  #--------------------#
+  private
+  
+  # a date next month of the date
+  #
+  # @param  [Date]  date
+  # @return [Date]
+  def a_date_next_month(date)
+    Date.new(date.year, date.month, 1) + 32
+  end
+  
+  # first date of next month
+  #
+  # @param  [Date]  date
+  # @return [Date]
+  def first_date_next_month(date)
+    a_date = a_date_next_month(date)
+    Date.new(a_date.year, a_date.month, 1)
+  end
+end

data/lib/koyomi/period.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+require "date"
+
+class Koyomi::Period
+  attr_reader :range
+  
+  #--------------------#
+  # instance methods
+  
+  def initialize
+    super()
+    self.created_at = Date.today
+  end
+  
+  #--------------------#
+  protected
+  
+  attr_accessor :created_at
+  attr_writer :range
+  
+  #--------------------#
+  private
+  
+  # throw uniplemeted method to self range.
+  def method_missing(name, *args, &block)
+    begin
+      self.range.__send__(name, *args, &block)
+    rescue => e
+      super
+    end
+  end
+end

data/lib/koyomi/version.rb

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

data/test/init.rb

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

data/test/units.rb

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

data/test/units/test_calendar.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+class TestKoyomiCalendar < Test::Unit::TestCase
+  context "Koyomi::Calendar" do
+    setup do
+      @calendar = Koyomi::Calendar.new()
+    end # setup
+    
+    should "have koyomi month" do
+      assert(@calendar.koyomi_month.is_a?(Koyomi::Month))
+      assert(@calendar.the_month.is_a?(Koyomi::Month))
+    end
+    
+    should "have week start" do
+      assert(@calendar.week_start.is_a?(Numeric))
+      
+      assert_nothing_raised(Exception) do
+        (0..6).each do |wd|
+          @calendar.week_start = wd
+        end
+      end
+      
+      assert_raise(RuntimeError) do
+        @calendar.week_start = 7
+      end
+    end
+    
+    context "handle correct week" do
+      setup do
+        @cal = Koyomi::Calendar.new(2012, 12)
+      end # setup
+      
+      should "starts sun." do
+        @cal.week_start = :sun
+        assert_equal(Date.new(2012, 11, 25), @cal.first, "wrong first.")
+        assert_equal(Date.new(2013, 1, 5), @cal.last, "wrong last.")
+      end
+      
+      should "starts mon." do
+        @cal.week_start = :mon
+        assert_equal(Date.new(2012, 11, 26), @cal.first, "wrong first.")
+        assert_equal(Date.new(2013, 1, 6), @cal.last, "wrong last.")
+      end
+      
+      should "starts tue." do
+        @cal.week_start = :tue
+        assert_equal(Date.new(2012, 11, 27), @cal.first, "wrong first.")
+        assert_equal(Date.new(2012, 12, 31), @cal.last, "wrong last.")
+      end
+      
+      should "starts wed." do
+        @cal.week_start = :wed
+        assert_equal(Date.new(2012, 11, 28), @cal.first, "wrong first.")
+        assert_equal(Date.new(2013, 1, 1), @cal.last, "wrong last.")
+      end
+      
+      should "starts thu." do
+        @cal.week_start = :thu
+        assert_equal(Date.new(2012, 11, 29), @cal.first, "wrong first.")
+        assert_equal(Date.new(2013, 1, 2), @cal.last, "wrong last.")
+      end
+      
+      should "starts fri." do
+        @cal.week_start = :fri
+        assert_equal(Date.new(2012, 11, 30), @cal.first, "wrong first.")
+        assert_equal(Date.new(2013, 1, 3), @cal.last, "wrong last.")
+      end
+      
+      should "starts sat." do
+        @cal.week_start = :sat
+        assert_equal(Date.new(2012, 12, 1), @cal.first, "wrong first.")
+        assert_equal(Date.new(2013, 1, 4), @cal.last, "wrong last.")
+      end
+      
+    end # context "handle correct week"
+     
+  end # context "Koyomi::Calendar"
+end

data/test/units/test_month.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+class TestKoyomiMonth < Test::Unit::TestCase
+  context "Koyomi::Month" do
+    
+    setup do
+      @month = Koyomi::Month.new()
+    end
+    
+    should "have range" do
+      assert(@month.range.is_a?(Range))
+    end
+
+    should "respond to next" do
+      assert(@month.next.is_a?(Koyomi::Month))
+    end
+    
+    should "respond to prev" do
+      assert(@month.prev.is_a?(Koyomi::Month))
+    end
+    
+  end # context "Koyomi::Month"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: koyomi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- sekizo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extends Date class to handling with calendar.
+email:
+- sekizoworld@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- koyomi.gemspec
+- lib/koyomi.rb
+- lib/koyomi/calendar.rb
+- lib/koyomi/init.rb
+- lib/koyomi/month.rb
+- lib/koyomi/period.rb
+- lib/koyomi/version.rb
+- test/init.rb
+- test/units.rb
+- test/units/test_calendar.rb
+- test/units/test_month.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Add some classes to handle year, month, period.
+test_files:
+- test/init.rb
+- test/units.rb
+- test/units/test_calendar.rb
+- test/units/test_month.rb
+has_rdoc: