simple_drilldown 0.9.11 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bf78b23713b09e5007b4b8ab3c084e511bdb2cd620f45b9e8d8f4b8d181729c
-  data.tar.gz: 37110d16927f895350153faaec36bead96f2bf9f6b4263e014eaffe46eb52ecc
+  metadata.gz: 1e99331c0a6ab073aece756d21fc1e639e426321975ffd23f64c1becddc375d8
+  data.tar.gz: 6db7888ff16123847f4df9f3b780fa9232af484c26abcacd38f45a56a25cccca
 SHA512:
-  metadata.gz: d9a1f536867c67dd52cebfc34ed71e0c67e121f181afc0b169e00640176776fb9909ac049214eaadc06e886744cde84efc35d70a1009a6977478c90141254bc2
-  data.tar.gz: 4ac0a883010bdddfe9e5eaa81d87e41f8f5e2ea018d33297c80395154c9b2c45ca8efd024edb465cda8c779f24a0ca00d5a15b8cb6ac4ebe0d0d72647c6e5747
+  metadata.gz: 0002a2f6172dcd658e8bc329ed3985b3829690844c93b01d6a597083a0e59123b9c3fe5ad78f189a6041b8ad2ec82da0ff6e62a55dfe6e4118d2611aa9bde0c9
+  data.tar.gz: b877aab5468b90bccf608b854b3f362db63d36c4edd6806be9daed15136d54000f435a9047acd308b9016c5a194a4eed8fa86c58a1d73cc21bcbcc12d442b8b9

data/README.md

@@ -66,7 +66,7 @@ end
 Create a new controller to focus on posts.  Each drilldown controller focuses on
 one main entity.
 
-    bin/rails g drilldown_controller User
+    bin/rails g simple_drilldown:controller User
 
 ```ruby
 class PostsDrilldownController < DrilldownController
@@ -115,8 +115,12 @@ results.
 
 ### Views
 
-You need the following views:
+This gem includes views for the drilldown visualization using Bootstrap.
 
+You can override any views by creating them in your `app/views/drilldown` directory.
+If you would like a local copy of the views for overriding you can use the generator.
+
+    bin/rails g simple_drilldown:views
 
 
 ## Excel export

data/app/views/drilldown/_chart.html.erb

@@ -41,12 +41,12 @@
     options << [@dimensions[i][:pretty_name], @dimensions[i][:url_param_name]] if @dimensions[i]
     options += @remaining_dimensions.keys.map { |name| [controller.c_dimension_defs[name][:pretty_name], name] } %>
     <%= t(i == 0 ? :group_by : :then_by) %>:
-    <%= form.select 'dimensions', options, { :selected => @search.dimensions && @search.dimensions[i] },
+    <%= form.select 'dimensions', options.sort, { :selected => @search.dimensions && @search.dimensions[i] },
       { onChange: 'form.submit()', name: 'search[dimensions][]', id: "search_dimensions_#{i}" } %>
   <% end %>
 
   <br/>
-  <%= t :chart_type %>
+  <%= t :chart_type %>:
   <%= form.radio_button 'display_type', SimpleDrilldown::Search::DisplayType::BAR, { :onChange => 'form.submit()' } %>
   <%= form.label :display_type_bar, t(:bar) %>
   <%= form.radio_button 'display_type', SimpleDrilldown::Search::DisplayType::PIE, { :disabled => @search.dimensions.size >= 2, :onChange => 'form.submit()' } %>

data/app/views/drilldown/data_2.builder

@@ -4,7 +4,7 @@ xml.chart(
   xAxisName: (@dimensions[0][:pretty_name] || 'Elections').gsub("'", ''), palette: '2',
   caption: caption, subcaption: subcaption,
   showNames: '1',
-  showValues: @result[:rows].size > 15 || @result[:rows][0] && @result[:rows][0][:rows].size > 4 ? 0 : 1,
+  showValues: @result[:rows].size > 15 || (@result[:rows][0] && @result[:rows][0][:rows].size > 4) ? 0 : 1,
   decimals: '0',
   numberPrefix: '', clustered: '0', exeTime: '1.5', showPlotBorder: '0', zGapPlot: '30',
   zDepth: '90', divLineEffect: 'emboss', startAngX: '10', endAngX: '18', startAngY: '-10',

data/app/views/drilldown/data_3.builder

@@ -5,7 +5,7 @@ xml.chart(
   caption: caption, subcaption: subcaption,
   showNames: '1',
   showValues:
-      @result[:rows].size > 15 || @result[:rows][0] && @result[:rows][0][:rows].size > 4 ? 0 : 1,
+      @result[:rows].size > 15 || (@result[:rows][0] && @result[:rows][0][:rows].size > 4) ? 0 : 1,
   decimals: '0',
   numberPrefix: '', clustered: '0', exeTime: '1.5', showPlotBorder: '0', zGapPlot: '30',
   zDepth: '90', divLineEffect: 'emboss', startAngX: '10', endAngX: '18', startAngY: '-10',

data/app/views/drilldown/excel_export_xlsx.xlsx.axlsx

@@ -11,7 +11,7 @@ def excel_summary_row_xlsx(sheet, result, parent_result = nil, dimension = 0, he
           else
             headers + [{
               value: result[:value],
-              display_row_count: result[:nodes] + result[:row_count] * (@search.list ? 1 : 0)
+              display_row_count: result[:nodes] + (result[:row_count] * (@search.list ? 1 : 0))
             }]
           end
         else

data/app/views/drilldown/index.html.erb

@@ -17,8 +17,9 @@
       <div class="col-md-3" valign="top">
         <ul class="nav nav-tabs">
           <li class="nav-item">
-            <a id="filter-tab" class="nav-link active" data-target="#filter" data-toggle="tab"><%= t :filter %></a></li>
-          <li><a id="fields-tab" class="nav-link" data-target="#fields" data-toggle="tab"><%= t :fields %></a>
+            <a id="filter-tab" class="nav-link active" data-target="#filter" data-toggle="tab" data-bs-toggle="tab" data-bs-target="#filter"><%= t :filter %></a></li>
+          <li class="nav-item">
+            <a id="fields-tab" class="nav-link" data-target="#fields" data-toggle="tab" data-bs-toggle="tab" data-bs-target="#fields"><%= t :fields %></a>
           </li>
         </ul>
 

data/lib/generators/{drilldown_controller → simple_drilldown/controller}/USAGE

@@ -2,7 +2,7 @@ Description:
     Create a DrilldownController.
 
 Example:
-    rails generate drilldown_controller Thing
+    rails generate simple_drilldown:controller Thing
 
     This will create:
         app/controllers/thing_drilldown_controller.rb

data/lib/generators/simple_drilldown/controller/controller_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module SimpleDrilldown
+  class ControllerGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('templates', __dir__)
+
+    def copy_drilldown_controller_file
+      template 'drilldown_controller.rb.erb', "app/controllers/#{file_name}_drilldown_controller.rb"
+      template 'drilldown_controller_test.rb.erb', "test/controllers/#{file_name}_drilldown_controller_test.rb"
+      route "draw_drilldown :#{singular_name}"
+    end
+  end
+end

data/lib/generators/simple_drilldown/views/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Generate drilldown views.
+
+Example:
+    bin/rails generate simple_drilldown:views
+
+    This will create:
+        app/views/drilldown
+        app/views/layouts/drilldown

data/lib/generators/simple_drilldown/views/views_generator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module SimpleDrilldown
+  class ViewsGenerator < Rails::Generators::Base
+    source_root File.expand_path('../../../../', __dir__)
+
+    def copy_drilldown_views_file
+      directory 'app/views'
+    end
+  end
+end

data/lib/simple_drilldown/controller.rb

@@ -36,9 +36,7 @@ module SimpleDrilldown
             # No default target class found
           end
         end
-        return unless base.c_target_class.try :paranoid?
-
-        base.c_base_condition = "#{base.c_target_class.table_name}.deleted_at IS NULL"
+        base.update_base_condition
       end
 
       def base_condition(base_condition)
@@ -63,6 +61,7 @@ module SimpleDrilldown
 
       def target_class(target_class)
         self.c_target_class = target_class
+        update_base_condition
       end
 
       def select(select)
@@ -136,7 +135,9 @@ module SimpleDrilldown
           interval: interval,
           label_method: label_method,
           legal_values: legal_values,
-          pretty_name: I18n.t(name, default: [:"activerecord.models.#{name}", name.to_s.titleize]),
+          pretty_name: I18n.t(:"drilldown.dimension.#{name}",
+                              default: [:"drilldown.#{name}", :"activerecord.models.#{name}", name.to_sym,
+                                        name.to_s.titleize]),
           queries: queries,
           reverse: reverse,
           select_expression:
@@ -148,25 +149,18 @@ module SimpleDrilldown
 
       def legal_values_for(field, preserve_filter = false)
         lambda do |search|
-          my_filter = search.filter.dup
-          my_filter.delete(field.to_s) unless preserve_filter
-          filter_conditions, _t, includes = make_conditions(my_filter)
+          filter = search.filter.dup
+          filter.delete(field.to_s) unless preserve_filter
+          filter_conditions, _t, includes = make_conditions(filter)
           dimension_def = c_dimension_defs[field.to_s]
           result_sets = dimension_def[:queries].map do |query|
-            if query[:includes]
-              if query[:includes].is_a?(Array)
-                includes += query[:includes]
-              else
-                includes << query[:includes]
-              end
-              includes.uniq!
-            end
+            includes = merge_includes(includes, query[:includes]) if query[:includes]
             rows_query = c_target_class.unscoped.where(c_base_condition)
                                        .select("#{query[:select]} AS value")
                                        .joins(make_join([], c_target_class.name.underscore.to_sym, includes))
                                        .order('value')
                                        .group(:value)
-            # rows_query = rows_query.without_deleted if c_target_class.try :paranoid?
+            rows_query = rows_query.without_deleted if c_target_class.try :paranoid?
             rows_query = rows_query.where(filter_conditions) if filter_conditions
             rows_query = rows_query.where(query[:where]) if query[:where]
             rows = rows_query.to_a
@@ -275,8 +269,8 @@ module SimpleDrilldown
             fk_col = ass.options[:foreign_key] || "#{model}_id"
             sql = +"LEFT JOIN #{include_table} #{include_alias} ON #{include_alias}.#{fk_col} = #{model_table}.id"
             sql << " AND #{include_alias}.deleted_at IS NULL" if ass.klass.paranoid?
-            if ass.scope && (ass_order = ScopeHolder.new(ass.scope).to_s)
-              ass_order = ass_order.sub(/ DESC\s*$/i, '')
+            if ass.scope && (base_ass_order = ScopeHolder.new(ass.scope).to_s)
+              /^(?<ass_order>\S*)(?<ass_order_desc>\s+DESC)?/i =~ base_ass_order
               ass_order_prefixed = ass_order.dup
               ActiveRecord::Base.connection.columns(include_table).map(&:name).each do |cname|
                 ass_order_prefixed.gsub!(/\b#{cname}\b/, "#{include_alias}.#{cname}")
@@ -284,10 +278,10 @@ module SimpleDrilldown
               paranoid_clause = 'AND t2.deleted_at IS NULL' if ass.klass.paranoid?
               # FIXME(uwe):  Should we add "where" from the ScopeHolder here as well?
               #              Ref: SimpleDrilldown::Changes#changes_for
-              min_query = <<~SQL
-                SELECT MIN(#{ass_order}) FROM #{include_table} t2 WHERE t2.#{fk_col} = #{model_table}.id #{paranoid_clause}
+              aggregate_query = <<~SQL
+                SELECT #{ass_order_desc ? :MAX : :MIN}(#{ass_order}) FROM #{include_table} t2 WHERE t2.#{fk_col} = #{model_table}.id #{paranoid_clause}
               SQL
-              sql << " AND  #{ass_order_prefixed} = (#{min_query})"
+              sql << " AND  #{ass_order_prefixed} = (#{aggregate_query})"
             end
             sql
           else
@@ -301,6 +295,51 @@ module SimpleDrilldown
           raise "Unknown join class: #{include.inspect}"
         end
       end
+
+      def merge_includes(*args)
+        hash = hash_includes(*args)
+        result = hash.dup.map do |k, v|
+          if v.blank?
+            hash.delete(k)
+            k
+          end
+        end.compact
+        result << hash unless hash.blank?
+        case result.size
+        when 0
+          nil
+        when 1
+          result[0]
+        else
+          result
+        end
+      end
+
+      def hash_includes(*args)
+        args.inject({}) do |h, inc|
+          case inc
+          when Array
+            inc.each do |v|
+              h = hash_includes(h, v)
+            end
+          when Hash
+            inc.each do |k, v|
+              h[k] = merge_includes(h[k], v)
+            end
+          when NilClass, FalseClass
+            # Leave as it is
+          when String, Symbol
+            h[inc] ||= []
+          else
+            raise "Unknown include type: #{inc.inspect}"
+          end
+          h
+        end
+      end
+
+      def update_base_condition
+        self.c_base_condition = "#{c_target_class.table_name}.deleted_at IS NULL" if c_target_class.try :paranoid?
+      end
     end
 
     def initialize
@@ -535,18 +574,18 @@ module SimpleDrilldown
     def populate_list(conditions, includes, result, values)
       return result[:rows].each { |r| populate_list(conditions, includes, r, values + [r[:value]]) } if result[:rows]
 
-      list_includes = merge_includes(includes, c_list_includes)
+      list_includes = self.class.merge_includes(includes, c_list_includes)
       @search.fields.each do |field|
         field_def = c_fields[field.to_sym]
         raise "Field definition missing for: #{field.inspect}" unless field_def
 
         field_includes = field_def[:include]
-        list_includes = merge_includes(list_includes, field_includes) if field_includes
+        list_includes = self.class.merge_includes(list_includes, field_includes) if field_includes
       end
       if @search.list_change_times
         @history_fields.each do |f|
           if @search.fields.include? f
-            list_includes = merge_includes(list_includes, assignment: { order: :"#{f}_changes" })
+            list_includes = self.class.merge_includes(list_includes, assignment: { order: :"#{f}_changes" })
           end
         end
       end
@@ -557,47 +596,6 @@ module SimpleDrilldown
       result[:records] = base_query.to_a
     end
 
-    def merge_includes(*args)
-      hash = hash_includes(*args)
-      result = hash.dup.map do |k, v|
-        if v.blank?
-          hash.delete(k)
-          k
-        end
-      end.compact
-      result << hash unless hash.blank?
-      case result.size
-      when 0
-        nil
-      when 1
-        result[0]
-      else
-        result
-      end
-    end
-
-    def hash_includes(*args)
-      args.inject({}) do |h, inc|
-        case inc
-        when Array
-          inc.each do |v|
-            h = hash_includes(h, v)
-          end
-        when Hash
-          inc.each do |k, v|
-            h[k] = merge_includes(h[k], v)
-          end
-        when NilClass, FalseClass
-          # Leave as it is
-        when String, Symbol
-          h[inc] ||= []
-        else
-          raise "Unknown include type: #{inc.inspect}"
-        end
-        h
-      end
-    end
-
     def list_conditions(conditions, values)
       conditions ||= ['']
 

data/lib/simple_drilldown/helper.rb

@@ -31,7 +31,7 @@ module SimpleDrilldown
       if result[:rows]
         sub_headers = headers + [{
           value: result[:value],
-          display_row_count: result[:nodes] + result[:row_count] * (@search.list ? 1 : 0)
+          display_row_count: result[:nodes] + (result[:row_count] * (@search.list ? 1 : 0))
         }]
         significant_rows = result[:rows].reject { |r| r[:row_count].zero? }
         significant_rows.each_with_index do |r, i|
@@ -62,7 +62,7 @@ module SimpleDrilldown
               else
                 headers + [{
                   value: result[:value],
-                  display_row_count: result[:nodes] + result[:row_count] * (@search.list ? 1 : 0)
+                  display_row_count: result[:nodes] + (result[:row_count] * (@search.list ? 1 : 0))
                 }]
               end
             else
@@ -89,9 +89,13 @@ module SimpleDrilldown
     private
 
     def caption_txt
-      "#{controller.c_target_class} #{I18n.t(@search.select_value.downcase,
-                                             default: @search.select_value.to_s.titleize)}" +
-        (@dimensions && @dimensions.any? ? " by #{@dimensions.map { |d| d[:pretty_name] }.join(' and ')}" : '')
+      class_txt = controller.c_target_class &&
+                  I18n.t(controller.c_target_class.name.pluralize.to_sym,
+                         default: [controller.c_target_class.name.downcase.pluralize.to_sym,
+                                   controller.c_target_class.name.pluralize])
+      value_txt = I18n.t(@search.select_value.downcase, default: @search.select_value.to_s.titleize)
+      dimensions_txt = " by #{@dimensions.map { |d| d[:pretty_name] }.join(' and ')}" if @dimensions&.any?
+      "#{class_txt} #{value_txt}#{dimensions_txt}"
     end
   end
 end

data/lib/simple_drilldown/search.rb

@@ -47,7 +47,7 @@ module SimpleDrilldown
         attributes = attributes_or_search
         @default_fields = default_fields
         @default_select_value = default_select_value
-        @dimensions = attributes && attributes[:dimensions] || []
+        @dimensions = (attributes && attributes[:dimensions]) || []
         @dimensions.delete_if(&:empty?)
         @filter = attributes && attributes[:filter] ? attributes[:filter] : {}
         @filter.keys.dup.each { |k| @filter[k] = Array(@filter[k]) }

data/lib/simple_drilldown/version.rb

@@ -1,3 +1,3 @@
 module SimpleDrilldown
-  VERSION = '0.9.11'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_drilldown
 version: !ruby/object:Gem::Version
-  version: 0.9.11
+  version: 0.11.0
 platform: ruby
 authors:
 - Uwe Kubosch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-16 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: caxlsx_rails
@@ -137,10 +137,12 @@ files:
 - config/locales/en.yml
 - config/locales/nb.yml
 - config/routes.rb
-- lib/generators/drilldown_controller/USAGE
-- lib/generators/drilldown_controller/drilldown_controller_generator.rb
-- lib/generators/drilldown_controller/templates/drilldown_controller.rb.erb
-- lib/generators/drilldown_controller/templates/drilldown_controller_test.rb.erb
+- lib/generators/simple_drilldown/controller/USAGE
+- lib/generators/simple_drilldown/controller/controller_generator.rb
+- lib/generators/simple_drilldown/controller/templates/drilldown_controller.rb.erb
+- lib/generators/simple_drilldown/controller/templates/drilldown_controller_test.rb.erb
+- lib/generators/simple_drilldown/views/USAGE
+- lib/generators/simple_drilldown/views/views_generator.rb
 - lib/simple_drilldown.rb
 - lib/simple_drilldown/changes.rb
 - lib/simple_drilldown/controller.rb
@@ -170,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Simple data warehouse and drilldown.

data/lib/generators/drilldown_controller/drilldown_controller_generator.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-class DrilldownControllerGenerator < Rails::Generators::NamedBase
-  source_root File.expand_path('templates', __dir__)
-
-  def copy_drilldown_controller_file
-    template 'drilldown_controller.rb.erb', "app/controllers/#{file_name}_drilldown_controller.rb"
-    template 'drilldown_controller_test.rb.erb', "test/controllers/#{file_name}_drilldown_controller_test.rb"
-    route "draw_drilldown :#{singular_name}"
-  end
-end