timeline_setter 0.1.0

data/lib/timeline_setter/cli.rb

@@ -0,0 +1,85 @@
+require 'optparse'
+require 'fileutils'
+
+module TimelineSetter
+  class CLI
+    def initialize
+      parse_options!
+    end
+
+    def parse_options!
+      @options = {}
+      option_parser = OptionParser.new do |opts|
+        opts.banner = <<-BANNER
+          TimelineSetter: A tool to generate HTML timelines from CSVs.
+
+          Usage:
+        BANNER
+
+        opts.on('-c', '--csv CSV', 'CSV input file') do |c|
+          @options[:csv] = c
+        end
+        opts.on('-o', '--output OUTPUT', 'Output directory to install timeline into.') do |o|
+          @options[:output] = o
+        end
+        opts.on('-a', '--with-assets', 'Output timeline supporting assets as well') do |a|
+          @options[:assets] = a
+        end
+        opts.on('-O', '--open', 'Open generated timeline in a browser') do |o|
+          @options[:open] = o
+        end
+        opts.on('-m', '--min', 'Create a minified one-page version of the timeline') do |m|
+          @options[:min] = m
+        end
+
+
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
+      end
+      option_parser.parse!
+
+      if @options.empty?
+        puts option_parser.on_tail
+        exit
+      else
+        compile!
+      end
+    end
+
+    def sheet
+      File.open(@options[:csv]).read
+    end
+
+    def events
+      TimelineSetter::Parser.new sheet
+    end
+
+    def html
+      TimelineSetter::Timeline.new(events.events).send(@options[:min] ? :timeline_min : :timeline)
+    end
+
+    def outdir
+      @options[:output] ? @options[:output] : "#{`pwd`.strip}/"
+    end
+
+    def compile!
+      if @options[:assets]
+        FileUtils.cp_r(Dir.glob("#{TimelineSetter::ROOT}/public/*"), outdir)
+      end
+
+      File.open(outdir + 'timeline.html', 'w+') do |doc|
+        doc.write html
+      end
+
+      puts "== Files copied to #{outdir}"
+
+      if @options[:open]
+        puts "== Opening ..."
+        %x{ open #{outdir}timeline.html }
+      end
+    end
+
+  end
+end

data/lib/timeline_setter/parser.rb

@@ -0,0 +1,28 @@
+module TimelineSetter
+  class Parser
+    attr_reader :events
+
+    # Initialize a new timeline from a CSV file via TableFu,
+    # add a hash for each row (event) in the sheet to an events array.
+    # Sheet should contain columns for
+    #  * date
+    #  * display_date
+    #  * description
+    #  * link
+    #  * thumbnail
+    #  * series
+    #  * html
+    #
+    def initialize(sheet)
+      @events = []
+      spreadsheet = TableFu.new(sheet) do |s|
+        s.columns = %w[date display_date description link series html]
+      end
+
+      spreadsheet.rows.each do |row|
+        hash = spreadsheet.columns.inject({}) {|memo, column| memo[column.to_sym] = row[column].to_s ; memo}
+        @events << hash
+      end
+    end
+  end
+end

data/lib/timeline_setter/timeline.rb

@@ -0,0 +1,44 @@
+module TimelineSetter
+  class Timeline
+    attr_reader :timeline
+    # Instantiate a new timeline from an events
+    # array created in Parser#initialize
+    def initialize(events)
+      @events = events
+    end
+
+    # Convert human dates to timestamps, sort the hash by timestamp, and
+    # convert the events hash to JSON to stick into our HTML.
+    def to_json
+      @events.collect {|r| r[:timestamp] = Time.parse(r[:date]).to_i * 1000 }.sort{|a,b| b[:timestamp] <=> a[:timestamp]}
+      @events.to_json
+    end
+
+    def timeline_markup
+      tmpl("timeline-markup.erb")
+    end
+
+    # Create timeline HTML by interpolating events hash into an ERB template.
+    # Re-template timeline by editing ../templates/timeline.erb
+    # This version preserves external links to CSS and JS.
+    def timeline
+      @timeline = tmpl("timeline.erb")
+    end
+
+    # Create a minified one-page version of a timeline by minifying CSS and JS and embedding all assets
+    # into our ERB template.
+    def timeline_min
+      @js = ""
+      @css = Kompress::CSS.new(File.open("#{TimelineSetter::ROOT}/public/stylesheets/timeline-setter.css").read).css
+      libs = Dir.glob("#{TimelineSetter::ROOT}/public/javascripts/vendor/**")
+      libs.each { |lib| @js << File.open(lib,'r').read }
+      @min_html = Kompress::HTML.new(timeline_markup).html
+      @js << Closure::Compiler.new.compile(File.open("#{TimelineSetter::ROOT}/public/javascripts/timeline-setter.js", 'r'))
+      @timeline = tmpl("timeline-min.erb")
+    end
+    
+    def tmpl(tmpl_file)
+      ERB.new(File.open("#{TimelineSetter::ROOT}/templates/#{tmpl_file}").read).result(binding)
+    end
+  end
+end

data/lib/timeline_setter/version.rb

@@ -0,0 +1,3 @@
+module TimelineSetter
+  VERSION = "0.1.0"
+end

data/lib/timeline_setter.rb

@@ -0,0 +1,22 @@
+
+module TimelineSetter
+  ROOT = File.expand_path "#{File.dirname __FILE__}/.."
+end
+
+require 'date'
+require 'time'
+require 'erb'
+require 'table_fu'
+require 'json'
+require 'kompress'
+
+begin
+  require 'closure-compiler'
+  rescue LoadError
+    puts "== Warning, the closure-compiler gem is required to generate minified timelines"
+end
+
+
+require "#{TimelineSetter::ROOT}/lib/timeline_setter/version"
+require "#{TimelineSetter::ROOT}/lib/timeline_setter/parser"
+require "#{TimelineSetter::ROOT}/lib/timeline_setter/timeline"