ar_marshal_store 1.0.0

data/README.rdoc

@@ -0,0 +1,98 @@
+= ActiveRecord Marshal Store
+
+Rails/ActiveRecord 3 comes with a cool ActiveRecord::Store feature
+that allows for creating a fairly lightweight schema-less
+model. However, it uses YAML, which has poor performance and is just
+generally silly.
+
+This gem enhances ActiveRecord to store such things using the Marshal
+module which is pretty darn fast, compact and seemingly less flakey
+than Psych.
+
+== Usage
+
+You can call marshal_store similary to how you would previously have
+called store.
+
+  class FooModel < ActiveRecord::Base
+    # The old, YAML-based version would look like:
+    # store :extras, :accessors => :foo, :bar
+
+    # The new, marshal-based version would look like:
+    marshal_store :extras, :accessors => :foo, :bar
+  end
+
+In addition, you can also use the exposed marshal coder as a column
+coder, much like YamlCoder in serialize:
+
+  class FooModel < ActiveRecord::Base
+    # Used to serialize field as a hash via YAML
+    # serialize :field, Hash
+
+    # Now use marshal!
+    serialize :field, ArMarshalStore::NilFriendlyMarshal
+  end
+
+=== Ruby
+
+This gem has been tested with:
+
+* Ruby 1.8.7
+* Ruby 1.9.3
+
+If this works for you, great! If you use a different ruby, please let
+me know, and I will update this.
+
+=== Rails
+
+Add ar_marshal_store to your Gemfile.
+
+  gem 'ar_marshal_store', :git => 'git://github.com/hfwang/ar_marshal_store.git'
+
+The necessary code is included into ActiveRecord::Base automatically.
+
+=== Outside of Rails
+  require 'ar_marshal_store'
+  class MyModel < ActiveRecord::Base
+    include ArMarshalStore
+
+    # ... usage of ArMarshalStore here.
+
+  end
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright / License
+
+(2-clause BSD)
+
+Copyright (c) 2012, Hsiu-Fan Wang
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ar_marshal_store"
+    gem.summary = %Q{Use marshal to serialize things, similar to ActiveRecord::Store}
+    gem.description = %Q{Use marshal to serialize things, similar to ActiveRecord::Store}
+    gem.email = "hfwang@porkbuns.net"
+    gem.homepage = "http://github.com/hfwang/ar_marshal_store"
+    gem.authors = ["Hsiu-Fan Wang"]
+    gem.add_dependency('activerecord', '>= 3.1.0')
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/ar_marshal_store.gemspec

@@ -0,0 +1,43 @@
+# 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 = "ar_marshal_store"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Hsiu-Fan Wang"]
+  s.date = "2013-04-30"
+  s.description = "Use marshal to serialize things, similar to ActiveRecord::Store"
+  s.email = "hfwang@porkbuns.net"
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "ar_marshal_store.gemspec",
+    "lib/ar_marshal_store.rb",
+    "lib/ar_marshal_store/railtie.rb"
+  ]
+  s.homepage = "http://github.com/hfwang/ar_marshal_store"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Use marshal to serialize things, similar to ActiveRecord::Store"
+
+  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>, [">= 3.1.0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.1.0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.1.0"])
+  end
+end
+

data/lib/ar_marshal_store.rb

@@ -0,0 +1,46 @@
+module ArMarshalStore
+  class NilFriendlyMarshal
+    def initialize(opts = nil)
+      @opts = opts
+      @opts ||= { :default => Hash.new() }
+    end
+
+    def load(str)
+      if str.nil?
+        return default_value
+      else
+        Marshal.load(str) || default_value
+      end
+    end
+
+    def dump(str)
+      Marshal.dump(str)
+    end
+
+    def self.load(str)
+      ArMarshalStore::NilFriendlyMarshal::DEFAULT.load(str)
+    end
+
+    def self.dump(str)
+      ArMarshalStore::NilFriendlyMarshal::DEFAULT.dump(str)
+    end
+
+    private
+    def default_value
+      @opts[:default].duplicable? ? @opts[:default].dup : @opts[:default]
+    end
+  end
+
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def marshal_store(store_attribute, options={})
+      serialize(store_attribute, NilFriendlyMarshal)
+      store_accessor(store_attribute, options[:accessors]) if options.has_key? :accessors
+    end
+  end
+end
+
+ArMarshalStore::NilFriendlyMarshal::DEFAULT = ArMarshalStore::NilFriendlyMarshal.new
+
+require 'ar_marshal_store/railtie.rb' if defined?(Rails)

data/lib/ar_marshal_store/railtie.rb

@@ -0,0 +1,12 @@
+require 'ar_marshal_store'
+require 'rails'
+
+module ArMarshalStore
+  class Railtie < ::Rails::Railtie
+    initializer "ar_marshal_store.active_record" do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send :include, ArMarshalStore
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: ar_marshal_store
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Hsiu-Fan Wang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Use marshal to serialize things, similar to ActiveRecord::Store
+email: hfwang@porkbuns.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- README.rdoc
+- Rakefile
+- VERSION
+- ar_marshal_store.gemspec
+- lib/ar_marshal_store.rb
+- lib/ar_marshal_store/railtie.rb
+homepage: http://github.com/hfwang/ar_marshal_store
+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.24
+signing_key: 
+specification_version: 3
+summary: Use marshal to serialize things, similar to ActiveRecord::Store
+test_files: []