almanack 0.0.1.alpha3 → 1.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d73adf865b8f26fc09b7964c10617ff54d6b381
-  data.tar.gz: c9835f0434bf1821619eb22d86a0396c156860c3
+  metadata.gz: a36a4f4c0b5adffd13cfac0f50c223065fed1285
+  data.tar.gz: 3c5788c29f66ce658e7def8103707a4897660523
 SHA512:
-  metadata.gz: 64d23b956709c3127395f09e774f7acc6ec4761222c085d6b86bc3cfd4e49c77bc578c7ee93abc007dc6dcba762f4eabff9b24d43ec5705b086cc620df858b31
-  data.tar.gz: 164eb43910f561b1fd46e154e460dff36e70cd392cd1311e08f3ad78ae63b5afe179f3f89beb1181cc064260a393dcefe2b64c48aae5e84efa2267a413a27cc8
+  metadata.gz: f8673f497e3c53d7adf7f6b5a668ddfe38a29e2ec949e235489b9f1302cd93573c1ec7c12bf19993528fbb0c5d93a4991f5d431408f8372b6258caa706e70e2e
+  data.tar.gz: 0a3d77922eef10c8fe8f36591e13a3d6f982d353ed7bdc5b4ea72e073e56190ff249920b687fbbb6dcc125cbd0109d6e359d01ebcfa4832292073dee196ce51a

data/README.md

@@ -4,34 +4,76 @@
 [![Code Climate](https://codeclimate.com/github/Aupajo/sinatra-gcal.png)](https://codeclimate.com/github/Aupajo/sinatra-gcal)
 [![Code Climate](https://codeclimate.com/github/Aupajo/sinatra-gcal/coverage.png)](https://codeclimate.com/github/Aupajo/sinatra-gcal)
 
-TODO: Write a gem description
+A calendar that combines events from different sources (such as Google Calendar, Meetup.com, and iCal feeds), and can be hosted for free on [Heroku](http://heroku.com).
+
+## Features
+
+* Aggregate multiple calendars together into one stream
+* Supports iCal feeds (incuding Google Calendars)
+* Supports Meetup.com groups
+* Just supply a hash to create any arbitrary event
+* Supports being freely hosted on Heroku
+* 100% customisable themes with Sass and CoffeeScript support
+* Server optional (you can use the underlying calendar library by itself)
+* Rack-compatible (mount inside any Rails application)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Run the following command:
+
+    gem install almanack --pre
+
+## Creating a calendar
+
+Generate a new calendar with:
+
+    almanack new my-calendar
+
+This will create a directory called `my-calendar` and set up your new project.
+
+Once set up, run:
+
+    cd my-calendar
+    almanack start
+
+By default, your calendar will run on http://localhost:9292.
 
-    gem 'almanack'
+## Configuration
 
-And then execute:
+See examples inside `config.ru` for iCal feeds, Meetup.com, or static events.
 
-    $ bundle
+```ruby
+Almanack.config do |c|
+  c.title = 'My Calendar'
+  c.theme = 'my-custom-theme'
+  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'
+end
+```
 
-Or install it yourself as:
+**Note:** You'll need your [Meetup.com API key](https://secure.meetup.com/meetup_api/key) to use Meetup.
 
-    $ gem install almanack
+## Custom themes
 
-## Usage
+Inside your project, you can generate a new theme with:
 
-TODO: Write usage instructions here
+    almanack theme my-theme-name
 
-### Meetup.com
+Remember to update your `config.ru` to switch themes:
 
-You'll need your [Meetup.com API key](https://secure.meetup.com/meetup_api/key).
+```ruby
+Almanack.config do |c|
+  ...
+  c.theme = 'my-theme-name'
+  ...
+end
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/Aupajo/sinatra-gcal/fork )
+1. Fork it ( http://github.com/Aupajo/almanack/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/almanac.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Pete Nicholls"]
   spec.email         = ["pete@metanation.com"]
   spec.summary       = %q{Combined events calendar for Google Calendar, iCal, Meetup.com and friends.}
-  spec.homepage      = "https://github.com/Aupajo/sinatra-gcal"
+  spec.homepage      = Almanack::HOMEPAGE
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "sass"
   spec.add_dependency "ri_cal"
   spec.add_dependency "addressable"
+  spec.add_dependency "thor"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"

data/bin/almanack

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'almanack/cli'
+Almanack::CLI.start

data/example.ru

@@ -1,20 +1,24 @@
 require "bundler/setup"
-require "rack/reloader"
-require "almanack"
+require "almanack/server"
 
-today = DateTime.now
+now = Time.now
 
-Almanack.config.title = 'Discworld Holidays'
+Almanack.config do |calendar|
+  calendar.title = 'Discworld Holidays'
 
-Almanack.config.add_events [
-  {
-    title: "Hogswatch",
-    start_date: today,
-    description: 'The sausages have been strung, the wreaths of oakleaves hung and the stockings dangled. The pork pie, the sherry and the all-important turnip await their festive guests. The poker lent against the fireplace may or may not have been bent over the head of some nightmare creature.',
-    location: 'Castle of Bones'
-  },
-  { title: "Soul Cake Tuesday", start_date: today + 10 },
-  { title: "Eve of Small Gods", start_date: today + 30 },
-]
+  calendar.theme = 'starter'
+
+  calendar.add_events [
+    {
+      title: "Hogswatch",
+      start_date: now + Almanack::Calendar::ONE_DAY,
+      end_date: now + Almanack::Calendar::ONE_DAY * 2,
+      description: 'The sausages have been strung, the wreaths of oakleaves hung and the stockings dangled. The pork pie, the sherry and the all-important turnip await their festive guests. The poker lent against the fireplace may or may not have been bent over the head of some nightmare creature.',
+      location: 'Castle of Bones'
+    },
+    { title: "Soul Cake Tuesday", start_date: now + 10 * Almanack::Calendar::ONE_DAY },
+    { title: "Eve of Small Gods", start_date: now + 30 * Almanack::Calendar::ONE_DAY },
+  ]
+end
 
 run Almanack::Server

data/lib/almanack.rb

@@ -1,23 +1,26 @@
 require "pathname"
 require "almanack/version"
-require "almanack/server"
 require "almanack/configuration"
 require "almanack/calendar"
-require "almanack/simple_event_collection"
-require "almanack/meetup_group"
-require "almanack/ical_feed"
 require "almanack/event"
+require "almanack/event_source/static"
+require "almanack/event_source/meetup_group"
+require "almanack/event_source/ical_feed"
 
 module Almanack
-  def self.config
-    @config ||= Configuration.new
-  end
+  class << self
+    def config(&block)
+      @config ||= Configuration.new
+      yield @config if block_given?
+      @config
+    end
 
-  def self.calendar
-    @calendar ||= Calendar.new(config)
-  end
+    def calendar
+      @calendar ||= Calendar.new(config)
+    end
 
-  def self.reset!
-    config.reset!
+    def reset!
+      config.reset!
+    end
   end
-end
+end

data/lib/almanack/calendar.rb

@@ -2,6 +2,11 @@ require 'forwardable'
 
 module Almanack
   class Calendar
+    ONE_HOUR = 60 * 60
+    ONE_DAY = 24 * ONE_HOUR
+    ONE_MONTH = 30 * ONE_DAY
+    ONE_YEAR = 365 * ONE_DAY
+
     extend Forwardable
     def_delegators :@config, :event_sources, :title
 
@@ -10,14 +15,41 @@ module Almanack
     end
 
     def events
-      from_date = DateTime.now
-      to_date = DateTime.now + days_lookahead
+      now = Time.now
+      future = now + days_lookahead * ONE_DAY
+      events_between(now..future)
+    end
 
+    def events_between(date_range)
       event_sources.map do |event_source|
-        event_source.events_between(from_date..to_date)
+        event_source.events_between(date_range)
       end.flatten.sort_by(&:start_date)
     end
 
+    def ical_feed
+      now = Time.now
+      future = now + ONE_YEAR
+
+      # Three hours is the duration for events missing end dates, a
+      # recommendation suggested by Meetup.com.
+      three_hours = 3 * ONE_HOUR
+
+      ical = RiCal.Calendar
+
+      events_between(now..future).each do |event|
+        ical_event = RiCal.Event
+        ical_event.summary = event.title
+        ical_event.dtstart = event.start_date.utc
+        ical_event.dtend = (event.end_date || event.start_date + three_hours).utc
+        ical_event.description = event.description if event.description
+        ical_event.location = event.location if event.location
+
+        ical.add_subcomponent(ical_event)
+      end
+
+      ical.to_s
+    end
+
     def days_lookahead
       30
     end

data/lib/almanack/cli.rb

@@ -0,0 +1,131 @@
+require "thor"
+require "pathname"
+
+module Almanack
+  class CLI < Thor
+    include Thor::Actions
+
+    SKIP_THEMES = %w( starter )
+
+    map "--version" => :version
+
+    def self.available_themes
+      dirs = Pathname(__dir__).join("themes").children.select(&:directory?)
+
+      dirs.map do |path|
+        path.basename.to_s unless SKIP_THEMES.include?(path.basename.to_s)
+      end.compact
+    end
+
+    desc "version", "Show Almanack version"
+    def version
+      say "Almanack version #{VERSION} (#{CODENAME})"
+    end
+
+    desc "start", "Start an Almanack server"
+    option :config, aliases: "-c", desc: "Path to config file"
+    def start
+      exec "bundle exec rackup #{options[:config]}"
+    end
+
+    desc "new PATH", "Create a new Almanack project"
+    option :theme, default: 'legacy', desc: "Which theme to use (available: #{available_themes.join(', ')})"
+    option :git, type: :boolean, default: true, desc: "Whether to initialize an empty git repo"
+    def new(path)
+      path = Pathname(path).cleanpath
+
+      directory "templates/new", path
+
+      if options[:git]
+        template('templates/gitignore', path.join(".gitignore"))
+      end
+
+      inside path do
+        say_status :installing, "bundler dependencies"
+        system "bundle install --quiet"
+
+        if options[:git]
+          say_status :git, "initializing repository"
+          git "init"
+        end
+
+        say
+        say "==> Run your new calendar!"
+        say
+        say "  cd #{path}"
+        say "  almnack start"
+        say
+      end
+    end
+
+    desc "theme NAME", "Create a new theme"
+    def theme(name)
+      directory "lib/almanack/themes/starter", "themes/#{name}"
+
+      config_file = Pathname("config.ru")
+
+      if config_file.exist?
+        say_status :update, "config.ru"
+        set_theme_pattern = /\.theme\s*=\s*['"].*?['"]/
+        replacement = config_file.read.gsub(set_theme_pattern, ".theme = '#{name}'")
+        config_file.open('w') { |file| file.puts replacement }
+      end
+    end
+
+    desc "deploy [NAME]", "Deploy your site to Heroku (requires Heroku toolbelt)"
+    def deploy(name = nil)
+      remotes = `git remote -v`
+
+      heroku_remote = remotes.lines.find do |remote|
+        remote.split(' ').first == "heroku"
+      end
+
+      if !heroku_remote
+        say "No Heroku remote detected."
+        create_heroku_app(name)
+      end
+
+      current_branch = git("rev-parse --abbrev-ref HEAD")
+
+      say "Deploying #{current_branch}..."
+      run "git push heroku #{current_branch}:master --force"
+    end
+
+    no_tasks do
+      def create_heroku_app(name)
+        heroku_command = `which heroku`.strip
+
+        if heroku_command.empty?
+          say "Heroku Toolbelt not detected. Please install from:"
+          say "  https://toolbelt.heroku.com"
+          abort
+        end
+
+        say_status :heroku, "creating app..."
+        run "#{heroku_command} create #{name}"
+      end
+
+      def theme_name
+        options[:theme]
+      end
+
+      def git(command)
+        output = `git #{command}`
+        abort "Git failed: #{output}" if $?.exitstatus != 0
+        output.strip
+      end
+
+      def available_themes
+        self.class.available_themes
+      end
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+
+    def self.source_root
+      Pathname(__dir__).parent.parent
+    end
+  end
+end

data/lib/almanack/configuration.rb

@@ -4,27 +4,43 @@ require 'ri_cal'
 
 module Almanack
   class Configuration
+    class ThemeNotFound < StandardError; end
+
+    DEFAULT_THEME = "legacy"
+
     attr_reader :event_sources
-    attr_accessor :title
+    attr_accessor :title, :theme, :theme_paths, :theme_root
 
     def initialize
       reset!
     end
 
     def reset!
+      @theme = DEFAULT_THEME
       @event_sources = []
+
+      @theme_paths = [
+        Pathname.pwd.join('themes'),
+        Pathname(__dir__).join('themes')
+      ]
+    end
+
+    def theme_root
+      paths = theme_paths.map { |path| path.join(theme) }
+      root = paths.find { |path| path.exist? }
+      root || raise(ThemeNotFound, "Could not find theme #{theme} in #{paths}")
     end
 
     def add_ical_feed(url)
-      @event_sources << IcalFeed.new(url)
+      @event_sources << EventSource::IcalFeed.new(url)
     end
 
     def add_events(events)
-      @event_sources << SimpleEventCollection.new(events)
+      @event_sources << EventSource::Static.new(events)
     end
 
     def add_meetup_group(options)
-      @event_sources << MeetupGroup.new(options)
+      @event_sources << EventSource::MeetupGroup.new(options)
     end
   end
 end

data/lib/almanack/event.rb

@@ -2,5 +2,30 @@ require 'ostruct'
 
 module Almanack
   class Event < OpenStruct
+    def formatted_date
+      formatted = "#{formatted_day(start_date)} at #{formatted_time(start_date)}"
+
+      if end_date
+        formatted << " to "
+        formatted << "#{formatted_day(end_date)} at " unless ends_on_same_day?
+        formatted << formatted_time(end_date)
+      end
+
+      formatted
+    end
+
+    private
+
+    def ends_on_same_day?
+      [start_date.year, start_date.yday] == [end_date.year, end_date.yday]
+    end
+
+    def formatted_time(time)
+      time.strftime('%-l:%M%P')
+    end
+
+    def formatted_day(time)
+      time.strftime('%B %-d %Y')
+    end
   end
-end
+end