jsos 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d441cffbf9bb670f441a13fa351d1cad6970af3
+  data.tar.gz: 6ccb84d6350854b0ee6e859404087163669ff49f
+SHA512:
+  metadata.gz: b822ba701f192cd25076818b23123a112affb0774012404f52acad154418ed0525a5218e130e31c7b94cb2b0f2a055e669d3fd3d0707e17c20edcf8fd1f26961
+  data.tar.gz: cd6d096acc2a6cf5ee0e0cba723bec0acc83ad8deffd3da61f5657cd06821a197495856e450199a6ff894951513df97c8a2a82b50c25cc41aaf2602aaf8d44a0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+before_install: gem install bundler -v 1.10.6
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Johnson Denen
+
+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,83 @@
+# JSOS
+[![Build Status](https://travis-ci.org/jdenen/jsos.svg?branch=master)](https://travis-ci.org/jdenen/jsos)
+
+Use Ruby's OpenStruct object to represent JSON strings, making nested data a method call away.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsos'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsos
+
+## Usage
+
+JSOS turns a JSON string into an OpenStruct. It also allows you to construct JSON strings from scratch. Setter methods are turned into JSON keys and their arguments become the values. Getter methods return those values.
+
+```ruby
+# parsing JSON into OpenStruct
+jsos = JSOS.new("{\"foo\":\"bar\"}")
+jsos.foo
+#=> "bar"
+
+# parsing Hash into OpenStruct
+jsos = JSOS.new({foo: "bar"})
+jsos.foo
+#=> "bar"
+
+# creating an empty object and converting to JSON
+jsos = JSOS.new
+jsos.to_json
+#=> "{}"
+
+# adding to the empty JSON
+jsos.foo = "bar"
+jsos.to_json
+#=> "{\"foo\":\"bar\"}"
+```
+
+A missing getter method is created with an empty JSOS object as its value. This allows you to chain methods to created nested JSON strings.
+
+```ruby
+# nesting empty JSON objects
+jsos = JSOS.new
+jsos.foo
+jsos.to_json
+#=> "{\"foo\":{}}"
+
+# chaining methods to create nested JSON strings
+jsos = JSOS.new
+jsos.abc.foo = "bar"
+jsos.xyz.foo = "baz"
+jsos.to_json
+#=> "{\"abc\":{\"foo\":\"bar\"}, \"xyz\":{\"foo\":\"baz\"}}"
+```
+
+You can grab object level keys and values like a normal Ruby Hash. These do not return nested keys/values.
+
+```ruby
+jsos = JSOS.new("{\"abc\":{\"foo\":\"bar\"}, \"xyz\":{\"foo\":\"baz\"}}")
+jsos.keys
+#=> ["abc", "xyz"]
+jsos.values
+#=> ["#<JSOS foo=\"bar\">", "#<JSOS foo=\"baz\">"]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jdenen/jsos.
+
+
+## License
+
+The gem is 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 "rejoinder"
+
+# 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/jsos.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "jsos"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Johnson Denen"]
+  spec.email         = ["johnson.denen@gmail.com"]
+
+  spec.summary       = %q{JSON as OpenStruct}
+  spec.description   = %q{Convert JSON into nested OpenStruct objects with ease.}
+  spec.homepage      = "https://github.com/jdenen/jsos"
+  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.0"
+  spec.add_development_dependency "simplecov", "~> 0.11"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "yard"
+end

data/lib/jsos.rb

@@ -0,0 +1,86 @@
+require "ostruct"
+require "json"
+
+#
+# Parse or construct JSON strings with OpenStruct objects.
+#
+# @example
+#   JSOS.new("{\"foo\":\"bar\"}")
+#
+# Setter methods add a key and a value to the object and are converted to JSON.
+#
+# @example
+#   jsos = JSOS.new
+#   jsos.foo = "bar"
+#   jsos.to_json
+#   #=> "{\"foo\":\"bar\"}"
+#
+# Getter methods represent the object keys and return their values.
+#
+# @example
+#   jsos = JSOS.new("{\"foo\":\"bar\"}")
+#   jsos.foo
+#   #=> "bar"
+#
+# Undefined getter methods act like setter methods. Their values become empty JSOS objects.
+#
+# @example
+#   jsos = JSOS.new
+#   jsos.foo
+#   jsos.to_json
+#   #=> "{\"foo\":{}}"
+#
+# Undefined getters can be chained with setters to create nested JSON objects.
+#
+# @example
+#   jsos = JSOS.new
+#   jsos.abc.foo = "bar"
+#   jsos.to_json
+#   #=> "{\"abc\":{\"foo\":\"bar\"}}"
+#
+class JSOS < OpenStruct
+
+  # @param state [String|Hash] defaults to nil
+  def initialize(state = nil)
+    state.is_a?(String) ? super(JSON.parse state) : super(state)
+  end
+
+  # @return [Hash]
+  def to_h
+    @table.each_with_object({}) do |(key, value), new_hash|
+      new_hash[key] = value.is_a?(JSOS) ? value.to_h : value
+    end
+  end
+
+  # @return [String]
+  def to_json
+    self.to_h.to_json
+  end
+
+  # @return [Array<Symbol>]
+  def keys
+    self.to_h.keys
+  end
+
+  # @return [Array]
+  def values
+    self.to_h.values
+  end
+
+  # @return [true|false]
+  def empty?
+    @table.empty?
+  end
+
+  private
+
+  # @api private
+  def method_missing methd, *args
+    methd.to_s.end_with?('=') ? super(methd, *args) : super(make_setter(methd), JSOS.new)
+  end
+
+  # @api private
+  def make_setter getter
+    getter.to_s.concat('=').to_sym
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: jsos
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Johnson Denen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-31 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: Convert JSON into nested OpenStruct objects with ease.
+email:
+- johnson.denen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsos.gemspec
+- lib/jsos.rb
+homepage: https://github.com/jdenen/jsos
+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: JSON as OpenStruct
+test_files: []
+has_rdoc: