json-mapping 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36115b277de00edeac034d137cd1c01260e6eaf481b43ff6fe92876c09f0dba0
+  data.tar.gz: 07bc837a965f0118fc0b3d5fd90e079e311df65db3298dcb9f52cd4b66d7eee6
+SHA512:
+  metadata.gz: b7f016a61fdec360c354ee27a0d68cc15968e81cf124d5c3150df37f3c672cfb66ee5105601e2ba88c40d17ae11cbd504d89b93c8b710267f72b2fb12ae87d95
+  data.tar.gz: b84fc2b1f140bc7a9d4e1b2e197f757f5668c9869a61aaa2271815544088e7df7a7c2b80aa5370a10c29d2b4b55eab2f340d56c4a310a49ef6a43a1b503046fb

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Minor Release v0.1.0 (2019-10-23)
+  * **Kjarrigan**
+    * Basic mapping works { field_name => type }
+    
+
+*Released by Kjarrigan <github@kjarrigan.de>*

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+group :development do
+  gem 'rspec', '~> 3.0'
+  gem 'simplecov'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Kjarrigan
+
+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,36 @@
+# JSON.mapping
+
+A simple JSON mapper inspired by [Crystals](https://crystal-lang.org/api/JSON.html) `JSON.mapping`
+
+## Usage
+
+```ruby
+require "json"
+
+class Location
+  JSON.mapping(
+    lat: Float64,
+    lng: Float64,
+  )
+end
+
+class House
+  JSON.mapping(
+    address: String,
+    location: {type: Location, nilable: true},
+  )
+end
+
+house = House.from_json(%({"address": "Crystal Road 1234", "location": {"lat": 12.3, "lng": 34.5}}))
+house.address  # => "Crystal Road 1234"
+house.location # => #<Location:0x10cd93d80 @lat=12.3, @lng=34.5>
+house.to_json  # => %({"address":"Crystal Road 1234","location":{"lat":12.3,"lng":34.5}})
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Kjarrigan/json-mapping.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/json-mapping.gemspec

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json/mapping/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'json-mapping'
+  spec.version       = JSON::Mapping::VERSION
+  spec.authors       = ['Kjarrigan']
+  spec.email         = ['github@kjarrigan.de']
+
+  spec.summary       = 'Define ruby objects to directly parse from JSON.'
+  spec.description   = "Inspired by Crystal's JSON.mapping."
+  spec.homepage      = 'https://github.com/kjarrigan/json-mapping'
+  spec.license       = 'MIT'
+
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/json/mapping.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'json/mapping/version'
+
+module JSON
+  class Mapping
+    class Error < StandardError; end
+  end
+
+  def self.mapping(klass, fields)
+    fields.each do |name, typ|
+      klass.attr_reader name
+      klass.define_method "#{name}=" do |value|
+        value = typ.new(value) if typ.respond_to?(:from_json)
+        unless value.is_a?(typ)
+          raise JSON::Mapping::Error, "Wrong field type #{self.class} for '#{name}' - should be '#{typ}'"
+        end
+
+        instance_variable_set "@#{name}", value
+      end
+    end
+
+    klass.define_method :initialize do |params = {}|
+      params.each do |name, value|
+        unless fields.key?(name.to_sym)
+          raise JSON::Mapping::Error, "Missing field definition for '#{name}'"
+        end
+
+        send("#{name}=", value)
+      end
+    end
+
+    klass.define_singleton_method :from_json do |string|
+      klass.new(JSON.parse(string))
+    end
+  end
+end

data/lib/json/mapping/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module JSON
+  class Mapping
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: json-mapping
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kjarrigan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-10-23 00:00:00.000000000 Z
+dependencies: []
+description: Inspired by Crystal's JSON.mapping.
+email:
+- github@kjarrigan.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- json-mapping.gemspec
+- lib/json/mapping.rb
+- lib/json/mapping/version.rb
+homepage: https://github.com/kjarrigan/json-mapping
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Define ruby objects to directly parse from JSON.
+test_files: []