ar_serialized_array 0.1.0

data/README.markdown

@@ -0,0 +1,40 @@
+Serialize an array in one column.
+
+ - [] when not set
+ - `xxx_as_text` / `xxx_as_text=` accessors to edit in forms
+ - `:on_set` callback for cleanup
+ - stores NULL when given array was empty (all empty -> `IS NULL`)
+
+Install
+=======
+ - As Rails plugin: `script/plugin install git://github.com/grosser/ar_serialized_array.git `
+ - As gem: ` sudo gem install ar_serialized_array -s http://gemcutter.org `
+
+
+Usage
+=====
+
+    class User < ActiveRecord::Base
+      serialized_array :product_ids, :accessor => :product_ids_as_text, :on_set=>lambda{|x| x.map(&:to_i).uniq }
+    end
+
+    User.new.product_ids        # []
+
+    user.product_ids_as_text = "1, , 12323   , 23, 1"
+    user.product_ids            # [1, 12323, 23]
+    user.product_ids_as_text    # "1, 12323, 23"
+
+    f.text_area :product_ids_as_text
+
+    filled = User.all(:conditions => {:product_ids=>[1,3].to_yaml})
+    empty = User.all(:conditions => {:product_ids=>nil})
+
+TODO
+====
+ - add support for `user.product_ids << 1`
+
+Author
+======
+[Michael Grosser](http://pragmatig.wordpress.com)  
+grosser.michael@gmail.com  
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/Rakefile

@@ -0,0 +1,23 @@
+desc "Run all specs in spec directory"
+task :default do
+  options = "--colour --format progress --loadby --reverse"
+  files = FileList['spec/**/*_spec.rb']
+  system("spec #{options} #{files}")
+end
+
+begin
+  require 'jeweler'
+  project_name = 'ar_serialized_array'
+  Jeweler::Tasks.new do |gem|
+    gem.name = project_name
+    gem.summary = "Serialize an array in a column, [] when no set, xx_as_text accessors and more."
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.authors = ["Michael Grosser"]
+    gem.add_dependency ['activerecord']
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/ar_serialized_array.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ar_serialized_array}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2009-11-16}
+  s.email = %q{grosser.michael@gmail.com}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "ar_serialized_array.gemspec",
+     "init.rb",
+     "lib/ar_serialized_array.rb",
+     "spec/ar_serialized_array_spec.rb",
+     "spec/setup_test_model.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/grosser/ar_serialized_array}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Serialize an array in a column, [] when no set, xx_as_text accessors and more.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/setup_test_model.rb",
+     "spec/ar_serialized_array_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

data/init.rb

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

data/lib/ar_serialized_array.rb

@@ -0,0 +1,37 @@
+require 'activerecord'
+
+module ARSerializedArray
+  VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+  
+  def serialized_array(attr_name, options={})
+    options[:on_set] ||= lambda{|x|x}
+
+    # getter
+    define_method attr_name do
+      YAML.load(read_attribute(attr_name).to_s) || []
+    end
+
+    # setter
+    define_method "#{attr_name}=" do |value|
+      value = options[:on_set].call(value) || []
+      raise "Expected an Array, got: #{value.inspect}" unless value.is_a? Array
+      value = (value.empty? ? nil : value.to_yaml)
+      write_attribute attr_name, value
+    end
+
+    # accessors e.g. xxx_as_text
+    if options[:accessor]
+      #getter
+      define_method options[:accessor] do
+        send(attr_name) * ", "
+      end
+
+      #setter
+      define_method "#{options[:accessor]}=" do |value|
+        send "#{attr_name}=", value.to_s.split(',').reject(&:blank?).map(&:strip)
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:extend, ARSerializedArray)

data/spec/ar_serialized_array_spec.rb

@@ -0,0 +1,79 @@
+require "spec/spec_helper"
+
+describe 'ar_serialized_array' do
+  describe 'basics' do
+    it "is an empty array by default" do
+      UserPlain.new.product_ids.should == []
+    end
+
+    it "serializes on set" do
+      user = UserPlain.create!(:product_ids => [1, 2])
+      UserPlain.find(user.id).product_ids.should == [1, 2]
+    end
+
+    it "can save an empty array" do
+      user = UserPlain.create!(:product_ids => [])
+      UserPlain.find(user.id).product_ids.should == []
+    end
+
+    it "can save nil" do
+      user = UserPlain.create!(:product_ids => nil)
+      UserPlain.find(user.id).product_ids.should == []
+    end
+
+    it "stores empty arrays as NULL" do
+      user = UserPlain.create!(:product_ids => [])
+      UserPlain.first(:conditions => {:id => user.id, :product_ids => nil}).should == user
+    end
+
+    it "can search by array" do
+      user = UserPlain.create!(:product_ids => [1])
+      UserPlain.first(:conditions => {:id => user.id, :product_ids => [1].to_yaml}).should == user
+    end
+
+    it "raises when non-array is given" do
+      lambda{ UserPlain.create!(:product_ids => '') }.should raise_error
+    end
+  end
+
+  describe 'with accessor' do
+    it "can access the array as text" do
+      UserWithAccessor.new(:product_ids => [1,2,3]).product_ids_as_text.should == '1, 2, 3'
+    end
+
+    it "can set arrays via text" do
+      UserWithAccessor.new(:product_ids_as_text => '1, 2, 3').product_ids.should == ['1','2','3']
+    end
+
+    it "is symetric" do
+      text = '1, 2, 3'
+      UserWithAccessor.new(:product_ids_as_text => text).product_ids_as_text.should == text
+    end
+
+    it "accepts nil as empty" do
+      UserWithAccessor.new(:product_ids_as_text => nil).product_ids.should == []
+    end
+
+    it "is blank when unset" do
+      UserWithAccessor.new.product_ids_as_text.should == ''
+    end
+
+    it "is blank when empty" do
+      UserWithAccessor.new(:product_ids => []).product_ids_as_text.should == ''
+    end
+  end
+
+  describe 'with on_set' do
+    it "is used when storing normally" do
+      User.new(:product_ids => ['1','2','2']).product_ids.should == [1,2]
+    end
+
+    it "is used when storing through accessor" do
+      User.new(:product_ids_as_text => '1,2,2').product_ids.should == [1,2]
+    end
+  end
+
+  it "has a VERSION" do
+    ARSerializedArray::VERSION.should =~ /^\d+\.\d+\.\d+$/
+  end
+end

data/spec/setup_test_model.rb

@@ -0,0 +1,30 @@
+# connect
+ActiveRecord::Base.configurations = {"test" => {
+  :adapter => "sqlite3",
+  :database => ":memory:",
+}.with_indifferent_access}
+
+ActiveRecord::Base.establish_connection(:test)
+
+# create tables
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users do |t|
+    t.string :product_ids
+  end
+end
+
+# create models
+class User < ActiveRecord::Base
+  serialized_array :product_ids, :accessor => :product_ids_as_text, :on_set=>lambda{|x| x.map(&:to_i).uniq}
+end
+
+class UserWithAccessor < ActiveRecord::Base
+  self.table_name = 'users'
+  serialized_array :product_ids, :accessor => :product_ids_as_text
+end
+
+
+class UserPlain < ActiveRecord::Base
+  self.table_name = 'users'
+  serialized_array :product_ids
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH << "lib"
+require "init"
+require "spec/setup_test_model"

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: ar_serialized_array
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-16 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: grosser.michael@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- VERSION
+- ar_serialized_array.gemspec
+- init.rb
+- lib/ar_serialized_array.rb
+- spec/ar_serialized_array_spec.rb
+- spec/setup_test_model.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/grosser/ar_serialized_array
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Serialize an array in a column, [] when no set, xx_as_text accessors and more.
+test_files: 
+- spec/spec_helper.rb
+- spec/setup_test_model.rb
+- spec/ar_serialized_array_spec.rb