simple_calendar 2.2.4 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ae043df3828ea514cfbc68ed0d1284434251f1c2
-  data.tar.gz: a79029db7a1b2cdd7e306214e471c416c572cb28
+SHA256:
+  metadata.gz: 994f74fe8cc221e2a6b74c3f57d24391d9214e9ad511ca03ba24a986ff0082c1
+  data.tar.gz: 4473aab5073e486696990218578198c35627d5fd8429bff8fb8e02a845f14b4c
 SHA512:
-  metadata.gz: b6c0a2d71036917b42732c22c2c4625fc3bb7ff1d3b9878ef1a9beffce7a2f47e423eecaf98aec0e50d0f3fcc0ae592dfdaa275fcc7d6dd1e1ef52a3734acd78
-  data.tar.gz: 006074a747db645038610dd7b541bdf069b5af6a0f7195fed0263efc40307784acacbbea2a7238641cf7a5ac9e2781bab24e7a3a576cf4fad468efdeee1dcbbc
+  metadata.gz: 91bcb6559bafdbe99cc18e0b6f1f6a373b5485908e0ad2622a8e2a2d5e8481e3d3bc884161a9164bd6859d2e2fc6729c715827bc7e1af5a1b91f2de5879e09d2
+  data.tar.gz: 7b2c6dfafab0edfecb1444fb14b6709ae89a9f324b6d64086bf4541df8001b9ee81c58f4229e96e10cdb73ba284a59d0e3abadfbe188e7cd15f546abef7be6b7

data/.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [excid3] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
-  - 2.3.1
-  - 2.2.5
+  - 2.4.2
+  - 2.3.5
+  - 2.2.8

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+### 2.4.0
+
+* [BREAKING] Fixes Rails 4.2 by changing `block` to `passed_block`. A
+  security fix in Rails makes `block` a reserved local name that we can
+  no longer use.
+
+  **Upgrading**: If you've customized the simple_calendar views, rename
+  `block` to `passed_block`. Without this, calendar dates will be empty.

data/README.md

@@ -24,6 +24,16 @@ Just add this into your Gemfile followed by a bundle install:
 gem "simple_calendar", "~> 2.0"
 ```
 
+If you're using Bootstrap, the calendar should already have a border and
+nice spacing for days.
+
+Optionally, you can include the default stylesheet for the calendar in
+your `app/assets/stylesheets/application.css` file:
+
+```scss
+*= require simple_calendar
+```
+
 Usage
 -----
 
@@ -45,6 +55,8 @@ method.
 <% end %>
 ```
 
+To show the day of the month instead of the date, use `<%= date.day %>`
+
 ### Week Calendar
 
 You can generate a week calendar with the `week_calendar` method.
@@ -69,6 +81,17 @@ You can generate calendars of any length by passing in the number of days you wa
 
 Setting `number_of_days` is optional and defaults to 4.
 
+### Custom Parameter Name
+
+You can pass in `start_date_param` to change the name of the parameter
+in the URL for the current calendar view.
+
+```erb
+<%= calendar start_date_param: :my_date do |date| %>
+  <%= date %>
+<% end %>
+```
+
 ### Custom Partial
 
 You can set a different partial name for calendars by passing the partial path.
@@ -79,8 +102,6 @@ You can set a different partial name for calendars by passing the partial path.
 <% 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
@@ -99,17 +120,26 @@ $ rails g scaffold Meeting name start_time:datetime
 $ rails g scaffold Meeting name start_time:datetime end_time:datetime
 ```
 
-By default it uses `start_time` as the attribute name.  Optionally the `end_time`
-attribute can be used which enables multi-day event rendering.
-
-**If you'd like to use another attribute other than start_time or end_time, just
-pass it in as the `attribute` or `end_attribute` options respectively**
+By default it uses `start_time` as the attribute name.  
+**If you'd like to use another attribute other than start_time, just
+pass it in as the `attribute`**
 
 ```erb
 <%= month_calendar(attribute: :starts_at) do |date| %>
   <%= date %>
 <% end %>
 ```
+
+Optionally the `end_time` attribute can be used which enables multi-day event rendering.
+
+**Just pass in the `attribute` and `end_attribute` options respectively**
+
+```erb
+<%= month_calendar(attribute: :start_date, end_attribute: :end_date) do |date| %>
+  <%= date %>
+<% end %>
+```
+
 **If you already have a model with a start time attribute called something other than `start_time` or accesses it through a relationship, you can alias the attribute by defining a `start_time` method in the my_model.rb file and not have to specify it separately as in the above example**
 ```ruby
 class MyModel
@@ -175,7 +205,7 @@ edit to your heart's desire.
 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
-a before_filter like the following example.
+a before_action like the following example.
 
 This code example uses [Devise](https://github.com/plataformatec/devise)'s
 `current_user` and `user_signed_in?` methods to retrieve the user's timezone and set it for the duration of the request.
@@ -184,7 +214,7 @@ using some other method of authentication.
 
 ```ruby
 class ApplicationController < ActionController::Base
-  before_filter :set_time_zone, if: :user_signed_in?
+  before_action :set_time_zone, if: :user_signed_in?
 
   private
 
@@ -204,7 +234,7 @@ 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
+`Date.beginning_of_week` in a `before_action` just like in the previous
 example. If you want to set this globally, you can put this line in
 `config/application.rb`:
 
@@ -212,18 +242,6 @@ example. If you want to set this globally, you can put this line in
 config.beginning_of_week = :sunday
 ```
 
-### Default Stylesheet
-
-If you're using Bootstrap, the calendar should already have a border and
-nice spacing for days.
-
-Optionally, you can include the default stylesheet for the calendar in
-your `app/assets/stylesheets/application.css` file:
-
-```scss
-*= require simple_calendar
-```
-
 ### Custom CSS Classes
 
 Setting classes on the table and elements are pretty easy.
@@ -308,7 +326,7 @@ The main method you'll need to implement is the `date_range` so that
 your calendar can have a custom length.
 
 ```ruby
-class SimpleCalendar::BusinessWeekCalendar
+class SimpleCalendar::BusinessWeekCalendar < SimpleCalendar::Calendar
   private
 
     def date_range
@@ -322,7 +340,7 @@ end
 To render this in the view, you can do:
 
 ```erb
-<%= SimpleCalendar::BusinessWeekCalendar.new(self).render do |date| %>
+<%= SimpleCalendar::BusinessWeekCalendar.new(self, {}).render do |date| %>
   <%= date %>
 <% end %>
 ```

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

@@ -16,17 +16,17 @@
 
     <tbody>
       <% date_range.each_slice(7) do |week| %>
-        <tr>
+        <%= content_tag :tr, class: calendar.tr_classes_for(week) do %>
           <% week.each do |day| %>
             <%= content_tag :td, class: calendar.td_classes_for(day) do %>
-              <% if defined?(Haml) && respond_to?(:block_is_haml?) && block_is_haml?(block) %>
-                <% capture_haml(day, sorted_events.fetch(day, []), &block) %>
+              <% if defined?(Haml) && respond_to?(:block_is_haml?) && block_is_haml?(passed_block) %>
+                <% capture_haml(day, sorted_events.fetch(day, []), &passed_block) %>
               <% else %>
-                <% block.call day, sorted_events.fetch(day, []) %>
+                <% passed_block.call day, sorted_events.fetch(day, []) %>
               <% end %>
             <% end %>
           <% end %>
-        </tr>
+        <% end %>
       <% end %>
     </tbody>
   </table>

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

@@ -19,10 +19,10 @@
         <tr>
           <% week.each do |day| %>
             <%= content_tag :td, class: calendar.td_classes_for(day) do %>
-              <% if defined?(Haml) && respond_to?(:block_is_haml?) && block_is_haml?(block) %>
-                <% capture_haml(day, sorted_events.fetch(day, []), &block) %>
+              <% if defined?(Haml) && respond_to?(:block_is_haml?) && block_is_haml?(passed_block) %>
+                <% capture_haml(day, sorted_events.fetch(day, []), &passed_block) %>
               <% else %>
-                <% block.call day, sorted_events.fetch(day, []) %>
+                <% passed_block.call day, sorted_events.fetch(day, []) %>
               <% end %>
             <% end %>
           <% end %>

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

@@ -1,8 +1,12 @@
 <div class="simple-calendar">
   <div class="calendar-heading">
     <%= link_to t('simple_calendar.previous', default: 'Previous'), calendar.url_for_previous_view %>
-    <span class="calendar-title">Week <%= calendar.week_number %></span>
-    <%= link_to t('simple_calendar.next', default: 'Next'), calendar.url_for_next_view %>
+    <% if calendar.number_of_weeks == 1 %>
+      <span class="calendar-title">Week <%= calendar.week_number %></span>
+    <%else%>
+        <span class="calendar-title">Week <%= calendar.week_number %> - <%= calendar.end_week %></span>
+    <%end%>
+        <%= link_to t('simple_calendar.next', default: 'Next'), calendar.url_for_next_view %>
   </div>
 
   <table class="table table-striped">
@@ -19,10 +23,10 @@
         <tr>
           <% week.each do |day| %>
             <%= content_tag :td, class: calendar.td_classes_for(day) do %>
-              <% if defined?(Haml) && respond_to?(:block_is_haml?) && block_is_haml?(block) %>
-                <% capture_haml(day, sorted_events.fetch(day, []), &block) %>
+              <% if defined?(Haml) && respond_to?(:block_is_haml?) && block_is_haml?(passed_block) %>
+                <% capture_haml(day, sorted_events.fetch(day, []), &passed_block) %>
               <% else %>
-                <% block.call day, sorted_events.fetch(day, []) %>
+                <% passed_block.call day, sorted_events.fetch(day, []) %>
               <% end %>
             <% end %>
           <% end %>

data/lib/simple_calendar/calendar.rb

@@ -10,16 +10,20 @@ module SimpleCalendar
       @view_context = view_context
       @options = opts
 
+      # Next and previous view links should use the same params as the current view
       @params = @view_context.respond_to?(:params) ? @view_context.params : Hash.new
       @params = @params.to_unsafe_h if @params.respond_to?(:to_unsafe_h)
       @params = @params.with_indifferent_access.except(*PARAM_KEY_BLACKLIST)
+
+      # Add in any additional params the user passed in
+      @params.merge!(@options.fetch(:params, {}))
     end
 
     def render(&block)
       view_context.render(
         partial: partial_name,
         locals: {
-          block: block,
+          passed_block: block,
           calendar: self,
           date_range: date_range,
           start_date: start_date,
@@ -45,12 +49,24 @@ module SimpleCalendar
       td_class
     end
 
+    def tr_classes_for(week)
+      today = Date.current
+      tr_class = ['week']
+      tr_class << 'current-week' if week.include?(today)
+
+      tr_class
+    end
+
     def url_for_next_view
-      view_context.url_for(@params.merge(start_date: date_range.last + 1.day))
+      view_context.url_for(@params.merge(start_date_param => date_range.last + 1.day))
     end
 
     def url_for_previous_view
-      view_context.url_for(@params.merge(start_date: date_range.first - 1.day))
+      view_context.url_for(@params.merge(start_date_param => date_range.first - 1.day))
+    end
+
+    def date_range
+      (start_date..(start_date + additional_days.days)).to_a
     end
 
     private
@@ -67,6 +83,10 @@ module SimpleCalendar
         options.fetch(:end_attribute, :end_time).to_sym
       end
 
+      def start_date_param
+        options.fetch(:start_date_param, :start_date).to_sym
+      end
+
       def sorted_events
         @sorted_events ||= begin
                              events = options.fetch(:events, []).reject { |e| e.send(attribute).nil? }.sort_by(&attribute)
@@ -92,7 +112,7 @@ module SimpleCalendar
         if options.has_key?(:start_date)
           options.fetch(:start_date).to_date
         else
-          view_context.params.fetch(:start_date, Date.current).to_date
+          view_context.params.fetch(start_date_param, Date.current).to_date
         end
       end
 
@@ -100,10 +120,6 @@ module SimpleCalendar
         date_range.last
       end
 
-      def date_range
-        (start_date..(start_date + additional_days.days)).to_a
-      end
-
       def additional_days
         options.fetch(:number_of_days, 4) - 1
       end

data/lib/simple_calendar/month_calendar.rb

@@ -1,10 +1,8 @@
 module SimpleCalendar
   class MonthCalendar < SimpleCalendar::Calendar
-    private
-
-      def date_range
-        (start_date.beginning_of_month.beginning_of_week..start_date.end_of_month.end_of_week).to_a
-      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/version.rb

@@ -1,3 +1,3 @@
 module SimpleCalendar
-  VERSION = "2.2.4"
+  VERSION = "2.4.0"
 end

data/lib/simple_calendar/week_calendar.rb

@@ -1,21 +1,23 @@
 module SimpleCalendar
   class WeekCalendar < SimpleCalendar::Calendar
     def week_number
-      format = (Date.beginning_of_week == :sunday) ? "%U" : "%W"
+      format = (Date.beginning_of_week == :sunday) ? "%U" : "%V"
       start_date.beginning_of_week.strftime(format).to_i
     end
 
-    private
+    def number_of_weeks
+      options.fetch(:number_of_weeks, 1)
+    end
 
-      def date_range
-        starting = start_date.beginning_of_week
-        ending = (starting + (number_of_weeks - 1).weeks).end_of_week
+    def end_week
+      week_number + number_of_weeks - 1
+    end
 
-        (starting..ending).to_a
-      end
+    def date_range
+      starting = start_date.beginning_of_week
+      ending = (starting + (number_of_weeks - 1).weeks).end_of_week
 
-      def number_of_weeks
-        options.fetch(:number_of_weeks, 1)
-      end
+      (starting..ending).to_a
+    end
   end
 end

data/spec/calendar_spec.rb

@@ -1,22 +1,8 @@
 require 'spec_helper'
 require 'action_controller'
 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?
-      ActionController::Parameters.new({start_date: @start_date})
-    else
-      ActionController::Parameters.new
-    end
-  end
-end
+require_relative 'support/fake_event'
+require_relative 'support/view_context'
 
 describe SimpleCalendar::Calendar do
   let(:calendar) { SimpleCalendar::Calendar.new(ViewContext.new) }
@@ -104,20 +90,87 @@ describe SimpleCalendar::Calendar do
       calendar = SimpleCalendar::Calendar.new(view_context, start_date: Date.tomorrow)
       expect(calendar.send(:start_date)).to eq(Date.tomorrow)
     end
+
+    it "takes an option to override the start_date parameter" do
+      view_context = ViewContext.new(Date.yesterday, start_date_param: :date)
+      calendar = SimpleCalendar::Calendar.new(view_context, start_date_param: :date)
+      expect(calendar.send(:start_date)).to eq(Date.yesterday)
+    end
+  end
+
+  describe 'current week class' do
+    it 'should have the current week' do
+      calendar = SimpleCalendar::Calendar.new(ViewContext.new)
+      week = calendar.date_range.each_slice(7).to_a[0]
+      expect(calendar.send(:tr_classes_for, week)).to include('current-week')
+    end
+
+    it 'should not have the current week if it does not contain today' do
+      calendar = SimpleCalendar::MonthCalendar.new(ViewContext.new(6.months.ago))
+      week = calendar.date_range.each_slice(7).to_a[0]
+      expect(calendar.send(:tr_classes_for, week)).to_not include('current-week')
+    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 'has a param that determines the start date of the calendar' do
+    calendar = SimpleCalendar::Calendar.new(ViewContext.new)
+
+    rendering_variables = calendar.render[:locals]
+
+    expect(rendering_variables[:start_date]).not_to be_nil
+  end
+
+  it 'generates a default date if no start date is present' do
+    calendar = SimpleCalendar::Calendar.new(ViewContext.new)
+
+    calendar_start_date = calendar.render[:locals][:start_date]
+
+    expect(calendar_start_date).not_to be_nil
+    expect(calendar_start_date).to be_a(Date)
+  end
+
+  it 'has a range of dates' do
+    calendar = SimpleCalendar::Calendar.new(ViewContext.new)
+
+    calendar_date_range = calendar.date_range
+
+    expect(calendar_date_range).to be_an(Array)
+    expect(calendar_date_range).to all(be_an(Date))
+  end
 
   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 'accepts an array of events' do
+    first_event = FakeEvent.new('event1', Date.today)
+    second_event = FakeEvent.new('event2', Date.today + 1.day)
+    events = [first_event, second_event]
+    calendar = SimpleCalendar::Calendar.new(ViewContext.new, events: events)
+
+    calendar_sorted_events = calendar.render[:locals][:sorted_events]
+
+    expect(calendar_sorted_events.length).to eq(2)
+  end
+
+  it 'sorts the events' do
+    first_event = FakeEvent.new('event1', Date.today + 2.days)
+    second_event = FakeEvent.new('event2', Date.today + 1.day)
+    third_event = FakeEvent.new('event3', Date.today)
+    events = [first_event, third_event, second_event]
+    calendar = SimpleCalendar::Calendar.new(ViewContext.new, events: events)
+
+    calendar_sorted_events = calendar.render[:locals][:sorted_events]
+    first_key = calendar_sorted_events.keys[0]
+    second_key = calendar_sorted_events.keys[1]
+    third_key = calendar_sorted_events.keys[2]
+
+    expect(calendar_sorted_events[first_key][0]).to eq(third_event)
+    expect(calendar_sorted_events[second_key][0]).to eq(second_event)
+    expect(calendar_sorted_events[third_key][0]).to eq(first_event)
+  end
 
+  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

@@ -1,7 +1,25 @@
 require 'spec_helper'
+require 'action_controller'
+require 'simple_calendar/calendar'
 require 'simple_calendar/month_calendar'
+require 'support/view_context'
 
 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'
+  describe '#date_range' do
+    it 'renders a full calendar month' do
+      today = Date.today
+      calendar = SimpleCalendar::MonthCalendar.new(ViewContext.new, start_date: Date.today)
+
+      expect(calendar.date_range.min).to be <= today.beginning_of_month
+      expect(calendar.date_range.max).to be >= today.end_of_month
+    end
+
+    it 'render the days of next and previous months on the edges of the calendar' do
+      month = Date.new(2018, 8, 1)
+      calendar = SimpleCalendar::MonthCalendar.new(ViewContext.new, start_date: month)
+
+      expect(calendar.date_range.first).to eq Date.new(2018, 7, 30)
+      expect(calendar.date_range.last).to eq Date.new(2018, 9, 2)
+    end
+  end
 end

data/spec/support/fake_event.rb

@@ -0,0 +1,9 @@
+class FakeEvent
+  attr_accessor :name, :start_time, :end_time
+
+  def initialize(name='event', start_time=nil, end_time=nil)
+    @name       = name
+    @start_time = start_time
+    @end_time   = end_time
+  end
+end

data/spec/support/view_context.rb

@@ -0,0 +1,20 @@
+class ViewContext
+  attr_accessor :start_date, :start_date_param
+
+  def initialize(start_date=nil, options={})
+    @start_date = start_date
+    @start_date_param = options.fetch(:start_date_param, :start_date)
+  end
+
+  def params
+    if @start_date.present?
+      ActionController::Parameters.new({start_date_param => @start_date})
+    else
+      ActionController::Parameters.new
+    end
+  end
+
+  def render(options = {})
+    options
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_calendar
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.4.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-26 00:00:00.000000000 Z
+date: 2020-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -45,9 +45,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -71,6 +73,8 @@ files:
 - spec/calendars/month_calendar_spec.rb
 - spec/simple_calendar_spec.rb
 - spec/spec_helper.rb
+- spec/support/fake_event.rb
+- spec/support/view_context.rb
 - spec/views_generators_spec.rb
 homepage: https://github.com/excid3/simple_calendar
 licenses:
@@ -91,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: simple_calendar
-rubygems_version: 2.6.8
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A simple Rails calendar
@@ -101,4 +104,6 @@ test_files:
 - spec/calendars/month_calendar_spec.rb
 - spec/simple_calendar_spec.rb
 - spec/spec_helper.rb
+- spec/support/fake_event.rb
+- spec/support/view_context.rb
 - spec/views_generators_spec.rb