attributor-flatpack 1.2.2 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d7c83619e69912dac110f8f66981c26904c3613b
-  data.tar.gz: a4379341c151eb0436fffcc3cd77630baa3b2efe
+SHA256:
+  metadata.gz: 05e224a1d45d2c46f2033a79cb42bc58862c40189c221dcece9bf5b77b68c330
+  data.tar.gz: 7e840c73a9af7cf19c4882500fb2b5559da0cf4315561ca635af31c5c3a47c20
 SHA512:
-  metadata.gz: 336ef03e6940a442de9300e65ab433a2691f45f54d583329fba22fa146e190bce0e792504815b3ad810eaa179c120ab2d9ec96431b58e3d08c9698d3146a8148
-  data.tar.gz: 523cdd36a4554f3b54caa997e16c57c64459fc29c97341b36073483590d7aa52bfd9e336fb7c2339e973bdf2d685d7baddd8d2d3998c4f282ddd35627e0b859b
+  metadata.gz: 1522bfc14ae927b1fd3aedcb0be2b2de83e33e640f4a0a457bb480b57404cef7345c08c534457a45ee0c327f860321c3641b649f3249ae8541a7f6ea75ccab09
+  data.tar.gz: 8949fdfc0466bf24fb7f33d86054e64b5289a1b678284538144a34c7d592fd53eecfc5dfc61946745871e3c33fd607b6066571ca52eb3630be92462986045714

data/.rubocop.yml

@@ -1,20 +1,26 @@
 AllCops:
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.7
+  NewCops: enable
 Style/Documentation:
   Enabled: false
-  Exclude:
-    - lib/attributor/flatpack/version.rb
-    - lib/attributor/flatpack.rb
-    - lib/attributor/flatpack/config.rb
-    - lib/attributor/flatpack/config_dsl_compiler.rb
-    - lib/attributor/flatpack/undefined_key.rb
+Metrics/AbcSize:
+  Max: 20
 Metrics/MethodLength:
   Enabled: false
 Metrics/ClassLength:
   Enabled: false
-Metrics/LineLength:
-  Max: 85
+Layout/LineLength:
+  Max: 160
+  Exclude:
+    - "spec/**/*.rb"
 Style/RedundantSelf:
   Enabled: false
 Style/DoubleNegation:
   Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb
+Style/RedundantFetchBlock:
+  Enabled: false
+Style/HashEachMethods:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.4.3
+2.7.1

data/CHANGELOG.md

@@ -1,13 +1,25 @@
 # attributor-flatpack changelog
 
+## 1.4.1
+
+- Fix regexp for `Config#subselect` not escaping the separator and not matching properly
+
+## 1.4
+
+- Respect `allow_extra: true` option when validating.
+
+## 1.3
+
+- Add `Attributor::Flatpack::MultilineString` type to handle multiline strings from environment variables.
+
 ## 1.2
 
-* Add support for redefining the separator 
+- Add support for redefining the separator
 
 ## 1.1
 
-* Significant performance improvements. See [benchmark results](benchmark/output.txt) for comparisons.
+- Significant performance improvements. See [benchmark results](benchmark/output.txt) for comparisons.
 
 ## 1.0
 
-* Initial Release
+- Initial Release

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in attributor-flatpack.gemspec

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
@@ -42,8 +44,8 @@ group :red_green_refactor, halt_on_fail: true do
     dsl.watch_spec_files_for(ruby.lib_files)
   end
 
-  guard :rubocop do
-    watch(/.+\.rb$/)
-    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
-  end
+  # guard :rubocop do
+  #   watch(/.+\.rb$/)
+  #   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  # end
 end

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 

data/attributor-flatpack.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 'attributor/flatpack/version'
@@ -20,7 +22,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.require_paths = ['lib']
 
   spec.add_dependency 'attributor', '>= 5'
-  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'codeclimate-test-reporter'
   spec.add_development_dependency 'fuubar', '~> 2'
   spec.add_development_dependency 'guard'
@@ -28,8 +30,8 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
   spec.add_development_dependency 'guard-rubocop'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'rspec-its'
   spec.add_development_dependency 'simplecov'
 end

data/benchmark/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gem 'attributor-flatpack', path: '../'
 gem 'benchmark-ips'

data/benchmark/bench.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
 Bundler.require
 
@@ -26,6 +28,7 @@ ConfigStruct = Struct.new(:home, :path)
 
 class Poro
   attr_accessor :home, :path
+
   def initialize(home, path)
     @home = home
     @path = path

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'attributor/flatpack'

data/examples/sample_config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pp'
 require 'bundler/setup'
 require 'pry'

data/lib/attributor/flatpack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'attributor'
 
 require 'attributor/flatpack/version'
@@ -5,6 +7,7 @@ require 'attributor/flatpack/config_dsl_compiler'
 
 require 'attributor/flatpack/config'
 require 'attributor/flatpack/undefined_key'
+require 'attributor/flatpack/types/multiline_string'
 
 module Attributor
   module Flatpack

data/lib/attributor/flatpack/config.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Attributor
   module Flatpack
     class Config < Attributor::Hash
-      @separator = '_'.freeze
+      @separator = '_'
       @key_type = Symbol
 
       class << self
@@ -19,6 +21,7 @@ module Attributor
           @separator = sep
         end
         klass.options[:dsl_compiler] = ConfigDSLCompiler
+        klass.options[:allow_extra] = true
       end
 
       def self.from_hash(object, _context, **_opts)
@@ -29,7 +32,8 @@ module Attributor
       def self.example(context = nil, **values)
         example = super
         # Need the @raw to be set as well, since we're using it in fetch
-        example.instance_variable_set(:@raw, @contents.dup)
+        contents = example.instance_variable_get(:@contents)
+        example.instance_variable_set(:@raw, contents.dup)
         example
       end
 
@@ -107,17 +111,17 @@ module Attributor
       def fetch(key)
         return @raw[key] if @raw.key?(key)
 
-        _found_key, found_value = @raw.find do |(k, _v)|
+        found_key, found_value = @raw.find do |(k, _v)|
           k.to_s.casecmp(key.to_s).zero?
         end
 
-        return found_value if found_value
+        return found_value if found_key
 
         yield if block_given?
       end
 
       def subselect(prefix)
-        prefix_match = /^#{prefix.to_s}#{self.class.separator}?(.*)/i
+        prefix_match = /^#{prefix}#{::Regexp.escape(self.class.separator)}(.*)/i
 
         selected = @raw.collect do |(k, v)|
           if (match = prefix_match.match(k))
@@ -147,7 +151,8 @@ module Attributor
       # shamelessly copied from Attributor::Model's #validate :(
       def validate(context = Attributor::DEFAULT_ROOT_CONTEXT)
         self.validate_attributes(context) +
-          self.validate_requirements(context)
+          self.validate_requirements(context) +
+          self.validate_keys(context)
       end
 
       def validate_attributes(context)
@@ -164,6 +169,16 @@ module Attributor
         end
       end
 
+      def validate_keys(context)
+        return [] if self.class.options[:allow_extra]
+
+        errors = (@raw.keys.collect(&:to_s) - self.class.keys.keys.collect(&:to_s)).collect do |extra_key|
+          "Unknown key received: #{extra_key.inspect} for #{Attributor.humanize_context(context)}"
+        end
+
+        errors
+      end
+
       def pretty_print(context: [])
         self.collect do |k, v|
           sub_context = context + [k]
@@ -175,6 +190,12 @@ module Attributor
           end
         end.flatten
       end
+
+      def dump(**opts)
+        # quick hack to ensure we load all the values into @contents
+        self.validate
+        super
+      end
     end
   end
 end

data/lib/attributor/flatpack/config_dsl_compiler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Attributor
   module Flatpack
     class ConfigDSLCompiler < Attributor::HashDSLCompiler
@@ -10,6 +12,7 @@ module Attributor
         if attr_type.nil? && block
           sep = target.separator
           # Ensure class for subkeys uses the same separator as the parent
+          opts[:allow_extra] = options[:allow_extra]
           attr_type = ::Class.new(Attributor::Flatpack::Config) do
             separator sep
           end

data/lib/attributor/flatpack/types/multiline_string.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Sometimes a multline string when read in by ruby has escaped newlines, sometimes not.
+# This type will remove any escaping of newline from a string.
+
+module Attributor
+  module Flatpack
+    class MultilineString < Attributor::String
+      def self.load(value, context = Attributor::DEFAULT_ROOT_CONTEXT, **options)
+        value.gsub('\\n', "\n")
+      rescue StandardError
+        super
+      end
+
+      def self.example(*)
+        '-----BEGIN EC PRIVATE KEY-----\\nMIHcAgEBBEI\\n3abcdefghijklmnop==\\n-----END EC PRIVATE KEY-----'
+      end
+    end
+  end
+end

data/lib/attributor/flatpack/undefined_key.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Attributor
   module Flatpack
     class UndefinedKey < Attributor::LoadError

data/lib/attributor/flatpack/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Attributor
   module Flatpack
-    VERSION = '1.2.2'.freeze
+    VERSION = '1.4.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attributor-flatpack
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.4.2
 platform: ruby
 authors:
 - Dane Jensen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-22 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attributor
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -140,30 +140,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -221,6 +221,7 @@ files:
 - lib/attributor/flatpack.rb
 - lib/attributor/flatpack/config.rb
 - lib/attributor/flatpack/config_dsl_compiler.rb
+- lib/attributor/flatpack/types/multiline_string.rb
 - lib/attributor/flatpack/undefined_key.rb
 - lib/attributor/flatpack/version.rb
 homepage: https://github.com/careo/attributor-flatpack
@@ -242,8 +243,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Attributor type for loading configuration data