report_cat 0.2.0

data/spec/lib/report_cat/reports/cohort_report_spec.rb

@@ -0,0 +1,215 @@
+require 'spec_helper'
+
+module ReportCat
+  module Reports
+
+    describe CohortReport do
+
+      before( :each ) do
+        @cohort = DateRangeReport.new
+        @cohort.add_column( :total, :integer, :sql => '0' )
+        @cohort.add_param( :foo, :integer )
+        @cohort.add_param( :bar, :string )
+
+        @period = :weekly
+        @start_date = Date.civil( 2013, 1, 1 )
+        @stop_date = Date.civil( 2013, 1, 31 )
+
+        @report = CohortReport.new( :cohort => @cohort )
+        @report.param( :start_date ).value =  @start_date
+        @report.param( :stop_date ).value = @stop_date
+        @report.param( :period ).value =  @period
+
+        @range = DateRange.range( @period, @start_date, @stop_date )
+      end
+
+      #############################################################################
+      # initialize
+
+      describe '#initialize' do
+
+        it 'uses a default name'  do
+          expect( @report.name ).to eql( :cohort_report )
+        end
+
+        it 'adds a total column' do
+          expect( @report ).to have_column( :total ).with_type( :integer )
+        end
+
+        it 'merges in any non-duplicate params from the cohort report' do
+          expect( @report ).to have_param( :foo ).with_type( :integer )
+          expect( @report ).to have_param( :bar ).with_type( :string )
+        end
+
+        it 'defaults cohort_column to :total' do
+          expect( @report.cohort_column ).to eql( :total )
+        end
+
+        it 'accepts cohort_column as an attribute' do
+          @report = CohortReport.new( :cohort_column => :test )
+          expect( @report.cohort_column ).to eql( :test )
+        end
+      end
+
+      #############################################################################
+      # query
+
+      describe '#query' do
+
+        it 'adds columns for each date range' do
+          @report.query
+          expect( @report.columns.size ).to eql( 4 + @range.size )
+        end
+
+        it 'adds rows for each date range' do
+          @report.query
+          expect( @report.rows.size ).to eql( @range.size )
+        end
+
+        it 'adds a line chart of all its columns' do
+          @report.query
+          expect( @report.charts.size ).to eql( 1 )
+          expect( @report ).to have_chart( :cohort_line ).with_type( :line )
+        end
+
+        it 'adds an link column' do
+          expect( @report.column( :link ) ).to be_nil
+          @report.query
+          expect( @report.column( :link ) ).to be_present
+        end
+      end
+
+      #############################################################################
+      # add_row
+
+      describe '#add_row' do
+
+        before( :each ) do
+          DateRange.generate( @period, @start_date, @stop_date )
+        end
+
+        it 'returns the generates row' do
+          expect( @report.add_row( @range.first, @range ) ).to be_an_instance_of( Array )
+        end
+
+        it 'generates the report for this cohort' do
+          expect(  @report ).to receive( :generate_cohort )
+          @report.add_row( @range.first, @range )
+        end
+
+        it 'sets the first three columns to start, stop, total' do
+          @report.add_row( @range.first, @range )
+          expect( @report.columns[ 0 ].name ).to eql( :start_date )
+          expect( @report.columns[ 1 ].name ).to eql( :stop_date )
+          expect( @report.columns[ 2 ].name ).to eql( :total )
+        end
+
+        it 'fills in the columns by date range' do
+          row = @report.add_row( @range.first, @range )
+          expect( row ).to be_an_instance_of( Array )
+          expect( row.size ).to eql( @range.size + 3 )
+        end
+
+        it 'fills nil when there is no data' do
+          allow( @report.cohort ).to receive( :rows ).and_return( [] )
+          row = @report.add_row( @range.first, @range )
+          expect( row[ 3 ] ).to be_nil
+        end
+
+        it 'fills with the total value' do
+          allow( @report.cohort ).to receive( :rows ).and_return( [ [ '', '', 30 ], [ '', '', 20 ], [ '', '', 10 ] ] )
+          row = @report.add_row( @range.first, @range )
+          expect( row[ 3 ] ).to eql( 30.0 )
+        end
+
+        it 'tolerates total being 0' do
+          allow( @report.cohort ).to receive( :rows ).and_return( [ [ '', '', 0 ], [ '', '', 20 ], [ '', '', 10 ] ] )
+          row = @report.add_row( @range.first, @range )
+          expect( row[ 3 ] ).to eql( 0.0 )
+        end
+
+      end
+
+      #############################################################################
+      # generate_cohort
+
+      describe '#generate_cohort' do
+
+        before( :each ) do
+          DateRange.generate( @period, @start_date, @stop_date )
+        end
+
+        it 'initializes the start, stop, and period of the cohort report' do
+          @report.cohort.param( :period ).value = :monthly
+          @report.cohort.param( :start_date ).value = Date.civil( 2012, 1, 1)
+          @report.cohort.param( :stop_date ).value = Date.civil( 2012, 1, 1)
+
+          @report.generate_cohort( @range.first )
+
+          expect( @report.cohort.param( :period ).value ).to eql( @report.param( :period ).value )
+          expect( @report.cohort.param( :start_date ).value ).to eql( @range.first.start_date )
+          expect( @report.cohort.param( :stop_date ).value ).to eql( @report.param( :stop_date ).value )
+        end
+
+        it 'generates the cohort report' do
+          expect( @report.cohort ).to receive( :generate )
+          @report.generate_cohort( @range.first )
+        end
+
+      end
+
+      #############################################################################
+      # add_link_column
+
+      describe '#add_link_column' do
+
+        before( :each ) do
+          allow( @report ).to receive( :rows ).and_return( [ [ Date.parse( '2014-04-22' ), nil, nil ] ] )
+          @report.add_link_column
+        end
+
+        it 'adds a link column' do
+          expect( @report ).to have_column( :link ).with_type( :report )
+        end
+
+        it 'populates the link column' do
+          i_link = @report.column_index( :link )
+          i_start = @report.column_index( :start_date )
+
+          @report.rows.each do |row|
+            start_date = row[ i_start ]
+            expect( row[ i_link ] ).to eql( @report.cohort_link( start_date ) )
+          end
+        end
+
+      end
+
+      #############################################################################
+      # cohort_link
+
+      describe '#cohort_link' do
+
+        it 'gets the cohort attributes as a hash' do
+          start_date =  @report.param( :start_date ).value
+          cohort_link = @report.cohort_link( start_date )
+
+          expect( cohort_link[ :name ] ).to eql( @report.cohort.name )
+          expect( cohort_link[ :id ] ).to eql( @report.cohort.name )
+          expect( cohort_link[ :start_date ] ).to eql( start_date )
+          expect( cohort_link[ :stop_date ] ).to eql( @report.param( :stop_date ).value )
+          expect( cohort_link[ :period ] ).to eql( @report.param( :period ).value )
+          expect( cohort_link[ :back ] ).to eql( @report.attributes )
+        end
+
+        it 'accepts link attributes to override the report values' do
+          link_attributes = { :period => :foobar }
+          start_date =  @report.param( :start_date ).value
+          cohort_link = @report.cohort_link( start_date, link_attributes )
+          expect( cohort_link[ :period ] ).to eql( :foobar )
+        end
+
+      end
+
+    end
+  end
+end

data/spec/lib/report_cat/reports/date_range_report_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+module ReportCat
+  module Reports
+
+    describe DateRangeReport do
+
+      before( :each ) do
+        @report = DateRangeReport.new
+
+        @table_name = ReportCat::DateRange.table_name
+        @defaults = {
+            :name => :date_range_report,
+            :from => @table_name,
+            :order_by => "#{@table_name}.start_date asc",
+            :group_by => "#{@table_name}.start_date, #{@table_name}.stop_date"
+        }
+
+        @period = :weekly
+        @start_date = Date.civil( 2013, 9, 1 )
+        @stop_date = Date.civil( 2013, 9, 18 )
+
+        @report.param( :period ).value = @period
+        @report.param( :start_date ).value = @start_date
+        @report.param( :stop_date ).value = @stop_date
+      end
+
+      it 'defines supported time periods' do
+        expected = [ :daily, :weekly, :monthly, :quarterly, :yearly ]
+        expect(  DateRangeReport::PERIODS ).to eql( expected )
+      end
+
+      #############################################################################
+      # defaults
+
+      describe '#defaults' do
+
+        it 'defines default report values' do
+          expect( @report.defaults ).to eql( @defaults )
+        end
+
+      end
+
+      #############################################################################
+      # initialize
+
+      describe '#initialize' do
+
+        it 'merges default values' do
+          name = :test
+          @report = DateRangeReport.new( :name => name )
+          expect( @report.name ).to be( name )
+        end
+
+        it 'defines params' do
+          expect( @report.params.size ).to eql( 3 )
+          expect( @report ).to have_param( :start_date ).with_type( :date ).with_value( @start_date )
+          expect( @report ).to have_param( :stop_date ).with_type( :date ).with_value( @stop_date )
+          expect( @report ).to have_param( :period ).with_type( :select ).with_value( :weekly ).with_options( :values => DateRangeReport::PERIODS )
+        end
+
+        it 'defines columns' do
+          expect( @report.columns.size ).to eql( 2 )
+          expect( @report ).to have_column( :start_date ).with_type( :date ).with_options( :sql => "report_cat_date_ranges.start_date" )
+          expect( @report ).to have_column( :stop_date ).with_type( :date ).with_options( :sql => "report_cat_date_ranges.stop_date" )
+        end
+
+      end
+
+      #############################################################################
+      # query
+
+      describe '#query' do
+
+        it 'generates the required date ranges' do
+          expect( DateRange ).to receive( :generate ).with( @period, @start_date, @stop_date )
+          @report.query
+        end
+
+        it 'calls query on its super' do
+          expect( @report ).to receive( :to_sql ).and_return( 'select 1' )
+          @report.query
+        end
+
+      end
+
+      #############################################################################
+      # where
+
+      describe '#where' do
+
+        it 'generates sql' do
+          expect( @report.where ).to eql_file( 'spec/data/lib/date_range_report_where.sql')
+        end
+
+        it 'includes the preconfigured where clause' do
+          where = '1 = 1'
+          @report = DateRangeReport.new( :where => where )
+          expect( @report.where ).to include( where )
+        end
+
+      end
+
+      #############################################################################
+      # accessors
+
+      describe 'accessors' do
+
+        it 'has param accessors' do
+          expect( @report.period ).to eql( @report.param( :period ).value.to_sym )
+          expect( @report.start_date ).to eql( @report.param( :start_date ).value )
+          expect( @report.stop_date ).to eql( @report.param( :stop_date ).value )
+        end
+
+        it 'has a first_period accessor' do
+          expected = ReportCat::DateRange.range( @report.period, @report.start_date, @report.stop_date ).first
+          expect( @report.first_period ).to eql( expected )
+        end
+
+      end
+
+    end
+
+  end
+end

data/spec/lib/report_cat/version_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'version' do
+
+  it 'has a version constant' do
+    expect( ReportCat::VERSION ).to_not be_nil
+    expect( ReportCat::VERSION ).to be_an_instance_of( String )
+    expect( ReportCat::VERSION ).to match( /\d+\.\d+\.\d+/ )
+  end
+
+end

data/spec/lib/report_cat_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+include ReportCat
+
+describe ReportCat do
+
+  it 'requires the engine' do
+    expect( ReportCat::Engine ).to_not be_nil
+  end
+
+  it 'defines the ReportCat module' do
+    expect( ReportCat ).to_not be_nil
+  end
+
+  #############################################################################
+  # config
+
+  describe '::config' do
+
+    it 'returns the configuration' do
+      expect( ReportCat.config ).to be_an_instance_of( ReportCat::Config )
+    end
+
+  end
+
+  #############################################################################
+  # configure
+
+  describe '::configure' do
+
+    it 'yields the configuration' do
+      yielded = false
+      ReportCat.configure do |config|
+        expect( config ).to be_an_instance_of( ReportCat::Config )
+        yielded = true
+      end
+      expect( yielded ).to be( true )
+    end
+
+  end
+
+  #############################################################################
+  # reports
+
+  describe '::reports' do
+
+    it 'returns a HashWithIndifferentAccess' do
+      expect( ReportCat.reports ).to be_an_instance_of( HashWithIndifferentAccess )
+    end
+
+    it 'adds Report subclasses to the hash' do
+      reports = ReportCat.reports
+
+      Report.descendants.each do |klass|
+        report = klass.new
+        expect( reports[ report.name.to_sym ] ).to_not be_nil
+      end
+    end
+
+  end
+
+end

data/spec/lib/tasks/report_cat.rake_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'rake'
+
+describe 'rake_cat rake tasks' do
+
+  before( :each ) do
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    Rake::Task.define_task(:environment)
+    load 'lib/tasks/rake_cat.rake'
+  end
+
+end

data/spec/models/report_cat/date_range_spec.rb

@@ -0,0 +1,144 @@
+require 'spec_helper'
+
+module ReportCat
+
+  describe DateRange do
+
+    before( :each ) do
+      @period = :daily
+      @start_date = Date.civil( 2013, 9, 15 )
+      @stop_date = Date.civil( 2013, 9, 18 )
+    end
+
+    #############################################################################
+    # ::generate
+
+    describe '::generate' do
+
+      it 'iterates the periods in the date range' do
+        expect( DateRange ).to receive( :iterate ).with( @period, @start_date, @stop_date )
+        DateRange.generate( @period, @start_date, @stop_date )
+      end
+
+      it 'creates entries for each period' do
+        expected = ( @stop_date - @start_date ).to_i + 1
+
+        expect( DateRange.count ).to eql( 0 )
+        DateRange.generate( @period, @start_date, @stop_date )
+        expect( DateRange.count ).to eql( expected )
+
+        (@start_date..@stop_date).each do |date|
+          date_range = DateRange.where( :period => @period, :start_date => date, :stop_date => date ).first
+          expect( date_range ).to be_present
+          expect( date_range.period ).to eql( @period.to_s )
+          expect( date_range.start_date ).to eql( date )
+          expect( date_range.stop_date ).to eql( date )
+        end
+      end
+
+      it 'does not create entries that already exist' do
+        DateRange.generate( @period, @start_date, @stop_date )
+        expect( DateRange ).to_not receive( :create )
+        DateRange.generate( @period, @start_date, @stop_date )
+      end
+
+    end
+
+    #############################################################################
+    # ::iterate
+
+    describe '::iterate' do
+
+      it 'iterates the requests date range and yields the start and stop times for each period' do
+        expected = @stop_date - @start_date + 1
+        expect { |b| DateRange.iterate( @period, @start_date, @stop_date, &b) }.to yield_control.exactly( expected ).times
+      end
+
+      it 'iterates daily' do
+        expect { |b| DateRange.iterate( :daily, '2013-01-01', '2013-12-31', &b) }.to yield_control.exactly( 365 ).times
+      end
+
+      it 'iterates weekly' do
+        expect { |b| DateRange.iterate( :weekly, '2013-01-01', '2013-12-31', &b) }.to yield_control.exactly( 53 ).times
+      end
+
+      it 'iterates monthly' do
+        expect { |b| DateRange.iterate( :monthly, '2013-01-01', '2013-12-31', &b) }.to yield_control.exactly( 12 ).times
+      end
+
+      it 'iterates quarterly' do
+        expect { |b| DateRange.iterate( :quarterly, '2013-01-01', '2013-12-31', &b) }.to yield_control.exactly( 4 ).times
+      end
+
+      it 'iterates yearly' do
+        expect { |b| DateRange.iterate( :yearly, '2013-01-01', '2013-12-31', &b) }.to yield_control.exactly( 1 ).times
+      end
+
+      it 'raises an except for an unknown period' do
+        expect { |b| DateRange.iterate( :hourly, '2013-01-01', '2013-12-31', &b) }.to raise_error( 'Unknown date range: hourly' )
+      end
+
+    end
+
+    #############################################################################
+    # ::join_*
+
+    describe 'joins' do
+
+      before( :each ) do
+        @table = 'users'
+        @column = 'created_at'
+      end
+
+      describe '::join_to' do
+
+        it 'generates a join string' do
+          expected = "join users on date( users.created_at ) between report_cat_date_ranges.start_date and report_cat_date_ranges.stop_date"
+          expect( DateRange.join_to( @table, @column ) ).to eql( expected )
+        end
+
+      end
+
+      describe '::join_before' do
+
+        it 'generates a join string' do
+          expected = "join users on date( users.created_at ) <= report_cat_date_ranges.stop_date"
+          expect( DateRange.join_before( @table, @column ) ).to eql( expected )
+        end
+
+      end
+
+      describe '::join_after' do
+
+        it 'generates a join string' do
+          expected = "join users on date( users.created_at ) > report_cat_date_ranges.stop_date"
+          expect( DateRange.join_after( @table, @column ) ).to eql( expected )
+        end
+
+      end
+
+    end
+
+    #############################################################################
+    # ::sql_*
+
+    describe '::sql_intersect' do
+
+      it 'generates date intersection sql' do
+        expect( DateRange.sql_intersect( '2013-09-01', '2013-09-18' ) ).to eql_file( 'spec/data/models/sql_intersect.sql')
+      end
+
+    end
+
+    describe '::sql_period' do
+
+      it 'generate query sql' do
+        expected = "report_cat_date_ranges.period = 'weekly'"
+        expect( DateRange.sql_period( :weekly ) ).to eql( expected )
+      end
+
+    end
+
+  end
+
+end

data/spec/rails_helper.rb

@@ -0,0 +1,49 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+
+
+require 'spec_helper'
+require File.expand_path('../dummy/config/environment', __FILE__)
+require 'rspec/rails'
+
+
+ENGINE_ROOT = File.join(File.dirname(__FILE__), '..')
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(ENGINE_ROOT, 'spec/support/**/*.rb')].each {|f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  #  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  # config.infer_base_class_for_anonymous_controllers = false
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'spec_cat'
+
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+]
+
+SimpleCov.start 'rails' do
+  add_filter '/vendor/'
+  add_filter '/spec/'
+end
+
+RSpec.configure do |config|
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/setup_reports.rb

@@ -0,0 +1,28 @@
+module SetupReports
+
+  include ReportCat::Core
+
+  def setup_reports
+    @report = Report.new( :name => :test )
+
+    @report.add_param( :check_box_test, :check_box, false )
+    @report.add_param( :date_test, :date, Date.civil( 2013, 9, 16 ) )
+    @report.add_param( :hidden_test, :check_box, true, :hidden => true )
+    @report.add_param( :select_test, :select, 1, :values => [ 1, 2, 3 ] )
+    @report.add_param( :text_field_test, :text_field )
+
+    @report.add_column( :day, :date )
+    @report.add_column( :total, :integer )
+
+    @report.add_chart( :pie_test, :pie, :day, :total )
+    @report.add_chart( :bar_test, :bar, :day, :total )
+    @report.add_chart( :line_test, :line, :day, :total )
+
+    @report.rows[ 0 ] = [ '2013-09-17', 27 ]
+    @report.rows[ 1 ] = [ '2013-09-18', 270 ]
+
+    @reports = HashWithIndifferentAccess.new
+    @reports[ @report.name.to_sym ] = @report
+  end
+
+end

data/spec/views/report_cat/reports/index.html.erb_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe 'report_cat/reports/index.html.erb' do
+
+  include SetupReports
+
+  before( :each ) do
+    setup_reports
+  end
+
+  it 'renders without exception' do
+    assign( :reports, @reports )
+    render
+  end
+
+end