rails_string_enum 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 43182f0552462fba5ee90d62eeceb8f684190e0f
-  data.tar.gz: cd4c5618c68b62407c8d0adc53ac96a689bbd0b1
+  metadata.gz: 5a89d7aa241c25ea1f29072f16f75d0fe4a36897
+  data.tar.gz: de151b0233565f9d35b2f6794660df13c681a25a
 SHA512:
-  metadata.gz: 0a092b9281df9dc19c2ddb62a69c5be38491a109036ff44348972be0415fd4153dc99a60d00d373d36c7138a7a5d77f54de7860c81d831e06ff07cddbfcf3ffe
-  data.tar.gz: 394a21ebf8889f446d64f26ae2f4a7e9e6ea37598f4c322cc4085e8ea98590c93d6aa1e99f038592a4a8acc04d964e52abecc0dd877a71b823f90489031f5086
+  metadata.gz: 9c85604c44e26365ecdf8742fbb68666529cd20c800864f98eeff60e7741e0425fa5747827a811c89747472ae724815df09f174284a864a9025512e8c911c0fe
+  data.tar.gz: 542eac4498a6ad9661d996831d295f4736843cbf8c840a0940769fdc1d39d0d9e7720707513be4133b43038f36867fa3713640896764ecc7f4f504e4f0d46c7b

data/README.md

@@ -1,5 +1,5 @@
 ## rails_string_enum
-support in rails db enums or string (using as flexible enum)
+support in rails native postgresql enums or string (using as flexible enum)
 
 This gem inspired rails native enum and  https://github.com/zmbacker/enum_help
 ## Installation
@@ -11,11 +11,7 @@ Add this line to your application's Gemfile:
 
 Tested on Rails 4.2, ruby 2.2
 
-#### Broken changes from 0.1 to 0.2
-`Product::COLOR::GREEN -> Product::GREEN`
 
-#### Broken changes from 0.2 to 0.3
-`added prefix for scopes: Product.red -> Product.only_red or Product.only_reds`
 
 #### Native postgresql enum (migrations)
 ```ruby
@@ -28,18 +24,20 @@ add_enum_value :color, 'black', after: 'red'
 add_enum_value :color, 'black', before: 'blue'
 add_enum_value :color, 'black', schema: 'public'
 
+# add_enum_value cannot run inside a transaction block, using outside change method
+
 drop_enum :color
 drop_enum :color, schema: 'cmyk'
 
 rename_enum_value :color, 'gray', 'black'
-reorder_enum_values :order_state_enum, %w(black white) # other color will be latest
+reorder_enum_values :color, %w(black white) # other color will be latest
 
 delete_enum_value :color, 'black'
 # you should delete record with deleting value
 # if exists index with condition, method raise exception
-# "ERROR: operator does not exist: order_type_enum <> order_type_enum_new"
+# "ERROR: operator does not exist: color <> color_new"
 # you should first remove and then create an index
-  Product.where(color: 'black').delete_all # or Product.where(color: 'black').update_all(state: nil)
+  Product.where(color: 'black').delete_all # or Product.where(color: 'black').update_all(color: nil)
   remove_index :product, :color, where: "color NOT IN ('pink')"
   delete_enum_value :color, 'black'
   add_index :product, :color, where: "color NOT IN ('pink')"
@@ -61,9 +59,9 @@ class CreateTables < ActiveRecord::Migration
     create_table :products do |t|
       t.string :color
     end
-    
+
     create_enum :enum_color, %w(red green blue)
-    
+
     create_table :pages do |t|
       t.column :color, :enum_color, default: 'red'
     end
@@ -72,7 +70,7 @@ end
 
 class Product < ActiveRecord::Base
   string_enum :color, %w(red green yellow black white), scopes: true # default false
-  
+
   def self.colored
     where.not(color: [BLACK, WHITE])
   end
@@ -101,6 +99,15 @@ Product.only_red # if scopes: true
 Product.only_reds # if scopes: { pluralize: true }
 ```
 
+Using constants to any `Class` or `Module`
+```ruby
+module ValidateStatesFromApi
+
+  extend MixinStringEnum
+  string_enum :states, %w(accept obtain canceled lost)
+
+end
+```
 
 I18n local file example (compatible with https://github.com/zmbacker/enum_help):
 
@@ -141,4 +148,3 @@ Calculating -------------------------------------
  rails_string_enum_c     38.159k (± 5.3%) i/s -    192.128k
          enum_help_c     15.939k (± 4.5%) i/s -     80.272k
 ```
-

data/lib/rails_string_enum.rb

@@ -1,20 +1,24 @@
 require 'rails_string_enum/version'
+require 'rails_string_enum/mixin_string_enum'
 
 
-require 'rails_string_enum/pg_enum_migration'
-require 'active_record/connection_adapters/postgresql_adapter'
-ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send :include, PgEnumMigrations
-
+if defined? ActiveRecord::Base
+  require 'rails_string_enum/active_record_string_enum'
+  ActiveRecord::Base.send :extend, ActiveRecordStringEnum
+end
 
-require 'rails_string_enum/string_enum'
-ActiveRecord::Base.send :extend, RailsStringEnum
 
+require 'active_record/connection_adapters/postgresql_adapter'
+if defined? ActiveRecord::ConnectionAdapters::PostgreSQL
+  require 'rails_string_enum/pg_enum_migration'
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.send :include, PgEnumMigrations
 
-require 'rails_string_enum/patch_enum_null' if Rails.version <= "4.2.1"
+  require 'rails_string_enum/patch_enum_null' if Rails.version <= "4.2.1"
+end
 
 
 begin
   require 'simple_form'
   require 'rails_string_enum/simple_form'
 rescue LoadError
-end
+end

data/lib/rails_string_enum/{string_enum.rb → active_record_string_enum.rb}

@@ -1,4 +1,4 @@
-module RailsStringEnum
+module ActiveRecordStringEnum
 
   # product.rb
   # string_enum :color, %w(red green yellow)
@@ -142,4 +142,4 @@ module RailsStringEnum
     const_set name_s, name_s.split('__').map { |i| const_get(i) }
   end
 
-end
+end

data/lib/rails_string_enum/mixin_string_enum.rb

@@ -0,0 +1,27 @@
+module MixinStringEnum
+
+  # this is a simplified version ActiveRecordStringEnum, for any Class or Module, support only constants
+
+  def string_enum(name, enums)
+
+    const_name_all_values = name.to_s.pluralize.upcase
+    const_set const_name_all_values, enums.map(&:to_s)
+
+    klass = self
+    enums.each do |value|
+      const_set value.to_s.upcase, value.to_s
+    end
+
+  end
+
+
+  private
+
+  def const_missing(name)
+    name_s = name.to_s
+    return super unless name_s.include?('__')
+
+    const_set name_s, name_s.split('__').map { |i| const_get(i) }
+  end
+
+end

data/lib/rails_string_enum/pg_enum_migration.rb

@@ -2,7 +2,7 @@ module PgEnumMigrations
 
   # create_enum :color, %w(red green blue) # default schema is 'public'
   # create_enum :color, %w(red green blue), schema: 'cmyk'
-  def create_enum(enum_name, values, schema: nil)
+  def create_enum(enum_name, values, schema: 'public')
     execute "CREATE TYPE #{enum_name(enum_name, schema)} AS ENUM (#{escape_enum_values(values)})"
   end
 
@@ -11,12 +11,13 @@ module PgEnumMigrations
   # add_enum_value :color, 'purple', after: 'red'
   # add_enum_value :color, 'pink', before: 'purple'
   # add_enum_value :color, 'white', schema: 'public'
-  def add_enum_value(enum_name, value, before: nil, after: nil, schema: nil)
+  # **WARN** cannot run inside a transaction block
+  def add_enum_value(enum_name, value, before: nil, after: nil, schema: 'public')
     opts = if    before then "BEFORE #{escape_enum_value(before)}"
            elsif after  then "AFTER #{escape_enum_value(after)}"
            else  ''
            end
-    execute "ALTER TYPE #{enum_name(enum_name, schema)} ADD VALUE #{escape_enum_value(value)} #{opts}"
+    execute "ALTER TYPE #{enum_name(enum_name, schema)} ADD VALUE IF NOT EXISTS #{escape_enum_value(value)} #{opts}"
   end
 
   # drop_enum :color
@@ -27,15 +28,15 @@ module PgEnumMigrations
 
 
   # you should delete record with deleting value
-  # Order.back_picking.delete_all or Order.back_picking.update_all(state: nil)
+  # Product.only_purple.delete_all or Product.purple.update_all(color: nil)
   #
-  # if exists index with condition - add_index :orders, :state, where: "state NOT IN ('closed', 'canceled', 'returned')"
-  # this method show exeption ERROR: operator does not exist: order_type_enum <> order_type_enum_new
+  # if exists index with condition - add_index :products, :color, where: "color NOT IN ('white', 'black')"
+  # this method show exeption ERROR: operator does not exist: color <> color_new
   # you must first remove and then create an index
   #
-  # delete_enum_value :order_state_enum, 'back_picking'
-  def delete_enum_value(enum_name, value_name, scheme: nil)
-    old_values = select_values("SELECT enumlabel FROM pg_catalog.pg_enum WHERE enumtypid = #{enum_name_as_srt(enum_name, scheme)}::regtype::oid")
+  # delete_enum_value :color, 'black'
+  def delete_enum_value(enum_name, value_name, scheme: 'public')
+    old_values = select_values("SELECT enumlabel FROM pg_catalog.pg_enum WHERE enumtypid = '#{scheme}.#{enum_name}'::regtype::oid")
     new_values = old_values - Array(value_name)
 
     execute <<-SQL
@@ -43,8 +44,11 @@ module PgEnumMigrations
       CREATE TYPE #{enum_name} AS enum (#{escape_enum_values(new_values)});
     SQL
 
-    cols_using_enum = select_rows("SELECT table_name, column_name FROM information_schema.columns WHERE udt_name = '#{enum_name}_old'")
-    cols_using_enum.each do |table_name, column_name|
+    cols_using_enum = select_rows("SELECT table_name, column_name, column_default FROM information_schema.columns WHERE udt_name = '#{enum_name}_old'")
+    cols_using_enum.each do |table_name, column_name, column_default|
+      unless column_default.nil?
+        raise "column #{table_name}.#{column_name} has default value #{column_default}, you must manually drop default"
+      end
       execute <<-SQL
         ALTER TABLE #{table_name}
         ALTER COLUMN #{column_name} TYPE #{enum_name} USING #{column_name}::text::#{enum_name};
@@ -58,7 +62,7 @@ module PgEnumMigrations
 
 
 
-  # rename_enum_value :order_state_enum, 'accept', 'init'
+  # rename_enum_value :color, 'white', 'pale'
   def rename_enum_value(enum_name, old_value_name, new_value_name, scheme: 'public')
     execute <<-SQL
       UPDATE pg_catalog.pg_enum
@@ -69,8 +73,8 @@ module PgEnumMigrations
 
 
 
-  # reorder_enum_values :order_state_enum, %w(lost returning obtain accept)
-  def reorder_enum_values(enum_name, ordered_values, scheme: nil)
+  # reorder_enum_values :color, %w(green pale red blue)
+  def reorder_enum_values(enum_name, ordered_values, scheme: 'public')
     all_values = select_values("SELECT enumlabel FROM pg_catalog.pg_enum WHERE enumtypid = '#{scheme}.#{enum_name}'::regtype::oid")
     max_order =  select_value("SELECT max(enumsortorder) FROM pg_catalog.pg_enum WHERE enumtypid = '#{scheme}.#{enum_name}'::regtype::oid").to_i + 1
 
@@ -79,7 +83,7 @@ module PgEnumMigrations
     execute <<-SQL
       UPDATE pg_catalog.pg_enum
       SET enumsortorder = CASE enumlabel #{ordered_sql} END
-      WHERE enumtypid = #{enum_name_as_srt(enum_name, scheme)}::regtype::oid
+      WHERE enumtypid = '#{scheme}.#{enum_name}'::regtype::oid
     SQL
   end
 
@@ -110,12 +114,6 @@ module PgEnumMigrations
     }.join('.')
   end
 
-  def enum_name_as_srt(name, schema)
-    [schema || 'public', name].map { |s|
-      %Q{'#{s}'}
-    }.join('.')
-  end
-
   def escape_enum_value(value)
     escaped_value = value.to_s.sub("'", "''")
     "'#{escaped_value}'"
@@ -140,4 +138,4 @@ module PgEnumMigrations
     SQL
   end
 
-end
+end

data/lib/rails_string_enum/version.rb

@@ -1,3 +1,3 @@
 module RailsStringEnum
-  VERSION = "0.4.1"
-end
+  VERSION = "0.5.0"
+end

data/rails_string_enum.gemspec

@@ -20,9 +20,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
-
-  spec.add_dependency "activerecord", "~> 4.2"
 
   spec.required_ruby_version = '~> 2.0'
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_string_enum
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - ermolaev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2016-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,34 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.9'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.2'
 description: migration methods for postgresql enum, internationalization, simple_form
 email:
 - andrey@ermolaev.me
@@ -65,10 +37,11 @@ files:
 - README.md
 - Rakefile
 - lib/rails_string_enum.rb
+- lib/rails_string_enum/active_record_string_enum.rb
+- lib/rails_string_enum/mixin_string_enum.rb
 - lib/rails_string_enum/patch_enum_null.rb
 - lib/rails_string_enum/pg_enum_migration.rb
 - lib/rails_string_enum/simple_form.rb
-- lib/rails_string_enum/string_enum.rb
 - lib/rails_string_enum/version.rb
 - rails_string_enum.gemspec
 homepage: https://github.com/ermolaev/rails_string_enum
@@ -91,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: support in rails db enums or string (using as flexible enum)