ordered_week 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0517bac6ebb69bc05da834db9ee73f2b1bd1beea
+  data.tar.gz: d1948d0bb756d9ef883890178695e3aadb4f186c
+SHA512:
+  metadata.gz: 8c1a790f59d4a0ea9324419bbe9a2adf39ac40efca131d69520dbac5e21165ec796f6a3d90c77ea1bdb6c5e03865b9e0df84d3dd0eff665e0380b5670840660e
+  data.tar.gz: 5496b24554658c13a59992cdc85e57dd562aa163a0811011b0dd66c6724c359a2107ef388c3cc582e914e11dac19d54ef7943f090515f17265bd0a2c459e8122

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brad Rice
+
+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,78 @@
+# OrderedWeek
+
+A class useful for when it makes sense to think of a week, conceptually, as a single object.
+An example, at least my use case, would be an app tracking pay periods. It makes sense to explicitly label a beginning marker.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ordered_week'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ordered_week
+
+## Usage
+
+You now have access to the OrderedWeek class, which returns an array of Dates, which includes an optionally given Date (defaults to including current day).
+Note: The following examples assume the current date to be Sunday, 2014-02-16.
+
+    OrderedWeek.new
+    #=> [2014-02-10, 2014-02-11, ... ]
+
+These collections have a concept of where they start and end.
+
+    OrderedWeek.new.start_date
+    #=> #<Date: 2014-02-10 ((2456699j,0s,0n),+0s,2299161j)>
+    OrderedWeek.new.end_date
+    #=> #<Date: 2014-02-16 ((2456705j,0s,0n),+0s,2299161j)>
+
+By default, the "week" starts on Monday. You can change this by setting the class option.
+Note: The following example shows that by resetting the start date for the week, a completely different week can be returned.
+
+    OrderedWeek.start_day
+    #=> :monday
+    OrderedWeek.start_day = :sunday
+    #=> :sunday
+    OrderedWeek.new.start_date
+    #=> #<Date: 2014-02-16 ((2456705j,0s,0n),+0s,2299161j)>
+
+Don't worry though! If you accidentally pass an argument that isn't the symbol of a valid day of the week, nothing changes
+
+    OrderedWeek.start_day
+    #=> :monday
+    OrderedWeek.start_day = :bad
+    #=> :bad
+    OrderedWeek.start_day
+    #=> :monday
+
+These objects respond to the following methods
+
+    OrderedWeek.new.monday
+    #=> #<Date: 2014-02-10 ((2456699j,0s,0n),+0s,2299161j)>
+
+    ...
+
+    OrderedWeek.new.sunday
+    #=> #<Date: 2014-02-16 ((2456705j,0s,0n),+0s,2299161j)>
+
+    OrderedWeek.new.to_a
+    #=> [#<Date: 2014-02-10 ((2456699j,0s,0n),+0s,2299161j)>, #<Date: 2014-02-11 ((2456700j,0s,0n),+0s,2299161j)>, ... ]
+
+The objects are also enumerable, so feel free to modify your Dates however you need
+
+    OrderedWeek.new.map {|day| day.strftime("%F")}
+    #=> ["2014-02-10", "2014-02-11", ... ]
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/ordered_week/fork )
+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,7 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/ordered_week.rb

@@ -0,0 +1,67 @@
+class OrderedWeek
+  include Enumerable
+
+  VERSION = '0.0.1'
+  WEEK_DAYS = [:sunday, :monday, :tuesday, :wednesday, :thursday, :friday, :saturday]
+
+  @@start_day ||= :monday
+
+  private_constant :WEEK_DAYS
+
+  def self.start_day
+    @@start_day
+  end
+
+  def self.start_day= day
+    return false unless WEEK_DAYS.include?(day)
+    @@start_day = day 
+  end
+
+  def initialize includes_date=nil
+    includes_date = includes_date.is_a?(Date) ? includes_date : Date.today
+    @days = build_days(includes_date)
+  end
+
+  def inspect
+    @days.map {|d| d.strftime("%F")}.inspect.gsub('"','')
+  end
+
+  def to_a
+    @days
+  end
+
+  def each &block
+    @days.each {|d| yield d}
+  end
+
+  def start_date
+    @days.first
+  end
+
+  def end_date
+    @days.last
+  end
+
+  WEEK_DAYS.each_with_index do |day, day_index|
+    define_method day do
+      @days[ day_index - start_day_index ]
+    end
+  end
+
+  private
+
+    def build_days(date)
+      while not date_is_start_of_week(date)
+        date -= 1
+      end
+      (date..date+6).to_a
+    end
+
+    def date_is_start_of_week date
+      date.send( (@@start_day.to_s + ??).to_sym )
+    end
+
+    def start_day_index
+      WEEK_DAYS.index(@@start_day)
+    end
+end

data/ordered_week.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+#require 'ordered_week/version'
+require 'ordered_week'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ordered_week"
+  spec.version       = OrderedWeek::VERSION
+  spec.authors       = ["Brad Rice"]
+  spec.email         = ["bradley_rice@mac.com"]
+  spec.summary       = %q{A customizable ordered collection of Dates}
+  spec.description   = %q{Useful for situations in which the concept of a week requires a specific start/stop marker}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+end

data/spec/ordered_week_spec.rb

@@ -0,0 +1,208 @@
+require 'spec_helper'
+
+describe OrderedWeek do
+  describe "::start_day" do
+    subject { OrderedWeek.start_day }
+
+    it "should respond" do
+      expect{ subject }.to_not raise_error
+    end
+
+    it "should return a Symbol" do
+      subject.should be_a Symbol
+    end
+  end
+
+  describe "::start_day=" do
+    subject { OrderedWeek.start_day = :sunday }
+
+    it "should respond" do
+      expect{ subject }.to_not raise_error
+    end
+
+    context "given a valid day of week" do
+      let(:day) { :wednesday }
+
+      subject { OrderedWeek.start_day = day }
+
+      it "should update the established start of week" do
+        OrderedWeek.start_day.should_not eq day
+        subject
+        OrderedWeek.start_day.should eq day
+      end
+    end
+
+    context "given an invalid day of week" do
+      let(:day) { :bad }
+
+      subject { OrderedWeek.start_day = day }
+
+      it "should not update the established start of week" do
+        OrderedWeek.start_day.should_not eq day
+        subject
+        OrderedWeek.start_day.should_not eq day
+      end
+    end
+  end
+
+  describe "::new" do
+    subject { OrderedWeek.new }
+
+    it "should respond" do
+      expect{ subject }.to_not raise_error
+    end
+
+    it "should accept a Date" do
+      expect{ OrderedWeek.new(Date.today) }.to_not raise_error
+    end
+
+    it "should default to the current week, if not given an arg" do
+      with_arg = OrderedWeek.new(Date.today)
+      without_arg = OrderedWeek.new
+      with_arg.start_date.should eq without_arg.start_date
+      with_arg.end_date.should eq without_arg.end_date
+    end
+  end
+
+  describe "An instance of", OrderedWeek do
+    subject { OrderedWeek.new }
+
+    describe "#start_date" do
+      subject { OrderedWeek.new.start_date }
+
+      it "should respond" do
+        expect{ subject }.to_not raise_error
+      end
+
+      it "should return a Date" do
+        subject.should be_a Date
+      end
+    end
+
+    describe "#end_date" do
+      subject { OrderedWeek.new.end_date }
+
+      it "should respond" do
+        expect{ subject }.to_not raise_error
+      end
+
+      it "should return a Date" do
+        subject.should be_a Date
+      end
+    end
+
+    describe "#sunday" do
+      subject { OrderedWeek.new.sunday }
+
+      it "should respond" do
+        expect{ subject }.to_not raise_error
+      end
+
+      it "should return a Date" do
+        subject.should be_a Date
+      end
+    end
+
+    describe "#monday" do
+      subject { OrderedWeek.new.monday }
+
+      it "should respond" do
+        expect{ subject }.to_not raise_error
+      end
+
+      it "should return a Date" do
+        subject.should be_a Date
+      end
+    end
+
+    describe "#tuesday" do
+      subject { OrderedWeek.new.tuesday }
+
+      it "should respond" do
+        expect{ subject }.to_not raise_error
+      end
+
+      it "should return a Date" do
+        subject.should be_a Date
+      end
+    end
+
+    describe "#wednesday" do
+      subject { OrderedWeek.new.wednesday }
+
+      it "should respond" do
+        expect{ subject }.to_not raise_error
+      end
+
+      it "should return a Date" do
+        subject.should be_a Date
+      end
+    end
+
+    describe "#thursday" do
+      subject { OrderedWeek.new.thursday }
+
+      it "should respond" do
+        expect{ subject }.to_not raise_error
+      end
+
+      it "should return a Date" do
+        subject.should be_a Date
+      end
+    end
+
+    describe "#friday" do
+      subject { OrderedWeek.new.friday }
+
+      it "should respond" do
+        expect{ subject }.to_not raise_error
+      end
+
+      it "should return a Date" do
+        subject.should be_a Date
+      end
+    end
+
+    describe "#saturday" do
+      subject { OrderedWeek.new.saturday }
+
+      it "should respond" do
+        expect{ subject }.to_not raise_error
+      end
+
+      it "should return a Date" do
+        subject.should be_a Date
+      end
+    end
+
+    describe "#inspect" do
+      subject { OrderedWeek.new.inspect }
+
+      it "should respond" do
+        expect{ subject }.to_not raise_error
+      end
+    end
+
+    describe "#to_a" do
+      subject { OrderedWeek.new.to_a }
+
+      it "should respond" do
+        expect{ subject }.to_not raise_error
+      end
+    end
+
+    describe "#each" do
+      subject { OrderedWeek.new.each {|obj| obj} }
+
+      it "should respond" do
+        expect{ subject }.to_not raise_error
+      end
+
+      it "should make for enumerable operations" do
+        enum_return = OrderedWeek.new.map {|obj| obj.strftime("%F")}
+        enum_return.each {|e_obj| e_obj.should be_a String}
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'ordered_week'
+Dir[File.join( File.dirname(__FILE__), 'support', '**', '*.rb' )].each {|f| require f}
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: ordered_week
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brad Rice
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: Useful for situations in which the concept of a week requires a specific
+  start/stop marker
+email:
+- bradley_rice@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ordered_week.rb
+- ordered_week.gemspec
+- spec/ordered_week_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A customizable ordered collection of Dates
+test_files:
+- spec/ordered_week_spec.rb
+- spec/spec_helper.rb