candl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2de1e49fd55c32ba7bdb1349ba4144fce35243d7bfb87ff96e509cd9bc8898e7
+  data.tar.gz: 5c70092087bdc7b4ba2b5ec7b73f838ca938a308fe00493fa0457d4499bf2198
+SHA512:
+  metadata.gz: 70fc75081298f1be1d4d444ce0748b01b4d3c1cc9bf4e4151c16c3712a8205134de1af7d634d6743af80c6b5e888691b7aa1679f6ce2cd357958ebb4af469288
+  data.tar.gz: 42b7672d2a2b03affefee1f9be6845c2b004d8ed54cfd5f6e2e22ac36e42f3622e073a008ad9bc5be5a6458fad8cf3e8eb07323fd51f30df42a24d96acd0a375

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Andreas Schau
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Candle
+
+This gem helps load and display a calendar from google calendar in an agenda or month style view.
+
+## Usage
+
+The gem consists of mainly three models. One - the event loader model - is focusing on loading the events from the google server via a restfull api and an api key. The other two are the agenda and month model wich offer functionality to organize the data for an agenda or month view. Next to the models are the views wich come with a "_frame.slim" view. This view can be included in a host view as a partial. This way one can display a calendar inside of another page. The "_frame.slim" is the entry point that prepares the model and view for the respective view type (month/agenda). (It does not come with a seperate week view.)
+
+Find an example inclusion of the _frame.slim partial in the show.slim file in candle/spec/dummy/app/views/sample/show.slim.
+
+The main steps to use this gem are:
+- Initialize an agenda or month model object with a config that specifies these values:
+
+````
+config = {
+  "calendar": {
+    "google_calendar_api_host_base_path": "https://www.googleapis.com/calendar/v3/calendars/",
+    "calendar_id": "schau-hnh%40web.de",
+    "api_key": "AIzaSyB5F1X5hBi8vPsmt1itZTpMluUAjytf6hI"
+  },
+  "agenda": {
+    "display_day_count": "14",
+    "days_shift_coefficient": "7"
+  },
+  "month": {
+    "summary_teaser_length_in_characters": "42",
+    "delta_start_of_weekday_from_sunday": "1"
+  },
+  "general": {
+    "maps_query_host": "https://www.google.de/maps",
+    "maps_query_parameter": "q"
+  }
+}
+````
+
+- The node "calendar" holds all relevant information to the chosen calendar that you want to load events from.
+- Under "general" there is the "maps_query_host" wich is the base url to a map service (like google maps in this example) and the "maps_query_parameter". (Maybe in the future there will be more map services, that let one search for a location just via the url and a parameter. But for now i only found gmaps to be able to do this. Like: https://www.google.de/maps/?q=Dresden+Hauptbahnhof)
+- In "agenda" you can set the span "display_day_count" of day's considered/loaded in one view and by how many day's it will be shifted "days_shift_coefficient".
+- In "month" you can set the "summary_teaser_length_in_characters" and in your view you can truncate the title to that length to reduce the size of the seperate events not to become to big in the view. The "delta_start_of_weekday_from_sunday" can be set to whatever value you need to have the week start at another day than sunday. (Like 1 -> Monday)
+
+Then once configured you can load the events inside of the current timeframe and then use the other functionality to display them nicely.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'candle'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install candle
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at this repository.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Candle'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/candle_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/candle .js
+//= link_directory ../stylesheets/candle .css

data/app/assets/javascripts/candle/application.js

@@ -0,0 +1,19 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require rails-ujs
+//= require activestorage
+//= require jquery3
+//= require jquery_ujs
+//= require turbolinks
+//= require bootstrap
+//= require_tree .

data/app/assets/javascripts/candle/calendar.coffee

@@ -0,0 +1,54 @@
+$(document).on "turbolinks:load", ->
+
+  $(".open_more").click (e) ->
+    e.preventDefault()
+    $(this).next('.details').toggle()
+    return
+
+  $(".onclick_open_backdrop").click (e) ->
+    e.preventDefault()
+    $(this).children('.snowflake_popover').popover('show')
+    $('.popover_backdrop').show()
+    return
+
+  $(document).on "click", ".close, .popover_backdrop", (e) ->
+    e.preventDefault()
+    $('.snowflake_popover').popover('hide')
+    $('.popover_backdrop').hide()
+    return
+
+  $('[data-toggle="popover"]').popover
+    html: true
+    trigger: 'manual'
+    content: ->
+      $(this).children('.popover_content').html()
+
+  debounceIntervalMs = ->
+    return 240
+
+  shiftUrl = (url, regex, shifts) ->
+    change = (str, p1, p2, offset, text) ->
+      return p1 + (parseInt(p2) + parseInt(shifts))
+
+    text = String(url)
+    return text.replace regex, change
+    
+  $("a.debounce_this").click (e) ->
+    e.preventDefault()
+
+    if !window.forwardShiftAmount?
+      window.forwardShiftAmount = 0
+    if window.debounceTimeout?
+      clearTimeout(window.debounceTimeout)
+      window.forwardShiftAmount = window.forwardShiftAmount + if (e.currentTarget.dataset.directionForward == 'true') then 1 else -1
+      console.log(window.forwardShiftAmount)
+
+    regex = new RegExp("(" + e.currentTarget.dataset.debounceParam + "=)(-?\\d+)", "g")
+    delayedPageChange = ->
+      location.href = newHref
+
+    newHref = shiftUrl(e.currentTarget.href, regex, window.forwardShiftAmount)
+    window.debounceTimeout = setTimeout(delayedPageChange, debounceIntervalMs())
+    return
+
+  return

data/app/assets/stylesheets/candle/application.scss

@@ -0,0 +1,20 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require material_icons
+ *= require_tree .
+ *= require_self
+ */
+
+@import "bootstrap";
+
+/* There seems to be a bug that makes it necessary to have some sort of change to this file in order to have the typical asset pipeline behaviour. */

data/app/assets/stylesheets/candle/calendar.scss

@@ -0,0 +1,291 @@
+$hnh-color-black: #333333;
+$hnh-color-light-gray: #eeeeee;
+$hnh-color-orange: #df631d;
+$hnh-color-green: #8fa841;
+$hnh-color-blue: #4781ba;
+$hnh-color-yellow: #f7cb51;
+
+$hnh-size-micro: 0.125rem;
+$hnh-size-tiny: 0.25rem;
+$hnh-size-small: 0.5rem;
+$hnh-size-medium: 1rem;
+$hnh-size-big: 2rem;
+$hnh-size-huge: 4rem;
+$hnh-size-humongus: 8rem;
+
+.button_holder {
+  width: 100%;
+  height: 100%;
+  display: flex;
+  flex-flow: row wrap;
+  justify-content: space-between;
+  margin-bottom: $hnh-size-medium;
+
+  .btn-group {
+    display: flex;
+    flex-flow: row wrap;
+    justify-content: space-between;
+
+    .button_item {
+      display: flex;
+      flex-flow: column nowrap;
+      justify-content: center;
+      align-content: center;
+
+      .button_icon {
+        display: flex;
+        flex-flow: row nowrap;
+        justify-content: center;
+        align-content: center;
+        width: 100%;
+        height: 100%;
+
+        i {
+          margin: auto;
+        }
+      }
+    }
+  }
+
+  a.btn {
+    min-width: $hnh-size-humongus + $hnh-size-big;
+    min-height: $hnh-size-huge;
+  }
+}
+
+.error_message {
+  font-weight: bold;
+}
+
+.agenda {
+  width: 100%;
+  border: 1px solid lighten($hnh-color-black, 67%);
+
+  .today {
+    background-color: lighten($hnh-color-blue, 36%);
+  }
+  .not_today {
+    background-color: lighten($hnh-color-black, 72%);
+  }
+
+  .row_head {
+    color: $hnh-color-black;
+    
+    padding: $hnh-size-small;
+  }
+
+  .event_shell {
+    background-color: lighten($hnh-color-light-gray, 4%);
+    color: darken($hnh-color-blue, 7%);
+    transition: background-color 0.33s;
+    cursor: pointer;
+
+    .event {
+      display: flex;
+      align-items: center;
+      padding: $hnh-size-small;
+
+      .time {
+        font-weight: bold;
+        min-width: 6rem;
+        text-align: center;
+      }
+      .summary {
+        color: inherit;
+      }
+      .auto_margin_left {
+        margin-left: auto;
+        margin-right: 1px;
+      }
+      &:hover {
+        background-color: darken($hnh-color-light-gray, 3%);
+      }
+    }
+
+    .details {
+      padding: $hnh-size-tiny;
+      color: $hnh-color-black;
+
+      .text {
+        display: inline-flex;
+        align-items: center;
+
+        .icon {
+          min-width: 6rem;
+          padding-left: $hnh-size-medium;
+          padding-right: $hnh-size-medium;
+          text-align: center;
+        }
+        .content {
+          padding-left: $hnh-size-medium;
+          padding-right: $hnh-size-medium;
+        }
+      }
+    }
+    &:nth-child(odd) {
+      color: darken($hnh-color-green, 7%);
+    }
+  }
+}
+
+.month_view {
+  table-layout: fixed;
+
+  .weekday_name_header {
+    overflow: hidden;
+  }
+
+  .day_row {
+    background-color: lighten($hnh-color-light-gray, 4%);
+
+    .day_head {
+      width: 100%;
+      text-align: center;
+    }
+  }
+
+  .small_padding {
+    padding: $hnh-size-tiny + $hnh-size-micro;
+  }
+
+  .multiday_event {
+    padding: $hnh-size-micro;
+    overflow: hidden;
+    cursor: pointer;
+  
+    border-radius: $hnh-size-small;
+    border: $hnh-size-micro solid $hnh-color-light-gray;
+    background-color: lighten($hnh-color-blue, 42%);
+    border: 1px solid lighten($hnh-color-blue, 29%);
+
+    transition: background-color 0.33s;
+
+    .summary {
+      margin-left: $hnh-size-small;
+      color: $hnh-color-black;
+    }
+    &:nth-child(odd) {
+      background-color: lighten($hnh-color-green, 42%);
+      border: 1px solid lighten($hnh-color-green, 29%);
+    }
+    &:hover {
+      background-color: lighten($hnh-color-blue, 33%);
+      border: 1px solid lighten($hnh-color-blue, 15%);
+
+      &:nth-child(odd) {
+        background-color: lighten($hnh-color-green, 33%);
+        border: 1px solid lighten($hnh-color-green, 15%);
+      }
+    }
+  }
+  .multiday_event_leftcut {
+    border-top-left-radius: 0;
+    border-bottom-left-radius: 0;
+  }
+  .multiday_event_bothcut {
+    border-top-left-radius: 0;
+    border-bottom-left-radius: 0;
+    border-top-right-radius: 0;
+    border-bottom-right-radius: 0;
+  }
+  .multiday_event_rightcut {
+    border-top-right-radius: 0;
+    border-bottom-right-radius: 0;
+  }
+
+  .events_row {
+    height: $hnh-size-huge;
+
+    .event {
+      padding: $hnh-size-tiny;
+      overflow: hidden;
+      margin-bottom: $hnh-size-small;
+      cursor: pointer;
+    
+      border-radius: $hnh-size-small;
+      border: $hnh-size-micro solid $hnh-color-light-gray;
+      background-color: lighten($hnh-color-blue, 42%);
+      border: 1px solid lighten($hnh-color-blue, 29%);
+  
+      transition: background-color 0.33s;
+  
+      .time {
+        font-weight: bold;
+      }
+      
+      .summary {
+        margin-left: $hnh-size-small;
+        color: $hnh-color-black;
+      }
+      &:nth-child(odd) {
+        background-color: lighten($hnh-color-green, 42%);
+        border: 1px solid lighten($hnh-color-green, 29%);
+      }
+      &:hover {
+        background-color: lighten($hnh-color-blue, 33%);
+        border: 1px solid lighten($hnh-color-blue, 15%);
+  
+        &:nth-child(odd) {
+          background-color: lighten($hnh-color-green, 33%);
+          border: 1px solid lighten($hnh-color-green, 15%);
+        }
+      }
+    }
+  }
+}
+
+.popover_backdrop {
+  z-index: 101;
+  position: fixed;
+  top: 0;
+  left: 0;
+  right: 0;
+  bottom: 0;
+  background: rgba($hnh-color-light-gray,0.4);
+}
+
+.init_display_none {
+  display: none;
+}
+
+.popover-content {
+  overflow: hidden;
+  display: inline-flex;
+  flex-direction: column;
+
+  .icon_spacing {
+    margin-right: $hnh-size-medium;
+  }
+
+  .close_span {
+    width: 100%;
+  
+    .close {
+      text-align: right;
+      cursor: pointer;
+    }
+  }
+  hr {
+    width: 100%;
+  }
+  .text {
+    .medium_margin_right {
+      margin-right: $hnh-size-humongus;
+    }
+
+    display: flex;
+    flex-direction: row;
+
+    display: flex;
+    align-items: center;
+    
+    .flex_wrap_it {
+      flex-wrap: wrap;
+    }
+    .breakable {
+      word-break: break-word;
+      hyphens: auto;
+      overflow-wrap: break-word;
+    }
+  }
+}

data/app/controllers/candle/application_controller.rb

@@ -0,0 +1,5 @@
+module Candle
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/candle/calendar_controller.rb

@@ -0,0 +1,8 @@
+require_dependency "candle/application_controller"
+
+module Candle
+  class CalendarController < ApplicationController
+    def show
+    end
+  end
+end

data/app/helpers/candle/application_helper.rb

@@ -0,0 +1,4 @@
+module Candle
+  module ApplicationHelper
+  end
+end

data/app/helpers/candle/calendar_helper.rb

@@ -0,0 +1,4 @@
+module Candle
+  module CalendarHelper
+  end
+end

data/app/jobs/candle/application_job.rb

@@ -0,0 +1,4 @@
+module Candle
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/candle/application_mailer.rb

@@ -0,0 +1,6 @@
+module Candle
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/candle/application_record.rb

@@ -0,0 +1,5 @@
+module Candle
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/candle/calendar/_agenda.slim

@@ -0,0 +1,47 @@
+
+- unless calendar_agenda.agenda_grouped_events.empty?
+  .agenda
+    - calendar_agenda.agenda_grouped_events.keys.sort.each do |date|
+      .row_head class=Candle::AgendaModel.emphasize_date(date, Date.today, 'today', 'not_today') = l(date, format: '%A, %e. %B %Y')
+      - calendar_agenda.agenda_grouped_events[date].each do |event|
+
+        .event_shell
+          .open_more data-id=""
+            .event
+              - if event.dtstart.instance_of?(DateTime)
+                span.time = event.dtstart.localtime.strftime('%k:%M')
+              - else
+                span.time ▶
+              span.flex_wrap_it.breakable.summary{ title = Candle::AgendaModel.summary_title(event) } == event.summary.to_s.force_encoding("UTF-8")
+              i class="material-icons auto_margin_left" arrow_drop_down
+
+          .details style="display: none;"
+            .timeframe title="Zeitraum"
+              .text
+                span.icon
+                  i class="material-icons" date_range
+                span.content
+                  - if event.dtstart.instance_of?(DateTime)
+                    = l(event.dtstart.localtime, format: :short) + " - " + l(event.dtend.localtime, format: :hnh_short)
+                  - else
+                    = l(event.dtstart, format: :short) + " - " + l((event.dtend - 1.day), format: :short)
+
+            - if !event.location.to_s.strip.empty?
+              .location title="Adresse"
+                .text
+                  span.icon
+                    i class="material-icons" location_on
+                  span.content
+                    a href=calendar_agenda.address_to_maps_path(event.location.to_s) target="_blank"
+                      .flex_wrap_it.breakable = event.location.to_s.force_encoding("UTF-8")
+
+            - if !event.description.to_s.strip.empty?
+            .description title="Weitere Beschreibung"
+              .text
+                span.icon
+                  i class="material-icons" description
+                span.content
+                  .flex_wrap_it.breakable = auto_link(event.description.to_s.force_encoding("UTF-8"), html: { target: '_blank' })
+
+- else
+  p No upcoming events in the next week.

data/app/views/candle/calendar/_frame.slim

@@ -0,0 +1,54 @@
+
+- events_error_free = true
+- is_month = params[:v] != 'a'
+- current_shift_factor = params[:s] || 0
+- date_today = Date.today
+- update_interval = config[:general][:cache_update_interval_in_s]
+
+- if is_month
+  - begin
+    - month = Rails.cache.fetch("#month/#{current_shift_factor}/#{date_today}", expires_in: update_interval) do
+      - Candle::MonthModel.new(config, current_shift_factor, date_today)
+  - rescue => exception
+    - events_error_free = false
+- else
+  - begin
+    - agenda = Rails.cache.fetch("#agenda/#{current_shift_factor}/#{date_today}", expires_in: update_interval) do
+      - Candle::AgendaModel.new(config, current_shift_factor, date_today)
+  - rescue => exception
+    - events_error_free = false
+
+- if events_error_free
+  - model = (is_month ? month : agenda)
+
+
+  .popover_backdrop.init_display_none
+
+  div
+    .button_holder
+      .btn-group
+        = link_to "Monat", model.path("", v: :m, s: model.current_shift_for_month(current_shift_factor)), class: "btn btn-default button_item #{'active' if is_month}"
+
+        = link_to "Agenda", model.path("", v: :a, s: model.current_shift_for_agenda(current_shift_factor)), class: "btn btn-default button_item #{'active' unless is_month}"
+
+      .btn-group
+        = link_to "Heute", model.path(""), class: "btn btn-default button_item"
+
+      .btn-group
+        = link_to model.previous_path("", current_shift_factor), class: "btn btn-default button_item debounce_this", data: { debounce_param: "s", direction_forward: false }
+          .button_icon
+            i.material-icons navigate_before
+
+        = link_to model.upcoming_path("", current_shift_factor), class: "btn btn-default button_item debounce_this", data: { debounce_param: "s", direction_forward: true }
+          .button_icon
+            i.material-icons navigate_next
+
+    .calendar
+      - if is_month
+        = render partial: "candle/calendar/month", locals: { calendar_month: model }
+      - else
+        = render partial: "candle/calendar/agenda", locals: { calendar_agenda: model }
+
+- else
+  .error_message Der Kalender kann wegen einer kurzzeitigen technischen Störung gerade nicht angezeigt werden. Bitte versuchen sie es in einer Weile noch einmal.
+