acts_as_serializable 0.1.6 → 0.2.0

data/README.rdoc

@@ -8,12 +8,18 @@ A gem/rails plugin for handling versioning of serialization methods (to_xml, to_
 Uses the builder pattern for a one stop multi-format serialization method, which can be
 versioned in-class, in a module or in seperately managed class files.
 
+Works with Builder::XmlMarkup <= 2.1.2
+
 == Installation from source
 
   git clone git://github.com/birkirb/acts_as_serializable.git
   cd acts_as_serializable
   rake install
 
+=== Rails Plugin Installation
+
+  script/plugin install git://github.com/birkirb/acts_as_serializable.git
+
 === Gem Installation
 
   gem install birkirb-acts_as_serializable --source http://gems.github.com

data/Rakefile

@@ -12,8 +12,8 @@ begin
     s.homepage = %q{http://github.com/birkirb/acts_as_serializable}
     s.rubyforge_project = %q{serializable}
     s.rubygems_version = %q{1.3.1}
-    #s.required_rubygems_version = "1.3.1"
-    s.add_dependency(%q<jsonbuilder>, [">= 0.0.6"])
+    s.add_dependency(%q<builder>, ["<= 2.1.2"])
+    s.add_dependency(%q<jsonbuilder>, [">= 0.1.0"])
     s.add_dependency(%q<activesupport>, [">= 1.2"])
   end
 rescue LoadError
@@ -21,13 +21,12 @@ rescue LoadError
 end
 
 begin
-  require 'spec/rake/spectask'
+  require 'rspec/core/rake_task'
 
-  Spec::Rake::SpecTask.new('spec') do |t|
-    t.spec_opts = ["-f specdoc", "-c"]
-    t.spec_files = FileList['spec/*_spec.rb']
+  RSpec::Core::RakeTask.new('spec') do |t|
+    t.rspec_opts = ["-fd", "-c"]
+    t.pattern = 'spec/**/*_spec.rb'
   end
-
 rescue LoadError
   desc 'Spec rake task not available'
   task :spec do
@@ -35,44 +34,18 @@ rescue LoadError
   end
 end
 
-# begin
-#   require 'cucumber'
-#   require 'cucumber/rake/task'
-
-
-#   desc "Run Cucumber feature tests"
-#   Cucumber::Rake::Task.new(:features) do |t|
-#     t.cucumber_opts = "--format pretty" 
-#   end
-
-# rescue LoadError
-#   desc 'Cucumber rake task not available'
-#   task :features do
-#     abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
-#   end
-# end
-
 begin
   require 'spec/rake/spectask'
-# require 'cucumber'
-# require 'cucumber/rake/task'
   require 'spec/rake/verify_rcov'
 
   task :test do
     Rake::Task[:spec].invoke
-#   Rake::Task[:features].invoke
   end
 
   desc "Run tests with RCov"
   namespace :rcov do
     rm "coverage.data" if File.exist?("coverage.data")
 
-#   desc "Run Features with RCov"
-#   Cucumber::Rake::Task.new(:features) do |t|
-#     t.rcov = true
-#     t.rcov_opts = %w{ --exclude osx\/objc,gems\/,spec\/,features\/ --aggregate coverage.data}
-#     t.rcov_opts << %[-o "coverage"]
-#   end
 
     Spec::Rake::SpecTask.new(:spec) do |t|
       t.spec_opts = ["-f specdoc", "-c"]
@@ -84,7 +57,6 @@ begin
     desc "Run both specs and features to generate aggregated coverage"
     task :all do |t|
       Rake::Task["rcov:spec"].invoke
-#     Rake::Task["rcov:features"].invoke
     end
 
     RCov::VerifyTask.new(:verify => 'rcov:all') do |t|
@@ -132,4 +104,4 @@ rescue LoadError
   # Too bad
 end
 
-task :default => [:test]
+task :default => [:spec]

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.2.0

data/acts_as_serializable.gemspec

@@ -1,71 +1,64 @@
+# 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 = %q{acts_as_serializable}
-  s.version = "0.1.6"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Birkir A. Barkarson"]
-  s.date = %q{2009-06-18}
+  s.date = %q{2011-09-20}
   s.description = %q{Easy versioning of serialization methods}
   s.email = %q{birkirb@stoicviking.net}
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
   s.files = [
-    ".gitignore",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "acts_as_serializable.gemspec",
-     "init.rb",
-     "lib/acts_as_serializable.rb",
-     "lib/serializable/version.rb",
-     "lib/serializable/versions.rb",
-     "spec/acts_as_serializable_spec.rb",
-     "spec/app/serializations/test_rails_model/version_1_0_0.rb",
-     "spec/app/serializations/test_rails_model/version_1_5.rb",
-     "spec/app/serializations/test_rails_model/version_2_1.rb",
-     "spec/serializations/test_model/version_1_0_0.rb",
-     "spec/serializations/test_model/version_1_5.rb",
-     "spec/serializations/test_model/version_2_1.rb",
-     "spec/spec_helper.rb",
-     "spec/version_spec.rb",
-     "spec/versions_spec.rb"
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "acts_as_serializable.gemspec",
+    "init.rb",
+    "lib/acts_as_serializable.rb",
+    "lib/serializable/version.rb",
+    "lib/serializable/versions.rb",
+    "lib/serializable/xbuilder.rb",
+    "spec/acts_as_serializable_spec.rb",
+    "spec/app/serializations/test_rails_model/version_1_0_0.rb",
+    "spec/app/serializations/test_rails_model/version_1_5.rb",
+    "spec/app/serializations/test_rails_model/version_2_1.rb",
+    "spec/serializations/test_model/version_1_0_0.rb",
+    "spec/serializations/test_model/version_1_5.rb",
+    "spec/serializations/test_model/version_2_1.rb",
+    "spec/spec_helper.rb",
+    "spec/version_spec.rb",
+    "spec/versions_spec.rb"
   ]
-  s.has_rdoc = true
   s.homepage = %q{http://github.com/birkirb/acts_as_serializable}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{serializable}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Easy versioning of serialization methods}
-  s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/acts_as_serializable_spec.rb",
-     "spec/versions_spec.rb",
-     "spec/version_spec.rb",
-     "spec/serializations/test_model/version_1_0_0.rb",
-     "spec/serializations/test_model/version_2_1.rb",
-     "spec/serializations/test_model/version_1_5.rb",
-     "spec/app/serializations/test_rails_model/version_1_0_0.rb",
-     "spec/app/serializations/test_rails_model/version_2_1.rb",
-     "spec/app/serializations/test_rails_model/version_1_5.rb"
-  ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<jsonbuilder>, [">= 0.0.6"])
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<builder>, ["<= 2.1.2"])
+      s.add_runtime_dependency(%q<jsonbuilder>, [">= 0.1.0"])
       s.add_runtime_dependency(%q<activesupport>, [">= 1.2"])
     else
-      s.add_dependency(%q<jsonbuilder>, [">= 0.0.6"])
+      s.add_dependency(%q<builder>, ["<= 2.1.2"])
+      s.add_dependency(%q<jsonbuilder>, [">= 0.1.0"])
       s.add_dependency(%q<activesupport>, [">= 1.2"])
     end
   else
-    s.add_dependency(%q<jsonbuilder>, [">= 0.0.6"])
+    s.add_dependency(%q<builder>, ["<= 2.1.2"])
+    s.add_dependency(%q<jsonbuilder>, [">= 0.1.0"])
     s.add_dependency(%q<activesupport>, [">= 1.2"])
   end
 end
+

data/init.rb

@@ -1,2 +1,3 @@
 require 'acts_as_serializable'
+require 'serializable/xbuilder'
 ActiveRecord::Base.send(:include, Serializable)

data/lib/acts_as_serializable.rb

@@ -1,6 +1,7 @@
 require 'jsonbuilder'
 require 'active_support'
 require 'find'
+require 'serializable/version'
 
 module Serializable
   SERIALIZE_TO_VERSION_REGEXP = /^serialize_to_version_((:?\d+_?)+)$/
@@ -42,13 +43,16 @@ module Serializable
   module SingletonMethods
     def find_project_serialization_classes(project_path)
       klass_name = self.name
-      serialization_directory = File.join(project_path, 'serializations', klass_name.underscore)
-      Find.find(serialization_directory) do |path|
-        if File.file?(path) && versioned_klass = path.match(SERIALIZED_CLASS_NAME_REGEXP)
-          require path
-          klass = Serializations.const_get("#{klass_name}").const_get("Version_#{versioned_klass[1]}")
-          if klass && klass.respond_to?(:serialize)
-            define_local_serialization_method(versioned_klass[1])
+      serialization_directory = File.expand_path(File.join(project_path, 'serializations', klass_name.underscore))
+      puts serialization_directory.inspect
+      if File.exist?(serialization_directory)
+        Find.find(serialization_directory) do |path|
+          if File.file?(path) && versioned_klass = path.match(SERIALIZED_CLASS_NAME_REGEXP)
+            require path
+            klass = Serializations.const_get("#{klass_name}").const_get("Version_#{versioned_klass[1]}")
+            if klass && klass.respond_to?(:serialize)
+              define_local_serialization_method(versioned_klass[1])
+            end
           end
         end
       end
@@ -75,7 +79,7 @@ module Serializable
 
     def find_local_serialization_methods
       self.instance_methods.each do |method_name|
-        if method_name = method_name.match(SERIALIZE_TO_VERSION_REGEXP)
+        if method_name = SERIALIZE_TO_VERSION_REGEXP.match(method_name)
           @serialization_versions << Version.new(method_name[1])
         end
       end
@@ -83,9 +87,9 @@ module Serializable
     end
 
     def define_local_serialization_method(method_version)
-      class_eval <<-EOV
-        def serialize_to_version_#{method_version}(builder, options)
-          Serializations::#{self.name}::Version_#{method_version}.serialize(self, builder, options)
+      class_eval(<<-EOV, __FILE__, __LINE__)
+        def serialize_to_version_#{method_version}(builder, options, &block)
+          Serializations::#{self.name}::Version_#{method_version}.serialize(self, builder, options, &block)
         end
       EOV
       @serialization_versions << Version.new(method_version)
@@ -94,36 +98,37 @@ module Serializable
 
   # This module contains instance methods
   module InstanceMethods
-    def to_hash(options = {})
-      serialize(Builder::HashStructure.new, options)
+    def to_hash(options = {}, &block)
+      serialize(Builder::HashStructure.new, options, &block)
     end
 
-    def to_json(options = {})
-      serialize(Builder::JsonFormat.new, options).to_json
+    def to_json(options = {}, &block)
+      serialize(Builder::HashStructure.new, options, &block).to_json
     end
 
-    def to_xml(options = {})
-      serialize(Builder::XmlMarkup.new, options)
+    def to_xml(options = {}, &block)
+      serialize(Builder::XmlMarkup.new, options, &block)
     end
 
-    def serialize(builder, options = {})
+    def serialize(builder, options = {}, &block)
       if version_number = options[:version]
-        if version = self.class.serialization_versions.find_version(Version.new(version_number))
-          return self.send("serialize_to_version_#{version.to_s_underscored}", builder, options)
+        version = version_number.is_a?(Serializable::Version) ? version_number : Version.new(version_number)
+        if found_version = self.class.serialization_versions.find_version(version)
+          return self.send("serialize_to_version_#{found_version.to_s_underscored}", builder, options, &block)
         else
-          raise "Version #{version_number} given but no serialization method found"
+          raise "Version #{version} given but no serialization method found"
         end
       else
         if version = self.class.default_serialization_version
-          return self.send("serialize_to_version_#{version.to_s_underscored}", builder, options)
+          return self.send("serialize_to_version_#{version.to_s_underscored}", builder, options, &block)
         else
           raise "No serialization method found"
         end
       end
     end
 
-    def serialize_for(builder, options = {})
-      self.send(builder.serialization_method!, options)
+    def serialize_for(builder, options = {}, &block)
+      self.send(builder.serialization_method!, options, &block)
     end
   end
 

data/lib/serializable/versions.rb

@@ -1,3 +1,5 @@
+require 'serializable/version'
+
 module Serializable
   class Versions < Array
 

data/lib/serializable/xbuilder.rb

@@ -0,0 +1,27 @@
+module Serializable
+  class XBuilder < ::ActionView::TemplateHandler
+    include ActionView::TemplateHandlers::Compilable
+
+    def compile(template)
+      compiled_code = <<-CODE
+        format = params[:format]
+
+        if format && :json == format.to_sym
+          _set_controller_content_type(Mime::JSON)
+          xbuilder = ::Builder::HashStructure.new
+          #{template.source}
+          xbuilder.target!.to_json
+        else
+          _set_controller_content_type(Mime::XML)
+          xbuilder = ::Builder::XmlMarkup.new
+          #{template.source}
+          xbuilder.target!
+        end
+      CODE
+      compiled_code
+    end
+
+  end
+end
+
+ActionView::Template.register_template_handler(:xbuilder, Serializable::XBuilder)

data/spec/acts_as_serializable_spec.rb

@@ -8,7 +8,10 @@ class SerializableObject
   end
 
   def serialize_to_version_1_5(builder, options)
-    "This is version 1.5.0"
+    postfix = if block_given?
+      yield(builder)
+    end
+    "This is version 1.5.0#{postfix}"
   end
 
   def serialize_to_version_2_1(builder, options)
@@ -133,6 +136,13 @@ describe Serializable, 'when included in a class that has multiple versioned ser
 
       klass.to_xml.should == "This is version 1.5.0"
     end
+
+    it 'should pass on blocks' do
+      SerializableObject.default_serialization_version = Serializable::Version.new('1.5')
+      klass = SerializableObject.new
+
+      klass.to_xml { '.1' }.should == "This is version 1.5.0.1"
+    end
   end
 end
 
@@ -184,5 +194,12 @@ describe Serializable, 'when included in a class that has multiple serialization
       klass.to_json(:version => '1.5.0').should == "\"This is version 1.5.0 for TestRailsModel\""
       klass.to_hash(:version => '2.1.0').should == "This is version 2.1 for TestRailsModel"
     end
+
+    it 'should pass on blocks' do
+      TestModel.default_serialization_version = "1.5"
+      klass = TestModel.new
+
+      klass.to_hash { 'BlockedInsertion' }.should == "This is version 1.5.0 for BlockedInsertion"
+    end
   end
 end

data/spec/serializations/test_model/version_1_5.rb

@@ -2,7 +2,12 @@ module Serializations
   module TestModel
     class Version_1_5
       def self.serialize(test_model, builder, options)
-        "This is version 1.5.0 for #{test_model.class.name}"
+        if block_given?
+          klass = yield(builder)
+        else
+          klass = test_model.class.name
+        end
+        "This is version 1.5.0 for #{klass}"
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 require 'rubygems'
-require 'spec'
 
 ::RAILS_ROOT = File.join(File.dirname(__FILE__))
 $LOAD_PATH.push(File.join(::RAILS_ROOT, 'app'))

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_serializable
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Birkir A. Barkarson
@@ -9,29 +15,56 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-18 00:00:00 +09:00
+date: 2011-09-20 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: jsonbuilder
+  name: builder
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - <=
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jsonbuilder
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.6
-    version: 
+        hash: 27
+        segments: 
+        - 0
+        - 1
+        - 0
+        version: 0.1.0
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
         version: "1.2"
-    version: 
+  type: :runtime
+  version_requirements: *id003
 description: Easy versioning of serialization methods
 email: birkirb@stoicviking.net
 executables: []
@@ -41,7 +74,6 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
-- .gitignore
 - README.rdoc
 - Rakefile
 - VERSION
@@ -50,6 +82,7 @@ files:
 - lib/acts_as_serializable.rb
 - lib/serializable/version.rb
 - lib/serializable/versions.rb
+- lib/serializable/xbuilder.rb
 - spec/acts_as_serializable_spec.rb
 - spec/app/serializations/test_rails_model/version_1_0_0.rb
 - spec/app/serializations/test_rails_model/version_1_5.rb
@@ -62,38 +95,37 @@ files:
 - spec/versions_spec.rb
 has_rdoc: true
 homepage: http://github.com/birkirb/acts_as_serializable
+licenses: []
+
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: serializable
-rubygems_version: 1.3.1
+rubygems_version: 1.3.7
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Easy versioning of serialization methods
-test_files: 
-- spec/spec_helper.rb
-- spec/acts_as_serializable_spec.rb
-- spec/versions_spec.rb
-- spec/version_spec.rb
-- spec/serializations/test_model/version_1_0_0.rb
-- spec/serializations/test_model/version_2_1.rb
-- spec/serializations/test_model/version_1_5.rb
-- spec/app/serializations/test_rails_model/version_1_0_0.rb
-- spec/app/serializations/test_rails_model/version_2_1.rb
-- spec/app/serializations/test_rails_model/version_1_5.rb
+test_files: []
+

data/.gitignore

@@ -1,2 +0,0 @@
-coverage*
-pkg