smart_enum 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8eaf1f9daa80f2b5c6c9b8a8d2160972f5e6bdf4943e5b2b9d34993402e483da
-  data.tar.gz: 2d32004d0ab8cf7ef68f785433fc7ebcbdf82851b569bea2334217a19839bf99
+  metadata.gz: 7b509495447ff0f5652c258b272ce0ee0f37613b2c3e245a320677268cb4cb39
+  data.tar.gz: 934e89507c312f351ae5ad1d4fed972e83477314b42a2e426f7c5c79b1de5f44
 SHA512:
-  metadata.gz: 3ce8cfdf9f513c139e5becfdebc1d0a327e163acb0f45f22ba031063753ee57937ba2044cd93ef5f6d004de93a468efdf1fa2a8a55aa3d711a301a57b6ce6ca4
-  data.tar.gz: 4f6c7a78c8c66fba4c8e28e2163a84770ab11a29f8a0b85770ce9fc1808b39109e0dbf172e36dd91750206279e83f103d595ac3de2a5ec7b1ef261fb6b0d2fb9
+  metadata.gz: f55bf375b72f8fa189f3c9772300aafd571b458e96c40bc48647ab1c65f2ed7b4758c41082668c25ddcda3caf6812163a6bfa09da9128fa9f15dc2b28bb2c816
+  data.tar.gz: 289a41a759595796b31f08f224bdd844d68e085e55b261ad4b9033ac72852e1d39a1d47cfbf48988e090939560c65a4e70ab4a130ddb492bccd6914c82af835c

data/lib/smart_enum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class SmartEnum
-  VERSION = "2.2.0"
+  VERSION = "2.2.1"
 end

data/lib/smart_enum/yaml_store.rb

@@ -4,6 +4,12 @@ require 'yaml'
 # Methods for registering values from YAML files
 class SmartEnum
   module YamlStore
+    # Loads values from a YAML file or files
+    #
+    # Looks for a file or directory named after the enum type in the data root.
+    # If a directory is found, values from all of the YAML files in that directory
+    # are loaded.
+    # Otherwise, values are loaded from the file named after the enum.
     def register_values_from_file!
       unless SmartEnum::YamlStore.data_root
         raise "Must set SmartEnum::YamlStore.data_root before using `register_values_from_file!`"
@@ -12,10 +18,21 @@ class SmartEnum
         raise "Cannot infer data file for anonymous class"
       end
 
-      filename = "#{SmartEnum::Utilities.tableize(self.name)}.yml"
-      file_path = File.join(SmartEnum::YamlStore.data_root, filename)
-      values = YAML.load_file(file_path)
-      register_values(values, self, detect_sti_types: true)
+      basename = SmartEnum::Utilities.tableize(self.name)
+      dirname = File.join(SmartEnum::YamlStore.data_root, basename)
+      inferred_file = File.join(SmartEnum::YamlStore.data_root, "#{basename}.yml")
+      files = if Dir.exists?(dirname)
+                if File.exists?(inferred_file)
+                  raise AmbiguousSource, "#{self} values should be defined in inferred file or directory, not both"
+                end
+                Dir[File.join(dirname, "*.yml")]
+              else
+                [inferred_file]
+              end
+      files.each do |file_path|
+        values = YAML.load_file(file_path)
+        register_values(values, self, detect_sti_types: true)
+      end
     end
 
     def self.data_root
@@ -25,6 +42,8 @@ class SmartEnum
     def self.data_root=(val)
       @data_root = val
     end
+
+    class AmbiguousSource < RuntimeError; end
   end
 
   # automatically enable YAML store when this file is loaded

data/lib/smart_enum.rb

@@ -70,7 +70,7 @@ class SmartEnum
       else
         # No instance registration has been attempted, need to call
         # register_values or register_value and lock_enum! first.
-        raise "Cannot use unlocked enum"
+        raise EnumUnlocked, self
       end
     end
 
@@ -137,16 +137,20 @@ class SmartEnum
               enum_type
             end
     unless (_descends_from_cache[klass] ||= (klass <= self))
-      raise "Specified class #{klass} must derive from #{self}"
+      raise RegistrationError.new("Specified class must derive from #{self}", type: klass, attributes: attrs)
     end
     if klass.abstract_class
-      raise "#{klass} is marked as abstract and may not be registered"
+      raise RegistrationError, "#{klass} is marked as abstract and may not be registered"
     end
 
     instance = klass.new(attrs)
     id = instance.id
-    raise "Must provide id" unless id
-    raise "Already registered id #{id}!" if _enum_storage.has_key?(id)
+    unless id
+      raise MissingIDError.new(type: klass, attributes: attrs)
+    end
+    if _enum_storage.has_key?(id)
+      raise DuplicateIDError.new(type: klass, attributes: attrs, id: id, existing: _enum_storage[id])
+    end
     instance.freeze_attributes
     _enum_storage[id] = instance
     if klass != self
@@ -155,8 +159,44 @@ class SmartEnum
   end
 
   class EnumLocked < StandardError
+    attr_reader :type
+
     def initialize(klass)
+      @type = klass
       super("#{klass} has been locked and can not be written to")
     end
   end
+
+  class EnumUnlocked < StandardError
+    attr_reader :type
+
+    def initialize(klass)
+      @type = klass
+      super("Cannot use unlocked enum #{klass}.")
+    end
+  end
+
+  class RegistrationError < StandardError
+    attr_reader :type, :attributes
+
+    def initialize(info=nil, type: nil, attributes:{})
+      @info = info
+      @type = type
+      @attributes = attributes
+      super("Failed to register enum #{@type} with attributes: #{@attributes}. #{@info}")
+    end
+  end
+
+  class MissingIDError < RegistrationError
+  end
+
+  class DuplicateIDError < RegistrationError
+    attr_reader :id, :existing
+
+    def initialize(type:,id:,attributes:,existing:)
+      @id = id
+      @existing = existing
+      super("The ID #{@id} has already been registered with #{existing}", type: type, attributes: attributes)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_enum
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Carl Brasic
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2019-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord