reportable 1.0.3 → 1.1.0

data/spec/db/schema.rb

@@ -9,12 +9,12 @@ ActiveRecord::Schema.define(:version => 1) do
   end
 
   create_table :reportable_cache, :force => true do |t|
-    t.string   :model_name,       :null => false
-    t.string   :report_name,      :null => false
-    t.string   :grouping,         :null => false
-    t.string   :aggregation,      :null => false
-    t.string   :conditions,       :null => false
-    t.float    :value,            :null => false, :default => 0
+    t.string   :model_name,       :null => false, :limit => 100
+    t.string   :report_name,      :null => false, :limit => 100
+    t.string   :grouping,         :null => false, :limit => 10
+    t.string   :aggregation,      :null => false, :limit => 10
+    t.string   :conditions,       :null => false, :limit => 100
+    t.float    :value,            :null => false,                :default => 0
     t.datetime :reporting_period, :null => false
 
     t.timestamps

data/spec/other/report_method_spec.rb

@@ -2,14 +2,33 @@ require File.join(File.dirname(__FILE__), '..', 'spec_helper')
 
 describe Saulabs::Reportable do
 
+  before(:all) do
+    User.create!(:login => 'test 1', :created_at => Time.now - 1.days,  :profile_visits => 1)
+    User.create!(:login => 'test 2', :created_at => Time.now - 2.days, :profile_visits => 2)
+  end
+
+  it 'should return a Saulabs::Reportable::ResultSet' do
+    User.registrations_report.should be_instance_of(Saulabs::Reportable::ResultSet)
+  end
+
+  it 'should return a result set that stores the name of the model the report was invoked on' do
+    User.registrations_report.model_name.should == User.name
+  end
+
+  it 'should return a result set that stores the name of the report that was invoked' do
+    User.registrations_report.report_name.should == 'registrations'
+  end
+
   describe 'for inherited models' do
 
     before(:all) do
-      User.create!(:login => 'test 1', :created_at => Time.now - 1.days,  :profile_visits => 1)
-      User.create!(:login => 'test 2', :created_at => Time.now - 2.days, :profile_visits => 2)
       SpecialUser.create!(:login => 'test 3', :created_at => Time.now - 2.days, :profile_visits => 3)
     end
 
+    it 'should return a result set that stores the model the report was invoked on' do
+      SpecialUser.registrations_report.model_name.should == SpecialUser.name
+    end
+
     it 'should include all data when invoked on the base model class' do
       result = User.registrations_report.to_a
 
@@ -25,7 +44,6 @@ describe Saulabs::Reportable do
     end
 
     after(:all) do
-      User.destroy_all
       SpecialUser.destroy_all
     end
 
@@ -35,10 +53,16 @@ describe Saulabs::Reportable do
     Saulabs::Reportable::ReportCache.destroy_all
   end
 
+  after(:all) do
+    User.destroy_all
+  end
+
 end
 
 class User < ActiveRecord::Base
+
   reportable :registrations, :limit => 10
+
 end
 
 class SpecialUser < User; end

data/spec/other/report_tag_helper_spec.rb

@@ -0,0 +1,118 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Saulabs::Reportable::ReportTagHelper do
+
+  before do
+    @helper = TestHelper.new
+  end
+
+  describe '#raphael_report_tag' do
+
+    data_set = Saulabs::Reportable::ResultSet.new([[DateTime.now, 1.0], [DateTime.now - 1.day, 3.0]], "User", "registrations")
+
+    it 'should return a string' do
+      @helper.raphael_report_tag(data_set).class.should == String
+    end
+
+    it 'should contain a div tag' do
+      @helper.raphael_report_tag(data_set).should =~ /^<div id=".*">.*<\/div>/
+    end
+
+    it 'should contain a script tag' do
+      @helper.raphael_report_tag(data_set).should =~ /<script type="text\/javascript" charset="utf-8">.*<\/script>/m
+    end
+
+    it 'should assign a default dom id to the the div tag if none is specified' do
+      @helper.raphael_report_tag(data_set).should =~ /^<div id="#{data_set.model_name.downcase}_#{data_set.report_name}".*<\/div>/
+    end
+
+    it 'should assign correct default dom ids to the the div tag if none is specified and there are more than one report tags on the page' do
+      @helper.raphael_report_tag(data_set).should =~ /^<div id="#{data_set.model_name.downcase}_#{data_set.report_name}".*<\/div>/
+      @helper.raphael_report_tag(data_set).should =~ /^<div id="#{data_set.model_name.downcase}_#{data_set.report_name}1".*<\/div>/
+    end
+
+  end
+  
+    describe '#flot_report_tag' do
+
+    data_set = Saulabs::Reportable::ResultSet.new([[DateTime.now, 1.0], [DateTime.now - 1.day, 3.0]], "User", "registrations")
+
+    it 'should return a string' do
+      @helper.flot_report_tag(data_set).class.should == String
+    end
+
+    it 'should contain a div tag' do
+      @helper.flot_report_tag(data_set).should =~ /^<div id=".*">.*<\/div>/
+    end
+
+    it 'should contain a script tag' do
+      @helper.flot_report_tag(data_set).should =~ /<script type="text\/javascript" charset="utf-8">.*<\/script>/m
+    end
+
+    it 'should assign a default dom id to the the div tag if none is specified' do
+      @helper.flot_report_tag(data_set).should =~ /^<div id="#{data_set.model_name.downcase}_#{data_set.report_name}".*<\/div>/
+    end
+
+    it 'should assign correct default dom ids to the the div tag if none is specified and there are more than one report tags on the page' do
+      @helper.flot_report_tag(data_set).should =~ /^<div id="#{data_set.model_name.downcase}_#{data_set.report_name}".*<\/div>/
+      @helper.flot_report_tag(data_set).should =~ /^<div id="#{data_set.model_name.downcase}_#{data_set.report_name}1".*<\/div>/
+    end
+
+  end
+
+  describe '#google_report_tag' do
+
+    it 'should render an image with the correct source' do
+      @helper.should_receive(:image_tag).once.with(
+        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=0077cc&chm=B,e6f2fa,0,0,0&chls=1,0,0&chds=1.0,3.0',
+        { :title => nil, :alt => nil }
+      )
+
+      @helper.google_report_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]])
+    end
+
+    it 'should add parameters for labels to the source of the image if rendering of lables is specified' do
+      @helper.should_receive(:image_tag).once.with(
+        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=0077cc&chm=B,e6f2fa,0,0,0&chls=1,0,0&chds=1.0,3.0&chxt=x,y,r,t&chxr=0,0,3|1,0,3.0|2,0,3.0|3,0,3',
+        { :title => nil, :alt => nil }
+      )
+
+      @helper.google_report_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]], :labels => [:x, :y, :r, :t])
+    end
+
+    it 'should set the parameters for custom colors if custom colors are specified' do
+      @helper.should_receive(:image_tag).once.with(
+        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=000000&chm=B,ffffff,0,0,0&chls=1,0,0&chds=1.0,3.0',
+        { :title => nil, :alt => nil }
+      )
+
+      @helper.google_report_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]], :line_color => '000000', :fill_color => 'ffffff')
+    end
+
+    it 'should set the parameters for a custom title if a title specified' do
+      @helper.should_receive(:image_tag).once.with(
+        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=0077cc&chm=B,e6f2fa,0,0,0&chls=1,0,0&chds=1.0,3.0&chtt=title',
+        { :title => 'title', :alt => nil }
+      )
+
+      @helper.google_report_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]], :title => 'title')
+    end
+
+    it 'should use a specified alt text as alt text for the image' do
+      @helper.should_receive(:image_tag).once.with(
+        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=0077cc&chm=B,e6f2fa,0,0,0&chls=1,0,0&chds=1.0,3.0',
+        { :title => nil, :alt => 'alt' }
+      )
+
+      @helper.google_report_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]], :alt => 'alt')
+    end
+
+  end
+
+end
+
+class TestHelper
+
+  include Saulabs::Reportable::ReportTagHelper
+
+end

data/spec/spec_helper.rb

@@ -1,14 +1,10 @@
-$:.reject! { |e| e.include? 'TextMate' }
-
 ENV['RAILS_ENV'] = 'test'
 
 require 'rubygems'
-require 'spec'
-require 'test/unit'
-require 'active_support'
-require 'initializer'
+require 'bundler'
+Bundler.setup
 
-require File.join(File.dirname(__FILE__), 'boot') unless defined?(ActiveRecord)
+require File.join(File.dirname(__FILE__), 'boot')
 
 class User < ActiveRecord::Base; end
 

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: reportable
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Marco Otte-Witte
@@ -10,30 +16,42 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-11 00:00:00 +01:00
+date: 2010-05-26 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
         version: 2.0.0
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
         version: 2.0.0
-    version: 
-description: Reportable allows for easy report generation from ActiveRecord and DataMapper models by the addition of the reportable method.
+  type: :runtime
+  version_requirements: *id002
+description: Reportable allows for easy report generation from ActiveRecord models by the addition of the reportable method.
 email: reportable@saulabs.com
 executables: []
 
@@ -46,14 +64,26 @@ files:
 - HISTORY.md
 - Rakefile
 - MIT-LICENSE
+- generators/reportable_jquery_flot_assets/reportable_jquery_flot_assets_generator.rb
+- generators/reportable_jquery_flot_assets/templates/NOTES
+- generators/reportable_jquery_flot_assets/templates/excanvas.min.js
+- generators/reportable_jquery_flot_assets/templates/jquery.flot.min.js
 - generators/reportable_migration/reportable_migration_generator.rb
-- generators/reportable_migration/templates/migration.erb
+- generators/reportable_migration/templates/migration.rb
+- generators/reportable_raphael_assets/reportable_raphael_assets_generator.rb
+- generators/reportable_raphael_assets/templates/NOTES
+- generators/reportable_raphael_assets/templates/g.line.min.js
+- generators/reportable_raphael_assets/templates/g.raphael.min.js
+- generators/reportable_raphael_assets/templates/raphael.min.js
+- lib/saulabs/reportable/config.rb
 - lib/saulabs/reportable/cumulated_report.rb
 - lib/saulabs/reportable/grouping.rb
+- lib/saulabs/reportable/railtie.rb
 - lib/saulabs/reportable/report.rb
 - lib/saulabs/reportable/report_cache.rb
+- lib/saulabs/reportable/report_tag_helper.rb
 - lib/saulabs/reportable/reporting_period.rb
-- lib/saulabs/reportable/sparkline_tag_helper.rb
+- lib/saulabs/reportable/result_set.rb
 - lib/saulabs/reportable.rb
 - rails/init.rb
 - spec/boot.rb
@@ -64,11 +94,11 @@ files:
 - spec/classes/reporting_period_spec.rb
 - spec/db/schema.rb
 - spec/other/report_method_spec.rb
-- spec/other/sparkline_tag_helper_spec.rb
+- spec/other/report_tag_helper_spec.rb
 - spec/spec_helper.rb
 - spec/db/database.yml
 - spec/spec.opts
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/saulabs/reportable
 licenses: []
 
@@ -78,21 +108,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 2
 summary: Easy report generation for Ruby on Rails

data/lib/saulabs/reportable/sparkline_tag_helper.rb

@@ -1,62 +0,0 @@
-module Saulabs
-
-  module Reportable
-
-    module SparklineTagHelper
-
-      # Renders a sparkline with the given data.
-      #
-      # @param [Array<Array<DateTime, Float>>] data
-      #   an array of report data as returned by {Saulabs::Reportable::Report#run}
-      # @param [Hash] options
-      #   options for the sparkline
-      #
-      # @option options [Fixnum] :width (300)
-      #   the width of the generated image
-      # @option options [Fixnum] :height (34)
-      #   the height of the generated image
-      # @option options [String] :line_color ('0077cc')
-      #   the line color of the generated image
-      # @option options [String] :fill_color ('e6f2fa')
-      #   the fill color of the generated image
-      # @option options [Array<Symbol>] :labels ([])
-      #   the axes to render lables for (Array of +:x+, +:y+, +:r+, +:t+; this is x axis, y axis, right, top)
-      # @option options [String] :alt ('')
-      #   the alt attribute for the generated image
-      # @option options [String] :title ('')
-      #   the title attribute for the generated image
-      #
-      # @return [String]
-      #   an image tag showing a sparkline for the passed +data+
-      #
-      # @example Rendering a sparkline tag for report data
-      #
-      #   <%= sparkline_tag(User.registrations_report, :width => 200, :height => 100, :color => '000') %>
-      #
-      def sparkline_tag(data, options = {})
-        options.reverse_merge!({ :width => 300, :height => 34, :line_color => '0077cc', :fill_color => 'e6f2fa', :labels => [], :alt => '', :title => '' })
-        data = data.collect { |d| d[1] }
-        labels = ''
-        unless options[:labels].empty?
-          chxr = {}
-          options[:labels].each_with_index do |l, i|
-            chxr[l] = "#{i}," + ([:x, :t].include?(l) ? "0,#{data.length}" : "#{[data.min, 0].min},#{data.max}")
-          end
-          labels = "&chxt=#{options[:labels].map(&:to_s).join(',')}&chxr=#{options[:labels].collect{|l| chxr[l]}.join('|')}"
-        end
-        title = ''
-        unless options[:title].empty?
-          title = "&chtt=#{options[:title]}"
-        end
-        image_tag(
-          "http://chart.apis.google.com/chart?cht=ls&chs=#{options[:width]}x#{options[:height]}&chd=t:#{data.join(',')}&chco=#{options[:line_color]}&chm=B,#{options[:fill_color]},0,0,0&chls=1,0,0&chds=#{data.min},#{data.max}#{labels}#{title}",
-          :alt   => options[:alt],
-          :title => options[:title]
-        )
-      end
-
-    end
-
-  end
-
-end

data/spec/other/sparkline_tag_helper_spec.rb

@@ -1,64 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'spec_helper')
-
-describe Saulabs::Reportable::SparklineTagHelper do
-
-  before do
-    @helper = TestHelper.new
-  end
-
-  describe '#sparkline_tag' do
-
-    it 'should render an image with the correct source' do
-      @helper.should_receive(:image_tag).once.with(
-        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=0077cc&chm=B,e6f2fa,0,0,0&chls=1,0,0&chds=1.0,3.0',
-        { :title => '', :alt => '' }
-      )
-
-      @helper.sparkline_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]])
-    end
-
-    it 'should add parameters for labels to the source of the image if rendering of lables is specified' do
-      @helper.should_receive(:image_tag).once.with(
-        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=0077cc&chm=B,e6f2fa,0,0,0&chls=1,0,0&chds=1.0,3.0&chxt=x,y,r,t&chxr=0,0,3|1,0,3.0|2,0,3.0|3,0,3',
-        { :title => '', :alt => '' }
-      )
-
-      @helper.sparkline_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]], :labels => [:x, :y, :r, :t])
-    end
-
-    it 'should set the parameters for custom colors if custom colors are specified' do
-      @helper.should_receive(:image_tag).once.with(
-        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=000000&chm=B,ffffff,0,0,0&chls=1,0,0&chds=1.0,3.0',
-        { :title => '', :alt => '' }
-      )
-
-      @helper.sparkline_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]], :line_color => '000000', :fill_color => 'ffffff')
-    end
-
-    it 'should set the parameters for a custom title if a title specified' do
-      @helper.should_receive(:image_tag).once.with(
-        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=0077cc&chm=B,e6f2fa,0,0,0&chls=1,0,0&chds=1.0,3.0&chtt=title',
-        { :title => 'title', :alt => '' }
-      )
-
-      @helper.sparkline_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]], :title => 'title')
-    end
-
-    it 'should use a specified alt text as alt text for the image' do
-      @helper.should_receive(:image_tag).once.with(
-        'http://chart.apis.google.com/chart?cht=ls&chs=300x34&chd=t:1.0,2.0,3.0&chco=0077cc&chm=B,e6f2fa,0,0,0&chls=1,0,0&chds=1.0,3.0',
-        { :title => '', :alt => 'alt' }
-      )
-
-      @helper.sparkline_tag([[DateTime.now, 1.0], [DateTime.now, 2.0], [DateTime.now, 3.0]], :alt => 'alt')
-    end
-
-  end
-
-end
-
-class TestHelper
-
-  include Saulabs::Reportable::SparklineTagHelper
-
-end