countdowner 0.2.0

data/README.md

@@ -0,0 +1,131 @@
+# Countdowner
+
+Countdown announcer for site maintenance etc.
+
+[![Build Status](https://secure.travis-ci.org/zubin/countdowner.png)](http://travis-ci.org/zubin/countdowner)
+
+![Molly with Kylie](http://images.smh.com.au/2011/12/17/2845044/art-Molly-420x0.jpg "Molly with Kylie (source: SMH)")
+
+## Synopsis
+
+### Scenario
+
+Your site is undergoing infrastructure changes which require downtime. Wouldn't it be great to warn users of impending doom well in advance.
+
+### Solution
+
+Simply create a message:
+
+    Countdowner::Message.create! message: "Site closing for maintenance {{target}}",
+                                 start_at: Time.parse("9pm").utc,
+                                 target: Time.parse("10pm").utc,
+                                 end_at: Time.parse("10:01pm").utc
+
+From 9pm users will see something like:
+
+    Site closing for maintenance 1 hour from now
+
+## Features
+
+* human readable time remaining
+* updated via Javascript, so it's always up-to-date
+* when Javascript is disabled, users will see UTC time
+* timezone agnostic
+* unaffected by caching
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'countdowner'
+
+And then execute:
+
+    $ bundle
+
+### Rails 3.1 and above
+
+    # application.js
+    //= require jquery.timeago
+    //= require jquery.countdowner
+
+    # Install migrations and migrate
+    $ rake countdowner_engine:install:migrations db:migrate
+
+### Rails 3.0 and below
+
+**TODO: generators**
+
+For now, copy these files into your app (paths are relative to gem).
+
+* vendor/assets/javascripts/jquery.timeago.js
+* lib/assets/javascripts/jquery.countdowner.js
+* db/migrations/20121018090014_create_countdowners.rb
+
+Then, include the Javascript files and migrate the database.
+
+### All versions
+
+Add this to your layout:
+
+    # application.html.erb (after opening body tag)
+    <%= countdowner %>
+
+Style it, eg:
+
+    # countdowner.css
+    #countdowner { background:#900; color:white; font-size:1.25em; padding:1em 2em; text-align:center; }
+
+## Optional configuration
+
+If you're not fussed about non-Javascript users, you can prevent the UTC time appearing before the DOM loads.
+
+    # application.html.erb
+    <%= countdowner(hidden_initially: true) %>
+
+If you're site cops a lot of traffic, cache it!
+
+    # application.html.erb (note that `expires_in` only works with memcache)
+    <% cache('countdowner', expires_in: 5.minutes) do %>
+      <%= countdowner %>
+    <% end %>
+
+## Requirements
+
+* rails (>= 2.3)
+* jQuery
+
+## Acknowledgments
+
+This gem uses the excellent [timeago](http://timeago.yarp.com/) jQuery plugin.
+
+## Contributing
+
+1. Fork it
+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
+
+## MIT License
+
+Copyright 2012 Zubin Henner
+
+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/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+task :build_js do
+  require 'coffee-script'
+  js_path = File.expand_path('../lib/assets/javascripts', __FILE__)
+  js = CoffeeScript.compile(File.read(File.join(js_path, 'src', 'jquery.countdowner.js.coffee')))
+  File.open(File.join(js_path, 'jquery.countdowner.js'), 'w') { |f| f << js }
+end

data/db/migrate/20121018090014_create_countdowners.rb

@@ -0,0 +1,9 @@
+class CreateCountdowners < ActiveRecord::Migration
+  def change
+    create_table :countdowners do |t|
+      t.datetime :target, :start_at, :end_at
+      t.string :message
+    end
+    add_index :countdowners, [:target, :start_at, :end_at]
+  end
+end

data/lib/assets/javascripts/jquery.countdowner.js

@@ -0,0 +1,29 @@
+(function() {
+
+  $(function() {
+    var $countdowner, allowFuture, removeAfterEnd,
+      _this = this;
+    $countdowner = $('#countdowner');
+    if ($countdowner.length) {
+      removeAfterEnd = function() {
+        console.log("checking...");
+        if ($countdowner.data('end_at') < new Date().toISOString()) {
+          $countdowner.remove();
+          if (_this.checkEnd != null) {
+            clearInterval(_this.checkEnd);
+          }
+          return true;
+        }
+      };
+      if (!removeAfterEnd()) {
+        allowFuture = $.timeago.settings.allowFuture;
+        $.timeago.settings.allowFuture = true;
+        $countdowner.find('time').timeago();
+        $countdowner.show();
+        $.timeago.settings.allowFuture = allowFuture;
+        return this.checkEnd = setInterval(removeAfterEnd, 60000);
+      }
+    }
+  });
+
+}).call(this);

data/lib/assets/javascripts/src/jquery.countdowner.js.coffee

@@ -0,0 +1,16 @@
+$ ->
+  $countdowner = $('#countdowner')
+  if $countdowner.length
+    removeAfterEnd = =>
+      console.log "checking..."
+      if $countdowner.data('end_at') < new Date().toISOString()
+        $countdowner.remove()
+        clearInterval(@checkEnd) if @checkEnd?
+        true
+    unless removeAfterEnd()
+      allowFuture = $.timeago.settings.allowFuture
+      $.timeago.settings.allowFuture = true
+      $countdowner.find('time').timeago()
+      $countdowner.show()
+      $.timeago.settings.allowFuture = allowFuture
+      @checkEnd = setInterval(removeAfterEnd, 60000)

data/lib/countdowner.rb

@@ -0,0 +1,4 @@
+require 'countdowner/action_view'
+require 'countdowner/datetime'
+require 'countdowner/message'
+require 'countdowner/rails'

data/lib/countdowner/action_view.rb

@@ -0,0 +1,16 @@
+module Countdowner
+  module ActionView
+    def countdowner(options = {})
+      message = Countdowner::Message.current or return
+      options[:id] = 'countdowner'
+      options[:'data-end_at'] = Countdowner::Datetime.new(message.end_at).iso
+      options[:style] = 'display:none' if options.delete(:hidden_initially)
+      content_tag(:div, options) do
+        time = Countdowner::Datetime.new(message.target)
+        message.message.sub('{{target}}', content_tag(:time, time.to_s, :datetime => time.iso)).html_safe
+      end
+    end
+  end
+end
+
+ActionView::Base.send :include, Countdowner::ActionView

data/lib/countdowner/datetime.rb

@@ -0,0 +1,15 @@
+module Countdowner
+  class Datetime
+    def initialize(time)
+      @utc = time.getutc
+    end
+
+    def iso
+      @utc.iso8601
+    end
+
+    def to_s
+      @utc.to_s
+    end
+  end
+end

data/lib/countdowner/message.rb

@@ -0,0 +1,26 @@
+module Countdowner
+  class Message < ActiveRecord::Base
+    attr_accessible :message, :start_at, :target, :end_at
+    validates_presence_of :message, :start_at, :target, :end_at
+    validates_format_of :message, :with => /\{\{target\}\}/
+    validate :ensure_valid_periods
+
+    def self.current
+      find(:first, :order => "target",
+           :conditions => ["target > :now and end_at > :now and start_at < :now", {:now => Time.now.utc}])
+    end
+
+    private
+
+    def self.table_name
+      'countdowners'
+    end
+
+    def ensure_valid_periods
+      if target.present?
+        errors.add(:start_at, "must be before target") if start_at.present? && start_at > target
+        errors.add(:end_at, "must be after target") if end_at.present? && end_at < target
+      end
+    end
+  end
+end

data/lib/countdowner/rails.rb

@@ -0,0 +1,3 @@
+if ::Rails.version >= '3.1'
+  Countdowner::Engine = Class.new(::Rails::Engine)
+end

data/lib/countdowner/version.rb

@@ -0,0 +1,3 @@
+module Countdowner
+  VERSION = "0.2.0"
+end

data/lib/tasks/announce_until_tasks.rake

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

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: countdowner
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Zubin Henner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coffee-script
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Countdown announcer for site maintenance etc.
+email:
+- zubin.henner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- db/migrate/20121018090014_create_countdowners.rb
+- lib/assets/javascripts/jquery.countdowner.js
+- lib/assets/javascripts/src/jquery.countdowner.js.coffee
+- lib/countdowner/action_view.rb
+- lib/countdowner/datetime.rb
+- lib/countdowner/message.rb
+- lib/countdowner/rails.rb
+- lib/countdowner/version.rb
+- lib/countdowner.rb
+- lib/tasks/announce_until_tasks.rake
+- Rakefile
+- README.md
+homepage: https://github.com/zubin/countdowner
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3925088943962807564
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3925088943962807564
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Countdown announcer for site maintenance etc.
+test_files: []