symbolize 3.0.3 → 3.1.0

data/README.rdoc

@@ -60,10 +60,21 @@ validates_inclusion_of to restrict the possible values (just like an enum).
         :linux   => "Linux",
         :mac     => "Mac OS X"
       }, :scopes => true
+
+      # Allow blank
       symbolize :gui,  :in => [:gnome, :kde, :xfce], :allow_blank => true
+
+      # Don`t i18n
       symbolize :browser, :in => [:firefox, :opera], :i18n => false, :methods => true
+
+      # Scopes
       symbolize :angry, :in => [true, false], :scopes => true
+
+      # Don`t validate
       symbolize :lang, :in => [:ruby, :c, :erlang], :validate => false
+
+      # Default
+      symbolize :kind, :in => [:admin, :manager, :user], :default => :admin
   end
 
 
@@ -78,7 +89,7 @@ allow_(blank|nil): What you expect.
 
 === validate
 
-Set to false to avoid the validation of the input. 
+Set to false to avoid the validation of the input.
 Useful for a dropdown with an "other" option textfield.
 
 
@@ -142,6 +153,13 @@ For boolean colums you can use
     ( or with_[attribute] and without_[attribute] )
 
 
+=== default (BETA)
+
+As the name suggest, the symbol you choose as default will be set in new objects automatically.
+
+     User.new.kind # Will print :admin
+
+
 == Examples
 
   u = User.find_by_name('Anna')   # => #<User Anna>

data/VERSION

@@ -1 +1 @@
-3.0.3
+3.1.0

data/lib/symbolize.rb

@@ -52,10 +52,11 @@ module Symbolize
       configuration.update(attr_names.extract_options!)
 
       enum = configuration[:in] || configuration[:within]
-      i18n = configuration[:i18n].nil? && !enum.instance_of?(Hash) && enum ? true : configuration[:i18n]
-      methods = configuration[:methods]
-      scopes = configuration[:scopes]
-      validation = configuration[:validation] != false
+      i18n = configuration.delete(:i18n).nil? && !enum.instance_of?(Hash) && enum ? true : configuration[:i18n]
+      scopes  = configuration.delete :scopes
+      methods = configuration.delete :methods
+      validation     = configuration.delete(:validation) != false
+      default_option = configuration.delete :default
 
       unless enum.nil?
         # Little monkeypatching, <1.8 Hashes aren't ordered.
@@ -90,38 +91,44 @@ module Symbolize
             end
           end
 
-
           if scopes
             scope_comm = lambda { |*args| ActiveRecord::VERSION::MAJOR >= 3 ? scope(*args) : named_scope(*args)}
             values.each do |value|
-                if value[0].respond_to?(:to_sym)
-                  scope_comm.call( value[0].to_sym, :conditions => { attr_name => value[0].to_sym })
-                else
-                  if value[0] == true || value[0] == false
-                    scope_comm.call( "with_#{attr_name}", :conditions => { attr_name => true })
-                    scope_comm.call( "without_#{attr_name}", :conditions => { attr_name => false })
-
-                    scope_comm.call( attr_name.to_sym, :conditions => { attr_name => true })
-                    scope_comm.call( "not_#{attr_name}", :conditions => { attr_name => false })
-                  end
+              if value[0].respond_to?(:to_sym)
+                scope_comm.call value[0].to_sym, :conditions => { attr_name => value[0].to_sym }
+              else
+                if value[0] == true || value[0] == false
+                  scope_comm.call "with_#{attr_name}",    :conditions => { attr_name => true }
+                  scope_comm.call "without_#{attr_name}", :conditions => { attr_name => false }
+
+                  scope_comm.call attr_name.to_sym,   :conditions => { attr_name => true }
+                  scope_comm.call "not_#{attr_name}", :conditions => { attr_name => false }
                 end
+              end
             end
           end
         end
 
         if validation
-          class_eval "validates_inclusion_of :#{attr_names.join(', :')}, configuration"
+          class_eval "validates_inclusion_of :#{attr_names.join(', :')}, #{configuration}"
         end
       end
 
       attr_names.each do |attr_name|
-        attr_name = attr_name.to_s
-        class_eval("def #{attr_name}; read_and_symbolize_attribute('#{attr_name}'); end")
-        class_eval("def #{attr_name}= (value); write_symbolized_attribute('#{attr_name}', value); end")
+
+        if default_option
+          class_eval("def #{attr_name}; read_and_symbolize_attribute('#{attr_name}') || :#{default_option}; end")
+          class_eval("def #{attr_name}= (value); write_symbolized_attribute('#{attr_name}', (value && !value.empty? ? value : #{default_option})); end")
+          class_eval("def set_default_for_attr_#{attr_name}; self[:#{attr_name}] ||= :#{default_option}; end")
+          class_eval("before_save :set_default_for_attr_#{attr_name}")
+        else
+          class_eval("def #{attr_name}; read_and_symbolize_attribute('#{attr_name}'); end")
+          class_eval("def #{attr_name}= (value); write_symbolized_attribute('#{attr_name}', value); end")
+        end
         if i18n
           class_eval("def #{attr_name}_text; read_i18n_attribute('#{attr_name}'); end")
         elsif enum
-          class_eval("def #{attr_name}_text; #{attr_name.upcase}_VALUES[#{attr_name}]; end")
+          class_eval("def #{attr_name}_text; #{attr_name.to_s.upcase}_VALUES[#{attr_name}]; end")
         else
           class_eval("def #{attr_name}_text; #{attr_name}.to_s; end")
         end
@@ -133,14 +140,14 @@ module Symbolize
   def symbolize_attribute attr
     case attr
       when String then attr.empty? ? nil : attr.to_sym
-      when Symbol, TrueClass, FalseClass then attr
+      when Symbol, TrueClass, FalseClass, Numeric then attr
       else nil
     end
   end
 
   # Return an attribute's value as a symbol or nil
   def read_and_symbolize_attribute attr_name
-    symbolize_attribute read_attribute(attr_name)
+    symbolize_attribute self[attr_name]
   end
 
   # Return an attribute's i18n
@@ -152,7 +159,7 @@ module Symbolize
   def write_symbolized_attribute attr_name, value
     val = { "true" => true, "false" => false }[value]
     val = symbolize_attribute(value) if val.nil?
-    write_attribute(attr_name, val)
+    self[attr_name] = val
   end
 end
 

data/lib/symbolize/railtie.rb

@@ -0,0 +1,14 @@
+# Rails 3 initialization
+module Symbolize
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      initializer 'symbolize.insert_into_active_record' do
+        ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.extend(Symbolize::ClassMethods)
+        end
+      end
+    end
+  end
+end
+

data/rails/init.rb

@@ -1,2 +1,2 @@
-require File.join(File.dirname(__FILE__), '..', "lib", "symbolize_helper")
+require File.join(File.dirname(__FILE__), '..', "lib", "symbolize", "symbolize_helper")
 ActiveRecord::Base.send(:include, Symbolize)

data/spec/db/create_testing_structure.rb

@@ -1,7 +1,7 @@
 class CreateTestingStructure < ActiveRecord::Migration
   def self.up
     create_table :users do |t|
-      t.string :name, :so, :gui, :other, :status, :language
+      t.string :name, :so, :gui, :other, :status, :language, :kind
       t.string :limited, :limit => 10
       t.string :karma, :limit => 5
       t.boolean :sex
@@ -9,8 +9,18 @@ class CreateTestingStructure < ActiveRecord::Migration
       t.boolean :cool
     end
     create_table :user_skills do |t|
+      t.references :user
       t.string :kind
     end
+    create_table :user_extras do |t|
+      t.references :user
+      t.string :key, :null => false
+    end
+    create_table :permissions do |t|
+      t.string  :name, :null => false
+      t.string  :kind, :null => false
+      t.integer :lvl,  :null => false
+    end
   end
 
   def self.down

data/spec/symbolize_spec.rb

@@ -16,12 +16,25 @@ class User < ActiveRecord::Base
   symbolize :gui, :allow_blank => true, :in => [:cocoa, :qt, :gtk], :i18n => false
   symbolize :karma, :in => [:good, :bad, :ugly], :methods => true, :i18n => false, :allow_nil => true
   symbolize :cool, :in => [true, false], :scopes => true
+
+  has_many :extras, :dependent => :destroy, :class_name => "UserExtra"
+  has_many :access, :dependent => :destroy, :class_name => "UserAccess"
 end
 
 class UserSkill < ActiveRecord::Base
   symbolize :kind, :in => [:agility, :magic]
 end
 
+class UserExtra < ActiveRecord::Base
+  symbolize :key, :in => [:one, :another]
+end
+
+class Permission < ActiveRecord::Base
+  validates_presence_of :name
+  symbolize :kind, :in => [:temp, :perm], :default => :perm
+  symbolize :lvl, :in => (1..9).to_a, :i18n => false#, :default => 1
+end
+
 # Make with_scope public-usable for testing
 #if ActiveRecord::VERSION::MAJOR < 3
 class << ActiveRecord::Base
@@ -40,7 +53,7 @@ describe "Symbolize" do
     ActiveRecord::Base.should respond_to :symbolize
   end
 
-  describe "Instantiated" do
+  describe "User Instantiated" do
     before(:each) do
       @user = User.first
     end
@@ -59,11 +72,11 @@ describe "Symbolize" do
       # @user.read_attribute(:status).should eql('active')
     end
 
-    it "should acts nice with numbers" do
+    it "should work nice with numbers" do
       @user.status = 43
-      @user.status.should be_nil
-      @user.status_before_type_cast.should be_nil
-      @user.read_attribute(:status).should be_nil
+      @user.status.should_not be_nil
+      # @user.status_before_type_cast.should be_nil
+      # @user.read_attribute(:status).should be_nil
     end
 
     it "should acts nice with nil" do
@@ -148,76 +161,22 @@ describe "Symbolize" do
       #   assert_equal "'weird''; chars'", @user.status.quoted_id
     end
 
-    describe "ActiveRecord stuff" do
-
-      #
-      #  ActiveRecord < 3
-      #
-      if ActiveRecord::VERSION::MAJOR < 3
-
-        it "test_symbolized_finder" do
-          User.find(:all, :conditions => { :status => :inactive }).map(&:name).should eql(['Bob'])
-          User.find_all_by_status(:inactive).map(&:name).should eql(['Bob'])
-        end
-
-        it "test_symbolized_with_scope" do
-          User.with_scope(:find => { :conditions => { :status => :inactive }}) do
-            User.find(:all).map(&:name).should eql(['Bob'])
-          end
-        end
-
-      #
-      #  ActiveRecord >= 3
-      #
-      else
-
-        it "test_symbolized_finder" do
-          User.where({ :status => :inactive }).all.map(&:name).should eql(['Bob'])
-          User.find_all_by_status(:inactive).map(&:name).should eql(['Bob'])
-        end
-
-        it "test_symbolized_with_scope" do
-          User.with_scope(:find => { :conditions => { :status => :inactive }}) do
-            User.find(:all).map(&:name).should eql(['Bob'])
-          end
-        end
-
-        describe "Named Scopes" do
-
-          before do
-            @anna = User.find_by_name!('Anna')
-            @bob = User.find_by_name!('Bob')
-          end
-
-          it "should have main named scope" do
-            User.inactive.should == [@bob]
-          end
-
-          it "should have other to test better" do
-            User.linux.should == [@anna]
-          end
-
-          it "should have 'with' helper" do
-            User.with_sex.should == [@anna]
-          end
-
-          it "should have 'without' helper" do
-            User.without_sex.should == [@bob]
-          end
-
-          it "should have 'attr_name' helper" do
-            User.cool.should == [@anna]
-          end
+    it "should work fine through relations" do
+      @user.extras.create(:key => :one)
+      UserExtra.first.key.should eql(:one)
+    end
 
-          it "should have 'not_attr_name' helper" do
-            User.not_cool.should == [@bob]
-          end
+    it "should play fine with null db columns" do
+      new_extra = @user.extras.build
+      new_extra.should_not be_valid
+    end
 
-        end
+    it "should play fine with null db columns" do
+      new_extra = @user.extras.build
+      new_extra.should_not be_valid
+    end
 
-      end
 
-    end
 
     describe "View helpers" do
       include ActionView::Helpers::FormHelper
@@ -310,4 +269,113 @@ describe "Symbolize" do
 
   end
 
+  describe "more tests on Permission" do
+
+    it "should use default value on object build" do
+      Permission.new.kind.should eql(:perm)
+    end
+
+    it "should not interfer on create" do
+      Permission.create!(:name => "p7", :kind =>:temp, :lvl => 7)
+      Permission.find_by_name("p7").kind.should eql(:temp)
+    end
+
+    it "should work on create" do
+      pm = Permission.new(:name => "p7", :lvl => 7)
+      pm.should be_valid
+      pm.save.should be_true
+    end
+
+    it "should work on create" do
+      Permission.create!(:name => "p8", :lvl => 9)
+      Permission.find_by_name("p8").kind.should eql(:perm)
+    end
+
+    it "should work on edit" do
+      pm = Permission.find_by_name("p8")
+      pm.kind = :temp
+      pm.save
+      Permission.find_by_name("p8").kind.should eql(:temp)
+    end
+
+    it "should work with default values" do
+      pm = Permission.new(:name => "p9")
+      pm.lvl = 9
+      pm.save
+      Permission.find_by_name("p9").lvl.to_i.should eql(9)
+    end
+
+  end
+
+  describe "ActiveRecord stuff" do
+
+    #
+    #  ActiveRecord <= 2
+    #
+    if ActiveRecord::VERSION::MAJOR < 3
+
+      it "test_symbolized_finder" do
+        User.find(:all, :conditions => { :status => :inactive }).map(&:name).should eql(['Bob'])
+        User.find_all_by_status(:inactive).map(&:name).should eql(['Bob'])
+      end
+
+      it "test_symbolized_with_scope" do
+        User.with_scope(:find => { :conditions => { :status => :inactive }}) do
+          User.find(:all).map(&:name).should eql(['Bob'])
+        end
+      end
+
+      #
+      #  ActiveRecord >= 3
+      #
+    else
+
+      it "test_symbolized_finder" do
+        User.where({ :status => :inactive }).all.map(&:name).should eql(['Bob'])
+        User.find_all_by_status(:inactive).map(&:name).should eql(['Bob'])
+      end
+
+      it "test_symbolized_with_scope" do
+        User.with_scope(:find => { :conditions => { :status => :inactive }}) do
+          User.find(:all).map(&:name).should eql(['Bob'])
+        end
+      end
+
+      describe "Named Scopes" do
+
+        before do
+          @anna = User.find_by_name!('Anna')
+          @bob = User.find_by_name!('Bob')
+        end
+
+        it "should have main named scope" do
+          User.inactive.should == [@bob]
+        end
+
+        it "should have other to test better" do
+          User.linux.should == [@anna]
+        end
+
+        it "should have 'with' helper" do
+          User.with_sex.should == [@anna]
+        end
+
+        it "should have 'without' helper" do
+          User.without_sex.should == [@bob]
+        end
+
+        it "should have 'attr_name' helper" do
+          User.cool.should == [@anna]
+        end
+
+        it "should have 'not_attr_name' helper" do
+          User.not_cool.should == [@bob]
+        end
+
+      end
+
+    end
+
+  end
+
 end

data/symbolize.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{symbolize}
-  s.version = "3.0.3"
+  s.version = "3.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marcos Piccinini"]
-  s.date = %q{2011-03-18}
+  s.date = %q{2011-03-23}
   s.description = %q{ActiveRecord enums with i18n}
   s.email = %q{x@nofxx.com}
   s.extra_rdoc_files = [
@@ -23,7 +23,8 @@ Gem::Specification.new do |s|
     "VERSION",
     "init.rb",
     "lib/symbolize.rb",
-    "lib/symbolize_helper.rb",
+    "lib/symbolize/railtie.rb",
+    "lib/symbolize/symbolize_helper.rb",
     "rails/init.rb",
     "spec/db/create_testing_structure.rb",
     "spec/locales/en.yml",

metadata

@@ -2,7 +2,7 @@
 name: symbolize
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors: 
 - Marcos Piccinini
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-18 00:00:00 -03:00
+date: 2011-03-23 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,7 +51,8 @@ files:
 - VERSION
 - init.rb
 - lib/symbolize.rb
-- lib/symbolize_helper.rb
+- lib/symbolize/railtie.rb
+- lib/symbolize/symbolize_helper.rb
 - rails/init.rb
 - spec/db/create_testing_structure.rb
 - spec/locales/en.yml