attribute_enums 0.1.8 → 0.2.0

data/.gitignore

@@ -2,8 +2,6 @@
 .bundle
 Gemfile.lock
 pkg/*
+.rvmrc
 
 
-spec/rails3_0_app/db/*.sqlite3
-spec/rails3_0_app/log/*
-spec/rails3_0_app/tmp/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG

@@ -1,3 +1,7 @@
+== 0.2.0
+
+* refactoring options
+
 == 0.1.8
 
 * fix 'DEPRECATION WARNING: The InstanceMethods module inside ActiveSupport::Concern will be no longer included automatically.'

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "http://ruby.taobao.org"
 
 # Specify your gem's dependencies in attribute_enums.gemspec
 gemspec

data/README.markdown

@@ -1,14 +1,14 @@
 #AttributeEnums
 
-AttributeEnums is a model attribute enums plugin for Rails3. like 'symbolize' gem.
+AttributeEnums is a model attribute enums plugin for Rails3.
 
 * https://github.com/vkill/attribute_enums
 
 ##Supported versions
 
-* Ruby 1.8.7, 1.9.2, 1.9.3
+* Ruby 1.9
 
-* Rails 3.0.x, 3.1
+* Rails 3
 
 
 ##Installation
@@ -17,9 +17,11 @@ In your app's `Gemfile`, add:
 
     gem "attribute_enums"
 
-Then run:
+or
 
-    > bundle
+    gem "attribute_enums", require: "attribute_enums/active_record"
+    #app/models/xxx.rb
+    include ::AttributeEnums::ActiveRecord
 
 
 ##Usage Example
@@ -41,94 +43,94 @@ Then run:
 
     #app/models/user.rb
     class User < ActiveRecord::Basse
-      attribute_enums :gender, :in => [:female, :male]
-      attribute_enums :enable, :booleans => true
+      attribute_enums :gender, in: [:female, :male], default: :male, scopeds: true, ask_methods: true, i18n: true, validate: true
+      attribute_enums :enable, boolean: true, default: true, scopeds: :disable, i18n: {t_prefix: :person_}
     end
 
+    # in config/locales/enums_en.yml
+    en:
+      enums:
+        gender:
+          female: Girl
+          male: Boy
+        enable:
+          "true": "Enable"
+          "false": "Disable"
+        person_gender:
+          female: Girl
+          male: Boy
+        person_enable:
+          "true": "Enable"
+          "false": "Disable"
 
 ##Options
 
-###booleans
+###in or boolean
 
-default `false`
+if use 'boolean', auto ignore 'in'.
 
-if use this, please don't use `in/within`.
+this option generate get_attr_values and attr_text methods
 
-###in/within
-
-default `[]`
+    #active_record
+    User.get_gender_values
+    User.get_enable_values
+    user = User.new(gender: :male, enable: true)
+    user.gender_text
+    user.enable_text
 
-if use this, please don't use `booleans`.
+you can use get_attr_values on rails `select` helper and more.
 
 ###i18n and use example
 
-default `true`
+default `false`
 
-    # in config/locales/enums_en.yml
-    en:
-      activerecord:
-        models:
-          user: User
-        attributes:
-          user:
-            gender: Gender
-            enable: Enable
-        enums:
-          user:
-            gender:
-              female: Girl
-              male: Boy
-            enable:
-              "true": "Yes"
-              "false": "No"
+set `true`, i18n is valid get_attr_values and attr_text methods.
+
+    #active_record
+    User.get_gender_values  #=> [["Girl", "female"], ["Boy", "male"]]
+    User.get_enable_values  #=> [["Enable", true], ["Disable", false]]
+    user = User.new(gender: :male, enable: true)
+    user.gender_text        #=> "Boy"
+    user.enable_text        #=> "Enable"
 
 ###scopes and use example
 
-default `true`
+default `false`
 
     #active_record
-    User.male         => User.where(:gender => :male)
-    User.female       => User.where(:gender => :female)
-    User.enable       => User.where(:enable => true)
-    User.not_enable   => User.where(:enable => false)
+    User.male         #=> User.where(gender: :male)
+    User.female       #=> User.where(gender: :female)
+    User.enable       #=> User.where(enable: true)
+    User.disable      #=> User.where(enable: false)
 
 ###validate
 
-default `true`
+default `false`, it only support `in` option.
 
-###allow_blank
+if you want support attribute value is nil, you can use `validate: {allow_nil: true}`
 
-default `false`, is valid with validate == true and in/within == true
+###ask_methods and use example
 
-###methods and use example
-
-default `true`
+default `false`, it only support `in` option.
 
     #active_record
-    User.get_gender_values  =>  [["female", "Girl"], ["male", "Boy"]]
-    User.gender_values      =>  {"female"=>"Girl", "male"=>"Boy"}
-    User.get_enable_values  =>  [[true, "Yes"], [false, "No"]]
-    User.enable_values      =>  {true=>"Yes", false=>"No"}
-    user = User.create(:gender => :male, :enable => true)
-    user.gender_text  =>  "Boy"
-    user.enable_text  =>  "Yes"
-    user.male?    =>  true
-    user.female?  =>  false
-    user.enable   =>  true
+    user = User.new(gender: :male, enable: true)
+    user.male?    #=> true
+    user.female?  #=> false
 
 ###default
 
 if your defined `default`, it set attribute `default` value before validate.
 
-Note: if your migration defined field default, this is invalidation.
-
-
-##Run test for development
+    #active_record
+    user = User.new
+    user.valid?
+    user.gender #=> :male
 
-    > guard
+Note: if your migration defined field default, this is invalidation.
 
 
 ##Copyright
 
-Copyright (c) 2011 vkill.net .
+Copyright (c) 2011-2013 vkill.net .
 

data/attribute_enums.gemspec

@@ -18,20 +18,9 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "guard-rspec"
-
-  s.add_development_dependency "rails", "~> 3.0"
-  s.add_development_dependency "sqlite3-ruby"
-  s.add_development_dependency "rspec-rails", "~> 2.7.0"
-  s.add_development_dependency "capybara"
-  s.add_development_dependency "timecop"
-  s.add_development_dependency "pry"
-  s.add_development_dependency "pry-padrino"
-
-  s.add_dependency "activerecord", "~> 3.0"
-  s.add_dependency "activesupport", "~> 3.0"
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency "i18n"
+  s.add_development_dependency "rspec-rails", '~> 2.13.0'
+  
 end
-

data/lib/attribute_enums.rb

@@ -1,7 +1,3 @@
-require "active_support/concern"
-require "active_support/core_ext/object"
-require "active_support/core_ext/class/attribute_accessors"
-
 require "attribute_enums/version"
 
 if defined?(::Rails)

data/lib/attribute_enums/active_record.rb

@@ -0,0 +1,122 @@
+module AttributeEnums
+end
+
+require "attribute_enums/version"
+require "attribute_enums/common"
+
+module AttributeEnums
+  module ActiveRecord
+    
+    def self.included base
+      base.extend(ClassMethods)
+      base.extend(AttributeEnums::Common)
+    end
+
+    module ClassMethods
+      
+      private
+
+      def _ae_set_default
+        set_defaule_method_name = "set_defaule_#{@_ae_attribute_name}"
+        if @_ae_boolean
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{set_defaule_method_name}
+              write_attribute(:#{@_ae_attribute_name}, #{@_ae_default}) if read_attribute(:#{@_ae_attribute_name}).nil?
+            end
+          RUBY
+        else
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{set_defaule_method_name}
+              write_attribute(:#{@_ae_attribute_name}, :#{@_ae_default}) if read_attribute(:#{@_ae_attribute_name}).nil?
+            end
+          RUBY
+        end
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          before_validation :#{set_defaule_method_name}
+        RUBY
+      end
+
+      def _ae_set_string_ask_methods
+        @_ae_in.each do |_in|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{_ae_ask_methods_string_attribute_method_name(_in)}
+              read_attribute(:#{@_ae_attribute_name}).to_s == '#{_in}'
+            end
+          RUBY
+        end
+      end
+
+      def _ae_set_string_scopeds
+        @_ae_in.each do |_in|
+          # scope _ae_scopeds_string_attribute_method_name(_in), ->{ where(@_ae_attribute_name => _in) }
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            scope :#{_ae_scopeds_string_attribute_method_name(_in)}, ->{ where(:#{@_ae_attribute_name} => :#{_in}) }
+          RUBY
+        end
+      end
+      
+      def _ae_set_boolean_scopeds
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          scope :#{@_ae_attribute_name}, ->{ where(:#{@_ae_attribute_name} => true) }
+        RUBY
+        if @_ae_scopeds.is_a?(Symbol)
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            scope :#{@_ae_scopeds}, ->{ where(:#{@_ae_attribute_name} => false) }
+          RUBY
+          puts "scope :#{@_ae_scopeds}, ->{ where(:#{@_ae_attribute_name} => false) }"
+        end
+      end
+
+      def _attribute_name_set_string_validate
+        unless @_ae_validate.is_a?(Hash) and !@_ae_validate[:allow_nil].nil?
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            validates :#{@_ae_attribute_name}, presence: true
+          RUBY
+        end
+
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          validates :#{@_ae_attribute_name}, inclusion: {in: #{@_ae_inclusion}}, unless: :"read_attribute(:#{@_ae_attribute_name}).nil?"
+        RUBY
+      end
+
+      def _attribute_name_set_boolean_text_method
+        if @_ae_i18n and defined?(::I18n)
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{_ae_text_method_name}
+              return '' if read_attribute(:#{@_ae_attribute_name}).nil?
+              I18n.translate('enums.%s%s.%s' % [self.class.send(:_ae_i18n_t_prefix), :#{@_ae_attribute_name}, read_attribute(:#{@_ae_attribute_name})])
+            end
+          RUBY
+        else
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{_ae_text_method_name}
+              return '' if read_attribute(:#{@_ae_attribute_name}).nil?
+              read_attribute(:#{@_ae_attribute_name}) ? 'Yes' : 'No'
+            end
+          RUBY
+        end
+      end
+
+      def _attribute_name_set_string_text_method
+        if @_ae_i18n and defined?(::I18n)
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{_ae_text_method_name}
+              return '' if read_attribute(:#{@_ae_attribute_name}).nil?
+              I18n.translate('enums.%s%s.%s' % [self.class.send(:_ae_i18n_t_prefix), :#{@_ae_attribute_name}, read_attribute(:#{@_ae_attribute_name})])
+            end
+          RUBY
+        else
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{_ae_text_method_name}
+              return '' if read_attribute(:#{@_ae_attribute_name}).nil?
+              read_attribute(:#{@_ae_attribute_name}).to_s
+            end
+          RUBY
+        end
+      end
+
+    end
+  end
+
+end
+

data/lib/attribute_enums/common.rb

@@ -0,0 +1,168 @@
+module AttributeEnums
+  module Common
+
+    def attribute_enums(attribute_name, options={})
+      _ae_init_instance_variables
+
+      @_ae_attribute_name = attribute_name.to_s
+
+      @_ae_in = options.has_key?(:in) ? Array(options.delete(:in)) : []
+      @_ae_boolean = options.has_key?(:boolean) ? options.delete(:boolean) : false
+      @_ae_default = options.has_key?(:default) ? options.delete(:default) : nil
+      @_ae_ask_methods = options.has_key?(:ask_methods) ? options.delete(:ask_methods) : false
+      @_ae_scopeds = options.has_key?(:scopeds) ? options.delete(:scopeds) : false
+      @_ae_validate = options.has_key?(:validate) ? options.delete(:validate) : false
+      @_ae_i18n = options.has_key?(:i18n) ? options.delete(:i18n) : false
+
+
+      # build _in
+      if @_ae_boolean
+        @_ae_in = [true, false]
+        @_ae_inclusion = @_ae_in
+      else
+        return if @_ae_in.empty?
+        @_ae_in = @_ae_in.map{|x| x.to_s.to_sym}.uniq.flatten.delete_if{|y| y.empty?}
+        return if @_ae_in.empty?
+        @_ae_inclusion = @_ae_in.map{|x| [x, x.to_s]}.flatten
+      end
+
+      unless @_ae_default.nil?
+        raise 'default value not match' unless @_ae_inclusion.include?(@_ae_default)
+      end
+
+      _ae_set_default unless @_ae_default.nil?
+      if @_ae_scopeds
+        if @_ae_boolean
+          _ae_set_boolean_scopeds
+        else
+          _ae_set_string_scopeds
+        end
+      end
+
+      
+      if @_ae_boolean
+        _attribute_name_set_boolean_values_method
+        _attribute_name_set_boolean_text_method
+      else
+        _attribute_name_set_string_values_method
+        _attribute_name_set_string_text_method
+      end
+      
+
+      unless @_ae_boolean
+        _ae_set_string_ask_methods if @_ae_ask_methods
+        _attribute_name_set_string_validate if @_ae_validate
+      end
+
+      _ae_remove_instance_variables
+    end
+
+
+
+    private
+
+    def _ae_instance_variable_names
+      %w(attribute_name in boolean default ask_methods scopeds validate i18n inclusion)
+    end
+
+    def _ae_init_instance_variables
+      _ae_instance_variable_names.each do |name|
+        instance_variable_set "@_ae_#{name}", nil
+      end
+    end
+
+    def _ae_remove_instance_variables
+      _ae_instance_variable_names.each do |name|
+        remove_instance_variable "@_ae_#{name}"
+      end
+    end
+
+    def _ae_valid_prefix?(prefix)
+      (prefix.is_a?(String) or prefix.is_a?(Symbol)) and !prefix.empty?
+    end
+
+    def _ae_ask_methods_string_attribute_method_name(_in)
+      prefix = ''
+      if @_ae_ask_methods.is_a?(Hash)
+        _prefix = @_ae_ask_methods[:prefix]
+        if (_prefix.is_a?(String) or _prefix.is_a?(Symbol)) and !_prefix.empty?
+          prefix = _prefix
+        end
+      end
+      ("%s%s?" % [prefix, _in]).to_sym
+    end
+
+    def _ae_scopeds_string_attribute_method_name(_in)
+      prefix = ''
+      if @_ae_scopeds.is_a?(Hash)
+        _prefix = @_ae_scopeds[:prefix]
+        if _ae_valid_prefix?(_prefix)
+          prefix = _prefix
+        end
+      end
+      ("%s%s" % [prefix, _in]).to_sym
+    end
+
+    def _ae_values_method_name
+      ("get_%s_values" % @_ae_attribute_name).to_sym
+    end
+
+    def _ae_text_method_name
+      ("%s_text" % @_ae_attribute_name).to_sym
+    end
+
+    def _ae_i18n_t_prefix
+      t_prefix = ''
+      if @_ae_scopeds.is_a?(Hash)
+        _t_prefix = @_ae_scopeds[:t_prefix]
+        t_prefix = _t_prefix if _ae_valid_prefix?(_t_prefix)
+      end
+      t_prefix
+    end
+
+
+    def _attribute_name_set_boolean_values_method
+      if @_ae_i18n and defined?(::I18n)
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def self.#{_ae_values_method_name}
+            #{@_ae_in}.map do |_in|
+              [I18n.translate('enums.%s%s.%s' % ['#{_ae_i18n_t_prefix}', :#{@_ae_attribute_name}, _in]), _in]
+            end
+          end
+        RUBY
+      else
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def self.#{_ae_values_method_name}
+            #{@_ae_in}.map do |_in|
+              [(_in ? 'Yes' : 'No'), _in]
+            end
+          end
+        RUBY
+      end
+    end
+
+    def _attribute_name_set_string_values_method
+      if @_ae_i18n and defined?(::I18n)
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def self.#{_ae_values_method_name}
+            #{@_ae_in}.map do |_in|
+              [I18n.translate('enums.%s%s.%s' % ['#{_ae_i18n_t_prefix}', :#{@_ae_attribute_name}, _in]), _in.to_s]
+            end
+          end
+        RUBY
+      else
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def self.#{_ae_values_method_name}
+            #{@_ae_in}.map do |_in|
+              [_in.to_s, _in.to_s]
+            end
+          end
+        RUBY
+      end
+    end
+
+
+
+  end
+end
+