fancy_serializer 0.0.1

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+
+gem "rails", "3.1.0"
+
+# In case you're encouterting weird behavior,
+# please test if it works with old Rails.
+#gem "rails", "3.0.10"
+
+gem "sqlite3"
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/MIT-LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+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

@@ -0,0 +1,29 @@
+Builds on top of Rails serialize method to create accessors for your serialized fields.
+Please read this post as <a href="http://gregmoreno.ca/preventing-model-explosion-via-rails-serialization/">I explain my motivation</a> behind this.
+
+Basically, it lets you do the following in your ActiveRecord models.
+
+{% highlight ruby %}
+
+class User
+  serializeable :preferences, { :show_email => false }
+end
+
+u = User.new :show_email => true
+u.show_email
+=> true
+
+u = User.new
+u.show_email
+=> false
+u.show_email = true
+=> true
+
+u = User.new :show_email => true
+u.save
+
+u = User.find(u)
+u.show_email
+=> true
+
+{% endhighlight %}

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AttributeSerializer'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/fancy_serializer.rb

@@ -0,0 +1,71 @@
+module FancySerializer
+
+  module ClassMethods
+    # class User
+    #   serializeable :preferences, { :show_email => false }
+    # end
+    #
+    # u = User.new :show_email => true
+    # u.show_email
+    # => true
+    #
+    # u = User.new
+    # u.show_email
+    # => false
+    # u.show_email = true
+    # => true
+    #
+    # u = User.find(1)
+    # u.show_email
+    # => true or false
+
+    def serializeable(serialized, serialized_accessors={})  
+      serialize serialized, serialized_accessors.class
+
+      serialized_attr_accessor serialized, serialized_accessors
+      serialized_attr_sanitizer serialized
+    end
+
+    # Creates the accessors
+    def serialized_attr_accessor(serialized, accessors)
+      define_method("memoized_#{serialized}") do
+        if self[serialized].blank?
+          self[serialized] = accessors.clone
+        else
+          self[serialized]
+        end
+      end
+
+      after_initialize "memoized_#{serialized}"
+
+      accessors.keys.each do |k|
+        define_method("#{k}") do
+          self.send("memoized_#{serialized}")[k]
+        end
+
+        define_method("#{k}=") do |value|
+          self.send("memoized_#{serialized}")[k] = value
+        end
+      end
+    end
+
+    # Helper for removing the serialized field in your queries
+    # You have to call +sanitize_serialize_attributes+ explicitly
+    def serialized_attr_sanitizer(serialized)
+      sanitizer = lambda { |attributes|
+        sanitized = attributes.clone
+        sanitized.delete(serialized)
+        sanitized
+      }
+
+      self.class.send(:define_method, "sanitize_serialized_attributes", sanitizer) 
+    end
+
+  end # ClassMethods
+
+end
+
+class ActiveRecord::Base
+  extend FancySerializer::ClassMethods
+end
+

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: fancy_serializer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Greg Moreno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-07 00:00:00.000000000 -07:00
+default_executable: 
+dependencies: []
+description: Please read this post http://gregmoreno.ca/preventing-model-explosion-via-rails-serialization/
+  for my motivation behind this gem
+email: rubyoncloud@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/fancy_serializer.rb
+- MIT-LICENSE.txt
+- Rakefile
+- Gemfile
+- README
+has_rdoc: true
+homepage: http://gregmoreno.ca/preventing-model-explosion-via-rails-serialization/
+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.6.2
+signing_key: 
+specification_version: 3
+summary: ActiveRecord method to create accessors for your serialized fields.
+test_files: []