reports_kit 0.1.0 → 0.2.0

data/docs/filters.md

@@ -60,7 +60,7 @@ measure:
   filters:
   - key: is_on_time
     criteria:
-      operator: true
+      value: true
 dimensions:
 - carrier
 ```
@@ -139,7 +139,7 @@ measure:
   filters:
   - key: was_delayed
     criteria:
-      operator: true
+      value: true
 dimensions:
 - carrier
 ```

data/docs/measures.md

@@ -5,8 +5,9 @@ The measure is what is being counted (or aggregated in another way). You can use
 For example, say we have a `Flight` model with a `flight_at` datetime column. We can chart the number of flights over time:
 
 ```yaml
-measure: flight
-dimensions:
-- flight_at
+measure:
+  key: flight
+  dimensions:
+  - flight_at
 ```
 [<img src="images/flights_by_flight_at.png?raw=true" width="500" />](images/flights_by_flight_at.png?raw=true)

data/gemfiles/mysql.gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: ..
   specs:
-    reports_kit (0.0.4)
+    reports_kit (0.2.0)
       rails (>= 3)
+      spreadsheet (>= 1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -50,9 +51,14 @@ GEM
       thor (>= 0.14.0)
     arel (8.0.0)
     builder (3.2.3)
+    byebug (2.7.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
     coderay (1.1.1)
+    columnize (0.9.0)
     concurrent-ruby (1.0.5)
     database_cleaner (1.6.1)
+    debugger-linecache (1.2.0)
     diff-lcs (1.3)
     erubi (1.6.1)
     factory_girl (4.8.0)
@@ -79,6 +85,9 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    pry-byebug (1.3.3)
+      byebug (~> 2.7)
+      pry (~> 0.10)
     rack (2.0.3)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -119,7 +128,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
+    ruby-ole (1.2.12.1)
     slop (3.6.0)
+    spreadsheet (1.1.4)
+      ruby-ole (>= 1.0)
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -146,6 +158,7 @@ DEPENDENCIES
   mysql2
   pg (>= 0.15)
   pry (~> 0)
+  pry-byebug (~> 1)
   reports_kit!
   rspec (~> 3)
   timecop (~> 0)

data/gemfiles/postgresql.gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: ..
   specs:
-    reports_kit (0.0.4)
+    reports_kit (0.2.0)
       rails (>= 3)
+      spreadsheet (>= 1.1)
 
 GEM
   remote: https://rubygems.org/
@@ -50,9 +51,14 @@ GEM
       thor (>= 0.14.0)
     arel (8.0.0)
     builder (3.2.3)
+    byebug (2.7.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
     coderay (1.1.1)
+    columnize (0.9.0)
     concurrent-ruby (1.0.5)
     database_cleaner (1.6.1)
+    debugger-linecache (1.2.0)
     diff-lcs (1.3)
     erubi (1.6.1)
     factory_girl (4.8.0)
@@ -78,6 +84,9 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    pry-byebug (1.3.3)
+      byebug (~> 2.7)
+      pry (~> 0.10)
     rack (2.0.3)
     rack-test (0.6.3)
       rack (>= 1.0)
@@ -118,7 +127,10 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
+    ruby-ole (1.2.12.1)
     slop (3.6.0)
+    spreadsheet (1.1.4)
+      ruby-ole (>= 1.0)
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -144,6 +156,7 @@ DEPENDENCIES
   factory_girl (~> 4)
   pg
   pry (~> 0)
+  pry-byebug (~> 1)
   reports_kit!
   rspec (~> 3)
   timecop (~> 0)

data/lib/reports_kit.rb

@@ -1,11 +1,14 @@
 require 'rails/all'
 
 require 'reports_kit/base_controller'
+require 'reports_kit/cache'
 require 'reports_kit/configuration'
 require 'reports_kit/engine'
 require 'reports_kit/helper'
 require 'reports_kit/model'
 require 'reports_kit/model_configuration'
+require 'reports_kit/order'
+require 'reports_kit/relative_time'
 require 'reports_kit/report_builder'
 require 'reports_kit/resources_controller'
 require 'reports_kit/reports_controller'
@@ -15,10 +18,18 @@ require 'reports_kit/reports/adapters/mysql'
 require 'reports_kit/reports/adapters/postgresql'
 
 require 'reports_kit/reports/data/chart_options'
+require 'reports_kit/reports/data/composite_aggregation'
+require 'reports_kit/reports/data/entity'
+require 'reports_kit/reports/data/format_one_dimension'
+require 'reports_kit/reports/data/format_two_dimensions'
 require 'reports_kit/reports/data/generate'
+require 'reports_kit/reports/data/generate_for_properties'
 require 'reports_kit/reports/data/one_dimension'
+require 'reports_kit/reports/data/populate_one_dimension'
+require 'reports_kit/reports/data/populate_two_dimensions'
 require 'reports_kit/reports/data/two_dimensions'
 require 'reports_kit/reports/data/utils'
+require 'reports_kit/reports/data/value'
 
 require 'reports_kit/reports/filter_types/base'
 require 'reports_kit/reports/filter_types/boolean'
@@ -27,8 +38,12 @@ require 'reports_kit/reports/filter_types/number'
 require 'reports_kit/reports/filter_types/records'
 require 'reports_kit/reports/filter_types/string'
 
+require 'reports_kit/reports/abstract_measure'
+require 'reports_kit/reports/composite_measure'
 require 'reports_kit/reports/dimension'
+require 'reports_kit/reports/dimension_with_measure'
 require 'reports_kit/reports/filter'
+require 'reports_kit/reports/filter_with_measure'
 require 'reports_kit/reports/generate_autocomplete_results'
 require 'reports_kit/reports/inferrable_configuration'
 require 'reports_kit/reports/measure'

data/lib/reports_kit/cache.rb

@@ -0,0 +1,37 @@
+module ReportsKit
+  class Cache
+    CACHE_PREFIX = 'reports_kit:reports:'
+
+    def self.get(properties, context_record)
+      return unless store
+      key = self.key(properties, context_record)
+      json_string = store.get(key)
+      return if json_string.blank?
+      ActiveSupport::JSON.decode(json_string)
+    end
+
+    def self.set(properties, context_record, data)
+      return unless store
+      key = self.key(properties, context_record)
+      json_string = ActiveSupport::JSON.encode(data)
+      store.setex(key, duration, json_string)
+    end
+
+    private
+
+    def self.key(properties, context_record)
+      key = properties.to_json
+      key += "#{context_record.class}#{context_record.id}" if context_record
+      key = Digest::MD5.hexdigest(key)
+      "#{CACHE_PREFIX}#{key}"
+    end
+
+    def self.duration
+      @duration ||= ReportsKit.configuration.cache_duration
+    end
+
+    def self.store
+      @store ||= ReportsKit.configuration.cache_store
+    end
+  end
+end

data/lib/reports_kit/configuration.rb

@@ -1,10 +1,22 @@
 module ReportsKit
   class Configuration
-    attr_accessor :context_record_method, :first_day_of_week
+    attr_accessor :cache_duration, :cache_store,
+      :context_params_method, :context_record_method, :custom_methods, :first_day_of_week
 
     def initialize
+      self.cache_duration = 5.minutes
+      self.cache_store = nil
+      self.context_params_method = nil
       self.context_record_method = nil
+      self.custom_methods = {}
       self.first_day_of_week = :sunday
     end
+
+    def custom_method(method_name)
+      return if method_name.blank?
+      method = custom_methods[method_name.to_sym]
+      raise ArgumentError.new("A method named '#{method_name}' is not defined") unless method
+      method
+    end
   end
 end

data/lib/reports_kit/helper.rb

@@ -1,19 +1,70 @@
 module ReportsKit
   module Helper
+    ACTION_KEYS_METHODS = {
+      'export_csv' => :export_csv_element,
+      'export_xls' => :export_xls_element
+    }
+
     def render_report(properties, &block)
       raise ArgumentError.new('`properties` must be a Hash or String') if properties.blank?
       if properties.is_a?(String)
         path = Rails.root.join('config', 'reports_kit', 'reports', "#{properties}.yml")
         properties = YAML.load_file(path)
       end
-      builder = ReportsKit::ReportBuilder.new(properties)
-      content_tag :div, nil, class: 'reports_kit_report', data: { properties: builder.properties, path: reports_kit_path } do
+      builder = ReportsKit::ReportBuilder.new(properties, additional_params: additional_params)
+      path = reports_kit.reports_kit_reports_path({ format: 'json' }.merge(additional_params))
+      content_tag :div, nil, class: 'reports_kit_report form-inline', data: { properties: builder.properties, path: path } do
+        elements = []
         if block_given?
-          form_tag reports_kit_path, method: 'get', class: 'reports_kit_report_form form-inline' do
+          elements << form_tag(path, method: 'get', class: 'reports_kit_report_form') do
             capture(builder, &block)
           end
         end
+        elements << content_tag(:div, nil, class: 'reports_kit_visualization')
+        action_elements = action_elements_for_properties(properties)
+        if action_elements
+          elements << content_tag(:div, nil, class: 'reports_kit_actions') do
+            action_elements.map { |element| concat(element) }
+          end
+        end
+        elements.join.html_safe
+      end
+    end
+
+    private
+
+    def additional_params
+      @additional_params ||= begin
+        context_params_method = ReportsKit.configuration.context_params_method
+        return {} unless context_params_method
+        context_params = instance_eval(&context_params_method)
+        { context_params: context_params }
       end
     end
+
+    def action_elements_for_properties(properties)
+      return if properties['actions'].blank?
+      properties['actions'].map do |action|
+        element_method = ACTION_KEYS_METHODS[action]
+        raise ArgumentError.new("Invalid action: #{action}") unless element_method
+        send(element_method)
+      end
+    end
+
+    def export_csv_element
+      data = {
+        role: 'reports_kit_export_button',
+        path: reports_kit.reports_kit_reports_path({ format: 'csv' }.merge(additional_params))
+      }
+      link_to('Download CSV', '#', class: 'btn btn-primary', data: data)
+    end
+
+    def export_xls_element
+      data = {
+        role: 'reports_kit_export_button',
+        path: reports_kit.reports_kit_reports_path({ format: 'xls' }.merge(additional_params))
+      }
+      link_to('Download Excel', '#', class: 'btn btn-primary', data: data)
+    end
   end
 end

data/lib/reports_kit/model_configuration.rb

@@ -1,13 +1,18 @@
 module ReportsKit
   class ModelConfiguration
-    attr_accessor :dimensions, :filters, :autocomplete_scopes
+    attr_accessor :aggregations, :dimensions, :filters, :autocomplete_scopes
 
     def initialize
+      self.aggregations = []
       self.dimensions = []
       self.filters = []
       self.autocomplete_scopes = []
     end
 
+    def aggregation(key, expression, properties={})
+      aggregations << { key: key.to_s, expression: expression }.merge(properties).symbolize_keys
+    end
+
     def dimension(key, properties)
       dimensions << { key: key.to_s }.merge(properties).symbolize_keys
     end

data/lib/reports_kit/order.rb

@@ -0,0 +1,33 @@
+module ReportsKit
+  class Order
+    attr_accessor :relation, :field, :direction
+
+    VALID_RELATIONS = %w(count dimension1 dimension2)
+    VALID_FIELDS = [nil, 'label']
+    VALID_DIRECTIONS = %w(asc desc)
+
+    def initialize(relation, field, direction)
+      self.relation = relation
+      self.field = field
+      self.direction = direction
+    end
+
+    def self.parse(string)
+      string ||= ''
+      field_expression, direction = string.to_s.split(/\s+/)
+      relation, field = (field_expression || '').split('.')
+
+      relation = relation.presence
+      field = field.presence
+      direction = direction.presence || 'asc'
+
+      relation = relation.to_i if relation =~ /^\d+$/
+
+      raise ArgumentError.new("Invalid relation: #{relation}") unless VALID_RELATIONS.include?(relation) || relation.is_a?(Fixnum)
+      raise ArgumentError.new("Invalid field: #{field}") unless VALID_FIELDS.include?(field)
+      raise ArgumentError.new("Invalid direction: #{direction}") unless VALID_DIRECTIONS.include?(direction)
+
+      new(relation, field, direction)
+    end
+  end
+end

data/lib/reports_kit/relative_time.rb

@@ -0,0 +1,42 @@
+module ReportsKit
+  class RelativeTime
+    LETTERS_DURATION_METHODS = {
+      'y' => :years,
+      'M' => :months,
+      'w' => :weeks,
+      'd' => :days,
+      'h' => :hours,
+      'm' => :minutes,
+      's' => :seconds
+    }
+    LETTERS = LETTERS_DURATION_METHODS.keys.join
+
+    def self.parse(string, prevent_exceptions: false)
+      return Time.zone.now if string == 'now'
+      original_string = string
+      string = string.to_s.strip
+      is_negative = string[0, 1] == '-'
+      string = string[1..-1] if is_negative
+
+      result_string = is_negative ? '-' : ''
+      result_durations = []
+
+      string.scan(/(\d+)([#{LETTERS}]?)/) do |number, letter|
+        result_string += "#{number}#{letter}"
+        duration_method = LETTERS_DURATION_METHODS[letter]
+        unless duration_method
+          return if prevent_exceptions
+          raise ArgumentError.new("Invalid duration letter: #{letter.inspect}")
+        end
+        result_durations << number.to_i.public_send(duration_method)
+      end
+
+      if result_string == '-' || result_string != original_string.to_s.strip
+        return if prevent_exceptions
+        raise ArgumentError.new("Invalid time duration: #{original_string.inspect}")
+      end
+      duration = result_durations.reduce(&:+)
+      is_negative ? duration.ago : duration.from_now
+    end
+  end
+end

data/lib/reports_kit/report_builder.rb

@@ -2,15 +2,18 @@ module ReportsKit
   class ReportBuilder
     include ActionView::Helpers
 
-    attr_accessor :properties
+    DEFAULT_DATE_RANGE_VALUE = ['-2M', 'now']
 
-    def initialize(properties)
-      self.properties = normalize_properties(properties)
+    attr_accessor :properties, :additional_params
+
+    def initialize(properties, additional_params: nil)
+      self.properties = properties.deep_symbolize_keys
+      self.additional_params = additional_params
     end
 
     def check_box(filter_key, options={})
       filter = validate_filter!(filter_key)
-      checked = filter.properties[:criteria][:operator] == 'true'
+      checked = filter.normalized_properties[:criteria][:value] == 'true'
       check_box_tag(filter_key, '1', checked, options)
     end
 
@@ -18,13 +21,17 @@ module ReportsKit
       filter = validate_filter!(filter_key)
       defaults = { class: 'form-control input-sm date_range_picker' }
       options = defaults.deep_merge(options)
-      text_field_tag(filter_key, filter.properties[:criteria][:value], options)
+      value = filter.normalized_properties[:criteria][:value].presence
+      value ||= default_date_range_value
+      text_field_tag(filter_key, value, options)
     end
 
     def multi_autocomplete(filter_key, options={})
       validate_filter!(filter_key)
+      filter = measure_filters.find { |f| f.key == filter_key.to_s }
       reports_kit_path = Rails.application.routes.url_helpers.reports_kit_path
-      path = "#{reports_kit_path}reports_kit/resources/measures/#{measure.key}/filters/#{filter_key}/autocomplete"
+      path = "#{reports_kit_path}reports_kit/resources/measures/#{filter.measure.key}/filters/#{filter_key}/autocomplete?"
+      path += additional_params.to_query if additional_params.present?
       scope = options.delete(:scope)
       params = {}
       params[:scope] = scope if scope.present?
@@ -46,7 +53,7 @@ module ReportsKit
       filter = validate_filter!(filter_key)
       defaults = { class: 'form-control input-sm' }
       options = defaults.deep_merge(options)
-      text_field_tag(filter_key, filter.properties[:criteria][:value], options)
+      text_field_tag(filter_key, filter.normalized_properties[:criteria][:value], options)
     end
 
     private
@@ -59,18 +66,30 @@ module ReportsKit
     end
 
     def filters
-      measure.filters
+      ui_filters + measure_filters
+    end
+
+    def measure_filters
+      measures.map(&:filters).flatten
+    end
+
+    def ui_filters
+      return [] if properties[:ui_filters].blank?
+      properties[:ui_filters].map do |ui_filter_properties|
+        Reports::Filter.new(ui_filter_properties)
+      end
     end
 
-    def measure
-      Reports::Measure.new(properties[:measure])
+    def measures
+      Reports::Measure.new_from_properties!(properties, context_record: nil)
     end
 
-    def normalize_properties(properties)
-      properties = properties.deep_symbolize_keys
-      measure = Reports::Measure.new(properties[:measure])
-      properties[:measure] = measure.properties_with_filters
-      properties
+    def default_date_range_value
+      @default_date_range_value ||= begin
+        start_date = Reports::Data::Utils.format_time_value(DEFAULT_DATE_RANGE_VALUE[0])
+        end_date = Reports::Data::Utils.format_time_value(DEFAULT_DATE_RANGE_VALUE[1])
+        [start_date, Reports::FilterTypes::Datetime::SEPARATOR, end_date].join(' ')
+      end
     end
   end
 end