ruport_report_builder 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 MileMeter, Inc.
+
+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.rdoc

@@ -0,0 +1,17 @@
+= MileMeter, Inc.
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 MileMeter, Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ruport_report_builder"
+    gem.summary = %Q{Simple wrapper for common ruport tasks}
+    gem.description = %Q{Simple wrapper for common ruport tasks}
+    gem.email = "code@milemeter.com"
+    gem.homepage = "http://github.com/milemeter/ruport_report_builder"
+    gem.authors = ["Doug Bryant", "John Riney"]
+    gem.add_dependency('ruport', '>= 1.4.0')
+    gem.add_dependency('activerecord', '>= 2.0.0')
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency 'sqlite3-ruby' 
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Ruport Report Builder #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/ordered_hash.rb

@@ -0,0 +1,43 @@
+# Maintains a hash in specified order when retrieving keys/values
+module RuportReportBuilderUtil
+  class OrderedHash < Hash
+    def initialize
+      @keys = []
+    end
+
+    def []=(key, val)
+      @keys << key
+      super
+    end
+  
+    def keys
+      @keys
+    end
+  
+    def values
+      result = []
+      each_value{|v| result << v}
+      result
+    end
+
+    def delete(key)
+      @keys.delete(key)
+      super
+    end
+
+    def each
+      @keys.each { |k| yield k, self[k] }
+    end
+
+    def each_key
+      @keys.each { |k| yield k }
+    end
+
+    def each_value
+      @keys.each { |k| yield self[k] }
+    end
+  
+    alias_method :store, :[]=
+    alias_method :each_pair, :each
+  end
+end

data/lib/ruport_report_builder.rb

@@ -0,0 +1,151 @@
+#
+# NOTES: When defining reports with define_report method, place the query methods *above* the report definition
+#          otherwise the report query will not be in scope
+#
+#
+#  Look at the test to figure out more details about how to use
+#  This is the jist of it
+#
+# class FooReport
+#   include RuportReportBuilder
+#
+#   # Define a sort method iff you want it sorted.  should return a hash similar to below.  default order is ASC. :order is optional
+#   def sort
+#     {:columns => "quote_number", :order => :descending}
+#   end
+#
+#   Define a query in two ways.  First is with a properly named method.
+#   The method should be the same as the report name with _query appended at the end.
+#   Queries can return an array of objects such as [Foo.new, Foo.new, Foo.new]
+#   or include a sql statement such as select * from foo
+#
+#   def foo_query
+#     .....
+#   end
+#
+#   # Define a report.  This should be done *below* the query definition if applicable because of scoping issues
+#   # What ever type of objects are returned from the "query" method
+#   define_report("foo") do |row, foo|
+#     row.store "Name", foo.name # typical usage for objects returned from query
+#     row.store "My Age", foo["age"] # typical usage for if query was sql
+#   end
+# end
+#
+# Typical usage
+#
+# foo_report = Foo.new
+# rpt = foo.build_report
+# rpt.{as_text|as_html|as_pdf|as_excel}
+#
+
+require 'rubygems'
+gem 'activerecord'
+require 'active_record'
+gem 'ruport'
+require 'ruport'
+require 'ordered_hash'
+
+module RuportReportBuilder
+
+  def self.included(base)
+    base.extend ClassMethods
+    base.send :include, InstanceMethods
+  end
+
+  module ClassMethods
+    def reports
+      @reports ||= RuportReportBuilderUtil::OrderedHash.new
+    end
+
+    def report_names
+      reports.keys
+    end
+
+    def define_report(name, query = nil, &proc)
+      raise ArgumentError, "The report name [name] is incorrect.  Report names must not contain a space!" if name.to_s.empty? || name.to_s.include?(" ")
+      raise ArgumentError, "You must provide a query or properly name it as a method. Looking for #{query_method_name(name)}. !!If using a query method, make sure it is defined *above* the report definition!!" if query.nil? && !self.instance_methods.include?(query_method_name(name))
+      reports[name] = {:query => query, :action => proc}
+    end
+
+    def report(name)
+      reports[name]
+    end
+
+    def query_method_name(name)
+      "#{name.gsub(/\s/, "_")}_query"
+    end
+  end
+
+  module InstanceMethods
+
+    #
+    # Returns a Ruport table object you can then call methods on
+    #
+    def build_report
+      main_report, *appended_reports = self.class.report_names
+
+      table_data = generate_report_data(main_report)
+
+      return Ruport::Data::Table.new if table_data.empty?
+
+      # build the table and set the column names based on the data from the "Primary" report
+      table = Ruport::Data::Table.new(:column_names => table_data.first.keys, :data => table_data.map{|d| d.values})
+
+
+      appended_reports.each do |rpt|
+        addl_rpt_data = generate_report_data(rpt)
+        addl_rpt_data.each{|row| table << row}
+      end
+      do_sort(table)
+    end
+    alias :build :build_report
+
+    protected
+
+    def generate_report_data(rpt)
+      if data = execute_query_for(rpt)
+        action = self.class.report(rpt)[:action]
+        return data.map do |d|
+          hash = RuportReportBuilderUtil::OrderedHash.new
+          action.call(hash, d)
+          hash
+        end
+      else
+        nil
+      end
+    end
+
+    def do_sort(table)
+      if self.respond_to?(:sort)
+        sort_by = self.sort
+        if sort_by.kind_of?(Hash)
+          table = table.sort_rows_by(sort_by[:columns], :order => sort_by[:order])
+        else
+          raise ArgumentError, "Sorting must return a hash!"
+        end
+      else
+        table
+      end
+    end
+
+    def execute_query_for(report)
+      rpt = self.class.report(report)
+      if rpt[:query].nil?
+        query = self.send self.class.query_method_name(report).to_sym
+      else
+        query = rpt[:query]
+      end
+
+      if query.kind_of?(Array)
+        result = query
+      else
+        result = ActiveRecord::Base.connection.execute query
+      end
+
+      result
+    end
+
+  end
+
+end
+

data/spec/ruport_report_builder_spec.rb

@@ -0,0 +1,175 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+## 
+# Support classes which will be under/used as test data
+#
+
+class Order < ActiveRecord::Base
+end
+
+class AskMe
+  def method_missing(symbol, *args)
+    "#{symbol.id2name}_answer"
+  end
+end
+
+class ReportBuilderUnderForMod
+  include RuportReportBuilder
+end
+
+class ReportBuilderUnderTestSql
+  include RuportReportBuilder
+
+  def rspec_sql_query
+    "select * from orders where status = 'paid' order by order_number ASC ;"
+  end
+
+  def sort
+    {:columns => "order_number", :order => :descending}
+  end
+
+  def rspec_object_query
+    (1..5).to_a.map{|x| AskMe.new}
+  end
+
+  define_report "rspec_sql" do |report, obj|
+    report.store "First Name", obj["first_name"]
+    report.store "Last Name", obj["last_name"]
+    report.store "Order Number", obj["order_number"]
+    report.store "Payment Status", obj["status"]
+  end
+
+end
+
+class ReportBuilderUnderTestNoSql
+  include RuportReportBuilder
+
+  def rspec_object_query
+    (1..5).to_a.map{|x| AskMe.new}
+  end
+
+  define_report "rspec_object" do |report, obj|
+    report.store "Status", obj.status
+    report.store "Miles Purchased", obj.miles_purchased
+    report.store "Term In Months", obj.term_in_months
+  end
+end
+
+############
+# Let the testing begin!
+#
+
+describe "ReportBuilder" do
+
+  it "should raise an ArgumentError if you try to define a report without a query and no default method" do
+    lambda {
+      ReportBuilderUnderForMod.instance_eval %Q{
+          define_report "fail" do |report, o|
+            report.store "FOOBAR", o.name
+          end
+      }
+    }.should raise_error(ArgumentError)
+  end
+
+  it "should raise an ArgumentError if the report name has a space in it" do
+    lambda {
+      ReportBuilderUnderForMod.instance_eval %Q{
+          define_report "gonna fail", "select * from temp" do |report, o|
+            report.store "FOOBAR", o.name
+          end
+      }
+    }.should raise_error(ArgumentError)
+  end
+
+  it "should not try to raise an error if you give it a query manually rather than defined as a method" do
+    lambda {
+      ReportBuilderUnderForMod.instance_eval %Q{
+          define_report "noFail", "select * from temp" do |report, o|
+            map "FOOBAR", o.name
+          end
+      }
+    }.should_not raise_error(ArgumentError)
+  end
+
+  it "should add a report to the list when it defines a report" do
+    ReportBuilderUnderTestNoSql.report("rspec_object").should_not be_nil
+  end
+
+  it "should be able to return a list of report names" do
+    ReportBuilderUnderTestNoSql.report_names.should == ["rspec_object"]
+  end
+
+  it "should be able to return a specific report" do
+    ReportBuilderUnderTestNoSql.report("rspec_object").should_not be_nil
+  end
+
+  it "should respond to the alias of build (alias of build_report)" do
+    ReportBuilderUnderTestNoSql.new.should respond_to(:build)
+  end
+
+
+  describe "Report using Objects" do
+    before(:each) do
+      @report = ReportBuilderUnderTestNoSql.new
+    end
+
+    it "should be able to generate a report with the query returning the data" do
+      result = @report.build_report
+      result.size.should == 5
+      4.times {|row|
+        result[row][0].should == "status_answer"
+        result[row][1].should == "miles_purchased_answer"
+        result[row][2].should == "term_in_months_answer"
+      }
+    end
+  end
+
+  describe "Report using SQL" do
+    before(:each) do
+      ActiveRecord::Base.establish_connection("adapter"=>"sqlite3", "database"=>":memory:") 
+      ActiveRecord::Base.logger = Logger.new(File.open('/dev/null', 'a'))   
+      ActiveRecord::Base.connection.execute %Q{
+        create table orders (
+          first_name varchar2(30),
+          last_name varchar2(30),
+          order_number varchar2(30),
+          status varchar2(30)
+        );
+      }
+      
+      Order.create!(:first_name => "doug" ,:last_name => "bryant", :order_number => "ABC087" ,:status => "failed")
+      Order.create!(:first_name => "john" ,:last_name => "riney", :order_number => "ABC042" ,:status => "pending")
+      Order.create!(:first_name => "chris" ,:last_name => "gay", :order_number => "ABC076" ,:status => "paid")
+      Order.create!(:first_name => "tom" ,:last_name => "mccall", :order_number => "ABC027" ,:status => "paid")
+      Order.create!(:first_name => "kenny" ,:last_name => "roberts", :order_number => "ABC001" ,:status => "paid")
+      Order.create!(:first_name => "ben" ,:last_name => "spies", :order_number => "ABC011" ,:status => "paid")
+      Order.create!(:first_name => "nicky" ,:last_name => "hayden", :order_number => "ABC069" ,:status => "paid")
+      Order.create!(:first_name => "colin" ,:last_name => "edwards", :order_number => "ABC005" ,:status => "paid")
+    end
+
+    after(:each) do
+      ActiveRecord::Base.connection.execute "drop table orders"
+    end
+
+    it "should be able to generate a report with SQL" do
+      report = ReportBuilderUnderTestSql.new
+      result = report.build_report
+      result.size.should == 6
+    end
+
+    it "should order the results properly" do
+      report = ReportBuilderUnderTestSql.new
+      result = report.build_report
+
+      # test that it is descending...
+      result[0][2].should == "ABC076"
+      result[1][2].should == "ABC069"
+      result[2][2].should == "ABC027"
+      result[3][2].should == "ABC011"
+      result[4][2].should == "ABC005"
+      result[5][2].should == "ABC001"
+    end
+
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'ruport_report_builder'
+require 'sqlite3'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: ruport_report_builder
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Doug Bryant
+- John Riney
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ruport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 0
+        version: 1.4.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Simple wrapper for common ruport tasks
+email: code@milemeter.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/ordered_hash.rb
+- lib/ruport_report_builder.rb
+- spec/ruport_report_builder_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/milemeter/ruport_report_builder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Simple wrapper for common ruport tasks
+test_files: 
+- spec/ruport_report_builder_spec.rb
+- spec/spec_helper.rb