negonicrac-magic_enums 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [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/Manifest

@@ -0,0 +1,7 @@
+init.rb
+README.textile
+Rakefile
+MIT-LICENSE
+lib/magic_enums.rb
+test/magic_enums_test.rb
+Manifest

data/README.textile

@@ -0,0 +1,44 @@
+h1. MagicEnums
+
+h2. Introduction
+
+*RAILS 2.1/EDGE only!*
+
+A nice way to have enums in Rails.
+
+Enumerations are easy as integers, however I want to take a text approach to it as soon as rearranging integers can get fussy.
+
+h2. Usage
+
+h3. In your models
+
+<pre>
+  <code>
+    enum_column :status, %w(draft private published)    
+  </code>
+</pre>
+_or_
+<pre>
+  <code>
+    enum_column :gender, ['male', 'female']
+  </code>
+</pre>
+
+h3. In your controller
+
+In your controller, you can check the status <code>post_record.status_is_published?</code> or simply by calling <code>person_record.gender</code> to find it out in words, as you would normally.
+
+You can also do find calls like so:
+<pre>
+  <code>
+    Post.status_is_published?
+  </code>
+</pre>
+_or_
+<pre>
+  <code>
+    Person.gender_is_male?
+  </code>
+</pre>
+
+Copyright (c) 2008 "Zach Inglis":http://zachinglis.com, released under the MIT license

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('magic_enums', '0.0.1') do |p|
+  p.description = "A nice way to have enums in Rails."
+  p.url = "http://github.com/zachinglis/magic_enums/tree/master"
+  p.author = "Zach Inglis"
+  p.email = "zach@lt3media.com"
+  p.ignore_pattern = ["tmp/*","script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/init.rb

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

data/lib/magic_enums.rb

@@ -0,0 +1,49 @@
+module MagicEnums
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def enum_column(column_name, choices=[], options={})
+      configuration = { :message => "is not a valid choice" }
+      configuration.merge!(options)
+
+      array_in_text = "[#{choices.collect { |choice| "'#{choice}'" }.join(", ")}]" # Make the array into text form.
+
+      class_eval "
+        class_inheritable_accessor  :#{column_name}_choices
+        write_inheritable_attribute :#{column_name}_choices, #{array_in_text}
+
+        validate :validate_#{column_name}_choice
+
+        def validate_#{column_name}_choice
+          errors.add(\"#{column_name}\", \"#{configuration[:message]}\") unless self.#{column_name}_choices.include?(self.#{column_name})
+        end
+      "
+
+      choices.each do |choice|
+        class_eval "
+          named_scope :#{column_name}_is_#{clean(choice)}, :conditions => {:#{column_name} => \"#{choice}\"}
+
+          def #{column_name}_is_#{clean(choice)}?
+            self.#{column_name} == '#{choice}'
+          end
+          "
+      end
+    end
+
+    private
+
+    def clean(text)
+      return nil if text.blank?
+      str = Iconv.iconv('ascii//translit', 'utf-8', text).to_s
+      str.gsub!(/\W+/, ' ')
+      str.strip!
+      str.downcase!
+      str.gsub!(/\ +/, '_')
+      return str
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, MagicEnums rescue nil

data/magic_enums.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{magic_enums}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Zach Inglis"]
+  s.date = %q{2008-11-23}
+  s.description = %q{A nice way to have enums in Rails.}
+  s.email = %q{zach@lt3media.com}
+  s.extra_rdoc_files = ["README.textile", "lib/magic_enums.rb"]
+  s.files = ["init.rb", "README.textile", "Rakefile", "MIT-LICENSE", "lib/magic_enums.rb", "test/magic_enums_test.rb", "Manifest", "magic_enums.gemspec", "test/test_helper.rb"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/zachinglis/magic_enums/tree/master}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Magic_enums", "--main", "README.textile"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{magic_enums}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{A nice way to have enums in Rails.}
+  s.test_files = ["test/magic_enums_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/magic_enums_test.rb

@@ -0,0 +1,27 @@
+require File.join(File.dirname(__FILE__), "test_helper.rb")
+
+class MagicEnumsTest < Test::Unit::TestCase
+  def setup
+    @person = Person.new
+  end
+
+  def test_should_recognize_column_and_associated_class_variables
+    assert_respond_to Person, :gender_choices
+    assert_respond_to Person, :gender_choices=
+    assert_respond_to Person, :gender_is_male
+    assert_respond_to Person, :gender_is_female
+  end
+
+  def test_should_recognize_instance_variables
+    assert_respond_to @person, :gender
+    assert_respond_to @person, :gender_is_male?
+    assert_respond_to @person, :gender_is_female?
+  end
+
+  def test_should_return_true_on_choices
+    @person.gender = "male"
+    assert @person.gender_is_male?
+    @person.gender = "female"
+    assert @person.gender_is_female?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require "test/unit"
+require "rubygems"
+require "active_record"
+require File.join(File.dirname(__FILE__), "..", "lib", "magic_enums")
+
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+ActiveRecord::Base.configurations = true
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :people do |t|
+    t.datetime :created_at
+    t.datetime :updated_at
+    t.string :name
+    t.string :gender
+  end
+end
+
+class Person < ActiveRecord::Base
+  enum_column :gender, %w(male female)
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: negonicrac-magic_enums
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Zach Inglis
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-23 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: A nice way to have enums in Rails.
+email: zach@lt3media.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+- lib/magic_enums.rb
+files: 
+- init.rb
+- README.textile
+- Rakefile
+- MIT-LICENSE
+- lib/magic_enums.rb
+- test/magic_enums_test.rb
+- Manifest
+- magic_enums.gemspec
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/zachinglis/magic_enums/tree/master
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Magic_enums
+- --main
+- README.textile
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: magic_enums
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A nice way to have enums in Rails.
+test_files: 
+- test/magic_enums_test.rb
+- test/test_helper.rb