simple_calendar 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 796aabd52df101faf850fc78a815ff5c77cdec9f
-  data.tar.gz: 624565897e01b55df78704601826f9c7bac1d432
+  metadata.gz: 79b8594840b9e18fdf52c8c4fb78cc9010be8e38
+  data.tar.gz: ded158c9f803340a257b9ea3a00702d8dd0b4f55
 SHA512:
-  metadata.gz: 5998574923fe285b6bbe1ff027961dec8217fa2a88dfcb15985dbd1926c5ddb8d39ac74d585aa5f2f9fb19343d2e1f620dff5f4132f7a25e218fe6697ff7a3be
-  data.tar.gz: 4e06bc29b002fcb7dfb288907634637dee753bddf74b6db7e7a02c1b3b4986cc41aab3fc35636590a4c49d39a2f71c61e93296c785f49f3ea0d15d4e2837259a
+  metadata.gz: 25a41a24e87bc41f7cbb68297b64a57b17e8267ba15b5b5cd36b4ea2b37a1b7997d7c6f08575c1d7c8ca563bd8703b5769ca0891d300031d927bd36ea7607c74
+  data.tar.gz: 0728743caa642b7a3d057ce182bcf86e49410e56d17624683bc03642a44b6c74f91bc98dc072603cbf2eafb4f9e35e622c5ded6a5471f2c7aac7a36799213597

data/README.md

@@ -1,7 +1,7 @@
 Simple Calendar
 ===============
 
-Simple Calendar is design to do one thing really really well: render a
+Simple Calendar is designed to do one thing really really well: render a
 calendar. It lets you render a calendar of any size. Maybe you want a
 day view, a 4 day agenda, a week view, a month view, or a 6 week
 calendar. You can do all of that with the new gem, just give it a range
@@ -97,7 +97,7 @@ 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.
+events will automatically be filtered out by day for you.
 
 ```erb
 <%= month_calendar events: @events do |date, events| %>
@@ -145,13 +145,20 @@ class ApplicationController < ActionController::Base
     end
 end
 ```
+If you want to set the time zone globally, you can set the following in
+`config/application.rb`:
 
-You can also change the beginning day of the week. If you want to set
-this globally, you can put this line in
-`config/initializers/simple_calendar.rb`:
+```ruby
+config.time_zone = 'Central Time (US & Canada)'
+```
+
+You can also change the beginning day of the week by setting
+`Date.beginning_of_week` in a `before_filter` just like in the previous
+example. If you want to set this globally, you can put this line in
+`config/application.rb`:
 
 ```ruby
-Date.beginning_of_week = :sunday
+config.beginning_of_week = :sunday
 ```
 
 Setting classes on the table and elements are pretty easy.
@@ -161,7 +168,7 @@ the `content_tag` method so each of them **must** be a hash.
 
 ```ruby
 
-<%= calendar table: {class: "table table-bordered"}, tr: {class: "row"}, td: {class: "day"}, do |day| %>
+<%= calendar table: {class: "table table-bordered"}, tr: {class: "calendar-row"}, td: {class: "day"}, do |date| %>
 <% end %>
 ```
 
@@ -207,7 +214,7 @@ This generate each day in the calendar like this:
 
 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
+adding this to one of your helpers:
 
 ```ruby
 def month_calendar_td_options
@@ -220,7 +227,7 @@ end
 And then your view would use `month_calendar_td_options` as the value.
 
 ```erb
-<%= month_calendar td: month_calendar_td_options do |day| %>
+<%= month_calendar td: month_calendar_td_options do |date| %>
 <% end %>
 ```
 
@@ -230,49 +237,63 @@ Each of the calendar methods will generate a header with links to the
 previous and next views. The `month_calendar` also includes a header
 with a title that tells you the current month and year that you are viewing.
 
-To change these, you can pass in the `prev_link`, `title`, and
+To change these, you can pass in the `previous_link`, `title`, and
 `next_link` options into the calendar methods.
 
-The default `month_calendar` look like this:
+**Use a method in your helpers to return a lambda instead of writing
+them inline like these examples so your views are cleaner.**
 
-```erb
-<%= month_calendar prev_link: ->(range) { link_to raw("&laquo;"), param_name => range.first - 1.day },
-  title: ->{ content_tag :span, "#{I18n.t("date.month_names")[start_date.month]} #{start_date.year}", class: "calendar-title" },
-  next_link: ->(range) { link_to raw("&raquo;"), param_name => range.last + 1.day } do |day| %>
+* `title` option is a lambda that shows at the top of the calendar. For
+month calendars, this is the Month and Year (May 2014)
 
+```erb
+<%= calendar title: ->(start_date) { content_tag :span, "#{I18n.t("date.month_names")[start_date.month]} #{start_date.year}", class: "calendar-title" } do |date, events| %>
 <% end %>
 ```
 
-`title` option is a lambda that
-
-`prev_link` option is a standard `link_to` that is a left arrow and
+* `previous_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.
 
-`next_link` option is a standard `link_to` that is a right arrow and
+```erb
+<%= month_calendar previous_link: ->(param, date_range) { link_to raw("&laquo;"), {param => date_range.first - 1.day} } do |date, events| %>
+<% end %>
+```
+
+* `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.
 
-`title` option is, by default, a simple span tag with the month and year
-inside of it.
+```erb
+<%= calendar next_link: ->(param, date_range) { link_to raw("&raquo;"), {param => date_range.last + 1.day} } do |date, events| %>
+<% end %>
+```
+
+* `header` lets you add options to the header tag
+
+```erb
+<%= calendar header: {class: "calendar-header"} do |date, events| %>
+<% end %>
+```
+
+* `thead` allows you to customize the table headers. These are the
+  abbreviated day names by default (Sun Mon Tue Wed).
 
-If you wish to add some styles to the header, you can use the `header`
-option:
+You can disable the `thead` line if you like by passing in `false`.
 
 ```erb
-<%= month_calendar header: {class: "calendar-header"} do |day| %>
+<%= calendar thead: false do |date, events| %>
 <% end %>
 ```
 
-The table header (thead) is the row of day names across the top. It
-tells you which column is which day. For example `Sun Mon Tue Wed`
+* `day_names` lets you customize the day names in the `thead` row.
 
 If you want to use full day names instead of the abbreviated ones in the
 table header, you can pass in the `day_names` option which points to a
 validate I18n array.
 
 ```erb
-<%= calendar day_names: "date.day_names" do |day, events| %>
+<%= calendar day_names: "date.day_names" do |date, events| %>
 <% end %>
 ```
 
@@ -293,7 +314,7 @@ By default we use the `date.abbr_day_names` translation to have shorter
 header names.
 
 ```erb
-<%= calendar day_names: "date.abbr_day_names" do |day, events| %>
+<%= calendar day_names: "date.abbr_day_names" do |date, events| %>
 <% end %>
 ```
 
@@ -310,13 +331,14 @@ This renders:
 </thead>
 ```
 
-You can disable the `thead` line if you like by passing in `false`.
+### AJAX Calendars
 
-```erb
-<%= month_calendar thead: false do |day| %>
-<% end %>
-```
+Rendering calendars that update with AJAX is pretty simple. You'll need
+to wrap your calendar in a div, overwrite the `next_link` and `previous_link` options, and setup your
+controller to respond to JS requests. The response can simply replace
+the HTML of the div with the newly rendered calendar.
 
+Take a look at **[excid3/simple_calendar-ajax-example](https://github.com/excid3/simple_calendar-ajax-example)** to see how it is done.
 
 ## TODO
 

data/lib/simple_calendar/calendar.rb

@@ -106,7 +106,7 @@ module SimpleCalendar
     end
 
     def start_date
-      @start_date ||= (params[param_name] || Time.zone.now).to_date
+      @start_date ||= (params[param_name] || get_option(:start_date) || Time.zone.now).to_date
     end
 
     def date_range
@@ -139,7 +139,7 @@ module SimpleCalendar
       when Hash
         option
       else
-        option.call(*params) if option.respond_to? :call
+        option.respond_to?(:call) ? option.call(*params) : option
       end
     end
   end

data/lib/simple_calendar/version.rb

@@ -1,3 +1,3 @@
 module SimpleCalendar
-  VERSION = "1.1.3"
+  VERSION = "1.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_calendar
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Chris Oliver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails