json2ruby 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+coverage
+testjson
+classes
+*.gem

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.5
+sudo: false

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,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    json2ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coveralls (0.8.2)
+      json (~> 1.8)
+      rest-client (>= 1.6.8, < 2)
+      simplecov (~> 0.10.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    domain_name (0.5.24)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    json (1.8.3)
+    mime-types (2.6.1)
+    netrc (0.10.3)
+    rake (10.4.2)
+    rdoc (4.2.0)
+      json (~> 1.4)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    sdoc (0.4.1)
+      json (~> 1.7, >= 1.7.7)
+      rdoc (~> 4.0)
+    simplecov (0.10.0)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
+    term-ansicolor (1.3.2)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.6.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  coveralls
+  json2ruby!
+  rake (~> 10.0)
+  rdoc (~> 4.1)
+  rspec (~> 3.1)
+  rspec-mocks (~> 3.1)
+  sdoc (~> 0.4)
+  simplecov (~> 0.10.0)
+  simplecov-rcov (~> 0.2)
+
+BUNDLED WITH
+   1.10.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tom Cully
+
+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,78 @@
+# json2ruby
+
+[![Build Status](https://travis-ci.org/tomdionysus/json2ruby.svg?branch=master)](https://travis-ci.org/tomdionysus/json2ruby) [![Coverage Status](https://coveralls.io/repos/tomdionysus/json2ruby/badge.svg?branch=master&service=github)](https://coveralls.io/github/tomdionysus/json2ruby?branch=master)
+
+A ruby rool for generating POROs from JSON data. It is intended to generate ruby model classes/modules from existing JSON data, e.g. responses from an API.
+
+The tool will 'fold down' objects with identical fields - i.e. if an object has exactly the same field names and types as another, it will assume they are the same type.
+
+'Root' entities are named after the files that they are parsed from. Entities with no obvious name (items in an array, for instance) are named `Unknown<x>` where `x` increments from 1. 
+
+## Installation
+
+```bash
+git clone git@github.com:tomdionysus/json2ruby.git
+```
+
+## Usage
+
+```bash
+json2ruby.rb [options] <file.json> [<file.json>....]
+```
+
+| Option Flags             | Default          | Description                                     |
+|:-------------------------|:-----------------|:-------------------------------------------------|
+| `-o, --outputdir`        | `./classes`      | The output directory for Ruby files             |
+| `-m, --modulename`       |                  | The Ruby module for files                       |
+| `-s, --superclass`       |                  | The superclass for classes                      |
+| `-r, --require`          |                  | Add ruby `require` to files                     |
+| `-i, --include`          |                  | Add ruby `include` to files                     |
+| `-e, --extend`           |                  | Add ruby `extend` to files                      |
+| `-M, --modules`          |                  | Generate Ruby modules, not classes              |
+| `-a, --attributemethod`  | `attr_accessor`  | Use a custom attribute definition method        |
+| `-c, --collectionmethod` | `attr_accessor`  | Use a custom collection definition method       |
+| `-t, --types`            |                  | Include type name in attribute definition call  |
+| `-b, --baseless`         |                  | Don't generate for the root object in each file |
+| `-f, --forceoverwrite`   |                  | Overwrite Existing files                        |
+| `-N, --forcenumeric`     |                  | Use Numeric instead of Integer/Float            |
+| `-v, --verbose`          |                  | Be verbose, List every operation/file           |
+
+## Example
+
+Generate a simple set of POROs from an API response JSON file, be verbose:
+
+```bash
+./json2ruby.rb -v data.json
+```
+
+Generate a (very) basic set of [apotonick/representable](https://github.com/apotonick/representable) compatible representer modules:
+
+```bash
+./json2ruby.rb -r representable/json-i Representable::JSON -M -a property -c collection data.json 
+```
+
+## Notes
+
+The option `-m, --modulename` can take path module names in `FirstModule::Submodule::SubSubModule` format, which will produce classes like so:
+
+```ruby
+module FirstModule
+  module Submodule
+    module SubSubModule
+      class JSONObject
+      ...
+      end
+    end
+  end
+end
+```
+
+The option `-N, --forcenumeric` can be useful to fold down identical types where an attribute which is a float happens to have an integer value, to avoid generating two identical types.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added 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/bin/json2ruby

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "#{File.expand_path("../lib/json2ruby",File.dirname(__FILE__))}"
+
+JSON2Ruby::CLI.run

data/json2ruby.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/json2ruby/version', __FILE__)
+
+Gem::Specification.new do |s|  
+  s.authors       = ["Tom Cully"]
+  s.email         = ["tomhughcully@gmail.com"]
+  s.summary       = 'A ruby rool for generating POROs from JSON data'
+  s.description   = 'json2ruby is intended to generate ruby model classes/modules from existing JSON data, e.g. responses from an API.'
+  s.homepage      = "http://github.com/tomdionysus/json2ruby"
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = ["json2ruby"]
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.name          = "json2ruby"
+  s.require_paths = ["lib"]
+  s.version       = JSON2Ruby::VERSION
+
+  s.add_development_dependency "coveralls"
+  s.add_development_dependency "bundler", "~> 1.10"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency 'simplecov',        '~> 0.10.0'
+  s.add_development_dependency 'simplecov-rcov',   '~> 0.2'
+  s.add_development_dependency 'rdoc',             '~> 4.1'
+  s.add_development_dependency 'sdoc',             '~> 0.4'
+  s.add_development_dependency 'rspec',            '~> 3.1'
+  s.add_development_dependency 'rspec-mocks',      '~> 3.1'
+end  

data/lib/json2ruby.rb

@@ -0,0 +1,9 @@
+files = [
+  'version',
+  'primitive',
+  'attribute',
+  'collection',
+  'entity',
+  'ruby_writer',
+  'cli',
+].each { |file| require "#{File.dirname(__FILE__)}/json2ruby/#{file}" }

data/lib/json2ruby/attribute.rb

@@ -0,0 +1,25 @@
+require 'digest/md5'
+
+module JSON2Ruby
+  class Attribute
+    attr_accessor :name, :original_name, :ruby_type
+
+    def self.short_name
+      "Attribute"
+    end
+
+    def initialize(name, ruby_type = nil)
+      @name = name
+      @ruby_type = ruby_type || "_unknown"
+    end
+
+    def attr_hash
+      Digest::MD5.hexdigest("#{@name}:#{@ruby_type}")
+    end
+
+    def ==(other)
+      return false if other.class != self.class
+      attr_hash == other.attr_hash
+    end
+  end
+end

data/lib/json2ruby/cli.rb

@@ -0,0 +1,183 @@
+require 'digest/md5'
+require 'json'
+require 'optparse'
+
+module JSON2Ruby
+
+  class CLI
+    def self.run
+
+      puts "json2ruby v#{VERSION}\n"
+
+      # Do the cmdline options
+      options = get_cli_options
+
+      # Ensure Output Directory
+      options[:outputdir] = File.expand_path(options[:outputdir], File.dirname(__FILE__))      
+      ensure_output_dir(options)
+
+      # Parse Files
+      rootclasses = parse_files(options)
+
+      # Write out Ruby (see what I'm doing here?)
+      writer = JSON2Ruby::RubyWriter
+
+      # Write Output
+      write_files(rootclasses, writer, options)
+    end
+
+    def self.ensure_output_dir(options)
+      puts "Output Directory: #{options[:outputdir]}" if options[:verbose]
+      unless Dir.exists?(options[:outputdir])
+        puts "Creating Output Directory..." if options[:verbose]
+        Dir.mkdir(options[:outputdir])
+      end
+    end
+
+    def self.get_cli_options
+
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = "Usage: #{$0} [options] <file.json> [<file.json>....]"
+
+        opts.on("-o", "--outputdir OUTPUTDIR", "Output directory") do |v|
+          options[:outputdir] = v
+        end
+
+        opts.on("-n", "--namespace MODULENAME", "Module namespace path") do |v|
+          options[:namespace] = v
+        end
+
+        opts.on("-s", "--superclass SUPERCLASS", "Class ancestor") do |v|
+          options[:superclass_name] = v
+        end
+
+        opts.on("-r", "--require REQUIRE", "Require module in file") do |v|
+          options[:require] ||= []
+          options[:require] << v
+        end
+
+        opts.on("-i", "--include INCLUDE", "Include Class/Module in file") do |v|
+          options[:include] ||= []
+          options[:include] << v
+        end
+
+        opts.on("-e", "--extend EXTEND", "Extend from Class/Module in file") do |v|
+          options[:extend] ||= []
+          options[:extend] << v
+        end
+
+        opts.on("-M", "--modules", "Create Modules, not classes") do |v|
+          options[:modules] = true
+        end
+
+        opts.on("-a", "--attributemethod METHODNAME", "Use attribute method instead of attr_accessor") do |v|
+          options[:attributemethod] = v
+        end
+
+        opts.on("-c", "--collectionmethod METHODNAME", "Use collection method instead of attr_accessor") do |v|
+          options[:collectionmethod] = v
+        end
+
+        opts.on("-t", "--types", "Include type in attribute definition call") do |v|
+          options[:includetypes] = true
+        end
+
+        opts.on("-b", "--baseless", "Don't generate classes/modules for the root JSON in each file") do |v|
+          options[:baseless] = true
+        end
+
+        opts.on("-f", "--forceoverwrite", "Overwrite Existing files") do |v|
+          options[:forceoverwrite] = v
+        end
+
+        opts.on("-N", "--forcenumeric", "Use Numeric instead of Integer/Float") do |v|
+          options[:forcenumeric] = v
+        end
+
+        opts.on("-v", "--verbose", "Verbose") do |v|
+          options[:verbose] = v
+        end
+      end.parse!
+
+      # Defaults
+      options[:outputdir] ||= File.expand_path("./classes")
+      options[:namespace] ||= ""
+      options[:attributemethod] ||= "attr_accessor"
+      options[:collectionmethod] ||= "attr_accessor"
+      options[:includetypes] ||= false
+      options[:baseless] ||= false
+      options[:forceoverwrite] ||= false
+      options[:verbose] ||= false
+
+      options[:modulenames] = options[:namespace].split("::")
+
+      options
+    end
+
+    def self.parse_files(options)
+      # Reset the object cache
+      Entity.reset_parse
+
+      # Load and parse each JSON file
+      puts "Parsing Files..." if options[:verbose]
+
+      rootclasses = []
+
+      ARGV.each do |filename|
+        filename = File.expand_path(filename)
+        puts "Processing: #{filename}" if options[:verbose]
+
+        file = File.read(filename)
+        data_hash = JSON.parse(file)
+
+        rootclasses << Entity.parse_from(File.basename(filename,'.*'), data_hash, options)
+      end
+
+      rootclasses
+    end
+
+    def self.write_files(rootclasses, writer, options)
+      files = 0
+      Entity.entities.each do |k,v|
+        next if options[:baseless] and rootclasses.include?(v)
+
+        display_entity(k,v) if options[:verbose] && !v.is_a?(Primitive)
+
+        if v.is_a?(Entity)
+          indent = 0
+          out = ""
+          options[:modulenames].each do |v|
+            out += (' '*indent)+"module #{v}\r\n"
+            indent += 2
+          end
+          out += writer.to_code(v, indent,options)
+          while indent>0
+            indent -= 2
+            out += (' '*indent)+"end\r\n"
+          end
+
+          filename = options[:outputdir]+"/#{v.name}.rb"
+          if File.exists?(filename) && !options[:forceoverwrite]
+            $stderr.puts "File #{filename} exists. Use -f to overwrite."
+          else
+            File.write(filename, out)
+            files += 1
+          end
+        end
+      end
+
+      # Done
+      puts "Done, Generated #{files} file#{files==1 ? '' : 's'}"
+    end
+
+    def self.display_entity(hsh, ent)
+      puts "- #{ent.name} (#{ent.class.short_name} - #{hsh})"
+      if ent.is_a?(Entity)
+        ent.attributes.each { |ak,av| puts "  #{ak}: #{av.name}" }
+      elsif ent.is_a?(Collection)
+        puts "  (Types): #{ent.ruby_types.map { |h,ent| ent.name }.join(',')}"
+      end
+    end
+  end
+end