A gem that converts a JSON to Ruby classes and returns the produced result into a string.
Ruby Shell
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
json_to_ruby_class.gemspec

README.md

JsonToRubyClass

Build Status Gem Version

JsonToRubyClass is a gem that converts a JSON to a list of Ruby classes and outputs it into a string.

Installation

Add this line to your application's Gemfile:

gem 'json_to_ruby_class'

And then execute:

$ bundle

Or install it yourself as:

$ gem install json_to_ruby_class

Usage

json = <<-JSON
{
  "students": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "age": 15
    },
    {
      "firstName": "Anna",
      "lastName": "Smith",
      "age": 16
    }
  ]
}
JSON

puts JsonToRubyClass.produce_models(json)

This produces the following:

class Student
   attr_accessor :first_name,
                 :last_name,
                 :age
end

class Example
   attr_accessor :students
end

Furthermore, the following types can be used to retrieve the proper classes in other languages:

  • 'c#', for C# classes
  • 'vb', for VB.net classes

Example use:

puts JsonToRubyClass.produce_models(json, 'c#')

public class Student
{
   public string firstName { get; set; }
   public string lastName { get; set; }
   public int age { get; set; }
}

public class Example
{
   public Student[] students { get; set; }
}

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/arcanoid/json_to_ruby_class. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.