reports_kit 0.1.0 → 0.2.0

data/spec/reports_kit/relative_time_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe ReportsKit::RelativeTime do
+  subject { described_class.parse(string) }
+
+  Timecop.freeze(TIMECOP_TIME) do
+    STRINGS_EXPECTED_VALUES = {
+      '2s' => 2.seconds.from_now,
+      '-3s' => 3.seconds.ago,
+      '4m' => 4.minutes.from_now,
+      '5h' => 5.hours.from_now,
+      '-6d' => 6.days.ago,
+      '7w' => 7.weeks.from_now,
+      '8M' => 8.months.from_now,
+      '9y' => 9.years.from_now,
+      '-2M1w' => (2.months + 1.week).ago
+    }
+  end
+
+  STRINGS_EXPECTED_VALUES.each do |string, expected_value|
+    context string do
+      let(:string) { string }
+
+      it 'transforms the filter criteria' do
+        expect(subject).to eq(expected_value)
+      end
+    end
+  end
+end

data/spec/reports_kit/report_builder_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe ReportsKit::ReportBuilder do
+  subject { described_class.new(properties) }
+
+  context 'with a datetime dimension' do
+    let(:properties) do
+      {
+        measure: {
+          key: 'issue',
+          filters: [
+            {
+              key: 'opened_at',
+              criteria: {
+                operator: 'between',
+                value: '-1w - now'
+              }
+            }
+          ]
+        }
+      }
+    end
+
+    it 'transforms the filter criteria' do
+      expect(subject.date_range('opened_at')).to include("#{format_criteria_time(1.week.ago)} - #{format_criteria_time(Time.zone.now)}")
+    end
+  end
+end

data/spec/reports_kit/reports/data/generate_spec.rb

@@ -13,6 +13,9 @@ describe ReportsKit::Reports::Data::Generate do
     end
     chart_data
   end
+  let(:table_data) do
+    subject[:table_data]
+  end
 
   let(:chart_type) { subject[:type] }
   let(:chart_options) { subject[:chart_data][:options] }
@@ -21,8 +24,10 @@ describe ReportsKit::Reports::Data::Generate do
     context 'with default granularity' do
       let(:properties) do
         {
-          measure: 'issue',
-          dimensions: %w(opened_at)
+          measure: {
+            key: 'issue',
+            dimensions: %w(opened_at)
+          }
         }
       end
       let!(:issues) do
@@ -63,12 +68,12 @@ describe ReportsKit::Reports::Data::Generate do
                   key: 'opened_at',
                   criteria: {
                     operator: 'between',
-                    value: "#{date_string_for_filter(now - 1.week)} - #{date_string_for_filter(now)}"
+                    value: "#{format_criteria_time(now - 1.week)} - #{format_criteria_time(now)}"
                   }
                 }
-              ]
-            },
-            dimensions: %w(opened_at)
+              ],
+              dimensions: %w(opened_at)
+            }
           }
         end
 
@@ -83,14 +88,95 @@ describe ReportsKit::Reports::Data::Generate do
             ]
           })
         end
+
+        context 'with zero results' do
+          let(:properties) do
+            {
+              measure: {
+                key: 'tag',
+                filters: [
+                  {
+                    key: 'created_at',
+                    criteria: {
+                      operator: 'between',
+                      value: "#{format_criteria_time(now - 1.week)} - #{format_criteria_time(now)}"
+                    }
+                  }
+                ],
+                dimensions: %w(created_at)
+              }
+            }
+          end
+
+          it 'returns the data' do
+            expect(chart_data).to eq({
+              labels: [
+                format_week_offset(1),
+                format_week_offset(0)
+              ],
+              datasets: [
+                {
+                  label: 'Tags',
+                  data: [0, 0]
+                }
+              ]
+            })
+          end
+        end
+
+        context 'with multiple measures and datetime filters with different keys' do
+          let!(:tags) do
+            [
+              create(:tag, repo: repo, created_at: now - 1.weeks),
+              create(:tag, repo: repo, created_at: now)
+            ]
+          end
+          let(:properties) do
+            {
+              measures: [
+                {
+                  key: 'issue',
+                  filters: %w(opened_at),
+                  dimensions: %w(opened_at)
+                },
+                {
+                  key: 'tag',
+                  filters: %w(created_at),
+                  dimensions: %w(created_at)
+                }
+              ],
+              ui_filters: {
+                created_at: "#{format_criteria_time(now - 1.week)} - #{format_criteria_time(now)}"
+              }
+            }
+          end
+
+          it 'returns the chart_data' do
+            expect(chart_data).to eq({
+              labels: [format_week_offset(2), format_week_offset(1), format_week_offset(0)],
+              datasets: [
+                {
+                  label: "Issues",
+                  data: [2, 0, 1]
+                },
+                {
+                  label: "Tags",
+                  data: [0, 1, 1]
+                }
+              ]
+            })
+          end
+        end
       end
     end
 
     context 'with day granularity' do
       let(:properties) do
         {
-          measure: 'issue',
-          dimensions: [{ key: 'opened_at', granularity: 'day' }]
+          measure: {
+            key: 'issue',
+            dimensions: [{ key: 'opened_at', granularity: 'day' }]
+          }
         }
       end
       let!(:issues) do
@@ -121,8 +207,10 @@ describe ReportsKit::Reports::Data::Generate do
   context 'with an association dimension' do
     let(:properties) do
       {
-        measure: 'issue',
-        dimensions: %w(repo)
+        measure: {
+          key: 'issue',
+          dimensions: %w(repo)
+        }
       }
     end
     let!(:issues) do
@@ -151,6 +239,51 @@ describe ReportsKit::Reports::Data::Generate do
       end
     end
 
+    context 'with a dimension limit' do
+      let(:properties) do
+        {
+          measure: {
+            key: 'issue',
+            dimensions: [{ key: 'repo', limit: 1 }]
+          }
+        }
+      end
+
+      it 'returns the chart_data' do
+        expect(chart_data).to eq({
+          labels: [repo.to_s],
+          datasets: [{ label: 'Issues', data: [2] }]
+        })
+      end
+    end
+
+    context 'with a custom aggregation' do
+      let(:properties) do
+        {
+          measure: {
+            key: 'issue',
+            name: 'Average Durations',
+            aggregation: 'average_duration',
+            dimensions: %w(repo)
+          }
+        }
+      end
+      let!(:issues) do
+        [
+          create(:issue, repo: repo, opened_at: now, closed_at: now),
+          create(:issue, repo: repo, opened_at: now - 2.weeks, closed_at: now),
+          create(:issue, repo: repo2, opened_at: now - 2.weeks, closed_at: now)
+        ]
+      end
+
+      it 'returns the chart_data' do
+        expect(chart_data).to eq({
+          labels: [repo2.to_s, repo.to_s],
+          datasets: [{ label: 'Average Durations', data: [14, 7] }]
+        })
+      end
+    end
+
     context 'with a belongs_to association filter' do
       let(:properties) do
         {
@@ -164,9 +297,9 @@ describe ReportsKit::Reports::Data::Generate do
                   value: [repo.id]
                 }
               }
-            ]
-          },
-          dimensions: %w(repo)
+            ],
+            dimensions: %w(repo)
+          }
         }
       end
 
@@ -191,9 +324,9 @@ describe ReportsKit::Reports::Data::Generate do
                   value: [tag.id]
                 }
               }
-            ]
-          },
-          dimensions: %w(repo)
+            ],
+            dimensions: %w(repo)
+          }
         }
       end
       let(:tag) { create(:tag) }
@@ -223,9 +356,9 @@ describe ReportsKit::Reports::Data::Generate do
                   value: [label.id]
                 }
               }
-            ]
-          },
-          dimensions: %w(repo)
+            ],
+            dimensions: %w(repo)
+          }
         }
       end
       let(:label) { create(:label) }
@@ -242,11 +375,41 @@ describe ReportsKit::Reports::Data::Generate do
     end
   end
 
+  context 'with a boolean dimension' do
+    let(:properties) do
+      {
+        measure: {
+          key: 'issue',
+          dimensions: %w(locked)
+        }
+      }
+    end
+    let!(:issues) do
+      [
+        create(:issue, locked: true),
+        create(:issue, locked: false),
+        create(:issue, locked: false)
+      ]
+    end
+
+    it 'returns the chart_data' do
+      expect(chart_data).to eq({
+        labels: ['false', 'true'],
+        datasets: [{ label: 'Issues', data: [2, 1] }]
+      })
+    end
+  end
+
   context 'with datetime and association dimensions' do
     let(:properties) do
       {
-        measure: 'issue',
-        dimensions: %w(opened_at repo)
+        measure: {
+          key: 'issue',
+          dimensions: [
+            { key: 'opened_at', label: nil },
+            { key: 'repo' }
+          ]
+        }
       }
     end
     let!(:issues) do
@@ -272,32 +435,456 @@ describe ReportsKit::Reports::Data::Generate do
         ]
       })
     end
+
+    context "with format: 'table'" do
+      subject { described_class.new(properties.merge(format: 'table'), context_record: context_record).perform }
+
+      it 'returns the table_data' do
+        expect(table_data).to eq([
+          [nil, repo.to_s, repo2.to_s],
+          [format_week_offset(2), 1, 0],
+          [format_week_offset(1), 0, 0],
+          [format_week_offset(0), 1, 1]
+        ])
+      end
+    end
+
+    context "with a data_format_method" do
+      subject { described_class.new(properties.merge(data_format_method: 'add_label_suffix'), context_record: context_record).perform }
+
+      it 'returns the chart_data' do
+        expect(chart_data).to eq({
+          labels: ["#{format_week_offset(2)} Foo", "#{format_week_offset(1)} Foo", "#{format_week_offset(0)} Foo"],
+          datasets: [
+            {
+              label: repo.to_s,
+              data: [1, 0, 1]
+            },
+            {
+              label: repo2.to_s,
+              data: [0, 0, 1]
+            }
+          ]
+        })
+      end
+    end
+  end
+
+  context 'with two measures' do
+    let(:properties) do
+      {
+        measures: [
+          {
+            key: 'issue',
+            dimensions: [{ key: 'created_at', label: nil }]
+          },
+          {
+            key: 'tag',
+            dimensions: %w(created_at)
+          },
+        ]
+      }
+    end
+    let!(:issues) do
+      [
+        create(:issue, repo: repo, created_at: now),
+        create(:issue, repo: repo, created_at: now - 2.weeks),
+        create(:issue, repo: repo2, created_at: now)
+      ]
+    end
+    let!(:tags) do
+      [
+        create(:tag, repo: repo, created_at: now - 1.week),
+        create(:tag, repo: repo, created_at: now - 2.weeks)
+      ]
+    end
+
+    it 'returns the chart_data' do
+      expect(chart_data).to eq({
+        labels: [format_week_offset(2), format_week_offset(1), format_week_offset(0)],
+        datasets: [
+          {
+            label: 'Issues',
+            data: [1, 0, 2]
+          },
+          {
+            label: 'Tags',
+            data: [1, 1, 0]
+          }
+        ]
+      })
+    end
+
+    context "with format: 'table'" do
+      subject { described_class.new(properties.merge(format: 'table'), context_record: context_record).perform }
+
+      it 'returns the table_data' do
+        expect(table_data).to eq([
+          [nil, 'Issues', 'Tags'],
+          [format_week_offset(2), 1, 1],
+          [format_week_offset(1), 0, 1],
+          [format_week_offset(0), 2, 0]
+        ])
+      end
+    end
+  end
+
+  context 'with two dimensions' do
+    context 'with a custom aggregation' do
+      let(:properties) do
+        {
+          measure: {
+            key: 'issue',
+            aggregation: 'average_duration',
+            dimensions: %w(repo created_at)
+          }
+        }
+      end
+      let!(:issues) do
+        [
+          create(:issue, repo: repo, opened_at: now, closed_at: now),
+          create(:issue, repo: repo, opened_at: now - 2.weeks, closed_at: now),
+          create(:issue, repo: repo2, opened_at: now - 2.weeks, closed_at: now)
+        ]
+      end
+
+      it 'returns the chart_data' do
+        expect(chart_data).to eq({
+          labels: [repo2.to_s, repo.to_s],
+          datasets: [{ label: format_week_offset(0), data: [14, 7] }]
+        })
+      end
+    end
+  end
+
+  describe 'composite aggregations' do
+    context 'with two measures' do
+      let(:properties) do
+        {
+          name: name,
+          composite_operator: composite_operator,
+          measures: [
+            {
+              key: 'issue',
+              dimensions: %w(created_at)
+            },
+            {
+              key: 'tag',
+              dimensions: %w(created_at)
+            }
+          ]
+        }
+      end
+      let!(:issues) do
+        [
+          create(:issue, repo: repo, created_at: now),
+          create(:issue, repo: repo, created_at: now - 2.weeks),
+          create(:issue, repo: repo2, created_at: now)
+        ]
+      end
+      let!(:tags) do
+        [
+          create(:tag, repo: repo, created_at: now),
+          create(:tag, repo: repo, created_at: now - 1.week),
+          create(:tag, repo: repo, created_at: now - 1.week)
+        ]
+      end
+      let(:name) { 'My Name' }
+
+      context 'with +' do
+        let(:composite_operator) { '+' }
+
+        it 'returns the chart_data' do
+          expect(chart_data).to eq({
+            labels: [format_week_offset(2), format_week_offset(1), format_week_offset(0)],
+            datasets: [
+              {
+                label: name,
+                data: [1, 2, 3]
+              }
+            ]
+          })
+        end
+      end
+
+      context 'with %' do
+        let(:composite_operator) { '%' }
+
+        it 'returns the chart_data' do
+          expect(chart_data).to eq({
+            labels: [format_week_offset(2), format_week_offset(1), format_week_offset(0)],
+            datasets: [
+              {
+                label: name,
+                data: [0, 0, 200]
+              }
+            ]
+          })
+        end
+      end
+
+      context 'with % and a custom value_format_method' do
+        let(:composite_operator) { '%' }
+        let(:properties) do
+          {
+            name: name,
+            composite_operator: composite_operator,
+            value_format_method: 'format_percentage',
+            measures: [
+              {
+                key: 'issue',
+                dimensions: %w(created_at)
+              },
+              {
+                key: 'tag',
+                dimensions: %w(created_at)
+              }
+            ]
+          }
+        end
+
+        it 'returns the chart_data' do
+          expect(chart_data).to eq({
+            labels: [format_week_offset(2), format_week_offset(1), format_week_offset(0)],
+            datasets: [
+              {
+                label: name,
+                data: ['0%', '0%', '200%']
+              }
+            ]
+          })
+        end
+      end
+
+      context 'with a boolean dimension' do
+        let!(:issues) do
+          [
+            create(:issue, locked: true),
+            create(:issue, locked: false),
+            create(:issue, locked: false)
+          ]
+        end
+        let(:composite_operator) { '+' }
+        let(:properties) do
+          {
+            name: name,
+            composite_operator: composite_operator,
+            measures: [
+              {
+                key: 'issue',
+                dimensions: %w(locked)
+              },
+              {
+                key: 'issue',
+                dimensions: %w(locked)
+              }
+            ]
+          }
+        end
+
+        it 'returns the chart_data' do
+          expect(chart_data).to eq({
+            labels: ['false', 'true'],
+            datasets: [
+              {
+                label: name,
+                data: [4, 2]
+              }
+            ]
+          })
+        end
+      end
+
+      context 'with a nested composite aggregation' do
+        let(:properties) do
+          {
+            measures: [
+              {
+                name: name,
+                composite_operator: '+',
+                measures: [
+                  {
+                    key: 'issue',
+                    dimensions: %w(created_at)
+                  },
+                  {
+                    key: 'tag',
+                    dimensions: %w(created_at)
+                  }
+                ]
+              },
+              {
+                key: 'issue',
+                dimensions: %w(created_at)
+              },
+              {
+                key: 'tag',
+                dimensions: %w(created_at)
+              }
+            ]
+          }
+        end
+
+        it 'returns the chart_data' do
+          expect(chart_data).to eq({
+            labels: [format_week_offset(2), format_week_offset(1), format_week_offset(0)],
+            datasets: [
+              {
+                label: name,
+                data: [1, 2, 3]
+              },
+              {
+                label: 'Issues',
+                data: [1, 0, 2]
+              },
+              {
+                label: 'Tags',
+                data: [0, 2, 1]
+              }
+            ]
+          })
+        end
+
+        context 'with ui_filters' do
+          let(:properties) do
+            {
+              measures: [
+                {
+                  name: name,
+                  composite_operator: '+',
+                  measures: [
+                    {
+                      key: 'issue',
+                      filters: %w(created_at),
+                      dimensions: %w(created_at)
+                    },
+                    {
+                      key: 'tag',
+                      filters: %w(created_at),
+                      dimensions: %w(created_at)
+                    }
+                  ]
+                },
+                {
+                  key: 'issue',
+                  filters: %w(created_at),
+                  dimensions: %w(created_at)
+                },
+                {
+                  key: 'tag',
+                  filters: %w(created_at),
+                  dimensions: %w(created_at)
+                }
+              ],
+              ui_filters: {
+                created_at: "#{format_criteria_time(now - 1.week)} - #{format_criteria_time(now)}"
+              }
+            }
+          end
+
+          it 'returns the chart_data' do
+            expect(chart_data).to eq({
+              labels: [format_week_offset(1), format_week_offset(0)],
+              datasets: [
+                {
+                  label: name,
+                  data: [2, 3]
+                },
+                {
+                  label: 'Issues',
+                  data: [0, 2]
+                },
+                {
+                  label: 'Tags',
+                  data: [2, 1]
+                }
+              ]
+            })
+          end
+        end
+
+        context 'with two dimensions' do
+          let(:properties) do
+            {
+              measures: [
+                {
+                  name: name,
+                  composite_operator: '+',
+                  measures: [
+                    {
+                      key: 'issue',
+                      dimensions: %w(created_at repo)
+                    },
+                    {
+                      key: 'tag',
+                      dimensions: %w(created_at repo)
+                    }
+                  ]
+                }
+              ]
+            }
+          end
+
+          it 'returns the chart_data' do
+            expect(chart_data).to eq({
+              labels: [format_week_offset(2), format_week_offset(1), format_week_offset(0)],
+              datasets: [
+                {
+                  label: repo.to_s,
+                  data: [1, 2, 2]
+                },
+                {
+                  label: repo2.to_s,
+                  data: [0, 0, 1]
+                }
+              ]
+            })
+          end
+        end
+      end
+    end
   end
 
   # These examples allow for quick comparisons of many types of inputs and outputs.
   # When making functional modifications, run these to see whether the modifications impact the output in any cases.
   # If the output effects are desired, run `REWRITE_RESULTS=1 rspec` to write them to the outputs YAML file, then verify that the output
   # modifications are desired, then commit the result and uncomment the `skip`.
-  describe 'chart options' do
+  describe 'YAML-based output comparisons' do
     FIXTURES_DIRECTORY = File.expand_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'fixtures'))
 
     let(:inputs) { YAML.load_file("#{FIXTURES_DIRECTORY}/generate_inputs.yml") }
     let(:outputs_path) { "#{FIXTURES_DIRECTORY}/generate_outputs.yml" }
     let(:outputs) { YAML.load_file(outputs_path) }
 
+    let!(:repo) { create(:repo, full_name: 'foo/bar1') }
+    let!(:repo2) { create(:repo, full_name: 'foo/bar2') }
+    let!(:issues) do
+      [
+        create(:issue, repo: repo, state: 'open', opened_at: now - 2.weeks),
+        create(:issue, repo: repo, state: 'closed', opened_at: now)
+      ]
+    end
+    let!(:labels) do
+      [
+        create(:label, repo: repo),
+        create(:label, repo: repo2),
+        create(:label, repo: repo2)
+      ]
+    end
+
     context 'input examples' do
       YAML.load_file("#{FIXTURES_DIRECTORY}/generate_inputs.yml").each.with_index do |inputs, index|
-        it 'returns the expected output' do
-          expect(described_class.new(inputs).perform).to eq(outputs[index])
+        it "returns the expected output for input ##{index}: #{inputs.to_json}" do
+          expect(described_class.new(inputs).perform.to_yaml).to eq(outputs[index].to_yaml)
         end
       end
     end
 
     context 'writing the outputs' do
-      # For documentation about this `skip`, see the comment at the top of this `describe` block.
-      skip unless ENV['REWRITE_RESULTS'] == '1'
-
       it 'writes the outputs' do
+        # For documentation about this `skip`, see the comment at the top of this `describe` block.
+        skip unless ENV['REWRITE_RESULTS'] == '1'
+
         outputs = inputs.map do |example|
           described_class.new(example).perform
         end