artirix_data_models 0.6.2 → 0.6.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c953eedf5e26123d9a2136591abf12b0a6be6ff
-  data.tar.gz: a3966ad6e6704d526176554e4b9a5d332dde1264
+  metadata.gz: 6bf75f8fabe2f1161d1306a0c1d1da33abc2e178
+  data.tar.gz: 033a3edd3d4ec0c2cb5158ec3fda73a05e9a6c7f
 SHA512:
-  metadata.gz: 2c79dbd9b140a1e584bad0d110d38a6a6ae384761d41ea296d78a58ebc81c44cea3691cbc5ed5ef00cdd9e5fb92d565549946ffeaf356748b57fac362f155677
-  data.tar.gz: afc8d927f2082134cb81a9f118f73b799882a019fccc20760886c2d34a2fc0cebfae479794523e735eccddf9b5110edecd1d6b04bd2c61fac00dcc0ebe53913c
+  metadata.gz: 8957ef6dae32230c8dd3c7223f8b2473fba7f70f969cd0585d53bf0008d62b9164d158b1e2fd0c30e19c0c4c5a77e1ff3f71b0c2b060de137725e695faf81e35
+  data.tar.gz: f26f34e27de7508872b7b5ca6a6f8d0a36f740848b6bd900aa6449d21738e975b67a66e1970eb39a25504152fbc92b6074adfce1fc64ca49f85715cff59ac80a

data/README.md

@@ -224,6 +224,11 @@ end
 
 ## Changes
 
+### 0.6.3.1
+
+- Fix in EsCollection's aggregation parsing (nested + single from RAW now work ok)
+- `SortedBucketAggregationBase` introduced. now `ArtirixDataModels::AggregationsFactory.sorted_aggregation_class_based_on_index_on(index_array)` available to create a class for Aggregations which will sort the buckets based on the position of the elements on a given array.
+
 ### 0.6.2
 
 *Fixed Breaking Change*: removal of `Aggregation.from_json` static method. Now back but delegating to default factory method is `aggregation_factory.aggregation_from_json` in the Aggregation Factory *instance*.
@@ -239,6 +244,14 @@ end
 
 ## Yanked versions
 
+### ~0.6.3~
+
+Yanked because of typo bug on SortedBucketAggregationBase. Released 0.6.3.1 with the fix.
+
+
+- Fix in EsCollection's aggregation parsing (nested + single from RAW now work ok)
+- `SortedBucketAggregationBase` introduced. now `ArtirixDataModels::AggregationsFactory.sorted_aggregation_class_based_on_index_on(index_array)` available to create a class for Aggregations which will sort the buckets based on the position of the elements on a given array.
+
 
 ### ~0.6.1~ 
 

data/lib/artirix_data_models.rb

@@ -14,10 +14,10 @@ require 'hashie'
 
 # loading features
 require 'artirix_data_models/es_collection'
+require 'artirix_data_models/aggregation'
 require 'artirix_data_models/aggregations_factory'
 require 'artirix_data_models/raw_aggregation_data_normaliser'
 require 'artirix_data_models/aggregation_builder'
-require 'artirix_data_models/aggregation'
 require 'artirix_data_models/model'
 require 'artirix_data_models/gateways/data_gateway'
 require 'artirix_data_models/gateway_response_adaptors/model_adaptor'

data/lib/artirix_data_models/aggregations_factory.rb

@@ -2,6 +2,14 @@ module ArtirixDataModels
   class AggregationsFactory
     DEFAULT_COLLECTION_CLASS_NAME = ''.freeze
 
+    # AGGREGATION CLASS BUILDING
+
+    def self.sorted_aggregation_class_based_on_index_on(index_array)
+      SortedBucketsAggregationClassFactory.build_class_based_on_index_on(index_array)
+    end
+
+    # FACTORY INSTANCE
+
     def initialize
       @_loaders = Hash.new { |h, k| h[k] = {} }
       setup_config
@@ -61,5 +69,56 @@ module ArtirixDataModels
       RawAggregationDataNormaliser.new(self, raw_aggs).normalise
     end
 
+    module SortedBucketsAggregationClassFactory
+      def self.build_class_based_on_index_on(index_array)
+        prepared_index_array = index_array.map { |key| SortedBucketsAggregationClassFactory.prepare_key(key) }
+        sort_by_proc         = sort_by_index_on(prepared_index_array)
+
+        Class.new(SortedBucketAggregationBase).tap do |klass|
+          klass.sort_by_callable = sort_by_proc
+        end
+      end
+
+      def self.prepare_key(key)
+        key.to_s.strip.downcase
+      end
+
+      def self.sort_by_index_on(index_array)
+        proc do |bucket|
+          name = SortedBucketsAggregationClassFactory.prepare_key(bucket.name)
+
+          found_index = index_array.index(name)
+
+          if found_index.present?
+            [0, found_index]
+          else
+            [1, 0]
+          end
+        end
+      end
+
+      class SortedBucketAggregationBase < ArtirixDataModels::Aggregation
+        alias_method :unordered_buckets, :buckets
+
+        def buckets
+          @sorted_buckets ||= sort_buckets
+        end
+
+        def sort_buckets
+          unordered_buckets.sort_by { |bucket| self.class.sort_by_callable.call(bucket) }
+        end
+
+        def self.sort_by_callable
+          @sort_by_callable
+        end
+
+        def self.sort_by_callable=(callable = nil, &block)
+          raise ArgumentError unless callable || block
+
+          @sort_by_callable = callable || block
+        end
+      end
+
+    end
   end
 end

data/lib/artirix_data_models/raw_aggregation_data_normaliser.rb

@@ -3,44 +3,53 @@ module ArtirixDataModels
 
     FIND_BUCKETS = ->(_k, v, _o) { v.respond_to?(:key?) && v.key?(:buckets) }
 
-    attr_reader :raw_aggs, :aggregations_factory
+    attr_reader :raw_aggs, :aggregations_factory, :list
 
     def initialize(aggregations_factory, raw_aggs)
       @aggregations_factory = aggregations_factory
       @raw_aggs             = raw_aggs
+      @list                 = []
     end
 
     def normalise
       return [] unless raw_aggs.present?
       return raw_aggs if Array === raw_aggs
 
-      normalise_hash
+      normalise_hash(raw_aggs)
+
+      list
     end
 
     alias_method :call, :normalise
 
     private
 
-    def normalise_hash
-      with_buckets_list = deep_locate raw_aggs, FIND_BUCKETS
+    def normalise_hash(hash)
+      with_buckets_list = deep_locate hash, FIND_BUCKETS
 
-      with_buckets_list.reduce([]) do |list, with_buckets|
+      with_buckets_list.each do |with_buckets|
         with_buckets.each do |name, value|
-          add_normalised_element_to_list(list, name, value)
+          normalise_element(name, value)
         end
-
-        list
       end
     end
 
-    def add_normalised_element_to_list(list, k, v)
-      return unless Hash === v && v.key?(:buckets)
+    def normalise_element(name, value)
+      return unless Hash === value
+
+      if value.key?(:buckets)
+        add_normalised_element_to_list(name, value)
+      else
+        normalise_hash(value)
+      end
+    end
 
-      buckets = v[:buckets].map do |raw_bucket|
+    def add_normalised_element_to_list(name, value)
+      buckets = value[:buckets].map do |raw_bucket|
         normalise_bucket(raw_bucket)
       end
 
-      list << { name: k, buckets: buckets }
+      list << { name: name, buckets: buckets }
     end
 
     def normalise_bucket(raw_bucket)

data/lib/artirix_data_models/version.rb

@@ -1,3 +1,3 @@
 module ArtirixDataModels
-  VERSION = '0.6.2'
+  VERSION = '0.6.3.1'
 end

data/spec/artirix_data_models/es_collection_spec.rb

@@ -169,6 +169,61 @@ RSpec.describe ArtirixDataModels::EsCollection, type: :model do
       Then { es_collection.aggregations.first.buckets.last.aggregations.first.buckets.last.name == 'Cognitive Impact' }
       Then { es_collection.aggregations.first.buckets.last.aggregations.first.buckets.last.count == 3 }
     end
+
+    context 'with Raw ES with multiple nested aggregations' do
+      Given(:fixture_file) { fixture_pathname('articles_search_multiple_nested_raw_es.json') }
+
+      Given(:model_class) {
+        Class.new do
+          attr_reader :data
+
+          def initialize(data)
+            @data = { given: data }
+          end
+        end
+      }
+      Given(:es_response) { Oj.load(File.read(fixture_file), symbol_keys: true) }
+
+      When(:es_collection) { ArtirixDataModels::EsCollection.new(model_class, response: es_response) }
+
+      Then { es_collection.total == 1234 }
+      Then { es_collection.results == [] }
+
+      Then { es_collection.aggregations.size == 2 }
+
+      Then { es_collection.aggregations.first.name == :publication_types }
+      Then { es_collection.aggregations.first.buckets.size == 8 }
+
+      Then { es_collection.aggregations.first.buckets.first.name == 'Expert Opinion' }
+      Then { es_collection.aggregations.first.buckets.first.count == 1798 }
+      Then { es_collection.aggregations.first.buckets.last.name == 'Guidelines' }
+      Then { es_collection.aggregations.first.buckets.last.count == 33 }
+
+
+      Then { es_collection.aggregations.last.name == :taxonomy_level_1 }
+      Then { es_collection.aggregations.last.buckets.size == 4 }
+
+      Then { es_collection.aggregations.last.buckets.first.name == 'Treatment' }
+      Then { es_collection.aggregations.last.buckets.first.count == 2404 }
+      Then { es_collection.aggregations.last.buckets.first.aggregations.size == 1 }
+      Then { es_collection.aggregations.last.buckets.first.aggregations.first.name == :taxonomy_level_2 }
+      Then { es_collection.aggregations.last.buckets.first.aggregations.first.buckets.size == 7 }
+      Then { es_collection.aggregations.last.buckets.first.aggregations.first.buckets.first.name == 'Drug Treatments' }
+      Then { es_collection.aggregations.last.buckets.first.aggregations.first.buckets.first.count == 977 }
+      Then { es_collection.aggregations.last.buckets.first.aggregations.first.buckets.last.name == 'Complementary and Alternative Therapies' }
+      Then { es_collection.aggregations.last.buckets.first.aggregations.first.buckets.last.count == 14 }
+
+
+      Then { es_collection.aggregations.last.buckets.last.name == 'Living' }
+      Then { es_collection.aggregations.last.buckets.last.count == 365 }
+      Then { es_collection.aggregations.last.buckets.last.aggregations.size == 1 }
+      Then { es_collection.aggregations.last.buckets.last.aggregations.first.name == :taxonomy_level_2 }
+      Then { es_collection.aggregations.last.buckets.last.aggregations.first.buckets.size == 8 }
+      Then { es_collection.aggregations.last.buckets.last.aggregations.first.buckets.first.name == 'Emotional Impact' }
+      Then { es_collection.aggregations.last.buckets.last.aggregations.first.buckets.first.count == 104 }
+      Then { es_collection.aggregations.last.buckets.last.aggregations.first.buckets.last.name == 'Cognitive Impact' }
+      Then { es_collection.aggregations.last.buckets.last.aggregations.first.buckets.last.count == 3 }
+    end
   end
 
 end

data/spec/fixtures/articles_search_multiple_nested_raw_es.json

@@ -0,0 +1,187 @@
+{
+  "took": 40,
+  "timed_out": false,
+  "_shards": {
+    "total": 5,
+    "successful": 5,
+    "failed": 0
+  },
+  "hits": {
+    "total": 1234,
+    "max_score": 0,
+    "hits": []
+  },
+  "aggregations": {
+    "publication_types": {
+      "doc_count_error_upper_bound": 0,
+      "sum_other_doc_count": 0,
+      "buckets": [
+        {
+          "key": "Expert Opinion",
+          "doc_count": 1798
+        },
+        {
+          "key": "Observational Studies",
+          "doc_count": 777
+        },
+        {
+          "key": "Clinical Observations",
+          "doc_count": 627
+        },
+        {
+          "key": "Controlled Studies",
+          "doc_count": 303
+        },
+        {
+          "key": "Randomised Controlled Trials",
+          "doc_count": 299
+        },
+        {
+          "key": "Systematic Reviews",
+          "doc_count": 220
+        },
+        {
+          "key": "Meta-Analysis",
+          "doc_count": 49
+        },
+        {
+          "key": "Guidelines",
+          "doc_count": 33
+        }
+      ]
+    },
+    "taxonomy": {
+      "doc_count": 4674,
+      "taxonomy_level_1": {
+        "doc_count_error_upper_bound": 0,
+        "sum_other_doc_count": 0,
+        "buckets": [
+          {
+            "key": "Treatment",
+            "doc_count": 2404,
+            "taxonomy_level_2": {
+              "doc_count_error_upper_bound": 0,
+              "sum_other_doc_count": 0,
+              "buckets": [
+                {
+                  "key": "Drug Treatments",
+                  "doc_count": 977
+                },
+                {
+                  "key": "Drug Development",
+                  "doc_count": 731
+                },
+                {
+                  "key": "Other Treatments",
+                  "doc_count": 358
+                },
+                {
+                  "key": "Surgical Treatments",
+                  "doc_count": 264
+                },
+                {
+                  "key": "Assistive Devices",
+                  "doc_count": 43
+                },
+                {
+                  "key": "Palliative Care",
+                  "doc_count": 17
+                },
+                {
+                  "key": "Complementary and Alternative Therapies",
+                  "doc_count": 14
+                }
+              ]
+            }
+          },
+          {
+            "key": "Understand",
+            "doc_count": 1356,
+            "taxonomy_level_2": {
+              "doc_count_error_upper_bound": 0,
+              "sum_other_doc_count": 0,
+              "buckets": [
+                {
+                  "key": "Symptoms",
+                  "doc_count": 1066
+                },
+                {
+                  "key": "Outlook",
+                  "doc_count": 143
+                },
+                {
+                  "key": "Causes",
+                  "doc_count": 123
+                },
+                {
+                  "key": "Ethics",
+                  "doc_count": 24
+                }
+              ]
+            }
+          },
+          {
+            "key": "Diagnosis",
+            "doc_count": 549,
+            "taxonomy_level_2": {
+              "doc_count_error_upper_bound": 0,
+              "sum_other_doc_count": 0,
+              "buckets": [
+                {
+                  "key": "Diagnostic Techniques",
+                  "doc_count": 525
+                },
+                {
+                  "key": "Diagnostic Challenges",
+                  "doc_count": 24
+                }
+              ]
+            }
+          },
+          {
+            "key": "Living",
+            "doc_count": 365,
+            "taxonomy_level_2": {
+              "doc_count_error_upper_bound": 0,
+              "sum_other_doc_count": 0,
+              "buckets": [
+                {
+                  "key": "Emotional Impact",
+                  "doc_count": 104
+                },
+                {
+                  "key": "Genetic Counseling",
+                  "doc_count": 63
+                },
+                {
+                  "key": "Diet",
+                  "doc_count": 59
+                },
+                {
+                  "key": "Fertility/Sex",
+                  "doc_count": 56
+                },
+                {
+                  "key": "Exercise",
+                  "doc_count": 48
+                },
+                {
+                  "key": "Physical Impact",
+                  "doc_count": 26
+                },
+                {
+                  "key": "Sleep",
+                  "doc_count": 6
+                },
+                {
+                  "key": "Cognitive Impact",
+                  "doc_count": 3
+                }
+              ]
+            }
+          }
+        ]
+      }
+    }
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artirix_data_models
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3.1
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -259,6 +259,7 @@ files:
 - spec/artirix_data_models/gateways/gateway_response_adaptors/model_adaptor_spec.rb
 - spec/artirix_data_models/model_fields_dao_spec.rb
 - spec/fixtures/articles_search_dl.json
+- spec/fixtures/articles_search_multiple_nested_raw_es.json
 - spec/fixtures/articles_search_nested_raw_es.json
 - spec/fixtures/articles_search_nested_single_raw_es.json
 - spec/fixtures/articles_search_raw_es.json
@@ -299,6 +300,7 @@ test_files:
 - spec/artirix_data_models/gateways/gateway_response_adaptors/model_adaptor_spec.rb
 - spec/artirix_data_models/model_fields_dao_spec.rb
 - spec/fixtures/articles_search_dl.json
+- spec/fixtures/articles_search_multiple_nested_raw_es.json
 - spec/fixtures/articles_search_nested_raw_es.json
 - spec/fixtures/articles_search_nested_single_raw_es.json
 - spec/fixtures/articles_search_raw_es.json