dates2svg 0.0.1.beta1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dates2svg.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,26 @@
+Copyright (c) 2012-2013.  The Board of Trustees of the Leland Stanford Junior University. All rights reserved.
+
+Redistribution and use of this distribution in source and binary forms, with or without modification, are permitted provided that: The above copyright notice and this permission notice appear in all copies and supporting documentation; The name, identifiers, and trademarks of The Board of Trustees of the Leland Stanford Junior University are not used in advertising or publicity without the express prior written permission of The Board of Trustees of the Leland Stanford Junior University; Recipients acknowledge that this distribution is made available as a research courtesy, "as is", potentially with defects, without any obligation on the part of The Board of Trustees of the Leland Stanford Junior University to provide support, services, or repair;
+
+THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, WITH REGARD TO THIS SOFTWARE, INCLUDING WITHOUT LIMITATION ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, AND IN NO EVENT SHALL THE BOARD OF TRUSTEES OF THE LELAND STANFORD JUNIOR UNIVERSITY BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, TORT (INCLUDING NEGLIGENCE) OR STRICT LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+MIT License
+
+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/README.md

@@ -0,0 +1,29 @@
+# Dates2svg
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dates2svg'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dates2svg
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dates2svg.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dates2svg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dates2svg"
+  spec.version       = Dates2SVG::VERSION
+  spec.authors       = ["Jessie Keck"]
+  spec.email         = ["jessie.keck@gmail.com"]
+  spec.description   = %q{Generate a SVG month grid w/ heatmap based on array of dates.}
+  spec.summary       = %q{Turn an array of objects that have a #value method w/ YYYY-MM-DD Date and a #hits method w/ the number of items in that month into an SVG month grid with heatmap.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/dates2svg/version.rb

@@ -0,0 +1,3 @@
+class Dates2SVG
+  VERSION = "0.0.1.beta1"
+end

data/lib/dates2svg.rb

@@ -0,0 +1,194 @@
+require "dates2svg/version"
+
+class Dates2SVG
+  BOX_SIZE = 15
+  BORDER = 1
+  BOX_WITH_BORDER = (BOX_SIZE + BORDER)
+  def initialize(dates, options={})
+    @dates = dates
+    @options = options
+    parse_dates
+  end
+
+  def parse_dates
+    @dates.map do |date|
+      date_from_facet_value(date)
+    end.sort do |a, b|
+      a.year.to_i <=> b.year.to_i
+    end.group_by(&:year).each do |year, dates|
+      years << Dates2SVG::Year.new(year, dates)
+    end
+  end
+  
+  def date_from_facet_value(facet)
+    facet.value[/^(\d{4})-(\d{2})-(\d{2})/]
+    Dates2SVG::DateWithValue.new(:year => $1, :month => $2, :day => $3, :hits => facet.hits)
+  end
+  
+  def years
+    @years ||= []
+  end
+  
+  def max
+    @max ||= years.map{|year| year.months.map{|month| month.hits} }.flatten.max
+  end
+  
+  def color_range
+    self.class.color_range(@options.merge(:max => @max))
+  end
+  
+  def color_options
+    @options[:color_options] || self.class.color_options
+  end
+  
+  def to_svg
+    svg = ""
+    # + 35 and +50 gives us the space for the year month text
+    svg << "<svg height='#{(12 * BOX_WITH_BORDER) + 35}' width='#{(all_years.to_a.length * BOX_WITH_BORDER) + 50}'>"
+      svg << "<g transform='translate(20,35)'>"
+        all_years.each_with_index do |year, index|
+          selected_years = years.select{|y| y.year.to_i == year.to_i }
+          unless selected_years.length == 0
+            svg << selected_years.first.to_svg(@options.merge(:index => index, :max => max))
+          else
+            svg << Dates2SVG::Year.new(year, []).to_svg(@options.merge(:index => index, :max => max))
+          end
+        end
+        svg << calendar_year_listing
+        svg << calendar_month_listing
+      svg << "</g>"
+    svg << "</svg>"
+  end
+  
+  def self.color_range(options={})
+    max_hits = options[:max] || 3000
+    section = (max_hits) / 5
+    colors = {}
+    color_options = options[:color_options] || self.color_options
+    ranges = [[0], (1..(section * 1)), 
+              (((section * 1) + 1)..(section * 2)), 
+              (((section * 2) + 1)..(section * 3)), 
+              (((section * 3) + 1)..(section * 4)), 
+              (((section * 4) + 1)..max_hits)]
+    color_options.each_with_index do |color, index|
+      unless ranges[index].is_a?(Range) and [ranges[index].first, ranges[index].last].include?(0)
+        colors[ranges[index]] = color
+      end
+    end
+    colors
+  end
+  
+  def self.color_options(options={})
+    options[:color_options] || ["#EEEEEE", "#330000", "#660000", "#990000", "#CC0000", "#FF0000"]
+  end
+  
+  private
+  
+  def all_years
+    @options[:year_range] || years.map{|y| y.year }
+  end
+  
+  def calendar_year_listing
+    svg = ""
+    all_years.each_with_index do |year, index|
+      svg << "<text x='3' y='#{(BOX_WITH_BORDER * index) + 20}' transform='rotate(-90)' class='year'>#{year}</text>"
+    end
+    svg
+  end
+  
+  def calendar_month_listing
+    svg = ""
+    ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", " Oct", "Nov", "Dec"].each_with_index do |month, index|
+      svg << "<text text-anchor='middle' class='cmonth' dx='0' dy='#{(BOX_WITH_BORDER * index) + 10}'>#{month}</text>"
+    end
+    svg
+  end
+  
+  class DateWithValue
+    attr_reader :year, :month, :day, :hits
+    def initialize(ops={})
+      @year = ops[:year]
+      @month = ops[:month]
+      @day = ops[:day]
+      @hits = ops[:hits]
+    end
+  end
+  
+  class Year
+    attr_reader :year
+    def initialize(year, dates)
+      @year = year
+      @dates = dates
+      parse_dates
+    end
+    
+    def parse_dates
+      @dates.sort do |a, b|
+        a.month.to_i <=> b.month.to_i
+      end.group_by(&:month).map do |month, dates|
+        months << Dates2SVG::Month.new(@year, month, dates)
+      end
+    end
+    
+    def months
+      @months ||= []
+    end
+    
+    def to_svg(options={})
+      svg = ""
+      svg << "<g transform='translate(#{(BOX_WITH_BORDER * options[:index]) + 12},0)'>"
+        all_months.each_with_index do |month, index|
+          unless months.select{|m| m.month == month}.length == 0
+            svg << months.select{|m| m.month == month}.first.to_svg(options.merge(:index => index))
+          else
+            svg << Dates2SVG::Month.new(@year, month, []).to_svg(options.merge(:index => index))
+          end
+        end
+      svg << "</g>"
+    end
+    
+    private
+    
+    def all_months
+      ["01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12"]
+    end
+    
+  end
+  
+  class Month
+    attr_reader :year, :month
+    def initialize(year, month, dates)
+      @year = year
+      @month = month
+      @dates = dates
+    end
+    def hits
+      @hits ||= (@dates.map{|d| d.hits.to_i }.inject(:+) || 0)
+    end
+    
+    def to_svg(options={})
+      svg = ""
+      svg << "<rect data-hits='#{hits}' data-year='#{@year}' data-month='#{@month}' class='month' width='#{BOX_SIZE}' height='#{BOX_SIZE}' y='#{BOX_WITH_BORDER * options[:index]}' style='fill: #{color(options)};'>"
+        svg << "<title>#{hits} hits on #{@year}-#{@month}</title>"
+      svg << "</rect>"
+    end
+    
+    private
+    
+    def color(options={})
+      max_hits = options[:max] || 3000
+      section = (max_hits / 5)
+      max = section * 5
+
+      return Dates2SVG.color_options(options).last if hits > max
+      colors = Dates2SVG.color_range(options)
+      begin
+        # .first turns the hash into an array and .last gets the value
+        colors.select{|k,v| k.include?(hits) }.first.last
+      rescue
+        Dates2SVG.color_options(options).first
+      end
+    end
+  end
+  
+end

data/spec/lib/dates2svg_spec.rb

@@ -0,0 +1,130 @@
+require "spec_helper"
+require "dates2svg"
+
+class DateValue
+  attr_reader :value, :hits
+  def initialize(ops={})
+    @value = ops[:value]
+    @hits = ops[:hits]
+  end
+end
+
+describe Dates2SVG do
+  before(:all) do
+    @hits_values = [98, 401, 500, 400, 100]
+    @dates = [
+    DateValue.new(:value=>"1779-05-02", :hits =>6),
+    
+    DateValue.new(:value=>"1789-01-05", :hits =>8),
+    DateValue.new(:value=>"1789-01-11", :hits =>20),
+    DateValue.new(:value=>"1789-01-12", :hits =>10),
+    
+    DateValue.new(:value=>"1789-03-10", :hits =>50),
+    DateValue.new(:value=>"1789-03-15", :hits =>100),
+    DateValue.new(:value=>"1789-03-20", :hits =>400),
+    DateValue.new(:value=>"1789-03-20", :hits =>323),
+    DateValue.new(:value=>"1789-03-14", :hits =>122),
+    DateValue.new(:value=>"1789-03-29", :hits =>426),
+    
+    DateValue.new(:value=>"1789-01-12", :hits =>10),
+    
+    DateValue.new(:value=>"1789-06-30", :hits =>5),
+    
+    DateValue.new(:value=>"1789-07-01", :hits =>7),
+    DateValue.new(:value=>"1789-07-02", :hits =>4),
+    DateValue.new(:value=>"1789-07-03", :hits =>5),
+    DateValue.new(:value=>"1789-07-04", :hits =>7),
+    DateValue.new(:value=>"1789-07-06", :hits =>6),
+    
+    DateValue.new(:value=>"1790-06-30", :hits =>40),
+    
+    DateValue.new(:value=>"1790-07-01", :hits =>@hits_values[0]),
+    DateValue.new(:value=>"1790-07-02", :hits =>@hits_values[1]),
+    DateValue.new(:value=>"1790-07-03", :hits =>@hits_values[2]),
+    DateValue.new(:value=>"1790-07-04", :hits =>@hits_values[3]),
+    DateValue.new(:value=>"1790-07-06", :hits =>@hits_values[4])]
+    @ranges = Dates2SVG.new(@dates)
+  end
+  
+  describe "date parsing" do
+    describe "years" do
+      it "should group the years properly" do
+        @ranges.years.length.should_not be 0
+        @ranges.years.length.should == 3
+        @ranges.years.map{|r| r.year }.should == ["1779", "1789", "1790"]
+      end
+    end
+    describe "months" do
+      it "should groups the months properly" do
+        year_1789 = @ranges.years.select{|y| y.year == "1789" }.first
+        year_1789.months.length.should == 4
+        year_1789.months.map{|m| m.month }.should == ["01", "03", "06", "07"]
+      end
+      it "should sum all the hits in the month" do
+        year_1790 = @ranges.years.select{|y| y.year == "1790" }.first
+        year_1790.months.length.should > 1
+        year_1790.months.select{|m| m.month == "07" }.first.hits.should == @hits_values.inject(:+)
+      end
+    end
+  end
+  
+  describe "max hits" do
+    it "should get the maximum number of hits in all months" do
+      @ranges.max.should == @hits_values.inject(:+)
+    end
+  end
+  
+  describe "colors" do
+    describe "color_range" do
+      it "should get the default max_hits when one is not provided" do
+        range = Dates2SVG.color_range
+        range.keys.first.should == [0]
+        range[[0]].should == "#EEEEEE"
+        range.keys.last.should == (2401..3000)
+        range[(2401..3000)].should == "#FF0000"
+      end
+      it "should use the max option passed to provide a differnt color range" do
+        range = Dates2SVG.color_range(:max => 6000)
+        range.keys.first.should == [0]
+        range[[0]].should == "#EEEEEE"
+        range.keys.last.should == (4801..6000)
+        range[(4801..6000)].should == "#FF0000"
+      end
+      it "should use an updated color range if one is provided" do
+        colors = ["black", "purple", "blue", "green", "yellow", "red"]
+        range = Dates2SVG.color_range(:max => 6000, :color_options => colors)
+        range.keys.first.should == [0]
+        range[[0]].should == colors.first
+        range.keys.last.should == (4801..6000)
+        range[(4801..6000)].should == colors.last
+      end
+    end
+  end
+  
+  describe "svg export" do
+    describe "options" do
+      describe "year_range" do
+        it "should return only the requested years" do
+          @ranges.to_svg.should match(/data-year='1779'/)
+          new_range = Dates2SVG.new(@dates, :year_range => (1785..1790))
+          new_range.to_svg.should_not match(/data-year='1779'/)
+        end
+      end
+      describe "color_options" do
+        it "use the range of color provided" do
+          [Dates2SVG.color_options.first, Dates2SVG.color_options.last].each do |color|
+            @ranges.to_svg.should match(/fill: #{color};/)
+          end
+          new_options = ["black", "purple", "blue", "green", "yellow", "red"]
+          new_range = Dates2SVG.new(@dates, :color_options => new_options).to_svg
+          Dates2SVG.color_options.each do |color|
+            new_range.should_not match(/fill: #{color};/)
+          end
+          [new_options.first, new_options.last].each do |color|
+            new_range.should match(/fill: #{color}/)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: dates2svg
+version: !ruby/object:Gem::Version
+  version: 0.0.1.beta1
+  prerelease: 6
+platform: ruby
+authors:
+- Jessie Keck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: Generate a SVG month grid w/ heatmap based on array of dates.
+email:
+- jessie.keck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dates2svg.gemspec
+- lib/dates2svg.rb
+- lib/dates2svg/version.rb
+- spec/lib/dates2svg_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! 'Turn an array of objects that have a #value method w/ YYYY-MM-DD Date
+  and a #hits method w/ the number of items in that month into an SVG month grid with
+  heatmap.'
+test_files:
+- spec/lib/dates2svg_spec.rb
+- spec/spec_helper.rb