packed-model 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "jeweler", "~> 1.8.4"
+  gem "rcov", ">= 0"
+  gem "rspec", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    rake (10.0.4)
+    rcov (1.0.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.8.4)
+  rcov
+  rdoc (~> 3.12)
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Doug Youch
+
+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.rdoc

@@ -0,0 +1,19 @@
+= packed-model
+
+Ruby library for storing model data in their binary format
+
+== Contributing to packed-model
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Doug Youch. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  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'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "packed-model"
+  gem.homepage = "http://github.com/dyouch5@yahoo.com/packed-model"
+  gem.license = "MIT"
+  gem.summary = "PackedModel stores model data in a binary string"
+  gem.description = "Used to minimize storage space required to store list of data"
+  gem.email = "doug@sessionm.com"
+  gem.authors = ["Doug Youch"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "packed-model #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/packed_model.rb

@@ -0,0 +1,4 @@
+require 'packed_model/errors'
+require 'packed_model/base'
+require 'packed_model/list'
+

data/lib/packed_model/base.rb

@@ -0,0 +1,247 @@
+module PackedModel
+  class Base
+    def self.fields
+      []
+    end
+
+    def fields
+      self.class.fields
+    end
+
+    def self.keys
+      []
+    end
+
+    def self.all_field_options
+      {}
+    end
+
+    def self.field_options(key)
+      all_field_options[key.to_sym]
+    end
+
+    def self.field_index(key)
+      field_options(key)[:index]
+    end
+
+    def keys
+      self.class.keys
+    end
+
+    def self.fixed_width?
+      true
+    end
+
+    def fixed_width?
+      self.class.fixed_width?
+    end
+
+    def self.attribute(name, options={}, &block)
+      options[:name] = name.to_sym
+      raise "duplicate field name #{name}" if self.keys.include?(options[:name])
+      options[:index] = self.fields.size
+      options[:type] ||= :string
+      case options[:type]
+      when :string
+        options[:strip] = true
+        options[:pack_directive] = 'Z*' # null terminated string
+      when :integer, :int
+        options[:default] ||= 0 # pack 'N' directive requires a value for an integer
+        options[:bytesize] = 4
+        options[:pack_directive] = 'N' # network byte order
+      when :char
+        options[:size] ||= 1
+        options[:bytesize] = options[:size]
+        options[:pack_directive] = "a#{options[:size]}"
+      when :marker
+        raise "missing value for marker" unless options[:value]
+        options[:default] = options[:value]
+        options[:bytesize] = 4
+        options[:pack_directive] = 'N' # network byte order
+      when :custom
+        raise "missing pack_directive for #{name}" unless options[:pack_directive]
+      else
+        raise "Unknown type #{options[:type]}"
+      end
+
+      class_eval do
+        attrs = self.fields << options
+        ks = self.keys << options[:name]
+        defaults = self.default_values << options[:default]
+        ps = self.pack_string << options[:pack_directive]
+        kopts = self.all_field_options.merge name.to_sym => options
+
+        class << self; self end.send(:define_method, "fields") do
+          attrs
+        end
+        class << self; self end.send(:define_method, "keys") do
+          ks
+        end
+        class << self; self end.send(:define_method, "default_values") do
+          defaults
+        end
+        class << self; self end.send(:define_method, "pack_string") do
+          ps
+        end
+        class << self; self end.send(:define_method, "all_field_options") do
+          kopts
+        end
+
+        if self.fixed_width? && options[:bytesize].nil?
+          class << self; self end.send(:define_method, "fixed_width?") do
+            false
+          end
+          class << self; self end.send(:define_method, "bytesize") do
+            nil
+          end
+        end
+
+        if self.fixed_width?
+          bs = self.bytesize + options[:bytesize]
+          class << self; self end.send(:define_method, "bytesize") do
+            bs
+          end
+        end
+      end
+
+      method_src = <<-METHOD
+        def #{name}
+          @values[#{options[:index]}] || #{options[:default].inspect}
+        end
+        METHOD
+
+      case options[:type]
+      when :string, :char
+        method_src << <<-METHOD
+        def #{name}=(val)
+          val = val.nil? ? nil : val.to_s
+          @changed = @changed || @values[#{options[:index]}] != val
+          @values[#{options[:index]}] = val
+        end
+        METHOD
+      when :integer, :int
+        method_src << <<-METHOD
+        def #{name}=(val)
+          val = val.nil? ? nil : val.to_i
+          @changed = @changed || @values[#{options[:index]}] != val
+          @values[#{options[:index]}] = val
+        end
+        METHOD
+      when :custom
+        if options[:filter].is_a?(Symbol) || options[:filter].is_a?(String)
+          method_src << <<-METHOD
+          def #{name}=(val)
+            val = val.nil? ? nil : val.#{options[:filter]}
+            @changed = @changed || @values[#{options[:index]}] != val
+            @values[#{options[:index]}] = val
+          end
+          METHOD
+        elsif options[:filter] ||= block
+          method_src << <<-METHOD
+          def #{name}=(val)
+            val = val.nil? ? nil : self.class.field_options(#{name.inspect})[:filter].call(val)
+            @changed = @changed || @values[#{options[:index]}] != val
+            @values[#{options[:index]}] = val
+          end
+          METHOD
+        else
+          method_src << <<-METHOD
+          def #{name}=(val)
+            @changed = @changed || @values[#{options[:index]}] != val
+            @values[#{options[:index]}] = val
+          end
+          METHOD
+        end
+      end
+
+      self.class_eval method_src, __FILE__, __LINE__
+    end
+
+    def initialize(values=nil)
+      case values
+      when String
+        raise InvalidDataException.new("fixed width model expected #{self.bytesize} but got #{values.bytesize}") if self.fixed_width? && self.bytesize != values.bytesize
+        self.unpack values
+      when Hash
+        @changed = true
+        @values = []
+        values.each do |k, v|
+          send("#{k}=", v) if self.class.field_options(k)
+        end
+        # set default values
+        fields.each_with_index do |field, idx|
+          @values[idx] ||= self.class.default_values[idx]
+        end
+      when NilClass
+        @changed = true
+        @values = self.class.default_values.dup
+      else
+        raise InvalidDataException.new("invalid values")
+      end
+    end
+
+    def values
+      @values
+    end
+
+    def changed?
+      !! @changed
+    end
+
+    def changed!
+      @changed = true
+    end
+
+    def not_changed!
+      @changed = false
+    end
+
+    def to_hash
+      Hash[self.keys.zip @values]
+    end
+    alias to_h to_hash
+
+    def pack
+      @values.pack self.class.pack_string
+    end
+
+    def bytesize
+      self.class.fixed_width? ? self.class.bytesize : (@bytesize ||= self.pack.bytesize)
+    end
+    alias size bytesize
+
+    def unpack(str)
+      @values = str.unpack(self.class.pack_string)
+      self.fields.each do |field|
+        case field[:type]
+        when :string
+          if @values[field[:index]].empty?
+            @values[field[:index]] = nil
+          else
+            @values[field[:index]].strip!
+          end
+        when :char
+          @values[field[:index]].strip! if field[:strip]
+        when :marker
+          marker_value = @values[field[:index]]
+          raise BadMarkerException.new("unpack failed, invalid marker value (#{marker_value}) expected #{field[:value]}") unless marker_value == field[:value]
+        end
+      end
+    end
+
+    private
+
+    def self.default_values
+      []
+    end
+
+    def self.bytesize
+      0
+    end
+
+    def self.pack_string
+      ""
+    end
+  end
+end
+

data/lib/packed_model/errors.rb

@@ -0,0 +1,5 @@
+module PackedModel
+  class BadMarkerException < Exception; end
+  class InvalidDataException < Exception; end
+  class InvalidPackedModelException < Exception; end
+end

data/lib/packed_model/list.rb

@@ -0,0 +1,126 @@
+module PackedModel
+  class List
+    include Enumerable
+
+    def initialize(row_class, values=nil)
+      raise InvalidPackedModelException.new("row_class must be fixed width") unless row_class.fixed_width?
+      @row_class = row_class
+      @buffer = values
+    end
+
+    # the data in each row is only unpacked when it is accessed from here
+    def [](idx)
+      if (row = rows[idx]).is_a?(String)
+        row = rows[idx] = @row_class.new(row)
+      end
+      row
+    end
+
+    def []=(idx, row)
+      row.changed!
+      rows[idx] = row
+    end
+
+    def <<(row)
+      row.changed!
+      rows << row
+    end
+
+    def remove(idx)
+      @must_repack = true
+      rows[idx] = nil
+    end
+
+    def pack
+      return repack if @must_repack
+      return @buffer unless @rows
+      @buffer ||= ''
+      start = 0
+      @rows.each_with_index do |row, idx|
+        # only updated dirty rows
+        if ! row.is_a?(String) && row.changed?
+          @buffer[start...(start+row_bytesize)] = row.pack
+          row.not_changed!
+        end
+        start += row_bytesize
+      end
+      @buffer
+    end
+
+    # repacks the buffer
+    def repack
+      @buffer = ''
+      self.each do |row|
+        next unless row
+        @buffer << row.pack
+      end
+      remove_instance_variable "@rows"
+      remove_instance_variable("@must_repack") if defined?(@must_repack)
+      remove_instance_variable("@results") if defined?(@results)
+      @buffer
+    end
+
+    # to search the buffer the first field must be a marker and the 2nd is the what you are searching for
+    # Example: class TestSearchableModel < PackedModel::Base
+    #            attribute :magic, :type => :marker, :value => 20130502
+    #            attribute :id, :type => :integer
+    #            attribute :name, :type => :char, :size => 20
+    #          end
+    def find_in_buffer(val)
+      return nil unless @buffer
+      @results ||= {}
+      return @results[val] if @results.has_key?(val)
+      index = @buffer.index search_string(val)
+      return (@results[val] = nil) unless index
+      index = index / row_bytesize
+      @results[val] = self[index]
+    end
+
+    def size
+      rows.size
+    end
+
+    def bytesize
+      row_bytesize * size
+    end
+
+    def each
+      self.size.times do |idx|
+        yield self[idx]
+      end
+    end
+
+    private
+
+    # doesn't really unpack the data into models, just creates an array of pointers into the buffer
+    # data is not unpacked unless it is accessed
+    def unpack(str)
+      raise InvalidDataException.new("invalid string for list") unless (str.bytesize % row_bytesize) == 0
+
+      start = 0
+      [].tap do |data|
+        (str.bytesize / row_bytesize).times do
+          data << str[start...(start+row_bytesize)] # essentially we are creating C style pointers into the string at certain locations
+          start += row_bytesize
+        end
+      end
+    end
+
+    def rows
+      if ! defined?(@rows)
+        @rows = @buffer ? unpack(@buffer) : []
+      end
+      @rows
+    end
+
+    def row_bytesize
+      @row_class.bytesize
+    end
+
+    def search_string(val)
+      marker_field = @row_class.fields[0]
+      key_field = @row_class.fields[1]
+      [marker_field[:value], val].pack "#{marker_field[:pack_directive]}#{key_field[:pack_directive]}"
+    end
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  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
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'packed_model'

data/spec/packed_model/base_spec.rb

@@ -0,0 +1,200 @@
+require 'helper'
+
+describe PackedModel::Base do
+  context "fixed width model testing" do
+    class TestFixedPackedModel < PackedModel::Base
+      attribute :magic, :type => :marker, :value => 20130501
+      attribute :id, :type => :integer
+      attribute :name, :type => :char, :size => 20, :strip => true
+      attribute :blob, :type => :char, :size => 4, :default => 'MP3'
+      attribute :count, :type => :integer, :default => 1
+
+      def self.test_packed_string
+        "\0013*\305\000\000\000Ztester\000\000\000\000\000\000\000\000\000\000\000\000\000\000WAV\000\000\000\000\005"
+      end
+
+      def self.test_hash
+        {:name => "tester", :id => '90', :count => 5, :blob => 'WAV'}
+      end
+    end
+
+    it "should be a fixed width model" do
+      TestFixedPackedModel.fixed_width?.should be_true
+    end
+
+    it "should have a bytesize of 36" do
+      TestFixedPackedModel.bytesize.should == 36
+    end
+
+    it "should construct a pack string based on the order of the attributes" do
+      TestFixedPackedModel.pack_string.should == "NNa20a4N"
+    end
+
+    it "should be able to get the index for a field" do
+      TestFixedPackedModel.keys.should == [:magic, :id, :name, :blob, :count]
+      TestFixedPackedModel.field_index(:blob).should == 3
+    end
+
+    it "should default the count to 1" do
+      TestFixedPackedModel.new.tap do |m|
+        m.changed?.should be_true
+        m.id.should == 0
+        m.name.should be_nil
+        m.blob.should == "MP3"
+        m.count.should == 1
+      end
+    end
+
+    it "should pack the model data into a binary string" do
+      TestFixedPackedModel.new(TestFixedPackedModel.test_hash).tap do |m|
+        m.changed?.should be_true
+        m.id.should == 90
+        m.name.should == "tester"
+        m.blob.should == "WAV"
+        m.count.should == 5
+        m.pack.should == TestFixedPackedModel.test_packed_string
+        m.pack.bytesize.should == TestFixedPackedModel.bytesize
+      end
+    end
+
+    it "should not be changed if initialized from a packed string" do
+      TestFixedPackedModel.new(TestFixedPackedModel.test_packed_string).tap do |m|
+        m.changed?.should be_false
+        m.id.should == 90
+        m.name.should == "tester"
+        m.blob.should == "WAV\000" # expected not stripping after unpacking
+        m.count.should == 5
+        m.pack.should == TestFixedPackedModel.test_packed_string
+        m.pack.bytesize.should == TestFixedPackedModel.bytesize
+      end
+    end
+
+    it "should raise BadMarkerException marker values do not match" do
+      TestFixedPackedModel.new.tap do |m|
+        str = m.pack
+        str[0] = 'z'
+
+        expect {
+          TestFixedPackedModel.new str
+        }.to raise_exception(PackedModel::BadMarkerException)
+      end
+    end
+
+    it "should not accept strings that do not have enough data to unpack" do
+      expect {
+        TestFixedPackedModel.new 'bad data'
+      }.to raise_exception(PackedModel::InvalidDataException)
+    end
+
+    it "should be changed of a field value changes" do
+      TestFixedPackedModel.new(TestFixedPackedModel.test_packed_string).tap do |m|
+        m.changed?.should be_false
+        m.name = "tester"
+        m.changed?.should be_false
+        m.name = "different"
+        m.changed?.should be_true
+        m.pack.should == "\0013*\305\000\000\000Zdifferent\000\000\000\000\000\000\000\000\000\000\000WAV\000\000\000\000\005"
+        m.changed?.should be_true
+        m.not_changed!
+        m.changed?.should be_false
+      end
+    end
+
+    it "should be able to_hash the model data" do
+      TestFixedPackedModel.new(TestFixedPackedModel.test_hash).to_hash.should ==
+        { :magic => 20130501,
+          :name => 'tester',
+          :id => 90,
+          :blob => "WAV",
+          :count => 5
+        }
+    end
+  end
+
+  context "custom field model testing" do
+    class TestCustomPackedModel < PackedModel::Base
+      attribute :magic, :type => :marker, :value => 20130501
+      attribute :id, :type => :integer
+      attribute :special, :type => :custom, :pack_directive => 'n', :filter => :to_i, :bytesize => 2 # 16-bit integer
+      attribute :name, :type => :char, :size => 4
+
+      def self.test_packed_string
+        "\0013*\305\000\000\000Z\000Y\000\000\000\000"
+      end
+
+      def self.test_hash
+        {:id => '90', :special => '89'}
+      end
+    end
+
+    it "should be a fixed width model" do
+      TestCustomPackedModel.fixed_width?.should be_true
+    end
+
+    it "should have a bytesize of 14" do
+      TestCustomPackedModel.bytesize.should == 14
+    end
+
+    it "should properly transform values for the special field to integers" do
+      TestCustomPackedModel.new(:special => '90').tap do |m|
+        m.id.should == 0
+        m.special.should == 90
+        m.pack.bytesize.should == TestCustomPackedModel.bytesize
+      end
+    end
+
+    it "should be able to pack/unpack custom fields" do
+      m1 = TestCustomPackedModel.new TestCustomPackedModel.test_hash
+      m1.pack.should == TestCustomPackedModel.test_packed_string
+      m1.id.should == 90
+      m1.special.should == 89
+
+      m2 = TestCustomPackedModel.new TestCustomPackedModel.test_packed_string
+      m2.id.should == 90
+      m2.special.should == 89
+    end
+  end
+
+  context "non fixed width model testing" do
+    class TestNonFixedWidthPackedModel < PackedModel::Base
+      attribute :magic, :type => :marker, :value => 20130502
+      attribute :name, :type => :string
+      attribute :count, :type => :integer
+      attribute :description, :type => :string
+      attribute :summary, :type => :string
+      attribute :ratings, :type => :integer
+
+      def self.test_packed_string
+        "\0013*\306Mr. Foo Bar\000\000\000\000P\000Foobartastic\000\000\000\000\000"
+      end
+
+      def self.test_hash
+        {:name => "Mr. Foo Bar", :count => '80', :summary => 'Foobartastic'}
+      end
+    end
+
+    it "should not be a fixed width" do
+      TestNonFixedWidthPackedModel.fixed_width?.should be_false
+      TestNonFixedWidthPackedModel.bytesize.should be_nil
+    end
+
+    it "should be able to pack/unpack non fixed with models" do
+      m1 = TestNonFixedWidthPackedModel.new TestNonFixedWidthPackedModel.test_hash
+      m1.name.should == "Mr. Foo Bar"
+      m1.count.should == 80
+      m1.description.should be_nil
+      m1.summary.should == 'Foobartastic'
+      m1.ratings.should == 0
+      m1.pack.should == TestNonFixedWidthPackedModel.test_packed_string
+      m1.bytesize.should == 38
+
+      m2 = TestNonFixedWidthPackedModel.new TestNonFixedWidthPackedModel.test_packed_string
+      m2.name.should == "Mr. Foo Bar"
+      m2.count.should == 80
+      m2.description.should be_nil
+      m2.summary.should == 'Foobartastic'
+      m2.ratings.should == 0
+      m2.bytesize.should == 38
+    end
+  end
+end

data/spec/packed_model/list_spec.rb

@@ -0,0 +1,140 @@
+require 'helper'
+
+describe PackedModel::List do
+  class TestListPackedModel < PackedModel::Base
+    attribute :magic, :type => :marker, :value => 20130501
+    attribute :id, :type => :integer
+    attribute :name, :type => :char, :size => 20, :strip => true
+
+    def self.test_list_packed_string
+      "\0013*\305\000\000\000\005foo\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\0013*\305\000\000\002\274bar\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\0013*\305\000\000\000\006game\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000\000"
+    end
+
+    def self.test_list_with_models
+      PackedModel::List.new(TestListPackedModel).tap do |list|
+        list << TestListPackedModel.new(:id => 5, :name => "foo")
+        list << TestListPackedModel.new(:id => 700, :name => "bar")
+        list << TestListPackedModel.new(:id => 6, :name => "game")
+      end
+    end
+  end
+
+  class TestInvalidListPackedModel < PackedModel::Base
+    attribute :magic, :type => :marker, :value => 20130501
+    attribute :id, :type => :integer
+    attribute :name, :type => :string
+  end
+
+  context "initialize" do
+    it "should only allow fixed width PackedModels" do
+      TestListPackedModel.fixed_width?.should be_true
+      PackedModel::List.new TestListPackedModel
+
+      TestInvalidListPackedModel.fixed_width?.should be_false
+      expect {
+        PackedModel::List.new TestInvalidListPackedModel
+      }.to raise_exception(PackedModel::InvalidPackedModelException)
+    end
+
+    it "should be able to pack a list of models" do
+      list = TestListPackedModel.test_list_with_models
+      list.pack.should == TestListPackedModel.test_list_packed_string
+      list.size.should == 3
+    end
+
+    it "should be able to initialize a list from a packed string" do
+      PackedModel::List.new(TestListPackedModel, TestListPackedModel.test_list_packed_string).tap do |list|
+        list.map(&:name).should == ['foo', 'bar', 'game']
+        list.size.should == 3
+      end
+    end
+
+    it "should not perform any operations on the buffer unless the data is accessed" do
+      PackedModel::List.new(TestListPackedModel, 'bad data').tap do |list|
+        list.pack.should == 'bad data'
+        expect {
+          list[0].name
+        }.to raise_exception(PackedModel::InvalidDataException)
+      end
+    end
+  end
+
+  context "pack/unpack" do
+    it "should only update the buffer if the row has changed" do
+      PackedModel::List.new(TestListPackedModel, TestListPackedModel.test_list_packed_string).tap do |list|
+        list[1].name = 'changed'
+        list[1].changed?.should be_true
+        list.pack.should_not == TestListPackedModel.test_list_packed_string
+      end
+
+      PackedModel::List.new(TestListPackedModel, TestListPackedModel.test_list_packed_string).tap do |list|
+        list[1].name = 'changed'
+        list[1].changed?.should be_true
+
+        # change the model state to not changed
+        list[1].not_changed!
+        list[1].changed?.should be_false
+
+        # when packing the data the list skips over unchanged rows
+        list.pack.should == TestListPackedModel.test_list_packed_string
+      end
+    end
+
+    it "should be able to add new rows to the list" do
+      PackedModel::List.new(TestListPackedModel, TestListPackedModel.test_list_packed_string).tap do |list|
+        list << (item = TestListPackedModel.new(:name => "new item", :id => 500))
+        list.pack.should == "#{TestListPackedModel.test_list_packed_string}#{item.pack}"
+      end
+
+      PackedModel::List.new(TestListPackedModel, TestListPackedModel.test_list_packed_string).tap do |list|
+        list[list.size] = (item = TestListPackedModel.new(:name => "new item", :id => 500))
+        list.pack.should == "#{TestListPackedModel.test_list_packed_string}#{item.pack}"
+      end
+    end
+  end
+
+  context "find_in_buffer" do
+    it "should be able to find rows in the buffer" do
+      PackedModel::List.new(TestListPackedModel, TestListPackedModel.test_list_packed_string).tap do |list|
+        list.find_in_buffer(700).tap do |item|
+          item.should_not be_nil
+          item.name.should == "bar"
+        end
+
+        list.find_in_buffer(999999).tap do |item|
+          item.should be_nil
+        end
+
+        # only the row found is unpacked
+        list.send(:rows).tap do |rows|
+          rows[0].is_a?(String)
+          rows[1].is_a?(TestListPackedModel)
+          rows[2].is_a?(String)
+        end
+
+        list.find_in_buffer(700).tap do |item|
+          item.should_not be_nil
+          item.name.should == "bar"
+        end
+      end
+    end
+  end
+
+  context "remove" do
+    it "should be able to remove a row from the list" do
+      PackedModel::List.new(TestListPackedModel, TestListPackedModel.test_list_packed_string).tap do |list|
+        item1 = list[0]
+        item1.name.should == "foo"
+        item2 = list[2]
+        item2.name.should == "game"
+        list.remove 1
+        list.pack.should == "#{item1.pack}#{item2.pack}"
+        list.map(&:name).should == ["foo", "game"]
+
+        PackedModel::List.new(TestListPackedModel, list.pack).tap do |list2|
+          list2.map(&:name).should == ["foo", "game"]
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'packed_model'
+
+class Test::Unit::TestCase
+end

data/test/test_packed_model_base.rb

@@ -0,0 +1,12 @@
+require 'helper'
+
+class TestPackedModelBase < Test::Unit::TestCase
+  should "create a PackedModel::Base with different columns" do
+    class TestModel < PackedModel::Base
+      attribute :magic, :type => :marker, :value => 20130501
+      attribute :name, :type => :char, :size => 20
+      attribute :count, :type => :integer
+    end
+    TestModel.fixed_width?.should be_true
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification 
+name: packed-model
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Doug Youch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-05-02 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rdoc
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 12
+        version: "3.12"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: jeweler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 8
+        - 4
+        version: 1.8.4
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rcov
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: Used to minimize storage space required to store list of data
+email: doug@sessionm.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/packed_model.rb
+- lib/packed_model/base.rb
+- lib/packed_model/errors.rb
+- lib/packed_model/list.rb
+- spec/helper.rb
+- spec/packed_model/base_spec.rb
+- spec/packed_model/list_spec.rb
+- test/helper.rb
+- test/test_packed_model_base.rb
+has_rdoc: true
+homepage: http://github.com/dyouch5@yahoo.com/packed-model
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: PackedModel stores model data in a binary string
+test_files: []
+