r_creds 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7636928cd93f004b5d651ffca982183ae1d14affc19eb4521110f9e27f1d6342
-  data.tar.gz: 41aa95eb3f6844fdcce9ef52d1d0f4b17214ab11ea5f9495498e7418350a7cdf
+  metadata.gz: 57e20d024695254a526587f77b6a61cf8b9c51c19a09b71be4f05d392c6b80c1
+  data.tar.gz: 19088da2f4c05df90f15c3ba1a150c53831693170d074a7ada79f5317f07ff8a
 SHA512:
-  metadata.gz: b887e3669f71b8a33dd5b94fd58cbc9aa1c445dad0cf42c3e54c2fd5fa388c087773c49f6111d8549dd3656b659bd3785bd81dff3f224610ab3e5a52e3808c66
-  data.tar.gz: 04b881382bf4e54669fd6874f37674961ba7e820bf770fbd27ee7385bf092d42e4a8792f82063410ae9f314ac214ca6f969d4c6ec782c72ddef08e63886bd385
+  metadata.gz: fbcbcbfd8c79efc2446f1da258368a7a2459bda119726d6bdca5d0ca67dc0f4afd007a72744138c557e43a14c98b8e28bf5b14e45aa14c6878d0d31e330b3e5c
+  data.tar.gz: 3830c5b4321bde44ebedcc1cb9cf264fb8bb763581e5c3b86547a438cd9f5efba4000f24358640a891ed8b22842688ac5cb698b934114e5d621571814ae07a9e

data/README.md

@@ -1,4 +1,4 @@
-# RCreds v1.1.1 - [changelog](https://github.com/coaxsoft/r_creds/blob/master/CHANGELOG.md)
+# RCreds v1.2.0 - [changelog](https://github.com/coaxsoft/r_creds/blob/master/CHANGELOG.md)
 
 RCreds makes working with Rails 5.2/6/7 credentials easier
 
@@ -23,6 +23,10 @@ Or install it yourself as:
 
     $ gem install r_creds
 
+Run the generator:
+
+    $ rails generate r_creds:install
+
 ## Usage
 There are no need to do this:
 ```ruby

data/lib/generators/r_creds/install_generator.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module RCreds
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __dir__)
+      desc 'Creates a RCreds config file.'
+
+      def copy_config
+        template 'r_creds_initializer.rb', "#{Rails.root}/config/initializers/r_creds.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/r_creds_initializer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'r_creds'
+
+RCreds.config do |c|
+  # c.environment_first = boolean # default: false
+  # c.allow_nil_value   = boolean # default: true
+end

data/lib/r_creds/fetcher.rb

@@ -1,14 +1,19 @@
+# frozen_string_literal: true
+
 module RCreds
   class Fetcher
     class NoRailsError < StandardError; end
+    class NilValueError < StandardError; end
 
-    def initialize(keys, default, environment)
+    def initialize(keys, default, environment, environment_first, allow_nil_value)
       @keys = keys.map!(&:to_sym)
       @default = default
       @environment = environment
+      @environment_first = environment_first
+      @allow_nil_value = allow_nil_value
     end
 
-    attr_reader :keys, :default
+    attr_reader :keys, :default, :environment_first, :allow_nil_value, :cred_value
 
     def call
       check_rails
@@ -21,10 +26,29 @@ module RCreds
       (presence?(@environment) || Rails.env).to_sym
     end
 
+    def check_rails
+      return define_rails_strategy && true if defined?(::Rails)
+
+      no_rails_error!
+    end
+
     def fetch
-      cred = send("fetch_rails_#{@rails_version}")
+      define_cred_value
 
-      presence?(cred) || presence?(ENV[keys.join('_').upcase]) || default
+      nil_value_error! if cred_value.nil? && !allow_nil_value
+
+      cred_value
+    end
+
+    def define_cred_value
+      cred = send("fetch_rails#{@rails_version}")
+      env = ENV[keys.join('_').upcase]
+
+      @cred_value = if environment_first.present?
+                      presence?(env) || presence?(cred) || default
+                    else
+                      presence?(cred) || presence?(env) || default
+                    end
     end
 
     def presence?(cred)
@@ -41,32 +65,38 @@ module RCreds
       cred.respond_to?(:empty?) ? !!cred.empty? : !cred
     end
 
-    def fetch_rails_5
+    def define_rails_strategy
+      @rails_version = Rails.version.to_i
+    end
+
+    def fetch_rails5
       Rails.application.credentials.dig(environment, *keys)
     end
 
-    def fetch_rails_6
+    def fetch_rails6
       if rails6_multi_env?
-        puts "WARNING! Environment choice does not work in Rails >= 6. Fetching credentials for '#{Rails.env}'" if presence?(@environment)
+        show_warning if presence?(@environment)
         Rails.application.credentials.dig(*keys)
       else
         Rails.application.credentials.dig(environment, *keys)
       end
     end
-    alias fetch_rails_7 fetch_rails_6
+    alias fetch_rails7 fetch_rails6
 
     def rails6_multi_env?
       Rails.application.credentials.content_path.basename.to_s != 'credentials.yml.enc'
     end
 
-    def check_rails
-      return define_rails_strategy && true if defined?(::Rails)
+    def show_warning
+      puts "WARNING! Environment choice does not work in Rails >= 6. Fetching credentials for '#{Rails.env}'"
+    end
 
-      raise NoRailsError, 'RCreds works with 5.2 and above'
+    def nil_value_error!
+      raise NilValueError, "can not find existing value by that keys -> #{keys}"
     end
 
-    def define_rails_strategy
-      @rails_version = Rails.version.to_i
+    def no_rails_error!
+      raise NoRailsError, 'RCreds works with 5.2 and above'
     end
   end
 end

data/lib/r_creds/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RCreds
-  VERSION = '1.1.1'.freeze
+  VERSION = '1.2.0'
 end

data/lib/r_creds.rb

@@ -1,8 +1,43 @@
+# frozen_string_literal: true
+
 require 'r_creds/version'
 require_relative 'r_creds/fetcher'
 
 module RCreds
-  def self.fetch(*keys, default: nil, environment: nil)
-    Fetcher.new(keys, default, environment).call
+  class << self
+    class InvalidTypeError < StandardError; end
+
+    attr_writer :environment_first, :allow_nil_value
+
+    def environment_first
+      @environment_first || false
+    end
+
+    def allow_nil_value
+      @allow_nil_value || true
+    end
+
+    def config
+      yield self
+    end
+
+    def fetch(*keys,
+              default: nil,
+              environment: nil,
+              environment_first: self.environment_first,
+              allow_nil_value: self.allow_nil_value)
+
+      [environment_first, allow_nil_value].each do |attr|
+        invalid_type_error! unless [true, false].include?(attr)
+      end
+
+      Fetcher.new(keys, default, environment, environment_first, allow_nil_value).call
+    end
+
+    private
+
+    def invalid_type_error!
+      raise InvalidTypeError, 'only boolean type allowed'
+    end
   end
 end

data/r_creds.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'r_creds/version'
@@ -12,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.description   = 'RCreds makes working with Rails 5.2 credentials easier'
   spec.homepage      = 'https://github.com/coaxsoft/r_creds'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.2.0'
+  spec.required_ruby_version = '>= 2.5'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -25,6 +27,8 @@ Gem::Specification.new do |spec|
   spec.files = Dir['README.md', 'lib/**/*', 'lib/*', 'r_creds.gemspec']
 
   spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'railties', '~> 7.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.11'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: r_creds
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - OrestF
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-30 00:00:00.000000000 Z
+date: 2022-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,34 +24,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.11'
 description: RCreds makes working with Rails 5.2 credentials easier
 email:
 - falchuko@gmail.com
@@ -60,6 +74,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- lib/generators/r_creds/install_generator.rb
+- lib/generators/templates/r_creds_initializer.rb
 - lib/r_creds.rb
 - lib/r_creds/fetcher.rb
 - lib/r_creds/version.rb
@@ -67,7 +83,8 @@ files:
 homepage: https://github.com/coaxsoft/r_creds
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -76,14 +93,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.0
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: RCreds makes working with Rails 5.2 credentials easier