yaml_enumeration 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d42b540fe754657e4e982b3324efcc67aaf7726019311dc574ec0035ee7b76ea
-  data.tar.gz: c046de0c21e60c0f0bed6be8f276b60988182ecb793893ce4433d8cfbccfa1af
+  metadata.gz: 789056e38408fc39c5203d9b27347d67eac1223a005c4e97d6c3fbb0b50e52c9
+  data.tar.gz: f687bbcc331fa6959225a5701721b156ae652dc5c51540f4a85d2b8c75d66ab0
 SHA512:
-  metadata.gz: d4b52ee6c9b97391eb0d3aea409595c2d3ef253a7b364222d47020da7fa4e017802029556b50d4e0d997ea08a14f8b2c6d6287d334f0a56d94f874c87fe37974
-  data.tar.gz: ec4e04994a577354f8fd360601a5f4b07ba3153193a356dac69c8a89b162431451f75dd4addc7477be5cff26fe7cad968481f84ef1b374dd9649b8df744f3fb1
+  metadata.gz: 937de680ad7a668d42faa880eac779d53d0bfb9833bfdf981f50c97cf3703d113de49e550b3290ae27c9a7ca7173d44b0630cbf5922a07e60464b98886cb20e5
+  data.tar.gz: bc24da29146aac8453d17badffaf83176dc8c937d54eff3660ead43b8261237445741c1db95fff163bdf8f0fddeb80adc6e2f925573f3aa2d71604a4c05b3b8d

data/.travis.yml

@@ -4,4 +4,6 @@ rvm:
   - 2.5.3
   - 2.6.5
   - 2.7.1
+  - 3.0.5
+  - 3.1.4
 before_install: gem install bundler

data/CHANGELOG.md

@@ -1,14 +1,20 @@
 # CHANGELOG
 
+## 0.4.0
+ * add support for Ruby `3.1` [#7](https://github.com/alto/yaml_enumeration/pull/7)
+
+## 0.3.0
+ * enable exclusion of blocks of YAML from the enumeration (support YAML anchors) [#6](https://github.com/alto/yaml_enumeration/pull/6)
+
 ## 0.2.2
- * enhance find-by methods [#4])(https://github.com/alto/yaml_enumeration/pull/4)
- * add support for Ruby `2.6` and `2.7` [#3])(https://github.com/alto/yaml_enumeration/pull/3)
+ * enhance find-by methods [#4](https://github.com/alto/yaml_enumeration/pull/4)
+ * add support for Ruby `2.6` and `2.7` [#3](https://github.com/alto/yaml_enumeration/pull/3)
 
 ## 0.2.1
- * add support for Ruby `2.5.3` [#2])(https://github.com/alto/yaml_enumeration/pull/2)
+ * add support for Ruby `2.5.3` [#2](https://github.com/alto/yaml_enumeration/pull/2)
 
 ## 0.2.0
- * support _ActiveRecord_ methods `where`, `find_by` [#1])(https://github.com/alto/yaml_enumeration/pull/1), thanks to [@richdrich](https://github.com/richdrich)
+ * support _ActiveRecord_ methods `where`, `find_by` [#1](https://github.com/alto/yaml_enumeration/pull/1), thanks to [@richdrich](https://github.com/richdrich)
 
 ## 0.1.0
  * initial version

data/README.md

@@ -80,6 +80,36 @@ class User < ActiveRecord::Base
 end
 ```
 
+additional `yaml` syntax such as anchors can be removed from the enumeration by including `_exclude_from_enumeration`:
+
+```yaml
+# countries.yml
+---
+defaults_exclude_from_enumeration: &defaults
+  continent: Australia
+
+nz:
+  <<: *defaults
+  id: 1 # has to be provided
+  type: new_zealand # has to be provided
+  name: New Zealand
+  code: nz
+au:
+  <<: *defaults
+  id: 2
+  type: australia
+  name: Australia
+  code: au
+uk:
+  <<: *defaults
+  id: 3
+  type: united_kingdom
+  name: United Kingdom
+  code: uk
+  continent: Europe
+...
+```
+
 ## Accessing members
 
 If you include a call to class method `with_named_items` you will get an item defined for each typed entry in the enumeration, e.g. `Country.NEW_ZEALAND` and `Country.AUSTRALIA`.

data/lib/yaml_enumeration/configuration.rb

@@ -0,0 +1,14 @@
+module YamlEnumeration
+  class Configuration
+
+    DEFAULT_PERMITTED_CLASSED = [].freeze
+
+    class << self
+      attr_writer :permitted_classes
+
+      def permitted_classes
+        @permitted_classes || DEFAULT_PERMITTED_CLASSED
+      end
+    end
+  end
+end

data/lib/yaml_enumeration/enumeration.rb

@@ -13,7 +13,7 @@ module YamlEnumeration
 
     def self.load_values(filename)
       file = File.join(Rails.root, 'db', 'enumerations', "#{filename}.yml")
-      YAML.load(ERB.new(File.read(file)).result).values.each do |data|
+      remove_exclusions(yaml_load(ERB.new(File.read(file)).result)).values.each do |data|
         value data.symbolize_keys
       end
     end
@@ -126,6 +126,14 @@ module YamlEnumeration
         end
       end
 
+      def yaml_load(source)
+        begin
+          YAML.load(source, aliases: true, permitted_classes: Configuration.permitted_classes)
+        rescue ArgumentError
+          YAML.load(source, permitted_classes: Configuration.permiitted_classes)
+        end
+      end
+
       # Define singleton methods .BLAH for each type
       def with_named_items(column = :type)
         all.each do |item|
@@ -144,5 +152,10 @@ module YamlEnumeration
       self.id = id
     end
 
+    def self.remove_exclusions(result)
+      keys_to_remove = result.keys.select {|key| key =~ /.*_exclude_from_enumeration$/ }
+      result.except(*keys_to_remove)
+    end
+
   end # Enumeration
 end

data/lib/yaml_enumeration/version.rb

@@ -1,3 +1,3 @@
 module YamlEnumeration
-  VERSION = "0.2.2"
+  VERSION = "0.4.0"
 end

data/lib/yaml_enumeration.rb

@@ -1,4 +1,5 @@
 require "yaml_enumeration/version"
 require "yaml_enumeration/association"
 require "yaml_enumeration/enumeration"
+require "yaml_enumeration/configuration"
 require "yaml_enumeration/railtie"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml_enumeration
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Thorsten Boettger
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-28 00:00:00.000000000 Z
+date: 2023-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ files:
 - bin/setup
 - lib/yaml_enumeration.rb
 - lib/yaml_enumeration/association.rb
+- lib/yaml_enumeration/configuration.rb
 - lib/yaml_enumeration/enumeration.rb
 - lib/yaml_enumeration/railtie.rb
 - lib/yaml_enumeration/version.rb
@@ -138,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Create ActiveRecord enumerations based on YAML files.