serialize-list-attribute 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/.idea

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+script: "bundle exec rspec"
+rvm:
+  - 1.9.3

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in serialize-list-attribute.gemspec
+gemspec
+
+group :test do
+  gem 'rake'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alexander Kaupanin
+
+MIT License
+
+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.md

@@ -0,0 +1,54 @@
+# Serialize attributes like a boss ![Build Status](https://travis-ci.org/simsalabim/serialize-list-attribute.png "Build Status")
+
+This gem adds helper methods to serialize AR model simple text attribute to an array or hash,
+handles the field updates and allows to perform per-item validation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'serialize-list-attribute'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install serialize-list-attribute
+
+## Usage
+Example: we store emails recipients as simple text field, but want to operate them as it was an array and,
+into the bargain, perform internal validation on create/update.
+
+In a model:
+```ruby
+class MailingList < ActiveRecord::Base
+  attr_accessible :recipients
+
+  include SerializeListAttribute
+  serialize_list_attributes :recipients, :recipients_emails_funnel_report, validation_method: :validate_for_email
+
+  # validation method which is to be invoked on each recipients array item
+  # consider email? method returns false if string is not a valid email address
+  def validate_for_email value, column
+    unless value.email?
+      errors.add column, 'Your validation error message'
+    end
+  end
+end
+```
+
+In a view:
+```ruby
+= semantic_form_for resource do |f|
+  = f.input :raw_recipients, as: :text
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/serialize-list-attribute.rb

@@ -0,0 +1,38 @@
+module SerializeListAttribute
+  extend ActiveSupport::Concern
+
+  included do
+    def self.serialize_list_attributes *contexts
+      options = contexts.extract_options!
+      as = options[:as].to_s.camelize.constantize || Array
+      before_save :synchronise_lists
+
+      contexts.each do |context|
+        serialize "#{context}", as
+        attr_writer "raw_#{context}"
+
+        define_method "raw_#{context}" do
+          instance_variable_get("@raw_#{context}") || instance_variable_set("@raw_#{context}", send("#{context}").join(', '))
+        end
+
+        define_method "build_#{context}" do
+          send("raw_#{context}").split(',').map(&:strip)
+        end
+
+        unless options[:validation_method].nil?
+          before_validation do
+            send("build_#{context}").each do |item|
+              send options[:validation_method], item, "raw_#{context}"
+            end
+          end
+        end
+      end
+
+      define_method :synchronise_lists do
+        contexts.each do |context|
+          send "#{context}=", send("build_#{context}")
+        end
+      end
+    end
+  end
+end

data/lib/serialize-list-attribute/version.rb

@@ -0,0 +1,3 @@
+module SerializeListAttribute
+  VERSION = '0.0.1'
+end

data/serialize-list-attribute.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'serialize-list-attribute/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'serialize-list-attribute'
+  s.version       = SerializeListAttribute::VERSION
+  s.authors       = ['Alexander Kaupanin']
+  s.email         = %w(kaupanin@gmail.com)
+  s.description   = %q{Manage text field attribute serialized as an array, hash, etc. Add per-item validation}
+  s.summary       = %q{Manage text field attribute serialized as an array, hash, etc. Add per-item validation}
+  s.homepage      = 'http://github.com/simsalabim/serialize-list-attribute'
+
+  s.files         = `git ls-files`.split($/)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = %w(lib)
+
+  s.add_development_dependency 'rspec', '~> 2.9'
+  s.add_development_dependency 'sqlite3'
+  s.add_runtime_dependency     'activerecord', '~> 3.0'
+end

data/spec/serialize_list_attribute_spec.rb

@@ -0,0 +1,45 @@
+require 'support/spec_helper'
+require 'support/active_record'
+require 'serialize-list-attribute'
+
+class MailingList < ActiveRecord::Base
+  attr_accessible :recipients
+
+  def validate_length item, column
+    errors.add column, 'Should be 5 characters or longer!' if item.length < 5
+  end
+end
+
+describe MailingList do
+
+  it 'should have plain text recipients attribute default' do
+    subject.recipients = 'cyberdyne_systems@model.101, the@terminator.com'
+    subject.recipients.is_a?(String).should be_true
+  end
+
+  it 'should have recipients attribute serialized into an array if the gem is used with defaults' do
+    subject.class.send :include, SerializeListAttribute
+    subject.class.send :serialize_list_attributes, :recipients
+    subject.recipients = %w(cyberdyne_systems@model.101 the@terminator.com)
+
+    subject.recipients.value.is_a?(Array).should be_true
+    subject.should have(:no).errors_on(:raw_recipients)
+  end
+
+  it 'should have recipients attribute serialized into a hash if the gem is configured properly' do
+    subject.class.send :include, SerializeListAttribute
+    subject.class.send :serialize_list_attributes, :recipients, as: :hash
+    subject.recipients = { person: 'cyberdyne_systems@model.101', nickname: 'the@terminator.com' }
+
+    subject.recipients.value.is_a?(Hash).should be_true
+    subject.should have(:no).errors_on(:raw_recipients)
+  end
+
+  it 'should validate each recipients attribute particle if the gem is configured to do so' do
+    subject.class.send :include, SerializeListAttribute
+    subject.class.send :serialize_list_attributes, :recipients, validation_method: :validate_length
+
+    subject.raw_recipients = 'arnie, 12'
+    subject.should have(1).error_on(:raw_recipients)
+  end
+end

data/spec/support/active_record.rb

@@ -0,0 +1,27 @@
+require 'active_record'
+
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+
+ActiveRecord::Migration.create_table :mailing_lists do |t|
+  t.text :recipients
+end
+
+module ActiveModel::Validations
+  # Extension to enhance `should have` on AR Model instances.  Calls
+  # model.valid? in order to prepare the object's errors object.
+  #
+  # You can also use this to specify the content of the error messages.
+  #
+  # @example
+  #
+  #     model.should have(:no).errors_on(:attribute)
+  #     model.should have(1).error_on(:attribute)
+  #     model.should have(n).errors_on(:attribute)
+  #
+  #     model.errors_on(:attribute).should include("can't be blank")
+  def errors_on(attribute)
+    self.valid?
+    [self.errors[attribute]].flatten.compact
+  end
+  alias :error_on :errors_on
+end

data/spec/support/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: serialize-list-attribute
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Alexander Kaupanin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Manage text field attribute serialized as an array, hash, etc. Add per-item
+  validation
+email:
+- kaupanin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/serialize-list-attribute.rb
+- lib/serialize-list-attribute/version.rb
+- serialize-list-attribute.gemspec
+- spec/serialize_list_attribute_spec.rb
+- spec/support/active_record.rb
+- spec/support/spec_helper.rb
+homepage: http://github.com/simsalabim/serialize-list-attribute
+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'
+      segments:
+      - 0
+      hash: 69075439
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 69075439
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Manage text field attribute serialized as an array, hash, etc. Add per-item
+  validation
+test_files:
+- spec/serialize_list_attribute_spec.rb
+- spec/support/active_record.rb
+- spec/support/spec_helper.rb