ar-serialize-helpers 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ar-serialize-helpers.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 EmberAds Ltd <team@emberads.com>
+
+MIT License
+
+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.md

@@ -0,0 +1,47 @@
+# Ar::Serialize::Helpers
+
+Collection of helpers for ActiveRecord's `serialize` method in Rails >= 3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ar-serialize-helpers'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ar-serialize-helpers
+
+## Usage
+
+You need to require the individual helper classes you wish to use. You can either do this in an initializer
+
+    require "ar-serialize-helpers/json"
+    
+or in the Gemfile
+
+    gem "ar-serialize-helpers", :require => "ar-serialize-helpers/json"
+    # Or for multiple modules
+    gem "ar-serialize-helpers", :require => ["ar-serialize-helpers/json", "ar-serialize-helpers/integer"]
+
+Then pass an instance of the class to the `serialize` call in the model definition
+
+    class MyModel < ActiveRecord::Base
+      serialize :my_column, ARSerializeHelpers::JSON.new
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+See LICENSE

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => e
+  task "spec" do
+    puts "RSpec not loaded - make sure it's installed and you're using bundle exec"
+    exit 1
+  end
+end
+
+task :default => :spec

data/ar-serialize-helpers.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/ar-serialize-helpers/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Caius Durling"]
+  gem.email         = ["caius@emberads.com"]
+  gem.description   = %q{Helpers for ActiveRecord's serialize in rails 3}
+  gem.summary       = %q{Helpers for ActiveRecord's serialize in rails 3}
+  gem.homepage      = "http://github.com/EmberAds/ar-serialize-helpers"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "ar-serialize-helpers"
+  gem.require_paths = ["lib"]
+  gem.version       = ARSerializeHelpers::VERSION
+
+  gem.add_development_dependency "json"
+  gem.add_development_dependency "rspec"
+end

data/lib/ar-serialize-helpers/all.rb

@@ -0,0 +1,3 @@
+Dir[File.dirname(__FILE__) + "/*.rb"].each do |f|
+  require f unless f =~ /(all|version)\.rb\z/
+end

data/lib/ar-serialize-helpers/integer.rb

@@ -0,0 +1,11 @@
+module ARSerializeHelpers
+  class Integer
+    def dump float
+      (float.to_f * 100.0).round if float != nil
+    end
+
+    def load int
+      int / 100.0 if int
+    end
+  end
+end

data/lib/ar-serialize-helpers/json.rb

@@ -0,0 +1,12 @@
+# assumes JSON is loaded when this is used
+module ARSerializeHelpers
+  class JSON
+    def dump obj
+      obj.to_json if obj != nil
+    end
+
+    def load text
+      ::JSON.parse(text) if text
+    end
+  end
+end

data/lib/ar-serialize-helpers/version.rb

@@ -0,0 +1,3 @@
+module ARSerializeHelpers
+  VERSION = "1.0.0"
+end

data/lib/ar-serialize-helpers.rb

@@ -0,0 +1,4 @@
+require "ar-serialize-helpers/version"
+
+module ARSerializeHelpers
+end

data/spec/ar-serialize-helpers/integer_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+require "ar-serialize-helpers/integer"
+
+describe ARSerializeHelpers::Integer do
+  before { @ints = ARSerializeHelpers::Integer.new }
+
+  describe "#dump" do
+    it "should dump integer successfully" do
+      @ints.dump(5).should be == 500
+    end
+    it "should dump float successfully" do
+      @ints.dump(0.58).should be == 58
+    end
+    it "should dump string successfully" do
+      @ints.dump("0.58").should be == 58
+    end
+    it "should not dump nil" do
+      @ints.dump(nil).should be_nil
+    end
+  end
+
+  describe "#load" do
+    it "should load integer successfully" do
+      @ints.load(58).should be == 0.58
+    end
+    it "should parse nil to nil" do
+      @ints.load(nil).should be_nil
+    end
+  end
+
+end

data/spec/ar-serialize-helpers/json_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+require "json"
+require "ar-serialize-helpers/json"
+
+module JSONSpecHelpers
+  extend self
+
+  # helperz
+  def ruby_to_json
+    {
+      true => "true",
+      1 => "1",
+      1.0 => "1.0",
+      "string" => %{"string"},
+      :symbol => %{"symbol"},
+      {"foo" => "bar"} => %@{"foo":"bar"}@,
+      [1,2,3] => "[1,2,3]"
+    }
+  end
+
+  def json_to_ruby
+    ruby_to_json.reject {|k,v| k == :symbol }.invert
+  end
+end
+
+describe ARSerializeHelpers::JSON do
+  before { @js = ARSerializeHelpers::JSON.new }
+
+  describe "#dump" do
+    JSONSpecHelpers.ruby_to_json.each do |ruby, json_str|
+      it "should dump #{ruby.class} to json successfully" do
+        @js.dump(ruby).should be == json_str
+      end
+    end
+    it "should not dump nil" do
+      @js.dump(nil).should be_nil # rather than "null" - JSON.parse("null") will throw an error y'see
+    end
+  end
+
+  describe "#load" do
+    JSONSpecHelpers.json_to_ruby.each do |json_str, ruby|
+      it "should load #{ruby.class} from json successfully" do
+        # Have to wrap in an array so JSON can parse the primitive types
+        @js.load("[#{json_str}]").should == [ruby]
+      end
+    end
+    it "should parse nil to nil" do
+      @js.load(nil).should be_nil
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require "ar-serialize-helpers"

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: ar-serialize-helpers
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Caius Durling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-20 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Helpers for ActiveRecord's serialize in rails 3
+email: 
+- caius@emberads.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- ar-serialize-helpers.gemspec
+- lib/ar-serialize-helpers.rb
+- lib/ar-serialize-helpers/all.rb
+- lib/ar-serialize-helpers/integer.rb
+- lib/ar-serialize-helpers/json.rb
+- lib/ar-serialize-helpers/version.rb
+- spec/ar-serialize-helpers/integer_spec.rb
+- spec/ar-serialize-helpers/json_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/EmberAds/ar-serialize-helpers
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 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
+signing_key: 
+specification_version: 3
+summary: Helpers for ActiveRecord's serialize in rails 3
+test_files: []
+