json_serialize 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,25 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.bundle
+.rvmrc
+
+## PROJECT::DOCUMENTATION
+.yardoc
+doc

data/.rspec

@@ -0,0 +1 @@
+-cfs

data/Gemfile

@@ -0,0 +1,13 @@
+source 'http://rubygems.org'
+
+# DEPENDENCIES
+gem 'activerecord', require: 'active_record'
+gem 'activesupport', require: 'active_support/core_ext/object/try'
+
+# DEVELOPMENT
+gem 'jeweler'
+gem 'yard'
+gem 'RedCloth', require: 'redcloth'
+
+# TEST
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.3)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.1)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.2)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    tzinfo (0.3.23)
+    yard (0.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  activerecord
+  activesupport
+  jeweler
+  rspec
+  yard

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tim Morgan
+
+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.textile

@@ -0,0 +1,33 @@
+h1. json_serialize -- JSON serialization in ActiveRecord
+
+| *Author* | Tim Morgan |
+| *Version* | 1.0 (Oct 30, 2010) |
+| *License* | Released under the MIT license. |
+
+h2. About
+
+@json_serialize@ gives you the ability to JSON-encode data into ActiveRecord
+model fields. JSON is a more compact but less robust serialization than YAML.
+Only hashes, arrays, and primitives can be reliably encoded to database fields;
+other types may not decode properly or at all.
+
+h2. Installation and Usage
+
+Firstly, add the gem to your Rails project's @Gemfile@:
+
+<pre><code>
+gem 'json_serialize'
+</code></pre>
+
+Then, extend your model with the @JsonSerialize@ module, and call the
+@json_serialize@ method to indicate which fields should be serialized:
+
+<pre><code>
+class MyModel < ActiveRecord::Base
+  extend JsonSerialize
+  json_serialize :favorites, :preferences
+end
+</code></pre>
+
+More information can be found at the {JsonSerialize#json_serialize} method
+documentation.

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rake'
+begin
+  require 'bundler'
+rescue LoadError
+  puts "Bundler is not installed; install with `gem install bundler`."
+  exit 1
+end
+
+Bundler.require :default
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "json_serialize"
+  gem.summary = %Q{Adds JSON serialization to ActiveRecord models}
+  gem.description = %Q{Adds to ActiveRecord the ability to JSON-serialize certain fields.}
+  gem.email = "git@timothymorgan.info"
+  gem.homepage = "http://github.com/riscfuture/json_serialize"
+  gem.authors = [ "Tim Morgan" ]
+  gem.required_ruby_version = '>= 1.9'
+  gem.add_dependency "activesupport", ">= 2.0"
+end
+Jeweler::GemcutterTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+YARD::Rake::YardocTask.new('doc') do |doc|
+  doc.options << "-m" << "textile"
+  doc.options << "--protected"
+  doc.options << "-r" << "README.textile"
+  doc.options << "-o" << "doc"
+  doc.options << "--title" << "json_serialize Documentation".inspect
+  
+  doc.files = [ 'lib/**/*', 'README.textile' ]
+end
+
+task(default: :spec)

data/VERSION

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

data/json_serialize.gemspec

@@ -0,0 +1,58 @@
+# 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{json_serialize}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Morgan"]
+  s.date = %q{2010-10-30}
+  s.description = %q{Adds to ActiveRecord the ability to JSON-serialize certain fields.}
+  s.email = %q{git@timothymorgan.info}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "json_serialize.gemspec",
+     "lib/json_serialize.rb",
+     "spec/json_serialize_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/riscfuture/json_serialize}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9")
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Adds JSON serialization to ActiveRecord models}
+  s.test_files = [
+    "spec/json_serialize_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.0"])
+  end
+end
+

data/lib/json_serialize.rb

@@ -0,0 +1,28 @@
+# Adds the {#json_serialize} method to @ActiveRecord@ objects.
+#
+# @example Basic usage
+#   class MyModel < ActiveRecord::Base
+#     extend JsonSerialize
+#     json_serialize :some_field
+#   end
+
+module JsonSerialize
+
+  # @overload json_serialize(field, ...)
+  #   Marks one or more fields as JSON-serialized. These fields are stored in
+  #   the database as JSON and encoded/decoded automatically upon read/write.
+  #   @param [Symbol] field The database field to JSON-serialize.
+
+  def json_serialize(*fields)
+    fields.each do |field|
+      define_method field do
+        value = read_attribute(field)
+        value.nil? ? nil : ActiveSupport::JSON.decode(value)
+      end
+
+      define_method :"#{field}=" do |value|
+        write_attribute field, (value.nil? ? nil : ActiveSupport::JSON.encode(value))
+      end
+    end
+  end
+end

data/spec/json_serialize_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+module SpecSupport
+  class JsonSerializeTester
+    extend JsonSerialize
+    json_serialize :field
+    def read_attribute(field) @value end
+    def write_attribute(field, value) @value = value end
+    def get() @value end
+    def set(value) @value = value end
+  end
+end
+
+describe JsonSerialize do
+  before :each do
+    @object = SpecSupport::JsonSerializeTester.new
+  end
+
+  describe "#json_serialize" do
+    context "getter" do
+      it "should JSON-decode the value" do
+        @object.set(ActiveSupport::JSON.encode({ foo: 'bar' }))
+        @object.field.should eql({ 'foo' => 'bar' })
+      end
+
+      it "should return nil if the value is nil" do
+        @object.set nil
+        @object.field.should be_nil
+      end
+    end
+
+    context "setter" do
+      it "should JSON-encode the value" do
+        @object.field = { foo: 'bar' }
+        @object.get.should eql({ foo: 'bar' }.to_json)
+      end
+
+      it "should leave nil as nil" do
+        @object.field = nil
+        @object.get.should be_nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+Bundler.require :default, :test
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'json_serialize'
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: json_serialize
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-30 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+description: Adds to ActiveRecord the ability to JSON-serialize certain fields.
+email: git@timothymorgan.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- json_serialize.gemspec
+- lib/json_serialize.rb
+- spec/json_serialize_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/riscfuture/json_serialize
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 9
+      version: "1.9"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Adds JSON serialization to ActiveRecord models
+test_files: 
+- spec/json_serialize_spec.rb
+- spec/spec_helper.rb