grosser-db_graph 0.1.2

data/README.markdown

@@ -0,0 +1,44 @@
+Gem/Rails plugin to generate graphs from all your date fields, beautifully simple and combineable.
+
+Examples
+========
+Weeks and months  
+![weeks](http://chart.apis.google.com/chart?chxl=0:|0||||||||||10||||||||||20||||||||||30||||||||||40||||||||||50|||1:|6|16|25|35|45|54|64|74|83|93&cht=lc&chs=445x400&chdl=Product+created_at|Product+updated_at&chd=s:JTKPKLKMUNPQHQSKRNLGPPLKUHNNPFJLLPNJINQex19u5xrrNFKLD,HLJMONLJLNHPQNOLNPMMINNKPMPGKLFJLRQLKOOtsxxvw137MHOLF&chco=333300,bbbb33&chxt=x,y)
+![months](http://chart.apis.google.com/chart?chxl=0:|1|2|3|4|5|6|7|8|9|10|11|12|1:|67|98|130|161|193|224|256|287|319|350&cht=lc&chs=445x400&chdl=Product+created_at|Product+updated_at&chd=s:QOQROONPM92L,OMPPOOMPO77N&chco=884466,22dddd&chxt=x,y)
+
+
+Install
+=======
+As Gem:
+    sudo gem install grosser-db_graph -s http://gems.github.com/
+
+Or as Rails plugin:
+    sudo gem install gchartrb
+    ./script/plugins install git://github.com/grosser/db_graph.git
+
+
+Usage
+=====
+    #all hours/days/weeks/months
+    g = DBGraph::Line.new(:weeks)
+
+    #hours/days/weeks/months in a selected interval (e.g. in 1 year for months)
+    g = DBGraph::Line.new(:weeks, :at=>Time.parse('2009-01-02 14:15:16'))
+    
+    g.add(User, :created_at)
+    g.add(Item, :sold_at, :label=>'Things we sold')
+    g.add(Product, :sold_at, :conditions=>['merchandise = ?',false])
+    ...
+    g.to_url --> google chart url with all your data as line graph
+
+We got :minutes, :hours, :days, :weeks, :months and seconds/years can be added if someone needs them...
+
+TODO
+====
+ - weeks/months from beginning of data (->all years)
+
+Author
+======
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/Rakefile

@@ -0,0 +1,24 @@
+desc "Run all specs in spec directory"
+task :default do |t|
+  options = "--colour --format progress --loadby --reverse"
+  files = FileList['spec/**/*_spec.rb']
+  system("spec #{options} #{files}")
+end
+
+
+begin
+  require 'jeweler'
+  project_name = 'db_graph'
+  Jeweler::Tasks.new do |gem|
+    gem.name = project_name
+    gem.summary = "AR generate beautiful graphs from date fields, in 1 LOC"
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.authors = ["Michael Grosser"]
+    gem.add_dependency ['gchartrb']
+    gem.add_dependency ['activesupport']
+    gem.add_dependency ['activerecord']
+  end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 2
+:major: 0

data/lib/db_graph/line.rb

@@ -0,0 +1,112 @@
+gem 'gchartrb'
+require 'google_chart'
+
+module DBGraph
+  class Line
+    NUM_Y_LABELS = 10
+    
+    attr_accessor :data
+    
+    def initialize(style, options={})
+      @style = style.to_sym
+      @options = options
+      self.data = {}
+    end
+
+    def add(model, attribute, options={})
+      label = options.delete(:label) || "#{model} #{attribute}"
+      data[label] = count(model, attribute, options)
+    end
+
+    def count(model, attribute, options={})
+      scope = if @options[:at]
+        start, ende = interval_for(@options[:at])
+        model.scoped(:conditions=>["#{attribute} BETWEEN ? AND ?", start, ende]).scoped(options)
+      else
+        model.scoped(options)
+      end
+      data_type = @style.to_s.sub(/s$/,'').upcase
+      scope.count(:group=>"#{data_type}(#{attribute})")
+    end
+
+    def to_url
+      size = @options[:size] || '600x500'
+      GoogleChart::LineChart.new(size, nil, false) do |line|
+        for name, hash in data
+          line.data(name, self.class.filled_and_sorted_values(hash, x_values), random_color)
+        end
+        line.axis :x, :labels => x_labels
+        line.axis :y, :labels => y_labels
+      end.to_url
+    end
+
+    def x_labels
+      case @style
+      when :days then x_values.map{|x|x%5==0 ? x : ''}
+      when :weeks, :minutes then x_values.map{|x|x%10==0 ? x : ''}
+      else x_values
+      end
+    end
+
+    def y_labels
+      values = []
+      data.each{|name,hash|values += self.class.filled_and_sorted_values(hash, x_values)}
+      distribute_evently(values, NUM_Y_LABELS)
+    end
+
+    private
+
+    def x_values
+      case @style
+      when :minutes then 0..59
+      when :hours then 0..23
+      when :days then 1..31
+      when :weeks then 0..52 #week 0 == week 52 of last year, e.g. in 2009-01-01
+      when :months then 1..12
+      else raise "#{@style} is not supported"
+      end.to_a
+    end
+
+    def random_color
+      [1,2,3].map{ (('0'..'9').to_a + ('a'..'f').to_a)[rand(16)] * 2 } * ''
+    end
+    
+    def interval_for(time)
+      interval_word = {:minutes=>:hour,:hours=>:day,:days=>:month,:weeks=>:year,:months=>:year}[@style]
+      raise "style #{@style} is not supported" unless interval_word
+
+      start = self.class.at_beginning_of_interval(time, interval_word)
+      ende = start + 1.send(interval_word) - 1.second
+      [start, ende]
+    end
+
+    def self.at_beginning_of_interval(time, interval_type)
+      #simple substraction does not (seem) to work for long intervals (summer/winter time ?)
+      #and at_beginning_of_hour is not defined
+      if [:year, :month, :week, :day].include? interval_type
+        time.to_date.send("at_beginning_of_#{interval_type}")
+      else
+        time - (time.to_i % 1.send(interval_type))
+      end
+    end
+
+    def self.filled_and_sorted_values(values, keys)
+      array = fill_up_values(values, keys)
+      array.sort.map(&:last)
+    end
+
+    #values is array or hash with integer or string keys
+    def self.fill_up_values(values, expected_keys)
+      values = values.map{|k,v| [k.to_i, v]}
+      expected_keys.each{|k| values += [[k,0]] unless values.assoc(k)}
+      values.sort
+    end
+
+    def distribute_evently(values, num_steps)
+      min = values.min
+      max = values.max
+      step = (max-min) / (num_steps-1).to_f
+      (0...num_steps).map{|i| (step*i + min).to_f.round}
+    end
+  end
+end

data/spec/db_graph/line_spec.rb

@@ -0,0 +1,218 @@
+require File.join(File.dirname(__FILE__),'..','spec_helper')
+
+describe DBGraph::Line do
+  describe "minutes" do
+    before :all do
+      Product.delete_all
+      Product.create!(:created_at=>"2009-01-01 10:59:59")
+      Product.create!(:created_at=>"2009-01-01 10:59:59")
+
+      Product.create!(:created_at=>"2009-01-01 11:00:00")
+      Product.create!(:created_at=>"2009-01-01 11:10:10")
+      Product.create!(:created_at=>"2009-01-01 11:10:20")
+      Product.create!(:created_at=>"2009-01-01 11:59:59")
+
+      Product.create!(:created_at=>"2009-01-01 12:00:00")
+      Product.create!(:created_at=>"2009-01-01 12:00:00")
+    end
+
+    it "collects from one hour when at is set" do
+      line = DBGraph::Line.new(:minutes, :at=>Time.parse('2009-01-01 11:15:16'))
+      line.count(Product, :created_at).should == {"0"=>1,"10"=>2,"59"=>1}
+    end
+
+    it "collects from all hours when at is not set" do
+      @line = DBGraph::Line.new(:minutes)
+      @line.count(Product, :created_at).should == {"59"=>3,"0"=>3,"10"=>2}
+    end
+  end
+
+  describe "hours" do
+    before :all do
+      Product.delete_all
+      Product.create!(:created_at=>"2009-01-01 23:59:59")
+
+      Product.create!(:created_at=>"2009-01-02 00:00:00")
+      Product.create!(:created_at=>"2009-01-02 10:11:12")
+      Product.create!(:created_at=>"2009-01-02 10:59:12")
+      Product.create!(:created_at=>"2009-01-02 13:11:12")
+
+      Product.create!(:created_at=>"2009-01-03 00:00:00")
+    end
+
+    it "collects from one day when at is set" do
+      @line = DBGraph::Line.new(:hours, :at=>Time.parse('2009-01-02 14:15:16'))
+      @line.count(Product, :created_at).should == {"0"=>1,"10"=>2,"13"=>1}
+    end
+
+    it "collects from all days when at is not set" do
+      @line = DBGraph::Line.new(:hours)
+      @line.count(Product, :created_at).should == {"23"=>1,"0"=>2,"10"=>2,"13"=>1}
+    end
+  end
+
+  describe "days" do
+    before :all do
+      Product.delete_all
+      Product.create!(:created_at=>"2009-03-31 23:59:59")
+
+      Product.create!(:created_at=>"2009-04-01 00:00:00")
+      Product.create!(:created_at=>"2009-04-10 13:11:12")
+      Product.create!(:created_at=>"2009-04-30 23:59:59")
+      Product.create!(:created_at=>"2009-04-30 23:59:59")
+
+      Product.create!(:created_at=>"2009-05-01 00:00:00")
+    end
+
+    it "collects from one onth when at is set" do
+      @line = DBGraph::Line.new(:days, :at=>Time.parse('2009-04-02 14:15:16'))
+      @line.count(Product, :created_at).should == {"1"=>1,"10"=>1,"30"=>2}
+    end
+
+    it "collects from all years when at is not set" do
+      @line = DBGraph::Line.new(:days)
+      @line.count(Product, :created_at).should == {"1"=>2,"10"=>1,"30"=>2,"31"=>1}
+    end
+  end
+
+  describe "weeks" do
+    before :all do
+      Product.delete_all
+      Product.create!(:created_at=>"2008-12-31 23:59:59")
+
+      Product.create!(:created_at=>"2009-01-01 00:00:00")
+      Product.create!(:created_at=>"2009-05-31 13:11:12")
+      Product.create!(:created_at=>"2009-05-31 13:11:11")
+      Product.create!(:created_at=>"2009-12-31 23:59:59")
+
+      Product.create!(:created_at=>"2010-01-01 00:00:00")
+    end
+
+    it "collects from one year when at is set" do
+      @line = DBGraph::Line.new(:weeks, :at=>Time.parse('2009-01-02 14:15:16'))
+      @line.count(Product, :created_at).should == {"0"=>1,"22"=>2,"52"=>1}
+    end
+
+    it "collects from all years when at is not set" do
+      @line = DBGraph::Line.new(:weeks)
+      @line.count(Product, :created_at).should == {"0"=>2,"22"=>2,"52"=>2}
+    end
+  end
+
+  describe "months" do
+    before :all do
+      Product.delete_all
+      Product.create!(:created_at=>"2008-12-31 23:59:59")
+
+      Product.create!(:created_at=>"2009-01-01 00:00:00")
+      Product.create!(:created_at=>"2009-05-31 13:11:12")
+      Product.create!(:created_at=>"2009-05-31 13:11:11")
+      Product.create!(:created_at=>"2009-12-31 23:59:59")
+
+      Product.create!(:created_at=>"2010-01-01 00:00:00")
+    end
+
+    it "collects from one year when at is set" do
+      @line = DBGraph::Line.new(:months, :at=>Time.parse('2009-01-02 14:15:16'))
+      @line.count(Product, :created_at).should == {"1"=>1,"5"=>2,"12"=>1}
+    end
+
+    it "collects from all years when at is not set" do
+      @line = DBGraph::Line.new(:months)
+      @line.count(Product, :created_at).should == {"1"=>2,"5"=>2,"12"=>2}
+    end
+  end
+
+  describe :add do
+    it "accepts options for count" do
+      Product.delete_all
+      3.times{Product.create!}
+      2.times{Product.create!(:created_at=>'2009-02-02')}
+      3.times{Product.create!}
+
+      line = DBGraph::Line.new(:months)
+      line.add(Product, :created_at, :conditions=>"MONTH(created_at)=2")
+      line.data.values.first.should == {"2"=>2}
+    end
+
+    it "supports custom labels" do
+      line = DBGraph::Line.new(:months)
+      line.add(Product, :created_at, :label=>'ToC')
+      line.data['ToC'].should_not be_nil
+    end
+
+    it "adds the collected data to a hash" do
+      line = DBGraph::Line.new(:months)
+      line.add(Product, :created_at)
+      line.data['Product created_at'].should_not be_nil
+    end
+  end
+
+  describe :x_labels do
+    it "has minutes with gaps for readability" do
+      line = DBGraph::Line.new(:minutes)
+      gaps = [''] * 9
+      line.x_labels.should == [0,gaps,10,gaps,20,gaps,30,gaps,40,gaps,50,gaps].flatten
+    end
+
+    it "has all hours" do
+      line = DBGraph::Line.new(:hours)
+      line.x_labels.should == [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23]
+    end
+
+    it "has days with gaps for readability" do
+      line = DBGraph::Line.new(:days)
+      gaps = ['','','','']
+      line.x_labels.should == [gaps,5,gaps,10,gaps,15,gaps,20,gaps,25,gaps,30,''].flatten
+    end
+
+    it "has weeks with gaps for readability" do
+      line = DBGraph::Line.new(:weeks)
+      gaps = [''] * 9
+      line.x_labels.should == [0,gaps,10,gaps,20,gaps,30,gaps,40,gaps,50,'',''].flatten
+    end
+
+    it "has all months" do
+      line = DBGraph::Line.new(:months)
+      line.x_labels.should == [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
+    end
+  end
+
+  describe :y_labels do
+    it "has even values as y labels" do
+      Product.should_receive(:count).and_return({"0"=>1,"1"=>3,"2"=>3,"23"=>9})
+      line = DBGraph::Line.new(:hours)
+      line.add(Product, :created_at)
+      line.y_labels.should == [0,1,2,3,4,5,6,7,8,9]
+    end
+  end
+
+  describe :fill_up_values do
+    it "adds 0 for every non-filled value" do
+      data = [["1",2], ["3",3]]
+      expected_keys = [1,2,3,4,5]
+      filled = DBGraph::Line.send(:fill_up_values, data, expected_keys)
+      filled.should == [[1,2], [2,0], [3,3], [4,0], [5,0]]
+    end
+  end
+
+  describe :filled_and_sorted_values do
+    it "fills/sorts the values" do
+      data = {"1"=>2, "3"=>3, "10"=>4}
+      expected_keys = [1,2,3,4,5,6,7,8,9,10]
+      filled = DBGraph::Line.send(:filled_and_sorted_values, data, expected_keys)
+      filled.should == [2, 0, 3, 0, 0, 0, 0, 0, 0, 4]
+    end
+  end
+
+  describe :random_color do
+    before do
+      @line = DBGraph::Line.new(:months)
+    end
+
+    it "includes pairs of colors" do
+      @line.should_receive(:rand).and_return 0,2,10
+      @line.send(:random_color).should == '0022aa'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# ---- requirements
+require 'rubygems'
+$LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+require 'activerecord'
+require 'activesupport'
+load File.expand_path("test_model.rb", File.dirname(__FILE__))
+require 'db_graph/line'

data/spec/test_model.rb

@@ -0,0 +1,15 @@
+ActiveRecord::Base.establish_connection({
+  :adapter => "mysql",
+  :database => "db_graph_test",
+  :user => 'root',
+  :password => 'root'
+})
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :products, :force=>true do |t|
+    t.timestamps
+  end
+end
+
+class Product < ActiveRecord::Base
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: grosser-db_graph
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gchartrb
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION.yml
+- lib/db_graph/line.rb
+- spec/db_graph/line_spec.rb
+- spec/spec_helper.rb
+- spec/test_model.rb
+has_rdoc: true
+homepage: http://github.com/grosser/db_graph
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: AR generate beautiful graphs from date fields, in 1 LOC
+test_files: 
+- spec/spec_helper.rb
+- spec/db_graph/line_spec.rb
+- spec/test_model.rb