simple_calendar 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae8f18ccce8e55fd2c7caefb28f9260befdb50c8
-  data.tar.gz: ed5657eb62db1fee6021f516f935eed13c55335c
+  metadata.gz: 4ac05b82caf3c5475d9890349e7fe90fb9c536d1
+  data.tar.gz: df0ee7c7ba1fc634b41aa703dde69b89ec1040a5
 SHA512:
-  metadata.gz: 687581a924042ef175fede1beb7fbf550dbbf5e8a936b7365d6b9c362d9484216c092bcc80abfcf3a116dff5184758393db77514c2023285662b86417e73170c
-  data.tar.gz: 2d70ac7b3b28297e0e6cdbf457078240dbadcff2ed0635d1f4fccae5e45acc722ebc5814367137ca9001908bbc51872987fb03c0540ffe2b00ad3ba6da5c25a8
+  metadata.gz: af7ea6649813615d366c6915e883ee128a125526308e8caeb960da9552046d70407fe5c6dc87cf9f29effec7710064d181a2fb25f8e3f65782392ef2a1e7388c
+  data.tar.gz: ae67ff184ff36292f9c6ab38a55159c0d390a439436d49b33f577aaa5e3ed4268e17e8075038c116dbd6e8ae206f8f13e9d1d8c2945d1c80dccc4784fa716063

data/README.md

@@ -17,12 +17,12 @@ Installation
 
 Just add this into your Gemfile followed by a bundle install:
 
-    gem "simple_calendar", "~> 1.0.0"
+    gem "simple_calendar", "~> 1.1.0"
 
 Usage
 -----
 
-Generating calendars is extremely simple with simple_calendar in version 1.0.
+Generating calendars is extremely simple with simple_calendar in version 1.1.
 
 The first parameter is a symbol that looks up the current date in
 `params`. If no date is found, it will use the current date.
@@ -33,22 +33,20 @@ In these examples, we're using `:start_date` which is the default.
 
 You can generate a calendar for the month with the `month_calendar`
 method.
-This will use `params[:start_date]` to render the calendar.
 
 ```erb
-<%= month_calendar :start_date do |day| %>
-  <%= day %>
+<%= month_calendar do |date| %>
+  <%= date %>
 <% end %>
 ```
 
 ### Week Calendar
 
 You can generate a week calendar with the `week_calendar` method.
-This will use `params[:start_date]` to render the calendar.
 
 ```erb
-<%= week_calendar :start_date, number_of_weeks: 2 do |day| %>
-  <%= day %>
+<%= week_calendar number_of_weeks: 2 do |date| %>
+  <%= date %>
 <% end %>
 ```
 
@@ -57,16 +55,66 @@ Setting `number_of_weeks` is optional and defaults to 1.
 ### Custom Length Calendar
 
 You can generate calendars of any length by passing in the number of days you want to render.
-This will use `params[:start_date]` to render the calendar.
 
 ```erb
-<%= calendar :start_date, number_of_days: 4 do |day| %>
-  <%= day %>
+<%= calendar number_of_days: 4 do |date| %>
+  <%= date %>
 <% end %>
 ```
 
 Setting `number_of_days` is optional and defaults to 4.
 
+## Rendering Events
+
+What's a calendar without events in it? There are two simple steps for
+creating calendars with events.
+
+The first step is to add the following to your model. We'll be using a
+model called Event, but you can add this to any model or Ruby object.
+
+We use the `has_calendar` method to tell simple_calendar how to filter
+and sort the events on the different calendar days. This should be the
+start date/time of your event. By default it uses `starts_at` as the
+attribute name.
+
+```ruby
+class Event < ActiveRecord::Base
+  extend SimpleCalendar
+  has_calendar
+
+  # Or set a custom attribute for simple_calendar to sort by
+  # has_calendar :attribute => :your_starting_time_column_name
+end
+```
+
+In your controller, query for these events and store them in an instance
+variable. We'll just load up all the events for this example.
+
+```ruby
+def index
+  @events = Event.all
+end
+```
+
+Then in your view, you can pass in the `events` option to render. The
+events will automatically be filter out by day for you.
+
+```erb
+<%= month_calendar events: @events do |date, events| %>
+  <%= date %>
+
+  <% events.each do |event| %>
+    <div>
+      <%= event.name %>
+    </div>
+  <% end %>
+<% end %>
+```
+
+If you pass in objects that don't respond to the attribute method (like
+starts_at), then all the events will be yielded each day. This lets you
+do custom filtering however you want.
+
 ## Customizing The Calendar
 
 You can change a couple of global options that will affect how the
@@ -113,10 +161,7 @@ the `content_tag` method so each of them **must** be a hash.
 
 ```ruby
 
-<%= calendar :start_date,
-  table: {class: "table table-bordered"},
-  tr: {class: "row"},
-  td: {class: "day"}, do |day| %>
+<%= calendar table: {class: "table table-bordered"}, tr: {class: "row"}, td: {class: "day"}, do |day| %>
 <% end %>
 ```
 
@@ -149,9 +194,7 @@ content_tag options. If you wish to set a class or data attributes, just
 set them as you normally would in a content_tag call.
 
 ```erb
-<%= month_calendar :start_date, tr: ->(start_date,
-current_calendar_date) { {class: "calendar-date", data: {day:
-current_calendar_date}} } do |day| %>
+<%= month_calendar td: ->(start_date, current_calendar_date) { {class: "calendar-date", data: {day: current_calendar_date}} } do |day| %>
 <% end %>
 ```
 
@@ -162,6 +205,25 @@ This generate each day in the calendar like this:
 </td>
 ```
 
+Instead of writing the lambdas inline, a cleaner approach is to write a
+helper that returns a lambda. You can duplicate the following example by
+adding this to your helpers
+
+```ruby
+def month_calendar_td_options
+  ->(start_date, current_calendar_date) {
+    {class: "calendar-date", data: {day: current_calendar_date}}
+  }
+end
+```
+
+And then your view would use `month_calendar_td_options` as the value.
+
+```erb
+<%= month_calendar td: month_calendar_td_options do |day| %>
+<% end %>
+```
+
 ### Custom Header Links
 
 Each of the calendar methods will generate a header with links to the
@@ -174,8 +236,7 @@ To change these, you can pass in the `prev_link`, `header`, and
 The default `month_calendar` look like this:
 
 ```erb
-<%= month_calendar :start_date,
-  prev_link: ->(range) { link_to raw("&laquo;"), param_name => range.first - 1.day },
+<%= month_calendar prev_link: ->(range) { link_to raw("&laquo;"), param_name => range.first - 1.day },
   header: ->{ content_tag :span, "#{I18n.t("date.month_names")[start_date.month]} #{start_date.year}", class: "calendar-header" },
   next_link: ->(range) { link_to raw("&raquo;"), param_name => range.last + 1.day } do |day| %>
 
@@ -197,16 +258,12 @@ If you wish to disable any of these partsof the header, just pass in
 `false` and that will hide it:
 
 ```erb
-<%= month_calendar :start_date, header: false do |day| %>
+<%= month_calendar header: false do |day| %>
 <% end %>
 ```
 
 ## TODO
 
-- Having an "events" option would be nice. Users can pass in all the
-  objects and we can use it to auto-filter them so the user doesn't
-  have to. This is what the previous version did and yielded the
-  day's events to the block.
 - Multi-day events?
 
 ## Author

data/lib/simple_calendar/calendar.rb

@@ -0,0 +1,126 @@
+module SimpleCalendar
+  class Calendar
+    delegate :capture, :concat, :content_tag, :link_to, :params, :raw, :safe_join, to: :view_context
+
+    attr_reader :block, :events, :options, :view_context
+
+    def initialize(view_context, options={})
+      @view_context = view_context
+      @events       = options.delete(:events) { [] }
+      @options      = options
+      @options[:previous_link] ||= default_previous_link
+      @options[:header]        ||= default_header
+      @options[:next_link]     ||= default_next_link
+      @options[:td]            ||= default_td_classes
+    end
+
+    def render(block)
+      @block = block
+
+      capture do
+        concat render_header
+        concat render_table
+      end
+    end
+
+    def render_header
+      capture do
+        content_tag :div do
+          concat get_option(:previous_link, param_name, date_range)
+          concat get_option(:header, start_date)
+          concat get_option(:next_link, param_name, date_range)
+        end
+      end
+    end
+
+    def render_table
+      content_tag :table, get_option(:table)  do
+        content_tag :tbody, get_option(:tbody) do
+          render_weeks
+        end
+      end
+    end
+
+    def render_weeks
+      capture do
+        date_range.each_slice(7) do |week|
+          concat content_tag(:tr, render_week(week), get_option(:tr, week))
+        end
+      end
+    end
+
+    def render_week(week)
+      results = week.map do |day|
+        content_tag :td, get_option(:td, start_date, day) do
+          block.call day, events_for_date(day)
+        end
+      end
+      safe_join results
+    end
+
+    def param_name
+      @param_name ||= options.fetch(:param_name, :start_date)
+    end
+
+    def events_for_date(current_date)
+      if events.any? && events.first.respond_to?(:simple_calendar_start_time)
+        events.select do |e|
+          current_date == e.send(:simple_calendar_start_time).to_date
+        end.sort_by(&:simple_calendar_start_time)
+      else
+        events
+      end
+    end
+
+    def default_previous_link
+      ->(param, date_range) { link_to raw("«"), param => date_range.first - 1.day }
+    end
+
+    def default_header
+      ->(start_date) {  }
+    end
+
+    def default_next_link
+      ->(param, date_range) { link_to raw("»"), param => date_range.last + 1.day }
+    end
+
+    def start_date
+      @start_date ||= (params[param_name] ||Time.zone.now).to_date
+    end
+
+    def date_range
+      @date_range ||= begin
+                        number_of_days = options.fetch(:number_of_days, 4) - 1
+                        start_date..(start_date + number_of_days.days)
+                      end
+    end
+
+    def default_td_classes
+      ->(start_date, current_calendar_date) {
+        today = Time.zone.now.to_date
+        td_class = ["day"]
+
+        td_class << "today"  if today == current_calendar_date
+        td_class << "past"   if today > current_calendar_date
+        td_class << "future" if today < current_calendar_date
+        td_class << "prev-month"    if start_date.month != current_calendar_date.month && current_calendar_date < start_date
+        td_class << "next-month"    if start_date.month != current_calendar_date.month && current_calendar_date > start_date
+        td_class << "current-month" if start_date.month == current_calendar_date.month
+        td_class << "wday-#{current_calendar_date.wday.to_s}"
+
+        { class: td_class.join(" ") }
+      }
+    end
+
+    def get_option(name, *params)
+      option = options[name]
+      case option
+      when Hash
+        option
+      else
+        option.call(*params) if option.respond_to? :call
+      end
+    end
+  end
+end
+

data/lib/simple_calendar/model_additions.rb

@@ -0,0 +1,16 @@
+module SimpleCalendar
+  module ModelAdditions
+    def has_calendar(options={})
+      config = { :attribute => :starts_at }
+
+      # Override default config
+      config.update(options) if options.is_a?(Hash)
+
+      class_eval <<-EOV
+        def simple_calendar_start_time
+          #{config[:attribute]}
+        end
+      EOV
+    end
+  end
+end

data/lib/simple_calendar/month_calendar.rb

@@ -0,0 +1,16 @@
+module SimpleCalendar
+  class MonthCalendar < Calendar
+    def date_range
+      @date_range ||= start_date.beginning_of_month.beginning_of_week..start_date.end_of_month.end_of_week
+    end
+
+    def default_header
+      ->(start_date) { content_tag :span, month_name(start_date), class: "calendar-header" }
+    end
+
+    def month_name(start_date)
+      "#{I18n.t("date.month_names")[start_date.month]} #{start_date.year}"
+    end
+  end
+end
+

data/lib/simple_calendar/version.rb

@@ -1,3 +1,3 @@
 module SimpleCalendar
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/lib/simple_calendar/view_helpers.rb

@@ -1,150 +1,18 @@
 module SimpleCalendar
   module ViewHelpers
-    def month_calendar(param_name=:start_date, options={}, &block)
-      start_date = (params[param_name] || Time.zone.now).to_date
-
-      options.reverse_merge!(
-        td: day_classes,
-        prev_link: ->(range) { link_to raw("«"), param_name => range.first - 1.day },
-        header: month_header,
-        next_link: ->(range) { link_to raw("»"), param_name => range.last + 1.day },
-        start_date: start_date,
-      )
-      render_calendar month_range(start_date), options, &block
-    end
-
-    def week_calendar(param_name=:start_date, options={}, &block)
-      start_date = (params[param_name] || Time.zone.now).to_date
-      number_of_weeks = options.fetch(:number_of_weeks, 1)
-
-      options.reverse_merge!(
-        td: day_classes,
-        prev_link: ->(range) { link_to raw("«"), param_name => range.first - 1.day },
-        header: false,
-        next_link: ->(range) { link_to raw("»"), param_name => range.last + 1.day },
-        start_date: start_date,
-      )
-      render_calendar week_range(start_date, number_of_weeks), options, &block
-    end
-
-    def calendar(param_name=:start_date, options={}, &block)
-      start_date = (params[param_name] || Time.zone.now).to_date
-      number_of_days_to_advance = options.fetch(:number_of_days, 4) - 1
-
-      options.reverse_merge!(
-        td: day_classes,
-        prev_link: ->(range) { link_to raw("«"), param_name => range.first - 1.day },
-        header: false,
-        next_link: ->(range) { link_to raw("»"), param_name => range.last + 1.day },
-        start_date: start_date,
-      )
-      render_calendar calendar_range(start_date, number_of_days_to_advance), options, &block
-    end
-
-    def month_range(start_date)
-      start_date.beginning_of_month.beginning_of_week.to_date..start_date.end_of_month.end_of_week.to_date
-    end
-
-    def week_range(start_date, number_of_weeks)
-      number_of_days_to_advance = (number_of_weeks * 7) - 1
-      starting_day              = start_date.beginning_of_week.to_date
-      ending_day                = starting_day + number_of_days_to_advance.days
-      starting_day..ending_day
-    end
-
-    def calendar_range(start_date, number_of_days_to_advance)
-      start_date..(start_date + number_of_days_to_advance.days)
-    end
-
-    def render_calendar(range, options, &block)
-      raise 'SimpleCalendar requires a block' unless block_given?
-
-      @block      = block
-      @options    = options.reverse_merge default_options
-      @start_date = options.fetch(:start_date)
-
-      capture do
-        concat render_header(@start_date, range)
-        concat render_table(range)
-      end
-    end
-
-    def render_header(start_date, range)
-      capture do
-        content_tag :div do
-          concat get_options(@options[:prev_link], range)
-          concat get_options(@options[:header], start_date)
-          concat get_options(@options[:next_link], range)
-        end
-      end
-    end
-
-    def render_table(range)
-      content_tag(:table, get_options(@options[:table])) do
-        content_tag(:tbody) do
-          render_weeks(range)
-        end
-      end
-    end
-
-
-    def render_weeks(range)
-      weeks = []
-      range.each_slice(7) do |week|
-        weeks << content_tag(:tr, get_options(@options[:tr], week)) do
-          render_week(week)
-        end
-      end
-      safe_join weeks
+    def calendar(options={}, &block)
+      raise 'calendar requires a block' unless block_given?
+      SimpleCalendar::Calendar.new(self, options).render(block)
     end
 
-    def render_week(week)
-      results = week.map do |day|
-        content_tag :td, get_options(@options[:td], @start_date, day) do
-          @block.call(day)
-        end
-      end
-      safe_join results
-    end
-
-    def get_options(options, *params)
-      case options
-      when Hash
-        options
-      when String
-        send(options, *params)
-      when Symbol
-        send(options, *params)
-      else
-        options.call(*params) if options.respond_to? :call
-      end
-    end
-
-    def default_options
-      { table: {}, tr: {}, td: {}, }
-    end
-
-    def day_classes
-      ->(start_date, current_calendar_date) {
-        today = Time.zone.now.to_date
-        td_class = ["day"]
-
-        td_class << "today"  if today == current_calendar_date
-        td_class << "past"   if today > current_calendar_date
-        td_class << "future" if today < current_calendar_date
-        td_class << "prev-month"    if start_date.month != current_calendar_date.month && current_calendar_date < start_date
-        td_class << "next-month"    if start_date.month != current_calendar_date.month && current_calendar_date > start_date
-        td_class << "current-month" if start_date.month == current_calendar_date.month
-        td_class << "wday-#{current_calendar_date.wday.to_s}"
-
-        { class: td_class.join(" ") }
-      }
+    def month_calendar(options={}, &block)
+      raise 'month_calendar requires a block' unless block_given?
+      SimpleCalendar::MonthCalendar.new(self, options).render(block)
     end
 
-    def month_header
-      ->(start_date) {
-        content_tag :span, "#{I18n.t("date.month_names")[start_date.month]} #{start_date.year}", class: "calendar-header"
-      }
+    def week_calendar(options={}, &block)
+      raise 'week_calendar requires a block' unless block_given?
+      SimpleCalendar::WeekCalendar.new(self, options).render(block)
     end
   end
 end

data/lib/simple_calendar/week_calendar.rb

@@ -0,0 +1,22 @@
+module SimpleCalendar
+  class WeekCalendar < Calendar
+    def date_range
+      @date_range ||= begin
+                        number_of_weeks = options.fetch(:number_of_weeks, 1)
+                        number_of_days  = (number_of_weeks * 7) - 1
+                        starting_day              = start_date.beginning_of_week.to_date
+                        ending_day                = starting_day + number_of_days.days
+                        starting_day..ending_day
+                      end
+    end
+
+    def default_previous_link
+      ->(param, date_range) { link_to raw("&laquo;"), param => date_range.first - 8.days }
+    end
+
+    def default_next_link
+      ->(param, date_range) { link_to raw("&raquo;"), param => date_range.last + 1.day }
+    end
+  end
+end
+

data/lib/simple_calendar.rb

@@ -1,3 +1,17 @@
+require "simple_calendar/calendar"
+require "simple_calendar/month_calendar"
+require "simple_calendar/week_calendar"
+require "simple_calendar/model_additions"
+require "simple_calendar/railtie"
 require "simple_calendar/version"
 require "simple_calendar/view_helpers"
-require "simple_calendar/railtie"
+
+module SimpleCalendar
+  def self.extended(model_class)
+    return if model_class.respond_to? :has_calendar
+
+    model_class.class_eval do
+      extend ModelAdditions
+    end
+  end
+end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: simple_calendar
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-12 00:00:00.000000000 Z
+date: 2014-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.0'
 description: A simple Rails 3 and Rails 4 calendar
@@ -31,15 +31,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
+- .gitignore
+- .rspec
 - Gemfile
 - README.md
 - Rakefile
 - lib/simple_calendar.rb
+- lib/simple_calendar/calendar.rb
+- lib/simple_calendar/model_additions.rb
+- lib/simple_calendar/month_calendar.rb
 - lib/simple_calendar/railtie.rb
 - lib/simple_calendar/version.rb
 - lib/simple_calendar/view_helpers.rb
+- lib/simple_calendar/week_calendar.rb
 - simple_calendar.gemspec
 homepage: https://github.com/excid3/simple_calendar
 licenses: []
@@ -50,12 +54,12 @@ 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: []