simple_enums 0.1.1

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,79 @@
+=SimpleEnum
+
+== Description
+Simple Enum is a simple and useful plugin for using enum attribute.
+
+* version 0.23
+* by Caryl
+
+== Requirements
+
+* Rails 2.2 or greater
+
+==Installation
+
+  ./script/plugin install git://github.com/caryl/simple_enum.git
+
+==Getting Started
+
+Example:
+  class User
+      include SimpleEnum
+      has_enum :status, :enums => [[:unactived, 0, "未激活"],[:normal, 1, "正常"],[:locked, 2, "已锁定"]], \
+        :column => :status_id, :default => :normal
+  end
+options:
+  has_enum name, enums[, column][, default]
+* name: enum name 
+* enum: a array to define enums, each enum defined by [key(symbol), value(integer), human_name(string)]
+* column: optional, must be a column, attr_accessor or a getter and setter method pair
+  * default is name + '_id'
+* default: enum's default value, can assigned by a symbol(key) integer(value) or string(human name)
+  * default is the first enum
+
+=Usage
+
+This will define the following methods dynamically:
+
+==class methods:
+
+* User.status_enums => [[:unactived, 0, "未激活"],[:normal, 1, "正常"],[:locked, 2, "已锁定"]]
+
+* User.options_for_status => [["正常", 1], ["草稿", 0], ["锁定回复", 2], ["隐藏", 3]]
+
+* User.status_name(:normal) => "正常" #return enum's human name
+  * params: array, symbol, integer, string or array
+
+* User.status_value(:normal) => 1 #return enum value
+  * params: array, symbol, integer, string or array
+  
+* User.new => #default value has been set: user.status == 1
+
+* User.status_is(:normal) => same as User.status_in(:normal) 
+
+==instance methods:
+
+* user.status => #same as status_id
+
+* user.status= => #same as status_id =
+
+* user.status_key => :locked #enum key
+
+* user.status_name => '正常' #enum's human name
+
+* user.status_is?(:normal) => true 
+  * params: array, symbol, integer, string or array
+
+* user.status_default_value => #default value , assign by :default option, default is the first of :enums
+
+* user.set_status_value(:locked) #set value, same as user.status=2 or user.status_id=2
+  * params: array, symbol, integer, string or array
+
+* user.update_status_value(:locked) #update value 
+  * params: array, symbol, integer, string or array
+
+==named scope
+
+* User.status_in(:locked)
+  * params: array, symbol, integer, string or array
+

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'rake'
+require 'rake/testtask'
+
+task :default => [:test]
+
+desc 'Test the simple_enum plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/*_test.rb'
+  t.verbose = true
+end

data/lib/simple_enum/version.rb

@@ -0,0 +1,3 @@
+module SimpleEnum
+  VERSION = "0.1.1"
+end

data/lib/simple_enum.rb

@@ -0,0 +1,128 @@
+module SimpleEnum
+  def self.included(base)
+    base.cattr_accessor :enum_columns
+    base.extend EnumMethods
+    base.send :include, InstanceMethods
+    base.alias_method_chain :initialize, :enum_defaults
+  end
+
+  module EnumMethods
+    def has_enum(name, options)
+      column_attr = "enum_#{name}_column"
+      enums_attr = "#{name}_enums"
+      default_attr = "default_#{name}_enum"
+      cattr_accessor column_attr, enums_attr, default_attr
+      self.enum_columns ||= []
+      self.enum_columns << name
+      self.send("#{column_attr}=",  options[:column] || "#{name}_id")
+      self.send("#{enums_attr}=", options[:enums])
+      self.send("#{default_attr}=", options[:default] || options[:enums].first.first)
+      self.module_eval do
+        scope "#{name}_in", lambda{|s| where(self.send(column_attr).to_sym => self.send("#{name}_value", s)) }
+
+        #类方法
+        #enum_in的别名：enum_is
+        self.class.send(:define_method, "#{name}_is") do |s|
+          self.send "#{name}_in", s
+        end
+
+        #返回一个select options数组
+        self.class.send(:define_method, "options_for_#{name}") do |*params|
+          if params.blank?
+            self.send(enums_attr).map{|s|[s.last, s.second]}
+          elsif params.first.is_a?(Symbol)
+            self.send(enums_attr).select{|e|params.include?(e.first)}.map{|s|[s.last, s.second]}
+          elsif params.first.is_a?(Array)
+            params.map{|p|[p.second, self.send(enums_attr).detect{|e|e.first == p.first}.try(:second)]}
+          end
+        end
+
+        #根据数组、符号、字符串返回value
+        self.class.send(:define_method, "#{name}_value") do |param|
+          if param.is_a?(Array)
+            param.map{|p|self.send("#{name}_value",p)}
+          elsif param.is_a?(Symbol)
+            self.send(enums_attr).assoc(param).try(:second)
+          elsif param.is_a?(String)
+            self.send(enums_attr).detect{|s| s.third == param }.try(:second)
+          else
+            param
+          end
+        end
+
+        #根据符号、字符串返回名称
+        self.class.send(:define_method, "#{name}_name") do |param|
+          self.send(enums_attr)
+          if param.is_a?(Symbol)
+            self.send(enums_attr).detect{|s| s.first == param }.try(:last)
+          elsif param.is_a?(String)
+            param
+          else
+            self.send(enums_attr).detect{|s| s.second == param }.try(:last)
+          end
+        end
+
+        #当前名称
+        self.send(:define_method, "#{name}_name") do
+          self.class.send(enums_attr).detect {|s| s.second == self.send(self.send(column_attr))}.try(:last)
+        end
+
+        #当前key
+        self.send(:define_method, "#{name}_key") do
+          self.class.send(enums_attr).detect {|s| s.second == self.send(self.send(column_attr))}.try(:first)
+        end
+
+        #设置值
+        self.send(:define_method, "set_#{name}_value") do |param|
+          value_id =
+            if param.is_a?(Symbol)  #key
+            self.class.send("#{name}_value", param)
+          elsif param.is_a?(String) #name
+            self.send(enums_attr).detect {|s| s.last == param  }.try(:second)
+          else #id
+            param
+          end
+          self.send("#{self.send(column_attr)}=", value_id)
+          value_id
+        end
+
+        #更新值
+        self.send(:define_method, "update_#{name}_value") do |param|
+          self.send("set_#{name}_value", param)
+          self.save(:validate => false)
+        end
+
+        #判断当前实例是否是
+        self.send(:define_method, "#{name}_is?") do |key|
+          if key.is_a?(Array)
+            key.detect{|p|self.send("#{name}_is?", p)}
+          else
+            self.class.send("#{name}_value", key) == self.send(self.send(column_attr))
+          end
+        end
+
+        #默认值
+        self.send(:define_method, "set_#{name}_default_value") do
+          self.send("#{self.send(column_attr)}=", self.send("#{name}_default_value"))
+        end
+
+        self.send(:define_method, "#{name}_default_value") do
+          self.class.send("#{name}_value", self.send(default_attr))
+        end
+
+        #可使用name和column访问
+        alias_attribute name, self.send(column_attr) unless name.to_s == self.send(column_attr).to_s
+      end
+    end
+  end
+
+  module InstanceMethods
+    def initialize_with_enum_defaults(attrs = nil, *args, &block)
+      initialize_without_enum_defaults(attrs, *args, &block)
+      self.enum_columns.each do |column|
+        self.send("set_#{column}_default_value") unless attrs && self.respond_to?("enum_#{column}_column") && attrs.include?(self.send("enum_#{column}_column").to_sym) || !self.respond_to?("set_#{column}_default_value")
+      end
+      yield(self) if block_given?
+    end
+  end
+end

data/simple_enum.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simple_enum/version"
+
+Gem::Specification.new do |s|
+  s.name        = "simple_enums"
+  s.version     = SimpleEnum::VERSION
+  s.authors     = ["CarylWang"]
+  s.email       = ["xianwei.wang@gmail.com"]
+  s.homepage    = "http://github.com/caryl/simple_enum"
+  s.summary     = %q{a plugin for using enum attribute.}
+  s.description = %q{Simple Enum is a simple and useful plugin for using enum attribute.}
+
+  #s.rubyforge_project = "simple_enum"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+plugin_test:
+  adapter: sqlite3
+  database: ":memory:"

data/test/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define(:version => 0) do
+	create_table :mocks, :force => true do |t|
+	  t.string :name
+		t.integer :status
+	end
+end

data/test/simple_enum_test.rb

@@ -0,0 +1,159 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class SimpleEnumTest < Test::Unit::TestCase
+  def setup
+    @mock = Mock.new
+  end
+
+  def test_mock_new
+    mock = Mock.new(:name => "my name", :status => '3')
+    assert_equal mock.name, "my name"
+    assert_equal mock.status, 3
+    mock = Mock.new(:name => "my name")
+    assert_equal mock.name, "my name"
+    assert_equal mock.status, 2
+  end
+
+  def test_enum_scope
+    assert_equal Mock.status_in(:normal).class, ActiveRecord::Relation
+    assert_equal Mock.kind_in(:normal).class, ActiveRecord::Relation
+    assert_equal Mock.status_is(:normal).class, ActiveRecord::Relation
+  end
+
+  def test_enum_enums
+    assert_equal Mock.status_enums, [[:normal, 1, '正常'],[:locked, 2, '锁定'],[:deleted, 3, '已删除']]
+    assert_equal Mock.kind_enums, [[:admin, 1, '管理员'],[:member, 2, '成员']]
+  end
+
+  def test_options_for_enum
+    assert_equal Mock.options_for_status, [['正常',1],['锁定',2],['已删除',3]]
+    assert_equal Mock.options_for_status(:normal, :locked), [['正常',1],['锁定',2]]
+    assert_equal Mock.options_for_status([:normal, '审核'], [:locked, '锁定']), [['审核',1],['锁定',2]]
+    assert_equal Mock.options_for_kind, [['管理员',1],['成员',2]]
+  end
+
+  def test_enum_value
+    assert_equal Mock.status_value(:locked), 2
+    assert_equal Mock.status_value('正常'), 1
+    assert_equal Mock.status_value(['正常', :deleted]), [1,3]
+    assert_equal Mock.status_value(:other), nil
+
+    assert_equal Mock.kind_value(:admin), 1
+    assert_equal Mock.kind_value('成员'), 2
+    assert_equal Mock.kind_value(['成员', :admin]), [2,1]
+    assert_equal Mock.kind_value(:other), nil
+  end
+
+  def test_class_enum_name
+    assert_equal Mock.status_name(:locked), '锁定'
+    assert_equal Mock.status_name('正常'), '正常'
+    assert_equal Mock.status_name(1), '正常'
+    assert_equal Mock.status_name(:other), nil
+
+    assert_equal Mock.kind_name(:admin), '管理员'
+    assert_equal Mock.kind_name('成员'), '成员'
+    assert_equal Mock.kind_name(1), '管理员'
+    assert_equal Mock.kind_name(:other), nil
+  end
+
+  def test_enum_default
+    mock = Mock.new
+    assert_equal mock.status, 2
+    mock.status = 3
+    assert_equal mock.status, 3
+    assert_equal mock.status_default_value, 2
+
+    mock = Mock.new
+    assert_equal mock.kind, 1
+    assert_equal mock.kind_id, 1
+    mock.kind = 2
+    assert_equal mock.kind, 2
+    assert_equal mock.kind_id, 2
+    assert_equal mock.kind_default_value, 1
+  end
+
+  def test_enum_key
+    @mock.set_status_value(:locked)
+    assert_equal @mock.status_key, :locked
+    @mock.status = 1
+    assert_equal @mock.status_key, :normal
+
+    @mock.set_kind_value(:admin)
+    assert_equal @mock.kind_key, :admin
+    @mock.kind = 2
+    assert_equal @mock.kind_key, :member
+  end
+
+  def test_enum_name
+    @mock.set_status_value(:locked)
+    assert_equal @mock.status_name, '锁定'
+    @mock.status = 1
+    assert_equal @mock.status_name, '正常'
+
+    @mock.set_kind_value(:admin)
+    assert_equal @mock.kind_name, '管理员'
+    @mock.kind_id = 2
+    assert_equal @mock.kind_name, '成员'
+  end
+
+  def test_enum_is?
+    @mock.set_status_value(:locked)
+    assert @mock.status_is?(:locked)
+    assert @mock.status_is?(2)
+    assert @mock.status_is?('锁定')
+    assert !@mock.status_is?('其他')
+
+    @mock.set_kind_value(:admin)
+    assert @mock.kind_is?(:admin)
+    assert @mock.kind_is?(1)
+    assert @mock.kind_is?('管理员')
+    assert !@mock.kind_is?(:member)
+  end
+
+  def test_set_enum_value
+    @mock.set_status_value(:normal)
+    assert @mock.status_is?(:normal)
+
+    @mock.set_kind_value(:member)
+    assert @mock.kind_is?(:member)
+  end
+
+  def test_update_enum_value
+    @mock.update_status_value(:normal)
+    @mock.reload
+    assert @mock.status_is?(:normal)
+  end
+
+  def test_set_default_value
+    mock = Mock.new
+    mock.status = 1
+    mock.set_status_default_value
+    assert mock.status_is?(:locked)
+
+    mock.kind_id = 2
+    assert mock.kind_is?(:member)
+    mock.set_kind_default_value
+    assert mock.kind_is?(:admin)
+  end
+
+  def test_enum_on_save
+    mock = Mock.new
+    mock.save
+    assert mock.status_is?(:locked)
+    assert mock.kind_is?(:admin)
+
+    mock.set_status_value(:normal)
+    mock.set_kind_value(:member)
+    mock.save
+    assert mock.status_is?(:normal)
+    assert mock.kind_is?(:member)
+  end
+end
+
+
+class Mock < ActiveRecord::Base
+  attr_accessor :kind_id
+  include SimpleEnum
+  has_enum :status, :enums => [[:normal, 1, '正常'],[:locked, 2, '锁定'],[:deleted, 3, '已删除']], :column => :status, :default => :locked
+  has_enum :kind, :enums => [[:admin, 1, '管理员'],[:member, 2, '成员']], :column => :kind_id
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'test/unit'
+require 'active_record'
+require 'simple_enum'
+
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'plugin_test'])
+
+load(File.dirname(__FILE__) + "/schema.rb") if File.exist?(File.dirname(__FILE__) + "/schema.rb")

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: simple_enums
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- CarylWang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-27 00:00:00 Z
+dependencies: []
+
+description: Simple Enum is a simple and useful plugin for using enum attribute.
+email: 
+- xianwei.wang@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/simple_enum.rb
+- lib/simple_enum/version.rb
+- simple_enum.gemspec
+- test/database.yml
+- test/schema.rb
+- test/simple_enum_test.rb
+- test/test_helper.rb
+homepage: http://github.com/caryl/simple_enum
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: a plugin for using enum attribute.
+test_files: []
+