enumerations 2.2.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6d3706af5a24b06cfd32e5313ae93aed2d141e1c
-  data.tar.gz: 84e6d7f1536f2fda8bf380dfb8aefd93251bf7fe
+  metadata.gz: 2df0679b8e64a8f5308716c2267da923343c3e25
+  data.tar.gz: 94e557e82f4a8e4b0b14c3c353e1a35c59041253
 SHA512:
-  metadata.gz: a33613627715d0897356efcef395ba8a9aaaa037a09c10164304c4fa852521c41f11d650cb3d99caa11e96ee41849c750e490fa154516177b23d231d93d61886
-  data.tar.gz: 8c79d5499ace432b42be7ba39a0ddac3a425dd23fd1c7da6401340bc6571e0bb13c8a673c4a1899ad98857ab861318753ed9ae9f8b747b7f4c0fc42aa17aaf50
+  metadata.gz: 487e7348405aa95e9cdbc1fa481b8bcf792aa991bcd34b0eebc4bdded31ccca85ec9d517b2fec77c9f133948f068e8d85095d832881c1203fe135515b6b8c9d5
+  data.tar.gz: 570bf8b1f44b99ec33c194dd9fc68b40c7cf3f6cf6e154e2d38d1229fc596c817dfdbc8a3ab065e7cf5ee6c60f1e91997f8a536e68587a01a5a9a64fe770e220

data/.gitignore

@@ -2,3 +2,4 @@
 *.gem
 Gemfile.lock
 .todo
+coverage

data/Migrate.md

@@ -0,0 +1,99 @@
+How to migrate from 1.x.x
+=========================
+
+Changes in the namespace
+========================
+
+First off, start by renaming your namespaces, what used to be
+
+```ruby
+class MyClass < Enumeration::Base
+```
+
+will now be
+
+```ruby
+class MyClass < Enumerations::Base
+```
+
+Configuration
+=============
+
+Since v2 has a breaking change of default values in the database columns, you have 2 options:
+
+1. Create an initializer that you will configure to have the old naming conventions
+2. Create data migrations and convert your data to be alligned with the new Enumerations
+
+First option might be tempting, but you need to weigh in the advantages of the new enumerations.
+With the second option, you can get enumerations in the database instead of ID's, which may prove quite usefull.
+
+First way
+=========
+
+You need to create the following initializer
+
+```ruby
+# config/initializers/enumerations.rb
+
+Enumerations.configure do |config|
+  config.primary_key        = :id
+  config.foreign_key_suffix = :id
+end
+```
+
+And voilà! You can carry on with work knowing your enumerations are up to date.
+
+Second way
+==========
+
+You can use a gem for the migration, or just write raw SQL.
+
+Your migrations will look something like this:
+
+First to change the column types
+```ruby
+class MoveMyEnumToNewEnumerationsColumns
+  def up
+    rename_column :my_table, :my_enum_id, :my_enum
+    change_column :my_table, :my_enum, :string
+  end
+
+  def down
+    change_column :my_table, :my_enum, 'integer USING CAST(my_enum AS integer)'
+    rename_column :my_table, :my_enum, :my_enum_id
+  end
+end
+```
+
+And now for the actual data
+
+```ruby
+class MoveMyEnumToNewEnumerations < ActiveRecord::Migration
+  def up
+    execute(<<-SQL
+      UPDATE my_table
+      SET my_enum =
+        CASE my_enum
+        WHEN '1' THEN 'first'
+        WHEN '2' THEN 'second'
+        WHEN '3' THEN 'third'
+        END
+    SQL
+    )
+  end
+
+  def down
+    execute(<<-SQL
+      UPDATE my_table
+      SET my_enum =
+        CASE my_enum
+        WHEN 'first' THEN '1'
+        WHEN 'second' THEN '2'
+        WHEN 'third' THEN '3'
+        END
+    SQL
+    )
+end
+```
+
+And that's it, you won't need an initializer for this to work anymore, because these are the default options Enumeration gem ships with.

data/Readme.md

@@ -222,6 +222,7 @@ class Status < Enumerations::Base
   value :draft,           id: 1, name: 'Draft'
   value :review_pending,  id: 2, name: 'Review pending', description: 'Some description...'
   value :published,       id: 3, name: 'Published', published: true
+  value :other                                 # passing no attributes is also allowed
 end
 ```
 

data/enumerations.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'i18n'
   s.add_development_dependency 'pry-byebug'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'codeclimate-test-reporter'
+  s.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
   s.add_development_dependency 'sqlite3'
 
   s.files         = `git ls-files`.split("\n")

data/lib/enumerations.rb

@@ -7,6 +7,7 @@ require 'enumerations/configuration'
 require 'enumerations/version'
 require 'enumerations/base'
 require 'enumerations/reflection'
+require 'enumerations/enumerations_error'
 
 module Enumerations
   extend ActiveSupport::Concern
@@ -86,6 +87,7 @@ module Enumerations
         enumeration_value = reflection.enumerator_class.find(other)
 
         self[reflection.foreign_key] =
+          enumeration_value &&
           enumeration_value.send(Enumerations.configuration.primary_key || :symbol)
       end
     end

data/lib/enumerations/base.rb

@@ -22,7 +22,7 @@ module Enumerations
     #   Role.find(:admin).name          => # "Admin"
     #   Role.find(:admin).description   => # "Some description..."
     #
-    def self.value(symbol, attributes)
+    def self.value(symbol, attributes = {})
       validate_symbol_and_primary_key(symbol, attributes)
 
       self._values = _values.merge(symbol => new(symbol, attributes))
@@ -80,13 +80,13 @@ module Enumerations
     end
 
     def self.validate_symbol_and_primary_key(symbol, attributes)
-      raise "Duplicate symbol #{symbol}" if find(symbol)
+      raise EnumerationsError, "Duplicate symbol #{symbol}" if find(symbol)
 
       primary_key = Enumerations.configuration.primary_key
       return if primary_key.nil?
 
-      raise 'Enumeration primary key is required' if attributes[primary_key].nil?
-      raise "Duplicate primary key #{attributes[primary_key]}" if find(attributes[primary_key])
+      raise EnumerationsError, 'Enumeration primary key is required' if attributes[primary_key].nil?
+      raise EnumerationsError, "Duplicate primary key #{attributes[primary_key]}" if find(attributes[primary_key])
 
       self._symbol_index = _symbol_index.merge(symbol => attributes[primary_key])
     end

data/lib/enumerations/enumerations_error.rb

@@ -0,0 +1,2 @@
+class EnumerationsError < RuntimeError
+end

data/lib/enumerations/version.rb

@@ -1,3 +1,3 @@
 module Enumerations
-  VERSION = '2.2.1'.freeze
+  VERSION = '2.2.2'.freeze
 end

data/test/base_test.rb

@@ -16,7 +16,7 @@ class BaseTest < Minitest::Test
   end
 
   def test_duplicated_symbol
-    assert_raises 'Duplicate symbol draft' do
+    assert_raises EnumerationsError, 'Duplicate symbol draft' do
       obj = Class.new(Enumerations::Base)
 
       obj.value :draft, id: 1, name: 'Draft'

data/test/configuration_test.rb

@@ -10,8 +10,8 @@ class ConfigurationTest < Minitest::Test
   end
 
   def test_default_configuration
-    assert_equal nil, Enumerations.configuration.primary_key
-    assert_equal nil, Enumerations.configuration.foreign_key_suffix
+    assert_nil Enumerations.configuration.primary_key
+    assert_nil Enumerations.configuration.foreign_key_suffix
   end
 
   def test_custom_configuration
@@ -37,15 +37,15 @@ class ConfigurationTest < Minitest::Test
   def test_required_primary_key_when_primary_key_configured
     Enumerations.configure { |config| config.primary_key = :id }
 
-    assert_raises 'Enumeration primary key is required' do
-      Class.new(Enumerations::Base).value draft: { name: 'Draft' }
+    assert_raises EnumerationsError, 'Enumeration primary key is required' do
+      Class.new(Enumerations::Base).value :draft, name: 'Draft'
     end
   end
 
   def test_duplicated_primary_key_when_primary_key_configured
     Enumerations.configure { |config| config.primary_key = :id }
 
-    assert_raises 'Duplicate primary key 1' do
+    assert_raises EnumerationsError, 'Duplicate primary key 1' do
       Class.new(Enumerations::Base).values draft: { id: 1, name: 'Draft' },
                                            test:  { id: 1, name: 'Draft' }
     end

data/test/enumerations_test.rb

@@ -1,4 +1,5 @@
 require_relative 'helpers/test_helper'
+require 'enumerations/enumerations_error'
 
 class EnumerationsTest < Minitest::Test
   def test_reflect_on_all_enumerations
@@ -75,8 +76,8 @@ class EnumerationsTest < Minitest::Test
   end
 
   def test_enumerated_class_has_scopes
-    Role.all do |role|
-      assert_respond_to User, ['with_role', role.name].join('_').to_sym
+    Role.all.each do |role|
+      assert_respond_to User, ['with_role', role.to_s].join('_').to_sym
     end
   end
 
@@ -85,4 +86,14 @@ class EnumerationsTest < Minitest::Test
 
     assert_equal query_hash, role: :admin
   end
+
+  def test_nonexistent_value_assignment
+    user = User.new(role: :nonexistent_value)
+    assert_nil user.role
+  end
+
+  def test_on_nil_value_assignment
+    user = User.new(role: nil)
+    assert_nil user.role
+  end
 end

data/test/finder_test.rb

@@ -28,7 +28,7 @@ class FinderTest < Minitest::Test
   def test_fail_find_by
     status = Status.find_by(name: 'Draft1')
 
-    assert_equal nil, status
+    assert_nil status
   end
 
   def test_where_by_name

data/test/helpers/test_helper.rb

@@ -1,5 +1,5 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
+require 'simplecov'
+SimpleCov.start
 
 require 'minitest/autorun'
 require 'enumerations'
@@ -22,6 +22,7 @@ class Role < Enumerations::Base
   value :admin,   name: 'Admin',  admin: true, active: true
   value :editor,  name: 'Editor', admin: true, active: false, description: 'Edits newspapers'
   value :author,  name: 'Author'
+  value :lecturer
 
   def my_custom_name
     ['user', name].join('_')

data/test/translation_test.rb

@@ -69,13 +69,13 @@ class TranslationTest < Minitest::Test
   def test_empty_custom_attribute_with_custom_locale
     role = Role.find(:admin)
 
-    assert_equal nil, role.description(locale: :hr)
+    assert_nil role.description(locale: :hr)
   end
 
   def test_empty_custom_attribute_with_custom_locale_and_defined_translation
     role = Role.find(:author)
 
-    assert_equal nil, role.description(locale: :hr)
+    assert_nil role.description(locale: :hr)
   end
 
   def test_find_by_localized_name
@@ -89,6 +89,6 @@ class TranslationTest < Minitest::Test
     status = Status.find_by(name: 'Nacrt')
     I18n.locale = :en
 
-    assert_equal nil, status
+    assert_nil status
   end
 end

data/test/value_test.rb

@@ -40,7 +40,7 @@ class ValueTest < Minitest::Test
   def test_without_defined_custom_attributes
     status = Status.find(:draft)
 
-    assert_equal nil, status.visible
+    assert_nil status.visible
   end
 
   def test_enumeration_to_i_return_ordinal

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerations
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Tomislav Car
@@ -88,16 +88,16 @@ dependencies:
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -125,12 +125,14 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - Gemfile
+- Migrate.md
 - Rakefile
 - Readme.md
 - enumerations.gemspec
 - lib/enumerations.rb
 - lib/enumerations/base.rb
 - lib/enumerations/configuration.rb
+- lib/enumerations/enumerations_error.rb
 - lib/enumerations/finder_methods.rb
 - lib/enumerations/reflection.rb
 - lib/enumerations/value.rb