creation_report 0.0.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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 @@
+= CreationReport
+
+
+CreationReport is an easy way to visualize how many instances of each model are being created over time.
+Keep in mind that it cannot keep track of rows that have been deleted.
+
+Note: This plugin requires 'gchartrb'. The following line should go in your environment.rb file:
+ config.gem 'gchartrb', :lib => 'google_chart'
+
+
+Example
+=======
+
+# MODEL
+def User < ActiveRecord::Base
+  include CreationReport  # Make sure that this is in your model
+
+  # the rest of your code
+end
+
+# CONTROLLER
+def usage
+  @creations_by_day_chart = User.creations_by_day_chart
+  @creations_by_hour_chart = User.creations_by_hour_of_day_chart
+end
+
+# VIEW
+<img src="<%= @creations_by_day_chart.to_url %>" alt="Google Chart" class="google_chart" />
+<img src="<%= @creations_by_hour_chart.to_url %>" alt="Google Chart" class="google_chart" />

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'CreationReport'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/creation_report/version.rb

@@ -0,0 +1,3 @@
+module CreationReport
+  VERSION = "0.0.3"
+end

data/lib/creation_report.rb

@@ -0,0 +1,96 @@
+require 'data_set'
+require 'data_set/hourly_data_set'
+require 'data_set/daily_data_set'
+require 'data_set/day_of_week_data_set'
+require 'data_set/hour_of_day_data_set'
+require 'data_set/monthly_data_set'
+
+module CreationReport
+  
+    def self.append_features(base)
+      super
+      if base.superclass == ActiveRecord::Base
+        base.extend(ClassMethods)
+      else
+        raise "CreationReport can only be included in ActiveRecord subclasses."
+      end
+    end
+
+    module ClassMethods
+      @@number_of_days = 1000
+      
+      def created_by_hour
+        DataSet::HourlyDataSet.new(
+          count(
+            :group => "DATE_FORMAT(#{table_name}.created_at,'%Y-%m-%d %h')", 
+            :order => "#{table_name}.id ASC", 
+            :conditions => ["#{table_name}.created_at > ?", 24.hours.ago]
+          ), 24
+        )
+      end
+
+      def created_by_day
+        DataSet::DailyDataSet.new(
+          count(
+            :group => "DATE(#{table_name}.created_at)", 
+            :order => "#{table_name}.id ASC", 
+            :conditions => ["#{table_name}.created_at > ?", report_start_time]
+          ), @@number_of_days
+        )
+      end
+      
+      def created_by_hour_of_day
+        DataSet::HourOfDayDataSet.new(
+          count(
+            :group => "DATE_FORMAT(created_at, '%k')", 
+            :order => "#{table_name}.id ASC", 
+            :conditions => ["created_at > ?", report_start_time]
+          )
+        )
+      end
+
+      def average_created_by_day
+        created_by_day.values.sum.to_f / created_by_day.values.length.to_f
+      end
+      
+      def average_created_at_this_hour
+        created_by_day.values.at( Time.now.hour )
+      end
+  
+      def creations_by_day_chart
+        dataset = created_by_day
+        GoogleChart::LineChart.new('600x150', "#{self.table_name.upcase} CREATED IN THE LAST #{@@number_of_days} DAYS", false) do |lc|
+          lc.data_encoding = :extended
+          lc.data "Created", dataset.values, '00ff00'
+          lc.show_legend = false
+          lc.title_color = 'A5B1A0'
+          lc.title_font_size = '10'
+          lc.max_value dataset.max_value
+          lc.axis :y, :range => [dataset.min_value, dataset.max_value]
+          lc.axis :x, :labels => dataset.date_labels
+          lc.grid :y_step => 50, :x_step => 25, :length_segment => 2, :length_blank => 10
+        end
+      end
+      
+      def creations_by_hour_of_day_chart
+        dataset = created_by_hour_of_day
+        GoogleChart::LineChart.new('600x150', "#{self.table_name.upcase} CREATED FOR EACH HOUR", false) do |lc|
+          lc.data "Created", dataset.values, '00ff00'
+          lc.show_legend = false
+          lc.title_color = 'A5B1A0'
+          lc.title_font_size = '10'
+          lc.max_value dataset.max_value
+          lc.axis :y, :range => [dataset.min_value, dataset.max_value]
+          lc.axis :x, :labels => dataset.hours.to_a
+          lc.grid :y_step => 50, :x_step => 100/11.5, :length_segment => 2, :length_blank => 10
+        end
+      end
+
+      protected
+      def report_start_time
+        @@number_of_days.days.ago.beginning_of_day
+      end
+      
+  end
+  
+end

data/lib/data_set/daily_data_set.rb

@@ -0,0 +1,50 @@
+class DataSet::DailyDataSet < DataSet
+
+  def initialize( point_array, count = 30 )
+
+    @datapoints ||= {} #[["2008-06-01", 200.58], ["2008-06-02", 205.39]]
+    @count = count
+    
+    point_array.each do |date, value|
+      value = value.to_f
+      @datapoints[date.to_s] = value
+    end
+
+    fill_with_zeroes(@count)
+  end
+  
+  # Array of dates corresponding to datapoints in "2009-11-18" format
+  def dates
+    @datapoints.collect{|point| point[0]}
+  end
+  
+  # Array of dates in "Nov 18" format corresponding to datapoints
+  # at one week increments working backwords from today.
+  # Compare today's DOW ("Mon") to each date in the array, and only return "Nov 18" for dates that match the DOW.
+  def date_labels
+    if @count < 90
+      dates.collect { |date| date.to_date.strftime('%d') == Time.now.strftime('%a') ? date.to_date.strftime("%b %e") : '' }
+    else
+      dates.collect { |date| date.to_date.strftime('%d') == '01' ? date.to_date.strftime("%b %e") : '' }
+    end
+  end
+  
+  def full_weeks_in_dataset
+    @count.to_i / 7 
+  end
+
+  # Array containing month names corresponding to datapoint positions which represent the first day of the month.
+  # ['','','December','','']
+  def month_labels
+    dates.collect{|date| date.to_date.day==1 ? date.to_date.strftime("%B") : ''}
+  end
+
+    protected
+    def fill_with_zeroes(days)
+      (0..@count).each do |i|
+        @datapoints[i.days.ago.to_date.to_s] ||= 0
+      end
+
+      @datapoints = @datapoints.sort
+    end
+end

data/lib/data_set/day_of_week_data_set.rb

@@ -0,0 +1,26 @@
+class DataSet::DayOfWeekDataSet < DataSet
+  
+  def initialize( point_array )
+    @datapoints ||= {'Mon'=>0, 'Tue'=>0, 'Wed'=> 0, 'Thu'=>0, 'Fri'=>0, 'Sat'=>0, 'Sun'=>0}
+   
+    point_array.each do |day_of_week, value|
+      value = value.to_f
+      @datapoints[day_of_week] = value
+    end
+  end
+  
+  def days
+    %w{Mon Tue Wed Thu Fri Sat Sun}
+  end
+  
+  def values
+    [ @datapoints['Mon'],
+      @datapoints['Tue'],
+      @datapoints['Wed'],
+      @datapoints['Thu'],
+      @datapoints['Fri'],
+      @datapoints['Sat'],
+      @datapoints['Sun']]
+  end
+  
+end

data/lib/data_set/hour_of_day_data_set.rb

@@ -0,0 +1,25 @@
+class DataSet::HourOfDayDataSet < DataSet
+  
+  def initialize( point_array )
+    @datapoints = {}
+    hours.each do |hour|
+      @datapoints[hour] = 0
+    end
+    
+    point_array.each do |hour_of_day, value|
+      value = value.to_f
+      @datapoints[hour_of_day.to_i] = value
+    end
+
+    @datapoints = @datapoints.sort
+  end
+  
+  def hours
+    (0..23)
+  end
+  
+  def values
+    hours.collect{|hour| @datapoints[hour][1]}
+  end
+  
+end

data/lib/data_set/hourly_data_set.rb

@@ -0,0 +1,31 @@
+class DataSet::HourlyDataSet < DataSet
+
+  def initialize( point_array, count = 24 )
+
+    @datapoints ||= {} #[["2008-06-01 12", 200.58], ["2008-06-02 13", 205.39]]
+    @count = count
+    
+    point_array.each do |date, value|
+      value = value.to_f
+      @datapoints[date.to_s] = value
+    end
+
+    fill_with_zeroes(@count)
+  end
+  
+  # Array of dates corresponding to datapoints in "2009-11-18" format
+  def dates
+    @datapoints.collect{|point| point[0]}
+  end
+
+  protected
+  def fill_with_zeroes( hours )
+    puts "Filling to #{@count}..."
+    (0..@count).each do |i|
+      puts "Adding #{i.hours.ago.strftime("%Y-%m-%d %H")}"
+      @datapoints[i.hours.ago.strftime("%Y-%m-%d %H")] ||= 0
+    end
+
+    @datapoints = @datapoints.sort
+  end
+end

data/lib/data_set/monthly_data_set.rb

@@ -0,0 +1,49 @@
+class DataSet::MonthlyDataSet < DataSet
+
+  def initialize( point_array, count = 24 )
+
+    @datapoints ||= {} #[["2008-06", 200.58], ["2008-07", 205.39]]
+    @count = count
+    
+    point_array.each do |date, value|
+      value = value.to_f
+      @datapoints[date] = value
+    end
+    fill_with_zeroes(@count)
+    truncate_datapoints
+  end
+  
+  # Return array of months in '2009-11' format corresponding to datapoints
+  def months
+    @datapoints.collect{ |point| point[0] }
+  end
+  
+  # Array of abbreviated months ('Jan', 'Feb') corresponding to datapoints
+  def month_labels
+    months.collect{ |month| 
+      "#{month}-01".to_date.strftime("%b")
+    }
+  end
+  
+  # Array containing full year (2009) x-axis labels stacked beneath month labels that are "Jan"
+  def year_labels
+    months.collect{|month| "#{month}-01".to_date.month==1 ? "#{month}-01".to_date.year : '' }
+  end
+  
+  
+  protected
+    # Set dates that don't have values to 0.
+    # This method turns the @datapoints hash into an array.
+    def fill_with_zeroes(month_count)
+      (0..month_count-1).each do |i|
+        @datapoints[i.months.ago.to_date.strftime("%Y-%m")] ||= 0
+      end
+      @datapoints = @datapoints.sort
+    end
+  
+  # Ditch the datapoints that we aren't interested in
+  def truncate_datapoints
+    return unless @datapoints.length > @count
+    @datapoints = @datapoints.slice( @datapoints.length - @count, @count)
+  end
+end

data/lib/data_set.rb

@@ -0,0 +1,53 @@
+class DataSet
+  
+  attr_accessor :datapoints
+  attr_reader :max_value, :min_value, :max_date, :min_date, :count
+  
+  # The standard initialize function creates a hash out of an array of points.
+  def initialize( point_array )
+    @datapoints ||= {}
+    @count = count || 30
+    
+    point_array.each do |x_value, y_value|
+      y_value = y_value.to_f
+      @datapoints[x_value] = y_value
+    end
+  end
+  
+  def values_for_google_chart
+    values.join(',')
+  end
+  
+  def min_value
+    values.min
+  end
+  
+  def max_value
+    values.max
+  end
+  
+  def min_date
+    dates.min
+  end
+  
+  def max_date
+    dates.max
+  end
+  
+  def dates
+    @datapoints.collect{|point| point[0]}
+  end
+
+  def values
+    @datapoints.collect{|point| point[1]}
+  end
+  
+  def value_for_date(date)
+    begin
+      return @datapoints.detect{|point| point[0]==date}[1]
+    rescue
+      raise "That date is not in the dataset."
+    end
+  end
+  
+end

data/lib/tasks/creation_report_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :creation_report do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: creation_report
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Jon Collier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-18 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 3
+        - 2
+        version: "3.2"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: gchartrb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: ""
+email: 
+- gem@joncollier.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/creation_report/version.rb
+- lib/creation_report.rb
+- lib/data_set/daily_data_set.rb
+- lib/data_set/day_of_week_data_set.rb
+- lib/data_set/hour_of_day_data_set.rb
+- lib/data_set/hourly_data_set.rb
+- lib/data_set/monthly_data_set.rb
+- lib/data_set.rb
+- lib/tasks/creation_report_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: ""
+licenses: []
+
+post_install_message: 
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Easily generate graphs for ActiveRecord object creation.
+test_files: []
+