active_model_archive 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--format nested
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in active_model_archive.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/active_model_archive.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "active_model_archive/version"
+
+Gem::Specification.new do |s|
+  s.name        = "active_model_archive"
+  s.version     = ActiveModelArchive::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Grant Rodgers"]
+  s.email       = ["grantr@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Dump and restore activemodel objects}
+  s.description = %q{Adds dump and restore functionality to activemodel classes}
+
+  s.rubyforge_project = "active_model_archive"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_dependency('activesupport', '~> 3')
+  s.add_dependency('yajl-ruby', '>= 0')
+  s.add_development_dependency('rspec', '~> 2')
+end

data/lib/active_model_archive/version.rb

@@ -0,0 +1,3 @@
+module ActiveModelArchive
+  VERSION = "0.0.1"
+end

data/lib/active_model_archive.rb

@@ -0,0 +1,166 @@
+require 'zlib'
+require 'active_support/concern'
+
+module ActiveModel
+  module Archive
+    extend ActiveSupport::Concern
+
+    MAGIC = 42098
+    CURRENT_VERSION = 1
+    SUPPORTED_VERSIONS = [1]
+
+    # dump file format:
+    # version 1:
+    #
+    # magic 4 bytes
+    # version 4 bytes
+    # 
+    # record length 4 bytes
+    # record + \n
+    # crc 4 bytes
+    # record length 4 bytes
+    # record + \n
+    # crc 4 bytes
+    # ...
+    #
+    # null 4 bytes
+    # record count 4 bytes
+    # magic 4 bytes
+    #
+
+    module ClassMethods
+      # Dump records to a stream.
+      # uses find_each without query params
+      # uses paginated_each with query params
+      # executes the block with each dumped record if given
+      # the block can be used to log progress
+      def dump!(stream, query_params={}, &block)
+        # set the encoding so we can write packed ints
+        stream.set_encoding("ASCII-8BIT")
+
+        archive_write_int(stream, MAGIC)
+        archive_write_int(stream, CURRENT_VERSION)
+
+        count = 0
+        encoder = Yajl::Encoder.new
+
+        writer = lambda do |json|
+          # write size, record, and crc
+          archive_write_int(stream, json.bytesize)
+          stream.write(json)
+          archive_write_int(stream, Zlib::crc32(json))
+          count += 1
+        end
+
+        if query_params.blank?
+          find_each do |object|
+            encoder.encode(object.as_archive, nil, &writer)
+            block.call(object) if block_given?
+          end
+        else
+          paginated_each(query_params) do |object|
+            encoder.encode(object.as_archive, nil, &writer)
+            block.call(object) if block_given?
+          end
+        end
+
+        archive_write_int(stream, 0)
+        archive_write_int(stream, count)
+        archive_write_int(stream, MAGIC)
+
+        stream.flush
+        return count
+      end
+
+      # Restore records from a stream.
+      # require attributes= and save accepting :validate option
+      # set :check true to only check the archive and not restore. if no exceptions are thrown, archive is valid.
+      # set :validate true to validate records as they are saved
+      # executes the block with each restored record if given
+      # the block can be used to log progress and warn about invalid objects
+      def restore!(stream, options={}, &block)
+        # check magic byte
+        magic = archive_read_int(stream)
+        raise "Not an archive stream" unless magic == MAGIC
+
+        # check version byte
+        version = archive_read_int(stream)
+        raise "Unsupported version #{version}" unless SUPPORTED_VERSIONS.include?(version)
+
+        count = 0
+        parser = Yajl::Parser.new
+
+        if options[:check]
+          # if we are just checking, increment but do not create anything
+          parser.on_parse_complete = lambda do |hash|
+            count += 1
+          end
+        else
+          # for each hash read, create an object
+          parser.on_parse_complete = lambda do |hash|
+            o = from_archive(hash)
+            o.save(:validate => !!options[:validate])
+            block.call(o) if block_given?
+            count += 1
+          end
+        end
+
+        # loop through records until a null is read
+        record_size = archive_read_int(stream)
+        while record_size != 0
+          json = stream.read(record_size)
+          crc = archive_read_int(stream)
+          raise "Invalid CRC at #{stream.pos-1}" unless crc == Zlib::crc32(json)
+          parser << json
+          record_size = archive_read_int(stream)
+        end
+
+        record_count = archive_read_int(stream)
+        magic = archive_read_int(stream)
+        raise "Unexpected end of archive file" unless magic == MAGIC
+        raise "Record counts didn't match: #{record_count} in stream, #{count} read" unless record_count == count
+
+        return count
+      end
+
+      # returns true if the archive is valid
+      def valid_archive?(stream)
+        begin
+          restore!(stream, :check => true)
+        rescue
+          return false
+        end
+        true
+      end
+
+      # generates an object from the archived hash
+      def from_archive(hash)
+        new.tap do |o|
+          o.id = hash.keys.first
+          o.attributes = hash.values.first[model_name.element]
+        end
+      end
+
+      private
+
+      def archive_read_int(stream)
+        stream.read(4).unpack("N").first
+      end
+
+      def archive_write_int(stream, int)
+        stream.write([int].pack("N"))
+      end
+    end
+  
+    # instance method to return archived hash
+    def as_archive
+      # force include_root_in_json
+      # allows archives to include multiple object types
+      if include_root_in_json
+        {id => as_json}
+      else
+        {id => {self.class.model_name.element => as_json}}
+      end
+    end
+  end
+end

data/spec/archive_spec.rb

@@ -0,0 +1,3 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_model_archive'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: active_model_archive
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Grant Rodgers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-03-09 00:00:00.000000000 -08:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &14070060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14070060
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &14069320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *14069320
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &14068620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: *14068620
+description: Adds dump and restore functionality to activemodel classes
+email:
+- grantr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Rakefile
+- active_model_archive.gemspec
+- lib/active_model_archive.rb
+- lib/active_model_archive/version.rb
+- spec/archive_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ''
+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: active_model_archive
+rubygems_version: 1.6.0
+signing_key: 
+specification_version: 3
+summary: Dump and restore activemodel objects
+test_files:
+- spec/archive_spec.rb
+- spec/spec_helper.rb