artirix_data_models 0.6.7 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c56b4f635171ba067ea9c4fdd3082c412eaab23a
-  data.tar.gz: d25c8af81bf51fa14bd5fff95c3c7a9d6506e97d
+  metadata.gz: f15642b0096a000e01eb83c1ce3016f0af83b001
+  data.tar.gz: afdfc74dd09d32112a198cf4a5f9c89b2437b84c
 SHA512:
-  metadata.gz: 004f2a8fa562df1dddc3a5ef35986257590d298760eff8dbaead938d12a0c9be9e782c156378d53d06a8a5df3191cb9c73de457d4042fbb2e973e5914cf22fe5
-  data.tar.gz: 242a1a52ad9feaaa30684bdfdacec0ee42c9af37fefee9cc9936ff761efd3696ab07d17edfcc71a77cf0576b6564aa47fae1492e9f6af9a54367b833b14ce22e
+  metadata.gz: 6484979971c7378ad68acf26d6a9ca4be25869643a111a049b66efd85fce6a2fb80222fb0d039ea8389cd20592dd258f8d95de00e5988aa309cff2540c235ddf
+  data.tar.gz: d15b73a1ac5588b68178842a2c456055ba4bfe674b516425dabf4baab8ed5ccdef82b89e14e8669b5c1f81ee9abb228b132be92e3767953194957ab7571aa11b

data/README.md

@@ -250,6 +250,18 @@ end
 
 ## Changes
 
+### 0.7.1
+
+- added `MetricAggregation`. Normal `AggregationBuilder` will build an aggregation with that class if instead of `buckets` it finds `value` in the JSON.  
+- normalize raw aggregations now does not ignore metric aggregations (see above)
+- added `calculate_filtered(filtered_values)` to aggregations (noop in Metric aggregations). In a bucket aggregation, will mark with `filtered?` each bucket (aka Aggregation Value) if the `bucket.name` is present in the given `filtered_values`.
+- added to `Aggregation` the methods: 
+-- `filtered_buckets` that will return only buckets marked as `filtered?`
+-- `unfiltered_buckets` that will return only buckets not marked as `filtered?`
+-- `filtered_first_buckets` that will concatenate `filtered_buckets` and `unfiltered_buckets`
+- changed classes to stop inheriting from `Struct`, had some problems with inheritance.
+- `Aggregation`, `Aggregation::Value` and `MetricAggregation` now using the same inspection as models.
+
 ### 0.6.7
 
 - aggregations use `key_as_string` as name of the bucket value if it exists, if not then it uses `key` and if that also does not exist then it uses `name`
@@ -288,6 +300,10 @@ end
 
 ## Yanked versions
 
+### ~0.7.0~
+
+Yanked because of bug on Aggregations. Released 0.7.1 with the fix. Changeset moved too to 0.7.1 
+
 ### ~0.6.3~
 
 Yanked because of typo bug on SortedBucketAggregationBase. Released 0.6.3.1 with the fix.

data/lib/artirix_data_models.rb

@@ -14,6 +14,7 @@ require 'hashie'
 
 
 # loading features
+require 'artirix_data_models/inspectable'
 require 'artirix_data_models/es_collection'
 require 'artirix_data_models/aggregation'
 require 'artirix_data_models/aggregations_factory'

data/lib/artirix_data_models/aggregation.rb

@@ -1,15 +1,22 @@
 module ArtirixDataModels
-  class Aggregation < Struct.new(:name, :buckets)
+  class CommonAggregation
+    include Inspectable
+    attr_accessor :name
 
-    include Enumerable
-
-    delegate :each, :empty?, to: :buckets
+    def initialize(name)
+      @name = name
+    end
 
-    def self.from_json(definition, value_class = Value)
+    def self.from_json(definition, value_class = Aggregation::Value)
       DAORegistry.aggregations_factory.aggregation_from_json(definition, value_class: value_class, aggregation_class: self)
     end
 
     def pretty_name
+      @pretty_name ||= load_pretty_name
+    end
+
+    private
+    def load_pretty_name
       I18n.t("aggregations.#{name.to_s.gsub('.', '_')}.name", default: default_pretty_name)
     end
 
@@ -17,6 +24,20 @@ module ArtirixDataModels
       name
     end
 
+  end
+
+  class Aggregation < CommonAggregation
+    include Enumerable
+
+    attr_accessor :buckets
+
+    def initialize(name, buckets)
+      super name
+      @buckets = buckets
+    end
+
+    delegate :each, :empty?, to: :buckets
+
     def non_empty_buckets
       buckets.reject { |x| x.empty? }
     end
@@ -28,10 +49,40 @@ module ArtirixDataModels
       }
     end
 
-    class Value < Struct.new(:aggregation_name, :name, :count, :aggregations)
+    def calculate_filtered(filtered_values = [])
+      buckets.each do |b|
+        b.filtered = filtered_values.include?(b.name)
+      end
+
+      self
+    end
+
+    def filtered_buckets
+      buckets.select &:filtered?
+    end
+
+    def unfiltered_buckets
+      buckets.reject &:filtered?
+    end
+
+    def filtered_first_buckets
+      filtered_buckets + unfiltered_buckets
+    end
+
+    class Value
+
+      attr_accessor :filtered, :aggregation_name, :name, :count
+      attr_writer :aggregations
+
+      def initialize(aggregation_name, name, count, aggregations)
+        @aggregation_name = aggregation_name
+        @name             = name
+        @count            = count
+        @aggregations     = aggregations
+      end
 
       def aggregations
-        Array(super)
+        Array(@aggregations)
       end
 
       alias_method :nested_aggregations, :aggregations
@@ -69,6 +120,18 @@ module ArtirixDataModels
         }
       end
 
+      def mark_filtered
+        @filtered = true
+      end
+
+      def mark_unfiltered
+        @filtered = false
+      end
+
+      def filtered?
+        !!@filtered
+      end
+
       private
       def load_pretty_name
         tranlsation_key = "aggregations.#{aggregation_name.to_s.gsub('.', '_')}.buckets.#{name.to_s.gsub('.', '_')}"
@@ -76,4 +139,26 @@ module ArtirixDataModels
       end
     end
   end
+
+  class MetricAggregation < CommonAggregation
+    attr_accessor :value
+
+    def initialize(name, value)
+      super name
+      @value = value
+    end
+
+    def data_hash
+      {
+        name:  name,
+        value: value
+      }
+    end
+
+    def calculate_filtered(_filtered_values = [])
+      # NOOP
+      self
+    end
+  end
+
 end

data/lib/artirix_data_models/aggregation_builder.rb

@@ -1,22 +1,35 @@
 module ArtirixDataModels
 
   class AggregationBuilder
-    attr_reader :aggregations_factory, :definition, :value_class, :aggregation_class
-
-    def initialize(aggregations_factory:, definition:, aggregation_class: Aggregation, value_class: Aggregation::Value)
-      @aggregations_factory = aggregations_factory
-      @definition           = definition
-      @aggregation_class    = aggregation_class
-      @value_class          = value_class
+    attr_reader :aggregations_factory, :definition, :value_class, :aggregation_class, :metric_aggregation_class
+
+    def initialize(aggregations_factory:, definition:, aggregation_class: Aggregation, metric_aggregation_class: MetricAggregation, value_class: Aggregation::Value)
+      @aggregations_factory     = aggregations_factory
+      @definition               = definition
+      @aggregation_class        = aggregation_class
+      @metric_aggregation_class = metric_aggregation_class || aggregation_class
+      @value_class              = value_class
     end
 
     def build
-      aggregation_class.new agg_name, buckets
+      if is_metric?
+        metric_aggregation_class.new agg_name, value
+      else
+        aggregation_class.new agg_name, buckets
+      end
     end
 
     alias_method :call, :build
 
     private
+    def is_metric?
+      definition.key?(:value) && !definition.key?(:buckets)
+    end
+
+    def value
+      definition[:value]
+    end
+
     def buckets
       definition[:buckets].map do |bucket|
         build_bucket(bucket)

data/lib/artirix_data_models/inspectable.rb

@@ -0,0 +1,16 @@
+module ArtirixDataModels
+  module Inspectable
+    def inspect
+      inspect_with_tab 1
+    end
+
+    def inspect_with_tab(tab_level = 0)
+      insp = data_hash.map do |at, val|
+        v   = val.try(:inspect_with_tab, tab_level + 1) || val.inspect
+        tab = ' ' * tab_level * 4
+        "#{tab} - #{at}: #{v}"
+      end
+      "#<#{self.class} \n#{insp.join("\n")}>"
+    end
+  end
+end

data/lib/artirix_data_models/model.rb

@@ -107,6 +107,7 @@ module ArtirixDataModels
 
       included do
         include KeywordInit
+        include Inspectable
       end
 
       def self.direct_getter_method_name(attribute)
@@ -121,19 +122,6 @@ module ArtirixDataModels
         data_hash.reject { |_, v| v.nil? }
       end
 
-      def inspect_with_tab(tab_level = 0)
-        insp = data_hash.map do |at, val|
-          v   = val.try(:inspect_with_tab, tab_level + 1) || val.inspect
-          tab = ' ' * tab_level * 4
-          "#{tab} - #{at}: #{v}"
-        end
-        "#<#{self.class} \n#{insp.join("\n")}>"
-      end
-
-      def inspect
-        inspect_with_tab 1
-      end
-
       module ClassMethods
         def attribute(*attributes)
           attributes.each { |attribute| _define_attribute attribute }

data/lib/artirix_data_models/raw_aggregation_data_normaliser.rb

@@ -2,6 +2,7 @@ module ArtirixDataModels
   class RawAggregationDataNormaliser
 
     FIND_BUCKETS = ->(_k, v, _o) { v.respond_to?(:key?) && v.key?(:buckets) }
+    FIND_VALUE   = ->(_k, v, _o) { v.respond_to?(:key?) && v.key?(:value) }
 
     attr_reader :raw_aggs, :aggregations_factory, :list
 
@@ -25,6 +26,11 @@ module ArtirixDataModels
     private
 
     def normalise_hash(hash)
+      treat_buckets(hash)
+      treat_values(hash)
+    end
+
+    def treat_buckets(hash)
       with_buckets_list = deep_locate hash, FIND_BUCKETS
 
       with_buckets_list.each do |with_buckets|
@@ -34,17 +40,29 @@ module ArtirixDataModels
       end
     end
 
+    def treat_values(hash)
+      with_values_list = deep_locate hash, FIND_VALUE
+
+      with_values_list.each do |with_values|
+        with_values.each do |name, value|
+          normalise_element(name, value)
+        end
+      end
+    end
+
     def normalise_element(name, value)
       return unless Hash === value
 
       if value.key?(:buckets)
-        add_normalised_element_to_list(name, value)
+        add_normalised_buckets_element_to_list(name, value)
+      elsif value.key?(:value)
+        add_normalised_value_element_to_list(name, value)
       else
         normalise_hash(value)
       end
     end
 
-    def add_normalised_element_to_list(name, value)
+    def add_normalised_buckets_element_to_list(name, value)
       buckets = value[:buckets].map do |raw_bucket|
         normalise_bucket(raw_bucket)
       end
@@ -52,6 +70,10 @@ module ArtirixDataModels
       list << { name: name, buckets: buckets }
     end
 
+    def add_normalised_value_element_to_list(name, value)
+      list << { name: name, value: value[:value] }
+    end
+
     def normalise_bucket(raw_bucket)
       basic_bucket(raw_bucket).tap do |bucket|
         nested_aggs           = nested_aggs_from(raw_bucket)

data/lib/artirix_data_models/version.rb

@@ -1,3 +1,3 @@
 module ArtirixDataModels
-  VERSION = '0.6.7'
+  VERSION = '0.7.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artirix_data_models
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.7.1
 platform: ruby
 authors:
 - Eduardo Turiño
@@ -256,6 +256,7 @@ files:
 - lib/artirix_data_models/fake_response_factory.rb
 - lib/artirix_data_models/gateway_response_adaptors/model_adaptor.rb
 - lib/artirix_data_models/gateways/data_gateway.rb
+- lib/artirix_data_models/inspectable.rb
 - lib/artirix_data_models/model.rb
 - lib/artirix_data_models/raw_aggregation_data_normaliser.rb
 - lib/artirix_data_models/spec_support.rb