reports_kit 0.0.1

data/lib/reports_kit/resources_controller.rb

@@ -0,0 +1,8 @@
+module ReportsKit
+  class ResourcesController < ReportsKit::BaseController
+    def autocomplete
+      results = Reports::GenerateAutocompleteResults.new(params, context_record: context_record).perform
+      render json: { data: results }
+    end
+  end
+end

data/lib/reports_kit/version.rb

@@ -0,0 +1,3 @@
+module ReportsKit
+  VERSION = '0.0.1'
+end

data/reports_kit.gemspec

@@ -0,0 +1,23 @@
+require File.expand_path('../lib/reports_kit/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.authors       = ['Tom Benner']
+  s.email         = ['tombenner@gmail.com']
+  s.description = s.summary = 'Beautiful, interactive charts for Ruby on Rails'
+  s.homepage      = 'https://github.com/tombenner/reports_kit'
+
+  s.files         = `git ls-files`.split($\)
+  s.name          = 'reports_kit'
+  s.require_paths = ['lib']
+  s.version       = ReportsKit::VERSION
+  s.license       = 'MIT'
+
+  s.add_dependency 'rails'
+  s.add_dependency 'pg'
+
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'database_cleaner', '~> 1'
+  s.add_development_dependency 'factory_girl', '~> 4'
+  s.add_development_dependency 'pry', '~> 0'
+  s.add_development_dependency 'timecop', '~> 0'
+end

data/spec/factories/issue_factory.rb

@@ -0,0 +1,4 @@
+FactoryGirl.define do
+  factory :issue do
+  end
+end

data/spec/factories/issues_label_factory.rb

@@ -0,0 +1,4 @@
+FactoryGirl.define do
+  factory :issues_label do
+  end
+end

data/spec/factories/label_factory.rb

@@ -0,0 +1,4 @@
+FactoryGirl.define do
+  factory :label do
+  end
+end

data/spec/factories/repo_factory.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :repo do
+    sequence(:full_name) { |i| "foo/bar#{i}" }
+  end
+end

data/spec/factories/tag_factory.rb

@@ -0,0 +1,4 @@
+FactoryGirl.define do
+  factory :tag do
+  end
+end

data/spec/fixtures/generate_inputs.yml

@@ -0,0 +1,35 @@
+- measure: issue
+  dimensions:
+  - repo
+- measure: issue
+  dimensions:
+  - repo
+  chart:
+    options:
+      foo: bar
+- measure: issue
+  dimensions:
+  - repo
+  chart:
+    foo: bar
+- measure:
+    key: issue
+  dimensions:
+  - key: repo
+- measure:
+    key: issue
+  dimensions:
+  - key: opened_at
+- measure:
+    key: issue
+  dimensions:
+  - key: opened_at
+  - key: repo
+- measure:
+    key: issue
+    filters:
+    - key: locked
+    - key: title
+    - key: opened_at
+  dimensions:
+  - key: repo

data/spec/fixtures/generate_outputs.yml

@@ -0,0 +1,208 @@
+---
+- :chart_data:
+    :labels: []
+    :datasets:
+    - :label: Issues
+      :data: []
+      :backgroundColor: "#1f77b4"
+      :borderColor: "#1f77b4"
+    :options:
+      :scales:
+        :xAxes:
+        - :gridLines:
+            :display: false
+          :barPercentage: 0.9
+          :categoryPercentage: 0.9
+          :scaleLabel:
+            :display: true
+            :labelString: Repo
+        :yAxes:
+        - :ticks:
+            :beginAtZero: true
+          :scaleLabel:
+            :display: true
+            :labelString: Issues
+      :legend:
+        :labels:
+          :usePointStyle: true
+      :tooltips:
+        :xPadding: 8
+        :yPadding: 7
+  :type: bar
+- :chart_data:
+    :labels: []
+    :datasets:
+    - :label: Issues
+      :data: []
+      :backgroundColor: "#1f77b4"
+      :borderColor: "#1f77b4"
+    :options:
+      :scales:
+        :xAxes:
+        - :gridLines:
+            :display: false
+          :barPercentage: 0.9
+          :categoryPercentage: 0.9
+          :scaleLabel:
+            :display: true
+            :labelString: Repo
+        :yAxes:
+        - :ticks:
+            :beginAtZero: true
+          :scaleLabel:
+            :display: true
+            :labelString: Issues
+      :legend:
+        :labels:
+          :usePointStyle: true
+      :tooltips:
+        :xPadding: 8
+        :yPadding: 7
+      :foo: bar
+  :type: bar
+- :chart_data:
+    :labels: []
+    :datasets:
+    - :label: Issues
+      :data: []
+      :backgroundColor: "#1f77b4"
+      :borderColor: "#1f77b4"
+    :options:
+      :scales:
+        :xAxes:
+        - :gridLines:
+            :display: false
+          :barPercentage: 0.9
+          :categoryPercentage: 0.9
+          :scaleLabel:
+            :display: true
+            :labelString: Repo
+        :yAxes:
+        - :ticks:
+            :beginAtZero: true
+          :scaleLabel:
+            :display: true
+            :labelString: Issues
+      :legend:
+        :labels:
+          :usePointStyle: true
+      :tooltips:
+        :xPadding: 8
+        :yPadding: 7
+  :type: bar
+- :chart_data:
+    :labels: []
+    :datasets:
+    - :label: Issues
+      :data: []
+      :backgroundColor: "#1f77b4"
+      :borderColor: "#1f77b4"
+    :options:
+      :scales:
+        :xAxes:
+        - :gridLines:
+            :display: false
+          :barPercentage: 0.9
+          :categoryPercentage: 0.9
+          :scaleLabel:
+            :display: true
+            :labelString: Repo
+        :yAxes:
+        - :ticks:
+            :beginAtZero: true
+          :scaleLabel:
+            :display: true
+            :labelString: Issues
+      :legend:
+        :labels:
+          :usePointStyle: true
+      :tooltips:
+        :xPadding: 8
+        :yPadding: 7
+  :type: bar
+- :chart_data:
+    :labels: []
+    :datasets:
+    - :label: Issues
+      :data: []
+      :backgroundColor: "#1f77b4"
+      :borderColor: "#1f77b4"
+    :options:
+      :scales:
+        :xAxes:
+        - :gridLines:
+            :display: false
+          :barPercentage: 0.9
+          :categoryPercentage: 0.9
+          :scaleLabel:
+            :display: true
+            :labelString: Opened At
+        :yAxes:
+        - :ticks:
+            :beginAtZero: true
+          :scaleLabel:
+            :display: true
+            :labelString: Issues
+      :legend:
+        :labels:
+          :usePointStyle: true
+      :tooltips:
+        :xPadding: 8
+        :yPadding: 7
+  :type: bar
+- :chart_data:
+    :labels: []
+    :datasets: []
+    :options:
+      :scales:
+        :xAxes:
+        - :gridLines:
+            :display: false
+          :barPercentage: 0.9
+          :categoryPercentage: 0.9
+          :scaleLabel:
+            :display: true
+            :labelString: Opened At
+        :yAxes:
+        - :ticks:
+            :beginAtZero: true
+          :scaleLabel:
+            :display: true
+            :labelString: Issues
+      :legend:
+        :labels:
+          :usePointStyle: true
+      :tooltips:
+        :xPadding: 8
+        :yPadding: 7
+  :type: bar
+- :chart_data:
+    :labels: []
+    :datasets:
+    - :label: Issues
+      :data: []
+      :backgroundColor: "#1f77b4"
+      :borderColor: "#1f77b4"
+    :options:
+      :scales:
+        :xAxes:
+        - :gridLines:
+            :display: false
+          :barPercentage: 0.9
+          :categoryPercentage: 0.9
+          :scaleLabel:
+            :display: true
+            :labelString: Repo
+        :yAxes:
+        - :ticks:
+            :beginAtZero: true
+          :scaleLabel:
+            :display: true
+            :labelString: Issues
+      :legend:
+        :labels:
+          :usePointStyle: true
+      :tooltips:
+        :xPadding: 8
+        :yPadding: 7
+  :type: bar

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

@@ -0,0 +1,275 @@
+require 'spec_helper'
+
+describe ReportsKit::Reports::Data::Generate do
+  subject { described_class.new(properties, context_record: context_record).perform }
+
+  let(:repo) { create(:repo) }
+  let(:repo2) { create(:repo) }
+  let(:context_record) { nil }
+  let(:chart_data) do
+    chart_data = subject[:chart_data].except(:options)
+    chart_data[:datasets] = chart_data[:datasets].map do |dataset|
+      dataset.except(:backgroundColor, :borderColor)
+    end
+    chart_data
+  end
+
+  let(:chart_type) { subject[:type] }
+  let(:chart_options) { subject[:chart_data][:options] }
+
+  context 'with a datetime dimension' do
+    let(:properties) do
+      {
+        measure: 'issue',
+        dimensions: %w(opened_at)
+      }
+    end
+    let!(:issues) do
+      [
+        create(:issue, repo: repo, opened_at: now - 2.weeks),
+        create(:issue, repo: repo, opened_at: now - 2.weeks),
+        create(:issue, repo: repo, opened_at: now)
+      ]
+    end
+
+    it 'returns the type' do
+      expect(chart_type).to eq('bar')
+    end
+
+    it 'returns the data' do
+      expect(chart_data).to eq({
+        labels: [
+          format_time(2),
+          format_time(1),
+          format_time(0)
+        ],
+        datasets: [
+          {
+            label: 'Issues',
+            data: [2, 0, 1]
+          }
+        ]
+      })
+    end
+
+    context 'with a datetime filter' do
+      let(:properties) do
+        {
+          measure: {
+            key: 'issue',
+            filters: [
+              {
+                key: 'opened_at',
+                criteria: {
+                  operator: 'between',
+                  value: "#{date_string_for_filter(now - 1.week)} - #{date_string_for_filter(now)}"
+                }
+              }
+            ]
+          },
+          dimensions: %w(opened_at)
+        }
+      end
+
+      it 'returns the chart_data' do
+        expect(chart_data).to eq({
+          labels: [format_time(0)],
+          datasets: [
+            {
+              label: "Issues",
+              data: [1.0]
+            }
+          ]
+        })
+      end
+    end
+  end
+
+  context 'with an association dimension' do
+    let(:properties) do
+      {
+        measure: 'issue',
+        dimensions: %w(repo)
+      }
+    end
+    let!(:issues) do
+      [
+        create(:issue, repo: repo),
+        create(:issue, repo: repo),
+        create(:issue, repo: repo2)
+      ]
+    end
+
+    it 'returns the chart_data' do
+      expect(chart_data).to eq({
+        labels: [repo.to_s, repo2.to_s],
+        datasets: [{ label: 'Issues', data: [2, 1] }]
+      })
+    end
+
+    context 'with a context_record' do
+      let(:context_record) { repo }
+
+      it 'returns the chart_data' do
+        expect(chart_data).to eq({
+          labels: [repo.to_s],
+          datasets: [{ label: "Issues", data: [2.0] }]
+        })
+      end
+    end
+
+    context 'with a belongs_to association filter' do
+      let(:properties) do
+        {
+          measure: {
+            key: 'issue',
+            filters: [
+              {
+                key: 'repo',
+                criteria: {
+                  operator: 'include',
+                  value: [repo.id]
+                }
+              }
+            ]
+          },
+          dimensions: %w(repo)
+        }
+      end
+
+      it 'returns the chart_data' do
+        expect(chart_data).to eq({
+          labels: [repo.to_s],
+          datasets: [{ label: "Issues", data: [2.0] }]
+        })
+      end
+    end
+
+    context 'with a has_many association filter' do
+      let(:properties) do
+        {
+          measure: {
+            key: 'issue',
+            filters: [
+              {
+                key: 'tags',
+                criteria: {
+                  operator: 'include',
+                  value: [tag.id]
+                }
+              }
+            ]
+          },
+          dimensions: %w(repo)
+        }
+      end
+      let(:tag) { create(:tag) }
+      before(:each) do
+        issues[0].tags << tag
+      end
+
+      it 'returns the chart_data' do
+        chart_data
+        expect(chart_data).to eq({
+          labels: [repo.to_s],
+          datasets: [{ label: "Issues", data: [1.0] }]
+        })
+      end
+    end
+
+    context 'with a has_many :through association filter' do
+      let(:properties) do
+        {
+          measure: {
+            key: 'issue',
+            filters: [
+              {
+                key: 'labels',
+                criteria: {
+                  operator: 'include',
+                  value: [label.id]
+                }
+              }
+            ]
+          },
+          dimensions: %w(repo)
+        }
+      end
+      let(:label) { create(:label) }
+      before(:each) do
+        issues[0].labels << label
+      end
+
+      it 'returns the chart_data' do
+        expect(chart_data).to eq({
+          labels: [repo.to_s],
+          datasets: [{ label: "Issues", data: [1.0] }]
+        })
+      end
+    end
+  end
+
+  context 'with datetime and association dimensions' do
+    let(:properties) do
+      {
+        measure: 'issue',
+        dimensions: %w(opened_at repo)
+      }
+    end
+    let!(:issues) do
+      [
+        create(:issue, repo: repo, opened_at: now),
+        create(:issue, repo: repo, opened_at: now - 2.weeks),
+        create(:issue, repo: repo2, opened_at: now)
+      ]
+    end
+
+    it 'returns the chart_data' do
+      expect(chart_data).to eq({
+        labels: [format_time(2), format_time(1), format_time(0)],
+        datasets: [
+          {
+            label: repo.to_s,
+            data: [1, 0, 1]
+          },
+          {
+            label: repo2.to_s,
+            data: [0, 0, 1]
+          }
+        ]
+      })
+    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
+    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) }
+
+    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])
+        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
+        outputs = inputs.map do |example|
+          described_class.new(example).perform
+        end
+        File.write(outputs_path, outputs.to_yaml)
+      end
+    end
+  end
+end