acts_as_enum 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,51 @@
+== ActsAsEnum
+
+主要应用于有枚举类型属性的Model，这个插件会帮我们生成一些常用到的方法。
+
+如：枚举数组常量，每个元素的常量和布尔方法，属性的名字，Named scope方法
+
+Support rails 3
+
+== Usage
+
+  class User < ActiveRecord::Base
+    acts_as_enum :status, :enum => [ ['disable', 0, '冻结'], ['enable', 1, '激活'] ]
+  end
+
+  Also can usage alias enum_attr
+  enum_attr :status, :enum => [ ['disable', 0, '冻结'], ['enable', 1, '激活'] ]
+
+  
+  Will generate bellow:
+  
+    Constants: User::STATUSES, User::DISABLE, User::ENABLE
+    
+    Named scopes: User.enable, User.disable
+
+    Class methods: User.status_options
+    
+    Instance methods: user.status_name, user.enable?, user.disable?
+    
+    
+    If with option prefix is true: 
+      acts_as_enum :status, :enum => [ ['disable', 0, '冻结'], ['enable', 1, '激活'] ], :prefix => true
+      
+    Will generate bellow:
+    
+      User::STATUS_DISABLE, User::STATUS_ENABLE, User.status_enable, User.status_disable, user.status_enable?, user.status_disable?
+
+
+== Install
+
+  git clone git://github.com/wenke/acts_as_enum.git OR
+  
+  rails 2
+  ./script/plugin install git://github.com/wenke/acts_as_enum.git
+
+  rails 3
+  rails plugin install git://github.com/wenke/acts_as_enum.git
+
+
+== Note
+
+Copyright (c) 2010 liangwenke8@gmail.com, released under the MIT license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the acts_as_enum plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the acts_as_enum plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActsAsEnum'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require 'acts_as_enum'

data/lib/acts_as_enum.rb

@@ -0,0 +1,82 @@
+# EnumAttr#  == Example
+#
+#    class User < ActiveRecord::Base
+#      acts_as_enum :status, :enum => [ ['disable', 0, '冻结'], ['enable', 1, '激活'] ]
+#    end
+#
+#    Also can usage alias enum_attr
+#    enum_attr :status, :enum => [ ['disable', 0, '冻结'], ['enable', 1, '激活'] ]
+#    
+#    Will generate bellow:
+#    
+#      Constants: User::STATUSES(return hash { 0 => "冻结", 1 => "激活" }), User::DISABLE, User::ENABLE
+#      
+#      Named scopes: User.enable, User.disable
+#
+#      Class methods: User.status_options => [["冻结", 0], ["激活", 1]] 
+#
+#      Instance methods: user.status_name, user.enable?, user.disable?
+#      
+#      
+#    If with option prefix is true: 
+#      acts_as_enum :status, :enum => [ ['disable', 0, '冻结'], ['enable', 1, '激活'] ], :prefix => true
+#      
+#    Will generate bellow:
+#      User::STATUS_DISABLE, User::STATUS_ENABLE, User.status_enable, User.status_disable, user.status_enable?, user.status_disable?
+    
+module ActsAsEnum
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    def acts_as_enum(attr, opts = { :enum => [], :prefix => false })
+      attr = attr.to_s
+      plural_upcase_attr = attr.pluralize.upcase
+      enum = opts[:enum]
+      
+      rails "Can not load Rails" unless defined?(Rails)
+      rails "Options enum can not be empty" if enum.blank?
+      rails "Options enum must be an array object" unless enum.is_a?(Array)
+      
+      validates_inclusion_of attr, :in => enum.collect { |arr| arr[1] }, :allow_blank => true
+
+      const_set(plural_upcase_attr, enum.inject({}) { |hash, arr| hash[arr[1]] = arr[2].to_s; hash })
+      
+      enum.each do |arr|
+        enum_name, attr_value = arr[0].to_s, arr[1]
+        method_name = opts[:prefix] ? "#{attr}_#{enum_name}" : enum_name
+        
+        const_set("#{method_name}".upcase, attr_value)
+        
+        if Rails.version =~ /^2/
+          named_scope method_name.to_sym, :conditions => { attr.to_sym => attr_value }
+        else
+          scope method_name.to_sym, where(["#{attr} = ?", attr_value])
+        end
+        
+        class_eval(%Q{
+          def #{method_name}?
+            #{attr} == #{attr_value}
+          end
+        })
+      end
+        
+      class_eval(%Q{
+        def self.#{attr}_options
+          #{plural_upcase_attr}.inject([]){ |arr, obj| arr << obj.reverse }
+        end
+        
+        def #{attr}_name
+          # #{plural_upcase_attr}.detect { |arr| arr[1] == #{attr} }[0] unless #{attr}.blank?
+          #{plural_upcase_attr}[#{attr}] unless #{attr}.blank?
+        end
+      })
+    end
+    
+    alias enum_attr acts_as_enum
+  end
+  
+end
+
+ActiveRecord::Base.send(:include, ActsAsEnum)

data/lib/tasks/acts_as_enum_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_enum do
+#   # Task goes here
+# end

data/test/acts_as_enum_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class ActsAsEnumTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_enum
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- LiangWenKe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-20 00:00:00 +08:00
+default_executable: 
+dependencies: []
+
+description: "\xE4\xB8\xBB\xE8\xA6\x81\xE5\xBA\x94\xE7\x94\xA8\xE4\xBA\x8E\xE6\x9C\x89\xE6\x9E\x9A\xE4\xB8\xBE\xE7\xB1\xBB\xE5\x9E\x8B\xE5\xB1\x9E\xE6\x80\xA7\xE7\x9A\x84Model\xEF\xBC\x8C\xE8\xBF\x99\xE4\xB8\xAA\xE6\x8F\x92\xE4\xBB\xB6\xE4\xBC\x9A\xE5\xB8\xAE\xE6\x88\x91\xE4\xBB\xAC\xE7\x94\x9F\xE6\x88\x90\xE4\xB8\x80\xE4\xBA\x9B\xE5\xB8\xB8\xE7\x94\xA8\xE5\x88\xB0\xE7\x9A\x84\xE6\x96\xB9\xE6\xB3\x95\xE3\x80\x82"
+email: liangwenke8@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/acts_as_enum.rb
+- lib/tasks/acts_as_enum_tasks.rake
+- test/acts_as_enum_test.rb
+- test/test_helper.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- VERSION
+- init.rb
+has_rdoc: true
+homepage: http://github.com/wenke/acts_as_enum
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: acts_as_enum
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Enum Attribute for Rails ActiveRecord
+test_files: []
+