object_field 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be3cd0dd7166aabe94e860d0c8b4b19849553731
-  data.tar.gz: eaffb90af0495c61a3632e8ccfaa9fc73151bdc5
+  metadata.gz: 0c025020189aba2a0c4d9cbdd591c98cd390b2f5
+  data.tar.gz: 0dedf186e39e0955493d3aaecfaa5b3911240da6
 SHA512:
-  metadata.gz: 3126872d032f29e11d5e5ff9e741b4c59f7be65c674a88c588f6c21339d2b1bcb06aad6c042940e072d985edfd0fa928e873d07974a7b70855b2d0ef0858a5c6
-  data.tar.gz: 0e2288fbaa55a1d4af236e0aa5114b42b70958486f75fbef1362c76724dbc0fa61a5d1d5310a89a0e5ae0d26a782916c8181b53cc130569df2cb6efb5b7d6eb4
+  metadata.gz: 349ae8f45cfbc1ff6b03f9987ad3e9d4780e2154753a1fef92924729decfc5b26a193ed7f4e41691f123354c7a46c9eb2e888682db381e7976149a48ca41f028
+  data.tar.gz: 74540a02a97c87f6c648f30698146845ddbcf02bf756c1a4bfc4a39053d5bc2b5fc501017218fae27fbdb93ddf3273e9cb56c0276afa29479bb3797f43e11530

data/.coveralls.yml

@@ -0,0 +1,2 @@
+repo_token: pBPPHGBz5FL9oLMi9kvQrNw8Z3U9BKzjt
+

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+gemfile:
+  - Gemfile
+script: bundle exec rake spec
+notifications:
+  mails:
+    - i2bskn@gmail.com
+

data/README.md

@@ -1,6 +1,13 @@
 # ObjectField
 
-Support for object persistence.
+[![Gem Version](https://badge.fury.io/rb/object_field.svg)](http://badge.fury.io/rb/object_field)
+[![Build Status](https://travis-ci.org/i2bskn/object_field.svg)](https://travis-ci.org/i2bskn/object_field)
+[![Coverage Status](https://coveralls.io/repos/i2bskn/object_field/badge.png)](https://coveralls.io/r/i2bskn/object_field)
+[![Code Climate](https://codeclimate.com/github/i2bskn/object_field/badges/gpa.svg)](https://codeclimate.com/github/i2bskn/object_field)
+[![Dependency Status](https://gemnasium.com/i2bskn/object_field.svg)](https://gemnasium.com/i2bskn/object_field)
+
+Support for object persistence.  
+Save the object to data store via instance method.
 
 ## Installation
 
@@ -20,21 +27,57 @@ Or install it yourself as:
 
 ## Usage
 
-```ruby
-require "object_field"
+Include `ObjectField::Jsonizer` or `ObjectField::Serializer`.
+
+#### Jsonizer
 
-class Example
+`.#jsonize` defines accessor of JSON field.  
+
+```ruby
+class InJsonValue
   include ObjectField::Jsonizer
-  attr_accessor :field1_json, :field2_json, :field3_json
-  jsonize :field1_json, :field2_json
+  attr_accessor :field1_json, :field2, :field3_json
+  jsonize :field1_json, :field2
   jsonize :field3_json, as: :attributes
 end
+```
+
+Setter is save the value to JSON.  
+Getter returns parsed value.  
+Name of accessor can be specified with `as` option.  
+It is set `field1`, `field2_as_json` if not specified.
+
+```ruby
+object = InJsonValue.new
+object.field1 = [1, 2, 3]
+p object.field1_json # => "[1,2,3]"
+object.field1.each {|i| p i}
+```
+
+#### Serializer
+
+`.#serialize` defines accessor of marshal data field.  
+Like marshal option of [redis-object](https://github.com/nateware/redis-objects).
+
+```ruby
+class InSerializedValue
+  include ObjectField::Serializer
+  attr_accessor :field
+  serialize :field
+end
+```
 
-e = Example.new
-e.field1 = [1, 2, 3]
-e.attributes = {key: :value}
-p e # => #<Example:0x007fa5914ac548 @field1_json="[1,2,3]", @field3_json="{\":key\":\":value\"}">
-puts e.attributes[:key] # => value
+Setter is save the serialized value.  
+Can not be saved, Proc object and anonymous class. (To raise TypeError)  
+Getter returns deserialized value.  
+Name of accessor can be specified with `as` option.  
+It is set `field_data` if not specified.
+
+```
+class SerializedObject; end
+object = InSerializedValue.new
+object.field_data = SerializedObject.new
+p object.field_data.class # => SerializedObject
 ```
 
 ## Contributing

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run all specs"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w(--color --format documentation)
+end
+
+task :default => :spec
 

data/lib/object_field.rb

@@ -1,5 +1,7 @@
+require "zlib"
 require "oj"
 
 require "object_field/version"
 require "object_field/jsonizer"
+require "object_field/serializer"
 

data/lib/object_field/serializer.rb

@@ -0,0 +1,27 @@
+module ObjectField
+  module Serializer
+    module ClassMethods
+      def serialize(field_name, as: nil, compression: Zlib::DEFAULT_COMPRESSION)
+        accessor = as || accessor_name(field_name)
+        define_method accessor do |klass=nil|
+          object = Marshal.load(Zlib.inflate(self.send(field_name)))
+          klass ? klass.new(object) : object
+        end
+
+        define_method "#{accessor}=" do |object|
+          self.send "#{field_name}=", Zlib.deflate(Marshal.dump(object), compression)
+        end
+      end
+
+      private
+      def accessor_name(field_name)
+        [field_name, :_data].join.to_sym
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  end
+end
+

data/lib/object_field/version.rb

@@ -1,4 +1,4 @@
 module ObjectField
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end
 

data/object_field.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'object_field/version'
@@ -19,10 +18,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "oj"
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  # spec.add_development_dependency "rspec"
-  # spec.add_development_dependency "coveralls"
-  # spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
 end
 

data/spec/object_field/jsonizer_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe ObjectField::Jsonizer do
+  class InJsonValue
+    include ObjectField::Jsonizer
+    attr_accessor :field1_json, :field2, :field3_json
+    jsonize :field1_json, :field2
+    jsonize :field3_json, as: :attributes
+  end
+
+  describe ".#included" do
+    it "should define singleton method" do
+      expect(InJsonValue.respond_to? :jsonize).to be_truthy
+    end
+  end
+
+  it "not possible to specify more than one accessor" do
+    expect{InJsonValue.jsonize(:field1, :field2, as: :field_name)}.to raise_error(ArgumentError)
+  end
+
+  describe "included class" do
+    let(:example) { InJsonValue.new }
+    let(:hash) { {key: :value} }
+    let(:stored_instance) do
+      example.attributes = hash
+      example
+    end
+
+    it "should define accessor" do
+      expect(example.respond_to? :field1).to be_truthy
+      expect(example.respond_to? :field2_as_json).to be_truthy
+      expect(example.respond_to? :attributes).to be_truthy
+    end
+
+    it "should save JSON value" do
+      expect(stored_instance.field3_json).to eq(Oj.dump(hash))
+    end
+
+    it "should parse JSON value" do
+      expect(stored_instance.field3_json).not_to eq(hash)
+      expect(stored_instance.attributes).to eq(hash)
+    end
+
+    it "should generate instance with parse JSON value" do
+      expect(stored_instance.attributes(Struct.new(:value)).value).to eq(hash)
+    end
+  end
+end
+

data/spec/object_field/serializer_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe ObjectField::Serializer do
+  class InSerializedValue
+    include ObjectField::Serializer
+    attr_accessor :field1, :field2
+    serialize :field1
+    serialize :field2, as: :attributes
+  end
+
+  class SerializeObject; end
+
+  describe ".#included" do
+    it "should define singleton method" do
+      expect(InSerializedValue.respond_to? :serialize).to be_truthy
+    end
+  end
+
+  describe "included class" do
+    let(:example) { InSerializedValue.new }
+    let(:object) { SerializeObject.new }
+    let(:stored_instance) do
+      example.attributes = object
+      example
+    end
+
+    it "should define accessor" do
+      expect(example.respond_to? :field1_data).to be_truthy
+      expect(example.respond_to? :attributes).to be_truthy
+    end
+
+    it "should save Object" do
+      expect(stored_instance.field2).not_to eq(object)
+    end
+
+    it "should parse Object" do
+      expect(stored_instance.attributes.class).to eq(SerializeObject)
+    end
+
+    it "should generate instance with parse Object" do
+      expect(stored_instance.attributes(Struct.new(:value)).value.class).to eq(SerializeObject)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "coveralls"
+Coveralls.wear!
+
+require "object_field"
+
+RSpec.configure do |config|
+  config.order = :random
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: object_field
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - i2bskn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-25 00:00:00.000000000 Z
+date: 2014-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -28,30 +28,58 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Support for object persistence.
 email:
 - i2bskn@gmail.com
@@ -59,15 +87,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".coveralls.yml"
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/object_field.rb
 - lib/object_field/jsonizer.rb
+- lib/object_field/serializer.rb
 - lib/object_field/version.rb
 - object_field.gemspec
+- spec/object_field/jsonizer_spec.rb
+- spec/object_field/serializer_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/i2bskn/object_field
 licenses:
 - MIT
@@ -92,4 +126,7 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Support for object persistence.
-test_files: []
+test_files:
+- spec/object_field/jsonizer_spec.rb
+- spec/object_field/serializer_spec.rb
+- spec/spec_helper.rb