active_graph 0.0.2

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-12-21
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/active_graph.rb
+lib/active_graph/active_record_extension.rb
+script/console
+script/destroy
+script/generate
+spec/active_graph_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake
+rails/init.rb
+init.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on active_graph, see http://active_graph.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,130 @@
+= active_graph
+
+http://github.com/kazjote/active_graph/tree/master
+
+== DESCRIPTION:
+
+Gem which makes filling data for Gruff graphs based on ActiveRecord objects much easier.
+
+== FEATURES/PROBLEMS:
+
+Good points:
+* Ease of use
+* Flexible
+* Created in model but enable to customize presentation in controller
+
+Bad points:
+* Slow - requires many database calls (it is intended to create cacheable graphs)
+* Do not allow to customize options after model is loaded (TODO)
+
+== SYNOPSIS:
+
+The simplies case (mosts are defaults - you probably won't use it):
+
+
+  class User < ActiveRecord::Base
+    active_graph :posts,
+        :series => {:submited_posts => {:value => :count_have_posts_between, :caption => "posts"}}
+      
+    def self.count_have_posts_between(min, max)
+      count(:all, :conditions => "posts_count > #{min} AND posts_count <= #{max}")
+    end
+  end
+
+Now, featured one. It will create a line graph, which
+ * starts at User.start_time,
+ * end one week later
+ * shows data with 1 day step
+ * defines x_axis with formated labels
+ * presents 2 data series
+
+
+  class User < ActiveRecord::Base
+  
+    active_graph :new_posts,
+      :type => :line,
+      :start => Proc.new {@@start_time}, :end => Proc.new { @@start_time + 1.week },
+      :step => 1.day,
+      :x_axis => {:interval => 3, :method => Proc.new {|time| time.strftime("%d-%m") }},
+      :width => 100,
+      :series => {:submited_posts => {:value => :count_have_posts_between, :caption => "posts"},
+        :submited_posts2 => {:value => :count_have_posts2_between, :caption => "posts2"}}
+      
+    def self.count_have_posts_between(min, max); end
+    def self.count_have_posts2_between(min, max); end
+    
+  end
+  
+Statistic on user age?
+
+  active_graph :age, :type => :bar,
+    :start => 0, :end => 100, :step => 10,
+    :x_axis => {:interval => 1, :method => Proc.new {|age| "#{age}-#{age + 10}" }},
+    :series => {
+      :age => {:value => :count_aged_between, :caption => "Age" }
+    }
+
+Now, create an action in your controller:
+
+  class UsersController < ApplicationController
+    def new_posts_graph
+      graph = User.new_posts_graph
+      send_data graph.to_blob, :type => "image/png", :disposition => "inline",
+        :filename => "new_users_graph.png"
+    end
+  end
+
+graph is a normal Gruff object, so you can customize presentation before rendering.
+
+== REQUIREMENTS:
+
+* gem 'activesupport' >= 2.0.2
+* gem 'metaid' >= 1.0
+* gem 'gruff' >= 0.3.1
+
+It can run without Rails (testcase does not use rails at all).
+
+== INSTALL:
+
+* sudo gem install active_graph
+
+In your envrionment.rb:
+  
+  config.gem "metaid"
+  config.gem "gruff"
+  config.gem "active_graph"
+  
+If you have older rails you can load it with initializer or directly in your model:
+  
+  require 'gruff'
+  require 'active_graph'
+  
+  class User < ActiveRecord::Base
+    extend ActiveGraph::ActiveRecordExtension
+    ...
+  end
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIXME full name
+
+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,29 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/active_graph'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('active_graph', ActiveGraph::VERSION) do |p|
+  p.developer('Kacper Bielecki', 'kazjote@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = 'activegraph'
+  p.extra_deps         = [
+    ['activesupport','>= 2.0.2'],
+    ['metaid', '>= 1.0'],
+    ['gruff', '>= 0.3.1']
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/init.rb

@@ -0,0 +1,3 @@
+require "active_graph"
+
+ActiveRecord::Base.send(:extend, ActiveGraph::ActiveRecordExtension)

data/lib/active_graph/active_record_extension.rb

@@ -0,0 +1,78 @@
+require 'rubygems'
+require 'metaid'
+
+module ActiveGraph
+  module Support # :nodoc:
+    def self.valualize(value_or_proc)
+      value_or_proc.is_a?(Proc) ? value_or_proc.call : value_or_proc
+    end
+  end
+  
+  module ActiveRecordExtension
+    # See README for examples and ActiveGraph for defaults.
+    #
+    # Available options are:
+    # * :start - proc or value - first value taken into consideration while creating a graph
+    # * :end - proc or value - last value
+    # * :step - x-axis step
+    # * :type - type of the graph (for example :line, :bar, see gruff documentation for other)
+    # * :width - target width of the image
+    # * :x_axis - options for x_axis
+    # * :series - data series
+    #
+    # x_axis is a hash with following keys allowed:
+    # * :interval - number of steps between two value labels
+    # * :method - proc which creates the label for particular x point
+    #
+    # series is a hash, which keys are the symbols of data series and value is a hash with following keys:
+    # * :value - symbol of the two argument method which gathers data for the graph
+    # * :caption - caption
+    def active_graph(name, options)
+      graph_start = options[:start] || ActiveGraph::DEFAULT_START
+      graph_end = options[:end] || ActiveGraph::DEFAULT_END
+      graph_type = options[:type] || ActiveGraph::DEFAULT_TYPE
+      width = options[:width] || ActiveGraph::DEFAULT_WIDTH
+      step = options[:step] || ActiveGraph::DEFAULT_STEP
+      x_axis_interval = (options[:x_axis] && options[:x_axis][:interval]) ||
+        ActiveGraph::DEFAULT_X_AXIS_INTERVAL
+      x_axis_method = (options[:x_axis] && options[:x_axis][:method]) ||
+        ActiveGraph::DEFAULT_X_AXIS_METHOD
+      series = options[:series]
+      raise "You must provide at least one data serie" unless series.is_a?(Hash)
+      
+      graph_class = begin
+        "Gruff::#{graph_type.to_s.camelize}".constantize
+      rescue NameError
+        raise "No such graph type '#{graph_type}'"
+      end
+      
+      meta_def("#{name}_graph") do
+        local_graph_start = Support.valualize(graph_start)
+        local_graph_end = Support.valualize(graph_end)
+        periods_count = ((local_graph_end - local_graph_start) / step).ceil
+        g = graph_class.new(width)
+        
+        series.each_pair do |serie_name, serie_options|
+          data_method = serie_options[:value]
+          caption = serie_options[:caption]
+          
+          data = Array.new(periods_count) do |i|
+            period_start = local_graph_start + i * step
+            period_end = period_start + step
+            send(data_method, period_start, period_end)
+          end
+          g.data(caption, data)
+        end
+        
+        labels = Array.new((periods_count / x_axis_interval.to_f).ceil) do |i|
+          period_start = local_graph_start + i * x_axis_interval * step
+          label = x_axis_method.is_a?(Proc) ?
+            x_axis_method.call(period_start) : self.send(x_axis_method, period_start)
+          [i * x_axis_interval, label]
+        end.flatten
+        g.labels = Hash[*labels]
+        g
+      end
+    end
+  end
+end

data/lib/active_graph.rb

@@ -0,0 +1,18 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'active_graph/active_record_extension'
+require 'rubygems'
+require 'activesupport'
+
+module ActiveGraph
+  VERSION = '0.0.2'
+  
+  DEFAULT_START = 0
+  DEFAULT_END = 7
+  DEFAULT_TYPE = :bar
+  DEFAULT_STEP = 1
+  DEFAULT_X_AXIS_INTERVAL = 1
+  DEFAULT_X_AXIS_METHOD = Proc.new {|x| "#{x} - #{x + ActiveGraph::DEFAULT_X_AXIS_INTERVAL}"}
+  DEFAULT_WIDTH=400
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+require "active_graph"
+
+ActiveRecord::Base.send(:extend, ActiveGraph::ActiveRecordExtension)

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/active_graph.rb'}"
+puts "Loading active_graph gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/active_graph_spec.rb

@@ -0,0 +1,148 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+module Gruff # :nodoc:all
+  module BasicMethods
+    attr_accessor :labels
+    attr_accessor :width
+    
+    def data(label, data); end
+    
+    def initialize(width)
+      @width = width
+    end
+  end
+  
+  class Bar
+    include BasicMethods
+  end
+  
+  class Line
+    include BasicMethods
+  end
+end
+
+class ActiveGraphTestModel # :nodoc:
+  extend ActiveGraph::ActiveRecordExtension
+  
+  attr_accessor :start_time
+  
+  active_graph :posts,
+    :series => {:submited_posts => {:value => :count_have_posts_between, :caption => "posts"}}
+    
+  active_graph :new_posts,
+    :type => :line,
+    :start => Proc.new {@@start_time}, :end => Proc.new { @@start_time + 1.week },
+    :step => 1.day,
+    :x_axis => {:interval => 3, :method => Proc.new {|time| time.strftime("%d-%m") }},
+    :width => 100,
+    :series => {:submited_posts => {:value => :count_have_posts_between, :caption => "posts"},
+      :submited_posts2 => {:value => :count_have_posts2_between, :caption => "posts2"}}
+    
+  def self.count_have_posts_between(min, max); end
+  def self.count_have_posts2_between(min, max); end
+end
+
+describe "ActiveGraph" do
+  it "should define method for creating the graph" do
+    ActiveGraphTestModel.respond_to?(:posts_graph).should be_true
+  end
+  
+  describe "while based on defaults" do
+    before do
+      @graph = Gruff::Bar.new(400)
+      Gruff::Bar.should_receive(:new).with(400).and_return(@graph)
+      default_start = ActiveGraph::DEFAULT_START
+      default_end = ActiveGraph::DEFAULT_END
+      @number_of_periods = default_end - default_start
+    end
+    
+    it "should gather data from default number of periods" do
+      @number_of_periods.times do |i|
+        ActiveGraphTestModel.should_receive(:count_have_posts_between).
+          with(i, i+1)
+      end
+      ActiveGraphTestModel.posts_graph
+    end
+    
+    it "should set correct labels" do
+      labels = Hash[*Array.new(@number_of_periods) {|i| [i, "#{i} - #{i+1}"]}.flatten]
+      ActiveGraphTestModel.posts_graph
+      @graph.labels.should == labels
+    end
+    
+    it "should set data properly" do
+      @number_of_periods.times do |i|
+        ActiveGraphTestModel.should_receive(:count_have_posts_between).
+          with(i, i+1).and_return(i)
+      end
+      data = Array.new(@number_of_periods) {|i| i}
+      @graph.should_receive(:data).with("posts", data)
+      ActiveGraphTestModel.posts_graph
+    end
+    
+    it "should create the graph" do
+      ActiveGraphTestModel.posts_graph.should == @graph
+    end
+    
+    it "should set default width" do
+      ActiveGraphTestModel.posts_graph.width.should == 400
+    end
+  end
+  
+  describe "while used with all custom parameters" do
+    before do
+      @start_time = Time.now - 1.month
+      ActiveGraphTestModel.send(:class_variable_set, :@@start_time, @start_time)
+    end
+    
+    it "should raise error on unknown graph type" do
+      lambda do
+        ActiveGraphTestModel.active_graph :wrong_type,
+          :type => :unknown,
+          :series => {:submited_posts => {:value => :count_have_posts_between,
+            :caption => "posts"}}
+      end.should raise_error
+    end
+    
+    it "should be possible to specify start and end options with proc and step with value" do
+      7.times do |i|
+        ActiveGraphTestModel.should_receive(:count_have_posts_between).
+          with(@start_time + i.days, @start_time + (i + 1).days)
+      end
+      ActiveGraphTestModel.new_posts_graph
+    end
+    
+    it "should set correct width" do
+      ActiveGraphTestModel.new_posts_graph.width.should == 100
+    end
+    
+    describe "and drawing the graph" do
+      before do
+        @graph = Gruff::Line.new(400)
+        Gruff::Line.should_receive(:new).and_return(@graph)
+      end
+      
+      it "should be possible to specify graph type" do
+        ActiveGraphTestModel.new_posts_graph.class.should == Gruff::Line
+      end
+      
+      it "should be possible to specify many series" do
+        @graph.should_receive(:data).with("posts", an_instance_of(Array))
+        @graph.should_receive(:data).with("posts2", an_instance_of(Array))
+        ActiveGraphTestModel.new_posts_graph
+      end
+      
+      it "should be possible to set x_axis interval" do
+        ActiveGraphTestModel.new_posts_graph
+        @graph.labels.keys.sort.should == [0, 3, 6]
+      end
+      
+      it "should be possible to specify x_axis labeling method" do
+        ActiveGraphTestModel.new_posts_graph
+        @graph.labels.should == {0 => @start_time.strftime("%d-%m"),
+          3 => (@start_time + 3.days).strftime("%d-%m"),
+          6 => (@start_time + 6.days).strftime("%d-%m")}
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'active_graph'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: active_graph
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Kacper Bielecki
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-02 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: metaid
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gruff
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: Gem which makes filling data for Gruff graphs based on ActiveRecord objects much easier.
+email: 
+- kazjote@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/active_graph.rb
+- lib/active_graph/active_record_extension.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/active_graph_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+- rails/init.rb
+- init.rb
+has_rdoc: true
+homepage: http://github.com/kazjote/active_graph/tree/master
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: activegraph
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Gem which makes filling data for Gruff graphs based on ActiveRecord objects much easier.
+test_files: []
+