classy_enum 0.0.1 → 0.0.2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Peter Brown
+Copyright (c) 2010 Peter Brown
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.textile

@@ -0,0 +1,77 @@
+h1. classy_enum
+
+ClassyEnum adds class-based enumerator functionality to your ActiveRecord model's attributes.
+
+h2. Installation
+
+ClassyEnum has only been tested with Rails 2.3.8, but should work with any version of Rails 2.3.x. The gem is hosted at "rubygems.org":https://rubygems.org/gems/classy_enum
+
+It can be installed with:
+
+<pre>
+  gem install classy_enum
+</pre>
+
+h2. Example Usage
+
+The most common use for ClassyEnum is to replace database lookup tables where the content and behavior is mostly static and has multiple "types". In this example, I have an ActiveRecord model called @Alarm@ with an attribute called @priority@. Priority is stored as a string (VARCHAR) type in the database and is converted to an enum value when requested. 
+
+Using the OPTIONS constant, I have defined three priority levels: low, medium, and high. Each priority level can have different properties and methods associated with it. In my example, each enum value has a method called @email?@. By default this method returns false, but is overridden for high priority alarms and returns true.
+
+*It is important that you include ClassyEnum AFTER declaring your OPTIONS and Default methods because they are used when creating the enum classes*
+
+Create a file in app/models called alarm_priority.rb 
+
+<pre>
+  module AlarmPriority
+    OPTIONS = [:low, :medium, :high]
+
+    module Defaults
+      def email?
+        false
+      end
+    end
+
+    include ClassyEnum
+  end
+
+  class AlarmPriorityHigh
+    def email?
+      true
+    end
+  end
+</pre>
+
+Then in my ActiveRecord model, Alarm, I've added a line that calls @classy_enum_attr@. The first argument is required, and is the name of the module defined above. The second argument is optional and specifies which Alarm attribute will be used as an enumerable. 
+
+In this case, I am using the module AlarmPriority, but the name of my attribute is priority. By default, it will use the name of module as the attribute name. If I wanted to do @alarm.alarm_priority@, I would not have included the second argument.
+
+<pre>
+  class Alarm < ActiveRecord::Base
+    classy_enum_attr :alarm_priority, :priority
+    
+    delegate :email?, :to => :priority
+  end
+</pre>
+
+With this setup, I can now do the following:
+
+<pre>
+  @alarm = Alarm.create(:priority => :medium)
+  
+  @alarm.priority => AlarmPriorityMedium
+  
+  @alarm.email? => false
+  
+  @alarm.update_attribute(:priority, :high)
+  
+  @alarm.email? => true
+</pre>
+
+h2. Notes
+
+An ActiveRecord validator @validates_inclusion_of :field, :in => ENUM.all@ is automatically added to your model when you use @classy_enum_attr@. 
+
+h2. Copyright
+
+Copyright (c) 2010 Peter Brown. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/classy_enum.gemspec

@@ -5,22 +5,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{classy_enum}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Peter Brown"]
-  s.date = %q{2010-09-21}
+  s.date = %q{2010-09-27}
   s.description = %q{A utility that adds class based enum functionaltiy to ActiveRecord attributes}
   s.email = %q{github@lette.us}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.textile"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.textile",
      "Rakefile",
      "VERSION",
      "classy_enum.gemspec",

data/lib/classy_enum.rb

@@ -61,7 +61,7 @@ module ClassyEnum
       
       other::OPTION_HASH[option] = other::OPTION_HASH[option.to_s.downcase] = instance
       
-      ClassyEnum.const_set(option.to_s.upcase, instance)
+      ClassyEnum.const_set(option.to_s.upcase, instance) unless ClassyEnum.const_defined?(option.to_s.upcase)
     end
 
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: classy_enum
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Peter Brown
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-21 00:00:00 -04:00
+date: 2010-09-27 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,12 +57,12 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.textile
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - classy_enum.gemspec

data/README.rdoc

@@ -1,7 +0,0 @@
-= classy_enum
-
-More Description love in the works
-
-== Copyright
-
-Copyright (c) 2010 Peter Brown. See LICENSE for details.