Define to_s and inspect on enums

Author: thegorgon

lib/enum_type/enum_class.rb

@@ -13,7 +13,9 @@ def self.create(attributes)
 
     def self.create_from_array(attributes)
       attributes = %i[name value] + attributes
-      Struct.new(*attributes)
+      klass = Struct.new(*attributes)
+      define_inspection_methods(klass)
+      klass
     end
 
     def self.create_from_hash(attributes)
@@ -36,7 +38,19 @@ def self.create_from_hash(attributes)
           instance_variable_set("@#{name}", values[index])
         end
       end
+      define_inspection_methods(klass)
       klass
     end
+
+    def self.define_inspection_methods(klass)
+      klass.send(:define_method, :to_s) do
+        name.to_s
+      end
+
+      klass.send(:define_method, :inspect) do
+        "\#<Enum:#{name} #{value.inspect}>"
+      end
+    end
+    private_class_method :define_inspection_methods
   end
 end

spec/enum_type_spec.rb

@@ -65,6 +65,18 @@
       it 'allows getting the list of names as symbols' do
         expect(enum.names).to eq %i[RED GREEN BLUE]
       end
+
+      it 'defines to_s as name on the enums' do
+        expect(enum.RED.to_s).to eq 'RED'
+        expect(enum.GREEN.to_s).to eq 'GREEN'
+        expect(enum.BLUE.to_s).to eq 'BLUE'
+      end
+
+      it 'defines inspect as a reasonable name on the enums' do
+        expect(enum.RED.inspect).to eq '#<Enum:RED :red>'
+        expect(enum.GREEN.inspect).to eq '#<Enum:GREEN :green>'
+        expect(enum.BLUE.inspect).to eq '#<Enum:BLUE :blue>'
+      end
     end
 
     context 'with array attributes' do
@@ -115,6 +127,18 @@
       it 'allows getting the list of names as symbols' do
         expect(enum.names).to eq %i[RED GREEN BLUE]
       end
+
+      it 'defines to_s as name on the enums' do
+        expect(enum.RED.to_s).to eq 'RED'
+        expect(enum.GREEN.to_s).to eq 'GREEN'
+        expect(enum.BLUE.to_s).to eq 'BLUE'
+      end
+
+      it 'defines inspect as a reasonable name on the enums' do
+        expect(enum.RED.inspect).to eq '#<Enum:RED :red>'
+        expect(enum.GREEN.inspect).to eq '#<Enum:GREEN :green>'
+        expect(enum.BLUE.inspect).to eq '#<Enum:BLUE :blue>'
+      end
     end
 
     context 'with hash attributes' do
@@ -165,6 +189,18 @@
       it 'allows getting the list of names as symbols' do
         expect(enum.names).to eq %i[RED GREEN BLUE]
       end
+
+      it 'defines to_s as name on the enums' do
+        expect(enum.RED.to_s).to eq 'RED'
+        expect(enum.GREEN.to_s).to eq 'GREEN'
+        expect(enum.BLUE.to_s).to eq 'BLUE'
+      end
+
+      it 'defines inspect as a reasonable string on the enums' do
+        expect(enum.RED.inspect).to eq '#<Enum:RED "red">'
+        expect(enum.GREEN.inspect).to eq '#<Enum:GREEN "green">'
+        expect(enum.BLUE.inspect).to eq '#<Enum:BLUE "blue">'
+      end
     end
 
     context 'with hash attributes and an invalid definition' do