jsonizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 475471c240795e2d040c4bb43f97cba7d51852a2
+  data.tar.gz: c90ad644ce4695df7b025ae5f851ed757131a7d0
+SHA512:
+  metadata.gz: 65bb931630c2f6ca7141b085013164cdf051060123021d342656807daf9df339eb3953af2c9298b7255ba0968aca37969f03c449ea811b084c7c5900eada4771
+  data.tar.gz: d585c241c0228a6b322c2f7a838a13a54ccf40d58b803f93521dc26b1d968895b4923cecc06b24a6711ae7294d239cfc952d98849ea820e9205c19b978f4aa63

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonizer.gemspec
+gemspec
+gem 'coveralls', group: :test, require: false

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    jsonizer (0.1.0)
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    adamantium (0.0.7)
+      backports (~> 3.0, >= 3.0.3)
+      ice_nine (~> 0.7.0)
+    backports (3.1.1)
+    colorize (0.5.8)
+    coveralls (0.6.3)
+      colorize
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      thor
+    diff-lcs (1.2.2)
+    equalizer (0.0.5)
+      adamantium (~> 0.0.6)
+      backports (~> 3.0, >= 3.0.3)
+    ice_nine (0.7.0)
+    json (1.7.7)
+    mime-types (1.22)
+    multi_json (1.7.2)
+    rake (10.0.4)
+    redcarpet (2.2.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    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.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    thor (0.18.1)
+    yard (0.8.5.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  coveralls
+  equalizer
+  jsonizer!
+  rake
+  redcarpet
+  rspec
+  simplecov
+  yard

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Simon Kohlmeyer
+
+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,86 @@
+[![Build Status](https://secure.travis-ci.org/voidus/jsonizer.png?branch=master)][travis]
+[![Code Climate](https://codeclimate.com/github/voidus/jsonizer.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/voidus/jsonizer/badge.png?branch=master)][coveralls]
+[![Dependencied](https://gemnasium.com/voidus/jsonizer.png)][dependencies]
+
+[travis]: https://travis-ci.org/voidus/jsonizer
+[codeclimate]: https://codeclimate.com/github/voidus/jsonizer
+[coveralls]: https://coveralls.io/r/voidus/jsonizer
+[dependencies]: https://gemnasium.com/voidus/jsonizer
+
+# Jsonizer
+
+Module to easily provide json serialization
+
+It was structurally inspired by http://github.com/dkubb/equalizer
+
+## Installation
+
+Using [Bundler](http://gembundler.com) (recommended)
+
+  * Add `gem 'jsonizer'` to your Gemfile
+  * Run `bundle install`
+
+Using rubygems
+
+  * Run `gem install jsonizer`
+
+Installing from git
+
+  * Clone the repository using `git clone git://github.com/voidus/jsonizer`
+  * Enter the directory using `cd jsonizer`
+  * Build and install the gem with `rake install`
+
+## Usage
+
+```ruby
+class TransferObject
+  include Jsonizer.new :operation_id, :parameter
+
+  attr_reader :operation_id, :parameter
+  attr_accessor :calculation_strategy
+
+  def initialize operation_id, parameter, transient = "default transient attribute"
+    @operation_id = operation_id
+    @parameter = parameter
+    @transient_attribute = transient
+  end
+end
+
+TestTransferObject.new("add", [15, 20], 'transient').to_json nil
+  # {"json_class":"TestTransferObject","operation_id":"add","parameter":[15,20]}
+
+JSON.dump(TestTransferObject.new("add", [15, 20], 'transient))
+  # {"json_class":"TestTransferObject","operation_id":"add","parameter":[15,20]}
+
+JSON.load(JSON.dump(TestTransferObject.new("add", [15, 20], 'transient))).inspect
+  # #<TestTransferObject:0x000000018ae188
+  #   @operation_id="add",
+  #   @parameter=[15, 20],
+  #   @transient_attribute="default transient attribute">
+
+JSON.dump(TestTransferObject.new("nested", TestTransferObject.new("op", "param")))
+  # {"json_class":"TestTransferObject",
+  #  "operation_id":"nested",
+  #  "parameter":
+  #     {"json_class":"TestTransferObject",
+  #      "operation_id":"op",
+  #      "parameter":"param"}}
+
+JSON.load(JSON.dump(TestTransferObject.new("nested", TestTransferObject.new("op", "param"))))
+  # <TestTransferObject:0x0000000268d308
+  #   @operation_id="nested",
+  #   @parameter=#<TestTransferObject:0x0000000268d5b0
+  #                @operation_id="op",
+  #                @parameter="param",
+  #                @transient_attribute="default transient attribute">,
+  #   @transient_attribute="default transient attribute">
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your tests and changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/jsonizer.rb

@@ -0,0 +1,2 @@
+require 'jsonizer/version'
+require 'jsonizer/jsonizer'

data/lib/jsonizer/jsonizer.rb

@@ -0,0 +1,66 @@
+require 'json'
+
+# Defines all methods neccessary for JSON encoding through JSON[], JSON.dump and #to_json
+class Jsonizer < Module
+
+  # Initialize a Jsonizer to use the given attributes
+  #
+  # They will be used to define as_json, to_json and self.json_create
+  #
+  # @param [Array<Symbol>] attributes
+  # @return [undefined]
+  def initialize *attributes
+    @attributes = attributes
+    define_as_json
+    define_to_json
+  end
+
+  # Include the equalizer instance into mod
+  #
+  # @param mod [Module]
+  # @return [undefined]
+  def included mod
+    raise ArgumentError, "Cannot jsonize anonymous classes. They cannot be restored." unless mod.name
+    mod.extend(class_methods_module)
+  end
+
+private
+
+  # Define #as_json using @attributes that returns a hash that will be converted to json
+  #
+  # @return [undefined]
+  def define_as_json
+    attributes = @attributes
+    define_method :as_json do |*|
+      hash = {'json_class' => self.class.name}
+      attributes.each do |attribute|
+        hash[attribute.to_s] = self.send(attribute.to_sym)
+      end
+      hash
+    end
+  end
+
+  # Define to_json that converts #as_json to a json string
+  #
+  # @return [undefined]
+  def define_to_json
+    define_method :to_json do |*|
+      as_json.to_json
+    end
+  end
+
+  # Creates a module that defines #json_create using the given attributes.
+  #
+  # It will pass them as positional attributes to #new in the same order that they were given in Jsonizer.new
+  #
+  # @return [undefined]
+  def class_methods_module
+    attributes = @attributes
+    Module.new do
+      define_method :json_create do |values|
+        params = attributes.map {|attribute| values[attribute.to_s]}
+        new(*params)
+      end
+    end
+  end
+end

data/lib/jsonizer/version.rb

@@ -0,0 +1,3 @@
+class Jsonizer < Module
+  VERSION = "0.1.0"
+end

data/spec/jsonizer_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+require 'json'
+require 'equalizer'
+
+describe Jsonizer do
+  it 'should have a version number' do
+    Jsonizer::VERSION.should_not be_nil
+  end
+
+  context 'When included without parameters' do
+    class NoParamIncludeClass
+      include Jsonizer.new
+    end
+
+    subject {NoParamIncludeClass.new}
+
+    it {should respond_to :to_json}
+    its(:class) {should respond_to :json_create}
+    it {should be_same_class_after_json}
+  end
+
+  context "With a jsonized and an unrelated attribute" do
+    class WithUnrelated
+      include Jsonizer.new :jsonized_attribute
+      include Equalizer.new :jsonized_attribute, :unrelated_attribute
+      attr_reader :jsonized_attribute, :unrelated_attribute
+
+      def initialize jsonized_attribute, unrelated_attribute = 'default_unrelated_attribute'
+        @jsonized_attribute = jsonized_attribute
+        @unrelated_attribute = unrelated_attribute
+      end
+    end
+
+    let(:original) {WithUnrelated.new 'original_jsonized_attribute', 'original_unrelated_attribute'}
+    subject {original}
+    it {should respond_to :to_json}
+    its(:class) {should respond_to :json_create}
+    it {should be_same_class_after_json}
+    it {should_not be_eql_after_json}
+
+    describe "after json conversion" do
+      subject {JSON.load(JSON.dump(original))}
+      its(:jsonized_attribute) {should eql original.jsonized_attribute}
+      its(:unrelated_attribute) {should_not eql original.unrelated_attribute}
+      its(:unrelated_attribute) {should eql 'default_unrelated_attribute'}
+    end
+  end
+
+  context "With multiple jsonized and unrelated attribute" do
+    class Multiple
+      include Jsonizer.new :jsonized_a, :jsonized_b
+      include Equalizer.new :jsonized_a, :unrelated_attribute
+      attr_reader :jsonized_a, :jsonized_b, :unrelated_attribute
+
+      def initialize jsonized_a, jsonized_b = 14, unrelated_attribute = 'default_unrelated_attribute'
+        @jsonized_a = jsonized_a
+        @jsonized_b = jsonized_a
+        @unrelated_attribute = unrelated_attribute
+      end
+    end
+
+    let(:original) {Multiple.new 'original_jsonized_a', 1024, 'original_unrelated_attribute'}
+    subject {original}
+
+    it {should respond_to :to_json}
+    its(:class) {should respond_to :json_create}
+    it {should be_same_class_after_json}
+    it {should_not be_eql_after_json}
+
+    describe "after json conversion" do
+      subject {JSON.load(JSON.dump(original))}
+      its(:jsonized_a) {should eql original.jsonized_a}
+      its(:jsonized_b) {should eql original.jsonized_b}
+      its(:unrelated_attribute) {should_not eql original.unrelated_attribute}
+      its(:unrelated_attribute) {should eql 'default_unrelated_attribute'}
+    end
+  end
+
+  context "Anonymous classes" do
+    it "should throw when included" do
+      expect {Class.new do include Jsonizer.new end}.to raise_error ArgumentError
+    end
+  end
+end

data/spec/matchers.rb

@@ -0,0 +1,46 @@
+def to_json_and_back obj
+  JSON.load(JSON.dump(obj))
+end
+
+RSpec::Matchers.define :be_same_class_after_json do
+  match do |subject|
+    to_json_and_back(subject).class.equal? subject.class
+  end
+
+  failure_message_for_should do |subject|
+    actual = to_json_and_back subject
+    <<HERE
+expected #{subject.inspect} to be the same class after json dump-load
+got class  #{actual.class} instead
+value: #{actual.inspect}
+HERE
+  end
+
+  description do
+    "be the same class after JSON.dump and JSON.load"
+  end
+end
+
+RSpec::Matchers.define :be_eql_after_json do
+  match do |subject|
+    to_json_and_back(subject).eql? subject
+  end
+
+  failure_message_for_should do |subject|
+    <<HERE
+expected #{subject.inspect} to be eql after json dump-load
+got      #{to_json_and_back(subject).inspect} instead"
+HERE
+  end
+
+  failure_message_for_should_not do |subject|
+    <<HERE
+expected #{subject.inspect} not to be eql after json dump-load
+(got     #{to_json_and_back(subject).inspect} after dump/load)"
+HERE
+  end
+
+  description do
+    "be the eql after JSON.dump and JSON.load"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+unless ENV['autotest']
+  require 'simplecov'
+  require 'coveralls'
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'jsonizer'
+
+require_relative 'matchers'

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: jsonizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Kohlmeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: equalizer
+  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: yard
+  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: redcarpet
+  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'
+description: |
+  Module to easily provide json serialization
+  Structurally inspired by http://github.com/dkubb/equalizer
+email:
+- simon.kohlmeyer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jsonizer.rb
+- lib/jsonizer/jsonizer.rb
+- lib/jsonizer/version.rb
+- spec/jsonizer_spec.rb
+- spec/matchers.rb
+- spec/spec_helper.rb
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+homepage: http://github.com/voidus/jsonizer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0.rc.2
+signing_key: 
+specification_version: 4
+summary: Module to easily provide json serialization
+test_files:
+- spec/jsonizer_spec.rb
+- spec/matchers.rb
+- spec/spec_helper.rb
+has_rdoc: