blueprint_config 1.1.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cec591307b09bd72ebe07601ae537938479fa70561e82127a468b7e0028e4df8
-  data.tar.gz: 4ac393929bbf592a95e4196cbb195cd7d463e80f4ba6df4fce8c99b74967e330
+  metadata.gz: c15d3fbdfef9100c4ea913ea334e54121af90b9a3d1a8ebebadf058e3e6332cb
+  data.tar.gz: 58bb317972ccb61b627973e957fc03f966d233312a45572b438e37ca61925c7f
 SHA512:
-  metadata.gz: 17467c0fd7172bf30880be1a40c1564c7f4271df3f388537f31986682f950766cea2ef3969061d5e7e2f68b1935dcddc930bff9151815be09be6ffcc1cca6bc8
-  data.tar.gz: 890305e747d5314fcd1d9fc13e0eeaec4d931930483ef39898f44df9105f17f5e4e191b5a1f76eb907bc00647668ceb42b2ded7dc6051c476e43fc37d458b200
+  metadata.gz: 9fc44988632c85c5d085b86fe6409577de935c781910d754edda255948e1a340951116fd130d0313c8a2390b837e47db3def437e4210fb566c00ebde60021e86
+  data.tar.gz: d070bfcbe59fa94f9720721c85d76b1d9074f9e55d78b6f2e1eb8164f88921c7237ee3a3d4c49327a9e5d8b596b33811e4d4c2d1bf56d74fa99ebbbe75dbbb83

data/lib/blueprint_config/backend/active_record.rb

@@ -11,11 +11,22 @@ module BlueprintConfig
         =======================================================================
         Settings table not found. Please add the configuration table by running:
 
-        rails generate blueprint_config:install
-        rake db:migrate
+        bundle exec rails generate blueprint_config:install
+        bundle exec rake db:migrate
         =======================================================================
       WARNING
 
+      MISSING_ATTRIBUTES_WARNING = <<-WARNING.gsub(/^ */, '')
+        =======================================================================
+        Settings table is missing required attributes: %s
+
+        You can create a migration and adjust it to your needs by running:
+        bundle exec rails generate blueprint_config:install
+        =======================================================================
+      WARNING
+
+      REQUIRED_ATTRIBUTES = %w[key value type updated_at].freeze
+
       def initialize(options = {})
         @options = options
         @updated_at = nil
@@ -26,23 +37,64 @@ module BlueprintConfig
 
       def load_keys
         @configured = true
+
+        return {} unless table_exist?
+        return {} unless has_required_attributes?
+
         update_timestamp
 
         data = Setting.all.map { |s| { s.key => s.parsed_value } }.reduce(:merge) || {}
         return data.transform_keys(&:to_sym) unless @options[:nest]
 
         nest_hash(data, @options[:nest_separator] || '.')
-      rescue ::ActiveRecord::NoDatabaseError => e
+      rescue ::ActiveRecord::NoDatabaseError, ::ActiveRecord::ConnectionNotEstablished
         # database is not created yet
         @configured = false
         {}
       rescue ::ActiveRecord::StatementInvalid => e
         @configured = false
-        Rails.logger.warn(e.message)
-        Rails.logger.warn(MISSING_TABLE_WARNING)
+        unless @options[:silence_warnings]
+          puts "Failed to load seetings from database: #{e.message}"
+          Rails.logger.warn(e.message) if defined?(Rails)
+        end
         {}
       end
 
+      def table_exist?
+        Setting.reset_column_information
+        return true if Setting.table_exists?
+
+        @configured = false
+
+        unless @options[:silence_warnings]
+          puts MISSING_TABLE_WARNING
+          if defined?(Rails)
+            Rails.logger.warn(e.message)
+            Rails.logger.warn(MISSING_TABLE_WARNING)
+          end
+        end
+
+        false
+      end
+
+      def has_required_attributes?
+        Setting.reset_column_information
+        return true if REQUIRED_ATTRIBUTES - Setting.attribute_names == []
+
+        @configured = false
+
+        missing = (REQUIRED_ATTRIBUTES - Setting.attribute_names).join(', ')
+        unless @options[:silence_warnings]
+          puts MISSING_ATTRIBUTES_WARNING % missing
+          if defined?(Rails)
+            Rails.logger.warn(e.message)
+            Rails.logger.warn(MISSING_TABLE_WARNING)
+          end
+        end
+
+        false
+      end
+
       def update_timestamp
         @mutex.synchronize do
           @updated_at = Setting.maximum(:updated_at)
@@ -51,13 +103,18 @@ module BlueprintConfig
 
       def fresh?
         # if database is not create/configured yet - don't try to refresh settings from it
-        return true if !@configured
+        return true unless @configured
         return true if @last_checked_at.present? && @last_checked_at > 1.second.ago
 
         @mutex.synchronize do
           @last_checked_at = Time.now
         end
-        @updated_at.present? && @updated_at >= Setting.maximum(:updated_at)
+        max_updated_at = Setting.maximum(:updated_at)
+
+        # if there is no settings in the database - don't try to refresh settings from it'
+        return true if max_updated_at.blank?
+
+        @updated_at.present? && @updated_at >= max_updated_at
       end
     end
   end

data/lib/blueprint_config/configuration.rb

@@ -16,7 +16,7 @@ module BlueprintConfig
           reload! unless backends&.fresh?
           config.#{method}(...)
         rescue KeyError => e
-          raise KeyError, e.message, caller[1..], cause: nil    
+          raise KeyError, e.message, caller[1..], cause: nil#{'    '}
         end
       RUBY
     end

data/lib/blueprint_config/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlueprintConfig
-  VERSION = '1.1.0'
+  VERSION = '1.3.0'
 end

data/lib/blueprint_config.rb

@@ -9,14 +9,18 @@ require 'blueprint_config/backend_collection'
 module BlueprintConfig
   class << self
     attr_accessor :root, :env, :before_initialize, :after_initialize
-    attr_writer :shortcut_name, :env_options
+    attr_writer :shortcut_name, :env_backend_options, :active_record_backend_options
 
     def shortcut_name
       @shortcut_name || 'AppConfig'
     end
 
-    def env_options
-      @env_options || {}
+    def env_backend_options
+      @env_backend_options ||= {}
+    end
+
+    def active_record_backend_options
+      @active_record_backend_options ||= { nest: true }
     end
 
     def define_shortcut
@@ -46,8 +50,6 @@ module BlueprintConfig
   end
 end
 
-BlueprintConfig.env_options ||= {}
-
 BlueprintConfig.before_initialize ||= proc do
   require 'blueprint_config/backend/credentials'
   require 'blueprint_config/backend/active_record'
@@ -55,17 +57,19 @@ BlueprintConfig.before_initialize ||= proc do
   BlueprintConfig.instance.init do |backends|
     backends.use :app,         BlueprintConfig::Backend::YAML.new('config/app.yml')
     backends.use :credentials, BlueprintConfig::Backend::Credentials.new
-    backends.use :env,         BlueprintConfig::Backend::ENV.new(BlueprintConfig.env_options)
+    backends.use :env,         BlueprintConfig::Backend::ENV.new(BlueprintConfig.env_backend_options)
     backends.use :app_local,   BlueprintConfig::Backend::YAML.new('config/app.local.yml')
   end
 end
 
 BlueprintConfig.after_initialize ||= proc do
   BlueprintConfig.instance.refine do |backends|
+    ar_backend = BlueprintConfig::Backend::ActiveRecord.new(BlueprintConfig.active_record_backend_options)
+
     if backends[:env]
-      backends.insert_after :env, :db, BlueprintConfig::Backend::ActiveRecord.new
+      backends.insert_after :env, :db, ar_backend
     else
-      backends.push :db, BlueprintConfig::Backend::ActiveRecord.new
+      backends.push :db, ar_backend
     end
   end
 end

data/spec/blueprint_config/backend/active_record_spec.rb

@@ -3,39 +3,119 @@
 require 'active_record'
 require 'blueprint_config/backend/active_record'
 
-ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
-
-ActiveRecord::Base.connection.create_table :settings do |t|
-  t.string :key, null: false, index: { unique: true }
-  t.integer :type, null: false, default: 0
-  t.string :value
-  t.timestamps
-end
-
 describe BlueprintConfig::Backend::ActiveRecord do
   let(:options) { {} }
   let(:subject) { described_class.new(options).load_keys }
-  around do |example|
-    ActiveRecord::Base.transaction do
+
+  context 'Database is correctly setup' do
+    around do |example|
+      ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+      ActiveRecord::Base.connection.create_table :settings do |t|
+        t.string :key, null: false, index: { unique: true }
+        t.integer :type, null: false, default: 0
+        t.string :value
+        t.timestamps
+      end
+
       BlueprintConfig::Setting.create(key: 'foo', type: :string, value: 'bar')
       BlueprintConfig::Setting.create(key: 'x', type: :integer, value: '1')
       BlueprintConfig::Setting.create(key: 'a.b', type: :string, value: '1')
 
       example.run
-      raise ActiveRecord::Rollback
+      ActiveRecord::Base.remove_connection
+    end
+
+    context 'with default options' do
+      it 'loads all keys' do
+        expect(subject).to eq({ foo: 'bar', "a.b": '1', x: 1 })
+      end
+    end
+
+    context 'when nesting enabled' do
+      let(:options) { { nest: true } }
+      it 'loads all keys' do
+        expect(subject).to eq({ foo: 'bar', a: { b: '1' }, x: 1 })
+      end
     end
   end
 
-  context 'with default options' do
-    it 'loads all keys' do
-      expect(subject).to eq({ foo: 'bar', "a.b": '1', x: 1 })
+  context 'Database is not configured' do
+    it 'returns empty hash' do
+      expect(subject).to eq({})
     end
   end
 
-  context 'when nesting enabled' do
-    let(:options) { { nest: true } }
-    it 'loads all keys' do
-      expect(subject).to eq({ foo: 'bar', a: { b: '1' }, x: 1 })
+  context 'Database does not have proper table' do
+    around do |example|
+      ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+      example.run
+      ActiveRecord::Base.remove_connection
+    end
+
+    it 'returns empty hash' do
+      expect(subject).to eq({})
+    end
+    it 'prints warning in console' do
+      expect { subject }.to output(a_string_including('blueprint_config:install'))
+        .to_stdout_from_any_process
+    end
+    context 'when silencing enabled' do
+      let(:options) { { silence_warnings: true } }
+      it 'prints nothing in console' do
+        expect { subject }.to_not output.to_stdout_from_any_process
+      end
+    end
+  end
+
+  context 'Database does table does not have correct attributes' do
+    around do |example|
+      ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+      ActiveRecord::Base.connection.create_table :settings do |t|
+        t.string :alias, null: false, index: { unique: true }
+        t.integer :type, null: false, default: 0
+        t.string :string
+      end
+      BlueprintConfig::Setting.reset_column_information
+      BlueprintConfig::Setting.create(alias: 'foo', type: :string, string: 'bar')
+      BlueprintConfig::Setting.create(alias: 'x', type: :integer, string: '1')
+      BlueprintConfig::Setting.create(alias: 'a.b', type: :integer, string: '1')
+
+      example.run
+      ActiveRecord::Base.remove_connection
+    end
+
+    it 'returns empty hash' do
+      expect(subject).to eq({})
+    end
+    it 'prints warning in console' do
+      expect { subject }.to output(a_string_including('blueprint_config:install'))
+        .to_stdout_from_any_process
+    end
+    context 'when silencing enabled' do
+      let(:options) { { silence_warnings: true } }
+      it 'prints nothing in console' do
+        expect { subject }.to_not output.to_stdout_from_any_process
+      end
+    end
+  end
+
+  context 'Database does not have any records' do
+    around do |example|
+      ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+      ActiveRecord::Base.connection.create_table :settings do |t|
+        t.string :key, null: false, index: { unique: true }
+        t.integer :type, null: false, default: 0
+        t.string :value
+        t.timestamps
+      end
+      example.run
+      ActiveRecord::Base.remove_connection
+    end
+
+    it 'returns empty hash' do
+      expect(subject).to eq({})
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blueprint_config
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Vladimir Elchinov
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord