sixarm_ruby_week 1.1.8 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43c2bf247a81648d563528f841600bfce4b615c0
-  data.tar.gz: b8c6242e092844a4ba41d2dbacece6b8a2e36954
+  metadata.gz: 6db74a3428b9b9ed56a05421475ee480c6c1255b
+  data.tar.gz: 4851889f70cfdabc6aab495f1ae3bf8ed93b0730
 SHA512:
-  metadata.gz: e9eced63ee4ac973570d7e4c44e460a57a1480cc845e6faf8753e3aa8091ff131c8e7bfaa1a522ab81564a4305e5d2a46183c0607fc0d728e8edfe440cbe6d39
-  data.tar.gz: c77d05a7d6edc1400ecf4ae1def478bb9c4759e8085c333909a72d0617bbf17a98621e5e0fc2a30067a357c48ba0f90aa57f43497f26c98e4d0d2ba4eaf34b88
+  metadata.gz: e319af65dc9fad712d7f12a41d3818329e92c59420e5494299167d993b7f068b3e2736ae6953398dc9b24bdc52628fcc662b3865d6d48eb462c748542deae6dd
+  data.tar.gz: 47d14753e907060beab0089de0383fc449d27fd9645381b6ac2e7e5906ac2be872c35403a59d9d8b03e11c9e3490c02d12cc2c5dad66f5c822dd1b3385c6fb8d

data/Rakefile

@@ -9,4 +9,3 @@ end
 
 task :default => [:test]
 task :default => [:test]
-task :default => [:test]

data/lib/sixarm_ruby_week.rb

@@ -3,4 +3,4 @@
 Please see README
 =end
 
-require "sixarm_ruby_week/week"
+require_relative "sixarm_ruby_week/week"

data/lib/sixarm_ruby_week/week.rb

@@ -0,0 +1,397 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Week class.
+=end
+
+require "date"
+
+class Week
+
+  attr :date
+
+  # Initialize the week with a date.
+  #
+  # Example:
+  #
+  #     require "date"
+  #     date = Date.today
+  #     week = Week.new(date)
+  #
+  # Return:
+  #
+  #  * [Week] The new week
+  #
+  def initialize(date)
+    @date = date
+  end
+
+  # Return the week's date, coverted to a string.
+  #
+  # Example:
+  #
+  #     date = Date.parse("2015-12-31")
+  #     week = Week.new(date)
+  #     week.to_s #=> "2015-12-31"
+  #
+  # Return:
+  #
+  #  * [String] The week's date, coverted to a string.
+  #
+  def to_s
+    @date.to_s
+  end
+
+  ###
+  #
+  # Instantiations
+  #
+  ###
+  
+  # Return the week that starts today
+  #
+  # Example:
+  #
+  #     week = Week.now
+  #
+  def self.now
+    Week.new(Date.today)
+  end
+
+  # Parse date text to a week. 
+  #
+  # Example:
+  #
+  #     week = Week.parse("2015-12-31") 
+  #
+  # Return:
+  #
+  #  * [Week] A new week.
+  #
+  def self.parse(date_text)
+    Week.new(Date.parse(date_text))
+  end
+
+  ###
+  #
+  # Comparable
+  #
+  ###
+
+  # Return a hash for object comparison.
+  #
+  # This is simply the hash of the date, which means
+  # that two week objects created with the same date
+  # always compare equally.
+  #
+  # Example:
+  #
+  #     date = Date.today
+  #     date.hash #=> 1655958911300557206
+  #     week = Week.new(date)
+  #     week.hash #=> 1655958911300557206
+  #
+  # Return:
+  #
+  #   * [Fixnum] The week's date's object hash number.
+  #
+  def hash
+    date.hash
+  end
+
+  # Return week1.date == week2.date
+  #
+  # Example:
+  #
+  #    a = Week.now
+  #    b = Week.now
+  #    a == b #=> true
+  #
+  # Return:
+  #
+  #   * [true,false]
+  #
+  def ==(other)
+    self.date == other.date
+  end
+
+  # Return week1.date.eql? week2.date
+  #
+  # Example:
+  #
+  #    a = Week.now
+  #    b = Week.now
+  #    a.eql? b #=> true
+  #
+  # Return:
+  #
+  #   * [true,false]
+  #
+  alias :eql? :==
+
+  # Return week1.date <=> week2.date
+  #
+  #    a = Week.now
+  #    b = Week.now
+  #    a <=> b #=> 0
+  #
+  # Return:
+  #
+  #  * [-1,0,1]
+  #
+  def <=>(other)
+   return self.date <=> other.date
+  end
+
+
+  # Return week1.date < week2.date
+  #
+  # Example:
+  #
+  #    a = Week.new(date)
+  #    b = Week.new(date - 1)
+  #    a < b #=> true
+  #
+  # Return:
+  #
+  #  * [true,false]
+  #
+  def <(other)
+    self.date < other.date
+  end
+
+
+  # Return week1.date <= week2.date
+  #
+  # Example:
+  #
+  #    a = Week.new(date)
+  #    b = Week.new(date - 1)
+  #    a <= b #=> true
+  #
+  # Return:
+  #
+  #  * [true,false]
+  #
+  def <=(other)
+    self.date <= other.date
+  end
+
+
+  # Return week1.date > week2.date
+  #
+  # Example:
+  #
+  #    a = Week.new(date)
+  #    b = Week.new(date + 1)
+  #    a > b #=> true
+  #
+  # Return:
+  #
+  #  * [true,false]
+  #
+  def >(other)
+    self.date > other.date
+  end
+
+
+  # Return week1.date >= week2.date
+  #
+  # Example:
+  #
+  #    a = Week.new(date)
+  #    b = Week.new(date + 1)
+  #    a >= b #=> true
+  #
+  # Return:
+  #
+  #  * [true,false]
+  #
+  def >=(other)
+    self.date >= other.date
+  end
+
+  ###
+  #
+  # Math
+  #
+  ###
+
+  # Addition: week + other => week
+  #
+  # Return a date object pointing at other weeks after self.
+  #
+  # The other should be a numeric value.
+  #
+  # Example:
+  #
+  #     week = Week.new(date)
+  #     week + 3 #=> three weeks later
+  #
+  # Return:
+  #
+  #  * [Week]
+  #
+  def +(other)
+    if other.is_a? Numeric
+      return Week.new(date + (other.to_i * 7))
+    else
+      raise TypeError
+    end
+  end
+
+  # Subtraction: week - other => week or integer
+  #
+  # If the other is a numeric value, return a week object pointing other weeks before self. 
+  #   
+  # If the other is a week object, then return the difference between the two weeks.
+  #
+  # Example:
+  #
+  #     week = Week.new(date)
+  #     week - 3 => three weeks earlier
+  #
+  # Example:
+  #
+  #     a =  Week.new(date)
+  #     b =  Week.new(date + 21)
+  #     b - a => 3
+  #
+  # Return:
+  #
+  #  * [Week]
+  #
+  def -(other)
+    if other.is_a? Numeric
+      return Week.new(date - (other * 7))
+    elsif other.is_a? Week
+      return ((self.date - other.date) / 7).round
+    else
+      raise TypeError
+    end
+  end
+  
+  ###
+  #
+  # Enumerable
+  #
+  ###
+
+  # Return the previous week, i.e. seven days earlier.
+  #
+  # Example:
+  #
+  #     week =  Week.new(date)
+  #     week.previous #=> seven days earlier
+  #
+  # Return:
+  #
+  #  * [Week] The previous week
+  #
+  def previous
+    return self - 1
+  end
+
+  # Return the next week, i.e. seven days later.
+  #
+  # Example:
+  #
+  #     week =  Week.new(date)
+  #     week.next #=> seven days later.
+  #
+  # Return:
+  #
+  #  * [Week] The next week
+  #
+  def next
+    return self + 1
+  end
+
+  ###
+  #
+  # Ranges
+  #
+  ###
+ 
+  # Return the first date of this week.
+  #
+  # Example:
+  #
+  #     week = Week.new(date)
+  #     week.first_date #=> date
+  #
+  # Aliases:
+  #
+  #     week.begin_date
+  #     week.start_date
+  #
+  ## Return:
+  #
+  #   * [Date] week.date
+  #
+  def first_date
+    @date
+  end
+
+  alias :begin_date :first_date
+  alias :start_date :first_date  
+
+  # Return the last date of this week.
+  #
+  # Return 
+  #
+  # Example:
+  #
+  #     week = Week.new(date)
+  #     week.last_date #=> date + 6
+  #
+  # Aliases:
+  #
+  #     week.end_date
+  #     week.stop_date
+  #
+  # Return:
+  #
+  #   * [Date] week.date + 6
+  #
+  def last_date
+    @date + 6
+  end
+
+  alias :end_date :last_date
+  alias :stop_date :last_date
+  
+  # Return the date range of the week.
+  #
+  # This returns start_date..end_date.
+  #
+  # Example:
+  #
+  #     week = Week.now
+  #     week.date_range => Range(2012-01-02..2012-01-08)
+  #
+  # Return:
+  #
+  #  * [Range] start_date..stop_date
+  #
+  def date_range
+    start_date..stop_date
+  end
+
+  # Does the week includes the date?
+  #
+  # Example:
+  #
+  #   date = Date.today
+  #   week = Week.new(date)
+  #   week.include?(date + 1) => true
+  #   week.include?(date + 7) => false
+  #
+  # Return:
+  #
+  #   * [true/false]
+  #
+  def include?(date)
+    (start_date..end_date).include?(date)
+  end
+
+end

data/test/sixarm_ruby_week_test.rb

@@ -8,3 +8,4 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   Coveralls::SimpleCov::Formatter
 ]
 SimpleCov.start
+require "sixarm_ruby_week"

data/test/sixarm_ruby_week_test/week_test.rb

@@ -1,6 +1,5 @@
 # -*- coding: utf-8 -*-
 require "sixarm_ruby_week_test"
-require "sixarm_ruby_week/week"
 
 describe Week do
 
@@ -309,53 +308,62 @@ describe Week do
 
   end
 
-  describe "#start_date" do
+  describe "#first_date" do
 
     it "=> Date" do
-      WEEK.start_date.must_be_kind_of Date
+      WEEK.first_date.must_be_kind_of Date
     end
 
     it "=> the initialzation date" do
-      WEEK.start_date.must_equal DATE
+      WEEK.first_date.must_equal DATE
     end
 
-  end
-
+    end
+    
   describe "#begin_date" do
 
-    it "=> Date" do
-      WEEK.begin_date.must_be_kind_of Date
+    it "alias" do
+      WEEK.method(:begin_date) == WEEK.method(:first_date)
     end
 
-    it "=> the initialzation date" do
-      WEEK.begin_date.must_equal DATE
+  end
+
+  describe "#start_date" do
+
+    it "alias" do
+      WEEK.method(:start_date) == WEEK.method(:first_date)
     end
 
   end  
-
-  describe "#stop_date" do
+  
+  describe "#last_date" do
 
     it "=> Date" do
-      WEEK.stop_date.must_be_kind_of Date
+      WEEK.last_date.must_be_kind_of Date
     end
 
     it "=> six days after the initialization date" do
-      WEEK.stop_date.must_equal DATE + 6
+      WEEK.last_date.must_equal DATE + 6
     end
     
   end
     
   describe "#end_date" do
 
-    it "=> Date" do
-      WEEK.end_date.must_be_kind_of Date
+    it "alias" do
+      WEEK.method(:end_date) == WEEK.method(:last_date)
     end
 
-    it "=> six days after the initialization date" do
-      WEEK.end_date.must_equal DATE + 6
+  end
+
+  describe "#stop_date" do
+
+    it "alias" do
+      WEEK.method(:stop_date) == WEEK.method(:last_date)
     end
 
   end
+  
 
   describe "#date_range" do
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixarm_ruby_week
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.2.2
 platform: ruby
 authors:
 - SixArm
@@ -44,7 +44,7 @@ cert_chain:
   2AC9FOGkybW6DJEFSFFMlNk0IILsa/gNp8ufGuTVLWF9FUUdMNK+TMbghnifT8/1
   n+ES/gQPOnvmVkLDGw==
   -----END CERTIFICATE-----
-date: 2015-07-18 00:00:00.000000000 Z
+date: 2017-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -66,6 +66,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
+- !ruby/object:Gem::Dependency
+  name: sixarm_ruby_minitest_extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -134,15 +148,17 @@ extra_rdoc_files: []
 files:
 - Rakefile
 - lib/sixarm_ruby_week.rb
+- lib/sixarm_ruby_week/week.rb
 - test/sixarm_ruby_week_test.rb
 - test/sixarm_ruby_week_test/week_test.rb
 homepage: http://sixarm.com/
 licenses:
-- BSD
-- GPL
+- Apache-2.0
+- Artistic-2.0
+- BSD-3-Clause
+- GPL-3.0
 - MIT
-- PAL
-- Various
+- MPL-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -160,11 +176,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
-summary: SixArm.com » Ruby » Week
+summary: SixArm.com → Ruby → Week
 test_files:
 - test/sixarm_ruby_week_test.rb
 - test/sixarm_ruby_week_test/week_test.rb
-has_rdoc: true