ar_serialized_array 0.2.4 → 0.3.0

data/Rakefile

@@ -1,80 +1,17 @@
-$LOAD_PATH << File.join(File.dirname(__FILE__),"..","lib")
-require 'lib/i18n_data'#TODO should not be necessary but is :/
-require 'yaml'
-
-desc "Run all specs in spec directory"
-task :default do |t|
-  options = "--colour --format progress --loadby --reverse"
-  files = FileList['spec/**/*_spec.rb']
-  system("spec #{options} #{files}")
-end
-
-desc "write all languages to output"
-task :all_languages do
-  I18nData.languages.keys.each do |lc|
-    `rake languages LANGUAGE=#{lc}`
-  end
-end
-
-desc "write languages to output/languages_{language}"
-task :languages do
-  raise unless language = ENV['LANGUAGE']
-  `mkdir output -p`
-  data = I18nData.languages(language.upcase)
-  File.open("output/languages_#{language.downcase}.yml",'w') {|f|f.puts data.to_yaml}
-end
-
-desc "write all countries to output"
-task :all_countries do
-  I18nData.languages.keys.each do |lc|
-    `rake countries LANGUAGE=#{lc}`
-  end
-end
-
-desc "write countries to output/countries_{language}"
-task :countries do
-  raise unless language = ENV['LANGUAGE']
-  `mkdir output -p`
-  data = I18nData.countries(language.upcase)
-  File.open("output/countries_#{language.downcase}.yml",'w') {|f|f.puts data.to_yaml}
-end
-
-desc "write example output, just to show off :D"
-task :example_output do
-  `mkdir example_output -p`
-  
-  #all names for germany, france, united kingdom and unites states
-  ['DE','FR','GB','US'].each do |cc|
-    names = I18nData.languages.keys.map do |lc|
-      begin
-        [I18nData.countries(lc)[cc], I18nData.languages[lc]]
-      rescue I18nData::NoOnlineTranslationAvaiable
-        nil
-      end
-    end
-    File.open("example_output/all_names_for_#{cc}.txt",'w') {|f|
-      f.puts names.reject(&:nil?).map{|x|x*" ---- "} * "\n"
-    }
-  end
-end
-
-desc "write cache for I18nData::FileDataProvider"
-task :write_cache_for_file_data_provider do
-  require 'i18n_data/file_data_provider'
-  require 'i18n_data/live_data_provider'
-  I18nData::FileDataProvider.write_cache(I18nData::LiveDataProvider)
-end
+task :default => :spec
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new {|t| t.spec_opts = ['--color']}
 
 begin
   require 'jeweler'
   project_name = 'ar_serialized_array'
   Jeweler::Tasks.new do |gem|
     gem.name = project_name
-    gem.summary = "country/language names and 2-letter-code pairs, in 85 languages"
+    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 ['activesupport']
+    gem.add_dependency ['activerecord']
   end
 
   Jeweler::GemcutterTasks.new

data/Readme.md

@@ -0,0 +1,50 @@
+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: `rails plugin install git://github.com/grosser/ar_serialized_array.git `
+ - As gem: ` sudo gem install ar_serialized_array `
+
+
+Usage
+=====
+
+    # basic / forms
+    class User < ActiveRecord::Base
+      serialized_array :product_ids, :accessor => :product_ids_as_text
+    end
+
+    <%= form_for @user do |f| %>
+      <%= f.text_field :product_ids_as_text %>
+    <% end %>
+
+    # set / get
+    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"
+
+    # find ...
+    filled = User.all(:conditions => {:product_ids=>[1,3].to_yaml})
+    empty = User.all(:conditions => {:product_ids=>nil})
+
+    # with cleanup (unique integers)
+    class User < ActiveRecord::Base
+      serialized_array :product_ids, :on_set=>lambda{|x| x.map(&:to_i).uniq }
+    end
+
+TODO
+====
+ - add support for `user.product_ids << 1`
+
+Author
+======
+[Michael Grosser](http://grosser.it)
+michael@grosser.it  
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.3.0

data/ar_serialized_array.gemspec

@@ -0,0 +1,47 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ar_serialized_array}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2011-01-17}
+  s.email = %q{grosser.michael@gmail.com}
+  s.files = [
+    "Rakefile",
+    "Readme.md",
+    "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.require_paths = ["lib"]
+  s.rubygems_version = %q{1.4.2}
+  s.summary = %q{Serialize an array in a column, [] when no set, xx_as_text accessors and more.}
+  s.test_files = [
+    "spec/ar_serialized_array_spec.rb",
+    "spec/setup_test_model.rb",
+    "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= 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 'active_record'
+
+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,84 @@
+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 nil when nil is saved" do
+      user = UserPlain.create!(:product_ids => nil)
+      UserPlain.first(:conditions => {:id => user.id, :product_ids => nil}).should == user
+    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,28 @@
+# connect
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+# 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

@@ -1,2 +1,4 @@
-$LOAD_PATH << 'lib'
-require 'i18n_data'
+require 'rubygems'
+$LOAD_PATH << "lib"
+require "init"
+require "spec/setup_test_model"

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ar_serialized_array
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  hash: 19
+  prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Michael Grosser
@@ -9,226 +15,76 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-16 00:00:00 +01:00
+date: 2011-01-17 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :runtime
+  version_requirements: *id001
 description: 
 email: grosser.michael@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.markdown
+extra_rdoc_files: []
+
 files: 
-- .gitignore
-- CHANGELOG
-- README.markdown
 - Rakefile
+- Readme.md
 - VERSION
-- cache/file_data_provider/countries-AF.txt
-- cache/file_data_provider/countries-AM.txt
-- cache/file_data_provider/countries-AR.txt
-- cache/file_data_provider/countries-AZ.txt
-- cache/file_data_provider/countries-BE.txt
-- cache/file_data_provider/countries-BG.txt
-- cache/file_data_provider/countries-BN.txt
-- cache/file_data_provider/countries-BR.txt
-- cache/file_data_provider/countries-BS.txt
-- cache/file_data_provider/countries-CA.txt
-- cache/file_data_provider/countries-CS.txt
-- cache/file_data_provider/countries-CY.txt
-- cache/file_data_provider/countries-DA.txt
-- cache/file_data_provider/countries-DE.txt
-- cache/file_data_provider/countries-DZ.txt
-- cache/file_data_provider/countries-EL.txt
-- cache/file_data_provider/countries-EN.txt
-- cache/file_data_provider/countries-EO.txt
-- cache/file_data_provider/countries-ES.txt
-- cache/file_data_provider/countries-ET.txt
-- cache/file_data_provider/countries-EU.txt
-- cache/file_data_provider/countries-FA.txt
-- cache/file_data_provider/countries-FI.txt
-- cache/file_data_provider/countries-FO.txt
-- cache/file_data_provider/countries-FR.txt
-- cache/file_data_provider/countries-GA.txt
-- cache/file_data_provider/countries-GL.txt
-- cache/file_data_provider/countries-GU.txt
-- cache/file_data_provider/countries-HE.txt
-- cache/file_data_provider/countries-HI.txt
-- cache/file_data_provider/countries-HR.txt
-- cache/file_data_provider/countries-HU.txt
-- cache/file_data_provider/countries-HY.txt
-- cache/file_data_provider/countries-ID.txt
-- cache/file_data_provider/countries-IS.txt
-- cache/file_data_provider/countries-IT.txt
-- cache/file_data_provider/countries-JA.txt
-- cache/file_data_provider/countries-KA.txt
-- cache/file_data_provider/countries-KK.txt
-- cache/file_data_provider/countries-KM.txt
-- cache/file_data_provider/countries-KN.txt
-- cache/file_data_provider/countries-KO.txt
-- cache/file_data_provider/countries-KU.txt
-- cache/file_data_provider/countries-LT.txt
-- cache/file_data_provider/countries-LV.txt
-- cache/file_data_provider/countries-MI.txt
-- cache/file_data_provider/countries-MK.txt
-- cache/file_data_provider/countries-ML.txt
-- cache/file_data_provider/countries-MN.txt
-- cache/file_data_provider/countries-MR.txt
-- cache/file_data_provider/countries-MS.txt
-- cache/file_data_provider/countries-MT.txt
-- cache/file_data_provider/countries-NB.txt
-- cache/file_data_provider/countries-NE.txt
-- cache/file_data_provider/countries-NL.txt
-- cache/file_data_provider/countries-NN.txt
-- cache/file_data_provider/countries-OC.txt
-- cache/file_data_provider/countries-PA.txt
-- cache/file_data_provider/countries-PL.txt
-- cache/file_data_provider/countries-PS.txt
-- cache/file_data_provider/countries-PT.txt
-- cache/file_data_provider/countries-RO.txt
-- cache/file_data_provider/countries-RU.txt
-- cache/file_data_provider/countries-RW.txt
-- cache/file_data_provider/countries-SK.txt
-- cache/file_data_provider/countries-SL.txt
-- cache/file_data_provider/countries-SO.txt
-- cache/file_data_provider/countries-SQ.txt
-- cache/file_data_provider/countries-SR.txt
-- cache/file_data_provider/countries-SV.txt
-- cache/file_data_provider/countries-SW.txt
-- cache/file_data_provider/countries-TA.txt
-- cache/file_data_provider/countries-TH.txt
-- cache/file_data_provider/countries-TI.txt
-- cache/file_data_provider/countries-TK.txt
-- cache/file_data_provider/countries-TL.txt
-- cache/file_data_provider/countries-TR.txt
-- cache/file_data_provider/countries-TT.txt
-- cache/file_data_provider/countries-UK.txt
-- cache/file_data_provider/countries-VE.txt
-- cache/file_data_provider/countries-VI.txt
-- cache/file_data_provider/countries-WA.txt
-- cache/file_data_provider/countries-WO.txt
-- cache/file_data_provider/countries-XH.txt
-- cache/file_data_provider/countries-ZU.txt
-- cache/file_data_provider/languages-AF.txt
-- cache/file_data_provider/languages-AM.txt
-- cache/file_data_provider/languages-AR.txt
-- cache/file_data_provider/languages-AZ.txt
-- cache/file_data_provider/languages-BE.txt
-- cache/file_data_provider/languages-BG.txt
-- cache/file_data_provider/languages-BR.txt
-- cache/file_data_provider/languages-BS.txt
-- cache/file_data_provider/languages-CA.txt
-- cache/file_data_provider/languages-CS.txt
-- cache/file_data_provider/languages-CY.txt
-- cache/file_data_provider/languages-DA.txt
-- cache/file_data_provider/languages-DE.txt
-- cache/file_data_provider/languages-EL.txt
-- cache/file_data_provider/languages-EN.txt
-- cache/file_data_provider/languages-EO.txt
-- cache/file_data_provider/languages-ES.txt
-- cache/file_data_provider/languages-ET.txt
-- cache/file_data_provider/languages-EU.txt
-- cache/file_data_provider/languages-FA.txt
-- cache/file_data_provider/languages-FI.txt
-- cache/file_data_provider/languages-FR.txt
-- cache/file_data_provider/languages-GA.txt
-- cache/file_data_provider/languages-GL.txt
-- cache/file_data_provider/languages-HE.txt
-- cache/file_data_provider/languages-HI.txt
-- cache/file_data_provider/languages-HR.txt
-- cache/file_data_provider/languages-HU.txt
-- cache/file_data_provider/languages-ID.txt
-- cache/file_data_provider/languages-IS.txt
-- cache/file_data_provider/languages-IT.txt
-- cache/file_data_provider/languages-JA.txt
-- cache/file_data_provider/languages-KO.txt
-- cache/file_data_provider/languages-LT.txt
-- cache/file_data_provider/languages-LV.txt
-- cache/file_data_provider/languages-MI.txt
-- cache/file_data_provider/languages-MK.txt
-- cache/file_data_provider/languages-MN.txt
-- cache/file_data_provider/languages-MR.txt
-- cache/file_data_provider/languages-MS.txt
-- cache/file_data_provider/languages-MT.txt
-- cache/file_data_provider/languages-NB.txt
-- cache/file_data_provider/languages-NL.txt
-- cache/file_data_provider/languages-NN.txt
-- cache/file_data_provider/languages-OC.txt
-- cache/file_data_provider/languages-PL.txt
-- cache/file_data_provider/languages-PS.txt
-- cache/file_data_provider/languages-PT.txt
-- cache/file_data_provider/languages-RO.txt
-- cache/file_data_provider/languages-RU.txt
-- cache/file_data_provider/languages-RW.txt
-- cache/file_data_provider/languages-SK.txt
-- cache/file_data_provider/languages-SL.txt
-- cache/file_data_provider/languages-SR.txt
-- cache/file_data_provider/languages-SV.txt
-- cache/file_data_provider/languages-TA.txt
-- cache/file_data_provider/languages-TH.txt
-- cache/file_data_provider/languages-TI.txt
-- cache/file_data_provider/languages-TR.txt
-- cache/file_data_provider/languages-TT.txt
-- cache/file_data_provider/languages-UK.txt
-- cache/file_data_provider/languages-VE.txt
-- cache/file_data_provider/languages-VI.txt
-- cache/file_data_provider/languages-WA.txt
-- cache/file_data_provider/languages-XH.txt
-- cache/file_data_provider/languages-ZU.txt
-- example_output/all_names_for_DE.txt
-- example_output/all_names_for_FR.txt
-- example_output/all_names_for_GB.txt
-- example_output/all_names_for_US.txt
-- i18n_data.gemspec
-- lib/i18n_data.rb
-- lib/i18n_data/file_data_provider.rb
-- lib/i18n_data/live_data_provider.rb
-- spec/i18n_data/file_data_provider_spec.rb
-- spec/i18n_data/live_data_provider_spec.rb
-- spec/i18n_data_spec.rb
+- 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
+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"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: country/language names and 2-letter-code pairs, in 85 languages
+summary: Serialize an array in a column, [] when no set, xx_as_text accessors and more.
 test_files: 
+- spec/ar_serialized_array_spec.rb
+- spec/setup_test_model.rb
 - spec/spec_helper.rb
-- spec/i18n_data/file_data_provider_spec.rb
-- spec/i18n_data/live_data_provider_spec.rb
-- spec/i18n_data_spec.rb