almanack 1.0.5 → 1.1.0.beta1

data/lib/almanack/server.rb

@@ -1,3 +1,4 @@
+require "rack/contrib"
 require "sinatra"
 require "sinatra/reloader"
 require "sass"
@@ -6,67 +7,52 @@ require "almanack"
 module Almanack
   class Server < Sinatra::Base
     require "almanack/server/helpers"
+    require "almanack/server/environment"
 
-    configure :development do
-      register Sinatra::Reloader
-    end
+    include Almanack::ServerContext::Environment
 
     set :root, -> { Almanack.config.theme_root }
     set :protection, except: :frame_options
-    set :feed_path, "feed.ics"
-
-    not_found do
-      status 404
-      erb :error
-    end
-
-    error do
-      status 500
-      erb :error
-    end
+    set :feed_path, "feed"
 
-    def basename(file)
-      Pathname(file).split.last.to_s.split(".", 2).first
-    end
+    use Rack::JSONP
 
-    def locate_asset(name, within: path)
-      name = basename(name)
-      path = settings.root.join(within)
-      available = Pathname.glob(path.join("*"))
-      asset = available.find { |path| basename(path) == name }
-      raise "Could not find stylesheet #{name} inside #{available}" if asset.nil?
-      asset
+    configure :development do
+      register Sinatra::Reloader
     end
 
-    def auto_render_template(asset)
-      renderer = asset.extname.split(".").last
-      content = asset.read
-      respond_to?(renderer) ? send(renderer, content) : content
+    helpers do
+      include Almanack::ServerContext::Helpers
     end
 
-    def auto_render_asset(*args)
-      auto_render_template locate_asset(*args)
+    before do
+      register_sass_loadpaths!
     end
 
-    def theme_stylesheet_path
-      settings.root.join('stylesheets')
+    not_found do
+      status 404
+      erb :error
     end
 
-    before do
-      if !Sass.load_paths.include?(theme_stylesheet_path)
-        Sass.load_paths << theme_stylesheet_path
-      end
+    error do
+      status 500
+      erb :error
     end
 
     get "/" do
       erb :events
     end
 
-    get "/#{settings.feed_path}" do
+    get "/#{settings.feed_path}.ics" do
       content_type "text/calendar"
       Almanack.calendar.ical_feed
     end
 
+    get "/#{settings.feed_path}.json" do
+      content_type :json
+      Almanack.calendar.json_feed
+    end
+
     get "/stylesheets/:name" do
       content_type :css
       auto_render_asset params[:name], within: "stylesheets"

data/lib/almanack/themes/legacy/views/events.erb

@@ -4,8 +4,8 @@
   <% calendar.events.each do |event| %>
     <div class="event">
       <div class="date">
-        <div class="month"><%= event.start_date.strftime('%a') %></div>
-        <div class="day"><%= event.start_date.strftime('%d') %></div>
+        <div class="month"><%= event.start_time.strftime('%a') %></div>
+        <div class="day"><%= event.start_time.strftime('%d') %></div>
       </div>
       <div class="details">
         <h3 class="title"><%= event.title %></h3>

data/lib/almanack/themes/starter/views/events.erb

@@ -4,8 +4,8 @@
   <% calendar.events.each do |event| %>
     <div class="event">
       <div class="date">
-        <div class="month"><%= event.start_date.strftime('%a') %></div>
-        <div class="day"><%= event.start_date.strftime('%d') %></div>
+        <div class="month"><%= event.start_time.strftime('%a') %></div>
+        <div class="day"><%= event.start_time.strftime('%d') %></div>
       </div>
       <div class="details">
         <h3 class="title"><%= event.title %></h3>

data/lib/almanack/version.rb

@@ -1,6 +1,6 @@
 module Almanack
   CODENAME = "Garlick"
-  VERSION  = "1.0.5"
+  VERSION  = "1.1.0.beta1"
   HOMEPAGE = "https://github.com/Aupajo/almanack"
   ISSUES   = "https://github.com/Aupajo/almanack/issues"
 end

data/lib/almanack.rb

@@ -4,28 +4,14 @@ require "ri_cal"
 require "addressable/uri"
 require "faraday"
 
+require "almanack/base"
 require "almanack/version"
 require "almanack/configuration"
 require "almanack/calendar"
+require "almanack/serialized_transformation"
+require "almanack/representation/ical_feed"
+require "almanack/representation/json_feed"
 require "almanack/event"
 require "almanack/event_source/static"
 require "almanack/event_source/meetup_group"
 require "almanack/event_source/ical_feed"
-
-module Almanack
-  class << self
-    def config(&block)
-      @config ||= Configuration.new
-      yield @config if block_given?
-      @config
-    end
-
-    def calendar
-      @calendar ||= Calendar.new(config)
-    end
-
-    def reset!
-      config.reset!
-    end
-  end
-end

data/spec/calendar_spec.rb

@@ -42,9 +42,9 @@ module Almanack
 
         config = Configuration.new
         config.add_events [
-          { title: 'Today', start_date: today },
-          { title: 'Yesterday', start_date: yesterday },
-          { title: 'Tomorrow', start_date: tomorrow },
+          { title: 'Today', start_time: today },
+          { title: 'Yesterday', start_time: yesterday },
+          { title: 'Tomorrow', start_time: tomorrow },
         ]
 
         calendar = Calendar.new(config)
@@ -60,5 +60,12 @@ module Almanack
       end
     end
 
+    describe "#feed_lookahead" do
+      it "delegates to the configuration's feed_lookahead" do
+        config = double(feed_lookahead: :delegated)
+        expect(Calendar.new(config).feed_lookahead).to eq(:delegated)
+      end
+    end
+
   end
 end

data/spec/configuration_spec.rb

@@ -37,6 +37,16 @@ module Almanack
       end
     end
 
+    describe "#feed_lookahead" do
+      specify { expect(Configuration.new.feed_lookahead).to eq(365) }
+
+      specify "it can be set" do
+        config = Configuration.new
+        config.feed_lookahead = 30
+        expect(config.feed_lookahead).to eq(30)
+      end
+    end
+
     describe "#add_events" do
       it "adds a simple event collection event source" do
         config = Configuration.new

data/spec/event_source/ical_feed_spec.rb

@@ -16,10 +16,23 @@ module Almanack::EventSource
           end
         end
 
-        start_dates = events.map(&:start_date)
+        start_times = events.map(&:start_time)
 
         expect(events.length).to eq(15)
-        expect(events).to all_have_properties(:title, :start_date, :end_date, :description, :location)
+        expect(events).to all_have_properties(:title, :start_time, :end_time, :description, :location)
+      end
+    end
+
+    describe "#serialized_between" do
+      it "returns a hash containing attributes" do
+        source = IcalFeed.new 'url'
+
+        events = [double(serialized: :serialized_event)]
+        expect(source).to receive(:events_between).with(:date_range) { events }
+
+        expect(source.serialized_between(:date_range)).to eq({
+          events: [:serialized_event]
+        })
       end
     end
 

data/spec/event_source/meetup_group_spec.rb

@@ -17,10 +17,10 @@ module Almanack::EventSource
           end
         end
 
-        start_dates = events.map(&:start_date)
+        start_times = events.map(&:start_time)
 
         expect(events.length).to eq(5)
-        expect(events).to all_have_properties(:title, :start_date, :end_date, :description, :location)
+        expect(events).to all_have_properties(:title, :start_time, :end_time, :description, :location)
       end
 
       it "handles a missing location" do
@@ -38,5 +38,26 @@ module Almanack::EventSource
       end
     end
 
+    describe "#serialized_between" do
+      it "returns a hash containing attributes" do
+        feed = MeetupGroup.new(group_urlname: 'The-Foundation-Christchurch',
+                               key: 'secrettoken',
+                               connection: Faraday.new)
+        serialized = nil
+
+        Timecop.freeze(2014, 5, 24) do
+          VCR.use_cassette('meetup') do
+            from = Time.now
+            to = from + 30 * 24 * 60 * 60
+            serialized = feed.serialized_between(from..to)
+          end
+        end
+
+        expect(serialized[:events].length).to eq 5
+        expect(serialized[:name]).to eq("The Foundation")
+        expect(serialized[:url]).to eq("http://www.meetup.com/The-Foundation-Christchurch")
+      end
+    end
+
   end
 end

data/spec/event_source/static_spec.rb

@@ -2,16 +2,20 @@ require 'spec_helper'
 
 module Almanack::EventSource
   describe Static do
+    let(:yesterday) { now - 1 }
+    let(:now) { Time.now }
+    let(:tomorrow) { now + 1 }
+
+    around do |test|
+      Timecop.freeze(now, &test)
+    end
+
     describe "#events_between" do
       it "returns events between two dates" do
-        now = Time.now
-        yesterday = now - 1
-        tomorrow = now + 1
-
         source = Static.new [
-          { title: 'Yesterday', start_date: yesterday },
-          { title: 'Today', start_date: now },
-          { title: 'Tomorrow', start_date: tomorrow }
+          { title: 'Yesterday', start_time: yesterday },
+          { title: 'Today', start_time: now },
+          { title: 'Tomorrow', start_time: tomorrow }
         ]
 
         expect(source.events_between(yesterday..tomorrow).map(&:title)).to eq(%w( Yesterday Today Tomorrow ))
@@ -19,5 +23,19 @@ module Almanack::EventSource
         expect(source.events_between(yesterday..now).map(&:title)).to eq(%w( Yesterday Today ))
       end
     end
+
+    describe "#serialized_between" do
+      it "returns a hash containing attributes" do
+        source = Static.new []
+        date_range = yesterday..tomorrow
+
+        events = [double(serialized: :serialized_event)]
+        expect(source).to receive(:events_between).with(date_range) { events }
+
+        expect(source.serialized_between(date_range)).to eq({
+          events: [:serialized_event]
+        })
+      end
+    end
   end
 end

data/spec/event_spec.rb

@@ -8,14 +8,14 @@ module Almanack
       expect(event.title).to eq("Music with rocks in")
     end
 
-    it "has a start date" do
-      event = Event.new(start_date: Time.new(2014, 01, 01))
-      expect(event.start_date).to eq_time(Time.new(2014, 01, 01))
+    it "has a start time" do
+      event = Event.new(start_time: Time.new(2014, 01, 01))
+      expect(event.start_time).to eq_time(Time.new(2014, 01, 01))
     end
 
-    it "has a end date" do
-      event = Event.new(end_date: Time.new(2014, 01, 02))
-      expect(event.end_date).to eq_time(Time.new(2014, 01, 02))
+    it "has a end time" do
+      event = Event.new(end_time: Time.new(2014, 01, 02))
+      expect(event.end_time).to eq_time(Time.new(2014, 01, 02))
     end
 
     it "has a location" do
@@ -30,23 +30,92 @@ module Almanack
 
     describe "#formatted_date" do
       it "handles events without an end date" do
-        event = Event.new(start_date: Time.parse("2014-07-06 06:24:00 UTC"))
+        event = Event.new(start_time: Time.parse("2014-07-06 06:24:00 UTC"))
         expect(event.formatted_date).to eq("July 6 2014 at 6:24am")
       end
 
       it "handles events with an end date on the same day" do
-        event = Event.new(start_date: Time.parse("2014-07-06 06:24:00 UTC"),
-                          end_date:   Time.parse("2014-07-06 13:20:00 UTC"))
+        event = Event.new(start_time: Time.parse("2014-07-06 06:24:00 UTC"),
+                          end_time:   Time.parse("2014-07-06 13:20:00 UTC"))
         expect(event.formatted_date).to eq("July 6 2014 at 6:24am to 1:20pm")
       end
 
       it "handles events with an end date on a different day" do
-        event = Event.new(start_date: Time.parse("2014-07-06 06:00:00 UTC"),
-                          end_date:   Time.parse("2014-08-07 10:00:00 UTC"))
+        event = Event.new(start_time: Time.parse("2014-07-06 06:00:00 UTC"),
+                          end_time:   Time.parse("2014-08-07 10:00:00 UTC"))
         expect(event.formatted_date).to eq("July 6 2014 at 6:00am to August 7 2014 at 10:00am")
       end
     end
 
+    describe "#start_date" do
+      it "returns start_time for legacy reasons" do
+        event = Event.new(start_time: Time.new(2014, 01, 01))
+        result = nil
+        expect { result = event.start_date }.to output(/deprecated/i).to_stderr
+        expect(result).to eq_time(Time.new(2014, 01, 01))
+      end
+
+      it "can be set via start_date for legacy reasons" do
+        event = Event.new(start_date: Time.new(2014, 01, 01))
+        result = nil
+        expect { result = event.start_time }.to output(/deprecated/i).to_stderr
+        expect(result).to eq_time(Time.new(2014, 01, 01))
+      end
+
+      it "raises an error when both start_date and start_time are given" do
+        event = Event.new(start_date: Time.new(2014, 01, 01),
+                          start_time: Time.new(2014, 01, 02))
+        expect { event.start_date }.to raise_error
+        expect { event.start_time }.to raise_error
+      end
+    end
+
+    describe "#end_date" do
+      it "returns end_time for legacy reasons" do
+        event = Event.new(end_time: Time.new(2014, 01, 01))
+        result = nil
+        expect { result = event.end_date }.to output(/deprecated/i).to_stderr
+        expect(result).to eq_time(Time.new(2014, 01, 01))
+      end
+
+      it "can be set via end_date for legacy reasons" do
+        event = Event.new(end_date: Time.new(2014, 01, 01))
+        result = nil
+        expect { result = event.end_time }.to output(/deprecated/i).to_stderr
+        expect(result).to eq_time(Time.new(2014, 01, 01))
+      end
+
+      it "raises an error when both end_date and end_time are given" do
+        event = Event.new(end_date: Time.new(2014, 01, 01),
+                          end_time: Time.new(2014, 01, 02))
+        expect { event.end_date }.to raise_error
+        expect { event.end_time }.to raise_error
+      end
+
+      it "does not output a deprecation warning when using end_time if neither end_date or end_time is set" do
+        event = Event.new
+        expect { event.end_time }.not_to output.to_stderr
+      end
+    end
+
+    describe "#serialized" do
+      it "returns attributes as a hash" do
+        wed = Time.new(2014, 01, 01)
+        thu = Time.new(2014, 01, 02)
+
+        event = Event.new(title: "Hogswatch",
+                          start_time: wed,
+                          end_time: thu,
+                          arbitrary: true)
+
+        expect(event.serialized).to eq({
+          title: "Hogswatch",
+          start_time: wed.iso8601,
+          end_time: thu.iso8601,
+          arbitrary: true
+        })
+      end
+    end
 
   end
 end

data/spec/features/api_feature_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe "API", :feature do
+  before { Almanack.reset! }
+
+  describe "/feed.json" do
+    it "has a JSON content-type" do
+      get '/feed.json'
+      expect(last_response['Content-Type']).to eq 'application/json'
+    end
+
+    it "returns the JSON feed" do
+      allow(Almanack.calendar).to receive(:json_feed) { "feed" }
+      get '/feed.json'
+      expect(last_response.body).to eq("feed")
+    end
+
+    it "supports JSONP" do
+      allow(Almanack.calendar).to receive(:json_feed) { "feed" }
+      get '/feed.json?callback=custom'
+      expect(last_response.body).to include("custom(feed)")
+    end
+  end
+end

data/spec/features/calendar_feature_spec.rb

@@ -7,9 +7,9 @@ describe "Viewing a calendar", :feature do
     now = Time.now
 
     Almanack.config.add_events [
-      { title: "Hogswatch", start_date: now },
-      { title: "Soul Cake Tuesday", start_date: now + 10 * 24 * 60 * 60 },
-      { title: "Eve of Small Gods", start_date: now + 30 * 24 * 60 * 60 },
+      { title: "Hogswatch", start_time: now },
+      { title: "Soul Cake Tuesday", start_time: now + 10 * 24 * 60 * 60 },
+      { title: "Eve of Small Gods", start_time: now + 30 * 24 * 60 * 60 },
     ]
 
     Timecop.freeze(now) do

data/spec/features/subscription_feature_spec.rb

@@ -12,13 +12,13 @@ describe "Consolidated iCal feed", :feature do
     Almanack.reset!
 
     Almanack.config.add_events [
-      { title: "Basic", start_date: now },
-      { title: "Almost a year away", start_date: now + 364 * 24 * 60 * 60 },
-      { title: "Over a year away", start_date: now + 366 * 24 * 60 * 60 },
+      { title: "Basic", start_time: now },
+      { title: "Almost a year away", start_time: now + 364 * 24 * 60 * 60 },
+      { title: "Over a year away", start_time: now + 366 * 24 * 60 * 60 },
       {
         title: "Complex",
-        start_date: now,
-        end_date: now + 30 * 24 * 60 * 60,
+        start_time: now,
+        end_time: now + 30 * 24 * 60 * 60,
         description: "Body",
         location: "CA"
       }

data/spec/representation/json_feed_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+module Almanack::Representation
+  describe JSONFeed do
+
+    let(:calendar) { Almanack.calendar }
+    let(:parsed_json) { JSON.parse JSONFeed.from(calendar).to_s }
+
+    before do
+      Almanack.reset!
+    end
+
+    describe ".from" do
+      around do |test|
+        Timecop.freeze(Time.now, &test)
+      end
+
+      it "returns empty event sources by default" do
+        expect(parsed_json).to eq({ "eventSources" => [] })
+      end
+
+      it "returns event sources" do
+        Almanack.config.add_events [
+          { title: "Basic event", start_time: Time.now, custom_data: 'present' }
+        ]
+
+        expect(parsed_json).to eq({
+          "eventSources" => [
+            {
+              "events" => [
+                {
+                  "title" => "Basic event",
+                  "startTime" => Time.now.iso8601,
+                  "customData" => 'present'
+                }
+              ]
+            }
+          ]
+        })
+      end
+    end
+
+  end
+end

data/spec/serialized_transformation_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+module Almanack
+  describe SerializedTransformation do
+    let(:fact_book) do
+      {
+        title: "Facts of the World",
+        countries: [
+          { name: "New Zealand", population: "4 mil" },
+          { name: "America", population: "320 mil" }
+        ]
+      }
+    end
+
+    let(:transformation) { described_class.new(fact_book) }
+
+    describe "#apply" do
+      it "returns an unmodified structure by default" do
+        expect(transformation.apply).to eq fact_book
+      end
+
+      it "can apply changes to keys" do
+        transformation.key { |key| key.to_s }
+        expect(transformation.apply).to eq({
+          "title" => "Facts of the World",
+          "countries" => [
+            { "name" => "New Zealand", "population" => "4 mil" },
+            { "name" => "America", "population" => "320 mil" }
+          ]
+        })
+      end
+
+      it "can apply changes to values" do
+        transformation.value { |value| value.upcase  }
+        expect(transformation.apply).to eq({
+          title: "FACTS OF THE WORLD",
+          countries: [
+            { name: "NEW ZEALAND", population: "4 MIL" },
+            { name: "AMERICA", population: "320 MIL" }
+          ]
+        })
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -21,3 +21,5 @@ VCR.configure do |config|
   config.ignore_hosts 'codeclimate.com'
   config.hook_into :webmock
 end
+
+WebMock.disable_net_connect!(:allow => "codeclimate.com")

data/spec/support/event_matchers.rb

@@ -29,7 +29,7 @@ module EventMatchers
 
   matcher :be_in_order do
     match do |events|
-      events == events.sort_by(&:start_date)
+      events == events.sort_by(&:start_time)
     end
 
     failure_message do |events|

data/templates/new/config.ru.tt

@@ -17,7 +17,7 @@ Almanack.config do |c|
     {
       title: "Edit my calendar's settings",
       description: "Edit the configuration at #{__FILE__}",
-      start_date: Time.now + 30 * 60
+      start_time: Time.now + 30 * 60
     }
   ]
 end