jsmestad-merb_activerecord_enum 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Justin Smestad
+
+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

@@ -0,0 +1,61 @@
+merb_activerecord_enum
+======================
+
+A plugin for the Merb framework that provides enumeration compatibility for ActiveRecord.
+Port of "activerecord-symbolize" by zargony
+
+Original README
+======================
+= Symbolize attribute values in ActiveRecord (e.g. for nicer enums)
+ 
+This plugin introduces an easy way to use symbols for values of ActiveRecord
+attributes. Symbolized attributes return a ruby symbol (or nil) as their value
+and can be set using symbols.
+ 
+== About
+ 
+Since ActiveRecord does not natively support database column types of ENUM or
+SET, you'll usually use a string attribute and restrict it to certain values
+with validations. Using this plugin, the values of such pseudo-enums are
+symbols, which look more ruby-style than strings.
+ 
+Simply add "symbolize :attr_name" to your model class, and the specified
+attribute will return symbol values and can be set using smbols (setting
+string values will still work, which is important when using forms).
+ 
+An attribute to symbolize should be a string (varchar) column in the database.
+ 
+Blog: http://zargony.com/
+Github: http://github.com/zargony/activerecord_symbolize
+ 
+== Install
+ 
+  ./script/plugin install git://github.com/zargony/activerecord_symbolize.git
+ 
+== Usage
+ 
+Add "symbolize :attr_name" to your model class. An attribute validation
+(like validates_inclusion_of) can be added by using the :in option.
+ 
+  class User < ActiveRecord::Base
+    symbolize :gender, :in => [:female, :male]
+  end
+ 
+== Examples
+ 
+  u = User.find_by_name('Anna')   # => #<User Anna>
+  u.gender                        # => :female
+  
+  u = User.find_by_gender(:male)  # => #<User Bob>
+  u.gender                        # => :male
+  
+  u = User.find(:all, :conditions => { :gender => :female })
+  
+  u = User.new(:name => 'ET', :gender => :unknown)
+  u.save                          # => validation fails
+ 
+== Notes
+ 
+I've been using this for quite some time and made it a rails plugin now. More
+background information can be found at
+http://zargony.com/2007/09/07/symbolize-attribute-values-in-activerecord

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "merb-activerecord-enum"
+GEM_VERSION = "1.0.2"
+AUTHOR = "Justin Smestad"
+EMAIL = "justin.smestad@gmail.com"
+HOMEPAGE = "http://www.evalcode.com/"
+SUMMARY = "Merb plugin that provides symbolized attribute values (nice enums) for AR"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= 1.0.8.1')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+  
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the plugin as a gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/TODO

@@ -0,0 +1,5 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/merb_activerecord_enum.rb
+Add your Merb rake tasks to lib/merb_activerecord_enum/merbtasks.rb

data/lib/merb_activerecord_enum.rb

@@ -0,0 +1,21 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  
+  dependency "activerecord"
+
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.config[:merb_activerecord_enum] = {
+  }
+  
+  Merb::BootLoader.before_app_loads do
+    # require code that must be loaded before the application
+    require File.join(File.dirname(__FILE__), 'merb_activerecord_enum', 'symbolize')
+    ActiveRecord::Base.send(:include, Symbolize)
+  end
+  
+  Merb::BootLoader.after_app_loads do
+    # code that can be required after the application loads
+  end
+  
+  Merb::Plugins.add_rakefiles "merb_activerecord_enum/merbtasks"
+end

data/lib/merb_activerecord_enum/merbtasks.rb

@@ -0,0 +1,7 @@
+namespace :merb_activerecord_enum do
+  task :default => [:test]
+  desc "Do something for merb_activerecord_enum"
+  task :test do
+    ruby "test/merb_activerecord_enum_test.rb"
+  end
+end

data/lib/merb_activerecord_enum/symbolize.rb

@@ -0,0 +1,81 @@
+module Symbolize
+  def self.included (base)
+    base.extend(ClassMethods)
+  end
+ 
+  # Symbolize ActiveRecord attributes. Add
+  #   symbolize :attr_name
+  # to your model class, to make an attribute return symbols instead of
+  # string values. Setting such an attribute will accept symbols as well
+  # as strings. In the database, the symbolized attribute should have
+  # the column-type :string.
+  #
+  # Example:
+  #   class User < ActiveRecord::Base
+  #     symbolize :gender, :in => [:female, :male]
+  #   end
+  module ClassMethods
+    # Specifies that values of the given attributes should be returned
+    # as symbols. The table column should be created of type string.
+    def symbolize (*attr_names)
+      configuration = {}
+      configuration.update(attr_names.extract_options!)
+      
+      enum = configuration[:in] || configuration[:within]
+      
+      unless enum.nil?
+        if enum.class == Hash
+          values = enum
+          enum   = enum.map { |key,value| key } 
+        else
+          values = Hash[*enum.collect { |v| [v, v.to_s.capitalize] }.flatten]
+        end
+ 
+        attr_names.each do |attr_name|
+          attr_name = attr_name.to_s
+          class_eval("#{attr_name.upcase}_VALUES = values")
+          class_eval("def self.get_#{attr_name}_values; #{attr_name.upcase}_VALUES; end")
+        end
+        
+        class_eval("validates_inclusion_of :#{attr_names.join(', :')}, configuration")
+      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")
+      end
+    end
+  end
+ 
+  # Return an attribute's value as a symbol or nil
+  def read_and_symbolize_attribute (attr_name)
+    read_attribute(attr_name).to_sym rescue nil
+  end
+ 
+  # Write a symbolized value
+  def write_symbolized_attribute (attr_name, value)
+    write_attribute(attr_name, (value.to_sym && value.to_sym.to_s rescue nil))
+  end
+end
+ 
+# The Symbol class is extended by method quoted_id which returns a string.
+# The idea behind this is, that symbols are converted to plain strings
+# when being quoted by ActiveRecord::ConnectionAdapters::Quoting#quote.
+# This makes it possible to work with symbolized attibutes in sql conditions.
+# E.g. validates_uniqueness_of could not use :scope with a symbolized
+# attribute, because AR quotes it to YAML:
+#  "... AND status = '--- :active\n'"
+# Having support for quoted_id in Symbol, makes AR quoting symbols correctly:
+#  "... AND status = 'active'"
+# NOTE: Normally quoted_id should be implemented as a singleton method
+#       only used on symbols returned by read_and_symbolize_attribute,
+#       but unfortunately this is not possible since Symbol is an immediate
+#       value and therefore does not support singleton methods.
+class Symbol
+  def quoted_id
+    # A symbol can contain almost every character (even a backslash or an
+    # apostrophe), so make sure to properly quote the string value here.
+    "'#{ActiveRecord::Base.connection.quote_string(self.to_s)}'"
+  end
+end

data/spec/merb_activerecord_enum_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "merb_activerecord_enum" do
+  it "should do nothing" do
+    true.should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: jsmestad-merb_activerecord_enum
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Justin Smestad
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-18 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.8.1
+    version: 
+description: Merb plugin that provides symbolized attribute values (nice enums) for AR
+email: justin.smestad@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb_activerecord_enum
+- lib/merb_activerecord_enum/merbtasks.rb
+- lib/merb_activerecord_enum/symbolize.rb
+- lib/merb_activerecord_enum.rb
+- spec/merb_activerecord_enum_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.evalcode.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: merb
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Merb plugin that provides symbolized attribute values (nice enums) for AR
+test_files: []
+