enumify 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.idea

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## v0.0.1
+* Initial release

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/Readme.md

@@ -0,0 +1,51 @@
+# Enumify
+
+enumify adds an enum command to all ActiveRecord models which enables you to work with string attributes as if they were enums
+
+## Installing
+
+Just add the enumify gem to your GemFile
+
+## How to use
+
+Just call the enum function in any ActiveRecord object, the function accepts the field name as the first variable and the possible values as an array
+
+    class Event < ActiveRecord::Base
+        enum :status, [:available, :canceled, :completed]
+    end
+
+After that you get several autogenerated commands to use with the enum
+
+    # Access through field name
+
+    event.status                # returns the enum's current value as a symbol
+    event.status = :canceled    # sets the enum's value to canceled (can also get a string)
+
+
+    # Shorthand methods, access through the possible values
+
+    event.available?            # returns true if enum's current status is available
+    event.canceled!             # changes the enum's value to canceled
+
+    # Get all the possible values
+    
+    Event::STATUSES             # returns all available status of the enum
+
+## Callbacks
+Another cool feature of enumify is the option to add a callback function that will be called each time the value of the field changes
+This is cool to do stuff like log stuff or create behaviour on state changes
+
+All you need to do is add a x_changed method in your class and the enumify will call it
+
+    class Event < ActiveRecord::Base
+        enum :status, [:available, :canceled, :completed]
+
+        def status_changed(old, new)
+            puts "status changed from #{old} to #{new}"
+        end
+    end
+
+
+---
+
+Copyright (c) 2011 Yonatan Bergman, released under the MIT license

data/enumify.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "enumify/version"
+
+Gem::Specification.new do |s|
+  s.name        = "enumify"
+  s.version     = Enumify::VERSION
+  s.authors     = ["yon"]
+  s.email       = ["yonatanbergman@gmail.com"]
+  s.homepage    = "http://github.com/yonbergman/enumify"
+  s.summary     = %q{enumify adds an enum command to all ActiveRecord models which enables you to work with string attributes as if they were enums}
+  s.description = %q{enumify adds an enum command to all ActiveRecord models which enables you to work with string attributes as if they were enums}
+
+  s.rubyforge_project = "enumify"
+
+  s.files         = `git ls-files`.split("\n") - ["Gemfile.lock"]
+  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 "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "supermodel"
+end

data/lib/enumify.rb

@@ -0,0 +1,3 @@
+require "enumify/version"
+require "enumify/model"
+require "enumify/railtie" if defined? Rails

data/lib/enumify/model.rb

@@ -0,0 +1,49 @@
+module Enumify
+  module Model
+    def enum(parameter, opts=[])
+
+      validates_inclusion_of parameter, :in => opts
+
+      const_set("#{parameter.to_s.pluralize.upcase}", opts)
+
+      define_method "#{parameter.to_s}" do
+        attr = read_attribute(parameter)
+        (attr.nil? || attr.empty?) ? nil : attr.to_sym
+      end
+
+      define_method "#{parameter.to_s}=" do |value|
+        send("_set_#{parameter.to_s}", value, false)
+      end
+
+      self.class_eval do
+
+        private
+        define_method "_set_#{parameter.to_s}" do |value, should_save|
+
+          value = value.to_sym
+          old = read_attribute(parameter) ? read_attribute(parameter).to_sym : nil
+          write_attribute(parameter, value.to_s)
+          save if should_save
+          send("#{parameter.to_s}_changed", old, value) if respond_to?("#{parameter.to_s}_changed", true) and old != value and !old.nil?
+          return value
+        end
+      end
+
+      opts.each do |opt|
+        raise "Collision in enum values method #{opt}" if respond_to?("#{opt.to_s}?") or respond_to?("#{opt.to_s}!") or respond_to?("#{opt.to_s}")
+
+        define_method "#{opt.to_s}?" do
+            send("#{parameter.to_s}") == opt
+        end
+
+        define_method "#{opt.to_s}!" do
+            send("_set_#{parameter.to_s}", opt, true)
+        end
+
+        scope opt.to_sym, where(parameter.to_sym => opt.to_s)
+      end
+
+    end
+
+  end
+end

data/lib/enumify/railtie.rb

@@ -0,0 +1,9 @@
+module UrlFormatter
+  class Railtie < Rails::Railtie
+    initializer 'enumify.model' do
+      ActiveSupport.on_load :active_record do
+        extend Enumify::Model
+      end
+    end
+  end
+end

data/lib/enumify/version.rb

@@ -0,0 +1,3 @@
+module Enumify
+  VERSION = "0.0.1"
+end

data/spec/enumify/enum_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+class Model < SuperModel::Base
+  include ActiveModel::Validations
+  extend Enumify::Model
+  def self.scope(name,hash={}) self end
+  def self.where(hash={}) self end
+
+  enum :status, [:available, :canceled, :completed]
+  
+end
+
+describe :Enumify do
+
+  before(:each) do
+    @obj = Model.new(:status => :available)
+  end
+
+  describe "short hand methods" do
+    describe "question mark (?)" do
+      it "should return true if value of enum equals a value" do
+        @obj.available?.should be_true
+      end
+
+      it "should return false if value of enum is different " do
+        @obj.canceled?.should be_false
+      end
+
+    end
+
+    describe "exclemation mark (!)" do
+      it "should change the value of the enum to the methods value" do
+        @obj.canceled!
+        @obj.status.should == :canceled
+      end
+    end
+
+    it "should have two shorthand methods for each possible value" do
+      Model::STATUSES.each do |val|
+        @obj.respond_to?("#{val}?").should be_true
+        @obj.respond_to?("#{val}!").should be_true
+      end
+    end
+  end
+
+  describe "getting value" do
+    it "should always return the enums value as a symbol" do
+      @obj.status.should == :available
+      @obj.status = "canceled"
+      @obj.status.should == :canceled
+    end
+
+  end
+
+  describe "setting value" do
+    it "should except values as symbol" do
+      @obj.status = :canceled
+      @obj.canceled?.should be_true
+    end
+
+    it "should except values as string" do
+      @obj.status = "canceled"
+      @obj.canceled?.should be_true
+    end
+  end
+
+  describe "validations" do
+    it "should not except a value outside the given list" do
+      @obj = Model.new(:status => :available)
+      @obj.status = :foobar
+      @obj.should_not be_valid
+    end
+
+    it "should except value in the list" do
+      @obj = Model.new(:status => :available)
+      @obj.status = :canceled
+      @obj.should be_valid
+    end
+  end
+
+  describe "callbacks" do
+    it "should receive a callback on change of value" do
+      @obj.should_receive(:status_changed).with(:available,:canceled)
+      @obj.canceled!
+    end
+
+    it "should not receive a callback on initial value" do
+      @obj = Model.new
+      @obj.should_not_receive(:status_changed).with(nil, :canceled)
+      @obj.canceled!
+      end
+
+    it "should not receive a callback on value change to same" do
+      @obj.should_not_receive(:status_changed).with(:available, :available)
+      @obj.available!
+    end
+
+  end
+
+  it "class should have a CONST that holds all the available options of the enum" do
+    Model::STATUSES.should == [:available, :canceled, :completed]
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'enumify'
+require 'supermodel'

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: enumify
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- yon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: supermodel
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: enumify adds an enum command to all ActiveRecord models which enables you to work with string attributes as if they were enums
+email: 
+- yonatanbergman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- Rakefile
+- Readme.md
+- enumify.gemspec
+- lib/enumify.rb
+- lib/enumify/model.rb
+- lib/enumify/railtie.rb
+- lib/enumify/version.rb
+- spec/enumify/enum_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/yonbergman/enumify
+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: enumify
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: enumify adds an enum command to all ActiveRecord models which enables you to work with string attributes as if they were enums
+test_files: 
+- spec/enumify/enum_spec.rb
+- spec/spec_helper.rb