reports_kits 0.7.5 → 0.7.7

data/spec/reports_kit/reports/data/normalize_properties_spec.rb

@@ -0,0 +1,196 @@
+require 'spec_helper'
+
+describe ReportsKit::Reports::Data::NormalizeProperties do
+  describe '#perform' do
+    let(:normalized_properties) { described_class.new(properties).perform }
+    let(:series) { normalized_properties[:series] }
+    let(:context_params) { { foo: 'bar' } }
+    let(:name) { 'Foo' }
+
+    context 'without a series key' do
+      let(:properties) do
+        {
+          measure: 'issue',
+          dimensions: %w(opened_at)
+        }
+      end
+
+      it 'normalizes' do
+        expect(series).to eq([properties])
+      end
+    end
+
+    context 'with a series key' do
+      let(:properties) do
+        {
+          series: {
+            measure: 'issue',
+            dimensions: %w(opened_at)
+          }
+        }
+      end
+
+      it 'normalizes' do
+        expect(series).to eq([properties[:series]])
+      end
+    end
+
+    context 'with a series array and context_params' do
+      let(:properties) do
+        {
+          series: [{
+            measure: 'issue',
+            dimensions: %w(opened_at)
+          }],
+          context_params: context_params
+        }
+      end
+
+      it 'normalizes' do
+        expect(series).to eq([{
+          measure: 'issue',
+          dimensions: %w(opened_at),
+          context_params: context_params
+        }])
+      end
+    end
+
+    context 'with a composite series and context_params' do
+      let(:properties) do
+        {
+          name: name,
+          composite_operator: '%',
+          series: [
+            {
+              measure: 'issue',
+              dimensions: %w(created_at)
+            },
+            {
+              measure: 'tag',
+              dimensions: %w(created_at)
+            }
+          ],
+          context_params: context_params
+        }
+      end
+
+      it 'copies the context_params to the series' do
+        expect(normalized_properties).to eq({
+          name: name,
+          composite_operator: '%',
+          series: [
+            {
+              measure: 'issue',
+              dimensions: %w(created_at),
+              context_params: context_params
+            },
+            {
+              measure: 'tag',
+              dimensions: %w(created_at),
+              context_params: context_params
+            }
+          ],
+          context_params: context_params
+        })
+      end
+    end
+
+    context 'with a composite series and context_params' do
+      let(:properties) do
+        {
+          series: [
+            {
+              name: name,
+              composite_operator: '+',
+              series: [
+                {
+                  measure: 'issue',
+                  dimensions: %w(created_at)
+                }
+              ]
+            }
+          ],
+          context_params: context_params
+        }
+      end
+
+      it 'copies the context_params to the series' do
+        expect(normalized_properties).to eq({
+          series: [
+            {
+              name: name,
+              composite_operator: '+',
+              series: [
+                {
+                  measure: 'issue',
+                  dimensions: %w(created_at),
+                  context_params: context_params
+                }
+              ],
+              context_params: context_params
+            }
+          ],
+          context_params: context_params
+        })
+      end
+    end
+
+    context 'with a composite series, a series, and context_params' do
+      let(:properties) do
+        {
+          series: [
+            {
+              measure: 'issue',
+              dimensions: %w(opened_at)
+            },
+            {
+              name: name,
+              composite_operator: '%',
+              series: [
+                {
+                  measure: 'issue',
+                  dimensions: %w(created_at)
+                },
+                {
+                  measure: 'tag',
+                  dimensions: %w(created_at)
+                }
+              ]
+            }
+          ],
+          context_params: context_params
+        }
+      end
+
+      it 'copies the context_params to the series' do
+        expect(normalized_properties).to eq({
+          series: [
+            {
+              measure: 'issue',
+              dimensions: %w(opened_at),
+              context_params: context_params
+            },
+            {
+              name: name,
+              composite_operator: '%',
+              series: [
+                {
+                  measure: 'issue',
+                  dimensions: %w(created_at),
+                  context_params: context_params
+                },
+                {
+                  measure: 'tag',
+                  dimensions: %w(created_at),
+                  context_params: context_params
+                }
+              ],
+              context_params: context_params
+            }
+          ],
+          context_params: context_params
+        })
+      end
+    end
+  end
+end

data/spec/reports_kit/reports/dimension_with_series_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe ReportsKit::Reports::DimensionWithSeries do
+  subject { described_class.new(dimension: dimension, series: series) }
+  let(:dimension) { ReportsKit::Reports::Dimension.new(properties) }
+  let(:series) { ReportsKit::Reports::Series.new(measure: 'issue', dimensions: [properties]) }
+
+  describe 'settings' do
+    context 'with a datetime dimension' do
+      let(:properties) { 'opened_at' }
+
+      it 'returns the settings' do
+        expect(subject.settings).to eq({ column: 'issues.opened_at', group: database_adapter.truncate_to_week('issues.opened_at') })
+      end
+    end
+
+    context 'with a string dimension' do
+      let(:properties) { 'title' }
+
+      it 'returns the settings' do
+        expect(subject.settings).to eq({ column: 'issues.title', group: 'issues.title' })
+      end
+    end
+
+    context 'with a text dimension' do
+      let(:properties) { 'description' }
+
+      it 'returns the settings' do
+        expect(subject.settings).to eq({ column: 'issues.description', group: 'issues.description' })
+      end
+    end
+
+    context 'with a belongs_to association dimension' do
+      let(:properties) { 'repo' }
+
+      it 'returns the settings' do
+        expect(subject.settings).to eq({ column: 'issues.repo_id', group: 'issues.repo_id' })
+      end
+    end
+
+    context 'with a has_many association dimension' do
+      let(:properties) { 'tags' }
+
+      it 'returns the settings' do
+        expect(subject.settings).to eq({ joins: :tags, column: 'tags.id', group: 'issues.issue_id' })
+      end
+    end
+
+    context 'with a has_many :through association dimension' do
+      let(:properties) { 'labels' }
+
+      it 'returns the settings' do
+        expect(subject.settings).to eq({ joins: :issues_labels, column: 'issues_labels.label_id', group: 'issues_labels.label_id' })
+      end
+    end
+
+    describe ':key_to_label setting' do
+      context 'with a Proc' do
+        let(:properties) { 'titleized_state' }
+
+        it 'returns the result of the Proc' do
+          expect(subject.key_to_label('foo')).to eq('Foo')
+        end
+      end
+    end
+  end
+end

data/spec/reports_kit/reports/filter_with_series_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe ReportsKit::Reports::FilterWithSeries do
+  subject { described_class.new(filter: filter, series: series) }
+  let(:filter) { ReportsKit::Reports::Filter.new(properties) }
+  let(:series) { ReportsKit::Reports::Series.new(measure: 'issue', dimensions: %w(repo)) }
+
+  context 'with a datetime filter' do
+    let(:properties) { 'opened_at' }
+
+    it 'returns the settings' do
+      expect(subject.settings).to eq({ column: 'issues.opened_at' })
+    end
+  end
+
+  context 'with a belongs_to association filter' do
+    let(:properties) { 'repo' }
+
+    it 'returns the settings' do
+      expect(subject.settings).to eq({ column: 'issues.repo_id' })
+    end
+  end
+
+  context 'with a has_many association filter' do
+    let(:properties) { 'tags' }
+
+    it 'returns the settings' do
+      expect(subject.settings).to eq({ joins: :tags, column: 'tags.id' })
+    end
+  end
+
+  context 'with a has_many :through association filter' do
+    let(:properties) { 'labels' }
+
+    it 'returns the settings' do
+      expect(subject.settings).to eq({ joins: :issues_labels, column: 'issues_labels.label_id' })
+    end
+  end
+end

data/spec/reports_kit/reports/generate_autocomplete_results_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe ReportsKit::Reports::GenerateAutocompleteResults do
+  subject { described_class.new(params, properties).perform }
+  let!(:repo) { create(:repo) }
+  let!(:repo2) { create(:repo) }
+  let!(:issues) do
+    [
+      create(:issue, repo: repo, opened_at: now - 2.weeks),
+      create(:issue, repo: repo2, opened_at: now - 2.weeks),
+      create(:issue, repo: repo, opened_at: now)
+    ]
+  end
+
+  context 'with valid params' do
+    let(:params) { { key: 'repo' } }
+    let(:properties) do
+      {
+        measure: 'issue',
+        filters: %w(repo),
+        dimensions: %w(opened_at)
+      }
+    end
+
+    it 'returns the results' do
+      expect(subject).to match_array([
+        { id: repo.id, text: repo.to_s },
+        { id: repo2.id, text: repo2.to_s }
+      ])
+    end
+  end
+
+  context 'with a contextual_filter' do
+    context 'with context_params' do
+      let(:params) { { key: 'repo', context_params: { repo_id: repo.id } } }
+      let(:properties) do
+        {
+          measure: 'issue',
+          filters: [{ key: 'repo', contextual_filters: %w(for_repo) }],
+          dimensions: %w(opened_at)
+        }
+      end
+
+      it 'returns the results' do
+        expect(subject).to match_array([
+          { id: repo.id, text: repo.to_s }
+        ])
+      end
+    end
+
+    context 'without context_params' do
+      let(:params) { { key: 'repo' } }
+      let(:properties) do
+        {
+          measure: 'issue',
+          filters: [{ key: 'repo', contextual_filters: %w(for_repo) }],
+          dimensions: %w(opened_at)
+        }
+      end
+
+      it 'returns the results' do
+        expect(subject).to match_array([
+          { id: repo.id, text: repo.to_s },
+          { id: repo2.id, text: repo2.to_s }
+        ])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,77 @@
+require 'reports_kit'
+
+require 'database_cleaner'
+require 'groupdate'
+require 'pry'
+require 'pry-byebug'
+require 'timecop'
+require 'support/factory_girl'
+require 'support/helpers'
+
+Time.zone = ActiveSupport::TimeZone.new('UTC')
+ActiveRecord::Base.default_timezone = :utc
+
+if Gem.loaded_specs.key?('mysql2')
+  REPORTS_KIT_DATABASE_ADAPTER = ReportsKit::Reports::Adapters::Mysql
+  REPORTS_KIT_DATABASE_TYPE = :mysql
+  ActiveRecord::Base.establish_connection(
+    adapter: 'mysql2',
+    host: ENV['MYSQL_HOST'] || 'localhost',
+    database: 'reports_kit_test',
+    username: 'root'
+  )
+else
+  REPORTS_KIT_DATABASE_ADAPTER = ReportsKit::Reports::Adapters::Postgresql
+  REPORTS_KIT_DATABASE_TYPE = :postgresql
+  ActiveRecord::Base.establish_connection(
+    adapter: 'postgresql',
+    host: ENV['POSTGRESQL_HOST'] || 'localhost',
+    database: 'reports_kit_test',
+    username: 'postgres'
+  )
+end
+directory = File.dirname(File.absolute_path(__FILE__))
+Dir.glob("#{directory}/support/models/*.rb") { |file| require file }
+Dir.glob("#{directory}/support/models/**/*.rb") { |file| require file }
+Dir.glob("#{directory}/factories/*.rb") { |file| require file }
+
+require 'support/config'
+require 'support/example_data_methods'
+require 'support/schema'
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # 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'
+
+  TIMECOP_TIME = Time.utc(2010)
+  config.before(:each) do
+    Timecop.freeze(TIMECOP_TIME)
+  end
+  config.after(:each) do
+    Timecop.return
+  end
+
+  config.before(:suite) do
+    # To support multi-threaded ActiveRecord queries, we need to use :truncation instead of :transaction.
+    DatabaseCleaner.strategy = [:truncation, pre_count: true]
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+
+  config.include Helpers
+end

data/spec/support/config.rb

@@ -0,0 +1,41 @@
+ReportsKit.configure do |config|
+  config.custom_methods = {
+    format_percentage: -> (value) { "#{value.round(0)}%" },
+    add_label_link: -> (data:, properties:, context_record:) {
+      data[:entities].each do |entity|
+        entity.label = "<a href='#'>#{entity.label}</a> Bar" if entity.label
+      end
+      data
+    },
+    add_label_suffix: -> (data:, properties:, context_record:) {
+      data[:entities].each do |entity|
+        entity.label = "#{entity.label} Foo" if entity.label
+      end
+      data
+    },
+    add_context_record_suffix: -> (data:, properties:, context_record:) {
+      data[:entities].each do |entity|
+        entity.label = "#{entity.label} #{context_record}" if entity.label
+      end
+      data
+    },
+    empty_result_set_for_relation: -> (relation) {
+      relation.where('0 = 1')
+    },
+    prepend_column: -> (data:, properties:, context_record:) {
+      values = data[:entities].map do |entity|
+        value = entity.instance.is_a?(Date) ? entity.instance.mday : nil
+        ReportsKit::Value.new(value, value)
+      end
+      new_dataset = {
+        entity: ReportsKit::Entity.new('day_of_month', 'Day of Month', 'day_of_month'),
+        values: values
+      }
+      data[:datasets] = [new_dataset] + data[:datasets]
+      data
+    },
+    all_repo_ids: -> (dimension_keys:, properties:, context_record:) {
+      Repo.pluck(:id)
+    }
+  }
+end

data/spec/support/example_data_methods.rb

@@ -0,0 +1,25 @@
+class ExampleDataMethods
+  def self.issues_by_opened_at(properties)
+    Issue.group_by_week(:opened_at).count.map { |date, count| [format_date(date), count] }
+  end
+
+  def self.issues_by_opened_at_and_repo(properties)
+    Issue.group_by_week(:opened_at).joins(:repo).group('repos.full_name').count.map do |(date, name), count|
+      [[format_date(date), name], count]
+    end
+  end
+
+  def self.issues_by_opened_at_with_filters(properties)
+    format = properties[:format]
+    ui_filters = properties[:ui_filters]
+    issues = Issue.group_by_week(:opened_at)
+    issues = issues.where(state: ui_filters[:state]) if ui_filters.try(:[], :state).present?
+    dates_issue_counts = issues.count.map { |date, count| [format_date(date), count] }
+    return dates_issue_counts unless format == 'table'
+    [['Date', 'Issue count']] + dates_issue_counts
+  end
+
+  def self.format_date(date)
+    date.strftime('%b %-d, \'%y')
+  end
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,5 @@
+require 'factory_girl'
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/helpers.rb

@@ -0,0 +1,25 @@
+module Helpers
+  def now
+    Time.zone.now
+  end
+
+  def database_adapter
+    REPORTS_KIT_DATABASE_ADAPTER
+  end
+
+  def format_configuration_time(time)
+    ReportsKit::Reports::Data::Utils.format_configuration_time(time)
+  end
+
+  def format_csv_week_offset(week_offset)
+    ReportsKit::Reports::Data::Utils.format_csv_time((now - week_offset.weeks).beginning_of_week(ReportsKit.configuration.first_day_of_week))
+  end
+
+  def format_day_offset(day_offset)
+    ReportsKit::Reports::Data::Utils.format_display_time((now - day_offset.days))
+  end
+
+  def format_week_offset(week_offset)
+    ReportsKit::Reports::Data::Utils.format_display_time((now - week_offset.weeks).beginning_of_week(ReportsKit.configuration.first_day_of_week))
+  end
+end

data/spec/support/models/issue.rb

@@ -0,0 +1,14 @@
+class Issue < ActiveRecord::Base
+  include ReportsKit::Model
+
+  belongs_to :repo
+  has_many :issues_labels
+  has_many :labels, through: :issues_labels
+  has_many :tags
+
+  reports_kit do
+    aggregation :average_duration, [:average, REPORTS_KIT_DATABASE_TYPE == :mysql ? 'DATEDIFF(closed_at, opened_at)' : '(closed_at::date - opened_at::date)']
+    contextual_filter :for_repo, ->(relation, context_params) { context_params ? relation.where(repo_id: context_params[:repo_id]) : relation }
+    dimension :titleized_state, group: 'issues.state', key_to_label: -> (state) { state.try(:titleize) }
+  end
+end

data/spec/support/models/issues_label.rb

@@ -0,0 +1,4 @@
+class IssuesLabel < ActiveRecord::Base
+  belongs_to :issue
+  belongs_to :label
+end

data/spec/support/models/label.rb

@@ -0,0 +1,5 @@
+class Label < ActiveRecord::Base
+  belongs_to :repo
+  has_many :issues_labels
+  has_many :issues, through: :issues_labels
+end

data/spec/support/models/pro/repo.rb

@@ -0,0 +1,5 @@
+module Pro
+  class Repo < ::Repo
+    has_many :special_issues
+  end
+end

data/spec/support/models/pro/special_issue.rb

@@ -0,0 +1,4 @@
+module Pro
+  class SpecialIssue < ::Issue
+  end
+end

data/spec/support/models/repo.rb

@@ -0,0 +1,13 @@
+class Repo < ActiveRecord::Base
+  include ReportsKit::Model
+
+  has_many :issues
+
+  reports_kit do
+    contextual_filter :for_repo, ->(relation, context_params) { context_params ? relation.where(id: context_params[:repo_id]) : relation }
+  end
+
+  def to_s
+    full_name
+  end
+end

data/spec/support/models/tag.rb

@@ -0,0 +1,4 @@
+class Tag < ActiveRecord::Base
+  belongs_to :repo
+  belongs_to :issue
+end

data/spec/support/schema.rb

@@ -0,0 +1,39 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :issues, :force => :cascade do |t|
+    t.integer  :repo_id
+    t.string   :title
+    t.text     :description
+    t.integer  :source_user_id
+    t.string   :state
+    t.boolean  :locked
+    t.datetime :opened_at
+    t.datetime :closed_at
+    t.timestamps
+  end
+
+  create_table :issues_labels, force: :cascade do |t|
+    t.integer  :issue_id
+    t.integer  :label_id
+    t.timestamps
+  end
+
+  create_table :labels, force: :cascade do |t|
+    t.integer  :repo_id
+    t.string   :name
+    t.timestamps
+  end
+
+  create_table :repos, :force => :cascade do |t|
+    t.string   :full_name
+    t.timestamps
+  end
+
+  create_table :tags, force: :cascade do |t|
+    t.integer  :repo_id
+    t.integer  :issue_id
+    t.string   :name
+    t.timestamps
+  end
+end