simple_calendar 1.1.10 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1bdcbd6d655fbc158f0cf7d66e3895da990d2bd
-  data.tar.gz: c9eae626c02312bf24d10416f0e7fdae69718e9e
+  metadata.gz: 8dfc97c340a63812f227e879a6756c2802c50488
+  data.tar.gz: ebf3dad29eae132666ecc41060996ca812e59d9c
 SHA512:
-  metadata.gz: e18cb18051aa312839aff84a6236302319accd44d208e3c5166e32af5bbe32409ab10149e8d8081f0117a6703ba23eb7e846f843899c64e6d04ec150044d5d9a
-  data.tar.gz: 2c82eaaa511a7c86c95b7e4555528789e84a5a64df3b4c2c6de7cdb0aec8cdad05802ca8360f332664a18e7c0d939f13fcceaa85f32dc64a5b7aa8b3ce1826c3
+  metadata.gz: c7fcff14b9f734bd872120d693bd3b71434cf82d439d92a11767c3cc6fbc862a05d2b297b7937b3704b5c5adf5d0dee6a2390b1bbb0a58a0d9003ad53d0fa9d8
+  data.tar.gz: 32501ddee6d5535fd55a1af0487b66ba9a3b23c3e464e48181e1bb7956de0efacc599decff45c131b9f8ba9f7b4865eb81ea0b8bf7a9256a66d022894332942f

data/.rspec

@@ -1 +1,2 @@
 --color
+--format documentation

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.1.6
+  - 2.0.0

data/README.md

@@ -1,3 +1,5 @@
+![travis ci](https://travis-ci.org/excid3/simple_calendar.svg?branch=2.0)
+
 Simple Calendar
 ===============
 
@@ -19,12 +21,12 @@ Installation
 
 Just add this into your Gemfile followed by a bundle install:
 
-    gem "simple_calendar", "~> 1.1.0"
+    gem "simple_calendar", "~> 2.0"
 
 Usage
 -----
 
-Generating calendars is extremely simple with simple_calendar in version 1.1.
+Generating calendars is extremely simple with simple_calendar.
 
 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.
@@ -77,26 +79,26 @@ model called Meeting, but you can add this to any model or Ruby object.
 Here's an example model:
 
 ```bash
-rails g scaffold Meeting name starts_at:datetime
+rails g scaffold Meeting name start_time:datetime
 ```
 
-We use the `has_calendar` method to tell simple_calendar how to filter
-and sort the meetings on the different calendar days. This should be the
-start date/time of your meeting. By default it uses `starts_at` as the
-attribute name.
+By default it uses `start_time` as the attribute name.
 
-```ruby
-class Meeting < ActiveRecord::Base
-  extend SimpleCalendar
-  has_calendar
+**If you'd like to use another attribute other than start_time, just
+pass it in as the `attribute` option**
 
-  # Or set a custom attribute for simple_calendar to sort by
-  # has_calendar :attribute => :your_starting_time_column_name
-end
+```erb
+<%= month_calendar(attribute: :starts_at) do |date| %>
+  <%= day %>
+<% end %>
 ```
 
 In your controller, query for these meetings and store them in an instance
-variable. We'll just load up all the meetings for this example.
+variable. Normally you'll want to search for the ones that only show up
+inside the calendar view (for example, you may only want to grab the events for
+the current month).
+
+We'll just load up all the meetings for this example.
 
 ```ruby
 def index
@@ -125,13 +127,23 @@ do custom filtering however you want.
 
 ## Customizing The Calendar
 
-You can change a couple of global options that will affect how the
-calendars are generated:
+There are a handful of configuration options that you can use in
+simple_calendar.
 
-```ruby
-Time.zone = "Central Time (US & Canada)"
+### Customizing Views
+
+You can customize the layouts for each of the calendars by running the
+generators for simple_calendar:
+
+```bash
+rails g simple_calendar:views
 ```
 
+This will generate a folder in app/views called simple_calendar that you
+edit to your heart's desire.
+
+### Time Zones
+
 Setting `Time.zone` will make sure the calendar start days are correctly computed
 in the right timezone. You can set this globally in your `application.rb` file or
 if you have a User model with a time_zone attribute, you can set it on every request by using
@@ -153,12 +165,6 @@ class ApplicationController < ActionController::Base
     end
 end
 ```
-On the other hand, you can always pass a ``ActiveSupport::TimeZone`` object as an option to avoid possible timezone pollution:
-
-```erb
-<%= calendar timezone: ActiveSupport::TimeZone.new('Taipei') do |date, events| %>
-<% end %>
-```
 
 If you want to set the time zone globally, you can set the following in
 `config/application.rb`:
@@ -167,6 +173,8 @@ If you want to set the time zone globally, you can set the following in
 config.time_zone = 'Central Time (US & Canada)'
 ```
 
+### Beginning Of Week
+
 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
@@ -176,188 +184,142 @@ example. If you want to set this globally, you can put this line in
 config.beginning_of_week = :sunday
 ```
 
+### Custom CSS Classes
+
 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.
+You can simply run the following command to install the calendar views
+and then add your own helpers to the table, rows, headers, and days.
 
-```ruby
+simple_calendar comes with a handful of useful classes for each day in
+the calendar that you can use:
 
-<%= calendar table: {class: "table table-bordered"}, tr: {class: "calendar-row"}, td: {class: "day"}, do |date| %>
-<% end %>
-```
+```scss
+.simple-calendar {
+  .day {}
 
-This will set the class of `table table-bordered` on the `table` HTML
-element.
+  .wday-0 {}
+  .wday-1 {}
+  .wday-2 {}
+  .wday-3 {}
+  .wday-4 {}
+  .wday-5 {}
+  .wday-6 {}
 
-### Custom Day Classes
+  .today {}
+  .past {}
+  .future {}
 
-`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:
+  .start-date {}
 
+  .prev-month {}
+  .next-month { }
+  .current-month {}
 
-```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}"
+  .has-events {}
+}
 ```
 
-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.
+Just paste this into a CSS file and add your styles and they will be
+applied to the calendar. All of these classes are inside of the
+simple-calendar class so you can scope your own classes with similar
+names.
 
-```erb
-<%= month_calendar td: ->(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:
+### Custom Header Title And Links
 
-```html
-<td class="calendar-date" data-day="2014-05-11">
-</td>
-```
+Header and title links are easily adjusted by generating views and
+modifying them inside your application.
 
-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 one of your helpers:
+For example, if you'd like to use abbreviated month names, you can modify
+the views from this:
 
-```ruby
-def month_calendar_td_options
-  ->(start_date, current_calendar_date) {
-    {class: "calendar-date", data: {day: current_calendar_date}}
-  }
-end
+```erb
+<%= I18n.t("date.month_names")[start_date.month] %> <%= start_date.year %>
 ```
 
-And then your view would use `month_calendar_td_options` as the value.
+To
 
 ```erb
-<%= month_calendar td: month_calendar_td_options do |date| %>
-<% end %>
+<%= I18n.t("date.abbr_month_names")[start_date.month] %> <%= start_date.year %>
 ```
 
-### Custom Header Title And Links
+Your calendar will now display "Sep 2015" instead of "September 2015" at
+the top! :)
 
-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 `previous_link`, `title`, and
-`next_link` options into the calendar methods.
+### AJAX Calendars
 
-**Use a method in your helpers to return a lambda instead of writing
-them inline like these examples so your views are cleaner.**
+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.
 
-* `title` option is a lambda that shows at the top of the calendar. For
-month calendars, this is the Month and Year (May 2014)
+Take a look at **[excid3/simple_calendar-ajax-example](https://github.com/excid3/simple_calendar-ajax-example)** to see how it is done.
 
-```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 %>
-```
 
-* `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.
+## Custom Calendars
 
-```erb
-<%= month_calendar previous_link: ->(param, date_range) { link_to raw("&laquo;"), {param => date_range.first - 1.day} } do |date, events| %>
-<% end %>
-```
+The three main calendars available should take care of most of your
+needs, but simple_calendar makes it easy to create completely custom
+calendars (like maybe you only want business weeks).
 
-* `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.
+If you'd like to make a completely custom calendar, you can create a new
+class that inherits from `SimpleCalendar::Calendar`. The name you give
+it will correspond to the name of the template it will try to render.
 
-```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
+The main method you'll need to implement is the `date_range` so that
+your calendar can have a custom length.
 
-```erb
-<%= calendar header: {class: "calendar-header"} do |date, events| %>
-<% end %>
 ```
+class SimpleCalendar::BusinessWeekCalendar
+  private
 
-* `thead` allows you to customize the table headers. These are the
-  abbreviated day names by default (Sun Mon Tue Wed).
+    def date_range
+      beginning = start_date.beginning_of_week + 1.day
+      ending    = start_date.end_of_week - 1.day
+      (beginning..ending)
+    end
+end
+```
 
-You can disable the `thead` line if you like by passing in `false`.
+To render this in the view, you can do:
 
 ```erb
-<%= calendar thead: false do |date, events| %>
+<%= SimpleCalendar::BusinessWeekCalendar.new(self).render do |date| %>
+  <%= day %>
 <% end %>
 ```
 
-* `day_names` lets you customize the day names in the `thead` row.
+And this will render the
+`app/views/simple_calendar/_business_week_calendar.html.erb` partial.
 
-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.
+You can copy one of the existing templates to use for the partial for
+your new calendar.
 
-```erb
-<%= calendar day_names: "date.day_names" do |date, events| %>
-<% end %>
-```
-
-Which renders:
-
-```html
-<thead>
-  <tr>
-    <th>Sunday</th>
-    <th>Monday</th>
-    <th>Tuesday</th>
-    <th>Wednesday</th>
-  </tr>
-</thead>
-```
+## View Specs and Tests
 
-By default we use the `date.abbr_day_names` translation to have shorter
-header names.
+If you're running view specs against views with calendars, you may run into route generation errors like the following:
 
-```erb
-<%= calendar day_names: "date.abbr_day_names" do |date, events| %>
-<% end %>
 ```
-
-This renders:
-
-```html
-<thead>
-  <tr>
-    <th>Sun</th>
-    <th>Mon</th>
-    <th>Tue</th>
-    <th>Wed</th>
-  </tr>
-</thead>
+Failure/Error: render
+ActionView::Template::Error:
+  No route matches {:action=>"show", :controller=>"controller_name", :start_date=>Sun, 29 Mar 2015}
 ```
 
-### AJAX Calendars
+If so, you can stub out the appropriate method like so (rspec 3 and up):
 
-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.
+```
+expect_any_instance_of(SimpleCalendar::Calendar).to receive(:link_to).at_least(:once).and_return("")
+```
 
-Take a look at **[excid3/simple_calendar-ajax-example](https://github.com/excid3/simple_calendar-ajax-example)** to see how it is done.
+With modifications as appropriate.
 
 ## TODO
 
-- Multi-day events?
+- Multi-day events
+- Rspec tests for Calendar
+- Rspec tests for MonthCalendar
+- Rspec tests for WeekCalendar
 
 ## Author
 
@@ -366,3 +328,7 @@ Chris Oliver <chris@gorails.com>
 [https://gorails.com](https://gorails.com)
 
 [@excid3](https://twitter.com/excid3)
+
+## Support
+
+Need help

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+end

data/app/views/simple_calendar/_calendar.html.erb

@@ -0,0 +1,27 @@
+<div class="simple-calendar">
+  <%= link_to "Previous", start_date: date_range.first - 1.day  %>
+  <%= I18n.t("date.month_names")[start_date.month] %> <%= start_date.year %>
+  <%= link_to "Next", start_date: date_range.last + 1.day  %>
+
+  <table class="table table-striped">
+    <thead>
+      <tr>
+        <% date_range.slice(0, 7).each do |day| %>
+          <th><%= I18n.t("date.abbr_day_names")[day.wday] %></th>
+        <% end %>
+      </tr>
+    </thead>
+
+    <tbody>
+      <% date_range.each_slice(7) do |week| %>
+        <tr>
+          <% week.each do |day| %>
+            <%= content_tag :td, class: calendar.td_classes_for(day) do %>
+              <%= block.call day, sorted_events.fetch(day, []) %>
+            <% end %>
+          <% end %>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/app/views/simple_calendar/_month_calendar.html.erb

@@ -0,0 +1,27 @@
+<div class="simple-calendar">
+  <%= link_to "Previous", start_date: date_range.first - 1.day  %>
+  <%= I18n.t("date.month_names")[start_date.month] %> <%= start_date.year %>
+  <%= link_to "Next", start_date: date_range.last + 1.day  %>
+
+  <table class="table table-striped">
+    <thead>
+      <tr>
+        <% date_range.slice(0, 7).each do |day| %>
+          <th><%= I18n.t("date.abbr_day_names")[day.wday] %></th>
+        <% end %>
+      </tr>
+    </thead>
+
+    <tbody>
+      <% date_range.each_slice(7) do |week| %>
+        <tr>
+          <% week.each do |day| %>
+            <%= content_tag :td, class: calendar.td_classes_for(day) do %>
+              <%= block.call day, sorted_events.fetch(day, []) %>
+            <% end %>
+          <% end %>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/app/views/simple_calendar/_week_calendar.html.erb

@@ -0,0 +1,27 @@
+<div class="simple-calendar">
+  <%= link_to "Previous", start_date: date_range.first - 1.day  %>
+  Week <%= start_date.strftime("%U").to_i %>
+  <%= link_to "Next", start_date: date_range.last + 1.day  %>
+
+  <table class="table table-striped">
+    <thead>
+      <tr>
+        <% date_range.slice(0, 7).each do |day| %>
+          <th><%= I18n.t("date.abbr_day_names")[day.wday] %></th>
+        <% end %>
+      </tr>
+    </thead>
+
+    <tbody>
+      <% date_range.each_slice(7) do |week| %>
+        <tr>
+          <% week.each do |day| %>
+            <%= content_tag :td, class: calendar.td_classes_for(day) do %>
+              <%= block.call day, sorted_events.fetch(day, []) %>
+            <% end %>
+          <% end %>
+        </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'rails'
+require 'simple_calendar'
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install

data/lib/generators/simple_calendar/views_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module SimpleCalendar
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../..", __FILE__)
+
+      def copy_views
+        directory 'app/views/simple_calendar', 'app/views/simple_calendar'
+      end
+    end
+  end
+end

data/lib/simple_calendar.rb

@@ -1,17 +1,7 @@
 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"
 
-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

data/lib/simple_calendar/calendar.rb

@@ -1,147 +1,83 @@
+require 'rails'
+
 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
+    attr_accessor :view_context, :options
 
     def initialize(view_context, opts={})
       @view_context = view_context
-      @events       = opts.delete(:events) { [] }
-      @timezone     = opts.fetch(:timezone, Time.zone)
-
-      opts.reverse_merge!(
-        header: {class: "calendar-header"},
-        previous_link: default_previous_link,
-        title: default_title,
-        next_link: default_next_link,
-        td: default_td_classes,
-        thead: default_thead,
+      @options = opts
+    end
+
+    def render(&block)
+      view_context.render(
+        partial: partial_name,
+        locals: {
+          block: block,
+          calendar: self,
+          date_range: date_range,
+          start_date: start_date,
+          sorted_events: sorted_events
+        }
       )
-
-      @options      = opts
     end
 
-    def render(block)
-      @block = block
+    def td_classes_for(day)
+      today = Time.zone.now.to_date
 
-      capture do
-        concat render_header
-        concat render_table
-      end
-    end
+      td_class = ["day"]
+      td_class << "wday-#{day.wday.to_s}"
+      td_class << "today"         if today == day
+      td_class << "past"          if today > day
+      td_class << "future"        if today < day
+      td_class << 'start-date'    if day.to_date == start_date.to_date
+      td_class << "prev-month"    if start_date.month != day.month && day < start_date
+      td_class << "next-month"    if start_date.month != day.month && day > start_date
+      td_class << "current-month" if start_date.month == day.month
+      td_class << "has-events"    if sorted_events.fetch(day, []).any?
 
-    def render_header
-      capture do
-        content_tag :header, get_option(:header) do
-          concat get_option(:previous_link, param_name, date_range)
-          concat get_option(:title, start_date)
-          concat get_option(:next_link, param_name, date_range)
-        end
-      end
+      td_class
     end
 
-    def render_table
-      content_tag :table, get_option(:table)  do
-        capture do
-          concat get_option(:thead, date_range.to_a.slice(0, 7))
-          concat content_tag(:tbody, render_weeks, get_option(:tbody))
-        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
+    private
 
-    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
+      def partial_name
+        self.class.name.underscore
       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).in_time_zone(@timezone).to_date
-        end.sort_by(&:simple_calendar_start_time)
-      else
-        events
+      def attribute
+        options.fetch(:attribute, :start_time).to_sym
       end
-    end
 
-    def default_previous_link
-      ->(param, date_range) { link_to raw("&laquo;"), param => date_range.first - 1.day }
-    end
-
-    def default_title
-      ->(start_date) {  }
-    end
-
-    def default_next_link
-      ->(param, date_range) { link_to raw("&raquo;"), param => date_range.last + 1.day }
-    end
-
-    def default_thead
-      ->(dates) {
-        content_tag(:thead) do
-          content_tag(:tr) do
-            capture do
-              dates.each do |date|
-                concat content_tag(:th, I18n.t(options.fetch(:day_names, "date.abbr_day_names"))[date.wday])
-              end
-            end
+      def sorted_events
+        events = options.fetch(:events, [])
+        sorted = {}
+
+        events.each do |event|
+          start_time = event.send(attribute)
+          if start_time.present?
+            date = start_time.to_date
+            sorted[date] ||= []
+            sorted[date] << event
+            sorted[date] = sorted[date].sort_by(&attribute)
           end
         end
-      }
-    end
 
-    def start_date
-      @start_date ||= (get_option(:start_date) || params[param_name] || Time.zone.now).to_date
-    end
+        # TODO: move sorting by start_time to after the event loop
 
-    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
+        sorted
+      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}"
-        td_class << "has-events" if events_for_date(current_calendar_date).any?
-
-        { class: td_class.join(" ") }
-      }
-    end
+      def start_date
+        view_context.params.fetch(:start_date, Date.today).to_date
+      end
 
-    def get_option(name, *params)
-      option = options[name]
-      case option
-      when Hash
-        option
-      else
-        option.respond_to?(:call) ? option.call(*params) : option
+      def date_range
+        (start_date..(start_date + additional_days.days)).to_a
+      end
+
+      def additional_days
+        options.fetch(:number_of_days, 4) - 1
       end
-    end
   end
 end

data/lib/simple_calendar/month_calendar.rb

@@ -1,16 +1,10 @@
 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
+  class MonthCalendar < SimpleCalendar::Calendar
+    private
 
-    def default_title
-      ->(start_date) { content_tag :span, month_name(start_date) }
-    end
-
-    def month_name(start_date)
-      "#{I18n.t("date.month_names")[start_date.month]} #{start_date.year}"
-    end
+      def date_range
+        (start_date.beginning_of_month.beginning_of_week..start_date.end_of_month.end_of_week).to_a
+      end
   end
 end
 

data/lib/simple_calendar/railtie.rb

@@ -1,5 +1,5 @@
 module SimpleCalendar
-  class Railtie < Rails::Railtie
+  class Engine < Rails::Engine
     initializer "simple_calendar.view_helpers" do
       ActionView::Base.send :include, ViewHelpers
     end

data/lib/simple_calendar/version.rb

@@ -1,3 +1,3 @@
 module SimpleCalendar
-  VERSION = "1.1.10"
+  VERSION = "2.0.0"
 end

data/lib/simple_calendar/view_helpers.rb

@@ -2,17 +2,17 @@ module SimpleCalendar
   module ViewHelpers
     def calendar(options={}, &block)
       raise 'calendar requires a block' unless block_given?
-      SimpleCalendar::Calendar.new(self, options).render(block)
+      SimpleCalendar::Calendar.new(self, options).render(&block)
     end
 
     def month_calendar(options={}, &block)
       raise 'month_calendar requires a block' unless block_given?
-      SimpleCalendar::MonthCalendar.new(self, options).render(block)
+      SimpleCalendar::MonthCalendar.new(self, options).render(&block)
     end
 
     def week_calendar(options={}, &block)
       raise 'week_calendar requires a block' unless block_given?
-      SimpleCalendar::WeekCalendar.new(self, options).render(block)
+      SimpleCalendar::WeekCalendar.new(self, options).render(&block)
     end
   end
 end

data/lib/simple_calendar/week_calendar.rb

@@ -1,44 +1,16 @@
 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
+  class WeekCalendar < SimpleCalendar::Calendar
+    private
 
-    def default_title
-      ->(start_date) { content_tag :span, 
-              if month_name(@date_range.last) == month_name(start_date)
-                month_name(start_date) .
-                  concat year_number(start_date)
-              else
-                month_name(start_date) .
-                  concat " into " .
-                  concat month_name(@date_range.last) .
-                  concat year_number @date_range.last
-              end
-          }
-    end
+      def date_range
+        starting = start_date.beginning_of_week
+        ending = (starting + (number_of_weeks - 1).weeks).end_of_week
 
-    def default_previous_link
-      ->(param, date_range) { link_to raw("&laquo;"), param => date_range.first - (((options.fetch(:number_of_weeks, 1) - 1) * 7) + 1).days }
-    end
+        (starting..ending).to_a
+      end
 
-    def default_next_link
-      ->(param, date_range) { link_to raw("&raquo;"), param => date_range.last + 1.day }
-    end
-
-    def month_name(date)
-      "#{I18n.t("date.month_names")[date.month]}"
-    end
-
-    def year_number(date)
-       " #{date.year}"
-    end
+      def number_of_weeks
+        options.fetch(:number_of_weeks, 1)
+      end
   end
 end
-

data/simple_calendar.gemspec

@@ -19,4 +19,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency 'rails', '>= 3.0'
+  s.add_development_dependency 'rspec'
 end

data/spec/calendar_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'simple_calendar/calendar'
+
+class ViewContext
+  attr_accessor :start_date
+
+  def initialize(start_date=nil)
+    @start_date = start_date
+  end
+
+  def params
+    if @start_date.present?
+      {start_date: @start_date}
+    else
+      {}
+    end
+  end
+end
+
+describe SimpleCalendar::Calendar do
+  let(:calendar) { SimpleCalendar::Calendar.new(nil) }
+
+  it 'renders a partial with the same name as the class' do
+    expect(calendar.send(:partial_name)).to eq("simple_calendar/calendar")
+  end
+
+  context 'event sorting attribute' do
+    it 'has start_time as the default attribute' do
+      expect(calendar.send(:attribute)).to eq(:start_time)
+    end
+
+    it 'allows you to override the default attribute' do
+      expect(SimpleCalendar::Calendar.new(nil, attribute: :starts_at).send(:attribute)).to eq(:starts_at)
+    end
+  end
+
+  describe "#sorted_events" do
+    it 'converts an array of events to a hash sorted by days'
+  end
+
+  describe "#start_date" do
+    it "defaults to today's date" do
+      view_context = ViewContext.new()
+      calendar = SimpleCalendar::Calendar.new(view_context)
+      expect(calendar.send(:start_date)).to eq(Date.today)
+    end
+
+    it "uses the params start_date to override" do
+      view_context = ViewContext.new(Date.yesterday)
+      calendar = SimpleCalendar::Calendar.new(view_context)
+      expect(calendar.send(:start_date)).to eq(Date.yesterday)
+    end
+  end
+
+  it 'has a param that determines the start date of the calendar'
+  it 'generates a default date if no start date is present'
+  it 'has a range of dates'
+
+  it 'can split the range of dates into weeks'
+  it 'has a title'
+  it 'has a next view link'
+  it 'has a previous view link'
+
+  it 'accepts an array of events'
+  it 'sorts the events'
+  it 'yields the events for each day'
+
+  it "doesn't crash when an event has a nil start_time"
+end

data/spec/calendars/month_calendar_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'simple_calendar/month_calendar'
+
+describe SimpleCalendar::MonthCalendar do
+  it 'renders a full calendar month'
+  it 'render the days of next and previous months on the edges of the calendar'
+end

data/spec/simple_calendar_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'rails'
+
+describe SimpleCalendar do
+  it 'has a version number' do
+    expect(SimpleCalendar::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,96 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/views_generators_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+require "generators/simple_calendar/views_generator"
+
+describe SimpleCalendar::Generators::ViewsGenerator do
+    it 'copies the files to app/views/simple_calendar'
+    it 'verifies the content'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_calendar
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-06 00:00:00.000000000 Z
+date: 2015-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,27 +24,54 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple Rails 3 and Rails 4 calendar
 email:
 - excid3@gmail.com
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
+- app/views/simple_calendar/_calendar.html.erb
+- app/views/simple_calendar/_month_calendar.html.erb
+- app/views/simple_calendar/_week_calendar.html.erb
+- bin/console
+- bin/setup
+- lib/generators/simple_calendar/views_generator.rb
 - 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
+- spec/calendar_spec.rb
+- spec/calendars/month_calendar_spec.rb
+- spec/simple_calendar_spec.rb
+- spec/spec_helper.rb
+- spec/views_generators_spec.rb
 homepage: https://github.com/excid3/simple_calendar
 licenses: []
 metadata: {}
@@ -64,8 +91,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: simple_calendar
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A simple Rails 3 and Rails 4 calendar
-test_files: []
+test_files:
+- spec/calendar_spec.rb
+- spec/calendars/month_calendar_spec.rb
+- spec/simple_calendar_spec.rb
+- spec/spec_helper.rb
+- spec/views_generators_spec.rb

data/lib/simple_calendar/model_additions.rb

@@ -1,16 +0,0 @@
-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