simple_calendar-timeslot 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6707f6b5e80e3b24e0329d17e629cfef2d39179c3e725baad3a60d526503963a
-  data.tar.gz: c05379b32ca660ac1cee7d0c44ee09c2666c0bbbbf60759c169127e057c90d1d
+  metadata.gz: e642f680ea5441076624a829e2e672a1cbb57f8b2ffffcf161dd658ae8b5b17c
+  data.tar.gz: 39caf7b4c9a72da1e11e8b21c12fb2fd8c7928ef86d18a572afaa6a0d9709d0c
 SHA512:
-  metadata.gz: 74c59bce0c06b79e65b9838b39c4222b5e481546f43a577acaf56cda80781bf553a86d29bfd21366aeb0b0daa226fe5b7e630b482f5e435bd3280dd438316e6a
-  data.tar.gz: 7c7583c4197f06951d76bc784a7444ec3c2c17bfcad0e466d7d3c3449407ec1de3f93b314f83c1e40c83322106554edabe6f5f6f8239916b8529308cf0d65e90
+  metadata.gz: ae67297856bc7d27e71ab6740c9b73b7e033d24a5cd7f3b5d9d3f4cc032fa0e7f36f1b5f63375529aa954af4f6a34be0385cbdf5d2d8abeabfe997aaff44bbf2
+  data.tar.gz: 05126f7fe63a2027f731f56138bffd965aebf46e0943da182b2d35cb337f6df860a0e097bc1293522ce4256706ae429fd944071aa0543516ed16641ca7ecba26

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 ## [Unreleased]
 
+## [0.6.0] - 2021-11-15
+### Added
+- Added option horizontal_scroll_split to view helper, which defaults to false. This option affects
+horizontal orientation only. If set to false, the
+different days of the calendar scroll together horizontally, which is more consistent with the
+behaviour of the vertical layout. If set to true, the days scroll independently.
+
+## [0.5.1] - 2021-11-15
+### Fixed
+- Fixed reliance of calendar on legacy function to
+calculate event height
+
+## [0.5.0] - 2021-11-14
+- Removed images for the README from the gem, sry :(
+
+## [0.4.0] - 2021-11-14
+### Added
+- Added compatibilty with the attribute and end_attribute options in the view helper
+- Added documentation to README
+
 ## [0.3.0] - 2021-11-14
 ### Fixed
 - Fix issue with css styles when including style of this gem and simple_calendar

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_calendar-timeslot (0.3.0)
+    simple_calendar-timeslot (0.6.0)
       simple_calendar (~> 2.0)
 
 GEM
@@ -90,6 +90,8 @@ GEM
     nokogiri (1.12.5)
       mini_portile2 (~> 2.6.1)
       racc (~> 1.4)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
     parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)

data/README.md

@@ -2,10 +2,18 @@
 
 This is an extension of the rubygem `simple_calendar` by Chris Oliver aka excid3. It allows 
 for simple calendar creation in a Ruby on Rails app with an timeslot representation of events 
-in a 24h day. This helps to visually grasps the length of events and the time between them. In case of overlapping, the respective events are shown side-by-side. It is also possible to categorise events in buckets according to some function, then they will be shown next to one another in the 24h timeline.
+in a 24h day. 
+
+This helps to visually grasps the length of events and the time between them. In case of overlapping, the respective events are shown side-by-side. It is also possible to categorise events in buckets according to some function, then they will be shown next to one another in the 24h timeline.
+
 Horizontal and vertical layout is selectable via options, just like many other ones.
 
-TODO: show examples
+Horizontal example
+![Horizontal Calendar](https://github.com/1klap/simple_calendar-timeslot/blob/96475bf7c354b7e0318a9421e155588d96517fc3/img/simple_calendar-timeslot_horizontal.png?raw=true)
+
+Vertical example
+![Vertical Calendar](https://github.com/1klap/simple_calendar-timeslot/blob/96475bf7c354b7e0318a9421e155588d96517fc3/img/simple_calendar-timeslot_vertical.png?raw=true)
+
 
 ## Installation
 
@@ -23,12 +31,56 @@ Or install it yourself as:
 
     $ gem install simple_calendar-timeslot
 
-TODO: include stylesheet, show sprockets and scss usecases
+
+**Important** Then include the stylesheet in your rails app.
+
+If you have an `application.css` file, include the following:
+```ruby
+*= require simple_calendar-timeslot
+```
+If you use an SCSS file (`application.scss`), add the following line instead:
+```ruby
+@import 'simple_calendar-timeslot';
+```
 
 ## Usage
 
 TODO: Write usage instructions here
 
+Your model must implement a `start_time` and `end_time` function,
+or you can specify alternatives as options to the call below
+as `attribute: :my_start_time` and `end_attribute: :my_end_time`.
+
+```erb
+<%= timeslot_calendar(events: @events,
+                      number_of_days: 2,
+                      px_per_minute: 1.5,
+                      orientation: :horizontal,
+                      horizontal_height_px: 250,
+                      # attribute: :my_start_time,
+                      # display_grid: false,
+                      # display_bucket_title: :event_type,
+                      # bucket_title_size: 30,
+                      # grid_width: "20px",
+                      # split_by_type: :event_type
+                     ) do |event| %>
+  <div class="timeslot-event">
+    <%= event.title %>
+  </div>
+<% end %>
+
+```
+
+Shortversion in the meantime:
+- orientation (:vertical, :horizontal, default: :vertical)
+- horizontal_height_px default: 300
+- split_by_type (model function to call in case of bucketung f.ex.`:event_type`, default: false)
+- px_per_minute default: 0.65
+- display_bucket_title (model function to call in case of bucketung f.ex.`:event_type_name`, default: false)
+- bucket_title_size default: 20
+- grid_width default: 20px
+- display_grid default: true
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/app/assets/stylesheets/simple_calendar-timeslot.css

@@ -9,6 +9,10 @@
   display: flex;
   flex-direction: column;
 }
+.timeslot-calendar .days-wrapper-horizontal.scroll-link {
+  overflow-x: auto;
+  overflow-y: hidden;
+}
 .timeslot-calendar .day-wrapper {
   flex: 1 1 0;
 }
@@ -21,6 +25,8 @@
   display: flex;
   flex-direction: column;
   position: relative;
+}
+.timeslot-calendar .day-content-horizontal.scroll-split {
   overflow-x: auto;
   overflow-y: hidden;
 }

data/app/views/simple_calendar/timeslot/_timeslot_calendar.html.erb

@@ -66,7 +66,7 @@
       <% end %>
     </div>
   <% elsif calendar.orientation == :horizontal %>
-    <div class="days-wrapper-horizontal">
+    <div class="days-wrapper-horizontal <%= calendar.horizontal_scroll_split ? "" : "scroll-link" %>">
       <% date_range.slice(0, 7).each do |day| %>
         <div class="day-wrapper">
           <div class="day-title-row">
@@ -78,7 +78,7 @@
             </span>
           </div>
           <%= content_tag :div, class: calendar.td_classes_for(day) do %>
-            <div class="day-content-horizontal">
+            <div class="day-content-horizontal <%= calendar.horizontal_scroll_split ? "scroll-split" : "" %>">
               <div class="day-content-horizontal-inner" style="width:<%=calendar.height%>px;height:<%=calendar.horizontal_height_px%>px">
                 <% if calendar.display_grid %>
                   <div class="hour-indicator-col-horizontal" style="z-index:-10;">

data/lib/simple_calendar/timeslot/timeslot_calendar.rb

@@ -1,53 +1,31 @@
 require "simple_calendar"
 
 module SimpleCalendar
-  module Timeslot
+  module Timeslot    
     class TimeslotCalendar < SimpleCalendar::Calendar
       MINUTE_HEIGHT_PX = 0.65
       FIRST_HOUR_SLOT = 0
-    
-      def height
-        h = (24 - TimeslotCalendar::FIRST_HOUR_SLOT) * 60 * px_per_minute
-        h = h+bucket_title_size if display_bucket_title
-        h
-      end
-    
-      def event_height(event, day)
-        minutes = if event.start_time.to_date != day
-                    (event.end_time - event.end_time.midnight)/60
-                  elsif event.start_time.to_date < event.end_time.to_date
-                    (event.end_time.midnight - 60 - event.start_time)/60
-                  else
-                    event.duration
-                  end
-        minutes * px_per_minute
-      end
-    
-      def event_top_distance(event, day)
-        return 0 if event.start_time.to_date != day
-        (event.start_time.hour - TimeslotCalendar::FIRST_HOUR_SLOT) * 60 * px_per_minute + event.start_time.min * px_per_minute
-      end
-    
+
       def orientation
         @options.fetch(:orientation, :vertical)
       end
-    
+
       def horizontal_height_px
         @options.fetch(:horizontal_height_px, 300)
       end
-    
+
       def split_by_type
         @options.fetch(:split_by_type, false)
       end
-    
+
       def px_per_minute
         @options.fetch(:px_per_minute, TimeslotCalendar::MINUTE_HEIGHT_PX)
       end
-    
+
       def display_bucket_title
         @options.fetch(:display_bucket_title, false)
       end
-    
+
       def bucket_title_size
         if display_bucket_title
           @options.fetch(:bucket_title_size, 20)
@@ -55,11 +33,11 @@ module SimpleCalendar
           0
         end
       end
-    
+
       def grid_top_offset(hour)
         4.16666667 * hour
       end
-    
+
       def grid_width
         if display_grid
           @options.fetch(:grid_width, "20px")
@@ -67,11 +45,39 @@ module SimpleCalendar
           0
         end
       end
-    
+
       def display_grid
         @options.fetch(:display_grid, true)
       end
-    
+
+      def horizontal_scroll_split
+        @options.fetch(:horizontal_scroll_split, false)
+      end
+
+      def height
+        #h = (24 - TimeslotCalendar::FIRST_HOUR_SLOT) * 60 * px_per_minute
+        h = 24 * 60 * px_per_minute
+        h = h+bucket_title_size if display_bucket_title
+        h
+      end
+
+      def event_height(event, day)
+        minutes = if event.send(attribute).to_date != day
+                    (event.send(end_attribute) - event.send(end_attribute).midnight)/60
+                  elsif event.send(attribute).to_date < event.send(end_attribute).to_date
+                    (event.send(end_attribute).midnight - 60 - event.send(attribute))/60
+                  else
+                    (event.send(end_attribute) - event.send(attribute))/60
+                  end
+        minutes * px_per_minute 
+      end
+
+      def event_top_distance(event, day)
+        return 0 if event.send(attribute).to_date != day
+        #(event.send(attribute).hour - TimeslotCalendar::FIRST_HOUR_SLOT) * 60 * px_per_minute + event.send(attribute).min * px_per_minute
+        event.send(attribute).hour * 60 * px_per_minute + event.send(attribute).min * px_per_minute
+      end
+
       def split_into_buckets(events)
         if split_by_type
           events.group_by{|e| e.send split_by_type}.values
@@ -79,33 +85,34 @@ module SimpleCalendar
           [events]
         end
       end
-    
+
       def slot_events(events, day)
         r = {}
         events.each do |event|
           r[event] = [0, 0, event_height(event, day), event_top_distance(event, day)]
         end
-        #
+        # Credit: https://stackoverflow.com/questions/11311410/visualization-of-calendar-events-algorithm-to-layout-events-with-maximum-width
+        # Author: Markus Jarderot (https://stackoverflow.com/users/22364/markus-jarderot)
         columns = [[]]
         last_event_ending = nil
         events.each do |event|
-          if(!last_event_ending.nil? && event.start_time > last_event_ending)
+          if !last_event_ending.nil? && event.send(attribute) > last_event_ending
             pack_events(r, columns)
-            colums = [[]]
+            columns = [[]]
             last_event_ending = nil
           end
           placed = false
           columns.each do |col|
-            if !events_collide(r, col.last, event)
+            unless events_collide(r, col.last, event)
               col << event
               placed = true
               break
             end
           end
-          if !placed
+          unless placed
             columns << [event]
           end
-          event_end_time = event.start_time + event.duration.minutes
+          event_end_time = event.send(end_attribute)
           if last_event_ending.nil? || event_end_time > last_event_ending
             last_event_ending = event_end_time
           end
@@ -115,7 +122,9 @@ module SimpleCalendar
         end
         r
       end
-    
+
+      private
+
       def pack_events(r, columns)
         num_columns = columns.size.to_f
         columns.each_with_index do |col, iter_col|
@@ -126,14 +135,14 @@ module SimpleCalendar
           end
         end
       end
-    
+
       def events_collide(r, event1, event2)
         return false if event1.nil? || event2.nil?
         event1_bottom = r[event1][3] + r[event1][2]
         event2_bottom = r[event2][3] + r[event2][2]
         event1_bottom > r[event2][3] && r[event1][3] < event2_bottom
       end
-    
+
       def expand_event(r, event, iter_col, columns)
         col_span = 1
         columns.each_with_index do |column, index|
@@ -146,8 +155,6 @@ module SimpleCalendar
         end
         col_span
       end
-    
-      private
     end
   end
 end

data/lib/simple_calendar/timeslot/version.rb

@@ -2,6 +2,6 @@
 
 module SimpleCalendar
   module Timeslot
-    VERSION = "0.3.0"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_calendar-timeslot
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Kim Laplume
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-14 00:00:00.000000000 Z
+date: 2021-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simple_calendar