artirix_data_models 1.0.0.beta1 → 1.0.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b24c8e95bc1bd45a7df4207da2d02673adb6f721
-  data.tar.gz: 7bbe651de9dcdeb677687ad0839c10a2b1b45d14
+  metadata.gz: 7b789a4325708b34bd7ebfdc7745857c0b15c274
+  data.tar.gz: a0b4df2ed3b9a82761ad7b7474d2456c7c1ec622
 SHA512:
-  metadata.gz: 2065f4af7b36c022d2160d899ed4535b8cefe5764f3eabc282a48750d5b0616c1f16ee72d786c53d0c5cb8be226fbba7aeca6c1615f194057279a73384f74a4c
-  data.tar.gz: 213acba354ebaca8c02116674c08aa9b6db758c78f705250f67ddac5dc8c99765f9dd9a9d96cc9cf8059d94482e90c90867c0516abb2b4ad2492b38fe7aa5eee
+  metadata.gz: b3067423501cef36002fc3c46a8d1bca73541ed2cfd92acb068b704472dca356d2c771f3e4434a554983dbe86f0b2956bcf181cf4d0554b8294c778572c1c6e4
+  data.tar.gz: d82ad3c5b183de485ddd6c3d85b749fe03abb5b5ba3dbd9c8c3ed9c3ad1918338fca8d08eb6e22efa000d8ac1fdd1ac4885fb9357d4dd48f393e7d40f8bcd242

data/.travis.yml

@@ -1,6 +1,8 @@
 language: ruby
 rvm:
-  - 2.3.0
+  - 2.3.3
+  - 2.4.0
+
 before_install: gem install bundler -v 1.11.2
 
 addons:

data/README.md

@@ -15,11 +15,6 @@ Its goal is to provide a set of Read Only model objects that receive their data
 
 It's designed to work assuming JSON APIs and ElasticSearch responses.
 
-# TODO:
-- usage doc
-- change Cache to use [artirix_cache_service](https://github.com/artirix/artirix_cache_service)
-
-
 note: for making a model compatible with [ActiveModelSerializers](https://github.com/rails-api/active_model_serializers), use [artirix_data_models-ams](https://github.com/artirix/artirix_data_models-ams/)
 
 ## Usage
@@ -321,11 +316,73 @@ end
 
 1. Documentation
 2. clean `basic_dao` (probably not backwards compatible, so we'll do it in a new major release)
-3. use [artirix_cache_service](https://github.com/artirix/artirix_cache_service) instead of this implementation (might be not backwards compatible. If so: new major release)
+3. config flags to modify the composition of Model (ie: include/exclude partial mode behaviour, default attributes...)
 
+## Changes
 
+### 1.0.0.beta2
 
-## Changes
+- Partial Mode: the default mode status is inherited from the parent class. If you have
+
+```ruby
+class A
+  include ArtirixDataModels::Model
+  self.mark_full_mode_by_default
+end
+
+class B < A
+end
+
+class C
+  include ArtirixDataModels::Model
+end
+
+A.default_full_mode? # => true
+B.default_full_mode? # => true (it would be false before this version)
+C.default_full_mode? # => false
+```
+
+- Default Mode: you can override the default mode (if not overridden it will be `:partial`)
+```ruby
+
+# make it full mode by default
+config.x.artirix_data_models.default_mode = :full
+```
+
+
+- Default Attributes: you can override the list of default attributes
+```ruby
+
+# add no default attributes
+config.x.artirix_data_models.default_attributes = []
+
+ # only _timestamp
+config.x.artirix_data_models.default_attributes = [:_timestamp]
+
+# if nothing is specified in the config, the default attributes are:
+[
+  :_timestamp,
+  :_score,
+  :_type,
+  :_index,
+  :_id,
+]
+```
+
+- Default Attributes always in Partial Mode: you can override the list of attributes always in partial mode
+```ruby
+
+# add no default attributes
+config.x.artirix_data_models.attributes_always_in_partial_mode = []
+
+ # _timestamp and _score
+config.x.artirix_data_models.attributes_always_in_partial_mode = [:_timestamp, :_score]
+
+# if nothing is specified in the config, the default attributes are:
+[
+  :_timestamp,
+]
+```
 
 ### Breaking Changes!!: version 1.0.0.beta1
 
@@ -391,7 +448,7 @@ added message support for DataGateway exceptions
 
 ### 0.22.0
 
-added support for aggregations that look like 
+added support for aggregations that look like
 ```json
 {
   "aggregations": {
@@ -421,8 +478,8 @@ which will be added as an aggregation like:
 
 ```ruby
 es_collection.aggregations.first.name # => :published_states
-es_collection.aggregations.first.buckets 
-  # => [ 
+es_collection.aggregations.first.buckets
+  # => [
   #      {name: 'live_soon', count: 0},
   #      {name: 'draft', count: 3},
   #      {name: 'expired', count: 0},
@@ -432,13 +489,13 @@ es_collection.aggregations.first.buckets
 
 ### 0.21.1
 
-Fix bug in `Inspectable`, on Arrays. 
+Fix bug in `Inspectable`, on Arrays.
 
 ### 0.21.0
 
-Changed cache to use `ArtirixCacheService` (gem `artirix_cache_service`). 
+Changed cache to use `ArtirixCacheService` (gem `artirix_cache_service`).
 
-Deprecated the use of method_missing on cache in favour of the `.key` method: 
+Deprecated the use of method_missing on cache in favour of the `.key` method:
 
 ```ruby
 # this is deprecated
@@ -460,7 +517,7 @@ ArtirixDataModels::CacheService.first_options 'some', 'other', return_if_missing
 
 
 ### 0.20.0
-Added `ensure_relative` boolean option to the creation of a `DataGateway` (disable by default). With it enabled, it will ensure that any given `path` is relative by removing the leading `/`. This is necessary if the Gateway should call a nested endpoint and not just a host. 
+Added `ensure_relative` boolean option to the creation of a `DataGateway` (disable by default). With it enabled, it will ensure that any given `path` is relative by removing the leading `/`. This is necessary if the Gateway should call a nested endpoint and not just a host.
 
 Example: If we have `"http://example.org/api/"` as connection's URL, and path `"/people/1"`, with this:
 
@@ -481,7 +538,7 @@ Added `configuration_loader` and support for `Rails.configuration.x.artirix_data
 `DataGateway` connection loader now moved to `DataGateway::ConnectionLoader`, with 3 public methods:
 - `default_connection` which will give us the connection based on config in `data_gateway` group in `SimpleConfig.for(:site)`
 - `connection_by_config_key(config_key)` which will give us the connection based on config in the given group key in `SimpleConfig.for(:site)`
-- `connection(config: {}, url: nil, login: nil, password: nil, bearer_token: nil, token_hash: nil)`: It will use the elements from the given config if they are not present on the params. 
+- `connection(config: {}, url: nil, login: nil, password: nil, bearer_token: nil, token_hash: nil)`: It will use the elements from the given config if they are not present on the params.
 
 ### 0.17.0
 
@@ -519,7 +576,7 @@ updating dependencies: KeywordInit (to support passing nil)
 - `Gateway` `perform` and `connect` now accept the extra arguments as keyword arguments:
 
 ```ruby
-  gateway.perform :get, path: '/this/is/required' body: nil, json_body: true, timeout: 10 
+  gateway.perform :get, path: '/this/is/required' body: nil, json_body: true, timeout: 10
 ```
 
 The internals are adapted but if a client app was mocking Gateway's `perform` directly, this could be a breaking change.
@@ -539,7 +596,7 @@ end
 
 ### 0.14.1
 - Exceptions now with `data_hash` and ability to be raised with message, options, or both.
-- Cache Adaptors now store the data hash of the NotFound exception, and a new one is built and raised when reading a cached NotFound. 
+- Cache Adaptors now store the data hash of the NotFound exception, and a new one is built and raised when reading a cached NotFound.
 
 ```ruby
 raise ArtirixDataModels::DataGateway::NotFound, 'blah blah'
@@ -555,7 +612,7 @@ raise ArtirixDataModels::DataGateway::NotFound.new('Something', path: 'x')
 ```ruby
 class MyModel
   include ArtirixDataModels::Model
-  
+
   mark_full_mode_by_default
 end
 
@@ -589,7 +646,7 @@ x.full_mode? # => true
 - Gateways:
 -- added `gateway_factory` besides `gateway` as a creation argument for a DAO and BasicModelDAO. Now, when using a gateway in BasicModelDAO, it will use the given gateway if present, or it will call `gateway_factory.call` and use it. It won't save the result of the gateway factory, so the factory will be called every time a gateway is used.
 -- `BasicModelDAO` methods can receive a `gateway` option to be used instead of the normal gateway for the particular request. Used in `_get`, `_post`, `_put` and `_delete` methods. If no override is passed, then it will use the preloaded gateway (using either `gateway` or `gateway_factory` creation arguments, see above).
--- `DAO` creation accepts an option `ignore_default_gateway` (`false` by default). If it is false, and no `gateway` or `gateway_factory` is passed, the gateway used will be `DAORegistry.gateway` (same as before). This allows to create DAOs without any gateway configured, making it necessary to instantiate it and pass it to `BasicModelDAO` on each request. 
+-- `DAO` creation accepts an option `ignore_default_gateway` (`false` by default). If it is false, and no `gateway` or `gateway_factory` is passed, the gateway used will be `DAORegistry.gateway` (same as before). This allows to create DAOs without any gateway configured, making it necessary to instantiate it and pass it to `BasicModelDAO` on each request.
 
 - Response Adaptors
 -- `DAO`'s `get_full` method now can pass to `BasicModelDAO` a `response_adaptor` option. `BasicModelDAO` will use `BasicModelDAO`'s `response_adaptor_for_reload` if no response adaptor is passed.
@@ -610,9 +667,9 @@ x.full_mode? # => true
 - Fake Responses now can be a callable object (if it responds to `call` it will invoke it)
 - refactor in `ArtirixDataModels::DataGateway` to add more info into the exceptions
 - `ArtirixDataModels::DataGateway::Error` and subclasses have now `path`, `method`, `response_status`, `response_body` (when applicable) and also `json_response_body` method which will try to parse `response_body` as if it were json (nil if it is not present or if it is not a valid json)
-- `ArtirixDataModels::DataGateway::Error` subclasses now for specific response status: 
+- `ArtirixDataModels::DataGateway::Error` subclasses now for specific response status:
 -- `NotFound`
--- `NotAcceptable` 
+-- `NotAcceptable`
 -- `UnprocessableEntity`
 -- `Unauthorized`
 -- `Forbidden`
@@ -654,7 +711,7 @@ Yanked because of the gateway mock helpers were missing an option, which made th
 - 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: 
+- 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`
@@ -663,7 +720,7 @@ Yanked because of the gateway mock helpers were missing an option, which made th
 
 ### ~0.7.0~ (YANKED)
 
-Yanked because of bug on Aggregations. Released 0.7.1 with the fix. Changeset moved too to 0.7.1 
+Yanked because of bug on Aggregations. Released 0.7.1 with the fix. Changeset moved too to 0.7.1
 
 ### 0.6.7
 
@@ -675,7 +732,7 @@ Yanked because of bug on Aggregations. Released 0.7.1 with the fix. Changeset mo
 
 ### 0.6.5
 
-- Specify `activemodel` as a dependency and require it in the lib 
+- Specify `activemodel` as a dependency and require it in the lib
 - `EsCollection` delegates `[]`, `first`, `last`, `take` and `drop` to the results.
 
 
@@ -719,4 +776,3 @@ Yanked because of breaking change introduction: removal of `Aggregation.from_jso
 
 - opening gem as is to the public.
 - still a lot of TODOs in the documentation
-

data/lib/artirix_data_models/model.rb

@@ -224,8 +224,8 @@ module ArtirixDataModels
           return nil if skip_option.include?(:reader) || skip_option.include?(:getter)
 
           variable_name = "@#{attribute}"
-          dir_get_name  = Attributes.direct_getter_method_name(attribute)
-          reader        = attribute.to_s
+          dir_get_name = Attributes.direct_getter_method_name(attribute)
+          reader = attribute.to_s
 
           define_method dir_get_name do
             instance_variable_get variable_name
@@ -268,14 +268,34 @@ module ArtirixDataModels
       module WithDefaultAttributes
         extend ActiveSupport::Concern
 
+        DEFAULT_ATTRIBUTES = [
+          :_timestamp,
+          :_score,
+          :_type,
+          :_index,
+          :_id,
+        ].freeze
+
+        ATTRIBUTES_ALWAYS_IN_PARTIAL_MODE = [
+          :_timestamp,
+        ].freeze
+
         included do
-          attribute :_timestamp
-          always_in_partial_mode(:_timestamp) if respond_to?(:always_in_partial_mode)
+          WithDefaultAttributes.default_attribute_names.each do |at|
+            attribute at
+          end
+
+          WithDefaultAttributes.default_attributes_always_in_partial_mode.each do |at|
+            always_in_partial_mode(at) if respond_to?(:always_in_partial_mode)
+          end
+        end
+
+        def self.default_attribute_names
+          Array(ArtirixDataModels.configuration.try(:default_attributes) || DEFAULT_ATTRIBUTES)
+        end
 
-          attribute :_score
-          attribute :_type
-          attribute :_index
-          attribute :_id
+        def self.default_attributes_always_in_partial_mode
+          Array(ArtirixDataModels.configuration.try(:attributes_always_in_partial_mode) || ATTRIBUTES_ALWAYS_IN_PARTIAL_MODE)
         end
       end
     end
@@ -364,7 +384,7 @@ module ArtirixDataModels
       extend ActiveSupport::Concern
 
       EMPTY_TIMESTAMP = 'no_time'.freeze
-      SEPARATOR       = '/'.freeze
+      SEPARATOR = '/'.freeze
 
       def cache_key
         # we do not want to force a reload for loading the cache key, it can lead to an infinite loop
@@ -468,28 +488,42 @@ module ArtirixDataModels
         end
 
         def default_full_mode?
-          !!attribute_config.default_full_mode
+          attribute_config.default_mode == :full
         end
 
         def mark_full_mode_by_default
-          attribute_config.default_full_mode = true
+          attribute_config.default_mode = :full
         end
 
         def mark_partial_mode_by_default
-          attribute_config.default_full_mode = false
+          attribute_config.default_mode = :partial
+        end
+
+        def restore_default_mode
+          attribute_config.default_mode = nil
         end
       end
     end
 
     class AttributeConfig
       attr_reader :attribute_list, :always_in_partial_mode_list
-      attr_accessor :parent_attribute_config, :default_full_mode
+      attr_accessor :parent_attribute_config
+      attr_writer :default_mode
 
       def initialize
-        @attribute_list              = Set.new
+        @attribute_list = Set.new
         @always_in_partial_mode_list = Set.new
-        @parent_attribute_config     = nil
-        @default_full_mode           = false
+        @parent_attribute_config = nil
+        @default_mode = nil
+      end
+
+      def default_mode
+        return @default_mode unless @default_mode.nil?
+        parent_attribute_config.try(:default_mode) || initial_default_mode
+      end
+
+      def initial_default_mode
+        ArtirixDataModels.configuration.try(:default_mode) || :partial
       end
 
       def attributes

data/lib/artirix_data_models/version.rb

@@ -1,3 +1,3 @@
 module ArtirixDataModels
-  VERSION = '1.0.0.beta1'
+  VERSION = '1.0.0.beta2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artirix_data_models
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta2
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-01 00:00:00.000000000 Z
+date: 2017-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport