calendar_walker 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 003a33ba43ba171b8eae1071e3cf3f80ff32a070
-  data.tar.gz: 4a4ede33d716c660902684ba43dd407945c172f6
+  metadata.gz: 9c40117316ae496c869335bdbf0dfcd7d92ed62d
+  data.tar.gz: e264d50a4d896a600be0a7789fb7e87accba5c49
 SHA512:
-  metadata.gz: 7898dff4e5005a09e26f335cbf3098b80e4fde04c91f921fb307913e6326fe1cc771e24b4db9cdbdb6f70593112cf9e20a99eb6bec67fcf2f8d187630acca0ca
-  data.tar.gz: afd688c50c15933f40b3d8150851bfc1f8fc9c6d1432f1927d052d0053ef760f2a20f9cdd0cfac5c3850f36f2187977b711fca42f311af4a99e55e338d82b750
+  metadata.gz: d87c7a4aaa81d7f0ef0a18ce47b7023faa286bdc6da9138b08beeb3321eee123553dae0c12ee529eb86ad1ffb4d2ca8a6b7e4693ef33f51cc1bddd51578c51ff
+  data.tar.gz: 64c4b38c281cd0ace514ef8d9df9db8826ccafa31ea3a8241af867b93cdc7d685780e4ba452772fb1f699bb1f6e362b6cb1f407f07071625f1cc64bd64b08745

data/.travis.yml

@@ -1,8 +1,11 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
+  - ruby-1.9.3
+  - ruby-2.0.0
+  - ruby-2.1.1
   - ruby-head
+  - jruby-1.7.12
+  - jruby-head
+  - rbx-2.2.6
 script:
   - bundle exec rspec

data/README.md

@@ -4,7 +4,14 @@
 
 <https://github.com/violarium/calendar_walker>
 
-A simple gem to get calendars in correct order and walk through them as you want.
+A simple gem to work with month dates in correct order and objects attached to them.
+
+It supports:
+
+1. Walking through dates of month (2d array) in correct order.
+2. Choosing the firsdt day of week: Sunday, Monday or whatever.
+3. Adding objects collections which will be automatically attached to appropriate dates.
+
 
 ## Installation
 
@@ -20,15 +27,62 @@ Or install it yourself as:
 
     $ gem install calendar_walker
 
+
+
 ## Usage
 
-    require 'calendar_walker'
+### Basic usage of CalendarWalker
 
+    require 'calendar_walker'
+    
+    events = [event1, event2, event3]
+    dates = [date1, date2, date3, date4]
+    
+    walker = CalendarWalker.month_walker_for(
+      Date.new(2014, 1), # Date object to find a current month. Could be also Time or DateTime object
+      1, # first day if week - Monday
+      { events: {collection: events, date_method: :event_date }, # collection "event", :event_date - method in objects to get dates
+        dates: { collection: dates } } # collection "dates", by default, date_method is #date
+    )
+    
+Next code will go through all dates in received month. Each row is week. Row contains elements. Element contains date and objects.
+    
+    walker.each do |row|
+      row.each do |row_element|
+        row_element.date # current date
+        row_element.objects[:events] # list of events at this date
+        row_element.objects[:dates] # list of dates at this date
+      end
+    end
+
+
+### Going deeper
+
+#### CalendarWalker::MonthGrid
+
+When **CalendarWalker#month_walker_for** is called, objects of this class are used by default to manage grid of dates in month. You can use it itself for your own aims.
+    
     CalendarWalker::Walker.new(Date.new(2014, 1, 1)).wday_list # => [0, 1, 2, 3, 4, 5, 6]
-
+    
     walker = CalendarWalker::Walker.new(Date.new(2014, 5, 5), 6)
     walker.wday_list # => [6, 0, 1, 2, 3, 4, 5]
     walker.days_matrix # => [[Date.new(2014, 4, 28), Date.new(2014, 4, 29), ...], ..., [..., Date.new(2014, 6, 1)]]
+    
+
+#### CalendarWalker::MonthWalker
+
+Method **CalendarWalker#month_walker_for** returns an object of class CalendarWalker::MonthWalker and encapsulates a proccess of configuring  it. You can do it manually:
+    
+    walker = CalendarWalker::MonthWalker.new(month_grid)
+    walker.add_objects(:events, events, :event_date)
+    walker.add_objects(:dates, dates)
+    
+
+## Roadmap
+
+1. Walking through the month in vertical way
+2. Simplier interface to manage single collection of objects
+
 
 ## Contributing
 

data/lib/calendar_walker/{walker.rb → month_grid.rb}

@@ -1,19 +1,19 @@
-require 'date'
-
 module CalendarWalker
-  # Class to walk through month in calendar
-  class Walker
+  # Class to work with grid of month days
+  class MonthGrid
     attr_reader :current_date, :first_wday
 
-    # Create a new walker to walk through month in proper order.
+    # Create a new month grid
     # Arguments:
     #   current date (date, datetime or time)
     #   number of start week day between 0 and 6. 0 - Sunday, 6 - Monday.
     # Examples:
-    #   CalendarWalker::Walker.new(Date.new(2014, 1, 1))
-    #   CalendarWalker::Walker.new(Time.now)
+    #   CalendarWalker::MonthGrid.new(Date.new(2014, 1, 1))
+    #   CalendarWalker::MonthGrid.new(Time.now)
     def initialize(date, first_wday = 0)
-      raise IncorrectWDay, 'Weekday should have value between 0 and 6' unless 0 <= first_wday and first_wday <= 6
+      unless first_wday.is_a? Fixnum and 0 <= first_wday and first_wday <= 6
+        raise IncorrectWDay, 'Weekday should have Fixnum value between 0 and 6'
+      end
 
       @current_date = date
       @first_wday = first_wday

data/lib/calendar_walker/month_walker/row_element.rb

@@ -0,0 +1,16 @@
+module CalendarWalker
+  class MonthWalker
+    # Special class which represent element in month walker.
+    # It contains date and hash of appropriate objects
+    class RowElement
+      attr_reader :date
+      attr_reader :objects
+
+      # Create an row element for month walker
+      def initialize(date, objects)
+        @date = date
+        @objects = objects
+      end
+    end
+  end
+end

data/lib/calendar_walker/month_walker.rb

@@ -0,0 +1,65 @@
+module CalendarWalker
+  # Class to walk through dates in months with attached to them appropriate objects
+  class MonthWalker
+    attr_reader :month_grid
+    
+    # Create a new walker with month grid
+    # Arguments:
+    #   month_grid - instance of the class CalendarWalker::MonthGrid or something with same functionality
+    # Examples:
+    #   month_grid = CalendarWalker::MonthGrid.new(Date.new(2014, 1, 1))
+    #   month_walker = CalendarWalker::MonthWalker.new(month_grid)
+    def initialize(month_grid)
+      @month_grid = month_grid
+      @objects = {}
+    end
+
+    # Add collection of objects with dates
+    # Arguments:
+    #   key - key to identify each collection
+    #   objects - collection of objects
+    #   date_method - method to get date from each object in collection
+    # Examples:
+    #   month_walker.add_objects[:dates, [..., ..., ...]]
+    #   month_walker.add_objects[:events, [..., ..., ...], :event_time]
+    def add_objects(key, objects, date_method = :date)
+      @objects[key] = {}
+      objects.each do |object|
+        date_key = object.send(date_method).to_date
+        @objects[key][date_key] ||= []
+        @objects[key][date_key].push object
+      end
+    end
+
+    # Remove object collection by key
+    # Arguments:
+    #   key - key to identify existing object collection
+    # Examples:
+    #   month_walker.remove_objects(:events)
+    def remove_objects(key)
+      @objects.delete(key)
+    end
+
+    # Walk through all date matrix with attached objects from added collections
+    # Examples:
+    #   month_walker.each do |row|
+    #     row.each do |row_element|
+    #       row_element.date # => Date.new(2014, 5, 8)
+    #       row_element.objects # => { events: [..., ...], dates: [] }
+    #     end
+    #   end
+    def each(&block)
+      @month_grid.days_matrix.each do |day_row|
+        row = []
+        day_row.each do |date|
+          row_elements_object = {}
+          @objects.each do |object_key, objects_list|
+            row_elements_object[object_key] = objects_list[date].nil? ? [] : objects_list[date]
+          end
+          row.push RowElement.new(date, row_elements_object)
+        end
+        block.call(row)
+      end
+    end
+  end
+end

data/lib/calendar_walker/version.rb

@@ -1,3 +1,3 @@
 module CalendarWalker
-  VERSION = '0.0.3'
+  VERSION = '1.0.0'
 end

data/lib/calendar_walker.rb

@@ -1,5 +1,29 @@
 require 'calendar_walker/version'
-require 'calendar_walker/walker'
+require 'date'
+require 'calendar_walker/month_grid'
+require 'calendar_walker/month_walker'
+require 'calendar_walker/month_walker/row_element'
 
 module CalendarWalker
+  # Create month walker with objects
+  # Arguments:
+  #   date - date to get the month
+  #   first_wday - first day of week: from 0 to 6
+  #   objects - object collections with dates
+  # Examples:
+  #   CalendarWalker.month_walker_for(
+  #     Date.new(2014, 1, 1),
+  #     1,
+  #     { events: { collection: events, date_method: :event_date },
+  #       dates: { collection: dates } } # date_method is :date by default
+  #   )
+  def self.month_walker_for(date, first_wday, objects = {})
+    walker = CalendarWalker::MonthWalker.new(CalendarWalker::MonthGrid.new(date, first_wday))
+    objects.each do |key, obj_container|
+      arguments = [key, obj_container[:collection]]
+      arguments.push obj_container[:date_method] unless obj_container[:date_method].nil?
+      walker.add_objects(*arguments)
+    end
+    walker
+  end
 end

data/spec/calendar_walker/month_grid_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe CalendarWalker::MonthGrid do
+  let(:current_date) { ::DateTime.new(2014, 5, 5) }
+
+  describe '#current_date' do
+    it 'should return same current date' do
+      grid = CalendarWalker::MonthGrid.new(current_date)
+      grid.current_date.should eq current_date
+    end
+  end
+
+  describe '#first_wday' do
+    it 'should return received wday number' do
+      CalendarWalker::MonthGrid.new(current_date, 4).first_wday.should eq 4
+    end
+
+    describe 'incorrect values' do
+      [-1, 7, 'hello', nil].each do |incorrect_value|
+        output_value = incorrect_value.nil? ? '`nil`' : incorrect_value.to_s
+        it output_value + ' as a first week day should throw an error' do
+          expect do
+            CalendarWalker::MonthGrid.new(current_date, incorrect_value)
+          end.to raise_error CalendarWalker::IncorrectWDay
+        end
+      end
+    end
+  end
+
+  describe '#days_matrix' do
+    {
+        0 => { from: Date.new(2014, 4, 27), to:  Date.new(2014, 5, 31) },
+        1 => { from: Date.new(2014, 4, 28), to:  Date.new(2014, 6, 1) },
+        2 => { from: Date.new(2014, 4, 29), to:  Date.new(2014, 6, 2) },
+        3 => { from: Date.new(2014, 4, 30), to:  Date.new(2014, 6, 3) },
+        4 => { from: Date.new(2014, 5, 1),  to:  Date.new(2014, 6, 4) },
+        5 => { from: Date.new(2014, 4, 25), to:  Date.new(2014, 6, 5) },
+        6 => { from: Date.new(2014, 4, 26), to:  Date.new(2014, 6, 6) },
+    }.each do |first_wday, date_range|
+      it 'should return correct matrix when first week day is ' + Date::DAYNAMES[first_wday] do
+        grid = CalendarWalker::MonthGrid.new(current_date, first_wday)
+        grid.days_matrix.should eq week_grid(date_range[:from], date_range[:to])
+      end
+    end
+  end
+
+  describe '#wday_list' do
+    [
+        (0..6).to_a,
+        (1..6).to_a + [0],
+        (2..6).to_a + (0..1).to_a,
+        (3..6).to_a + (0..2).to_a,
+        (4..6).to_a + (0..3).to_a,
+        (5..6).to_a + (0..4).to_a,
+        [6] + (0..5).to_a
+    ].each_with_index do |expect, first_wday|
+      it 'should print week days in proper order when first week day is ' + Date::DAYNAMES[first_wday] do
+        CalendarWalker::MonthGrid.new(current_date, first_wday).wday_list.should eq expect
+      end
+    end
+  end
+end

data/spec/calendar_walker/month_walker/row_element_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe CalendarWalker::MonthWalker::RowElement do
+  before do
+    @row_element = CalendarWalker::MonthWalker::RowElement.new('row_date', {a: [1, 2]})
+  end
+
+  describe '#date' do
+    it 'should return correct date' do
+      @row_element.date.should eq 'row_date'
+    end
+  end
+
+  describe '#objects' do
+    it 'should return correct objects' do
+      @row_element.objects.should eq ({a: [1, 2]})
+    end
+  end
+end

data/spec/calendar_walker/month_walker_spec.rb

@@ -0,0 +1,170 @@
+require 'spec_helper'
+
+describe CalendarWalker::MonthWalker do
+
+  describe 'functional' do
+
+    let(:month_grid) { CalendarWalker::MonthGrid.new(Date.new(2014, 5, 9)) }
+    let(:calendar_walker) { CalendarWalker::MonthWalker.new(month_grid) }
+
+    describe '#month_grid' do
+      it 'should return received later month grid' do
+        calendar_walker.month_grid.should eq month_grid
+      end
+    end
+
+    describe '#each' do
+
+      it 'should walk through all dates in month grid' do
+        walk_result = []
+        calendar_walker.each do |row|
+          row_result = []
+          row.each do |row_element|
+            row_result.push row_element.date
+          end
+          walk_result.push row_result
+        end
+
+        walk_result.should eq month_grid.days_matrix
+      end
+
+      describe 'managing objects' do
+
+        let(:a_objects) do
+          [
+              double('a1', date: Date.new(2014, 5, 8)),
+              double('a2', date: Date.new(2014, 5, 8)),
+              double('a3', date: Date.new(2014, 4, 30)),
+              double('a4', date: Date.new(2014, 1, 1)),
+          ]
+        end
+
+        let(:b_objects) do
+          [
+              double('b1', date_time: ::DateTime.new(2014, 5, 1, 12, 1, 1)),
+              double('b1', date_time: ::DateTime.new(2014, 5, 2, 23, 2, 2)),
+          ]
+        end
+
+        describe 'with added objects' do
+          before do
+            calendar_walker.add_objects(:a, a_objects)
+            calendar_walker.add_objects(:b, b_objects, :date_time)
+
+            @result = {}
+            calendar_walker.each do |row|
+              row.each do |row_element|
+                @result[row_element.date] = row_element.objects
+              end
+            end
+          end
+
+          it 'should not go through dates which a not in range' do
+            expect(@result[Date.new(2014, 1, 1)]).to be_nil
+          end
+
+          it 'should get objects in lists, attached to appropriate dates' do
+            expect(@result[Date.new(2014, 5, 8)][:a]).to include(a_objects[0], a_objects[1])
+            expect(@result[Date.new(2014, 4, 30)][:a]).to include(a_objects[2])
+
+            expect(@result[Date.new(2014, 5, 1)][:b]).to include(b_objects[0])
+            expect(@result[Date.new(2014, 5, 2)][:b]).to include(b_objects[1])
+          end
+
+          it 'should get empty list when there is no appropriate objects' do
+            expect(@result[Date.new(2014, 5, 12)][:a]).to eq []
+            expect(@result[Date.new(2014, 5, 12)][:b]).to eq []
+          end
+
+          it 'should not get another objects (which were not added)' do
+            expect(@result[Date.new(2014, 5, 1)][:c]).to be_nil
+          end
+        end
+
+
+        describe 'with added and deleted objects' do
+          before do
+            calendar_walker.add_objects(:a, a_objects)
+            calendar_walker.add_objects(:b, b_objects, :date_time)
+            calendar_walker.remove_objects(:a)
+
+            @result = {}
+            calendar_walker.each do |row|
+              row.each do |row_element|
+                @result[row_element.date] = row_element.objects
+              end
+            end
+          end
+
+          it 'should not contain deleted objects' do
+            expect(@result[Date.new(2014, 5, 8)][:a]).to be_nil
+          end
+        end
+      end
+    end
+  end
+
+
+  describe 'unit' do
+    let(:month_grid) { double('month_grid', days_matrix: [[1, 2], [3, 4]]) }
+    let(:month_walker) { CalendarWalker::MonthWalker.new(month_grid) }
+
+    describe '#each' do
+      it 'should create a special object for each date in day matrix with empty object hash' do
+        [1, 2, 3, 4].each do |e|
+          CalendarWalker::MonthWalker::RowElement.should_receive(:new).with(e, {}).once
+        end
+        month_walker.each { }
+      end
+
+      it 'should pass to block arrays of special objects for each row of day matrix' do
+        row_elements = []
+        [1, 2, 3, 4].each do |e|
+          row_element = "row_#{e}"
+          CalendarWalker::MonthWalker::RowElement.should_receive(:new).with(e, {}).and_return(row_element)
+          row_elements.push row_element
+        end
+
+        row_array = []
+        month_walker.each do |row|
+          row_array.push row
+        end
+
+        expect(row_array[0]).to eq [row_elements[0], row_elements[1]]
+        expect(row_array[1]).to eq [row_elements[2], row_elements[3]]
+      end
+
+
+      describe 'with added objects' do
+        let(:a_objects) do
+          [
+              double('a1', m: double('a1_date', to_date: 1)),
+              double('a2', m: double('a2_date', to_date: 1)),
+              double('a3', m: double('a3_date', to_date: 3)),
+              double('a4', m: double('a4_date', to_date: 10))
+          ]
+        end
+
+        let(:b_objects) { [double('b1', x: double('b1_date', to_date: 1))] }
+
+        before do
+          month_walker.add_objects(:a, a_objects, :m)
+          month_walker.add_objects(:b, b_objects, :x)
+        end
+
+        it 'should create a special object for each date in day matrix with appropriate object hash' do
+          CalendarWalker::MonthWalker::RowElement.should_receive(:new).with(1, {a: [a_objects[0], a_objects[1]], b: [b_objects[0]]}).once
+          CalendarWalker::MonthWalker::RowElement.should_receive(:new).with(2, {a: [], b: []}).once
+          CalendarWalker::MonthWalker::RowElement.should_receive(:new).with(3, {a: [a_objects[2]], b: []}).once
+          CalendarWalker::MonthWalker::RowElement.should_receive(:new).with(4, {a: [], b: []}).once
+          month_walker.each { }
+        end
+
+        it 'should not create special objects which are out of date range' do
+          CalendarWalker::MonthWalker::RowElement.should_receive(:new).with(10, anything).never
+          month_walker.each { }
+        end
+      end
+    end
+  end
+end

data/spec/calendar_walker_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe CalendarWalker do
+
+  describe '#month_walker_for' do
+    it 'should create and return CalendarWalker::MonthWalker with correct month grid' do
+      month_grid = double('month_grid')
+      CalendarWalker::MonthGrid.should_receive(:new).with(Date.new(2014, 1, 1), 2).and_return(month_grid)
+
+      walker = double('month_walker')
+      CalendarWalker::MonthWalker.should_receive(:new).with(month_grid).and_return(walker)
+
+      CalendarWalker.month_walker_for(Date.new(2014, 1, 1), 2).should eq walker
+    end
+
+
+    it 'should fill CalendarWalker::MonthWalker object with received collections' do
+      walker = double('month_walker')
+      CalendarWalker::MonthWalker.should_receive(:new).and_return(walker)
+
+      walker.should_receive(:add_objects).with(:events, [1, 2, 3], :event_date).once
+      walker.should_receive(:add_objects).with(:dates, [6, 7])
+
+      CalendarWalker.month_walker_for(
+          Date.new(2014, 1, 1),
+          2,
+          { events: {collection: [1, 2, 3], date_method: :event_date}, dates: { collection: [6, 7] } }
+      )
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'calendar_walker'
+
+Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require f }
+
+RSpec.configure do |config|
+  config.order = 'random'
+end

data/spec/support/grid_support.rb

@@ -0,0 +1,5 @@
+# Get week grid for range of dates
+# Each row is an array with 7 elements
+def week_grid(date_from, date_to)
+  (date_from..date_to).to_a.each_slice(7).to_a
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: calendar_walker
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Pavel Makarov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-06 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -69,9 +69,16 @@ files:
 - Rakefile
 - calendar_walker.gemspec
 - lib/calendar_walker.rb
+- lib/calendar_walker/month_grid.rb
+- lib/calendar_walker/month_walker.rb
+- lib/calendar_walker/month_walker/row_element.rb
 - lib/calendar_walker/version.rb
-- lib/calendar_walker/walker.rb
-- spec/calendar_walker/walker_spec.rb
+- spec/calendar_walker/month_grid_spec.rb
+- spec/calendar_walker/month_walker/row_element_spec.rb
+- spec/calendar_walker/month_walker_spec.rb
+- spec/calendar_walker_spec.rb
+- spec/spec_helper.rb
+- spec/support/grid_support.rb
 homepage: https://github.com/violarium/calendar_walker
 licenses:
 - MIT
@@ -97,4 +104,9 @@ signing_key:
 specification_version: 4
 summary: Simple gem to walk through calendar months.
 test_files:
-- spec/calendar_walker/walker_spec.rb
+- spec/calendar_walker/month_grid_spec.rb
+- spec/calendar_walker/month_walker/row_element_spec.rb
+- spec/calendar_walker/month_walker_spec.rb
+- spec/calendar_walker_spec.rb
+- spec/spec_helper.rb
+- spec/support/grid_support.rb

data/spec/calendar_walker/walker_spec.rb

@@ -1,57 +0,0 @@
-require 'calendar_walker'
-
-describe CalendarWalker::Walker do
-  let(:current_date) { DateTime.new(2014, 5, 5) }
-
-  describe '#current_date' do
-    it 'should return same current date' do
-      walker = CalendarWalker::Walker.new(current_date)
-      walker.current_date.should eq current_date
-    end
-  end
-
-  describe '#first_wday' do
-    it 'should be Sunday by default' do
-      CalendarWalker::Walker.new(current_date).first_wday.should eq 0
-    end
-    it 'should return received wday number' do
-      CalendarWalker::Walker.new(current_date, 4).first_wday.should eq 4
-    end
-    it 'should throw an error when week day is incorrect' do
-      expect do
-        CalendarWalker::Walker.new(current_date, -1)
-      end.to raise_error CalendarWalker::IncorrectWDay
-    end
-  end
-
-  describe '#days_matrix' do
-    context 'first wday is Sunday' do
-      let(:walker) { CalendarWalker::Walker.new(current_date) }
-      it 'should print days in proper order' do
-        walker.days_matrix.should eq (Date.new(2014, 4, 27)..Date.new(2014, 5, 31)).to_a.each_slice(7).to_a
-      end
-    end
-
-    context 'first day is Monday' do
-      let(:walker) { CalendarWalker::Walker.new(current_date, 1) }
-      it 'should print days in proper order' do
-        walker.days_matrix.should eq (Date.new(2014, 4, 28)..Date.new(2014, 6, 1)).to_a.each_slice(7).to_a
-      end
-    end
-  end
-
-
-  describe '#wday_list' do
-    context 'first wday is Sunday' do
-      it 'should print week days in proper order' do
-        CalendarWalker::Walker.new(current_date).wday_list.should eq [0, 1, 2, 3, 4, 5, 6]
-      end
-    end
-
-    context 'first day is Monday' do
-      it 'should print week days in proper order' do
-        CalendarWalker::Walker.new(current_date, 1).wday_list.should eq [1, 2, 3, 4, 5, 6, 0]
-      end
-    end
-  end
-end