flex_fields 1.0.0

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+.rvmrc
+.bundle
+
+flex_fields*.gem
+*emfile.lock
+

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gemspec
+
+gem "activerecord", "~> 3.0"
+gem "activesupport", "~> 3.0"
+
+group :test do
+	gem 'rspec'
+	gem "sqlite3"
+end

data/Gemfile.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    flex_fields (1.0.0)
+      activerecord (>= 3.0)
+      activesupport (>= 3.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.0)
+    multi_json (1.0.4)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    sqlite3 (1.3.5)
+    tzinfo (0.3.31)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 3.0)
+  activesupport (~> 3.0)
+  flex_fields!
+  rspec
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kyle Crum (http://kylecrum.wordpress.com)
+
+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.markdown

@@ -0,0 +1,102 @@
+Flex Fields
+===============
+
+Flex Fields allows you to define an arbitrary amount of data to be stored in 
+a serialized column.  Why?  Because sometimes you have data that just doesn't need
+to be in its own column. 
+
+  
+## Examples ##
+
+To activate, just need to declare flex_fields in your model.
+
+```
+	class MyModel < ActiveRecord::Base
+		flex_fields :foo=>String, :bar=>Integer
+	end
+```		
+		
+This gives you two new flex fields: foo and bar
+
+```
+	my_model = MyModel.new(:foo=>'foo',:bar=>1)
+	my_model.foo
+		=> 'foo'
+	my_model.bar
+		=> 1
+```
+			
+Flex Fields works nicely with inheritance and STI, too, so don't worry about that!
+
+```
+	class AnotherModel < MyModel
+		flex_fields :more_stuff=>Array
+	end
+	
+	another_model = AnotherModel.new
+	another_model.foo
+		=> nil
+	another_model.more_stuff
+		=> []
+```
+			
+By default, the data is stored in a serialized Hash in a column called 'flex'
+You can change this by passing in column_name.
+
+```
+	class MyModel < ActiveRecord::Base
+		flex_fields :column_name=>:data, :foo=>String, :bar=>Integer
+	end
+```
+		
+Now, everything is stored in a serialized hash in the data column.
+
+Just like in ActiveRecord, if you want to override the default getter and setter methods,
+you can.  Instead of using write_attribute and read_attribute, use write_flex_field and
+read_flex_field
+
+```
+	class MyModel < ActiveRecord::Base
+	
+		flex_fields :foo=>String, :bar=>Integer
+		
+		def foo
+			logger.debug("I am accessing foo")
+			read_flex_field(:foo)
+		end
+		
+		def foo=(new_val)
+			logger.debug("I am setting foo to a new value")
+			write_flex_field(:foo,new_val)
+		end
+	
+	end
+```
+	
+## Conversions ##
+
+Flex Attributes will convert the value to the class you specify in the declaration
+
+```
+	class MyModel < ActiveRecord::Base
+		flex_fields :float_value=>Float, :integer_value=>Integer
+	end
+	
+	model = MyModel.new
+	model.float_value = '1'
+	model.float_value
+		=> 1.0
+	model.integer_value = '1'
+	model.integer_value
+		=> 1
+```			
+Currently, Flex Fields supports these types of fields:
+
+	Array
+	Date
+	DateTime
+	Float
+	Hash
+	Integer
+	String
+	Time

data/flex_fields.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "flex_fields/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'flex_fields'
+  s.version     = FlexFields::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = [ 'Kyle Crum' ]
+  s.email       = [ 'kyle.e.crum@gmail.com' ]
+  s.homepage    = 'http://github.com/stouset/twitter_bootstrap_form_for'
+  s.summary     = 'Rails form builder optimized for Twitter Bootstrap'
+  s.description = 'A custom Rails FormBuilder that assumes the use of Twitter Bootstrap'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- {test,spec}/*`.split("\n")
+  s.executables  = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency('activerecord', '>= 3.0')
+  s.add_dependency('activesupport', '>= 3.0')
+end

data/lib/flex_fields/base.rb

@@ -0,0 +1,86 @@
+module FlexFields
+  module Base
+  
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+  
+    module ClassMethods
+    
+      def flex_fields(options={})
+        
+        set_flex_options(options)
+        
+        serialize(self.flex_fields_column, Hash) unless self.serialized_attributes.keys.include?(self.flex_fields_column)
+      
+        include InstanceMethods
+        flex_accessor(options)
+    
+      end
+      
+      def set_flex_options(options)
+        
+        class_attribute :flex_fields_column unless self.respond_to?(:flex_fields_column) 
+        class_attribute :flex_fields_config unless self.respond_to?(:flex_fields_config)
+        
+        self.flex_fields_config ||= {} 
+        
+        if !self.flex_fields_column
+          column_name = options.delete(:column_name) || :flex
+          self.flex_fields_column = column_name.to_sym if column_name
+          self.flex_fields_config = options
+        else
+          self.flex_fields_config = flex_fields_config.merge(options)
+        end
+      end
+    
+      def flex_accessor(options)
+        options.each_pair do |name,type|
+          setter = (name.to_s + '=').to_sym
+          define_method(name) {self.read_flex_field(name)}
+          define_method(setter) {|val| self.write_flex_field(name, val)}
+        end
+      end
+    
+    end
+  
+    module InstanceMethods
+    
+      protected
+      
+        def type_for_flex_field(attribute)
+          self.flex_fields_config[attribute]
+        end
+
+        def write_flex_field (attribute, val)
+          attribute = attribute.to_sym
+          converted_val = convert_to_type(val, type_for_flex_field(attribute))
+          self[self.flex_fields_column][attribute] = converted_val
+          send("#{flex_fields_column}_will_change!")
+          return converted_val
+        end
+
+        def read_flex_field (attribute)
+          attribute = attribute.to_sym
+          converted_val = convert_to_type(self[self.flex_fields_column][attribute], type_for_flex_field(attribute))
+          return converted_val 
+        end
+
+      private
+    
+        def convert_to_type(val, type)
+          return val if val.kind_of?(type)
+        
+          begin
+            converter_class = "FlexAttributes::#{type}Converter".constantize
+          rescue #if no converter
+            raise ArgumentError.new("Unsupported type #{type}")
+          end
+      
+          return converter_class.convert(val)
+
+        end
+    
+    end
+  end
+end

data/lib/flex_fields/converter/array_converter.rb

@@ -0,0 +1,14 @@
+module FlexAttributes
+  class ArrayConverter
+      
+    def self.convert(val=nil)
+      return [] if val.nil?
+      if val.kind_of?(Array)
+        return val
+      else
+        return [val]
+      end
+    end
+    
+  end
+end

data/lib/flex_fields/converter/date_converter.rb

@@ -0,0 +1,19 @@
+module FlexAttributes
+  class DateConverter
+      
+    def self.convert(val=nil)
+      
+      if val.kind_of?(Date)
+        return val
+      else
+        begin
+          return Date.parse(val.to_s, true)
+        rescue ArgumentError
+          return nil
+        end
+      end
+      
+    end
+      
+  end
+end

data/lib/flex_fields/converter/date_time_converter.rb

@@ -0,0 +1,17 @@
+module FlexAttributes
+  class DateTimeConverter
+      
+    def self.convert(val=nil)
+      if val.kind_of?(DateTime)
+        return val
+      else
+        begin
+          return DateTime.parse(val.to_s, true)
+        rescue ArgumentError
+          return nil
+        end
+      end
+    end
+      
+  end
+end

data/lib/flex_fields/converter/float_converter.rb

@@ -0,0 +1,9 @@
+module FlexAttributes
+  class FloatConverter
+      
+    def self.convert(val=nil)
+      val.to_f
+    end
+      
+  end
+end

data/lib/flex_fields/converter/hash_converter.rb

@@ -0,0 +1,13 @@
+module FlexAttributes
+  class HashConverter
+      
+    def self.convert(val=nil)
+      if val.kind_of?(Hash)
+        return val
+      else
+        return nil
+      end
+    end
+      
+  end
+end

data/lib/flex_fields/converter/integer_converter.rb

@@ -0,0 +1,9 @@
+module FlexAttributes
+  class IntegerConverter
+      
+    def self.convert(val=nil)
+      val.nil? ? nil : val.to_i
+    end
+      
+  end
+end

data/lib/flex_fields/converter/string_converter.rb

@@ -0,0 +1,9 @@
+module FlexAttributes
+  class StringConverter
+      
+    def self.convert(val=nil)
+      val.to_s
+    end
+      
+  end
+end

data/lib/flex_fields/converter/time_converter.rb

@@ -0,0 +1,17 @@
+module FlexAttributes
+  class TimeConverter
+      
+    def self.convert(val=nil)
+      if val.kind_of?(Time)
+        return val
+      else
+        begin
+          return Time.parse(val.to_s)
+        rescue ArgumentError
+          return nil
+        end
+      end
+    end
+      
+  end
+end

data/lib/flex_fields/railtie.rb

@@ -0,0 +1,11 @@
+module FlexFields
+  if defined? Rails::Railtie
+    class Railtie < Rails::Railtie
+      initializer 'flex_fields.insert_into_active_record' do
+        ActiveSupport.on_load :active_record do
+          ActiveRecord::Base.send :include, FlexFields::Base
+        end
+      end
+    end
+  end
+end

data/lib/flex_fields/version.rb

@@ -0,0 +1,3 @@
+module FlexFields
+  VERSION = '1.0.0'
+end

data/lib/flex_fields.rb

@@ -0,0 +1,7 @@
+require 'flex_fields/version'
+require 'flex_fields/base'
+require 'flex_fields/railtie'
+# Load Converters
+Dir.entries("#{File.dirname(__FILE__)}/flex_fields/converter").each do |filename|
+  require "flex_fields/converter/#{filename.gsub('.rb', '')}" if filename =~ /\.rb$/
+end

data/spec/flex_attributes_spec.rb

@@ -0,0 +1,152 @@
+require 'spec_helper'
+
+describe "FlexAttributes" do
+  
+  it 'is a part of ActiveRecord::Base' do
+    SomeModel.should respond_to(:flex_fields)
+  end
+  
+  after do
+    reset_classes
+  end
+  
+  describe 'being declared in the model' do
+    
+    it 'uses a default column called flex' do
+      SomeModel.should_receive(:serialize).with(:flex, Hash)
+      SomeModel.flex_fields
+      SomeModel.flex_fields_column.should == :flex
+    end
+    
+    it 'can override the default column' do
+      SomeModel.should_receive(:serialize).with(:something, Hash)
+      SomeModel.flex_fields :column_name=>'something'
+      SomeModel.flex_fields_column.should == :something
+    end
+    
+    it 'creates getters and setters for each attribute specified' do
+      SomeModel.flex_fields :foo=>String, :bar=>Date
+      some_model = SomeModel.new
+      some_model.should respond_to(:foo)
+      some_model.should respond_to(:foo=)
+      some_model.should respond_to(:bar)
+      some_model.should respond_to(:bar=)
+    end
+    
+    it 'can initialize flex values via the constructor' do
+      SomeModel.flex_fields :foo=>String, :bar=>Integer
+      model = SomeModel.new(:foo=>'foo',:bar=>1)
+      model.foo.should == 'foo'
+      model.bar.should == 1
+    end
+    
+    it 'should inherit settings for subclasses' do
+      SomeModel.flex_fields :foo=>String, :column_name=>:something
+      InheritedModel.flex_fields :bar=>Integer
+      InheritedModel.flex_fields_column.should == :something
+      InheritedModel.flex_fields_config.should == {:foo=>String,:bar=>Integer}
+      inherited = InheritedModel.new
+      inherited.should respond_to(:foo)
+      inherited.should respond_to(:bar)
+    end
+    
+    it 'takes the colum name from the base class that calls flex_fields' do
+      SomeModel.flex_fields :column_name=>:some_column
+      InheritedModel.flex_fields :column_name=>:differet_column
+      InheritedModel.flex_fields_column.should == :some_column
+    end
+    
+  end
+  
+  describe 'conversions' do
+    
+    before do
+      SomeModel.flex_fields
+      @model = SomeModel.new
+    end
+    
+    it 'can convert arrays' do
+      @model.send(:convert_to_type,[1,2,3],Array).should == [1,2,3]
+      @model.send(:convert_to_type,1,Array).should == [1]
+    end
+    
+    it 'can convert dates' do
+      date_string = '1979-12-05'
+      date = Date.parse(date_string)
+      @model.send(:convert_to_type,date_string,Date).should == date
+      @model.send(:convert_to_type,date,Date).should == date
+      @model.send(:convert_to_type,'foo',Date).should be_nil
+    end
+    
+    it 'can convert date times' do
+      date_time_string = '1979-12-05T08:30:45Z'
+      date_time = DateTime.parse(date_time_string)
+      @model.send(:convert_to_type,date_time_string,DateTime).should == date_time
+      @model.send(:convert_to_type,date_time,DateTime).should == date_time
+      @model.send(:convert_to_type,'foo',DateTime).should be_nil
+    end
+    
+    it 'can convert floats' do
+      @model.send(:convert_to_type,3.14159,Float).should == 3.14159
+      @model.send(:convert_to_type,'3.14159',Float).should == 3.14159
+    end
+    
+    it 'can convert hashes' do
+      @model.send(:convert_to_type,{:foo=>'bar'},Hash).should == {:foo=>'bar'}
+      @model.send(:convert_to_type,'foobar',Hash).should be_nil
+    end
+    
+    it 'can convert integers' do
+      @model.send(:convert_to_type,1,Integer).should == 1
+      @model.send(:convert_to_type,'1',Integer).should == 1
+    end
+    
+    it 'can convert strings' do
+      @model.send(:convert_to_type,"string",String).should == "string"
+      @model.send(:convert_to_type,3.14159,String).should == "3.14159"
+    end
+    
+    it 'can convert times' do
+      time_string = "16:30"
+      time = Time.parse(time_string)
+      @model.send(:convert_to_type,time_string,Time).should == time
+      @model.send(:convert_to_type,time,Time).should == time
+      @model.send(:convert_to_type,'foo',Time).should be_nil
+    end
+    
+  end
+  
+  describe 'instance methods' do
+    
+    before do
+      SomeModel.flex_fields :foo=>String, :bar=>Integer, :column_name=>:something
+      @model = SomeModel.new
+    end
+    
+    it 'should return the flex column' do
+      @model.send(:flex_fields_column).should == :something
+    end
+    
+    it 'should return the correct flex type for an attribute' do
+      @model.send(:type_for_flex_field, :foo).should == String
+    end
+  
+    it 'can set and return flex values' do
+      @model.foo = "I am a string"
+      @model.bar = 5
+      @model.foo.should == "I am a string"
+      @model.bar.should == 5
+    end
+
+    it 'will save values properly' do
+      @model.bar = "6"
+      @model.foo = "foo"
+      @model.save!
+      saved_model = SomeModel.find(@model.id)
+      saved_model.bar.should == 6
+      saved_model.foo.should == "foo"
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'sqlite3'
+
+require 'flex_fields'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'active_record'
+require 'active_support'
+
+$:.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'flex_fields'
+
+ActiveRecord::Base.configurations = {'sqlite3' => {:adapter => 'sqlite3', :database => ':memory:'}}
+ActiveRecord::Base.establish_connection('sqlite3')
+ 
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :some_models do |t|
+    t.string :name
+    t.string :type
+    t.text   :flex
+    t.text   :something
+  end
+end
+
+ActiveRecord::Base.send(:include, FlexFields::Base)
+
+def reset_classes
+  Object.send(:remove_const, :SomeModel) rescue nil
+  Object.send(:remove_const, :InheritedModel) rescue nil
+  Object.const_set(:SomeModel, Class.new(ActiveRecord::Base))
+  Object.const_set(:InheritedModel, SomeModel)
+end
+ 
+reset_classes

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: flex_fields
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Kyle Crum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &3744860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *3744860
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &3744360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *3744360
+description: A custom Rails FormBuilder that assumes the use of Twitter Bootstrap
+email:
+- kyle.e.crum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.markdown
+- flex_fields.gemspec
+- lib/flex_fields.rb
+- lib/flex_fields/base.rb
+- lib/flex_fields/converter/array_converter.rb
+- lib/flex_fields/converter/date_converter.rb
+- lib/flex_fields/converter/date_time_converter.rb
+- lib/flex_fields/converter/float_converter.rb
+- lib/flex_fields/converter/hash_converter.rb
+- lib/flex_fields/converter/integer_converter.rb
+- lib/flex_fields/converter/string_converter.rb
+- lib/flex_fields/converter/time_converter.rb
+- lib/flex_fields/railtie.rb
+- lib/flex_fields/version.rb
+- spec/flex_attributes_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/stouset/twitter_bootstrap_form_for
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.14
+signing_key: 
+specification_version: 3
+summary: Rails form builder optimized for Twitter Bootstrap
+test_files:
+- spec/flex_attributes_spec.rb
+- spec/spec_helper.rb