calendrier 0.9.0

data/README.md

@@ -0,0 +1,158 @@
+# Calendrier
+
+[![travis](https://secure.travis-ci.org/lafourmi/calendrier.png?branch=master)](http://travis-ci.org/lafourmi/calendrier)
+
+##DESCRIPTION
+
+A simple helper for creating calendars. It includes a method to sort objects by date and an helpers to display events/meetings and other objects.
+
+##SYNOPSIS:
+
+The gem provides `calendrier` helper to display calendars
+
+    # Simple example
+    <%= calendrier(:year => 2012, :month => 5, :day => 25, :start_on_monday => true, :display => :week, :title => "My calendar title") %>
+
+    # Complex example
+    <%= calendrier(:year => 2012, :month => 5, :day => 25, :start_on_monday => true, :display => :month) do |cell_begin_time, cell_end_time| %>
+      <!-- this code is run for every cell of the calendar -->
+      
+      <!-- you have access to `cell_begin_time` and `cell_end_time` which let you create links or custom content -->
+      <%= content_tag(:span, "Add meeting/event at #{l(cell_begin_time)} ?") %>
+    <% end %>
+
+Now you have a calendar, but you may need to display events inside. If you have many events to display, the gem provides a method `sort_events` for the controller to create a hash of events.
+This avoid the calendar to check every events of the month to display every single cell.
+To use that method, you could pass as argument a mix of any objects which `respond_to?` one of the following method sets :
+
+  * `year`, `month`, `day`
+  * `begin_time`, `end_time`
+
+This method will return an array like this :
+
+    events_by_date => {"2012"=>{"5"=>{"21"=>[#<Event>, #<Event>],
+                                      "22"=>[#<Event>, #<Event>, #<Event>],
+                                      "23"=>[#<Meeting>],
+                                      "25"=>[#<Event>, #<Meeting>],
+                                      "26"=>[#<Event>],
+                                      "27"=>[#<Meeting>, #<Event>]}}}
+
+In your controller :
+
+    class HomeController < ApplicationController
+      include Calendrier::EventExtension
+
+      def index
+        arr = Meeting.all
+        arr << Event.all
+        @events_by_date = sort_events(arr)
+      end
+    end
+
+In your view :
+
+    <%= calendrier(:year => 2012, :month => 5, :day => 25, :start_on_monday => true, :display => :month) do |cell_begin_time, cell_end_time| %>
+      <!-- this code is run for every cell of the calendar -->
+      
+      <% if count_sorted_events(@events_by_date, cell_begin_time, cell_end_time) > 0 %>
+        <!-- this code is run only there is at least one event between cell begin and end -->
+
+        <ul>
+        <% yield_sorted_events(@events_by_date, cell_begin_time, cell_end_time) do |obj| %>
+          <!-- you may handle event/meeting/... with the obj variable -->
+          <li><%= obj.title %></li>
+        <% end %>
+        </ul>
+      <% end %>
+
+    <% end %>
+    
+
+
+##Custom builder
+
+If you need a more complex calendar, you'll need to define a custom builder. To create such builder, add a file like the following. 
+
+    # /lib/calendrier/calendrier_builder/custom_builder.rb
+    module Calendrier
+      module CalendrierBuilder
+        class CustomBuilder < Builder
+
+          def render(header, content)
+             # header is an array like this, having Date object of each columns
+             # [Mon, 21 May 2012,
+             #  Tue, 22 May 2012,
+             #  Wed, 23 May 2012,
+             #  Thu, 24 May 2012,
+             #  Fri, 25 May 2012,
+             #  Sat, 26 May 2012,
+             #  Sun, 27 May 2012]
+             # 
+             # content is a double array like that, containing one Hash for each cell : {:time => Time.utc(<cell_begin_time>), :content => '<block content of this cell>' }
+             # [ [ 7 Hash for one week ], [ 7 Hash for the next week ], ... ]
+             #
+             # [[{:time=>nil, :content=>nil}, # time could be nil on monthly display if week do not starts on monday/sunday (first day of week) 
+             #   {:time=>2012-05-01 00:00:00 +0200, :content=>nil},
+             #   {:time=>2012-05-02 00:00:00 +0200, :content=>nil},
+             #   {:time=>2012-05-03 00:00:00 +0200, :content=>nil},
+             #   {:time=>2012-05-04 00:00:00 +0200, :content=>nil},
+             #   {:time=>2012-05-05 00:00:00 +0200, :content=>nil},
+             #   {:time=>2012-05-06 00:00:00 +0200, :content=>nil}],
+             #   ...
+             # 
+          end
+
+        end
+      end
+    end
+
+And do not forget to add /lib to rails autoload_paths by adding the following line.
+
+    # config/application.rb
+    module MyNiceRailsApplication
+      class Application < Rails::Application
+
+        ...
+
+        # Custom directories with classes and modules you want to be autoloadable.
+        # config.autoload_paths += %W(#{config.root}/extras)
+        config.autoload_paths += %W( #{config.root}/lib )
+
+        ...
+
+      end
+    end
+
+Use your new builder by adding the builder option to the renderer.
+
+    <%= calendrier(:year => 2012, :month => 5, :day => 25, :start_on_monday => true, :display => :month, :builder => Calendrier::CalendrierBuilder::CustomBuilder) %>
+
+
+##INSTALLATION
+
+Add this line to your application's Gemfile :
+
+    gem 'calendrier', :git => "git://github.com/lafourmi/calendrier.git", :branch => "master"
+
+And then execute :
+
+    $ bundle install
+
+Or install it yourself as :
+
+    $ gem install calendrier
+
+
+##AUTHORS
+
+Romain Castel
+
+Thomas Kienlen
+
+##USAGE
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'lib/calendrier'
+  t.libs << 'test' # to find test_helper
+  #t.test_files = FileList['test/lib/calendrier/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
+  #t.verbose = !!ENV["VERBOSE"]
+  t.verbose = true
+end
+task :default => :test

data/calendrier.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/calendrier/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Romain Castel", "Thomas Kienlen"]
+  gem.email         = ["thomas.kienlen@lafourmi-immo.com"]
+  gem.description   = %q{simple calendar}
+  gem.summary       = %q{simple calendar gem, including helpers to display objects inside cells}
+  gem.homepage      = "https://github.com/lafourmi/calendrier"
+
+  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.name          = "calendrier"
+  gem.require_paths = ["lib"]
+  gem.add_dependency 'rails', ['>= 3.0']
+  gem.version       = Calendrier::VERSION
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'nokogiri'
+  unless ENV["CI"]
+    gem.add_development_dependency "turn", "~> 0.9" if defined?(RUBY_VERSION) && RUBY_VERSION > '1.9'
+  end
+end

data/lib/calendrier.rb

@@ -0,0 +1,21 @@
+require "calendrier/version"
+require "calendrier/calendrier_builder"
+require "calendrier/controllers/event_extension"
+require "calendrier/helpers/calendrier_helper"
+require "calendrier/helpers/event_helper"
+
+module Calendrier
+  # including our calendar
+  ActiveSupport.on_load(:action_view) do
+    ::ActionView::Base.send :include, Calendrier::CalendrierHelper
+    # this one is crapy
+    ::ActionView::Base.send :include, Calendrier::EventHelper
+  end
+  # no automatic load
+  # you need to include manually in the controllers where it is needed
+  #ActiveSupport.on_load(:action_controller) do
+  #  ::ActionController::Base.send :include, Calendrier::EventExtension
+  #end
+end
+
+

data/lib/calendrier/calendrier_builder.rb

@@ -0,0 +1,74 @@
+require 'pp'
+
+module Calendrier
+  module CalendrierBuilder
+
+    class Builder
+      def initialize(context, options = {})
+        @context, @options = context, options
+        @options[:display] ||= :month
+
+        unless @options.include? :title
+          month = @options[:month] || nil
+          year = @options[:year] || nil
+          date = (month.nil? || year.nil?) ? Time.now.to_date : Date.new(year, month)
+          @options[:title] = "#{I18n.l(date)}"
+        end
+      end
+
+      def render(&block)
+        raise NotImplementedError
+      end
+    end
+
+    class SimpleBuilder < Builder
+      def render(header, content)
+        display = @options[:display]
+        title = @options[:title] || ''
+
+        @context.content_tag(:div, nil, :class => "calendar #{display.to_s}") do
+          cal = @context.content_tag(:span, title)
+          cal << @context.content_tag(:table, nil) do
+
+            unless header.nil?
+              thead = @context.content_tag(:thead, nil) do
+                ths = "".html_safe
+                ths << @context.content_tag(:th, 'Horaires') if display == :week
+                header.each do |cell_date|
+                  ths << @context.content_tag(:th, I18n.l(cell_date)) if display == :week
+                  ths << @context.content_tag(:th, I18n.l(cell_date, :format => '%A')) if display == :month
+                end
+                ths
+              end
+            end
+
+            unless content.nil?
+              tbody = @context.content_tag(:tbody, nil) do
+                trs = "".html_safe
+                content.each_with_index do |row, index|
+                  trs << @context.content_tag(:tr, nil) do 
+                    tds = "".html_safe
+                    tds << @context.content_tag(:td, index) if display == :week
+                    row.collect do |cell|
+                      cell_content = "".html_safe
+                      cell_time = cell[:time]
+                      cell_content << @context.content_tag(:span, cell_time.day) if display == :month && !cell_time.nil?
+                      cell_content << cell[:content]
+                      tds << @context.content_tag(:td, cell_content)
+                    end
+                    tds
+                  end
+                end
+                @context.concat trs
+              end
+            end
+
+            thead.concat(tbody) unless thead.nil?
+          end
+          cal
+        end
+      end
+    end
+
+  end
+end

data/lib/calendrier/controllers/event_extension.rb

@@ -0,0 +1,57 @@
+module Calendrier
+  module EventExtension
+
+    def sort_events(events)
+      events_by_date = {}
+
+      events.sort_by { |obj| get_event_stamp(obj) }.each do |event|
+
+        begin_date = Time.at(get_event_stamp(event)).to_date
+        end_date = Time.at(get_event_stamp(event, :end_time => true)).to_date
+
+        duration_in_days = (end_date - begin_date).to_i + 1
+
+        duration_in_days.times do |index|
+          current_date = begin_date + index
+          date_arr = [current_date.year.to_s, current_date.month.to_s, current_date.day.to_s]
+          exist = begin
+            true if events_by_date[current_date.year.to_s][current_date.month.to_s][current_date.day.to_s]
+          rescue NoMethodError
+            false
+          end
+          # create recursive hash {"2012"=>{"5"=>{"21"=>[]}}}
+          events_by_date = events_rmerge(events_by_date, date_arr.reverse.inject([]) { |a, n| {n=>a} }) unless exist
+
+          unless events_by_date[current_date.year.to_s][current_date.month.to_s][current_date.day.to_s].include? event
+            events_by_date[current_date.year.to_s][current_date.month.to_s][current_date.day.to_s] << event
+          end
+        end
+      end
+
+      return events_by_date
+    end
+
+    protected
+
+    def events_rmerge(hash, other_hash)
+      r = {}
+      hash.merge(other_hash) do |key, oldval, newval|
+        r[key] = oldval.class == hash.class ? events_rmerge(oldval, newval) : newval
+      end
+    end
+
+    def get_event_stamp(event, options = {})
+      end_time = options[:end_time]
+      ret = nil
+
+      if event.respond_to?(:year) && event.respond_to?(:month) && event.respond_to?(:day)
+        ret = Time.utc(event.year, event.month, event.day).to_i
+      elsif event.respond_to?(:begin_time) && event.respond_to?(:end_time)
+        ret = end_time ? event.end_time : event.begin_time
+      end
+
+      return ret
+    end
+
+  end
+end

data/lib/calendrier/helpers/calendrier_helper.rb

@@ -0,0 +1,94 @@
+module Calendrier
+  module CalendrierHelper
+    DAYS_IN_WEEK = 7
+    HOURS_IN_DAY = 24
+
+    DIMANCHE = 0
+    LUNDI = 1
+
+    def calendrier(options = {}, &block)
+      year = options[:year] || Time.now.year
+      month = options[:month] || Time.now.month
+      day = options[:day] || Time.now.day
+      display = options[:display] || :month
+
+      builder_options = options
+      builder_options[:display] = display unless builder_options.include? :display
+
+      builder = (options.delete(:builder) || CalendrierBuilder::SimpleBuilder).new(self, options)
+      start_on_monday = options[:start_on_monday].nil? ? true : options[:start_on_monday]
+
+      first_day_of_month = Time.utc(year, month, 1).wday
+      first_day_of_month = shift_week_days(first_day_of_month, 1) if start_on_monday
+
+      days_in_month = Time.utc(year, month, 1).end_of_month.day
+      days = (days_in_month + first_day_of_month)
+      weeks_in_month = (days / DAYS_IN_WEEK) + (days % DAYS_IN_WEEK != 0 ? 1 : 0)
+
+      days_arr = []
+      selected_calendar_date = Date.new(year, month, day)
+
+      day_shift = (start_on_monday ? LUNDI : DIMANCHE)
+      first_day_of_week = selected_calendar_date - (selected_calendar_date.wday - day_shift)
+
+
+      if display == :week
+        table_head = (0...DAYS_IN_WEEK).map { |index| first_day_of_week + index }
+        table_content = []
+        (0...HOURS_IN_DAY).each do |hour_index|
+          table_content_row = []
+          DAYS_IN_WEEK.times do |index|
+            this_day = (first_day_of_week + index)
+            cell_begin_time = Time.utc(this_day.year, this_day.month, this_day.day, hour_index)
+            cell_content = nil
+            cell_end_time = cell_begin_time + 3600
+            cell_content = capture(cell_begin_time, cell_end_time, &block) if block_given?
+            table_content_row << { time: cell_begin_time, content: cell_content}
+          end
+          table_content << table_content_row
+        end
+      else # :month
+        table_head = (0...DAYS_IN_WEEK).map { |index| first_day_of_week + index }
+        day_counter = 0
+        weeks_in_month.times do |week_index|
+          (0...DAYS_IN_WEEK).each do |day_index|
+            day_counter += 1 if (day_index == first_day_of_month || day_counter != 0) 
+            days_arr << nil if (day_counter == 0 && day_index != first_day_of_month) || (day_counter != 0 && day_counter > days_in_month) 
+            days_arr << day_counter if (day_counter == 0 && day_index == first_day_of_month) || (day_counter != 0 && day_counter <= days_in_month) 
+          end
+        end
+
+        table_content = []
+        while days_arr.length > 0
+          table_content_row = []
+          one_week = days_arr.slice!(0, DAYS_IN_WEEK)
+          one_week.each do |one_day|
+            cell_content = nil
+            cell_begin_time = nil
+
+            if one_day.is_a?(Integer)
+              cell_begin_time = Time.utc(year, month, one_day)
+              cell_end_time = cell_begin_time + 3600*24
+              cell_content = capture(cell_begin_time, cell_end_time, &block) if block_given?
+            end
+
+            table_content_row << { time: cell_begin_time, content: cell_content}
+          end
+          table_content << table_content_row
+        end
+      end
+
+      builder.render(table_head, table_content).html_safe
+    end
+
+    protected
+
+    def shift_week_days(wday, index)
+      wday -= index
+      wday += DAYS_IN_WEEK if wday < 0
+
+      return wday
+    end
+
+  end
+end