dm-is-serialized 0.9.10

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jakub Stastny aka Botanicus
+
+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,29 @@
+h1. About
+
+This plugin helps you to serialize your records into very short strings for storing in cookies.
+
+h1. Initialization
+
+<pre>
+class Product
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+end
+
+class OrderItem
+  include DataMapper::Resource
+  is :serialized
+  has 1, :product
+  property :id,    Serial
+  property :name,  String
+  property :count, Integer, :default => 1
+  property :used,  Boolean, :default => false
+  property :note,  Text
+  serialize_properties :count, :note # GeneralSerializeFilter is default value
+  serialize_property :product, ModelSerializeFilter
+  serialize_property :used, BooleanSerializeFilter
+end
+</pre>
+
+h1. Filters

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'lib/dm-is-serialized/is/version'
+
+GEM_NAME = "dm-is-serialized"
+AUTHOR = "Jakub Stastny aka Botanicus"
+EMAIL = "knava.bestvinensis@gmail.com"
+HOMEPAGE = "http://101Ideas.cz/"
+SUMMARY = "This plugin helps you to serialize your records into very short strings for storing in cookies"
+GEM_VERSION = DataMapper::Is::Serialized::VERSION
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.textile", "LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README.textile Rakefile) + Dir.glob("{lib,spec,app,public,stubs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+def sudo_gem(cmd)
+  sh "#{SUDO} #{RUBY} -S gem #{cmd}", :verbose => false
+end
+
+desc "Install #{GEM_NAME} #{GEM_VERSION}"
+task :install => [ :package ] do
+  sudo_gem "install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources"
+end
+
+desc "Uninstall #{GEM_NAME} #{GEM_VERSION}"
+task :uninstall => [ :clobber ] do
+  sudo_gem "uninstall #{GEM_NAME} -v#{GEM_VERSION} -Ix"
+end
+
+require 'spec/rake/spectask'
+desc 'Default: run spec examples'
+task :default => 'spec'

data/TODO

@@ -0,0 +1,8 @@
+- the best will be hook properties and has methods:
+
+class OrderItem
+  include DataMapper::Resource
+  is :serialized
+  has 1, :product, :serialized => true
+  property :count, Integer, :serialized => true
+end

data/dm-is-serialized.gemspec

@@ -0,0 +1,22 @@
+begin
+  require "rubygems/specification"
+rescue SecurityError
+  # http://gems.github.com
+end
+
+VERSION  = "0.9.10"
+SPECIFICATION = ::Gem::Specification.new do |s|
+  s.name = "dm-is-serialized"
+  s.version = VERSION
+  s.authors = ["Jakub Šťastný aka Botanicus"]
+  s.homepage = "http://github.com/botanicus/dm-is-serialized"
+  s.summary = "This plugin helps you to serialize your records into very short strings for storing in cookies."
+  # s.description = "" # TODO: long description
+  s.cert_chain = nil
+  s.email = ["knava.bestvinensis", "gmail.com"].join("@")
+  s.files = Dir.glob("**/*") - Dir.glob("pkg/*")
+  s.add_dependency "dm-core"
+  s.require_paths = ["lib"]
+  # s.required_ruby_version = ::Gem::Requirement.new(">= 1.9.1")
+  # s.rubyforge_project = "rango"
+end

data/lib/dm-is-serialized.rb

@@ -0,0 +1,17 @@
+# Needed to import datamapper and other gems
+require 'rubygems'
+require 'pathname'
+
+# Add all external dependencies for the plugin here
+gem 'dm-core'
+require 'dm-core'
+
+# Require plugin-files
+require Pathname(__FILE__).dirname.expand_path/'dm-is-serialized'/'is'/'serialized'
+
+# Include the plugin in Resource
+module DataMapper
+  module Model
+    include DataMapper::Is::Serialized
+  end
+end

data/lib/dm-is-serialized/is/filters.rb

@@ -0,0 +1,66 @@
+module DataMapper
+  module Is
+    module Serialized
+      module Filters
+        # superclass for all filter
+        class SerializeFilter
+          # record: object of model (just in serialize)
+          # name: symbol with property name
+          attr_accessor :record, :name
+          def property
+            @record.class.properties[@name]
+          end
+
+          def relationship(name)
+            @record.class.relationships[@name]
+          end
+        end
+
+        # serialize: true => 1, false => 0
+        class BooleanSerializeFilter < SerializeFilter
+          def serialize(data)
+            data ? 1 : 0
+          end
+
+          def deserialize(data)
+            data.to_i == 1
+          end
+        end
+
+        # serialize: :product => product_id
+        class ModelSerializeFilter < SerializeFilter
+          # serialize(:product)
+          def serialize(record)
+            keys = model.key.map { |property| property.name }
+            raise "Record can't be nil (#{model} with keys #{keys})" if record.nil?
+            values = keys.map { |key| record.send(key) }
+            values.length.eql?(1) ? values.first : values.join("|")
+          end
+
+          # product_id => id
+          def deserialize(id)
+            ids = id.split("|")
+            model.get(*ids)
+          end
+
+          def model
+            Object.const_get(@name.to_s.camel_case)
+          end
+        end
+
+        # called when any filter found
+        class GeneralSerializeFilter < SerializeFilter
+          def serialize(data)
+            raise "Data too long" if data.to_s.length > 20
+            return data
+          end
+
+          def deserialize(data)
+            # "" => nil
+            data.empty? ? nil : data
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dm-is-serialized/is/serialized.rb

@@ -0,0 +1,68 @@
+require Pathname(__FILE__).dirname.expand_path/'filters'
+
+module DataMapper
+  module Is
+    module Serialized
+      def self.included(base)
+      end
+
+      def is_serialized(options = Hash.new)
+        # Add class-methods
+        extend  DataMapper::Is::Serialized::ClassMethods
+        # Add instance-methods
+        include DataMapper::Is::Serialized::InstanceMethods
+        include DataMapper::Is::Serialized::Filters
+        self.serialized_properties = Array.new # otherwise it will be nil and it will cause NoMethodError
+      end
+
+      module ClassMethods
+        include DataMapper::Is::Serialized::Filters
+        attr_accessor :serialized_properties
+
+        # serialize_property :size, BooleanSerializedFilter
+        def serialize_property(property, filter = GeneralSerializeFilter)
+          self.serialized_properties ||= Array.new
+          self.serialized_properties.push([property, filter])
+          self.serialized_properties.uniq!
+        end
+
+        # serialize_properties :product, :count
+        # serialize_properties :product, :count, GeneralSerializeFilter
+        def serialize_properties(*properties)
+          self.serialized_properties ||= Array.new
+          filter = properties.last.class.eql?(Class) ? properties.pop : GeneralSerializeFilter
+          properties.each do |property|
+            self.serialized_properties.push([property, filter])
+          end
+          self.serialized_properties.uniq!
+        end
+
+        def deserialize(data)
+          params = Hash.new
+          data.split(",").each_with_index do |data, index|
+            property_name, filter_class = self.serialized_properties[index]
+            filter = filter_class.new
+            filter.name = property_name
+            value  = filter.deserialize(data)
+            #value.nil? ? raise(TypeError) : value
+            params[property_name] = value
+          end
+          return self.new(params)
+        end
+      end
+
+      module InstanceMethods
+        # @product.serialize => #<Product ...>
+        def serialize
+          self.class.serialized_properties.map do |property_name, filter_class|
+            filter = filter_class.new
+            filter.record = self
+            filter.name = property_name
+            data   = self.send(property_name)
+            data.nil? ? String.new : filter.serialize(data)
+          end.join(",")
+        end
+      end
+    end
+  end
+end

data/lib/dm-is-serialized/is/version.rb

@@ -0,0 +1,7 @@
+module DataMapper
+  module Is
+    module Serialized
+      VERSION = '0.9.10'
+    end
+  end
+end

data/spec/dm-is-serialized/serialized_spec.rb

@@ -0,0 +1,120 @@
+require File.join(File.dirname(__FILE__), '..', "spec_helper")
+require "dm-is-serialized"
+
+include DataMapper::Is::Serialized::Filters
+
+class Product
+  include DataMapper::Resource
+  property :id,   Serial
+  property :name, String
+end
+
+class OrderItem
+  include DataMapper::Resource
+  is :serialized
+  has 1, :product
+  property :id,    Serial
+  property :name,  String
+  property :count, Integer, :default => 1
+  property :used,  Boolean, :default => false
+  property :note,  Text
+end
+
+describe DataMapper::Is::Serialized do
+  def serialize_property(property, filter)
+    OrderItem.serialized_properties.clear if OrderItem.serialized_properties
+    OrderItem.serialize_property property, filter
+  end
+
+  before do
+    # Do not save it, it is the reason why all the required
+    # properties are saved in cookies - that the record
+    # isn't saved yet. In shopping cart for example.
+    @item = OrderItem.new
+  end
+
+  describe BooleanSerializeFilter do
+    before do
+      serialize_property :used, BooleanSerializeFilter
+    end
+
+    describe "false" do
+      it "should serialize false value" do
+        @item.used = false
+        @item.serialize.should eql("0")
+      end
+
+      it "should deserialize false value" do
+        item = OrderItem.deserialize("0")
+        item.used.should be_false
+      end
+    end
+
+    describe "true" do
+      it "should serialize true value" do
+        @item.used = true
+        @item.serialize.should eql("1")
+      end
+
+      it "should deserialize true value" do
+        item = OrderItem.deserialize("1")
+        item.used.should be_true
+      end
+    end
+  end
+
+  describe GeneralSerializeFilter do
+    describe "integers" do
+      before do
+        @item.count = 5
+        serialize_property :count, GeneralSerializeFilter
+      end
+
+      it "should serialize integers" do
+        @item.serialize.should eql("5")
+      end
+
+      it "should deserialize integers" do
+        item = OrderItem.deserialize("5")
+        item.count.should eql(5)
+      end
+    end
+
+    describe "strings" do
+      before do
+        @item.note = "quickly pls!"
+        serialize_property :note, GeneralSerializeFilter
+      end
+
+      it "should serialize strings" do
+        @item.serialize.should eql("quickly pls!")
+      end
+
+      it "should raise exception if string is too long" do
+        lambda { @item.serialize.should eql("too much long string") }.should raise_error
+      end
+
+      it "should deserialize strings" do
+        item = OrderItem.deserialize("quickly pls!")
+        item.note.should eql("quickly pls!")
+      end
+    end
+  end
+
+  describe ModelSerializeFilter do
+    before do
+      @product = Product.create
+      @item.product = @product
+      serialize_property :product, ModelSerializeFilter
+    end
+
+    it "should serialize boolean values" do
+      @item.serialize.should eql(@product.id.to_s)
+    end
+
+    it "should deserialize boolean values" do
+      item = OrderItem.deserialize(@product.id.to_s)
+      item.product.should eql(@product)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,5 @@
+--colour
+--format
+progress
+--loadby
+mtime

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$: << File.dirname(__FILE__) + "/../lib"
+
+require "dm-core"
+DataMapper.setup(:default, "sqlite3::memory")
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+    DataMapper.auto_migrate!
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-serialized
+version: !ruby/object:Gem::Version 
+  version: 0.9.10
+platform: ruby
+authors: 
+- "Jakub \xC5\xA0\xC5\xA5astn\xC3\xBD aka Botanicus"
+autorequire: 
+bindir: bin
+cert_chain: 
+date: 2009-11-26 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: knava.bestvinensis@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- dm-is-serialized.gemspec
+- lib/dm-is-serialized/is/filters.rb
+- lib/dm-is-serialized/is/serialized.rb
+- lib/dm-is-serialized/is/version.rb
+- lib/dm-is-serialized.rb
+- LICENSE
+- Rakefile
+- README.textile
+- spec/dm-is-serialized/serialized_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- TODO
+has_rdoc: true
+homepage: http://github.com/botanicus/dm-is-serialized
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: This plugin helps you to serialize your records into very short strings for storing in cookies.
+test_files: []
+