record_store 6.4.0 → 6.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 729d72dfcdc31837d583ed7701c8c9a20a344ff1a15c16e0473b6bec160eaa4a
-  data.tar.gz: 77287fe899cd38ac839f62925daae1e416a69ddf3dab895c1f8c5f61eef5777b
+  metadata.gz: 444fc56b77f3f4a4142af2094365fea4bd2ac0a2a89d2f42574067c48f13a4e6
+  data.tar.gz: 6d4bb6928c710a6d247be321e05b91ca929ac44d9ec15a2c99967e1f0a994d09
 SHA512:
-  metadata.gz: 2facb09ae40af90a3f7b83700b00251b3ba29415a1c0c91ab09f9be36136591ad338d63685bb60e12b5779a1645242f5aa4a3f458436f91ea604235f11b78a68
-  data.tar.gz: 5f77c86a04dcc27385358fb8039b2c2e717b12e086e726c7d08915db284866e95b2038529675a1516ea0114ca2b53785bcd9331b05f75b93e187a7f87d1918a9
+  metadata.gz: bf23882c66cfca5065bc4fb3308f39e5e441d085f2891297c254b9ff8f4af0b4b73a8a04cf806ad861f4cd6b075b429c20e74c73e5e6e0047a19b7b59ff4548f
+  data.tar.gz: 187c5f2c80fc0dfeb6baa3583ed2fadf1dac26ac0e3d344fd3cb7ce6b378cda27cfaa382250db0da79f5cf9514cfd40a27d74f5fda41cfa266cb4f4388b5bec2

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on: [push, pull_request]
+
+env:
+  SRB_SKIP_GEM_RBIS: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ 2.7.1 ]
+    name: Test Ruby ${{ matrix.ruby }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: rubocop
+        run: bin/rubocop --version && bin/rubocop
+      - name: setup
+        run: bin/setup
+      - name: test
+        run: bundle exec rake test

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # CHANGELOG
 
+## 6.5.2
+- Ensure filters for implicit_records, `except_record` and `conflict_with`, are truly optional [BUGFIX]
+
+## 6.5.1
+
+Add support for a new parameter in the implicit records templates:
+
+- `except_record`: the template will *NOT* generate the `injected_records` for records matching `except_record`, even if they matched `each_record`.
+
+Also added support for regular expressions in the matching, using the already available `!ruby/regexp` text in a YAML value. The object loaded from the YAML
+will be of `Regexp` type, and will thus be used to _match_ the value, instead of being identical only. This is supported in both `except_record` and
+`each_record` fields.
+
+## 6.5.0
+
+...
+
 ## 6.4.0
 
 Add support for injecting implicit records into a zone based on a pre-configured template. Brief overview of template keys:

data/lib/record_store/version.rb

@@ -1,3 +1,3 @@
 module RecordStore
-  VERSION = '6.4.0'.freeze
+  VERSION = '6.5.2'.freeze
 end

data/lib/record_store/zone.rb

@@ -20,6 +20,7 @@ module RecordStore
     validate :validate_provider_can_handle_zone_records
     validate :validate_no_empty_non_terminal
     validate :validate_can_handle_alias_records
+    validate :validate_no_duplicate_keys
 
     class << self
       def download(name, provider_name, **write_options)
@@ -70,10 +71,11 @@ module RecordStore
       end
     end
 
-    def initialize(name:, records: [], config: {})
+    def initialize(name:, records: [], config: {}, abstract_syntax_trees: {})
       @name = Record.ensure_ends_with_dot(name)
       @config = RecordStore::Zone::Config.new(config.deep_symbolize_keys)
       @records = build_records(records)
+      @abstract_syntax_trees = abstract_syntax_trees
     end
 
     def build_changesets(all: false)
@@ -191,7 +193,7 @@ module RecordStore
     def build_records(records)
       all_records = records.map { |record| Record.build_from_yaml_definition(record) }
 
-      config.implicit_record_templates.each do |template|
+      config.implicit_records_templates.each do |template|
         all_records.push(*template.generate_records_to_inject(current_records: all_records))
       end
 
@@ -307,5 +309,34 @@ module RecordStore
 
       errors.add(:records, "ALIAS record should be defined on the root of the zone: #{alias_record}")
     end
+
+    def validate_no_duplicate_keys
+      @abstract_syntax_trees.each do |filename, ast|
+        validate_no_duplicate_keys_in_node(filename, ast)
+      end
+    end
+
+    def validate_no_duplicate_keys_in_node(filename, node)
+      if node.mapping?
+        keys = node
+          .children
+          .each_slice(2)
+          .map(&:first)
+          .map(&:value)
+          .sort
+        dup_keys = keys
+          .find_all { |k| keys.count(k) > 1 }
+          .uniq
+        unless dup_keys.empty?
+          location = "#{File.basename(filename)}:#{node.start_line}"
+          description = "multiple definitions for keys #{dup_keys}"
+          errors.add(:records, "#{location}: #{description}")
+        end
+      end
+
+      node.children&.each do |child|
+        validate_no_duplicate_keys_in_node(filename, child)
+      end
+    end
   end
 end

data/lib/record_store/zone/config.rb

@@ -3,15 +3,15 @@ module RecordStore
     class Config
       include ActiveModel::Validations
 
-      attr_reader :ignore_patterns, :providers, :supports_alias, :implicit_record_templates
+      attr_reader :ignore_patterns, :providers, :supports_alias, :implicit_records_templates
 
       validate :validate_zone_config
 
-      def initialize(ignore_patterns: [], providers: nil, supports_alias: nil, implicit_record_templates: [])
+      def initialize(ignore_patterns: [], providers: nil, supports_alias: nil, implicit_records_templates: [])
         @ignore_patterns = ignore_patterns.map do |ignore_pattern|
           Zone::Config::IgnorePattern.new(ignore_pattern)
         end
-        @implicit_record_templates = implicit_record_templates.map do |filename|
+        @implicit_records_templates = implicit_records_templates.map do |filename|
           Zone::Config::ImplicitRecordTemplate.from_file(filename: filename)
         end
         @providers = providers

data/lib/record_store/zone/config/implicit_record_template.rb

@@ -26,9 +26,14 @@ module RecordStore
           def from_file(filename:)
             filepath = template_filepath_for(filename: filename)
             template_file = File.read(filepath)
-            filters_for_records_to_template = YAML.load(template_file).deep_symbolize_keys[:each_record]
 
-            new(template: ERB.new(template_file), filters_for_records_to_template: filters_for_records_to_template)
+            template_file_yaml = YAML.load(template_file).deep_symbolize_keys
+            filters_for_records_to_template = template_file_yaml[:each_record]
+            filters_for_records_to_exclude = template_file_yaml[:except_record] || []
+
+            new(template: ERB.new(template_file),
+                filters_for_records_to_template: filters_for_records_to_template,
+                filters_for_records_to_exclude: filters_for_records_to_exclude)
           end
 
           private
@@ -38,9 +43,10 @@ module RecordStore
           end
         end
 
-        def initialize(template:, filters_for_records_to_template:)
+        def initialize(template:, filters_for_records_to_template:, filters_for_records_to_exclude:)
           @template = template
           @filters_for_records_to_template = filters_for_records_to_template
+          @filters_for_records_to_exclude = filters_for_records_to_exclude
         end
 
         def generate_records_to_inject(current_records:)
@@ -61,23 +67,29 @@ module RecordStore
 
         private
 
-        attr_reader :template, :filters_for_records_to_template
+        attr_reader :template, :filters_for_records_to_template, :filters_for_records_to_exclude
 
         def should_inject?(template_records:, current_records:)
+          conflict_with = template_records[:conflict_with] || []
           current_records.none? do |record|
-            template_records[:conflict_with].any? do |filter|
+            conflict_with.any? do |filter|
               record_match?(record: record, filter: filter)
             end
           end
         end
 
         def should_template?(record:)
-          filters_for_records_to_template.any? { |filter| record_match?(record: record, filter: filter) }
+          filters_for_records_to_template.any? { |filter| record_match?(record: record, filter: filter) } && \
+            filters_for_records_to_exclude.none? { |filter| record_match?(record: record, filter: filter) }
         end
 
         def record_match?(record:, filter:)
           filter.all? do |key, value|
-            record.public_send(key) == value
+            if value.is_a?(Regexp)
+              value.match(record.public_send(key))
+            else
+              record.public_send(key) == value
+            end
           end
         end
 

data/lib/record_store/zone/yaml_definitions.rb

@@ -66,7 +66,10 @@ module RecordStore
         Dir["#{dir}/#{name}/*__*.yml"].each do |record_file|
           definition['records'] += load_yml_record_definitions(name, record_file)
         end
-        Zone.new(name: name, records: definition['records'], config: definition['config'])
+
+        asts = { filename => Psych.parse_file(filename) }
+
+        Zone.new(name: name, records: definition['records'], config: definition['config'], abstract_syntax_trees: asts)
       end
 
       def load_yml_record_definitions(name, record_file)

data/template/templates/implicit_records/implicit_example.yml.erb

@@ -2,6 +2,8 @@ each_record:
 - type: A
   fqdn: abc.123.com.
 - type: TXT
+except_record:
+- fqdn: !ruby/regexp /^_/
 conflict_with:
 - type: TXT
   fqdn: <%= record.fqdn %>.more.domain.com.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: record_store
 version: !ruby/object:Gem::Version
-  version: 6.4.0
+  version: 6.5.2
 platform: ruby
 authors:
 - Willem van Bergen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-02 00:00:00.000000000 Z
+date: 2021-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -335,6 +335,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop-https---shopify-github-io-ruby-style-guide-rubocop-yml"
 - ".rubocop.yml"
@@ -416,7 +417,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Manage DNS using git