simple_calendar 0.0.8 → 0.1.1

data/README.md

@@ -2,41 +2,61 @@ Simple Calendar
 ===============
 
 This is a small Rails 3.2 gem for creating a quick and clean table calendar.
-Theming is up to you, but it works nicely with Twitter Bootstrap.
+Theming is up to you, but it works nicely with Twitter Bootstrap. It's
+compatible with pure Ruby classes, ActiveRecord, Mongoid, and any other
+ORM.
 
-Thanks to Josh Chernoff for an early rewrite of the calendar generation
-code.
+Thanks to Josh Chernoff and all other contributors.
 
 Installation
 ------------
 
 Just add this into your Gemfile followed by a bundle install:
 
-    gem "simple_calendar", "~> 0.0.7"
+    gem "simple_calendar", "~> 0.1.1"
 
 Usage
 -----
 
-####Model
+#### Model
 
-Here we have a model called Event with the start_time attribute that we
-will be using with simple_calendar.
+SimpleCalendar will look for a method on your model called `start_time`.
+This is used to determine the day and time of the event. This should be
+a `DateTime` object or at least respond similarly.
 
-    class Event < ActiveRecord::Base
-      has_calendar
-    end
+If you don't have an attribute called `start_time` on your model, you
+can simply delegate like so:
 
-has_calendar has options that can be passed to it for configuration:
+```ruby
+class Event < ActiveRecord::Base
+  attr_accessible :name, :event_start_time
 
-    has_calendar :start_time => :my_start_column
+  def start_time
+    event_start_time
+  end
+end
+```
 
-The `start_time` option is the field for the start time of the event. This will use
-`my_start_column` to determine which day to render the event on.
+As long as `start_time` returns a `DateTime` object, you're good to go.
+This means SimpleCalendar is now compatible with any class, whether it's
+ORM backed like ActiveRecord, Mongoid, or it's just a pure Ruby class.
+(Yay!)
 
-####Views
+##### Querying
 
-We query the events we want to display as usual, and then render the
-calendar in the view like so:
+SimpleCalendar uses `params[:month]` and `params[:year]` to determine
+which month of the calendar to render. You can use these to make your
+database queries more efficient.
+
+#### Views
+
+SimpleCalendar just accepts an array of events and a block. The block
+will be executed for each event so you can provide your own logic for
+displaying the events.
+
+Here's an example that uses SimpleCalendar to simply render a link to
+each event on its own line inside the table. You would simply query for
+the `@events` as discussed above in the querying section.
 
     <%= calendar @events do |event| %>
       <div><%= link_to event.title, event %></div>
@@ -58,15 +78,15 @@ Possible options:
 
     :year	           # current year, default: from params or current year
     :month		       # current month, default: from params or current month
-    :prev_text         # previous month link text, default: &laquo;
-    :next_text         # next month link text, default: &raquo;
+    :prev_text       # previous month link text, default: &laquo;
+    :next_text       # next month link text, default: &raquo;
 
 CSS
 ---
 
 You will probably want to customize the height of the calendar so that
-all the rows are the same. You can do this by adding the following line
-to your css:
+all the rows are the same heights and widths. You can do this by adding
+the following line to your css:
 
     .calendar td { height: 100px; width: 14.28%; }
 
@@ -76,7 +96,4 @@ and .calendar classes.
 TODO
 ====
 
-* Add query helpers to grab events for a current month and the days into
-  the next and previous months for efficiency
 * Customizable starting day of week
-* More customization?

data/lib/simple_calendar.rb

@@ -1,4 +1,3 @@
 require "simple_calendar/version"
 require "simple_calendar/view_helpers"
-require "simple_calendar/model_additions"
 require "simple_calendar/railtie"

data/lib/simple_calendar/railtie.rb

@@ -3,10 +3,5 @@ module SimpleCalendar
     initializer "simple_calendar.view_helpers" do
       ActionView::Base.send :include, ViewHelpers
     end
-    initializer "simple_calendar.model_additions" do
-      ActiveSupport.on_load :active_record do
-        extend ModelAdditions
-      end
-    end
   end
 end

data/lib/simple_calendar/version.rb

@@ -1,3 +1,3 @@
 module SimpleCalendar
-  VERSION = "0.0.8"
+  VERSION = "0.1.1"
 end

data/lib/simple_calendar/view_helpers.rb

@@ -2,6 +2,9 @@ module SimpleCalendar
   module ViewHelpers
 
     def calendar(events, options={}, &block)
+      raise 'SimpleCalendar requires a block to be passed in' unless block_given?
+
+
       opts = {
           :year       => (params[:year] || Time.zone.now.year).to_i,
           :month      => (params[:month] || Time.zone.now.month).to_i,
@@ -9,6 +12,7 @@ module SimpleCalendar
           :next_text  => raw("»")
       }
       options.reverse_merge! opts
+      events       ||= []
       selected_month = Date.civil(options[:year], options[:month])
       current_date   = Date.today
       range          = build_range selected_month
@@ -26,7 +30,7 @@ module SimpleCalendar
       end_date   = selected_month.end_of_month
       end_date   = end_date.saturday? ? end_date : end_date.end_of_week(:sunday)
 
-      date_range = (start_date..end_date).to_a
+      (start_date..end_date).to_a
     end
 
     def build_month(date_range)
@@ -73,7 +77,7 @@ module SimpleCalendar
                     divs = []
 
                     concat content_tag(:div, date.day.to_s, :class=>"day_number")
-                    divs << day_events(date, events).collect {|event| block.call(event) }
+                    divs << day_events(date, events).collect { |event| block.call(event) }
                     divs.join.html_safe
                   end #content_tag :div
                 end #content_tag :td
@@ -90,7 +94,7 @@ module SimpleCalendar
 
     # Returns an array of events for a given day
     def day_events(date, events)
-      events.select { |e| e.start_time_column.to_date == date }
+      events.select { |e| e.start_time.to_date == date }
     end
 
     # Generates the header that includes the month and next and previous months

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_calendar
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-27 00:00:00.000000000 Z
+date: 2012-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,7 +39,6 @@ files:
 - README.md
 - Rakefile
 - lib/simple_calendar.rb
-- lib/simple_calendar/model_additions.rb
 - lib/simple_calendar/railtie.rb
 - lib/simple_calendar/version.rb
 - lib/simple_calendar/view_helpers.rb
@@ -56,12 +55,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1074299040452234765
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1074299040452234765
 requirements: []
 rubyforge_project: simple_calendar
 rubygems_version: 1.8.24

data/lib/simple_calendar/model_additions.rb

@@ -1,15 +0,0 @@
-module SimpleCalendar
-  module ModelAdditions
-    def has_calendar(options={})
-      config = { :start_time => "start_time"}
-      config.update(options) if options.is_a?(Hash)
-
-      class_eval <<-EOV
-        def start_time_column
-          #{config[:start_time]}
-        end
-      EOV
-    end
-  end
-end
-