Contents

module ReportsKit
  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.reportskit.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

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
reports_kit-0.7.1	lib/reports_kit/configuration.rb
reports_kit-0.7.0	lib/reports_kit/configuration.rb