almanack 1.1.2 → 1.1.3.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b2b817b3542f16e0f902216bb7943efc0f8a3649ee507cceb1e667f19ef5158
-  data.tar.gz: a50858dfdee7700c0d5e54d492695e72ca6a99e571d7a0c40e6d4803b741ba86
+  metadata.gz: 589e41a369c5f596904916e5bd0bc40e904da5ac13dc7506af8ccdaf8ccea919
+  data.tar.gz: db2f95c8d0fe54b37c3a570f0c21c2216c79b1d69c53589599bdc7676a261c8e
 SHA512:
-  metadata.gz: 569ead2bd71123bbdb99b4b225344b94afb566c62be99be51ad713d37e86766db97c6438efdad30ecc9fc58edf6856ed7875429fba1bedfb9df911dd8c9cfbb7
-  data.tar.gz: c4fe0b799824eadbcf57cdee660d10e55e303953b04e3d0a53ddbe4f8b6ede8e7fcb9640a001169565f75809f4ec3a8066f02dff927373e97f44908bbd083ae5
+  metadata.gz: 65ecf27b42e36b027bc2d06b68875788eea4a4929def3c9de1e74a14803d1d67849bee652a4327fcf2c0ba22d3ea047e79d37c2a04863b1ff376ac81c6d223ba
+  data.tar.gz: 6c25a187d1b60e97d5cd8c304ef6db4cad1d6b643d7ea1c26b50c24a8d9de781fee376ea7c181f5ea0940fd98285d28e810efcd6e629c4214a185076944566c4

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    almanack (1.1.2)
+    almanack (1.1.3.rc1)
       activesupport
       addressable
       faraday
@@ -23,7 +23,7 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
-    backports (3.14.0)
+    backports (3.15.0)
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
     crack (0.4.3)
@@ -33,7 +33,7 @@ GEM
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.13.1)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.10.0)
+    ffi (1.11.1)
     hashdiff (0.3.8)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)

data/README.md

@@ -61,18 +61,37 @@ By default, your calendar will run on http://localhost:9292.
 See examples inside `config.ru` for iCal feeds, Meetup.com, or static events.
 
 ```ruby
-Almanack.config do |c|
-  c.title = 'My Calendar'
-  c.theme = 'my-custom-theme'
-  c.days_lookahead = 30
-  c.add_ical_feed 'http://example.org/events.ics'
-  c.add_ical_feed 'http://example.org/more-events.ics'
-  c.add_meetup_group group_urlname: 'Christchurch-Ruby-Group', key: 'mysecretkey'
+Almanack.config do |config|
+  config.title = 'My Calendar'
+  config.theme = 'my-custom-theme'
+  config.days_lookahead = 30
+
+  # Combine sources from multiple iCal feeds
+  config.add_ical_feed 'http://example.org/events.ics'
+  config.add_ical_feed 'http://example.org/more-events.ics'
+
+  # Include a downloaded iCal
+  config.add_ical Pathname('downloaded-calendar.ical')
+
+  # Include Meetup events
+  config.add_meetup_group group_urlname: 'Christchurch-Ruby-Group', key: 'mysecretkey'
 end
 ```
 
 **Note:** You'll need your [Meetup.com API key](https://secure.meetup.com/meetup_api/key) to use Meetup.
 
+### Time zone
+
+To set your time zone, set your system's `TZ` environment variable.
+
+```bash
+TZ=Pacific/Auckland
+```
+
+On Heroku, you can do this with:
+
+    heroku config:set TZ=Pacific/Auckland
+
 ## Custom themes
 
 Inside your project, you can generate a new theme with:

data/checksums/almanack-1.1.2.gem.sha256

@@ -0,0 +1 @@
+0416f69614ba947317d15dd3bc0a2fd22385a3078652a11501bccb03255f3bda

data/checksums/almanack-1.1.2.gem.sha512

@@ -0,0 +1 @@
+142b5b870607ea6e6dca03ba4f84898eac15b6e069dd56aa5421fa0ab58b5373091f36035d057bcb23a7cd63f24f6255eba150c1c6ad156ddcf117f33f151226

data/lib/almanack/configuration.rb

@@ -58,6 +58,10 @@ module Almanack
       add_event_source EventSource::IcalFeed.new(url, connection: connection)
     end
 
+    def add_ical(io)
+      add_event_source EventSource::Ical.from(io)
+    end
+
     def add_events(events)
       add_event_source EventSource::Static.new(events)
     end

data/lib/almanack/event.rb

@@ -3,12 +3,18 @@ require 'ostruct'
 module Almanack
   class Event < OpenStruct
     def formatted_date
-      formatted = "#{formatted_day(start_time)} at #{formatted_time(start_time)}"
+      warn "formatted_date is deprecated, please use formatted_duration instead"
+      formatted_duration
+    end
+
+    def formatted_duration
+      formatted = "#{formatted_day(start_time)}"
+      formatted << " at #{formatted_time(start_time)}" unless start_time.is_a?(Date)
 
       if end_time
-        formatted << " to "
+        formatted << " to " unless is_date_ending_on_same_day?
         formatted << "#{formatted_day(end_time)} at " unless ends_on_same_day?
-        formatted << formatted_time(end_time)
+        formatted << formatted_time(end_time) unless end_time.is_a?(Date)
       end
 
       formatted
@@ -79,6 +85,10 @@ module Almanack
       end
     end
 
+    def is_date_ending_on_same_day?
+      end_time.is_a?(Date) && ends_on_same_day?
+    end
+
     def ends_on_same_day?
       [start_time.year, start_time.yday] == [end_time.year, end_time.yday]
     end

data/lib/almanack/event_source/ical.rb

@@ -0,0 +1,59 @@
+module Almanack
+  module EventSource
+    class Ical
+      attr_reader :io
+
+      def initialize(io)
+        @io = io
+      end
+
+      def events_between(date_range)
+        occurrences_between(date_range).map(&method(:event_from))
+      end
+
+      def serialized_between(date_range)
+        { events: events_between(date_range).map(&:serialized) }
+      end
+
+      def self.from(*args)
+        self.new(*args)
+      end
+
+      private
+
+      def occurrences_between(date_range, &block)
+        return enum_for(__method__, date_range) unless block_given?
+
+        query = { starting: date_range.min, before: date_range.max }
+
+        each_event do |ical_event|
+          ical_event.occurrences(query).each(&block)
+        end
+      end
+
+      def event_from(occurrence)
+        Event.new(
+          title: occurrence.summary,
+          start_time: occurrence.dtstart,
+          end_time: occurrence.dtend,
+          description: occurrence.description,
+          location: occurrence.location
+        )
+      end
+
+      def read_io
+        io.respond_to?(:read) ? io.read : io
+      end
+
+      def entities
+        RiCal.parse_string(read_io)
+      end
+
+      def each_event(&block)
+        entities.each do |entity|
+          entity.events.each(&block) if entity.respond_to?(:events)
+        end
+      end
+    end
+  end
+end

data/lib/almanack/event_source/ical_feed.rb

@@ -1,64 +1,28 @@
 module Almanack
   module EventSource
     class IcalFeed
-      def initialize(url, options = {})
-        @url = url
-        @options = options
-      end
-
-      def events_between(date_range)
-        occurrences_between(date_range).map do |occurrence|
-          event_from(occurrence)
-        end
-      end
-
-      def serialized_between(date_range)
-        { events: events_between(date_range).map(&:serialized) }
-      end
-
-      private
-
-      def each_ical_event(&block)
-        entities.each do |entity|
-          entity.events.each(&block) if entity.respond_to?(:events)
-        end
-      end
-
-      def occurrences_between(date_range)
-        to_date = date_range.max
-        from_date = date_range.min
+      extend Forwardable
 
-        occurrences = []
+      attr_reader :ical, :connection
 
-        each_ical_event do |ical_event|
-          ical_event.occurrences(starting: from_date, before: to_date).each do |occurrence|
-            occurrences << occurrence
-          end
-        end
+      def_delegators :ical, :events_between, :serialized_between
 
-        occurrences
+      def initialize(url, connection:)
+        @url = url
+        @connection = connection
       end
 
-      def event_from(occurrence)
-        Event.new(
-          title: occurrence.summary,
-          start_time: occurrence.dtstart,
-          end_time: occurrence.dtend,
-          description: occurrence.description,
-          location: occurrence.location
-        )
+      def ical
+        @ical ||= Ical.from(response.body)
       end
 
-      def entities
-        RiCal.parse_string(response.body)
-      end
+      private
 
-      def connection
-        @options[:connection]
+      def uri
+        Addressable::URI.parse(@url)
       end
 
       def response
-        uri = Addressable::URI.parse(@url)
         connection.get(uri)
       end
 

data/lib/almanack/representation/built_ical_event.rb

@@ -0,0 +1,65 @@
+module Almanack
+  module Representation
+    class BuiltIcalEvent
+      attr_reader :event
+
+      def initialize(event)
+        @event = event
+      end
+
+      def ical_event
+        @ical_event ||= build!
+      end
+
+      def self.for(event)
+        new(event).ical_event
+      end
+
+      private
+
+      def build!
+        @ical_event = RiCal.Event
+        set_summary
+        set_start_time
+        set_end_time
+        set_description
+        set_location
+        ical_event
+      end
+
+      def set_summary
+        ical_event.summary = event.title
+      end
+
+      def set_start_time
+        if event.start_time.is_a?(Date)
+          ical_event.dtstart = event.start_time
+        else
+          ical_event.dtstart = event.start_time.utc
+        end
+      end
+
+      def set_end_time
+        if event.end_time.is_a?(Date)
+          ical_event.dtend = event.end_time
+        else
+          ical_event.dtend = (event.end_time || event.start_time + default_event_duration ).utc
+        end
+      end
+
+      def set_description
+        ical_event.description = event.description if event.description
+      end
+
+      def set_location
+        ical_event.location = event.location if event.location
+      end
+
+      def default_event_duration
+        # Three hours is the duration for events missing end dates, a
+        # recommendation suggested by Meetup.com.
+        3 * ONE_HOUR
+      end
+    end
+  end
+end

data/lib/almanack/representation/ical_feed.rb

@@ -32,25 +32,13 @@ module Almanack
       end
 
       def ical_event_for(event)
-        ical_event = RiCal.Event
-        ical_event.summary = event.title
-        ical_event.dtstart = event.start_time.utc
-        ical_event.dtend = (event.end_time || event.start_time + default_event_duration ).utc
-        ical_event.description = event.description if event.description
-        ical_event.location = event.location if event.location
-        ical_event
+        BuiltIcalEvent.for(event)
       end
 
       def lookahead
         now + calendar.feed_lookahead * ONE_DAY
       end
 
-      def default_event_duration
-        # Three hours is the duration for events missing end dates, a
-        # recommendation suggested by Meetup.com.
-        3 * ONE_HOUR
-      end
-
       def now
         @now ||= Time.now
       end

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

@@ -23,7 +23,7 @@
           <% end %>
 
           <dt>When</dt>
-          <dd><%= event.formatted_date %></dd>
+          <dd><%= event.formatted_duration %></dd>
         </dl>
       </div>
     </div>

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

@@ -23,7 +23,7 @@
           <% end %>
 
           <dt>When</dt>
-          <dd><%= event.formatted_date %></dd>
+          <dd><%= event.formatted_duration %></dd>
         </dl>
       </div>
     </div>

data/lib/almanack/version.rb

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

data/lib/almanack.rb

@@ -1,4 +1,5 @@
 require "pathname"
+require "forwardable"
 require "json"
 require "ri_cal"
 require "addressable/uri"
@@ -11,9 +12,11 @@ require "almanack/version"
 require "almanack/configuration"
 require "almanack/calendar"
 require "almanack/serialized_transformation"
+require "almanack/representation/built_ical_event"
 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"
 require "almanack/event_source/ical_feed"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: almanack
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3.rc1
 platform: ruby
 authors:
 - Pete Nicholls
@@ -34,7 +34,7 @@ cert_chain:
   dZpUW6Gfv2VtOtiN0Q3PjLK+TRjHtqYBjbxa771Msax3xs40e2cSVU/dO+OY5NmR
   a61dVmZ1PIJiY+jyzJSb8ohHVx4=
   -----END CERTIFICATE-----
-date: 2019-05-18 00:00:00.000000000 Z
+date: 2019-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -326,6 +326,8 @@ files:
 - certs/aupajo.pem
 - checksums/almanack-1.1.1.gem.sha256
 - checksums/almanack-1.1.1.gem.sha512
+- checksums/almanack-1.1.2.gem.sha256
+- checksums/almanack-1.1.2.gem.sha512
 - example.ru
 - exe/almanack
 - lib/almanack.rb
@@ -334,9 +336,11 @@ files:
 - lib/almanack/cli.rb
 - lib/almanack/configuration.rb
 - lib/almanack/event.rb
+- lib/almanack/event_source/ical.rb
 - lib/almanack/event_source/ical_feed.rb
 - lib/almanack/event_source/meetup_group.rb
 - lib/almanack/event_source/static.rb
+- lib/almanack/representation/built_ical_event.rb
 - lib/almanack/representation/ical_feed.rb
 - lib/almanack/representation/json_feed.rb
 - lib/almanack/serialized_transformation.rb
@@ -372,9 +376,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: