dates2svg 0.0.1.beta1 → 0.0.1.beta2

data/.travis.yml

@@ -0,0 +1,5 @@
+notifications:
+  email: false
+rvm:
+  - 1.9.3
+  - 2.0.0

data/README.md

@@ -1,6 +1,10 @@
+[![Build Status](https://travis-ci.org/jkeck/dates2svg.png?branch=master)](https://travis-ci.org/jkeck/dates2svg)
+
 # Dates2svg
 
-TODO: Write a gem description
+Turn an array of simple objects including dates and values into an SVG month grid with heat-map.
+
+![date range heat map](http://i.imgur.com/6dcL09C.png)
 
 ## Installation
 
@@ -18,7 +22,31 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+You will need an array of objects that respond to value with a string in a YYYY-MM-DD format (things at the end like timestamps are okay) and respond to hits with a number.
+
+    dates = [OpenStruct.new(:value => "2013-01-22", :hits => 100), 
+             OpenStruct.new(:value => "2013-01-05", :hits => 140),
+             OpenStruct.new(:value => "2013-01-12", :hits => 10)]
+             
+Passing that array to Dates2SVG.new will give you your object that you can get the SVG from.
+
+    svg = Dates2SVG.new(dates).to_svg
+    
+### Options
+
+There are various options that can be passed in as an options has upon initialization.  These options are year_range, color_options, box_size, and border.
+    
+By default you will only get years that occur in the data passed in the dates array.  You can specify a range of years by passing a year_range option.
+
+    svg = Dates2SVG.new(dates, :year_range => (2000..2020)).to_svg
+
+If you would like to change the colors that the grid uses for the heat-map you can specify different colors in the color_options option.
+
+    svg = Dates2SVG.new(dates, :color_options => ["black", "purple", "blue", "green", "yellow", "red"]).to_svg
+    
+You can see the current range of colors and hits ranges being used in the SVG by accessing in the color_range key in the options hash.  This would be useful in generating a legend.
+
+    color_range = Dates2SVG.new(dates).options[:color_range]
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/dates2svg.rb

@@ -1,28 +1,14 @@
 require "dates2svg/version"
 
 class Dates2SVG
-  BOX_SIZE = 15
-  BORDER = 1
-  BOX_WITH_BORDER = (BOX_SIZE + BORDER)
+  attr_reader :options
   def initialize(dates, options={})
     @dates = dates
     @options = options
+    process_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)
+    @options[:color_range] = color_range
+    @options[:max] = max
   end
   
   def years
@@ -34,24 +20,41 @@ class Dates2SVG
   end
   
   def color_range
-    self.class.color_range(@options.merge(:max => @max))
-  end
-  
-  def color_options
-    @options[:color_options] || self.class.color_options
+    max_hits = max || 3000
+    section = (max_hits) / (@options[:color_options].length - 1)
+    colors = {}
+    ranges = [[0]]
+    
+    i = 0
+    (@options[:color_options].length - 1).times do
+      if i == 0
+        ranges << (1..(section * 1))
+      elsif ((i+1) == (@options[:color_options].length - 1))
+        ranges << (((section * i) + 1)..max_hits)
+      else
+        ranges << (((section * i) + 1)..(section * (i + 1)))
+      end
+      i = i+1
+    end
+    @options[: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 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 << "<svg height='#{(12 * @options[:box_with_border]) + 35}' width='#{(all_years.to_a.length * @options[: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))
+            svg << selected_years.first.to_svg(:index => index)
           else
-            svg << Dates2SVG::Year.new(year, []).to_svg(@options.merge(:index => index, :max => max))
+            svg << Dates2SVG::Year.new(year, [], @options).to_svg(:index => index)
           end
         end
         svg << calendar_year_listing
@@ -60,30 +63,23 @@ class Dates2SVG
     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
+  private
+  
+  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, @options)
     end
-    colors
   end
-  
-  def self.color_options(options={})
-    options[:color_options] || ["#EEEEEE", "#330000", "#660000", "#990000", "#CC0000", "#FF0000"]
+
+  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
-  
-  private
-  
+
   def all_years
     @options[:year_range] || years.map{|y| y.year }
   end
@@ -91,7 +87,7 @@ class Dates2SVG
   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>"
+      svg << "<text x='3' y='#{(@options[:box_with_border] * index) + 20}' transform='rotate(-90)' class='year'>#{year}</text>"
     end
     svg
   end
@@ -99,11 +95,24 @@ class Dates2SVG
   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>"
+      svg << "<text text-anchor='middle' class='cmonth' dx='0' dy='#{(@options[:box_with_border] * index) + 10}'>#{month}</text>"
     end
     svg
   end
   
+  def process_options
+    @options = self.class.default_options.merge(@options)
+    @options[:box_with_border] = (@options[:box_size].to_i + @options[:border].to_i)
+  end
+  
+  def self.default_options
+    {:color_options => ["#EEEEEE", "#330000", "#660000", "#990000", "#CC0000", "#FF0000"],
+     :box_size => 15,
+     :border => 1,
+     :box_with_border => nil
+    }
+  end
+  
   class DateWithValue
     attr_reader :year, :month, :day, :hits
     def initialize(ops={})
@@ -116,32 +125,25 @@ class Dates2SVG
   
   class Year
     attr_reader :year
-    def initialize(year, dates)
+    def initialize(year, dates, options={})
       @year = year
       @dates = dates
+      @options = options
       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)'>"
+      svg << "<g transform='translate(#{(@options[: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))
+            svg << months.select{|m| m.month == month}.first.to_svg(:index => index)
           else
-            svg << Dates2SVG::Month.new(@year, month, []).to_svg(options.merge(:index => index))
+            svg << Dates2SVG::Month.new(@year, month, [], @options).to_svg(:index => index)
           end
         end
       svg << "</g>"
@@ -149,6 +151,14 @@ class Dates2SVG
     
     private
     
+    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, @options)
+      end
+    end
+    
     def all_months
       ["01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12"]
     end
@@ -157,10 +167,11 @@ class Dates2SVG
   
   class Month
     attr_reader :year, :month
-    def initialize(year, month, dates)
+    def initialize(year, month, dates, options={})
       @year = year
       @month = month
       @dates = dates
+      @options = options
     end
     def hits
       @hits ||= (@dates.map{|d| d.hits.to_i }.inject(:+) || 0)
@@ -168,25 +179,25 @@ class Dates2SVG
     
     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 << "<rect data-hits='#{hits}' data-year='#{@year}' data-month='#{@month}' class='month' width='#{@options[:box_size]}' height='#{@options[:box_size]}' y='#{@options[:box_with_border] * options[:index]}' style='fill: #{color};'>"
         svg << "<title>#{hits} hits on #{@year}-#{@month}</title>"
       svg << "</rect>"
     end
     
     private
     
-    def color(options={})
-      max_hits = options[:max] || 3000
+    def color
+      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)
+      return @options[:color_options].last if hits > max
+      colors = @options[:color_range]
       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
+        @options[:color_options].first
       end
     end
   end

data/lib/dates2svg/version.rb

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

data/spec/lib/dates2svg_spec.rb

@@ -76,33 +76,64 @@ describe Dates2SVG do
   
   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"
+      it "should use the default maximum of 3000 if one isn't available (althouth that shouldn't happen)" do
+        range = Dates2SVG.new([]).options[:color_range]
         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)
+      it "should be from 0 - the max number of hits" do
+        range = @ranges.options[:color_range]
         range.keys.first.should == [0]
         range[[0]].should == "#EEEEEE"
-        range.keys.last.should == (4801..6000)
-        range[(4801..6000)].should == "#FF0000"
+        range.keys.last.should == (1197..1499)
+        range[(1197..1499)].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 = Dates2SVG.new([], :color_options => colors).options[:color_range]
         range.keys.first.should == [0]
         range[[0]].should == colors.first
-        range.keys.last.should == (4801..6000)
-        range[(4801..6000)].should == colors.last
+        range.keys.last.should == (2401..3000)
+        range[(2401..3000)].should == colors.last
+      end
+      it "should have more range options if additional colors are passed" do
+        colors = ["black", "purple", "blue", "green", "yellow", "red"]
+        range = Dates2SVG.new([], :color_options => colors).options[:color_range]
+        range.keys.length.should == colors.length
+        colors << ["#FF0000", "grey"]
+        range = Dates2SVG.new([], :color_options => colors).options[:color_range]
+        range.keys.length.should == colors.length
       end
     end
   end
   
   describe "svg export" do
     describe "options" do
+      describe "box size" do
+        it "should default to a 15px box size" do
+          @ranges.to_svg.should match(/<rect.*width='15' height='15'.*>/)
+        end
+        it "should change the box size when a box_size option is available" do
+          new_range = Dates2SVG.new(@dates, :box_size => "10").to_svg
+          new_range.should_not match(/<rect.*width='15' height='15'.*>/)
+          new_range.should match(/<rect.*width='10' height='10'.*>/)
+        end
+      end
+      describe "border" do
+        it "should default to a 1px border" do
+          @ranges.to_svg.should include "<g transform='translate(28,0)'>"
+        end
+        it "should change the border when a border options is available" do
+          border_2 = Dates2SVG.new(@dates, :border => "2").to_svg
+          border_2.should_not include "<g transform='translate(28,0)'>"
+          border_2.should include "<g transform='translate(29,0)'>"
+          
+          border_4 = Dates2SVG.new(@dates, :border => "4").to_svg
+          border_4.should_not include "<g transform='translate(28,0)'>"
+          border_4.should include "<g transform='translate(31,0)'>"
+        end
+      end
+      
       describe "year_range" do
         it "should return only the requested years" do
           @ranges.to_svg.should match(/data-year='1779'/)
@@ -112,12 +143,12 @@ describe Dates2SVG do
       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.options[:color_options].first, @ranges.options[: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|
+          @ranges.options[:color_options].each do |color|
             new_range.should_not match(/fill: #{color};/)
           end
           [new_options.first, new_options.last].each do |color|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dates2svg
 version: !ruby/object:Gem::Version
-  version: 0.0.1.beta1
+  version: 0.0.1.beta2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,6 +68,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md