jsoning 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e4d959011ca794ad4e783b547f7cbfe0e503cbb7
+  data.tar.gz: 4c6fea6be0eac306f0ffe0c7e5bd30c622e8efda
+SHA512:
+  metadata.gz: 699d0e152d55a6724a46dd6c35c5cc3840e69ee9f5c5f28d79c755e208635596b92d80193c4b5c0f12208e5d00a87aa5f5c80edf4a3d4e0ef8fa3628e7c12863
+  data.tar.gz: 1cfff70c84f877c08397c6511922b0b5c2415b4eff8059177ed6b86a11e315ae5d6037ab16acae3e12cc0acac6e41f93b4693290b9bd3b113e08ee24f4189999

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+*.swp
+*.swo
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Adam Pahlevi
+
+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,171 @@
+# Jsoning
+
+Turning object into json can sometimes be frustrating. With Jsoning, you could turn your
+everyday ruby object into JSON, very easily. It should work with
+any Ruby object there is. Kiss good bye to complexity
+
+[![Code Climate](https://codeclimate.com/github/saveav/jsoning/badges/gpa.svg)](https://codeclimate.com/github/saveav/jsoning)
+[ ![Codeship Status for saveav/bali](https://codeship.com/projects/b58d3950-493b-0133-a217-168d58eb1296/status?branch=release)](https://codeship.com/projects/105558)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'Jsoning'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsoning
+
+## Assumptions
+
+We have classes already defined as follow:
+
+```ruby
+module My; end
+class My::User
+  attr_accessor :name, :age, :gender
+  attr_accessor :taken_degree
+  attr_accessor :books
+
+  def initialize
+    self.books = []
+  end
+end
+class My::Book
+  attr_accessor :name
+  def initialize(name)
+    self.name = name
+  end
+end
+class My::UserDegree
+  attr_accessor :faculty
+  attr_accessor :degree_name
+
+  def to_s
+    "#{degree_name} at #{faculty}"
+  end
+end
+```
+
+## Usage
+
+Say, we want to serialize User. First, we have to define the serializer for `My::User`:
+
+```ruby
+Jsoning.for(My::User) do
+  key :name
+  key :years_old, from: :age
+  key :gender, default: "male"
+  key :books
+  key :degree_detail, from: :taken_degree
+end
+```
+
+But, as user have `books` and `taken_degree` which could be an instance of `My::Book` and `My::UserDegree`,
+on which Jsoning has no clue about how to serialize... you should define serializer for them as well:
+
+```ruby
+Jsoning.for(My::Book) do
+  key :name
+end
+
+Jsoning.for(My::UserDegree) do
+  key :faculty
+  key :degree, from: :degree_name
+end
+```
+
+So, where you put those codes? Anywhere you want it just make sure it is loaded/required. You can put it inside
+a file for each serializer, or a single file for all serializer. Anyway you want it.
+
+After those serializers are defined, we can have a test. Assume we let user to have value as follow:
+
+```ruby
+user = My::User.new
+user.name = "Adam Baihaqi"
+user.age = 21
+user.books << My::Book.new("Quiet: The Power of Introvert")
+user.books << My::Book.new("Harry Potter and the Half-Blood Prince")
+user
+```
+
+To serialize `user`, we only need to call:
+
+```ruby
+Jsoning(user)
+```
+
+Which will return:
+
+```json
+{"name":"Adam Baihaqi","years_old":21,"gender":"male","books":[{"name":"Quiet: The Power of Introvert"},{"name":"Harry Potter and the Half-Blood Prince"}],"degree_detail":null}
+```
+
+We can also pretty-print the value, which usually is bit slower though, by calling:
+
+```ruby
+Jsoning(user, pretty: true)
+```
+
+Which will return:
+
+```json
+{
+  "name": "Adam Baihaqi",
+  "years_old": 21,
+  "gender": "male",
+  "books": [
+    {
+      "name": "Quiet: The Power of Introvert"
+    },
+    {
+      "name": "Harry Potter and the Half-Blood Prince"
+    }
+  ],
+  "degree_detail": null
+}
+```
+
+Now, let us fill in the degree detail:
+
+```ruby
+degree = My::UserDegree.new
+degree.faculty = "School of IT"
+degree.degree_name = "B.Sc. (Hons) Computer Science"
+user.taken_degree = degree
+```
+
+Jsoning the user with pretty set to true, will return:
+
+```json
+{
+  "name": "Adam Baihaqi",
+  "years_old": 21,
+  "gender": "male",
+  "books": [
+    {
+      "name": "Quiet: The Power of Introvert"
+    },
+    {
+      "name": "Harry Potter and the Half-Blood Prince"
+    }
+  ],
+  "degree_detail": {
+    "faculty": "School of IT",
+    "degree": "B.Sc. (Hons) Computer Science"
+  }
+}
+```
+
+Wish it to be helpful for you! Enjoy!
+
+## License
+
+The gem is proudly available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jsoning"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/jsoning.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsoning/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsoning"
+  spec.version       = Jsoning::VERSION
+  spec.authors       = ["Adam Pahlevi"]
+  spec.email         = ["adam.pahlevi@gmail.com"]
+
+  spec.summary       = %q{Turns any of your everyday ruby objects to json formats, the way you always want it}
+  spec.description   = %q{Turning object into json can sometimes be frustrating. With Jsoning, you could turn your
+                            everyday ruby object into JSON, very easily. It should work with
+                            any Ruby object there is. Kiss good bye to complexity!}
+  spec.homepage      = "http://github.com/saveav/jsoning"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

data/lib/jsoning/dsl/for_dsl.rb

@@ -0,0 +1,43 @@
+class Jsoning::ForDsl
+  attr_reader :protocol
+
+  def initialize(protocol)
+    @protocol = protocol
+  end
+
+  # args is first specifying the name for variable to be displayed in JSON docs,
+  # and then the options. options are optional, if set, it can contains:
+  # - from
+  # - null
+  # - default
+  def key *args
+    mapped_to = nil
+    mapped_from = nil
+    options = {}
+
+    args.each do |arg|
+      if arg.is_a?(String) || arg.is_a?(Symbol)
+        mapped_to = arg
+      elsif arg.is_a?(Hash)
+        options = arg
+      end
+    end
+
+    mapper = Jsoning::Mapper.new
+    if block_given?
+      raise Jsoning::Error, "Cannot parse block to key"
+    else
+      mapped_from = options.delete(:from) || options.delete("from") || mapped_to
+      mapper.parallel_variable = mapped_from
+    end
+
+    mapper.name = mapped_to
+    mapper.default_value = options.delete(:default) || options.delete("default")
+    mapper.nullable = options.delete(:null)
+    mapper.nullable = options.delete("null") if mapper.nullable.nil?
+
+    options.keys { |key| raise Jsoning::Error, "Undefined option: #{key}" }
+
+    protocol.add_mapper mapper
+  end
+end

data/lib/jsoning/exceptions/error.rb

@@ -0,0 +1,2 @@
+class Jsoning::Error < StandardError
+end

data/lib/jsoning/foundations/mapper.rb

@@ -0,0 +1,73 @@
+# takes care of translating/fetching values from the object
+class Jsoning::Mapper
+  # when mapped, what will be the mapped name
+  attr_writer :name
+
+  attr_accessor :default_value
+  attr_writer :nullable
+  # what variable in the object will be used to obtain the value
+  attr_accessor :parallel_variable
+  attr_accessor :custom_block
+
+  def initialize
+    self.parallel_variable = nil
+    self.default_value = nil
+    self.nullable = true
+  end
+
+  def nullable
+    if @nullable.is_a?(TrueClass) || @nullable.is_a?(FalseClass)
+      return @nullable
+    else
+      # by default, allow every mapped things to be nil
+      true
+    end
+  end
+
+  def name
+    @name_as_string = @name.to_s if @name_as_string.nil?
+    @name_as_string
+  end
+
+  # map this very specific object's field to target_hash
+  def extract(object, target_hash)
+    if object.respond_to?(parallel_variable)
+      parallel_val = object.send(parallel_variable)
+      parallel_val = default_value if parallel_val.nil?
+      target_hash[name] = deep_parse(parallel_val)
+    else
+      if default_value
+        target_hash[name] = deep_parse(default_value)
+      else
+        unless nullable
+          raise Jsoning::Error, "Null value given for '#{name}' when serializing #{object}"
+        end
+      end
+    end
+  end
+
+  private
+    def deep_parse(object)
+      parsed_data = nil
+
+      if object.is_a?(Array)
+        parsed_data = []
+        object.each do |each_obj|
+          parsed_data << deep_parse(each_obj)
+        end
+      elsif object.is_a?(Hash)
+        parsed_data = {}
+        object.each do |obj_key_name, obj_val|
+          parsed_data[obj_key_name] = deep_parse(obj_val)
+        end
+      elsif object.is_a?(Integer) || object.is_a?(Float) || object.is_a?(String) ||
+        object.is_a?(TrueClass) || object.is_a?(FalseClass) || object.is_a?(NilClass)
+        parsed_data = object
+      else
+        protocol = Jsoning.protocol_for!(object.class)
+        parsed_data = protocol.parse(object)
+      end
+
+      parsed_data
+    end
+end

data/lib/jsoning/foundations/protocol.rb

@@ -0,0 +1,59 @@
+# takes care of the class
+class Jsoning::Protocol
+  attr_reader :klass
+  attr_reader :mappers
+  attr_reader :mappers_order
+
+  def initialize(klass)
+    @klass = klass
+
+    # mappers, only storing symbol of mapped values
+    @mappers_order = []
+
+    @mappers = {}
+  end
+
+  def add_mapper(mapper)
+    raise Jsoning::Error, "Mapper must be of class Jsoning::Mapper" unless mapper.is_a?(Jsoning::Mapper)
+    @mappers_order << canonical_name(mapper.name)
+    @mappers[canonical_name(mapper.name)] = mapper
+  end
+
+  def mapper_for(name)
+    @mappers[canonical_name(name)]
+  end
+
+  # generate a JSON object
+  # options:
+  # - pretty: pretty print json data
+  def generate(object, options = {})
+    pretty = options[:pretty]
+    pretty = options["pretty"] if pretty.nil?
+    pretty = false if pretty.nil?
+
+    data = parse(object)
+
+    if pretty
+      JSON.pretty_generate(data)
+    else
+      JSON.generate(data)
+    end
+  end
+
+  def parse(object)
+    # hold data here
+    data = {}
+
+    mappers_order.each do |mapper_sym|
+      mapper = mapper_for(mapper_sym)
+      mapper.extract(object, data)
+    end
+
+    data
+  end
+
+  private
+  def canonical_name(key_name)
+    key_name.to_s.downcase.to_sym
+  end
+end

data/lib/jsoning/version.rb

@@ -0,0 +1,3 @@
+module Jsoning
+  VERSION = "0.1.0"
+end

data/lib/jsoning.rb

@@ -0,0 +1,52 @@
+require "jsoning/version"
+
+require "jsoning/dsl/for_dsl"
+require "jsoning/exceptions/error"
+require "jsoning/foundations/mapper"
+require "jsoning/foundations/protocol"
+
+require "json"
+
+module Jsoning
+  PROTOCOLS = {}
+
+  module_function
+
+  # returns a protocol, or create one if none exists
+  def protocol_for(klass)
+    protocol = PROTOCOLS[klass.to_s]
+    if protocol.nil?
+      protocol = Jsoning::Protocol.new(klass)
+      PROTOCOLS[klass.to_s] = protocol
+    end
+    protocol
+  end
+
+  def protocol_for!(klass)
+    protocol = PROTOCOLS[klass.to_s]
+    raise Jsoning::Error, "Undefined Jsoning protocol for #{klass.to_s}" if protocol.nil?
+    protocol
+  end
+
+  def clear
+    PROTOCOLS.clear
+  end
+
+  def for(klass, &block)
+    Jsoning::ForDsl.new(protocol_for(klass)).instance_eval(&block)
+  end
+
+  def generate(object, options = {})
+    protocol = protocol_for!(object.class)
+    protocol.generate(object, options)
+  end
+
+  # monkey patch Kernel
+  module ::Kernel
+    private
+
+    def Jsoning(object, options = {})
+      Jsoning.generate(object, options)
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: jsoning
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Pahlevi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: |-
+  Turning object into json can sometimes be frustrating. With Jsoning, you could turn your
+                              everyday ruby object into JSON, very easily. It should work with
+                              any Ruby object there is. Kiss good bye to complexity!
+email:
+- adam.pahlevi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsoning.gemspec
+- lib/jsoning.rb
+- lib/jsoning/dsl/for_dsl.rb
+- lib/jsoning/exceptions/error.rb
+- lib/jsoning/foundations/mapper.rb
+- lib/jsoning/foundations/protocol.rb
+- lib/jsoning/version.rb
+homepage: http://github.com/saveav/jsoning
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Turns any of your everyday ruby objects to json formats, the way you always
+  want it
+test_files: []
+has_rdoc: