simple_calendar 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc702d5bfc9216617da9921539291ed03e61fd97
-  data.tar.gz: 4eec246dd685d28eea8f822483380c9121e53912
+  metadata.gz: ae8f18ccce8e55fd2c7caefb28f9260befdb50c8
+  data.tar.gz: ed5657eb62db1fee6021f516f935eed13c55335c
 SHA512:
-  metadata.gz: 45d62759c32d0a1ec5dadf6ebe3d819f8604bef0c4d99f5e45832d4e0d5815d001f788155d39d5067ee66979298ec23ac035b37940b571c7c00ca0c909bd8aa0
-  data.tar.gz: b0ece55d4cac8003ca070a9bd8803e02c7ce6f9c6ca6f7357f65eaa4db12540e2a5f0de00544589b4ac1446ce5c91a489c131f945da852086376a24bdd26b7fe
+  metadata.gz: 687581a924042ef175fede1beb7fbf550dbbf5e8a936b7365d6b9c362d9484216c092bcc80abfcf3a116dff5184758393db77514c2023285662b86417e73170c
+  data.tar.gz: 2d70ac7b3b28297e0e6cdbf457078240dbadcff2ed0635d1f4fccae5e45acc722ebc5814367137ca9001908bbc51872987fb03c0540ffe2b00ad3ba6da5c25a8

data/README.md

@@ -106,7 +106,10 @@ this globally, you can put this line in
 Date.beginning_of_week = :sunday
 ```
 
-Setting classes on the table and elements are pretty:
+Setting classes on the table and elements are pretty easy.
+
+Each of the options are passed directly to the
+the `content_tag` method so each of them **must** be a hash.
 
 ```ruby
 
@@ -120,8 +123,44 @@ Setting classes on the table and elements are pretty:
 This will set the class of `table table-bordered` on the `table` HTML
 element.
 
-Each of the `table`, `tr`, and `td`, options are passed directly to the
-the `content_tag` method so each of them **must** be a hash.
+### Custom Day Classes
+
+`td` is an option for setting the options on the td content tag that is
+generated. By default, simple_calendar renders the following classes for
+any given day in a calendar:
+
+
+```ruby
+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}"
+```
+
+You can set your CSS styles based upon these if you want to highlight
+specific days or types of days. If you wish to override this
+functionality, just set the `tr` option to a lambda that accepts two
+dates and returns a hash. The hash will be passed in directly to the
+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| %>
+<% end %>
+```
+
+This generate each day in the calendar like this:
+
+```html
+<td class="calendar-date" data-day="2014-05-11">
+</td>
+```
 
 ### Custom Header Links
 
@@ -143,15 +182,15 @@ The default `month_calendar` look like this:
 <% end %>
 ```
 
-The `prev_link` option is a standard `link_to` that is a left arrow and
+`prev_link` option is a standard `link_to` that is a left arrow and
 with the current url having `?start_date=2014-04-30` appended to it as
 a date in the previous view of the calendar.
 
-The `next_link` option is a standard `link_to` that is a right arrow and
+`next_link` option is a standard `link_to` that is a right arrow and
 with the current url having `?start_date=2014-06-01` appended to it as
 a date in the next view of the calendar.
 
-The `header` option is just a simple span tag with the month and year
+`header` option is just a simple span tag with the month and year
 inside of it.
 
 If you wish to disable any of these partsof the header, just pass in
@@ -162,6 +201,13 @@ If you wish to disable any of these partsof the header, just pass in
 <% 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/version.rb

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

data/lib/simple_calendar/view_helpers.rb

@@ -4,9 +4,11 @@ module SimpleCalendar
       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: ->{ content_tag :span, "#{I18n.t("date.month_names")[start_date.month]} #{start_date.year}", class: "calendar-header" },
+        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
@@ -16,9 +18,11 @@ module SimpleCalendar
       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
@@ -28,9 +32,11 @@ module SimpleCalendar
       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
@@ -53,20 +59,21 @@ module SimpleCalendar
     def render_calendar(range, options, &block)
       raise 'SimpleCalendar requires a block' unless block_given?
 
-      @block   = block
-      @options = options.reverse_merge default_options
+      @block      = block
+      @options    = options.reverse_merge default_options
+      @start_date = options.fetch(:start_date)
 
       capture do
-        concat render_header(range)
+        concat render_header(@start_date, range)
         concat render_table(range)
       end
     end
 
-    def render_header(range)
+    def render_header(start_date, range)
       capture do
         content_tag :div do
           concat get_options(@options[:prev_link], range)
-          concat get_options(@options[:header])
+          concat get_options(@options[:header], start_date)
           concat get_options(@options[:next_link], range)
         end
       end
@@ -93,7 +100,7 @@ module SimpleCalendar
 
     def render_week(week)
       results = week.map do |day|
-        content_tag :td, get_options(@options[:td], day) do
+        content_tag :td, get_options(@options[:td], @start_date, day) do
           @block.call(day)
         end
       end
@@ -116,5 +123,28 @@ module SimpleCalendar
     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(" ") }
+      }
+    end
+
+    def month_header
+      ->(start_date) {
+        content_tag :span, "#{I18n.t("date.month_names")[start_date.month]} #{start_date.year}", class: "calendar-header"
+      }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_calendar
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Chris Oliver