cymbalize 0.1.0

data/lib/cymbalize/railtie.rb

@@ -0,0 +1,13 @@
+require 'cymbalize'
+
+module Cymbalize
+  require 'rails'
+
+  class Railtie < Rails::Railtie
+    initializer 'cymbalize.insert_into_active_record' do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send(:include, Cymbalize)
+      end
+    end
+  end
+end

data/lib/cymbalize.rb

@@ -0,0 +1,60 @@
+require 'cymbalize/railtie'
+require 'active_support/concern'
+
+module Cymbalize
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    @@symbolized_options = {}
+
+    def symbolize(*attribute_names)
+      options = attribute_names.extract_options!
+
+      attribute_names.each do |attribute_name|
+        symbolize_attribute(attribute_name, options)
+      end
+    end
+
+    def symbolize_attribute(attribute_name, options)
+      define_method attribute_name do
+        read_symbolized_attribute(attribute_name)
+      end
+
+      if options[:in].present?
+        validates_inclusion_of attribute_name,
+                               :in => options[:in],
+                               :allow_blank => !!options[:allow_blank]
+
+        @@symbolized_options[attribute_name] = options[:in]
+
+        if !!options[:methods]
+          options[:in].each do |valid_type|
+            define_method "#{valid_type}?" do
+              read_symbolized_attribute(attribute_name) == valid_type
+            end
+          end
+        end
+
+        if !!options[:scopes]
+          options[:in].each do |valid_type|
+            scope valid_type, where(attribute_name => valid_type)
+          end
+        end
+      end
+    end
+
+    def options_for(attribute_name)
+      @@symbolized_options[attribute_name]
+    end
+  end
+
+  def read_symbolized_attribute(attribute_name)
+    value = read_attribute(attribute_name)
+
+    if value.present?
+      value.to_sym
+    else
+      nil
+    end
+  end
+end

data/spec/cymbalize_spec.rb

@@ -0,0 +1,106 @@
+require 'database'
+
+shared_examples 'it has a valid, symbolized gender' do
+  it { should be_valid }
+  its(:gender) { should be_a(Symbol) }
+end
+
+# User is:
+#
+#   t.string :name
+#   t.string :gender
+#   t.string :status
+#   t.string :mood
+describe 'Cymbalize' do
+  let(:user_class) { create_user_class }
+  subject { user_class }
+
+  it { should respond_to(:symbolize) }
+  it { should respond_to(:symbolize_attribute) }
+  its(:instance_methods) { should include('read_symbolized_attribute') }
+
+  context 'with symbolized gender' do
+    let(:symbolize_options) { {} }
+    before { user_class.symbolize :gender, symbolize_options }
+    specify { subject.options_for(:gender).should be_nil }
+
+    describe 'user instance' do
+      subject { user_class.new(:gender => :robot) }
+      it_behaves_like 'it has a valid, symbolized gender'
+
+      context 'initialized with a string' do
+        subject { user_class.new(:gender => 'robot') }
+        it_behaves_like 'it has a valid, symbolized gender'
+      end
+    end
+
+    context 'with the :in option' do
+      let(:symbolize_options) { {:in => [:robot, :alien]} }
+      specify { subject.options_for(:gender).should =~ [:robot, :alien] }
+
+      describe 'user instance' do
+        subject { user_class.new(:gender => gender) }
+
+        context 'with a gender in the list' do
+          let(:gender) { :robot }
+          it_behaves_like 'it has a valid, symbolized gender'
+        end
+
+        context 'with a gender not in the list' do
+          let(:gender) { :cowboy }
+          it { should_not be_valid }
+        end
+      end
+    end
+
+    context 'with the :allow_blank option' do
+      let(:symbolize_options) { {:in => [:robot, :alien], :allow_blank => true} }
+
+      describe 'user instance' do
+        subject { user_class.new(:gender => gender) }
+
+        context 'with an empty string value' do
+          let(:gender) { '' }
+          it { should be_valid }
+          its(:gender) { should be_nil }
+        end
+
+        context 'with a nil value' do
+          let(:gender) { nil }
+          it { should be_valid }
+          its(:gender) { should be_nil }
+        end
+      end
+    end
+
+    context 'with the :methods option' do
+      let(:symbolize_options) {{
+        :in => [:robot, :alien, :cowboy],
+        :methods => true
+      }}
+
+      its(:instance_methods) { should include('robot?', 'alien?') }
+
+      describe 'robot user instance' do
+        subject { user_class.new(:gender => :robot) }
+
+        it { should respond_to(:robot?, :alien?) }
+        it { should be_robot }
+        it { should_not be_alien }
+      end
+    end
+
+    context 'with the :scopes option' do
+      let(:symbolize_options) {{
+        :in => [:robot, :alien, :cowboy],
+        :scopes => true
+      }}
+
+      it { should respond_to(:robot, :alien, :cowboy) }
+
+      let(:robot_user) { user_class.create(:gender => :robot) }
+      its(:robot) { should include(robot_user) }
+      its(:alien) { should_not include(robot_user) }
+    end
+  end
+end

data/spec/database.rb

@@ -0,0 +1,33 @@
+require 'active_record'
+require 'cymbalize'
+
+# Include Cymbalize manually, since Railtie hook won't fire.
+ActiveRecord::Base.send(:include, Cymbalize)
+
+# Create our database.
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  :database => ':memory:'
+)
+
+ActiveRecord::Schema.define do
+  create_table :users do |t|
+    t.string :name
+    t.string :gender
+    t.string :status
+    t.string :mood
+
+    t.timestamps
+  end
+end
+
+def create_user_class
+  Class.new(ActiveRecord::Base) do
+
+    def self.name
+      'User'
+    end
+
+    self.table_name = 'users'
+  end
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: cymbalize
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mukund Lakshman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 2
+        - 11
+        - 0
+        version: 2.11.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 3
+        - 6
+        version: 1.3.6
+  type: :development
+  version_requirements: *id004
+description: |
+  Cymbalize is a tiny extension to support symbolized columns in ActiveRecord,
+  with optional convenience methods. It's heavily inspired by nofxx's symbolize
+  Gem.
+
+email: yaymukund@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/cymbalize.rb
+- lib/cymbalize/railtie.rb
+- spec/cymbalize_spec.rb
+- spec/database.rb
+homepage: http://github.com/yaymukund/cymbalize
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Use symbols in ActiveRecord columns.
+test_files: 
+- spec/cymbalize_spec.rb
+- spec/database.rb