json_serialize 1.0.0 → 2.0.0

data/Gemfile

@@ -4,10 +4,10 @@ source 'http://rubygems.org'
 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'
+group :development do
+  gem 'jeweler'
+  gem 'yard'
+  gem 'RedCloth', require: 'redcloth'
+  gem 'rspec'
+  gem 'sqlite3'
+end

data/Gemfile.lock

@@ -1,43 +1,38 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    RedCloth (4.2.3)
-    activemodel (3.0.1)
-      activesupport (= 3.0.1)
+    RedCloth (4.2.7)
+    activemodel (3.0.4)
+      activesupport (= 3.0.4)
       builder (~> 2.1.2)
-      i18n (~> 0.4.1)
-    activerecord (3.0.1)
-      activemodel (= 3.0.1)
-      activesupport (= 3.0.1)
-      arel (~> 1.0.0)
+      i18n (~> 0.4)
+    activerecord (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      arel (~> 2.0.2)
       tzinfo (~> 0.3.23)
-    activesupport (3.0.1)
-    arel (1.0.1)
-      activesupport (~> 3.0.0)
+    activesupport (3.0.4)
+    arel (2.0.8)
     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)
+    i18n (0.5.0)
+    jeweler (1.5.2)
+      bundler (~> 1.0.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)
+      rake
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    sqlite3 (1.3.3)
+    tzinfo (0.3.24)
+    yard (0.6.4)
 
 PLATFORMS
   ruby
@@ -48,4 +43,5 @@ DEPENDENCIES
   activesupport
   jeweler
   rspec
+  sqlite3
   yard

data/README.textile

@@ -1,7 +1,7 @@
 h1. json_serialize -- JSON serialization in ActiveRecord
 
 | *Author* | Tim Morgan |
-| *Version* | 1.0 (Oct 30, 2010) |
+| *Version* | 2.0 (Feb 21, 2011) |
 | *License* | Released under the MIT license. |
 
 h2. About
@@ -19,12 +19,12 @@ Firstly, add the gem to your Rails project's @Gemfile@:
 gem 'json_serialize'
 </code></pre>
 
-Then, extend your model with the @JsonSerialize@ module, and call the
+Then, include into your model the @JsonSerialize@ module, and call the
 @json_serialize@ method to indicate which fields should be serialized:
 
 <pre><code>
 class MyModel < ActiveRecord::Base
-  extend JsonSerialize
+  include JsonSerialize
   json_serialize :favorites, :preferences
 end
 </code></pre>

data/Rakefile

@@ -1,13 +1,15 @@
-require 'rake'
+require 'rubygems'
+require 'bundler'
 begin
-  require 'bundler'
-rescue LoadError
-  puts "Bundler is not installed; install with `gem install bundler`."
-  exit 1
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
+require 'rake'
 
-Bundler.require :default
-
+require 'jeweler'
 Jeweler::Tasks.new do |gem|
   gem.name = "json_serialize"
   gem.summary = %Q{Adds JSON serialization to ActiveRecord models}
@@ -15,17 +17,17 @@ Jeweler::Tasks.new do |gem|
   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
+Jeweler::RubygemsDotOrgTasks.new
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
 
+require 'yard'
 YARD::Rake::YardocTask.new('doc') do |doc|
   doc.options << "-m" << "textile"
   doc.options << "--protected"
+  doc.options << "--no-private"
   doc.options << "-r" << "README.textile"
   doc.options << "-o" << "doc"
   doc.options << "--title" << "json_serialize Documentation".inspect

data/VERSION

@@ -1 +1 @@
-1.0.0
+2.0.0

data/json_serialize.gemspec

@@ -1,58 +1,72 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{json_serialize}
-  s.version = "1.0.0"
+  s.version = "2.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.date = %q{2011-02-21}
   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"
+    "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"
+    ".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.rubygems_version = %q{1.5.2}
   s.summary = %q{Adds JSON serialization to ActiveRecord models}
   s.test_files = [
     "spec/json_serialize_spec.rb",
-     "spec/spec_helper.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"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<RedCloth>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
     else
-      s.add_dependency(%q<activesupport>, [">= 2.0"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<RedCloth>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
     end
   else
-    s.add_dependency(%q<activesupport>, [">= 2.0"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<RedCloth>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
   end
 end
 

data/lib/json_serialize.rb

@@ -2,27 +2,69 @@
 #
 # @example Basic usage
 #   class MyModel < ActiveRecord::Base
-#     extend JsonSerialize
+#     include JsonSerialize
 #     json_serialize :some_field
 #   end
 
 module JsonSerialize
+  extend ActiveSupport::Concern
 
-  # @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.
+  module ClassMethods
+    # @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)
+    def json_serialize(*fields)
+      fields.each do |field|
+        define_method field do
+          if instance_variable_defined?(field_ivar(field)) then
+            instance_variable_get field_ivar(field)
+          else
+            encoded = read_attribute(field)
+            decoded = encoded.nil? ? nil : ActiveSupport::JSON.decode(encoded)
+            instance_variable_set field_ivar(field), decoded
+            decoded
+          end
+        end
+  
+        define_method :"#{field}=" do |value|
+          write_attribute field, (value.nil? ? nil : ActiveSupport::JSON.encode(value))
+          instance_variable_set field_ivar(field), value
+        end
       end
 
-      define_method :"#{field}=" do |value|
-        write_attribute field, (value.nil? ? nil : ActiveSupport::JSON.encode(value))
+      define_method :serialize_json_values do
+        fields.each do |field|
+          if instance_variable_defined?(field_ivar(field)) then
+            send :"#{field}=", instance_variable_get(field_ivar(field))
+          end
+        end
       end
+      
+      define_method :reload_with_refresh_json_ivars do |*args|
+        res = reload_without_refresh_json_ivars *args
+        fields.each { |field| remove_instance_variable field_ivar(field) if instance_variable_defined?(field_ivar(field)) }
+        res
+      end
+      
+      define_method :update_with_refresh_json_ivars do |*args|
+        res = update_without_refresh_json_ivars(*args)
+        fields.each { |field| remove_instance_variable field_ivar(field) if instance_variable_defined?(field_ivar(field)) }
+        res
+      end
+      
+      before_validation :serialize_json_values
+      alias_method_chain :reload, :refresh_json_ivars
+      alias_method_chain :update, :refresh_json_ivars
+    end
+  end
+
+  module InstanceMethods
+    private
+
+    def field_ivar(name)
+      :"@_deserialized_#{name}"
     end
   end
 end

data/spec/json_serialize_spec.rb

@@ -1,43 +1,47 @@
 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
+    context "[getter]" do
       it "should JSON-decode the value" do
-        @object.set(ActiveSupport::JSON.encode({ foo: 'bar' }))
-        @object.field.should eql({ 'foo' => 'bar' })
+        require 'logger'
+        object = Json.create!
+        Json.update_all(data: '{"foo":"bar"}')
+        object.reload.data.should eql('foo' => 'bar')
       end
 
       it "should return nil if the value is nil" do
-        @object.set nil
-        @object.field.should be_nil
+        object = Json.create!
+        Json.update_all(data: nil)
+        object.reload.data.should be_nil
       end
     end
 
-    context "setter" do
+    context "[setter]" do
       it "should JSON-encode the value" do
-        @object.field = { foo: 'bar' }
-        @object.get.should eql({ foo: 'bar' }.to_json)
+        object = Json.create!(data: { foo: 'bar' })
+        object.send(:read_attribute, :data).should eql({ foo: 'bar' }.to_json)
       end
 
       it "should leave nil as nil" do
-        @object.field = nil
-        @object.get.should be_nil
+        object = Json.create!(data: nil)
+        object.send(:read_attribute, :data).should be_nil
+      end
+    end
+    
+    context "[database backing]" do
+      it "should back the instance object with the database" do
+        object = Json.create!(data: { foo: 'bar' })
+        object.data[:foo2] = 'bar2'
+        object.save!
+        object.data.should eql('foo' => 'bar', 'foo2' => 'bar2')
+      end
+      
+      it "should clear the in-memory reference on reload" do
+        object = Json.create!(data: { foo: 'bar' })
+        object.data[:foo2] = 'bar2'
+        object.reload
+        object.data.should eql('foo' => 'bar')
       end
     end
   end

data/spec/spec_helper.rb

@@ -5,6 +5,19 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'json_serialize'
 
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: 'test.sqlite'
+)
+
+class Json < ActiveRecord::Base
+  include JsonSerialize
+  json_serialize :data
+end
+
 RSpec.configure do |config|
-  
+  config.before(:each) do
+    Json.connection.execute "DROP TABLE IF EXISTS jsons"
+    Json.connection.execute "CREATE TABLE jsons (id INTEGER PRIMARY KEY ASC, data TEXT)"
+  end
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: json_serialize
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors: 
 - Tim Morgan
@@ -14,23 +10,86 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-30 00:00:00 -07:00
+date: 2011-02-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: activerecord
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+        version: "0"
   type: :runtime
   prerelease: false
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: RedCloth
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id007
 description: Adds to ActiveRecord the ability to JSON-serialize certain fields.
 email: git@timothymorgan.info
 executables: []
@@ -42,7 +101,6 @@ extra_rdoc_files:
 - README.textile
 files: 
 - .document
-- .gitignore
 - .rspec
 - Gemfile
 - Gemfile.lock
@@ -59,8 +117,8 @@ homepage: http://github.com/riscfuture/json_serialize
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -68,22 +126,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3149432936213936570
       segments: 
-      - 1
-      - 9
-      version: "1.9"
+      - 0
+      version: "0"
 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
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Adds JSON serialization to ActiveRecord models

data/.gitignore

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