candl 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23b22b8e041b3528a994dd2471a21583ea7b9c7c6e2bac72b62c8a22bfccdfff
-  data.tar.gz: 7fc03d75fcc96ee0fdcdfb14b6d2adc47d8f205ce8ffbf85dad1a74afd989cad
+  metadata.gz: 6cfbd460e92519f419a3991ea2d262511351e8f1dde3881660326a579820f88b
+  data.tar.gz: 51af14b7e89684f5877e41a00d1899e3ca3f8deadde218cf486504f68110f6a4
 SHA512:
-  metadata.gz: 111ce4bb0f4c532e09963134bcbe5585d80f9e7e0ee299833f7e98417a601104bef9c294731187225f3e20bcd3401f564237fc155164a1288964796cd5180615
-  data.tar.gz: 5483a9e5505ce0792060b084c462d1b22262620e3217004622f62ee13d17c80ae18a56dbad4ea5888dfa0001bf7042861fd7d51f3750a25bba8e1970748964fe
+  metadata.gz: '038bdea768c5a4f83ecf3f9c5d17f10dff50adde8ba147c01e78b0e53961fb829ee43219c3b1882296b3248606bddb5061558e68dbe0c8b59479c08ab58a90df'
+  data.tar.gz: 066fdb81b06cc826be4cfb58d9b3595306543318ca4a379737a243e5171f62788a047370af72f69259353a06b71baa88d1dee4ac624b3cb3a983eb8919645b20

data/README.md

@@ -1,4 +1,4 @@
-# Candle
+# Candl
 
 This gem helps load and display a calendar from google calendar in an agenda or month style view.
 
@@ -6,7 +6,7 @@ This gem helps load and display a calendar from google calendar in an agenda or
 
 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.
+Find an example inclusion of the _frame.slim partial in the show.slim file in candl/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:
@@ -45,7 +45,7 @@ Then once configured you can load the events inside of the current timeframe and
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'candle'
+gem 'candl'
 ```
 
 And then execute:
@@ -55,7 +55,44 @@ $ bundle
 
 Or install it yourself as:
 ```bash
-$ gem install candle
+$ gem install candl
+```
+
+Additionally:
+Require the library in the ./config/application.rb of your ruby on rails application.
+```ruby
+# ./config/application.rb
+require 'candl'
+```
+
+In the view you want the calendar to appear initialize a configuration hash like so:
+```slim
+- config = { \
+    calendar: { \
+      google_calendar_api_host_base_path: "https://www.googleapis.com/calendar/v3/calendars/", \
+      calendar_id: "grhnk1uaotql6gv2dkf9ldmqjc@group.calendar.google.com", \
+      api_key: "AIzaSyD1UIlX0n4-DnY3hSoTkeTZFbbsNO2g67E" \
+    }, \
+    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", \
+      cache_update_interval_in_s: 7200 \
+    } \
+  }
+```
+In this example done in a view that uses .slim instead of .erb but in the end config is just a ruby hash that needs to have the right key's and sensible values for them.
+
+Then at the position in your view where the calendar is supposed to show itself:
+```slim
+= render partial: "candl/calendar/frame", locals: { config: config }
 ```
 
 ## Contributing

data/Rakefile

@@ -8,7 +8,7 @@ require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Candle'
+  rdoc.title    = 'Candl'
   rdoc.options << '--line-numbers'
   rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')

data/app/assets/config/candle_manifest.js

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

data/app/controllers/{candle → candl}/application_controller.rb

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

data/app/controllers/{candle → candl}/calendar_controller.rb

@@ -1,6 +1,6 @@
-require_dependency "candle/application_controller"
+require_dependency "candl/application_controller"
 
-module Candle
+module Candl
   class CalendarController < ApplicationController
     def show
     end

data/app/helpers/{candle → candl}/application_helper.rb

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

data/app/helpers/{candle → candl}/calendar_helper.rb

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

data/app/jobs/{candle → candl}/application_job.rb

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

data/app/mailers/{candle → candl}/application_mailer.rb

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

data/app/models/{candle → candl}/application_record.rb

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

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

@@ -2,7 +2,7 @@
 - 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')
+      .row_head class=Candl::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
@@ -12,7 +12,7 @@
                 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")
+              span.flex_wrap_it.breakable.summary{ title = Candl::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;"

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

@@ -1,4 +1,3 @@
-
 - events_error_free = true
 - is_month = params[:v] != 'a'
 - current_shift_factor = params[:s] || 0
@@ -8,19 +7,19 @@
 - 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)
+      - Candl::MonthModel.new(config, current_shift_factor, date_today)
   - rescue => exception
     - events_error_free = false
-    - puts "ERROR - GOT EXCEPTION:"
+    - puts "\033[31mERROR - GOT EXCEPTION:\033[0m"
     - puts exception
     / Maybe there is a beter way to signal the exception?
 - 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)
+      - Candl::AgendaModel.new(config, current_shift_factor, date_today)
   - rescue => exception
     - events_error_free = false
-    - puts "ERROR - GOT EXCEPTION:"
+    - puts "\033[31mERROR - GOT EXCEPTION:\033[0m"
     - puts exception
     / Maybe there is a beter way to signal the exception?
 
@@ -51,9 +50,9 @@
 
     .calendar
       - if is_month
-        = render partial: "candle/calendar/month", locals: { calendar_month: model }
+        = render partial: "candl/calendar/month", locals: { calendar_month: model }
       - else
-        = render partial: "candle/calendar/agenda", locals: { calendar_agenda: model }
+        = render partial: "candl/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.

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

@@ -9,11 +9,11 @@
           th.weekday_name_header scope="col" = l(date, format: '%A')
 
     tbody
-      - Candle::MonthModel.weeks_in_months_view_dates(calendar_month.view_dates).times do |row|
+      - Candl::MonthModel.weeks_in_months_view_dates(calendar_month.view_dates).times do |row|
         tr.day_row
           - 7.times do |collumn|
             - current_day = calendar_month.view_dates[7 * row + collumn]
-            td class=Candle::MonthModel.emphasize_date(current_day, Date.today, 'bg-info', 'bg-default')
+            td class=Candl::MonthModel.emphasize_date(current_day, Date.today, 'bg-info', 'bg-default')
               - if current_day.day == 1
                 .day_head = current_day.day.to_s + '. ' + l(current_day, format: '%b.')
               - else
@@ -26,7 +26,7 @@
             - collumn = 0
             - while collumn < 7 do
               - current_day = calendar_month.view_dates[7 * row + collumn]
-              - current_event = Candle::MonthModel.find_best_fit_for_day(calendar_month.view_dates[7 * row], current_day, weekly_multiday_event_heap)
+              - current_event = Candl::MonthModel.find_best_fit_for_day(calendar_month.view_dates[7 * row], current_day, weekly_multiday_event_heap)
               - if current_event
                 - weekly_multiday_event_heap.delete_if{ |event| event.uid == current_event.uid }
 
@@ -36,12 +36,12 @@
 
                 - if current_event_length_within_current_week > 0
                   td.small_padding colspan=current_event_length_within_current_week
-                    .multiday_event.onclick_open_backdrop class=Candle::MonthModel.multiday_event_cutoff(current_event.dtstart < current_day, current_event.dtend > (calendar_month.view_dates[7 * row + 6] + 1.day), 'multiday_event_leftcut', 'multiday_event_bothcut', 'multiday_event_rightcut')
+                    .multiday_event.onclick_open_backdrop class=Candl::MonthModel.multiday_event_cutoff(current_event.dtstart < current_day, current_event.dtend > (calendar_month.view_dates[7 * row + 6] + 1.day), 'multiday_event_leftcut', 'multiday_event_bothcut', 'multiday_event_rightcut')
 
                       .snowflake_popover[data-placement="bottom" data-toggle="popover" data-container="body" type="button" data-html="true" href="#"]
 
                         div
-                          span.summary.breakable{ title = Candle::MonthModel.summary_title(current_event) } == current_event.summary.to_s.force_encoding("UTF-8").truncate(calendar_month.summary_teaser_length().to_i, seperator: ' ')
+                          span.summary.breakable{ title = Candl::MonthModel.summary_title(current_event) } == current_event.summary.to_s.force_encoding("UTF-8").truncate(calendar_month.summary_teaser_length().to_i, seperator: ' ')
 
                         .popover_content.hide
                           .close_span
@@ -81,7 +81,7 @@
         tr.events_row
           - 7.times do |collumn|
             - current_day = calendar_month.view_dates[7 * row + collumn]
-            td class=Candle::MonthModel.emphasize_date(current_day, Date.today, 'bg-info', 'bg-default')
+            td class=Candl::MonthModel.emphasize_date(current_day, Date.today, 'bg-info', 'bg-default')
 
               - if calendar_month.grouped_events[current_day]
                 - calendar_month.grouped_events[current_day].sort_by{ |event| event.dtstart.localtime }.each do |event|
@@ -91,7 +91,7 @@
 
                       div
                         span.time = event.dtstart.localtime.strftime('%k:%M')
-                        span.summary.breakable{ title = Candle::MonthModel.summary_title(event) } == event.summary.to_s.force_encoding("UTF-8").truncate(calendar_month.summary_teaser_length.to_i, seperator: ' ')
+                        span.summary.breakable{ title = Candl::MonthModel.summary_title(event) } == event.summary.to_s.force_encoding("UTF-8").truncate(calendar_month.summary_teaser_length.to_i, seperator: ' ')
 
                       .popover_content.hide
                         .close_span

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

@@ -1,3 +1,3 @@
-div Hello, this is the index/show view of the "candle" rails engine gem.
+div Hello, this is the index/show view of the "candl" rails engine gem.
 
 div You should not see this page. The calendar is supposed to be integrated via a partial (_frame.slim) wich will then render the calendar view inside of the host-apps page.

data/app/views/layouts/candl/application.html.erb

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Candl</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "candl/application", media: "all" %>
+  <%= javascript_include_tag "candl/application" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -1,3 +1,3 @@
-Candle::Engine.routes.draw do
+Candl::Engine.routes.draw do
   root "calendar#show"
 end

data/lib/{candle → candl}/agenda_model.rb

@@ -1,4 +1,4 @@
-module Candle
+module Candl
   class AgendaModel
     # Attributes one needs to access from the "outside"
     attr_reader :display_day_count

data/lib/{candle → candl}/engine.rb

@@ -5,10 +5,10 @@ require "material_icons"
 require "bootstrap-sass"
 require "rails_autolink"
 
-module Candle
+module Candl
   class Engine < ::Rails::Engine
-    isolate_namespace Candle
-    initializer 'candle.assets' do |app|
+    isolate_namespace Candl
+    initializer 'candl.assets' do |app|
       %w(stylesheets javascripts).each do |sub|
         app.config.assets.paths << root.join('app', 'assets', sub).to_s
       end

data/lib/{candle → candl}/event_loader_model.rb

@@ -1,7 +1,7 @@
 require 'net/http'
 require 'uri'
 
-module Candle
+module Candl
   class EventLoaderModel
     Event ||= Struct.new(:dtstart, :dtend, :summary, :description, :location, :uid)
     def self.Event(dtstart, dtend, summary, description, location, uid)
@@ -41,7 +41,12 @@ module Candle
 
       requested_events = JSON.parse(Net::HTTP.get(URI.parse(google_test_path)))
 
-      restructured_events = requested_events["items"].map{ |e| e["start"]["dateTime"] != nil ? Event.new(DateTime.parse(e["start"]["dateTime"]), DateTime.parse(e["end"]["dateTime"]), e["summary"], e["description"], e["location"], e["id"]) : Event.new(Date.parse(e["start"]["date"]), Date.parse(e["end"]["date"]), e["summary"], e["description"], e["location"], e["id"]) }
+      if requested_events["items"] != nil
+        restructured_events = requested_events["items"].map{ |e| e["start"]["dateTime"] != nil ? Event.new(DateTime.parse(e["start"]["dateTime"]), DateTime.parse(e["end"]["dateTime"]), e["summary"], e["description"], e["location"], e["id"]) : Event.new(Date.parse(e["start"]["date"]), Date.parse(e["end"]["date"]), e["summary"], e["description"], e["location"], e["id"]) }
+      else
+        # raise Exception.new("Calendar event request failed and responded with:\n  #{requested_events}")
+        raise "Calendar event request failed and responded with:\n  #{requested_events}"
+      end
 
       restructured_events.to_a
     end

data/lib/{candle → candl}/month_model.rb

@@ -1,4 +1,4 @@
-module Candle
+module Candl
   class MonthModel
     # Attributes one needs to access from the "outside"
     attr_reader :delta_start_of_weekday_from_sunday

data/lib/candl/version.rb

@@ -0,0 +1,3 @@
+module Candl
+  VERSION = '0.1.5'
+end

data/lib/candl.rb

@@ -0,0 +1,9 @@
+require "candl/engine"
+
+require "candl/event_loader_model"
+require "candl/agenda_model"
+require "candl/month_model"
+
+module Candl
+  # Code is all found in the models and views.
+end

data/lib/tasks/{candle_tasks.rake → candl_tasks.rake}

@@ -1,4 +1,4 @@
 # desc "Explaining what the task does"
-# task :candle do
+# task :candl do
 #   # Task goes here
 # end

data/spec/{candle_spec.rb → candl_spec.rb}

@@ -23,16 +23,16 @@ google_base_path = test_config[:calendar][:google_calendar_api_host_base_path]
 calendar_id = test_config[:calendar][:calendar_id]
 api_key = test_config[:calendar][:api_key]
 
-describe Candle do
+describe Candl do
   it "has a version number" do
-    expect(Candle::VERSION).not_to be nil
+    expect(Candl::VERSION).not_to be nil
   end
 
   context "Json parsing" do
     let(:current_shift_factor) { 0 }
     let(:fake_today) { Date.parse("2019-01-07") }
 
-    let(:agenda) { Candle::AgendaModel.new(test_config, current_shift_factor, fake_today) }
+    let(:agenda) { Candl::AgendaModel.new(test_config, current_shift_factor, fake_today) }
 
     it "Test agenda config" do
       expect(agenda.display_day_count).to eq(14)
@@ -42,24 +42,24 @@ describe Candle do
 end
 
 
-RSpec.describe Candle::EventLoaderModel do
+RSpec.describe Candl::EventLoaderModel do
   context "Get AGNEDA events" do
     let(:current_shift_factor) { 0 }
     let(:fake_today) { Date.parse("2019-01-07") }
-    let(:agenda) { Candle::AgendaModel.new(test_config, current_shift_factor, fake_today) }
+    let(:agenda) { Candl::AgendaModel.new(test_config, current_shift_factor, fake_today) }
     let(:current_start_date) { agenda.current_start_date(current_shift_factor, fake_today) }
     let(:current_end_date) { agenda.current_end_date(current_shift_factor, fake_today) }
 
-    let(:unspread_event_1) { Candle::EventLoaderModel::Event.new(DateTime.parse("2019-01-08T17:00:00"), DateTime.parse("2019-01-08T19:30:00"), "summary_1", "description_1", "location_1", "uid_1") }
-    let(:unspread_event_2) { Candle::EventLoaderModel::Event.new(Date.parse("2019-01-08"), Date.parse("2019-01-11"), "summary_2", "description_2", "location_2", "uid_2") }
-    let(:unspread_event_3) { Candle::EventLoaderModel::Event.new(Date.parse("2019-01-09"), Date.parse("2019-01-11"), "summary_2", "description_2", "location_2", "uid_2") }
-    let(:unspread_event_4) { Candle::EventLoaderModel::Event.new(Date.parse("2019-01-10"), Date.parse("2019-01-11"), "summary_2", "description_2", "location_2", "uid_2") }
+    let(:unspread_event_1) { Candl::EventLoaderModel::Event.new(DateTime.parse("2019-01-08T17:00:00"), DateTime.parse("2019-01-08T19:30:00"), "summary_1", "description_1", "location_1", "uid_1") }
+    let(:unspread_event_2) { Candl::EventLoaderModel::Event.new(Date.parse("2019-01-08"), Date.parse("2019-01-11"), "summary_2", "description_2", "location_2", "uid_2") }
+    let(:unspread_event_3) { Candl::EventLoaderModel::Event.new(Date.parse("2019-01-09"), Date.parse("2019-01-11"), "summary_2", "description_2", "location_2", "uid_2") }
+    let(:unspread_event_4) { Candl::EventLoaderModel::Event.new(Date.parse("2019-01-10"), Date.parse("2019-01-11"), "summary_2", "description_2", "location_2", "uid_2") }
 
     let(:unspread_events) { [unspread_event_1, unspread_event_2] }
     let(:spread_events) { [unspread_event_3, unspread_event_4] }
 
     it "Spread multiday events" do
-      expect(Candle::EventLoaderModel.spread_multiday_events(unspread_events, current_start_date, current_end_date)).to eq(spread_events)
+      expect(Candl::EventLoaderModel.spread_multiday_events(unspread_events, current_start_date, current_end_date)).to eq(spread_events)
     end
   end
 
@@ -67,16 +67,16 @@ RSpec.describe Candle::EventLoaderModel do
     let(:from) { Date.parse("2019-01-01") }
     let(:to) { Date.parse("2019-01-31") }
     it "Build google request path" do
-      expect(Candle::EventLoaderModel.build_google_request_path(google_base_path, calendar_id, api_key, from, to)).to eq("#{google_base_path}#{calendar_id}/events?key=#{api_key}&singleEvents=true&orderBy=startTime&timeMin=#{from}&timeMax=#{to}")
+      expect(Candl::EventLoaderModel.build_google_request_path(google_base_path, calendar_id, api_key, from, to)).to eq("#{google_base_path}#{calendar_id}/events?key=#{api_key}&singleEvents=true&orderBy=startTime&timeMin=#{from}&timeMax=#{to}")
     end
   end
 end
 
 
-RSpec.describe Candle::AgendaModel do
+RSpec.describe Candl::AgendaModel do
   let(:current_shift_factor) { 0 }
   let(:fake_today) { Date.parse("2019-01-07") }
-  let(:agenda) { Candle::AgendaModel.new(test_config, current_shift_factor, fake_today) }
+  let(:agenda) { Candl::AgendaModel.new(test_config, current_shift_factor, fake_today) }
   let(:page_path) { "page.host" }
 
   context "Helper functionality" do
@@ -102,10 +102,10 @@ RSpec.describe Candle::AgendaModel do
       expect(agenda.current_shift_for_month(4, Date.parse("2019-01-08"))).to eq(1)
     end
     it "emphasized date" do
-      expect(Candle::AgendaModel.emphasize_date(Date.parse("2019-01-08"), Date.parse("2019-01-08"), "emphasized", "regular")).to eq("emphasized")
+      expect(Candl::AgendaModel.emphasize_date(Date.parse("2019-01-08"), Date.parse("2019-01-08"), "emphasized", "regular")).to eq("emphasized")
     end
     it "regular date" do
-      expect(Candle::AgendaModel.emphasize_date(Date.parse("2019-01-08"), Date.parse("2019-01-09"), "emphasized", "regular")).to eq("regular")
+      expect(Candl::AgendaModel.emphasize_date(Date.parse("2019-01-08"), Date.parse("2019-01-09"), "emphasized", "regular")).to eq("regular")
     end
   end
 
@@ -132,10 +132,10 @@ RSpec.describe Candle::AgendaModel do
 
   context "Month/Agenda view toggle:" do
     let(:fake_today) { Date.parse("2019-01-07") }
-    let(:date_month_start) { Candle::MonthModel.current_month_start(current_shift_factor, fake_today) }
-    let(:date_month_end) { Candle::MonthModel.current_month_end(current_shift_factor, fake_today) }
+    let(:date_month_start) { Candl::MonthModel.current_month_start(current_shift_factor, fake_today) }
+    let(:date_month_end) { Candl::MonthModel.current_month_end(current_shift_factor, fake_today) }
 
-    let(:month) { Candle::MonthModel.new(test_config, current_shift_factor, fake_today) }
+    let(:month) { Candl::MonthModel.new(test_config, current_shift_factor, fake_today) }
     let(:months_view_dates) { month.generate_months_view_dates(date_month_start, date_month_end) }
 
     let(:events) { month.month_events(months_view_dates.first, months_view_dates.last) }
@@ -150,13 +150,13 @@ RSpec.describe Candle::AgendaModel do
 end
 
 
-RSpec.describe Candle::MonthModel do
+RSpec.describe Candl::MonthModel do
   let(:current_shift_factor) { 0 }
   let(:fake_today) { Date.parse("2019-01-07") }
-  let(:date_month_start) { Candle::MonthModel.current_month_start(current_shift_factor, fake_today) }
-  let(:date_month_end) { Candle::MonthModel.current_month_end(current_shift_factor, fake_today) }
+  let(:date_month_start) { Candl::MonthModel.current_month_start(current_shift_factor, fake_today) }
+  let(:date_month_end) { Candl::MonthModel.current_month_end(current_shift_factor, fake_today) }
 
-  let(:month) { Candle::MonthModel.new(test_config, current_shift_factor, fake_today) }
+  let(:month) { Candl::MonthModel.new(test_config, current_shift_factor, fake_today) }
   let(:months_view_dates) { month.generate_months_view_dates(date_month_start, date_month_end) }
 
   let(:page_path) { "http://page.path/" }
@@ -169,11 +169,11 @@ RSpec.describe Candle::MonthModel do
 
     let(:first_weekday) { Date.parse("2019-01-07") }
     let(:day) { Date.parse("2019-01-08") }
-    let(:event_heap) { [Candle::EventLoaderModel::Event.new(Date.parse("2019-01-08"), Date.parse("2019-01-11"), "s_1", "d_1", "l_1", "u_1"), Candle::EventLoaderModel::Event.new(Date.parse("2019-01-08"), Date.parse("2019-01-9"), "s_1", "d_1", "l_1", "u_1"), Candle::EventLoaderModel::Event.new(Date.parse("2019-01-08"), Date.parse("2019-01-10"), "s_1", "d_1", "l_1", "u_1"),
-      Candle::EventLoaderModel::Event.new(Date.parse("2019-01-09"), Date.parse("2019-01-11"), "s_1", "d_1", "l_1", "u_1")] }
+    let(:event_heap) { [Candl::EventLoaderModel::Event.new(Date.parse("2019-01-08"), Date.parse("2019-01-11"), "s_1", "d_1", "l_1", "u_1"), Candl::EventLoaderModel::Event.new(Date.parse("2019-01-08"), Date.parse("2019-01-9"), "s_1", "d_1", "l_1", "u_1"), Candl::EventLoaderModel::Event.new(Date.parse("2019-01-08"), Date.parse("2019-01-10"), "s_1", "d_1", "l_1", "u_1"),
+      Candl::EventLoaderModel::Event.new(Date.parse("2019-01-09"), Date.parse("2019-01-11"), "s_1", "d_1", "l_1", "u_1")] }
 
     it "Find best fit for day" do
-      expect(Candle::MonthModel.find_best_fit_for_day(first_weekday, day, event_heap)).to eq(Candle::EventLoaderModel::Event.new(Date.parse("2019-01-08"), Date.parse("2019-01-11"), "s_1", "d_1", "l_1", "u_1"))
+      expect(Candl::MonthModel.find_best_fit_for_day(first_weekday, day, event_heap)).to eq(Candl::EventLoaderModel::Event.new(Date.parse("2019-01-08"), Date.parse("2019-01-11"), "s_1", "d_1", "l_1", "u_1"))
     end
 
 
@@ -196,23 +196,23 @@ RSpec.describe Candle::MonthModel do
     end
 
     it "emphasized date" do
-      expect(Candle::MonthModel.emphasize_date(Date.parse("2019-01-08"), Date.parse("2019-01-08"), "emphasized", "regular")).to eq("emphasized")
+      expect(Candl::MonthModel.emphasize_date(Date.parse("2019-01-08"), Date.parse("2019-01-08"), "emphasized", "regular")).to eq("emphasized")
     end
     it "regular date" do
-      expect(Candle::MonthModel.emphasize_date(Date.parse("2019-01-08"), Date.parse("2019-01-09"), "emphasized", "regular")).to eq("regular")
+      expect(Candl::MonthModel.emphasize_date(Date.parse("2019-01-08"), Date.parse("2019-01-09"), "emphasized", "regular")).to eq("regular")
     end
 
     it "multiday event cutoff start" do
-      expect(Candle::MonthModel.multiday_event_cutoff(true, false, "start", "both", "end")).to eq("start")
+      expect(Candl::MonthModel.multiday_event_cutoff(true, false, "start", "both", "end")).to eq("start")
     end
     it "multiday event cutoff both" do
-      expect(Candle::MonthModel.multiday_event_cutoff(true, true, "start", "both", "end")).to eq("both")
+      expect(Candl::MonthModel.multiday_event_cutoff(true, true, "start", "both", "end")).to eq("both")
     end
     it "multiday event cutoff end" do
-      expect(Candle::MonthModel.multiday_event_cutoff(false, true, "start", "both", "end")).to eq("end")
+      expect(Candl::MonthModel.multiday_event_cutoff(false, true, "start", "both", "end")).to eq("end")
     end
     it "multiday event cutoff none" do
-      expect(Candle::MonthModel.multiday_event_cutoff(false, false, "start", "both", "end")).to eq("")
+      expect(Candl::MonthModel.multiday_event_cutoff(false, false, "start", "both", "end")).to eq("")
     end
 
     let(:weekday_dates_of_date_today) { [Date.parse("2019-01-07"), Date.parse("2019-01-08"), Date.parse("2019-01-09"), Date.parse("2019-01-10"), Date.parse("2019-01-11"), Date.parse("2019-01-12"), Date.parse("2019-01-13")] }
@@ -231,8 +231,8 @@ RSpec.describe Candle::MonthModel do
 
     it "months view dates along 12 * 1 month shifts" do
       shifts_in_year.times do |shift|
-        current_month_start = Candle::MonthModel.current_month_start(shift, fake_today)
-        current_month_end = Candle::MonthModel.current_month_end(shift, fake_today)
+        current_month_start = Candl::MonthModel.current_month_start(shift, fake_today)
+        current_month_end = Candl::MonthModel.current_month_end(shift, fake_today)
 
         current_months_view_dates = month.generate_months_view_dates(current_month_start, current_month_end)
 
@@ -244,24 +244,24 @@ RSpec.describe Candle::MonthModel do
     let(:day_in_five_week_month) { Date.parse("2019-01-01") }
     let(:day_in_six_week_month) { Date.parse("2019-03-01") }
     it "weeks in months view dates" do
-      five_week_month_start = Candle::MonthModel.current_month_start(0, day_in_five_week_month)
-      five_week_month_end = Candle::MonthModel.current_month_end(0, day_in_five_week_month)
+      five_week_month_start = Candl::MonthModel.current_month_start(0, day_in_five_week_month)
+      five_week_month_end = Candl::MonthModel.current_month_end(0, day_in_five_week_month)
 
-      six_week_month_start = Candle::MonthModel.current_month_start(0, day_in_six_week_month)
-      six_week_month_end = Candle::MonthModel.current_month_end(0, day_in_six_week_month)
+      six_week_month_start = Candl::MonthModel.current_month_start(0, day_in_six_week_month)
+      six_week_month_end = Candl::MonthModel.current_month_end(0, day_in_six_week_month)
 
       five_week_months_view_dates = month.generate_months_view_dates(five_week_month_start, five_week_month_end)
       six_week_months_view_dates = month.generate_months_view_dates(six_week_month_start, six_week_month_end)
 
-      expect(Candle::MonthModel.weeks_in_months_view_dates(five_week_months_view_dates)).to eq(5)
-      expect(Candle::MonthModel.weeks_in_months_view_dates(six_week_months_view_dates)).to eq(6)
+      expect(Candl::MonthModel.weeks_in_months_view_dates(five_week_months_view_dates)).to eq(5)
+      expect(Candl::MonthModel.weeks_in_months_view_dates(six_week_months_view_dates)).to eq(6)
     end
 
     it "current month start" do
-      expect(Candle::MonthModel.current_month_start(current_shift_factor, fake_today)).to eq(date_month_start)
+      expect(Candl::MonthModel.current_month_start(current_shift_factor, fake_today)).to eq(date_month_start)
     end
     it "current month end" do
-      expect(Candle::MonthModel.current_month_end(current_shift_factor, fake_today)).to eq(date_month_end)
+      expect(Candl::MonthModel.current_month_end(current_shift_factor, fake_today)).to eq(date_month_end)
     end
   end
 end

data/spec/dummy/app/assets/config/manifest.js

@@ -1,4 +1,4 @@
 //= link_tree ../images
 //= link_directory ../javascripts .js
 //= link_directory ../stylesheets .css
-//= link candle_manifest.js
+//= link candl_manifest.js

data/spec/dummy/app/assets/javascripts/application.js

@@ -13,4 +13,4 @@
 //= require rails-ujs
 //= require activestorage
 //= require_tree .
-//= require candle/application
+//= require candl/application

data/spec/dummy/app/assets/stylesheets/application.css

@@ -12,7 +12,7 @@
  *
  *= require_tree .
  *= require_self
- *= require candle/application
+ *= require candl/application
  */
 
 /* 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/spec/dummy/app/views/sample/index-old.html.erb

@@ -1,3 +1,3 @@
 <div>You should see the calendar rendered below:</div>
 
-<%= render partial: 'candle/calendar/frame', locals: { calendar_id: "grhnk1uaotql6gv2dkf9ldmqjc@group.calendar.google.com", api_key: "AIzaSyD1UIlX0n4-DnY3hSoTkeTZFbbsNO2g67E" } %>
+<%= render partial: 'candl/calendar/frame', locals: { calendar_id: "grhnk1uaotql6gv2dkf9ldmqjc@group.calendar.google.com", api_key: "AIzaSyD1UIlX0n4-DnY3hSoTkeTZFbbsNO2g67E" } %>

data/spec/dummy/app/views/sample/show.slim

@@ -22,4 +22,4 @@ div You should see the calendar rendered below:
     } \
   }
 
-= render partial: 'candle/calendar/frame', locals: { config: config }
+= render partial: 'candl/calendar/frame', locals: { config: config }

data/spec/dummy/config/application.rb

@@ -3,7 +3,7 @@ require_relative 'boot'
 require 'rails/all'
 
 Bundler.require(*Rails.groups)
-require "candle"
+require "candl"
 
 module Dummy
   class Application < Rails::Application

data/spec/dummy/config/environments/production.rb

@@ -1,94 +1,94 @@
-Rails.application.configure do
-  # Settings specified here will take precedence over those in config/application.rb.
-
-  # Code is not reloaded between requests.
-  config.cache_classes = true
-
-  # Eager load code on boot. This eager loads most of Rails and
-  # your application in memory, allowing both threaded web servers
-  # and those relying on copy on write to perform better.
-  # Rake tasks automatically ignore this option for performance.
-  config.eager_load = true
-
-  # Full error reports are disabled and caching is turned on.
-  config.consider_all_requests_local       = false
-  config.action_controller.perform_caching = true
-
-  # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
-  # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
-  # config.require_master_key = true
-
-  # Disable serving static files from the `/public` folder by default since
-  # Apache or NGINX already handles this.
-  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
-
-  # Compress JavaScripts and CSS.
-  config.assets.js_compressor = :uglifier
-  # config.assets.css_compressor = :sass
-
-  # Do not fallback to assets pipeline if a precompiled asset is missed.
-  config.assets.compile = false
-
-  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
-
-  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
-  # config.action_controller.asset_host = 'http://assets.example.com'
-
-  # Specifies the header that your server uses for sending files.
-  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
-  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
-
-  # Store uploaded files on the local file system (see config/storage.yml for options)
-  config.active_storage.service = :local
-
-  # Mount Action Cable outside main process or domain
-  # config.action_cable.mount_path = nil
-  # config.action_cable.url = 'wss://example.com/cable'
-  # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
-
-  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
-  # config.force_ssl = true
-
-  # Use the lowest log level to ensure availability of diagnostic information
-  # when problems arise.
-  config.log_level = :debug
-
-  # Prepend all log lines with the following tags.
-  config.log_tags = [ :request_id ]
-
-  # Use a different cache store in production.
-  # config.cache_store = :mem_cache_store
-
-  # Use a real queuing backend for Active Job (and separate queues per environment)
-  # config.active_job.queue_adapter     = :resque
-  # config.active_job.queue_name_prefix = "dummy_#{Rails.env}"
-
-  config.action_mailer.perform_caching = false
-
-  # Ignore bad email addresses and do not raise email delivery errors.
-  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
-  # config.action_mailer.raise_delivery_errors = false
-
-  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
-  # the I18n.default_locale when a translation cannot be found).
-  config.i18n.fallbacks = true
-
-  # Send deprecation notices to registered listeners.
-  config.active_support.deprecation = :notify
-
-  # Use default logging formatter so that PID and timestamp are not suppressed.
-  config.log_formatter = ::Logger::Formatter.new
-
-  # Use a different logger for distributed setups.
-  # require 'syslog/logger'
-  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
-
-  if ENV["RAILS_LOG_TO_STDOUT"].present?
-    logger           = ActiveSupport::Logger.new(STDOUT)
-    logger.formatter = config.log_formatter
-    config.logger    = ActiveSupport::TaggedLogging.new(logger)
-  end
-
-  # Do not dump schema after migrations.
-  config.active_record.dump_schema_after_migration = false
-end
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Ensures that a master key has been made available in either ENV["RAILS_MASTER_KEY"]
+  # or in config/master.key. This key is used to decrypt credentials (and other encrypted files).
+  # config.require_master_key = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.public_file_server.enabled = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Store uploaded files on the local file system (see config/storage.yml for options)
+  config.active_storage.service = :local
+
+  # Mount Action Cable outside main process or domain
+  # config.action_cable.mount_path = nil
+  # config.action_cable.url = 'wss://example.com/cable'
+  # config.action_cable.allowed_request_origins = [ 'http://example.com', /http:\/\/example.*/ ]
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  config.log_tags = [ :request_id ]
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Use a real queuing backend for Active Job (and separate queues per environment)
+  # config.active_job.queue_adapter     = :resque
+  # config.active_job.queue_name_prefix = "dummy_#{Rails.env}"
+
+  config.action_mailer.perform_caching = false
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Use a different logger for distributed setups.
+  # require 'syslog/logger'
+  # config.logger = ActiveSupport::TaggedLogging.new(Syslog::Logger.new 'app-name')
+
+  if ENV["RAILS_LOG_TO_STDOUT"].present?
+    logger           = ActiveSupport::Logger.new(STDOUT)
+    logger.formatter = config.log_formatter
+    config.logger    = ActiveSupport::TaggedLogging.new(logger)
+  end
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end

data/spec/dummy/config/routes.rb

@@ -1,4 +1,4 @@
 Rails.application.routes.draw do
   get "calendar" => "sample#show"
-  mount Candle::Engine => "/candle"
+  mount Candl::Engine => "/candl"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: candl
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Andreas Schau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-12 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -244,9 +244,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.8.0
-description: It does so by offering functions that gather the event data, cache it
-  and structure it in a way that makes it easy to display in an agenda or monthly
-  overview-like style.
+description: This gem provides functionality to handle the loading of event data from
+  a public google calendar via an api key. (Without the need for OAuth.) It does so
+  by offering functions that gather the event data, cache it and structure it in a
+  way that makes it easy to display in an agenda or monthly overview-like style.
 email:
 - andreas.schau@hicknhack-software.com
 executables: []
@@ -257,33 +258,33 @@ files:
 - README.md
 - Rakefile
 - app/assets/config/candle_manifest.js
-- app/assets/javascripts/candle/application.js
-- app/assets/javascripts/candle/calendar.coffee
-- app/assets/stylesheets/candle/application.scss
-- app/assets/stylesheets/candle/calendar.scss
-- app/controllers/candle/application_controller.rb
-- app/controllers/candle/calendar_controller.rb
-- app/helpers/candle/application_helper.rb
-- app/helpers/candle/calendar_helper.rb
-- app/jobs/candle/application_job.rb
-- app/mailers/candle/application_mailer.rb
-- app/models/candle/application_record.rb
+- app/assets/javascripts/candl/application.js
+- app/assets/javascripts/candl/calendar.coffee
+- app/assets/stylesheets/candl/application.scss
+- app/assets/stylesheets/candl/calendar.scss
+- app/controllers/candl/application_controller.rb
+- app/controllers/candl/calendar_controller.rb
+- app/helpers/candl/application_helper.rb
+- app/helpers/candl/calendar_helper.rb
+- app/jobs/candl/application_job.rb
+- app/mailers/candl/application_mailer.rb
+- app/models/candl/application_record.rb
 - app/views/candle/calendar/_agenda.slim
 - app/views/candle/calendar/_frame.slim
 - app/views/candle/calendar/_month.slim
 - app/views/candle/calendar/show.slim
-- app/views/layouts/candle/application.html.erb
+- app/views/layouts/candl/application.html.erb
 - config/locales/de.yml
 - config/locales/en.yml
 - config/routes.rb
-- lib/candle.rb
-- lib/candle/agenda_model.rb
-- lib/candle/engine.rb
-- lib/candle/event_loader_model.rb
-- lib/candle/month_model.rb
-- lib/candle/version.rb
-- lib/tasks/candle_tasks.rake
-- spec/candle_spec.rb
+- lib/candl.rb
+- lib/candl/agenda_model.rb
+- lib/candl/engine.rb
+- lib/candl/event_loader_model.rb
+- lib/candl/month_model.rb
+- lib/candl/version.rb
+- lib/tasks/candl_tasks.rake
+- spec/candl_spec.rb
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/javascripts/application.js
@@ -1835,8 +1836,8 @@ test_files:
 - spec/dummy/config/puma.rb
 - spec/dummy/config/storage.yml
 - spec/dummy/config/environments/development.rb
-- spec/dummy/config/environments/production.rb
 - spec/dummy/config/environments/test.rb
+- spec/dummy/config/environments/production.rb
 - spec/dummy/config/initializers/application_controller_renderer.rb
 - spec/dummy/config/initializers/assets.rb
 - spec/dummy/config/initializers/backtrace_silencers.rb
@@ -3288,4 +3289,4 @@ test_files:
 - spec/dummy/spec/helpers/sample_helper_spec.rb
 - spec/spec_helper.rb
 - spec/rails_helper.rb
-- spec/candle_spec.rb
+- spec/candl_spec.rb

data/app/views/layouts/candle/application.html.erb

@@ -1,16 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Candle</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= stylesheet_link_tag    "candle/application", media: "all" %>
-  <%= javascript_include_tag "candle/application" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>

data/lib/candle/version.rb

@@ -1,3 +0,0 @@
-module Candle
-  VERSION = '0.1.4'
-end

data/lib/candle.rb

@@ -1,9 +0,0 @@
-require "candle/engine"
-
-require "candle/event_loader_model"
-require "candle/agenda_model"
-require "candle/month_model"
-
-module Candle
-  # Code is all found in the models and views.
-end