artirix_data_models 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d663a0947a081d9dbd5145eb404521db0a42b4bd
-  data.tar.gz: ed757c3c5c1676982ccbb3d093a55134eae9ad60
+  metadata.gz: dfd953c7eaed394dbc237e87abfd355c97d19b1b
+  data.tar.gz: 5acbc42af128b2e3e89502eb40eb9049066739ad
 SHA512:
-  metadata.gz: 6bcc9f58f64f314fd09168500f6039ff829943c2cbad1adabbef34e8bbf16893d58917daeceba3aa0178da3d09f9c31b9253d1079643ba742c708330ed9e202e
-  data.tar.gz: f4777f21f1017f5edc30e898d71e4f1fe26f13cc2b2c873fdeaa76b424a126364ea417be826707af3797250acb5cc6c8c9576ab62bf55b92b64c0e5de866a629
+  metadata.gz: 250462062fac4f0eb4a93fcbcc83b4cb39b940f18a77517a25ad0e22071488340385e2a2c44b8160b88441f4cd86a258bc657380913c44572e883b99b65cd282
+  data.tar.gz: 37fdda63565fc00eca22bbe825894a14065b41b454abb4207bf17ef346da29cc84e44bb9dd6008cabf7702df4bdbe2ef13f33aad4adb82ab0a0579f1529b9aa1

data/README.md

@@ -24,11 +24,56 @@ note: for making a model compatible with [ActiveModelSerializers](https://github
 
 ## Usage
 
+### Configuration
+
+In previous versions, ADM required the use of `SimpleConfig` to configure itself. Now you have the alternative of using
+`Rails.configuration` with the `config.x` support for custom configurations.
+
+The configuration loaded will be `Rails.configuration.x.artirix_data_models` if present, or if not it will try to load
+`SimpleConfig.for(:site)`. *important: it will not merge configs, it will load one or the other*
+
+note: see [http://guides.rubyonrails.org/configuring.html#custom-configuration](http://guides.rubyonrails.org/configuring.html#custom-configuration)
+
+You can also specify a different config by passing a config loader to `ArtirixDataModels.configuration_loader = -> { myconfig }`.
+
+#### Using Rails config
+```ruby
+module SomeApplication
+  class Application < Rails::Application
+
+    # normal Rails config...
+    config.action_mailer.perform_caching = false
+
+
+
+    # ADM CONFIG
+    config.x.artirix_data_models.data_gateway = ActiveSupport::OrderedOptions.new
+    config.x.artirix_data_models.data_gateway.url = 'http://super-secure-domain-123456.com'
+  end
+end
+```
+
+#### Using SimpleConfig
+
+```ruby
+# config using SimpleConfig
+SimpleConfig.for(:site) do
+  group :data_gateway do
+    set :url, 'http://super-secure-domain-123456.com'
+  end
+end
+```
+
 ### Connection
 
 You have to specify the location of data-layer. It can be done in the config like this:
 
 ```ruby
+# config using Rails.configuration
+config.x.artirix_data_models.data_gateway.url = 'http://super-secure-domain-123456.com'
+
+
+# config using SimpleConfig
 SimpleConfig.for(:site) do
   group :data_gateway do
     set :url, 'http://super-secure-domain-123456.com'
@@ -270,6 +315,9 @@ end
 
 ## Changes
 
+### 0.19.0
+Added `configuration_loader` and support for `Rails.configuration.x.artirix_data_models`.
+
 ### 0.18.0
 
 `DataGateway` connection loader now moved to `DataGateway::ConnectionLoader`, with 3 public methods:

data/artirix_data_models.gemspec

@@ -20,13 +20,14 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'activesupport'
   spec.add_dependency 'activemodel'
-  spec.add_dependency 'simpleconfig'
   spec.add_dependency 'oj'
   spec.add_dependency 'faraday'
   spec.add_dependency 'keyword_init', '~> 1.4'
   spec.add_dependency 'naught'
   spec.add_dependency 'hashie', '~> 3.4'
 
+  spec.add_development_dependency 'simpleconfig'
+
   spec.add_development_dependency 'kaminari', '~> 0.16'
   spec.add_development_dependency 'will_paginate', '~> 3.0'
 

data/lib/artirix_data_models.rb

@@ -3,7 +3,6 @@ require 'artirix_data_models/version'
 # dependencies
 require 'active_support/all'
 require 'active_model'
-require 'simple_config'
 require 'oj'
 require 'faraday'
 require 'keyword_init'
@@ -11,6 +10,7 @@ require 'naught'
 require 'hashie'
 
 # note DO NOT require kaminari or will_paginate, it'll be done when invoking `ArtirixDataModels::EsCollection.work_with_will_paginate`
+# note: do not require SimpleConfig, it has to exist before used. Same as we don't require Rails.
 
 
 # loading features
@@ -130,7 +130,42 @@ module ArtirixDataModels
     @disabled_cache ||= DisabledCache.new
   end
 
+  # CONFIGURATION
+
+  def self.configuration
+    configuration_loader.call
+  end
+
+  def self.configuration_loader=(loader=nil, &block)
+    if block_given?
+      @configuration_loader = block
+    elsif loader.present? && loader.respond_to?(:call)
+      @configuration_loader = loader
+    else
+      raise 'no block or callable object given as a loader'
+    end
+  end
+
+  def self.configuration_loader
+    @configuration_loader ||= default_configuration_loader
+  end
+
+  def self.default_configuration_loader
+    lambda do
+      if defined?(Rails) && Rails.configuration.try(:x) && Rails.configuration.x.artirix_data_models.present?
+        Rails.configuration.x.artirix_data_models
+      elsif defined?(SimpleConfig)
+        SimpleConfig.for(:site)
+      else
+        raise ConfigurationNeededError, 'Rails.configuration.x.artirix_data_models not available, and SimpleConfig.for(:site) not available'
+      end
+    end
+  end
+
   class IllegalActionError < StandardError
   end
 
+  class ConfigurationNeededError < StandardError
+  end
+
 end

data/lib/artirix_data_models/cache_service.rb

@@ -120,7 +120,7 @@ module ArtirixDataModels::CacheService
     end
 
     def self.option_store
-      @option_store ||= SimpleConfig.for(:site).try(:cache_options) || disabled_options_store
+      @option_store ||= ArtirixDataModels.configuration.try(:cache_options) || disabled_options_store
     end
 
     def self.disabled_options_store
@@ -172,7 +172,7 @@ module ArtirixDataModels::CacheService
     end
 
     def self.prefix
-      SimpleConfig.for(:site).try(:cache_app_prefix)
+      ArtirixDataModels.configuration.try(:cache_app_prefix)
     end
   end
 

data/lib/artirix_data_models/dao.rb

@@ -158,7 +158,7 @@ module ArtirixDataModels
         end
 
         def enabled?
-          SimpleConfig.for(:site).try(:data_fake_mode).try(fake_mode_key)
+          ArtirixDataModels.configuration.try(:data_fake_mode).try(fake_mode_key)
         end
 
         def partial_hash_from_model(given_model_to_reload)

data/lib/artirix_data_models/gateway_response_adaptors/model_adaptor.rb

@@ -53,7 +53,7 @@ module ArtirixDataModels::GatewayResponseAdaptors
     end
 
     def self.collection(object_class_or_factory, from = 0, size = nil)
-      size ||= SimpleConfig.for(:site).search_page_size.default
+      size ||= ArtirixDataModels.configuration.try(:search_page_size).try(:default) || 10
       new ->(data_collection) { ArtirixDataModels::EsCollection.new object_class_or_factory, response: data_collection, from: from, size: size }
     end
 

data/lib/artirix_data_models/gateways/data_gateway.rb

@@ -234,7 +234,7 @@ class ArtirixDataModels::DataGateway
       end
 
       def connection_by_config_key(config_key, **others)
-        connection config: SimpleConfig.for(:site).send(config_key), **others
+        connection config: ArtirixDataModels.configuration.send(config_key), **others
       end
 
       def connection(config: {}, url: nil, login: nil, password: nil, bearer_token: nil, token_hash: nil)

data/lib/artirix_data_models/spec_support/fake_mode.rb

@@ -1,25 +1,18 @@
 # :nocov:
 def fake_mode_for(model_name)
-  before(:all) do
-    SimpleConfig.for(:site) do
+  before(:each) do
+    config = ArtirixDataModels.configuration
 
-      set :debug_model_mode_enabled, true
-
-      group :data_fake_mode do
-        set model_name, true
-      end
+    # fix in case of SimpleConfig (mocking SimpleConfig with rspec explodes if not)
+    if defined?(SimpleConfig) && config.kind_of?(SimpleConfig::Config)
+      SimpleConfig::Config.class_eval { public :singleton_class }
     end
-  end
 
-  after(:all) do
-    SimpleConfig.for(:site) do
+    dfm = config.try(:data_fake_mode) || double
+    allow(dfm).to receive(model_name).and_return(true)
+    allow(config).to receive(:data_fake_mode).and_return(dfm)
 
-      set :debug_model_mode_enabled, false
-
-      group :data_fake_mode do
-        set model_name, false
-      end
-    end
+    allow(config).to receive(:debug_model_mode_enabled).and_return(true)
   end
 end
 

data/lib/artirix_data_models/spec_support/gateway_mock.rb

@@ -1,13 +1,18 @@
 # :nocov:
 def given_gateway_config(connection_url = nil)
   connection_url ||= 'http://example.com/other'
-  before(:all) do
-    c = connection_url
-    SimpleConfig.for(:site) do
-      group :data_gateway do
-        set :url, c
-      end
+  
+  before(:each) do
+    config = ArtirixDataModels.configuration
+
+    # fix in case of SimpleConfig (mocking SimpleConfig with rspec explodes if not)
+    if defined?(SimpleConfig) && config.kind_of?(SimpleConfig::Config)
+      SimpleConfig::Config.class_eval { public :singleton_class }
     end
+
+    dg = config.try(:data_gateway) || double
+    allow(dg).to receive(:url).and_return(connection_url)
+    allow(config).to receive(:data_gateway).and_return(dg)
   end
 end
 

data/lib/artirix_data_models/version.rb

@@ -1,3 +1,3 @@
 module ArtirixDataModels
-  VERSION = '0.18.0'
+  VERSION = '0.19.0'
 end

data/spec/artirix_data_models/gateways/data_gateway_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'simple_config'
 
 RSpec.describe ArtirixDataModels::DataGateway, type: :model do
   Given(:bearer) { 'MyBearerToken' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artirix_data_models
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Eduardo Turiño
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-23 00:00:00.000000000 Z
+date: 2016-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: simpleconfig
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: oj
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simpleconfig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement