reports_kits 0.7.5 → 0.7.7

data/gemfiles/rails_5.1.4_postgresql.gemfile.lock

@@ -0,0 +1,169 @@
+PATH
+  remote: ..
+  specs:
+    reports_kit (0.7.1)
+      rails (>= 3)
+      spreadsheet (>= 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.4)
+      actionpack (= 5.1.4)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.4)
+      actionview (= 5.1.4)
+      activesupport (= 5.1.4)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.4)
+      activesupport (= 5.1.4)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.4)
+      activesupport (= 5.1.4)
+      globalid (>= 0.3.6)
+    activemodel (5.1.4)
+      activesupport (= 5.1.4)
+    activerecord (5.1.4)
+      activemodel (= 5.1.4)
+      activesupport (= 5.1.4)
+      arel (~> 8.0)
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      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.2)
+    columnize (0.9.0)
+    concurrent-ruby (1.0.5)
+    crass (1.0.2)
+    database_cleaner (1.6.1)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.3)
+    erubi (1.7.0)
+    factory_girl (4.8.1)
+      activesupport (>= 3.0.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    groupdate (3.2.0)
+      activesupport (>= 3)
+    i18n (0.8.6)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.6.6)
+      mime-types (>= 1.16, < 4)
+    method_source (0.9.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    nio4r (2.1.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    pg (0.21.0)
+    pry (0.11.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (1.3.3)
+      byebug (~> 2.7)
+      pry (~> 0.10)
+    rack (2.0.3)
+    rack-test (0.7.0)
+      rack (>= 1.0, < 3)
+    rails (5.1.4)
+      actioncable (= 5.1.4)
+      actionmailer (= 5.1.4)
+      actionpack (= 5.1.4)
+      actionview (= 5.1.4)
+      activejob (= 5.1.4)
+      activemodel (= 5.1.4)
+      activerecord (= 5.1.4)
+      activesupport (= 5.1.4)
+      bundler (>= 1.3.0)
+      railties (= 5.1.4)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.4)
+      actionpack (= 5.1.4)
+      activesupport (= 5.1.4)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.1.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    ruby-ole (1.2.12.1)
+    spreadsheet (1.1.7)
+      ruby-ole (>= 1.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    timecop (0.9.1)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  database_cleaner (~> 1)
+  factory_girl (~> 4)
+  groupdate (~> 3)
+  pg
+  pry (~> 0)
+  pry-byebug (~> 1)
+  rails (= 5.1.4)
+  reports_kit!
+  rspec (~> 3)
+  timecop (~> 0)
+
+BUNDLED WITH
+   1.16.1

data/gemfiles/rails_5_mysql.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "mysql2"
+gem "rails", "5.1.3"
+
+gemspec :path => "../"

data/gemfiles/rails_5_mysql.gemfile.lock

@@ -0,0 +1,171 @@
+PATH
+  remote: ..
+  specs:
+    reports_kit (0.7.1)
+      rails (>= 3)
+      spreadsheet (>= 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.3)
+      actionpack (= 5.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.3)
+      actionview (= 5.1.3)
+      activesupport (= 5.1.3)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.3)
+      activesupport (= 5.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.3)
+      activesupport (= 5.1.3)
+      globalid (>= 0.3.6)
+    activemodel (5.1.3)
+      activesupport (= 5.1.3)
+    activerecord (5.1.3)
+      activemodel (= 5.1.3)
+      activesupport (= 5.1.3)
+      arel (~> 8.0)
+    activesupport (5.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      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.2)
+    columnize (0.9.0)
+    concurrent-ruby (1.0.5)
+    crass (1.0.2)
+    database_cleaner (1.6.1)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.3)
+    erubi (1.7.0)
+    factory_girl (4.8.1)
+      activesupport (>= 3.0.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    groupdate (3.2.0)
+      activesupport (>= 3)
+    i18n (0.8.6)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.6.6)
+      mime-types (>= 1.16, < 4)
+    method_source (0.9.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    mysql2 (0.4.9)
+    nio4r (2.1.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    pg (0.21.0)
+    pry (0.11.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (1.3.3)
+      byebug (~> 2.7)
+      pry (~> 0.10)
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.1.3)
+      actioncable (= 5.1.3)
+      actionmailer (= 5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      activemodel (= 5.1.3)
+      activerecord (= 5.1.3)
+      activesupport (= 5.1.3)
+      bundler (>= 1.3.0)
+      railties (= 5.1.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.3)
+      actionpack (= 5.1.3)
+      activesupport (= 5.1.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.1.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    ruby-ole (1.2.12.1)
+    spreadsheet (1.1.7)
+      ruby-ole (>= 1.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    timecop (0.9.1)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  database_cleaner (~> 1)
+  factory_girl (~> 4)
+  groupdate (~> 3)
+  mysql2
+  pg (>= 0.15)
+  pry (~> 0)
+  pry-byebug (~> 1)
+  rails (= 5.1.3)
+  reports_kit!
+  rspec (~> 3)
+  timecop (~> 0)
+
+BUNDLED WITH
+   1.16.1

data/gemfiles/rails_5_postgresql.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "pg"
+gem "rails", "5.1.3"
+
+gemspec :path => "../"

data/gemfiles/rails_5_postgresql.gemfile.lock

@@ -0,0 +1,169 @@
+PATH
+  remote: ..
+  specs:
+    reports_kit (0.7.1)
+      rails (>= 3)
+      spreadsheet (>= 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.3)
+      actionpack (= 5.1.3)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.3)
+      actionview (= 5.1.3)
+      activesupport (= 5.1.3)
+      rack (~> 2.0)
+      rack-test (~> 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.3)
+      activesupport (= 5.1.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.3)
+      activesupport (= 5.1.3)
+      globalid (>= 0.3.6)
+    activemodel (5.1.3)
+      activesupport (= 5.1.3)
+    activerecord (5.1.3)
+      activemodel (= 5.1.3)
+      activesupport (= 5.1.3)
+      arel (~> 8.0)
+    activesupport (5.1.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      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.2)
+    columnize (0.9.0)
+    concurrent-ruby (1.0.5)
+    crass (1.0.2)
+    database_cleaner (1.6.1)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.3)
+    erubi (1.7.0)
+    factory_girl (4.8.1)
+      activesupport (>= 3.0.0)
+    globalid (0.4.0)
+      activesupport (>= 4.2.0)
+    groupdate (3.2.0)
+      activesupport (>= 3)
+    i18n (0.8.6)
+    loofah (2.1.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.6.6)
+      mime-types (>= 1.16, < 4)
+    method_source (0.9.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_portile2 (2.3.0)
+    minitest (5.10.3)
+    nio4r (2.1.0)
+    nokogiri (1.8.1)
+      mini_portile2 (~> 2.3.0)
+    pg (0.21.0)
+    pry (0.11.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (1.3.3)
+      byebug (~> 2.7)
+      pry (~> 0.10)
+    rack (2.0.3)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (5.1.3)
+      actioncable (= 5.1.3)
+      actionmailer (= 5.1.3)
+      actionpack (= 5.1.3)
+      actionview (= 5.1.3)
+      activejob (= 5.1.3)
+      activemodel (= 5.1.3)
+      activerecord (= 5.1.3)
+      activesupport (= 5.1.3)
+      bundler (>= 1.3.0)
+      railties (= 5.1.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (5.1.3)
+      actionpack (= 5.1.3)
+      activesupport (= 5.1.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.1.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    ruby-ole (1.2.12.1)
+    spreadsheet (1.1.7)
+      ruby-ole (>= 1.0)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    timecop (0.9.1)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  database_cleaner (~> 1)
+  factory_girl (~> 4)
+  groupdate (~> 3)
+  pg
+  pry (~> 0)
+  pry-byebug (~> 1)
+  rails (= 5.1.3)
+  reports_kit!
+  rspec (~> 3)
+  timecop (~> 0)
+
+BUNDLED WITH
+   1.16.1

data/lib/reports_kits/base_controller.rb

@@ -0,0 +1,17 @@
+module ReportsKits
+  class BaseController < ActionController::Base
+    include ReportsKits::NormalizedParams
+
+    # This is intentionally public to allow external code to access it
+    def context_record
+      ReportsKits.configuration.context_record(self)
+    end
+
+    private
+
+    def modify_context_params
+      modify_context_params_method = ReportsKits.configuration.modify_context_params_method
+      params[:context_params] = modify_context_params_method.call(params[:context_params], self) if modify_context_params_method
+    end
+  end
+end

data/lib/reports_kits/cache.rb

@@ -0,0 +1,37 @@
+module ReportsKits
+  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 ||= ReportsKits.configuration.cache_duration
+    end
+
+    def self.store
+      @store ||= ReportsKits.configuration.cache_store
+    end
+  end
+end

data/lib/reports_kits/configuration.rb

@@ -0,0 +1,50 @@
+module ReportsKits
+  class Configuration
+    attr_accessor :autocomplete_results_method, :cache_duration, :cache_store, :context_record_method, :custom_methods,
+      :default_dimension_limit, :default_properties, :first_day_of_week, :modify_context_params_method, :properties_method,
+      :report_filename_method, :use_concurrent_queries
+
+    DEFAULT_PROPERTIES_METHOD = lambda do |env|
+      path = Rails.root.join('config', 'reports_kit', 'reports', "#{report_key}.yml")
+      YAML.load_file(path)
+    end
+
+    def initialize
+      self.autocomplete_results_method = nil
+      self.cache_duration = 5.minutes
+      self.cache_store = nil
+      self.custom_methods = {}
+      self.default_dimension_limit = 30
+      self.default_properties = nil
+      self.first_day_of_week = :sunday
+      self.modify_context_params_method = nil
+      self.properties_method = DEFAULT_PROPERTIES_METHOD
+      self.report_filename_method = nil
+      self.use_concurrent_queries = false
+    end
+
+    def custom_method(method_name)
+      return if method_name.blank?
+      method = evaluated_custom_methods[method_name.to_sym]
+      raise ArgumentError.new("A method named '#{method_name}' is not defined") unless method
+      method
+    end
+
+    def evaluated_custom_methods
+      return custom_methods if custom_methods.is_a?(Hash)
+      return custom_methods.call if custom_methods.is_a?(Proc)
+      raise ArgumentError.new("Invalid type for custom_methods configuration: #{custom_methods.class}")
+    end
+
+    def context_record_method=(context_record_method)
+      warn "[DEPRECATION] `context_record_method` is deprecated. Please use contextual filters instead: https://www.ReportsKits.co/subcategories/contextual_filters"
+
+      @context_record_method = context_record_method
+    end
+
+    def context_record(context)
+      return unless context_record_method
+      context.instance_eval(&context_record_method)
+    end
+  end
+end

data/lib/reports_kits/engine.rb

@@ -0,0 +1,21 @@
+module ReportsKits
+  class Engine < ::Rails::Engine
+    engine_name 'reports_kits'
+
+    initializer 'reports_kits.helpers.helper' do
+      ActiveSupport.on_load(:action_view) do
+        include Helper
+      end
+    end
+
+    initializer 'reports_kits.assets.precompile' do |app|
+      if app.config.respond_to?(:assets)
+        if defined?(Sprockets) && Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new('4.0.0.beta1')
+          app.config.assets.precompile += %w(reports_kits.js reports_kits.css)
+        else
+          app.config.assets.precompile << proc { |path| path.start_with?('reports_kits.') }
+        end
+      end
+    end
+  end
+end

data/lib/reports_kits/entity.rb

@@ -0,0 +1,3 @@
+module ReportsKits
+  Entity = Struct.new(:key, :label, :instance)
+end

data/lib/reports_kits/filters_controller.rb

@@ -0,0 +1,11 @@
+module ReportsKits
+  class FiltersController < ReportsKits::BaseController
+    before_action :modify_context_params
+
+    def autocomplete
+      properties = Reports::Properties.generate(self)
+      results = Reports::GenerateAutocompleteResults.new(params, properties, context_record: context_record).perform
+      render json: { data: results }
+    end
+  end
+end