jzimmek-reportme 0.0.5

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jan Zimmek
+
+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,29 @@
+= report_me
+
+ReportMe is a thin ruby wrapper around your reporting sql queries which empowers you to automate, historicize, graph and mail them in an easy manner.
+
+== Usage
+
+  ReportFactory.create do
+    report :visits do
+      source do |von, bis|
+        <<-SQL
+          select
+            date(v.created_at) as datum,
+            channel,
+            count(1) as cnt
+          from
+            visits v
+          where
+            v.created_at between '#{von}' and '#{bis}'
+          group by
+            date(v.created_at),
+            channel
+        SQL
+      end
+    end
+  end
+
+== Copyright
+
+Copyright (c) 2009 Jan Zimmek. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "reportme"
+    gem.summary = "Ruby wrapper to automate sql reports"
+    gem.description = "ReportMe is a thin ruby wrapper around your reporting sql queries which empowers you to automate, historicize, graph and mail them in an easy manner."
+    gem.email = "jan.zimmek@web.de"
+    gem.homepage = "http://github.com/jzimmek/report_me"
+    gem.authors = ["Jan Zimmek"]
+    gem.files = FileList['lib/**/*.rb', 'bin/*', '[A-Z]*', 'test/**/*'].to_a
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "report_me #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.5

data/lib/reportme.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'activerecord'
+
+require 'reportme/report'
+require 'reportme/report_factory'

data/lib/reportme/report.rb

@@ -0,0 +1,45 @@
+module Reportme
+  class Report
+  
+    attr_reader :name
+  
+    def initialize(name)
+      @name = name
+      @periods = [:today, :day, :week, :calendar_week, :month, :calendar_month]
+    end
+  
+    def source(&block)
+      @source = block
+    end
+    
+    def periods(*args)
+      unless args.blank?
+        @periods.clear
+        args.each do |period|
+          @periods << period
+        end
+      end
+    end
+    
+    def wants_period?(period)
+      @periods.include?(period)
+    end
+    
+    def periods
+      
+    end
+    
+    def sql(von, bis)
+      @source.call(von, bis)
+    end
+  
+    def table_name(period)
+      "#{name}_#{period}"
+    end
+  
+    def table_exist?(period)
+      ActiveRecord::Base.connection.select_value("show tables like '#{table_name(period)}'") != nil
+    end
+  
+  end
+end

data/lib/reportme/report_factory.rb

@@ -0,0 +1,152 @@
+require 'reportme/report'
+
+module Reportme
+  class ReportFactory
+  
+    def self.create(&block)
+      rme = ReportFactory.new
+      rme.instance_eval(&block)
+      rme.run
+      rme
+    end
+  
+    def initialize
+      @reports = []
+    end
+  
+    def periods(today = DateTime.now)
+
+      periods = []
+
+      [:today, :day, :week, :calendar_week, :month, :calendar_month].each do |period|
+      
+        von, bis = case period
+          when :today
+            [today, today]
+          when :day
+            [today - 1.day, today - 1.day]
+          when :week
+            [today - 1.day - 1.week, today - 1.day]
+          when :calendar_week
+            n = today - 1.day
+            [n - n.cwday + 1, n - n.cwday + 7]
+          when :month
+            [today - 1.day - 1.month, today - 1.day]
+          when :calendar_month
+            n = today - 1.month
+            [n.beginning_of_month, n.end_of_month]
+        end
+      
+        periods << {:name => period, :von => von, :bis => bis}
+
+      end
+    
+      periods
+    end
+  
+    def report_information_table_name
+      "report_informations"
+    end
+  
+    def report_information_table_name_exist?
+      ActiveRecord::Base.connection.select_value("show tables like '#{report_information_table_name}'") != nil
+    end
+
+    def report_exists?(name, von, bis)
+      ActiveRecord::Base.connection.select_value("select 1 from #{report_information_table_name} where report = '#{name}' and von = '#{von}' and bis = '#{bis}'") != nil
+    end
+    
+    def reset
+      exec("drop table if exists #{report_information_table_name};")
+      
+      periods.each do |period|
+        @reports.each do |r|
+          exec("drop table if exists #{r.table_name(period[:name])};")
+        end
+      end
+    end
+  
+    def run
+    
+      debug = false
+    
+      unless report_information_table_name_exist?
+        ddl = <<-SQL
+          create
+            table report_informations
+            (
+              report varchar(255) not null,
+              von datetime not null,
+              bis datetime not null,
+              created_at datetime not null,
+              primary key (report)
+            )
+            ENGINE=InnoDB default CHARSET=utf8;
+        SQL
+        exec(ddl)
+      end
+    
+      if debug
+        # just for testing
+        exec("truncate #{report_information_table_name};")
+      end
+    
+      periods.each do |period|
+      
+        @reports.each do |r|
+          
+          next unless r.wants_period?(period[:name])
+          
+          von = period[:von].strftime("%Y-%m-%d 00:00:00")
+          bis = period[:bis].strftime("%Y-%m-%d 23:59:59")
+
+          table_name = r.table_name(period[:name])
+
+          if debug
+            # drop and create table while in testing mode
+            exec("drop table if exists #{table_name};")
+          end
+
+          table_exist   = r.table_exist?(period[:name])
+          sql           = r.sql(von, bis)
+          report_exist  = report_exists?(table_name, von, bis)
+        
+          puts "report: #{r.name}_#{period[:name]} :: #{report_exist}"
+        
+        
+          unless table_exist
+            exec("create table #{table_name} ENGINE=InnoDB default CHARSET=utf8 as #{sql} limit 0;")
+          end
+        
+          puts sql
+        
+          # if !report_exist || period[:name] == :today
+          #   ActiveRecord::Base.transaction do
+          #     exec("insert into #{report_information_table_name} values ('#{table_name}', '#{von}', '#{bis}', now());") unless report_exist
+          # 
+          #     if period[:name] == :today
+          #       exec("truncate #{table_name};")
+          #     end
+          #   
+          #     exec("insert into #{table_name} #{sql};")
+          #   end
+          # end
+
+        
+        end
+      end
+    end
+  
+    def exec(sql)
+      ActiveRecord::Base.connection.execute(sql)
+    end
+  
+    def report(name, &block)
+      r = Report.new(name)
+      r.instance_eval(&block)
+    
+      @reports << r
+    end
+  
+  end
+end

data/test/report_me_test.rb

@@ -0,0 +1,96 @@
+require 'test_helper'
+
+class ReportMeTest < Test::Unit::TestCase
+
+  def setup
+    exec("use report_me_test")
+    exec "drop table if exists visits"
+    exec <<-SQL
+      create
+        table visits
+        (
+          id bigint auto_increment,
+          channel varchar(255),
+          created_at datetime,
+          primary key (id)
+        )
+    SQL
+  end
+  
+  def create_visit_report_factory
+    
+    rme = ReportMe::ReportFactory.create do
+      report :visits do
+        source do |von, bis|
+          <<-SQL
+          select
+            date('#{von}') as datum,
+            channel,
+            count(1) as cnt
+          from
+            visits
+          where
+            created_at between '#{von}' and '#{bis}'
+          group by
+            date(created_at),
+            channel
+          SQL
+        end
+      end
+    end
+    
+    rme.reset
+    rme
+  end
+  
+  def exec(sql)
+    ActiveRecord::Base.connection.execute(sql)
+  end
+
+  def one(sql)
+    ActiveRecord::Base.connection.select_one(sql)
+  end
+
+  def teardown
+    exec("truncate visits;");
+  end
+
+  should "create one visitor in the today report for channel sem" do
+    exec("insert into visits values (null, 'sem', now())");
+    create_visit_report_factory.run
+    assert_equal 1, one("select count(1) as cnt from visits_today where channel = 'sem' and datum = curdate()")["cnt"].to_i
+  end
+  
+  should "create two visitors in the today report for channel sem" do
+    exec("insert into visits values (null, 'sem', now())");
+    exec("insert into visits values (null, 'sem', now())");
+    create_visit_report_factory.run
+    assert_equal 2, one("select cnt from visits_today where channel = 'sem' and datum = curdate()")["cnt"].to_i
+  end
+  
+  should "create visitors in the today report for channel sem and seo" do
+    exec("insert into visits values (null, 'sem', now())");
+    exec("insert into visits values (null, 'sem', now())");
+    exec("insert into visits values (null, 'seo', now())");
+    exec("insert into visits values (null, 'sem', now())");
+    exec("insert into visits values (null, 'seo', now())");
+    create_visit_report_factory.run
+    assert_equal 2, one("select cnt from visits_today where channel = 'seo' and datum = curdate()")["cnt"].to_i
+    assert_equal 3, one("select cnt from visits_today where channel = 'sem' and datum = curdate()")["cnt"].to_i
+  end
+
+  should "create visitors in the day report for channel sem and seo" do
+    exec("insert into visits values (null, 'sem', date_sub(curdate(), interval 1 day));");
+    exec("insert into visits values (null, 'sem', date_sub(curdate(), interval 1 day));");
+    exec("insert into visits values (null, 'seo', date_sub(curdate(), interval 1 day));");
+    exec("insert into visits values (null, 'sem', date_sub(curdate(), interval 1 day));");
+    exec("insert into visits values (null, 'seo', date_sub(curdate(), interval 1 day));");
+    create_visit_report_factory.run
+    assert_equal 2, one("select cnt from visits_day where channel = 'seo' and datum = date_sub(curdate(), interval 1 day)")["cnt"].to_i
+    assert_equal 3, one("select cnt from visits_day where channel = 'sem' and datum = date_sub(curdate(), interval 1 day)")["cnt"].to_i
+  end
+  
+  should "handle today and day periods but nothing else" do
+  end
+  
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'report_me'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+
+class Test::Unit::TestCase
+end
+
+ActiveRecord::Base.establish_connection(:adapter => "mysql", :database => "mysql", :username => "root", :password => "root", :host => "localhost", :port => 3306)
+
+ActiveRecord::Base.connection.execute "drop database if exists report_me_test;"
+ActiveRecord::Base.connection.execute "create database report_me_test;"
+ActiveRecord::Base.connection.execute "use report_me_test;"

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: jzimmek-reportme
+version: !ruby/object:Gem::Version 
+  version: 0.0.5
+platform: ruby
+authors: 
+- Jan Zimmek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-23 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: ReportMe is a thin ruby wrapper around your reporting sql queries which empowers you to automate, historicize, graph and mail them in an easy manner.
+email: jan.zimmek@web.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/reportme.rb
+- lib/reportme/report.rb
+- lib/reportme/report_factory.rb
+- test/report_me_test.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/jzimmek/report_me
+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: 3
+summary: Ruby wrapper to automate sql reports
+test_files: 
+- test/report_me_test.rb
+- test/test_helper.rb