active_reporter 0.6.5 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 723ed733317c2a8e7a9671f7df71388c7df0b8019824ef83a8455d1fc2358a26
-  data.tar.gz: 6897c073647fc646151861295592048449e80803ba000332a63b6a026942d770
+  metadata.gz: a17f440927f29a1dac9ad70f949fc92d0f57c72d8ccac27a4b27c0e737f86b43
+  data.tar.gz: 7cede09d4c1e903437b18b945e2ad3ea283ac6cdf886a21cd938124d1c39bcbf
 SHA512:
-  metadata.gz: 1d8eb39876e5f564fdf8b3522b9e1a6739052311b57f525baa4ac827fc0a3507a515c355a23f0b8d1e6280976a9f17dd654e80fb16e39278ceb82fed6fdb2d78
-  data.tar.gz: 89b76c59b8ef242536ed4758c7ff036fa35425703c57a56f1d212a72b642a5f5d24d919e2bc16c4907e93cac6e74e24d8500ca6f1d6ef2502c381cb4ab111fb0
+  metadata.gz: '0851b545beec8ac54b01d5148e8a04b0b39ef94e26f6ce8ca946ab6243bb2bb2f96da10d5d057748142b46d837310397443a27ce1c3b1eaed37faa8a5026be04'
+  data.tar.gz: a511a0301caeff962a234cf472b1557cda47381e04091af704816fcd3951fe4d4bfba4e531f30aeeb6b945ef9b5e038d277ab2ae30a5f915ede53964da09549a

data/README.md

@@ -283,7 +283,7 @@ params[:dimensions][<time dimension>][:bin_width] = { months: 2, hours: 2 }
 ```
 
 `Number`s will default to using 10 bins and `Time`s will
-default to using a sensical increment of time given the domain; you can
+default to using a sensible increment of time given the domain; you can
 customize this by overriding methods in those classes.
 
 Note that when you inspect `report.data` after grouping by a bin dimension, you

data/lib/active_reporter/dimension/bin/set.rb

@@ -136,7 +136,7 @@ module ActiveReporter
         alias eql? ==
 
         def bin_edges
-          case 
+          case
           when min_and_max? then :min_and_max
           when min? then :min
           when max? then :max

data/lib/active_reporter/dimension/bin.rb

@@ -115,7 +115,7 @@ module ActiveReporter
 
       def autopopulate_bins
         return [] if bin_start.blank? || bin_end.blank?
-        
+
         bin_count = ((bin_end - bin_start)/(bin_width)).to_i
         invalid_param!(:bin_width, "is too small for the domain; would generate #{bin_count.to_i} bins") if bin_count > max_bins
 

data/lib/active_reporter/dimension/time.rb

@@ -11,7 +11,7 @@ module ActiveReporter
       def validate_params!
         super
 
-        invalid_param!(:bin_width, "must be a valid width value or a hash where each hash keys is a valid value and each hash value\n  is interger representing the count of the key width\n  valid :bin_width values include #{STEPS.to_sentence}.") if params.key?(:bin_width) && !valid_duration?(params[:bin_width])
+        invalid_param!(:bin_width, "must be a valid width value or a hash where each hash keys is a valid value and each hash value\n  is an integer representing the count of the key width\n  valid :bin_width values include #{STEPS.to_sentence}.") if params.key?(:bin_width) && !valid_duration?(params[:bin_width])
       end
 
       def bin_width
@@ -29,7 +29,7 @@ module ActiveReporter
         # ensure that each autogenerated bin represents a correctly aligned
         # day/week/month/year
         bin_start = super
-        
+
         return if bin_start.nil?
 
         step = BIN_STEPS.detect { |step| bin_width == 1.send(step) }

data/lib/active_reporter/report/aggregation.rb

@@ -80,7 +80,7 @@ module ActiveReporter
           # Trackers can only be applied if the last grouper is a bin dimension, since bin dimensions are series of the
           # same data set with a pre-defined sequence. Bin dimension results also allow us to determine if an empty set
           # is present, because the bins are pre-defined.
-          # If additional demensions are included the trackers reset each time these groups change. For example, if the
+          # If additional dimensions are included the trackers reset each time these groups change. For example, if the
           # category dimension "author.id" and time dimension "created_at" with bin_width "day" are used, each time the
           # "author.id" value (bin) changes the tracker is reset so we do not track changes from the last day of each
           # "author.id" to the first day of the next "author.id".
@@ -121,7 +121,6 @@ module ActiveReporter
             results[calculator_group] = calculable? ? (raw_data[calculator_group] || calculator.default_value) : nil
           end
 
-          
           trackers.each do |name, tracker|
             tracker_group = group + [name.to_s]
             results[tracker_group] = trackable? ? (raw_data[tracker_group] || tracker.default_value) : nil
@@ -234,18 +233,18 @@ module ActiveReporter
         # field with identical values. If the field type is integer we can deduce the bin width to be 1, but if the
         # type is string or float the the width is less evident.
         # For example, if the field is float and the first value is 1.0 should the next sequential value be 1.1? What
-        # if we have 1.0001? Should we skip 1.0002 if it does not exist and skip right to 1.01? What if we habe 1.0,
+        # if we have 1.0001? Should we skip 1.0002 if it does not exist and skip right to 1.01? What if we have 1.0,
         # 1.1, 1.11, and 1.13 but no 1.12? So we determine that 1.13 is sequentially after 1.11 or de we reset the
         # tracker? Even if there is a "correct" method for one report it may not be correct for a different report. The
         # same problem applies to strings. Which character is after "z"? The ASCII hex value is "{", which would work
         # fine for ordering, but maybe not for determining when a tracker should be reset. Additionally, we need to
         # deal with strings of different lengths. Alphabetically you could order "A", "AA", "AAA", "B" but how do know
-        # when to reset the tracker? If we get a new value of "AAAA" we have entirelly new values used to calculate the
-        # tracker value for the "B" row, effectivally making the tracker values irrelevent.
+        # when to reset the tracker? If we get a new value of "AAAA" we have entirely new values used to calculate the
+        # tracker value for the "B" row, effectively making the tracker values irrelevant.
         # Even going back to the integer example, the value allowed to be stored increments by 1, but there is no
-        # guerentee that these are the actual values being used in the field.
+        # guarantee that these are the actual values being used in the field.
         # For these reasons we will not attempt to track any dimension that does not specifically specify a bin width.
-        
+
         # Any class that inherits from Bin will be evaluated, this includes both Number and Time classes, all other
         # classes will be skipped.
         return false unless dimension.is_a?(ActiveReporter::Dimension::Bin)

data/lib/active_reporter/report/definition.rb

@@ -41,7 +41,7 @@ module ActiveReporter
         # this data, and so multiple aggregator types are provided.
         #
         # Average aggregator would calculate the average value across all the data in the group.
-        # 
+        #
         # Sum aggregator would calculate the sum total of all values across all the data in the group.
         #
         # Additional aggregators are also available for many other calculation types
@@ -86,7 +86,7 @@ module ActiveReporter
         # are configured and an aggregator to sum Likes is configured, a tracker to calculate Likes delta may also be
         # used. Each Published date the delta will be calculated, as long as the previous row has a Published date
         # sequentially immediately adjacent to the current row. If the bin with is date, the dates 2020/06/05 and
-        # 2020/06/06 are adjacent, but if there are no blog posts for 2020/06/07 then the dela will not be calculated
+        # 2020/06/06 are adjacent, but if there are no blog posts for 2020/06/07 then the delta will not be calculated
         # on the 2020/06/08 row since 2020/06/06 is not adjacent. Additionally, when the Author changes no delta will
         # be calculated, even if the Published date on the row is sequentially immediately adjacent.
         #

data/lib/active_reporter/report.rb

@@ -5,7 +5,7 @@ module ActiveReporter
     include ActiveReporter::Report::Definition
     include ActiveReporter::Report::Validation
     include ActiveReporter::Report::Metrics
-    include ActiveReporter::Report::Aggregation    
+    include ActiveReporter::Report::Aggregation
 
     attr_reader :params, :parent_report, :parent_groupers, :supplements
 
@@ -18,7 +18,7 @@ module ActiveReporter
       # When using a Calculator you may need the parent report data. Pass in a ActiveReporter::Report object when
       # instantiating a new ActiveReporter::Report instance as :parent_report. This will allow you to calculate a data
       # based on the #total_report of this passed :parent_report. For example, if the parent report includes a sum
-      # aggregated "views" column, the child report can use Report::Calculator::Ratio to caluclate the ratio of "views"
+      # aggregated "views" column, the child report can use Report::Calculator::Ratio to calculate the ratio of "views"
       # on a given row versus the total "views" from the parent report.
       @parent_report = @params.delete(:parent_report)
       @parent_groupers = @params.delete(:parent_groupers) || ( grouper_names & Array(parent_report&.grouper_names) )
@@ -26,8 +26,8 @@ module ActiveReporter
       # Supplements -> supplemental reports and data
       #
       # we need 2 items:
-      # 1- the #supplements, a hash of reports and data, we can refrence by name
-      # => this is passed into the report initializer, the key is the name the value is the enrire report object
+      # 1- the #supplements, a hash of reports and data, we can reference by name
+      # => this is passed into the report initializer, the key is the name the value is the entire report object
       # 2- a configuration class, this will allow you to specify a special aggregator in the report class that
       # => take a block. The block defines { |key, row| return_value }, the block has access to the data in
       # #supplements available to use when calculating return the value.
@@ -50,18 +50,17 @@ module ActiveReporter
 
       validate_params!
 
-      # After params are parsed and validated you can call #data (or any derivitive of: #raw_data, #flat_data,
+      # After params are parsed and validated you can call #data (or any derivative of: #raw_data, #flat_data,
       # #hashed_data, #nested_data, etc.) on the ActiveReporter::Report object to #aggregate the data. This will
       # aggregate all the raw data by the configured dimensions, process any calculators, and then process any
       # trackers.
-      
-      # Caclulators calculate values using the current row data and the #parent_report.
-      
-      # Trackers calculate values using the current row data and prior row data.
 
+      # Calculators calculate values using the current row data and the #parent_report.
+
+      # Trackers calculate values using the current row data and prior row data.
 
       # If pre-compiled raw data was passed in, process all :calculators and :trackers now.
-      aggregate if  @raw_data.present? && ( @params.include?(:calculators) || @params.include?(:trackers) )
+      aggregate if @raw_data.present? && ( @params.include?(:calculators) || @params.include?(:trackers) )
       total if @total_data.present?
     end
 

data/lib/active_reporter/serializer/base.rb

@@ -5,8 +5,9 @@ module ActiveReporter
     class Base
       attr_reader :report
 
-      def initialize(report)
+      def initialize(report, **options)
         @report = report
+        @options = options
       end
 
       # Consider overriding many of these methods to use I18n with keys based

data/lib/active_reporter/serializer/nested_hash_with_id.rb

@@ -0,0 +1,22 @@
+module ActiveReporter
+  module Serializer
+    class NestedHashWithId < Base
+      ID_DELIMITER = "✦".freeze
+
+      def table
+        report.hashed_data.collect { |row| row.map { |k,v| [k, (v.respond_to?(:min) ? v.min : v).to_s] }.to_h }.collect do |row|
+          row_with_id = row.merge(_id: row.slice(*report.grouper_names).values.join(key_delimiter))
+          report.grouper_names.reverse.inject(row_with_id.slice(*report.all_aggregators.keys.prepend(:_id))) do |nested_row_data, group|
+            { row_with_id[group] => nested_row_data }
+          end
+        end.reduce({}, :deep_merge)
+      end
+
+      private
+
+      def key_delimiter
+        @key_delimiter ||= @options[:id_delimiter] || ID_DELIMITER
+      end
+    end
+  end
+end

data/lib/active_reporter/serializer.rb

@@ -5,3 +5,4 @@ require "active_reporter/serializer/form_field"
 require "active_reporter/serializer/highcharts"
 require "active_reporter/serializer/hash_table"
 require "active_reporter/serializer/nested_hash"
+require "active_reporter/serializer/nested_hash_with_id"

data/lib/active_reporter/version.rb

@@ -1,3 +1,3 @@
 module ActiveReporter
-  VERSION = "0.6.5"
+  VERSION = "0.7.1"
 end

data/spec/acceptance/data_spec.rb

@@ -34,7 +34,7 @@ describe "more complicated case" do
   def expect_equal(h1, h2)
     # sqlite uses Float instead of BigDecimal, we need to normalize the JSON objects to use the
     # same data type so the values match. We also round these at 9 decimal places to account for
-    # rounding discrepencies between the two data types 
+    # rounding discrepancies between the two data types
 
     h1_json = JSON.parse(h1.to_json).map do |a|
       a.deep_transform_values do |v|
@@ -227,7 +227,7 @@ describe "more complicated case" do
           { key: :min_likes, value: 3 },
           { key: :max_likes, value: 3 }
         ] }
-      ] } 
+      ] }
     ]
   end
 

data/spec/active_reporter/dimension/enum_spec.rb

@@ -14,7 +14,7 @@ describe ActiveReporter::Dimension::Enum do
   let(:enum_values) { { "draft" => 0, "unpublished" => 1, "published" => 2, "archived" => 3 } }
   let(:group_values) { ["published", "archived"] }
   let(:all_values) { enum_values.keys.unshift(nil) }
-  
+
   let(:status_dimension) do
     dimension = ActiveReporter::Dimension::Enum.new(:status, report, { model: report_model, only: filter_values })
     allow(dimension).to receive(:enum_values).and_return(enum_values)

data/spec/active_reporter/report_spec.rb

@@ -24,12 +24,12 @@ describe ActiveReporter::Report do
   let(:report) { report_model.new({groupers: groupers, aggregators: aggregators, dimensions: dimensions, parent_report: parent_report, parent_groupers: parent_groupers, calculators: calculators, trackers: trackers}.compact) }
 
   let(:year) { 1.year.ago.year }
-  
+
   let(:jan_datetime) { Time.new(year,1,1,0,0,0,0) }
   let(:feb_datetime) { Time.new(year,2,1,0,0,0,0) }
   let(:mar_datetime) { Time.new(year,3,1,0,0,0,0) }
   let(:apr_datetime) { Time.new(year,4,1,0,0,0,0) }
-  
+
   let(:jan) { { min: jan_datetime, max: jan_datetime.next_month } }
   let(:feb) { { min: feb_datetime, max: feb_datetime.next_month } }
   let(:mar) { { min: mar_datetime, max: mar_datetime.next_month } }
@@ -93,7 +93,7 @@ describe ActiveReporter::Report do
     let!(:author1_jan01_post) { create(:post, author: author1, created_at: Date.new(year,1,1), likes: 7) }
     let!(:author1_jan12_post) { create(:post, author: author1, created_at: Date.new(year,1,12), likes: 4) }
     let!(:author1_mar08_post) { create(:post, author: author1, created_at: Date.new(year,3,8), likes: 11) }
-    
+
     let!(:author2_jan15_post) { create(:post, author: author2, created_at: Date.new(year,1,15), likes: 3) }
     let!(:author2_feb27_post) { create(:post, author: author2, created_at: Date.new(year,2,27), likes: 24) }
     let!(:author2_feb28_post) { create(:post, author: author2, created_at: Date.new(year,2,28), likes: 0) }

data/spec/active_reporter/serializer/nested_hash_spec.rb

@@ -0,0 +1,47 @@
+require "spec_helper"
+
+describe ActiveReporter::Serializer::NestedHash do
+  let(:report_model) do
+    Class.new(ActiveReporter::Report) do
+      report_on :Post
+      number_dimension :likes
+      time_dimension :created_at
+      category_dimension :title
+      count_aggregator :post_count
+      sum_aggregator :likes_count, attribute: :likes
+    end
+  end
+
+  let(:report) do
+    report_model.new(
+      aggregators: [:post_count, :likes_count],
+      groupers: %i[title created_at],
+      dimensions: { created_at: { bin_width: "1 day" } }
+    )
+  end
+
+  let(:nested_hash_with_id) { ActiveReporter::Serializer::NestedHash.new(report) }
+  let!(:data_records) do
+    [
+      create(:post, created_at: "2016-01-01", likes: 2, title: "A"),
+      create(:post, created_at: "2016-01-01", likes: 2, title: "A"),
+      create(:post, created_at: "2016-01-01", likes: 1, title: "B"),
+      create(:post, created_at: "2016-01-02", likes: 1, title: "A"),
+    ]
+  end
+
+  describe "#report" do
+    it "builds report" do
+      expect(nested_hash_with_id.table).to eq({
+        "A" => {
+          "2016-01-01 00:00:00 UTC" => { post_count: "2", likes_count: "4" },
+          "2016-01-02 00:00:00 UTC" => { post_count: "1", likes_count: "1" },
+        },
+        "B" => {
+          "2016-01-01 00:00:00 UTC" => { post_count: "1", likes_count: "1" },
+          "2016-01-02 00:00:00 UTC" => { post_count: "0", likes_count: "0" },
+        }
+      })
+    end
+  end
+end

data/spec/active_reporter/serializer/nested_hash_with_id_spec.rb

@@ -0,0 +1,69 @@
+require "spec_helper"
+
+describe ActiveReporter::Serializer::NestedHashWithId do
+  let(:report_model) do
+    Class.new(ActiveReporter::Report) do
+      report_on :Post
+      number_dimension :likes
+      time_dimension :created_at
+      category_dimension :title
+      count_aggregator :post_count
+      sum_aggregator :likes_count, attribute: :likes
+    end
+  end
+
+  let(:report) do
+    report_model.new(
+      aggregators: [:post_count, :likes_count],
+      groupers: %i[title created_at],
+      dimensions: { created_at: { bin_width: "1 day" } }
+    )
+  end
+
+  let(:nested_hash_with_id) { ActiveReporter::Serializer::NestedHashWithId.new(report) }
+  let!(:data_records) do
+    [
+      create(:post, created_at: "2016-01-01", likes: 2, title: "A"),
+      create(:post, created_at: "2016-01-01", likes: 2, title: "A"),
+      create(:post, created_at: "2016-01-01", likes: 1, title: "B"),
+      create(:post, created_at: "2016-01-02", likes: 1, title: "A"),
+    ]
+  end
+
+  describe "#report" do
+    context "with :id_delimiter option" do
+      let(:id_delimiter) { "___" }
+      let(:nested_hash_with_id) { ActiveReporter::Serializer::NestedHashWithId.new(report, id_delimiter: id_delimiter) }
+
+      it "builds report" do
+        expect(nested_hash_with_id.table).to eq({
+          "A" => {
+            "2016-01-01 00:00:00 UTC" => { _id: "A#{id_delimiter}2016-01-01 00:00:00 UTC", post_count: "2", likes_count: "4" },
+            "2016-01-02 00:00:00 UTC" => { _id: "A#{id_delimiter}2016-01-02 00:00:00 UTC", post_count: "1", likes_count: "1" },
+          },
+          "B" => {
+            "2016-01-01 00:00:00 UTC" => { _id: "B#{id_delimiter}2016-01-01 00:00:00 UTC", post_count: "1", likes_count: "1" },
+            "2016-01-02 00:00:00 UTC" => { _id: "B#{id_delimiter}2016-01-02 00:00:00 UTC", post_count: "0", likes_count: "0" },
+          }
+        })
+      end
+    end
+
+    context "without :id_delimiter option" do
+      let(:id_delimiter) { ActiveReporter::Serializer::NestedHashWithId::ID_DELIMITER  }
+
+      it "builds report" do
+        expect(nested_hash_with_id.table).to eq({
+          "A" => {
+            "2016-01-01 00:00:00 UTC" => { _id: "A#{id_delimiter}2016-01-01 00:00:00 UTC", post_count: "2", likes_count: "4" },
+            "2016-01-02 00:00:00 UTC" => { _id: "A#{id_delimiter}2016-01-02 00:00:00 UTC", post_count: "1", likes_count: "1" },
+          },
+          "B" => {
+            "2016-01-01 00:00:00 UTC" => { _id: "B#{id_delimiter}2016-01-01 00:00:00 UTC", post_count: "1", likes_count: "1" },
+            "2016-01-02 00:00:00 UTC" => { _id: "B#{id_delimiter}2016-01-02 00:00:00 UTC", post_count: "0", likes_count: "0" },
+          }
+        })
+      end
+    end
+  end
+end

data/spec/dummy/app/models/data_builder.rb

@@ -62,7 +62,7 @@ class DataBuilder
         stddev_likes = gaussian(10, 2.5)
         h[author] = [average_likes, stddev_likes]
       end
-      
+
       likeability_for = Hash.new { |author_hash, author|
         author_hash[author] = Hash.new { |title_hash, title|
           average_likes, stddev_likes = author_likeability[author]