RubyGems - report_cat - Versions diffs - 0.2.0 - Mend

report_cat 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (132) hide show

checksums.yaml +7 -0
data/MIT-LICENSE +20 -0
data/README.md +147 -0
data/Rakefile +24 -0
data/app/assets/javascripts/report_cat/application.js +13 -0
data/app/assets/stylesheets/report_cat/application.css +13 -0
data/app/controllers/report_cat/reports_controller.rb +43 -0
data/app/helpers/report_cat/reports_helper.rb +132 -0
data/app/models/report_cat/date_range.rb +94 -0
data/app/views/report_cat/reports/_google_charts.html.erb +61 -0
data/app/views/report_cat/reports/index.html.erb +2 -0
data/app/views/report_cat/reports/show.html.erb +15 -0
data/config/locales/en.yml +26 -0
data/config/routes.rb +7 -0
data/db/migrate/20130918075200_create_date_ranges.rb +13 -0
data/lib/report_cat/config.rb +30 -0
data/lib/report_cat/core/chart.rb +50 -0
data/lib/report_cat/core/column.rb +70 -0
data/lib/report_cat/core/param.rb +35 -0
data/lib/report_cat/core/report.rb +127 -0
data/lib/report_cat/engine.rb +11 -0
data/lib/report_cat/matchers/have_chart.rb +58 -0
data/lib/report_cat/matchers/have_column.rb +45 -0
data/lib/report_cat/matchers/have_param.rb +52 -0
data/lib/report_cat/reports/cohort_report.rb +113 -0
data/lib/report_cat/reports/date_range_report.rb +66 -0
data/lib/report_cat/version.rb +3 -0
data/lib/report_cat.rb +39 -0
data/lib/tasks/report_cat.rake +4 -0
data/spec/controllers/report_cat/reports_controller_spec.rb +100 -0
data/spec/coverage_spec.rb +18 -0
data/spec/data/helpers/report_charts.html +1 -0
data/spec/data/helpers/report_charts.html.tmp +1 -0
data/spec/data/helpers/report_form.html +63 -0
data/spec/data/helpers/report_form.html.tmp +63 -0
data/spec/data/helpers/report_form_param.html +1 -0
data/spec/data/helpers/report_form_param.html.tmp +1 -0
data/spec/data/helpers/report_list.html +1 -0
data/spec/data/helpers/report_list.html.tmp +1 -0
data/spec/data/helpers/report_param_checkbox.html +1 -0
data/spec/data/helpers/report_param_checkbox.html.tmp +1 -0
data/spec/data/helpers/report_param_date.html +60 -0
data/spec/data/helpers/report_param_date.html.tmp +60 -0
data/spec/data/helpers/report_param_hidden.html +1 -0
data/spec/data/helpers/report_param_hidden.html.tmp +1 -0
data/spec/data/helpers/report_param_select.html +3 -0
data/spec/data/helpers/report_param_select.html.tmp +3 -0
data/spec/data/helpers/report_param_text_field.html +1 -0
data/spec/data/helpers/report_param_text_field.html.tmp +1 -0
data/spec/data/helpers/report_table.html +1 -0
data/spec/data/helpers/report_table.html.tmp +1 -0
data/spec/data/helpers/report_table_hidden.html +1 -0
data/spec/data/helpers/report_table_hidden.html.tmp +1 -0
data/spec/data/lib/chart_columns.json +1 -0
data/spec/data/lib/chart_columns.json.tmp +1 -0
data/spec/data/lib/chart_data.json +1 -0
data/spec/data/lib/chart_data.json.tmp +1 -0
data/spec/data/lib/date_range_report_where.sql +6 -0
data/spec/data/lib/date_range_report_where.sql.tmp +6 -0
data/spec/data/lib/report.csv +3 -0
data/spec/data/lib/report.csv.tmp +3 -0
data/spec/data/lib/report.sql +1 -0
data/spec/data/lib/report.sql.tmp +1 -0
data/spec/data/models/sql_intersect.sql +5 -0
data/spec/data/models/sql_intersect.sql.tmp +5 -0
data/spec/dummy/README.rdoc +28 -0
data/spec/dummy/Rakefile +6 -0
data/spec/dummy/app/assets/javascripts/application.js +13 -0
data/spec/dummy/app/assets/stylesheets/application.css +13 -0
data/spec/dummy/app/controllers/application_controller.rb +21 -0
data/spec/dummy/app/controllers/root_controller.rb +20 -0
data/spec/dummy/app/helpers/application_helper.rb +2 -0
data/spec/dummy/app/models/user.rb +13 -0
data/spec/dummy/app/models/visit.rb +16 -0
data/spec/dummy/app/reports/retention_cohort_report.rb +19 -0
data/spec/dummy/app/reports/retention_report.rb +30 -0
data/spec/dummy/app/reports/user_report.rb +23 -0
data/spec/dummy/app/views/layouts/admin.html.erb +19 -0
data/spec/dummy/app/views/layouts/application.html.erb +19 -0
data/spec/dummy/app/views/root/index.html.erb +8 -0
data/spec/dummy/bin/bundle +3 -0
data/spec/dummy/bin/rails +4 -0
data/spec/dummy/bin/rake +4 -0
data/spec/dummy/config/application.rb +30 -0
data/spec/dummy/config/boot.rb +5 -0
data/spec/dummy/config/database.yml +25 -0
data/spec/dummy/config/environment.rb +5 -0
data/spec/dummy/config/environments/development.rb +31 -0
data/spec/dummy/config/environments/production.rb +80 -0
data/spec/dummy/config/environments/test.rb +36 -0
data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
data/spec/dummy/config/initializers/inflections.rb +16 -0
data/spec/dummy/config/initializers/mime_types.rb +5 -0
data/spec/dummy/config/initializers/report_cat.rb +15 -0
data/spec/dummy/config/initializers/secret_token.rb +12 -0
data/spec/dummy/config/initializers/session_store.rb +3 -0
data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
data/spec/dummy/config/locales/en.yml +38 -0
data/spec/dummy/config/routes.rb +13 -0
data/spec/dummy/config.ru +4 -0
data/spec/dummy/db/development.sqlite3 +0 -0
data/spec/dummy/db/schema.rb +26 -0
data/spec/dummy/db/test.sqlite3 +0 -0
data/spec/dummy/log/development.log +61 -0
data/spec/dummy/log/test.log +26478 -0
data/spec/dummy/public/404.html +58 -0
data/spec/dummy/public/422.html +58 -0
data/spec/dummy/public/500.html +57 -0
data/spec/dummy/public/favicon.ico +0 -0
data/spec/helpers/report_cat/reports_helper_spec.rb +224 -0
data/spec/lib/report_cat/config_spec.rb +96 -0
data/spec/lib/report_cat/core/chart_spec.rb +67 -0
data/spec/lib/report_cat/core/column_spec.rb +156 -0
data/spec/lib/report_cat/core/param_spec.rb +95 -0
data/spec/lib/report_cat/core/report_spec.rb +342 -0
data/spec/lib/report_cat/engine_spec.rb +9 -0
data/spec/lib/report_cat/matchers/have_chart_spec.rb +36 -0
data/spec/lib/report_cat/matchers/have_column_spec.rb +30 -0
data/spec/lib/report_cat/matchers/have_param_spec.rb +33 -0
data/spec/lib/report_cat/reports/cohort_report_spec.rb +215 -0
data/spec/lib/report_cat/reports/date_range_report_spec.rb +125 -0
data/spec/lib/report_cat/version_spec.rb +11 -0
data/spec/lib/report_cat_spec.rb +62 -0
data/spec/lib/tasks/report_cat.rake_spec.rb +13 -0
data/spec/models/report_cat/date_range_spec.rb +144 -0
data/spec/rails_helper.rb +49 -0
data/spec/spec_helper.rb +23 -0
data/spec/support/setup_reports.rb +28 -0
data/spec/views/report_cat/reports/index.html.erb_spec.rb +16 -0
data/spec/views/report_cat/reports/show.html.erb_spec.rb +19 -0
metadata +489 -0

data/spec/dummy/public/404.html ADDED Viewed

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/spec/dummy/public/422.html ADDED Viewed

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/spec/dummy/public/500.html ADDED Viewed

@@ -0,0 +1,57 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style>
+  body {
+    background-color: #EFEFEF;
+    color: #2E2F30;
+    text-align: center;
+    font-family: arial, sans-serif;
+  }
+  div.dialog {
+    width: 25em;
+    margin: 4em auto 0 auto;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-left-color: #999;
+    border-bottom-color: #BBB;
+    border-top: #B00100 solid 4px;
+    border-top-left-radius: 9px;
+    border-top-right-radius: 9px;
+    background-color: white;
+    padding: 7px 4em 0 4em;
+  }
+  h1 {
+    font-size: 100%;
+    color: #730E15;
+    line-height: 1.5em;
+  }
+  body > p {
+    width: 33em;
+    margin: 0 auto 1em;
+    padding: 1em 0;
+    background-color: #F7F7F7;
+    border: 1px solid #CCC;
+    border-right-color: #999;
+    border-bottom-color: #999;
+    border-bottom-left-radius: 4px;
+    border-bottom-right-radius: 4px;
+    border-top-color: #DADADA;
+    color: #666;
+    box-shadow:0 3px 8px rgba(50, 50, 50, 0.17);
+  }
+  </style>
+</head>
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+  </div>
+  <p>If you are the application owner check the logs for more information.</p>
+</body>
+</html>

data/spec/dummy/public/favicon.ico ADDED Viewed

File without changes

data/spec/helpers/report_cat/reports_helper_spec.rb ADDED Viewed

@@ -0,0 +1,224 @@
+require 'spec_helper'
+describe ReportCat::ReportsHelper do
+  include SetupReports
+  before( :each ) do
+    setup_reports
+  end
+  #############################################################################
+  # report_back
+  describe '#report_back' do
+    context 'when back is set' do
+      it 'returns a link to the back report' do
+        @report.back = { :name => :user_report }
+        expected = "<a href=\"/report_cat/reports/user_report\">User Report</a>"
+        expect( helper.report_back( @report ) ).to eql( expected )
+      end
+    end
+    context 'when back is not set' do
+      it 'returns a link to the report root path' do
+        @report.back = nil
+        expected = "<a href=\"/\">Reports</a>"
+        expect( helper.report_back( @report ) ).to eql( expected )
+      end
+    end
+  end
+  #############################################################################
+  # report_chart_partial
+  describe '#report_chart_partial' do
+    it 'renders the google charts partial' do
+      expect( helper ).to receive( :render ).with( :partial => 'report_cat/reports/google_charts' )
+      helper.report_chart_partial
+    end
+  end
+  #############################################################################
+  # report_charts
+  describe '#report_charts' do
+    it 'renders the configured charts' do
+      expect( helper.report_charts( @report ) ).to eql_file( 'spec/data/helpers/report_charts.html' )
+    end
+  end
+  #############################################################################
+  # report_count
+  describe '#report_count' do
+    it 'returns a translated count string' do
+      expected = I18n.t( :count, :scope => :report_cat, :count => @report.rows.count )
+      expect( helper.report_count( @report ) ).to eql( expected )
+    end
+  end
+  #############################################################################
+  # report_csv_link
+  describe '#report_csv_link' do
+    it 'renders a CSV link' do
+      url = '/foo/bar?format=csv'
+      expect( helper ).to receive( :url_for ).with( { :params => { :format => :csv } } ).and_return( url )
+      expected = "<a href=\"#{url}\">Export as CSV</a>"
+      expect( helper.report_csv_link( @report ) ).to eql( expected )
+    end
+  end
+  #############################################################################
+  # report_description
+  describe '#report_description' do
+    it 'renders the localized description for the report' do
+      expected = t( :description, :scope => [ :report_cat, :instances, @report.name.to_sym ] )
+      expect( helper.report_description( @report ) ).to eql( expected )
+    end
+  end
+  #############################################################################
+  # report_form
+  describe '#report_form' do
+    it 'renders a form for the report params' do
+      pending 'broken on Travis in a non-obvious way.  need build artifact. http://blog.travis-ci.com/2012-12-18-travis-artifacts/ '
+      expect( helper ).to receive( :report_path ).and_return( '' )
+      expect( helper.report_form( @report ) ).to eql_file( 'spec/data/helpers/report_form.html' )
+    end
+  end
+  #############################################################################
+  # report_form_param
+  describe '#report_form_param' do
+    it 'returns a div with the form element' do
+      param = @report.param( :check_box_test )
+      expect( helper.report_form_param( param ) ).to eql_file( 'spec/data/helpers/report_form_param.html' )
+    end
+    it 'returns hidden params' do
+      param = @report.param( :hidden_test )
+      expected = "<input id=\"hidden_test\" name=\"hidden_test\" type=\"hidden\" value=\"true\" />"
+      expect( helper.report_form_param( param ) ).to eql( expected )
+    end
+  end
+  #############################################################################
+  # report_link
+  describe '#report_link' do
+    it 'generates a link to a report' do
+      attributes = { :name => :cohort_report, :is_cohort => '1' }
+      expected =  "<a href=\"/report_cat/reports/cohort_report?is_cohort=1\">Cohort Report</a>"
+      expect( helper.report_link( attributes ) ).to eql( expected )
+    end
+  end
+  #############################################################################
+  # report_list
+  describe '#report_list' do
+    it 'renders a list of reports in HTML' do
+      expect( helper.report_list( @reports ) ).to eql_file( 'spec/data/helpers/report_list.html' )
+    end
+  end
+  #############################################################################
+  # report_name
+  describe '#report_name' do
+    it 'renders the localized description for the report' do
+      expected = t( :name, :scope => [ :report_cat, :instances, @report.name.to_sym ] )
+      expect( helper.report_name( @report ) ).to eql( expected )
+    end
+  end
+  #############################################################################
+  # report_param
+  describe '#report_param' do
+    it 'returns a checkbox' do
+      param = @report.param( :check_box_test )
+      path = 'spec/data/helpers/report_param_checkbox.html'
+      expect( report_param( param ) ).to eql_file( path )
+    end
+    it 'returns a date' do
+      param = @report.param( :date_test )
+      path = 'spec/data/helpers/report_param_date.html'
+      expect( report_param( param ) ).to eql_file( path )
+    end
+    it 'returns a hidden' do
+      param = @report.param( :hidden_test )
+      path = 'spec/data/helpers/report_param_hidden.html'
+      expect( report_param( param ) ).to eql_file( path )
+    end
+    it 'returns a select' do
+      param = @report.param( :select_test )
+      path = 'spec/data/helpers/report_param_select.html'
+      expect( report_param( param ) ).to eql_file( path )
+    end
+    it 'returns a text_field' do
+      param = @report.param( :text_field_test )
+      path = 'spec/data/helpers/report_param_text_field.html'
+      expect( report_param( param ) ).to eql_file( path )
+    end
+    it 'raises an exception for unknown types' do
+      param = Param.new( :name => :foo, :type => :bar )
+      expect { report_param( param ) }.to raise_error
+    end
+    #############################################################################
+    # report_table
+    describe '#report_table' do
+      it 'renders a table of report rows' do
+        expect( report_table( @report ) ).to eql_file( 'spec/data/helpers/report_table.html' )
+      end
+      it 'excludes hidden columns'do
+        @report.column( :day ).options[ :hidden ] = true
+        @report.column( :total ).options[ :hidden ] = true
+        expect( report_table( @report ) ).to eql_file( 'spec/data/helpers/report_table_hidden.html' )
+      end
+    end
+  end
+end

data/spec/lib/report_cat/config_spec.rb ADDED Viewed

@@ -0,0 +1,96 @@
+require 'spec_helper'
+describe ReportCat::Config do
+  let( :config ) { ReportCat::Config.instance }
+  it 'is a singleton' do
+    expect( config ).to be( ReportCat::Config.instance )
+  end
+  describe 'attributes' do
+    it 'has an #authenticate accessor' do
+      config.authenticate = ReportCat::Config::NIL_PROC
+      config.authenticate = config.authenticate
+      expect( config.authenticate ).to eql( config.authenticate )
+    end
+    it 'has an #authorize accessor' do
+      config.authorize = ReportCat::Config::NIL_PROC
+      config.authorize = config.authorize
+      expect( config.authorize ).to eql( config.authorize )
+    end
+    it 'has an #layout excludes' do
+      expect( config.excludes ).to_not be_nil
+      config.excludes = config.excludes
+      expect( config.excludes ).to eql( config.excludes )
+    end
+    it 'has a #layout accessor' do
+      expect( config.layout ).to_not be_nil
+      config.layout = config.layout
+      expect( config.layout ).to eql( config.layout )
+    end
+  end
+  describe '#authenticate_with' do
+    it 'accepts a block' do
+      config.authenticate = nil
+      config.authenticate_with do
+        true
+      end
+      expect( config.authenticate ).to_not be_nil
+    end
+    it 'returns a block' do
+      @test = false
+      config.authenticate_with do
+        @test = true
+      end
+      instance_eval( &config.authenticate_with )
+      expect( @test ).to be( true )
+    end
+    it 'returns a nil proc if none has been set' do
+      config.authenticate = nil
+      instance_eval( &config.authenticate_with )
+    end
+  end
+  describe '#authorize_with' do
+    it 'accepts a block' do
+      config.authorize = nil
+      config.authorize_with do
+        true
+      end
+      expect( config.authorize ).to_not be_nil
+    end
+    it 'returns a block' do
+      @test = false
+      config.authorize_with do
+        @test = true
+      end
+      instance_eval( &config.authorize_with )
+      expect( @test ).to be( true )
+    end
+    it 'returns a nil proc if none has been set' do
+      config.authorize = nil
+      instance_eval( &config.authorize_with )
+    end
+  end
+end

data/spec/lib/report_cat/core/chart_spec.rb ADDED Viewed

@@ -0,0 +1,67 @@
+require 'spec_helper'
+include ReportCat::Core
+module ReportCat::Core
+  describe Chart do
+    include SetupReports
+    before( :each ) do
+      setup_reports
+      @name = :test
+      @type = :select
+      @label = @report.columns.first.name.to_sym
+      @values = @report.columns.map { |c| c.name.to_sym }
+      @options = {}
+      @chart = Chart.new(
+                  :name => @name,
+                  :type => @type,
+                  :label => @label,
+                  :values => @values,
+                  :options => @options )
+    end
+    #############################################################################
+    # #initialize
+    describe '#initialize' do
+      it 'initializes accessor values' do
+        expect( @chart.name ).to eql( @name )
+        expect( @chart.type ).to eql( @type )
+        expect( @chart.label ).to eql( @label )
+        expect( @chart.values ).to eql( @values )
+        expect( @chart.options ).to eql( @options )
+      end
+    end
+    #############################################################################
+    # #columns
+    describe '#columns' do
+      it 'generates json' do
+        expect( @chart.columns( @report ) ).to eql_file( 'spec/data/lib/chart_columns.json' )
+      end
+    end
+    #############################################################################
+    # #initialize
+    describe '#data' do
+      it 'generates json' do
+        setup_reports
+        expect( @chart.data( @report ) ).to eql_file( 'spec/data/lib/chart_data.json' )
+      end
+    end
+  end
+end