reports_kits 0.7.5 → 0.7.7

data/lib/reports_kits/reports/inferrable_configuration.rb

@@ -0,0 +1,116 @@
+module ReportsKits
+  module Reports
+    class InferrableConfiguration
+      SUPPORTED_COLUMN_TYPES = [
+        :boolean,
+        :datetime,
+        :integer,
+        :string,
+        :text
+      ]
+
+      attr_accessor :inferrable, :inferrable_type, :model_settings
+
+      delegate :key, :expression, :series, to: :inferrable
+      delegate :model_class, :settings_from_model, to: :model_settings
+
+      def initialize(inferrable, inferrable_type)
+        self.inferrable = inferrable
+        self.inferrable_type = inferrable_type
+        self.model_settings = ModelSettings.new(series.model_class, inferrable_type, key)
+      end
+
+      def configuration_strategy
+        if settings_from_model.present?
+          :model
+        elsif reflection
+          :association
+        elsif column_type
+          :column
+        else
+          inferrable_type_string = inferrable_type.to_s.singularize
+          raise ArgumentError.new("No configuration found on the #{model_class} model for #{inferrable_type_string} with key: '#{key}'")
+        end
+      end
+
+      def configured_by_association?
+        configuration_strategy == :association
+      end
+
+      def configured_by_column?
+        configuration_strategy == :column
+      end
+
+      def configured_by_model?
+        configuration_strategy == :model
+      end
+
+      def configured_by_time?
+        column_type == :datetime
+      end
+
+      def reflection
+        model_class.reflect_on_association(expression.to_sym)
+      end
+
+      def instance_class
+        return reflection.klass if reflection
+        nil
+      end
+
+      def column
+        return unless inferred_settings
+        inferred_settings[:column]
+      end
+
+      def inferred_settings
+        return { column: "#{model_class.table_name}.#{expression}" } if configured_by_column?
+        if configured_by_association?
+          return inferred_settings_from_belongs_to_or_has_one if inferred_settings_from_belongs_to_or_has_one
+          return inferred_settings_from_has_many if inferred_settings_from_has_many
+        end
+        {}
+      end
+
+      def inferred_settings_from_belongs_to_or_has_one
+        @inferred_settings_from_belongs_to_or_has_one ||= begin
+          return unless reflection.macro.in?([:belongs_to, :has_one])
+          through_reflection = reflection.through_reflection
+          if through_reflection
+            {
+              joins: through_reflection.name,
+              column: "#{through_reflection.table_name}.#{reflection.source_reflection.foreign_key}"
+            }
+          else
+            {
+              column: "#{model_class.table_name}.#{reflection.foreign_key}"
+            }
+          end
+        end
+      end
+
+      def inferred_settings_from_has_many
+        @inferred_settings_from_has_many ||= begin
+          return unless reflection.macro == :has_many
+          through_reflection = reflection.through_reflection
+          if through_reflection
+            {
+              joins: through_reflection.name,
+              column: "#{through_reflection.table_name}.#{reflection.source_reflection.foreign_key}"
+            }
+          else
+            {
+              joins: reflection.name,
+              column: "#{reflection.klass.table_name}.#{reflection.klass.primary_key}"
+            }
+          end
+        end
+      end
+
+      def column_type
+        column_type = model_class.columns_hash[expression.to_s].try(:type)
+        return column_type if SUPPORTED_COLUMN_TYPES.include?(column_type)
+      end
+    end
+  end
+end

data/lib/reports_kits/reports/model_settings.rb

@@ -0,0 +1,30 @@
+module ReportsKits
+  module Reports
+    class ModelSettings
+      attr_accessor :model_class, :model_configuration_type, :key
+
+      def initialize(model_class, model_configuration_type, key)
+        self.model_class = model_class
+        self.model_configuration_type = model_configuration_type
+        self.key = key
+      end
+
+      def settings_from_model
+        return {} if model_configuration.blank?
+        config_hashes = model_configuration.public_send(model_configuration_type)
+        return {} if config_hashes.blank?
+        config_hash = config_hashes.find do |hash|
+          hash[:key] == key
+        end
+        config_hash || {}
+      end
+
+      private
+
+      def model_configuration
+        return unless model_class && model_class.respond_to?(:reports_kit_configuration)
+        model_class.reports_kit_configuration
+      end
+    end
+  end
+end

data/lib/reports_kits/reports/properties.rb

@@ -0,0 +1,10 @@
+module ReportsKits
+  module Reports
+    class Properties
+      def self.generate(context)
+        properties = context.instance_eval(&ReportsKits.configuration.properties_method)
+        properties.deep_symbolize_keys
+      end
+    end
+  end
+end

data/lib/reports_kits/reports/properties_to_filter.rb

@@ -0,0 +1,40 @@
+module ReportsKits
+  module Reports
+    class PropertiesToFilter
+      attr_accessor :properties, :context_record
+
+      def initialize(properties, context_record: nil)
+        self.properties = properties
+        self.context_record = context_record
+      end
+
+      def perform(filter_key)
+        filter_key = filter_key.to_s
+        filter = filters.find { |f| f.key == filter_key }
+        raise ArgumentError.new("A filter with key '#{filter_key}' is not configured in this report") unless filter
+        filter
+      end
+
+      private
+
+      def filters
+        @filters ||= ui_filters + series_filters
+      end
+
+      def series_filters
+        serieses.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 serieses
+        Reports::Series.new_from_properties!(properties, context_record: context_record)
+      end
+    end
+  end
+end

data/lib/reports_kits/reports/series.rb

@@ -0,0 +1,121 @@
+module ReportsKits
+  module Reports
+    class Series < AbstractSeries
+      VALID_KEYS = [:measure, :dimensions, :contextual_filters, :context_params, :filters, :limit, :context_params, :report_options]
+
+      attr_accessor :properties, :dimensions, :contextual_filters, :filters, :context_record
+
+      def initialize(properties, context_record: nil)
+        properties = { measure: properties } if properties.is_a?(String)
+        properties = properties.deep_symbolize_keys.dup
+        measure_properties = properties[:measure]
+        properties[:measure] = measure_properties
+        properties[:measure] = { key: properties[:measure] } if properties[:measure].is_a?(String)
+        raise ArgumentError.new("Measure properties must be a String or Hash, not a #{properties.class.name}: #{properties.inspect}") unless properties.is_a?(Hash)
+
+        contextual_filter_keys = properties[:contextual_filters] || []
+        dimension_hashes = properties[:dimensions] || []
+        dimension_hashes = dimension_hashes.values if dimension_hashes.is_a?(Hash) && dimension_hashes.key?(:'0')
+        filter_hashes = properties[:filters] || []
+        filter_hashes = filter_hashes.values if filter_hashes.is_a?(Hash) && filter_hashes.key?(:'0')
+
+        self.properties = properties
+        self.context_record = context_record
+        self.dimensions = dimension_hashes.map { |dimension_hash| DimensionWithSeries.new(dimension: Dimension.new(dimension_hash), series: self) }
+        self.filters = filter_hashes.map { |filter_hash| FilterWithSeries.new(filter: Filter.new(filter_hash), series: self) }
+        self.contextual_filters = contextual_filter_keys.map { |key| ContextualFilter.new(key, model_class) }
+      end
+
+      def key
+        properties[:measure][:key].underscore
+      end
+
+      def label
+        properties[:measure][:name].presence || key.pluralize.titleize
+      end
+
+      def limit
+        properties[:limit]
+      end
+
+      def edit_relation_method
+        ReportsKits.configuration.custom_method(properties[:report_options].try(:[], :edit_relation_method))
+      end
+
+      def relation_name
+        key.tableize
+      end
+
+      def aggregate_function
+        aggregation_expression || [:count, model_class.primary_key]
+      end
+
+      def aggregation_expression
+        return unless aggregation_config
+        expression = aggregation_config[:expression]
+        if expression.is_a?(Array)
+          expression
+        else
+          raise ArgumentError.new("The '#{aggregation_key}' aggregation on the #{model_class} model isn't valid")
+        end
+      end
+
+      def aggregation_key
+        properties[:measure][:aggregation]
+      end
+
+      def aggregation_config
+        @aggregation_config ||= begin
+          return unless aggregation_key
+          raise ArgumentError.new("A '#{aggregation_key}' aggregation on the #{model_class} model hasn't been configured") unless model_class.respond_to?(:reports_kit_configuration)
+          config = model_class.reports_kit_configuration.aggregations.find { |aggregation| aggregation[:key] == aggregation_key }
+          raise ArgumentError.new("A '#{aggregation_key}' aggregation on the #{model_class} model hasn't been configured") unless config
+          config
+        end
+      end
+
+      def base_relation
+        return context_record.public_send(relation_name) if context_record
+        model_class
+      end
+
+      def model_class
+        if context_record
+          reflection = context_record.class.reflect_on_association(key.to_sym) ||
+            context_record.class.reflect_on_association(key.pluralize.to_sym)
+          return reflection.klass if reflection
+        end
+        key.camelize.constantize
+      end
+
+      def filtered_relation
+        relation = base_relation
+        filters.each do |filter|
+          relation = filter.apply(relation)
+        end
+        contextual_filters.each do |filter|
+          relation = filter.apply(relation, properties[:context_params])
+        end
+        relation
+      end
+
+      def has_two_dimensions?
+        dimensions.length == 2
+      end
+
+      def self.new_from_properties!(properties, context_record:)
+        series_hashes = properties[:series].presence || properties.slice(*Series::VALID_KEYS)
+        series_hashes = [series_hashes] if series_hashes.is_a?(Hash)
+        raise ArgumentError.new('At least one series must be configured') if series_hashes.blank?
+
+        series_hashes.map do |series_hash|
+          if series_hash[:composite_operator].present?
+            CompositeSeries.new(series_hash, context_record: context_record)
+          else
+            new(series_hash, context_record: context_record)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/reports_kits/reports_controller.rb

@@ -0,0 +1,65 @@
+require 'csv'
+require 'spreadsheet'
+
+module ReportsKits
+  class ReportsController < ReportsKits::BaseController
+    before_action :modify_context_params
+
+    VALID_PARAMS_PROPERTIES_KEYS = [:ui_filters]
+
+    def index
+      respond_to do |format|
+        format.json do
+          render json: { data: report_data }
+        end
+        format.csv do
+          properties[:format] = 'csv'
+          csv = CSV.generate do |csv|
+            report_data[:table_data].each do |row|
+              csv << row
+            end
+          end
+          send_data csv, filename: "#{report_filename}.csv"
+        end
+        format.xls do
+          properties[:format] = 'csv'
+          send_data xls_string, filename: "#{report_filename}.xls", type:  'application/vnd.ms-excel'
+        end
+      end
+    end
+
+    private
+
+    def report_filename
+      report_filename_method = ReportsKits.configuration.report_filename_method
+      return 'Report' unless report_filename_method
+      instance_eval(&report_filename_method)
+    end
+
+    def report_data
+      Reports::Data::Generate.new(properties, context_record: context_record, context_params: context_params).perform
+    end
+
+    def properties
+      @properties ||= begin
+        properties = Reports::Properties.generate(self)
+        properties.merge(params_properties).deep_symbolize_keys
+      end
+    end
+
+    def params_properties
+      @params_properties ||= ActiveSupport::JSON.decode(params[:properties]).with_indifferent_access.slice(*VALID_PARAMS_PROPERTIES_KEYS)
+    end
+
+    def xls_string
+      spreadsheet = Spreadsheet::Workbook.new
+      sheet = spreadsheet.create_worksheet
+      report_data[:table_data].each_with_index do |row, index|
+        sheet.update_row(index, *row)
+      end
+      io = StringIO.new
+      spreadsheet.write(io)
+      io.string
+    end
+  end
+end

data/lib/reports_kits/utils.rb

@@ -0,0 +1,11 @@
+module ReportsKits
+  class Utils
+    def self.string_to_class_method(string, string_identifer)
+      class_name, method_name = string.split('.')
+      raise ArgumentError.new("The #{string_identifer} value should be a class method with a format of MyClass.my_method") unless class_name && method_name
+      klass = class_name.constantize
+      raise ArgumentError.new("The #{string_identifer} class (#{class_name}) does not respond to a method named \"#{method_name}\"") unless klass.respond_to?(method_name)
+      [klass, method_name]
+    end
+  end
+end

data/lib/reports_kits/value.rb

@@ -0,0 +1,3 @@
+module ReportsKits
+  Value = Struct.new(:raw, :formatted)
+end

data/lib/reports_kits/version.rb

@@ -0,0 +1,3 @@
+module ReportsKits
+  VERSION = '0.7.7'
+end

data/lib/reports_kits.rb

@@ -0,0 +1,79 @@
+require 'rails/all'
+
+require 'reports_kits/normalized_params'
+require 'reports_kits/base_controller'
+require 'reports_kits/cache'
+require 'reports_kits/configuration'
+require 'reports_kits/engine'
+require 'reports_kits/entity'
+require 'reports_kits/filters_controller'
+require 'reports_kits/form_builder'
+require 'reports_kits/helper'
+require 'reports_kits/model'
+require 'reports_kits/model_configuration'
+require 'reports_kits/order'
+require 'reports_kits/relative_time'
+require 'reports_kits/report_builder'
+require 'reports_kits/reports_controller'
+require 'reports_kits/utils'
+require 'reports_kits/value'
+require 'reports_kits/version'
+
+require 'reports_kits/reports/adapters/mysql'
+require 'reports_kits/reports/adapters/postgresql'
+
+require 'reports_kits/reports/data/add_table_aggregations'
+require 'reports_kits/reports/data/aggregate_composite'
+require 'reports_kits/reports/data/aggregate_one_dimension'
+require 'reports_kits/reports/data/aggregate_two_dimensions'
+require 'reports_kits/reports/data/chart_data_for_data_method'
+require 'reports_kits/reports/data/chart_options'
+require 'reports_kits/reports/data/format_one_dimension'
+require 'reports_kits/reports/data/format_table'
+require 'reports_kits/reports/data/format_two_dimensions'
+require 'reports_kits/reports/data/generate'
+require 'reports_kits/reports/data/generate_for_properties'
+require 'reports_kits/reports/data/normalize_properties'
+require 'reports_kits/reports/data/populate_one_dimension'
+require 'reports_kits/reports/data/populate_two_dimensions'
+require 'reports_kits/reports/data/utils'
+
+require 'reports_kits/reports/filter_types/base'
+require 'reports_kits/reports/filter_types/boolean'
+require 'reports_kits/reports/filter_types/datetime'
+require 'reports_kits/reports/filter_types/number'
+require 'reports_kits/reports/filter_types/records'
+require 'reports_kits/reports/filter_types/string'
+
+require 'reports_kits/reports/abstract_series'
+require 'reports_kits/reports/composite_series'
+require 'reports_kits/reports/contextual_filter'
+require 'reports_kits/reports/dimension'
+require 'reports_kits/reports/dimension_with_series'
+require 'reports_kits/reports/filter'
+require 'reports_kits/reports/filter_with_series'
+require 'reports_kits/reports/generate_autocomplete_results'
+require 'reports_kits/reports/generate_autocomplete_method_results'
+require 'reports_kits/reports/inferrable_configuration'
+require 'reports_kits/reports/model_settings'
+require 'reports_kits/reports/properties'
+require 'reports_kits/reports/properties_to_filter'
+require 'reports_kits/reports/series'
+
+class ReportsKits
+  def self.configure
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.parse_date_range(string)
+    ReportsKits::Reports::Data::Utils.parse_date_range(string)
+  end
+
+  def self.format_date_range(string)
+    ReportsKits::Reports::Data::Utils.format_date_range(string)
+  end
+end

data/reports_kits.gemspec

@@ -0,0 +1,26 @@
+require File.expand_path('../lib/reports_kits/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.authors       = ["aipanhara"]
+  s.email         = ["titpanhara@gmail.com"]
+  s.summary       = 'Beautiful, interactive charts for Ruby on Rails'
+  s.description   = 'ReportsKits lets you easily create beautiful charts with customizable, interactive filters.'
+  s.homepage      = 'https://github.com/Panhara28/reports_kits'
+  s.name          = 'reports_kits'
+  s.require_paths = ["lib"]
+  s.files         = `git ls-files`.split($\)
+  s.version       = ReportsKits::VERSION
+  s.license       = 'MIT'
+  s.add_runtime_dependency 'rails', '~> 5'
+  s.add_runtime_dependency 'spreadsheet', '~> 1.1'
+
+  s. add_development_dependency 'appraisal', '~> 0'
+  s.add_development_dependency 'rspec', '~> 3'
+  s.add_development_dependency 'database_cleaner', '~> 1'
+  s.add_development_dependency 'factory_girl', '~> 4'
+  s.add_development_dependency 'groupdate', '~> 3'
+  s.add_development_dependency 'pg', '~> 0.15'
+  s.add_development_dependency 'pry', '~> 0'
+  s.add_development_dependency 'pry-byebug', '~> 1'
+  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/pro_repo_factory.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :pro_repo, class: Pro::Repo do
+    sequence(:full_name) { |i| "foo/bar#{i}" }
+  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