galetahub-enum_field 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8fe01fd9a421a42a8bc5a49fc1f1f57d78b3ef8
-  data.tar.gz: 3b86f719ab1b2dc329af61fca85ffff9e797bf42
+  metadata.gz: 6aecc946fb32aa9197932e9ff1264bbf06cd19ef
+  data.tar.gz: 58f8f65ee968672a7b1678819b18612a7faec2ac
 SHA512:
-  metadata.gz: c51540d123b2444fbc79dcde8457590960911e5147d19aac45931eda9ce5aa842efe64bd95e5fa3e258e5699e51d9fe3b47c33348290be6dfd9040d003f634e8
-  data.tar.gz: 744b7af8a17cf2c2ee51f5a1d154a42ad03926a2a5e8f72943d63f5053110f658a7ce2bfe97c50f7ed2ad3040fd9e7cffc6df90b415ebd40f5d01e782beb7446
+  metadata.gz: 2a9241a8594e8f55df86dd494cf288075e2865cb47672f537f675bd0c3e982b38c764bfa9b916dd69a67bf530f43f62274c766a04d147f87abf762d5a8eb8616
+  data.tar.gz: 065c0d729c5ecd8ef57b5673eb7802a851ad96c1a6c89f4b130edf3f808fb1440e681b3694bf1b749fc150a202f3506073de43387c7e6272817379771726cd47

data/README.md

@@ -6,11 +6,11 @@
 Enables Active Record attributes to point to enum like objects, by saving in your database
 only an integer ID.
 
-## INSTALL:
+## Install
 
     gem 'galetahub-enum_field', require: 'enum_field'
 
-## FEATURES:
+## Features
 
 * Allows creation of Classes with enum like behaviour.
 * Allows any number of members and methods in the enum classes.
@@ -20,7 +20,7 @@ only an integer ID.
   * <code>if user.role.can_edit?</code>
 * Saves in your +AR+ tables, only an integer id pointing to the enumeration member.
 
-## SYNOPSIS:
+## Synopsis
 
 When in an Active Record class, you have an attribute like role, state or country you have
 several options.
@@ -31,7 +31,7 @@ several options.
 
 If you are not comfortable with any of this options, maybe +enum_field+ is an answer for you.
 
-## BASIC USAGE:
+## Basic usage
 
 Define rules:
 
@@ -79,18 +79,21 @@ Your enum classes can have all the methods you need:
 class PhoneType
   include EnumField::DefineEnum
 
-  def initialize(name)
-    @name = name
+  attr_reader :prefix
+
+  def initialize(prefix)
+    @prefix = prefix
   end
 
   define_enum do
-    member :home,       object: new('home')
-    member :commercial, object: new('commercial')
-    member :mobile,     object: new('mobile')
+    member :home,       object: new('045')
+    member :commercial, object: new('044')
+    member :mobile,     object: new('+380')
   end
 end
 
-user.phone.type.name
+user.phone_type.prefix # +380
+user.phone_type.name   # :mobile
 ```
 
 You have some +AR+ like methods in enum classes
@@ -126,6 +129,31 @@ CommentType.audio.id # 102
 CommentType.text.id  # 103
 ```
 
+### Check if id exists
+
+``` ruby
+CommentType.valid_id?(-1)    # false
+CommentType.valid_id?(0)     # false
+CommentType.valid_id?(nil)   # false
+CommentType.valid_id?(1)     # false
+CommentType.valid_id?('101') # false
+CommentType.valid_id?(:text) # false
+
+CommentType.valid_id?(101)   # true
+```
+
+### Check if name exists
+
+``` ruby
+CommentType.valid_name?('video') # true
+CommentType.valid_name?(:video)  # true
+
+CommentType.valid_name?(nil)     # false
+CommentType.valid_name?(1)       # false
+CommentType.valid_name?('wrong') # false
+CommentType.valid_name?(:wrong)  # false
+```
+
 ## Tests
 
     bundle install

data/lib/enum_field/builder.rb

@@ -2,7 +2,7 @@
 
 module EnumField
   class Builder
-    METHODS = %w[all names find_by_id find first last ids].freeze
+    METHODS = %w[all names find_by_id find first last ids valid_id? valid_name?].freeze
 
     attr_reader :members
 
@@ -44,6 +44,14 @@ module EnumField
       all.map(&:id)
     end
 
+    def valid_id?(value)
+      !value.nil? && ids.include?(value)
+    end
+
+    def valid_name?(value)
+      !value.nil? && names.include?(normalize_name(value))
+    end
+
     def find(id)
       find_by_id(id) || raise(EnumField::ObjectNotFound)
     end
@@ -57,6 +65,23 @@ module EnumField
       end
     end
 
+    def method_missing(method_name, *args, &block)
+      if @target.respond_to?(method_name)
+        @target.send(method_name, *args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      @target.respond_to?(method_name) || super
+    end
+
+    def freeze!
+      @members.freeze
+      freeze
+    end
+
     private
 
     def create_new_object(name, options)

data/lib/enum_field/define_enum.rb

@@ -25,9 +25,9 @@ module EnumField
           end
         end
 
-        @enum_builder.members.keys.each do |method|
+        @enum_builder.names.each do |method|
           define_singleton_method method do
-            @enum_builder.members[method]
+            @enum_builder[method]
           end
 
           define_method "#{method}?" do
@@ -39,7 +39,7 @@ module EnumField
           @enum_builder[value]
         end
 
-        @enum_builder.members.freeze
+        @enum_builder.freeze!
       end
     end
 

data/lib/enum_field/version.rb

@@ -1,3 +1,3 @@
 module EnumField
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.5.1'.freeze
 end

data/spec/enum_field/define_enum_spec.rb

@@ -124,5 +124,58 @@ describe EnumField::DefineEnum do
       expect(comment_type.audio.id).to eq start_number + 2
       expect(comment_type.text.id).to eq start_number + 3
     end
+
+    it 'must check valid id' do
+      expect(comment_type.valid_id?(-1)).to eq false
+      expect(comment_type.valid_id?(0)).to eq false
+      expect(comment_type.valid_id?(nil)).to eq false
+      expect(comment_type.valid_id?(1)).to eq false
+      expect(comment_type.valid_id?('101')).to eq false
+      expect(comment_type.valid_id?(:text)).to eq false
+
+      expect(comment_type.valid_id?(101)).to eq true
+    end
+
+    it 'must check valid name' do
+      expect(comment_type.valid_name?('video')).to eq true
+      expect(comment_type.valid_name?(:video)).to eq true
+
+      expect(comment_type.valid_name?(nil)).to eq false
+      expect(comment_type.valid_name?(0)).to eq false
+      expect(comment_type.valid_name?(101)).to eq false
+      expect(comment_type.valid_name?('wrong')).to eq false
+      expect(comment_type.valid_name?(:not_exist)).to eq false
+    end
+  end
+
+  context 'custom objects' do
+    let(:start_number) { 100 }
+    let(:figure_type) do
+      Class.new(Object) do
+        include EnumField::DefineEnum
+
+        attr_accessor :size
+
+        def initialize(size)
+          @size = size
+        end
+
+        define_enum do
+          member :straight, object: new(10)
+          member :pear, object: new(20)
+          member :spoon, object: new(30)
+        end
+      end
+    end
+
+    it 'must set size attribute' do
+      expect(figure_type.straight.size).to eq 10
+      expect(figure_type.straight.name).to eq :straight
+      expect(figure_type.straight.id).to eq 1
+    end
+
+    it 'must freeze objects' do
+      expect { figure_type.pear.size = 100 }.to raise_error(RuntimeError)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: galetahub-enum_field
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Igor Galeta
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-04-28 00:00:00.000000000 Z
+date: 2017-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Enumerated attributes for any ruby class aka Active Record