uppercrust 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 75ea2d60b570ea8d3eda923af784209df44c6abe
+  data.tar.gz: f3d09d618562ba4d69e00aeb530df5217c60d542
+SHA512:
+  metadata.gz: 4f17cbba416524f5132cd1e0ca934f89ed7b9825debc1bfa995e91217ac7e609833c5517533586bb69b60e7b978e0f00edb8a5464aa2101a86b4aa1380dea85f
+  data.tar.gz: 8e9fb9c84db5ecb6d240bbc2904bf429309f9ee4428f2def3360a3779fe70b53f7548cb0bf5a6cde35873ee23f1277156b0c931e6c865c9c9c9bd3099c3c3e03

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jan Gorman
+
+MIT License
+
+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,123 @@
+![Crust](https://dl.dropboxusercontent.com/u/512759/crust.png)
+
+# Crust
+
+Inspired by [jsonschema2pojo](https://github.com/joelittlejohn/jsonschema2pojo "jsonschema2pojo"), crust is your trusty companion to generate [Mantle](https://github.com/github/Mantle "Mantle") compatible model files in Objective-C.
+
+Crust generates two header and two implementation files for each of your models. One set is prefixed with an underscore and is meant to be overwritten whenever the JSON schema changes. The files without underscore extends these classes and can be used to add custom functionality and custom mappings and should only be generated once.
+
+## Installation
+
+Install the gem as:
+
+    $ gem install uppercrust
+
+## Usage
+
+    $ uppercrust generate --path {path} --base_only true|false
+    
+This generate an output folder with all the JSON files mapped to their Objective-C counterparts.
+
+Say for example, you have a model file named 'article.json'. Running crust will then generate 4 files for you:
+
+* _Article.h
+* _Article.m
+* Article.h
+* Article.m
+
+Lets look at the following simple example:
+
+```json
+{
+    "type":"object",
+    "$schema":"http://json-schema.org/draft-03/schema",
+    "id":"Article",
+    "description":"Result object that represents an article.",
+    "required":true,
+    "additionalProperties":false,
+    "properties":{
+        "brand":{
+            "type":"string",
+            "id":"brand",
+            "required":true
+        },
+        "sku":{
+            "type":"string",
+            "id":"sku",
+            "required":true
+        }
+    }
+}
+```
+
+_Article.h:
+
+```objc
+// DO NOT EDIT. This file is machine-generated and constantly overwritten.
+// Make changes to article.h instead.
+//
+// Result object that represents an article.
+
+#import "MTLModel.h"
+#import "MTLJSONAdapter.h"
+
+
+@interface _Article : MTLModel<MTLJSONSerializing>
+
+@property(nonatomic, copy, readonly) NSString *brand;
+@property(nonatomic, copy, readonly) NSString *sku;
+
+@end
+```
+
+_Article.m:
+```objc
+// DO NOT EDIT. This file is machine-generated and constantly overwritten.
+// Make changes to Article.m instead.
+
+#import "_Article.h"
+
+@implementation _Article
+
++ (NSDictionary *)JSONKeyPathsByPropertyKey {
+   return @{
+       @"brand" : @"brand",
+       @"sku" : @"sku"
+   };
+}
+
+
+@end
+```
+
+Article.h:
+```objc
+#import "_Article.h"
+
+@interface Article : _Article
+@end
+```
+
+Article.m:
+```objc
+#import "Article.h"
+
+@implementation Article {
+}
+
+@end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## TODO
+
+* Add tests!
+* Add some special types to the schema since Foundation has a richer vocabulary
+* Add the option to prefix the generated class names

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/uppercrust

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require "uppercrust/cli"
+Uppercrust::CLI.start

data/features/generator.feature

@@ -0,0 +1,10 @@
+Feature: Generator
+  
+  Scenario: I generate .h and .m files
+    When I run `uppercrust generate --path data --base_only true`
+    Then the following files should exist:
+      | output/_Article.h |
+    Then the file "output/_Article.h" should contain:
+      """
+      Something
+      """

data/features/support/setup.rb

@@ -0,0 +1 @@
+require "aruba/cucumber"

data/lib/uppercrust.rb

@@ -0,0 +1,6 @@
+require "uppercrust/version"
+require "uppercrust/generator"
+
+module Uppercrust
+  # Your code goes here...
+end

data/lib/uppercrust/cli.rb

@@ -0,0 +1,13 @@
+require "thor"
+require "uppercrust"
+
+module Uppercrust
+  class CLI < Thor
+    desc "generate files", "Generates .h and .m files from the given directory"
+    option :path, :required => true, :aliases => '-p'
+    option :base_only, :type => :boolean, :aliases => '-b'
+    def generate
+      puts Uppercrust::Generator.generate(options[:path], options[:base_only])
+    end
+  end
+end

data/lib/uppercrust/generator.rb

@@ -0,0 +1,46 @@
+require 'mustache'
+require 'json'
+require 'uppercrust/parser'
+
+module Uppercrust
+
+  class Generator
+    
+    def self.generate(path, base_only)
+      unless File.readable?(path)
+        puts "Cannot read path #{path}"
+        return
+      end
+
+      files = read_files(path, base_only)
+      if files.length > 0
+        FileUtils.mkdir("output")
+        output = []
+        files.each do |generate|
+          puts "Generate #{generate.file_name}"
+          output << generate.generate_files
+        end
+        output.each do |generated|
+          generated.each { |name, contents| File.open(File.join("output", name), "w") { |f| f.write(contents) } }
+        end
+      end
+    end
+
+    def self.read_files(path, base_only)
+      files = File.file?(File.absolute_path(path)) ? [File.absolute_path(path)] : glob_dir_for_json(path)
+
+      output = []
+      files.each do |json_file|
+        data = JSON.parse(File.open(json_file, 'r') { |f| f.read })
+        output << Parser.new(json_file, data, base_only)
+      end
+      output
+    end
+
+    def self.glob_dir_for_json(path)
+      Dir.glob(File.join(File.absolute_path(path), '**', '*.json'))
+    end
+
+  end
+
+end

data/lib/uppercrust/parser.rb

@@ -0,0 +1,152 @@
+class Parser
+
+  attr_accessor :file_name
+
+  def initialize(file_name, data, base_only)
+    @file_name = file_name
+    @data = data
+    @base_only = base_only
+
+    @generated_class = self.snake_to_camel(File.basename(file_name, '.json'))
+
+    @properties = self.extract_properties(data['properties'])
+    @variable_names = self.extract_variable_names(data['properties'].keys)
+    @extends_class = self.extends_class(data)
+    @import = self.get_import(data)
+    @contains_classes = self.get_contains(data['properties'])
+    @array_converters = self.get_array_converters(data['properties'])
+  end
+
+  def generate_files
+    output = {}
+
+    output["_#{@generated_class}.h"] = Mustache.render(read_template('base_header'),
+                                                       :class_name => @generated_class,
+                                                       :extends_class => @extends_class,
+                                                       :import => @import,
+                                                       :description => @data['description'],
+                                                       :properties => @properties)
+
+    output["_#{@generated_class}.m"] = Mustache.render(read_template('base_implementation'),
+                                                       :class_name => @generated_class,
+                                                       :properties => @variable_names,
+                                                       :extends => !@import.nil?,
+                                                       :contains => @contains_classes,
+                                                       :array_converters => @array_converters)
+
+    unless @base_only
+      output["#{@generated_class}.h"] = Mustache.render(read_template('header'),
+                                                        :class_name => @generated_class)
+
+      output["#{@generated_class}.m"] = Mustache.render(read_template('implementation'),
+                                                        :class_name => @generated_class)
+    end
+
+    output
+  end
+
+  def read_template(template_name)
+    File.read("#{File.dirname(__FILE__)}/tpl/#{template_name}.mustache")
+  end
+
+  def get_contains(properties)
+    contains = []
+
+    properties.each do |name, type_info|
+      if self.match_type(type_info['type']) == 'NSArray' && type_info['items']['$ref'] != nil && type_info['items']['$ref'] != '#'
+        contains << "#import \"_#{self.snake_to_camel(Pathname.new(type_info['items']['$ref']).basename('.json').to_s)}.h\""
+      end
+    end
+
+    contains
+  end
+
+  def get_array_converters(properties)
+    array_converters = []
+
+    properties.each do |name, type_info|
+      if self.match_type(type_info['type']) == 'NSArray' && type_info['items']['$ref'] != nil
+        extends = type_info['items']['$ref'] != '#' ? self.snake_to_camel(Pathname.new(type_info['items']['$ref']).basename('.json').to_s) : @generated_class
+        array_converters << "+ (NSValueTransformer *)#{name}JSONTransformer {\n    return [NSValueTransformer mtl_JSONDictionaryTransformerWithModelClass:_#{extends}.class];\n}"
+      end
+    end
+
+    array_converters
+  end
+
+  def get_import(data)
+    if data['extends'].to_s == ''
+      nil
+    else
+      import = data['extends'].is_a?(String) ? '_' << self.snake_to_camel(data['extends'].sub('.json', '')) : '_' << self.snake_to_camel(File.basename(data['extends']['$ref'], '.json'))
+      "#import \"#{import}.h\""
+    end
+  end
+
+  def extends_class(data)
+    if data['extends'].to_s == ''
+      'MTLModel<MTLJSONSerializing>'
+    else
+      if data['extends'].is_a? String
+        '_' << self.snake_to_camel(Pathname.new(data['extends']).basename('.json').to_s)
+      else
+        '_' << self.snake_to_camel(Pathname.new(data['extends']['$ref']).basename('.json').to_s)
+      end
+    end
+  end
+
+  def extract_variable_names(keys)
+    extracted_variables_names = []
+
+    if keys.length > 1
+      last = keys.pop
+      keys.each { |key| extracted_variables_names << "@\"#{key}\" : @\"#{key}\"," }
+      extracted_variables_names << "@\"#{last}\" : @\"#{last}\""
+    else
+      extracted_variables_names << "@\"#{keys[0]}\" : @\"#{keys[0]}\""
+    end
+
+    extracted_variables_names
+  end
+
+  def extract_properties(properties)
+    extracted_properties = []
+
+    properties.each do |name, type_info|
+      type = match_type(type_info['type'])
+      extracted_properties << "@property(#{self.copy_type(type) ? 'copy' : 'assign'}, nonatomic, readonly) #{type} #{self.copy_type(type) ? '*' : ''}#{name};"
+    end
+
+    extracted_properties
+  end
+
+  def copy_type(type)
+    type != 'NSInteger' && type != 'BOOL'
+  end
+
+  def match_type(in_type)
+    case in_type
+      when 'string'
+        'NSString'
+      when 'number', 'long'
+        'NSNumber'
+      when 'integer'
+        'NSInteger'
+      when 'boolean'
+        'BOOL'
+      when 'object', 'any'
+        'NSObject'
+      when 'array'
+        'NSArray'
+      when 'null'
+        'NSNull'
+      else
+        'NSObject'
+    end
+  end
+
+  def snake_to_camel(file_name)
+    (file_name.split('_').length > 1) ? file_name.split('_').map { |w| w.capitalize }.join('') : file_name.capitalize
+  end
+
+end

data/lib/uppercrust/tpl/base_header.mustache

@@ -0,0 +1,15 @@
+// DO NOT EDIT. This file is machine-generated and constantly overwritten.
+// Make changes to {{{class_name}}}.h instead.
+//
+// {{{description}}}
+
+#import <Mantle/Mantle.h>
+{{{import}}}
+
+@interface _{{{class_name}}} : {{{extends_class}}}
+
+{{#properties}}
+{{{.}}}
+{{/properties}}
+
+@end

data/lib/uppercrust/tpl/base_implementation.mustache

@@ -0,0 +1,36 @@
+// DO NOT EDIT. This file is machine-generated and constantly overwritten.
+// Make changes to {{{class_name}}}.m instead.
+
+#import "_{{{class_name}}}.h"
+{{#array_converters}}
+{{#contains}}
+{{{.}}}
+{{/contains}}
+{{/array_converters}}
+
+@implementation _{{{class_name}}}
+
++ (NSDictionary *)JSONKeyPathsByPropertyKey {
+    {{#extends}}
+    NSMutableDictionary *dictionary = [NSMutableDictionary dictionaryWithDictionary:[super JSONKeyPathsByPropertyKey]];
+    [dictionary addEntriesFromDictionary:@{
+        {{#properties}}
+        {{{.}}}
+        {{/properties}}
+    }];
+    return dictionary;
+    {{/extends}}
+    {{^extends}}
+    return @{
+        {{#properties}}
+        {{{.}}}
+        {{/properties}}
+    };
+    {{/extends}}
+}
+
+{{#array_converters}}
+{{{.}}}
+{{/array_converters}}
+
+@end

data/lib/uppercrust/tpl/header.mustache

@@ -0,0 +1,4 @@
+#import "_{{{class_name}}}.h"
+
+@interface {{{class_name}}} : _{{{class_name}}}
+@end

data/lib/uppercrust/tpl/implementation.mustache

@@ -0,0 +1,5 @@
+#import "{{{class_name}}}.h"
+
+@implementation {{{class_name}}}
+
+@end

data/lib/uppercrust/version.rb

@@ -0,0 +1,3 @@
+module Uppercrust
+  VERSION = "0.0.1"
+end

data/spec/uppercrust_spec.rb

@@ -0,0 +1,11 @@
+require "uppercrust"
+
+spec_dir = File.expand_path(File.dirname(__FILE__))
+
+describe Uppercrust::Generator do
+  
+  it "generates .h and .m files" do
+    Uppercrust::Generator.generate(spec_dir, true)
+  end
+  
+end

data/uppercrust.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'uppercrust/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "uppercrust"
+  spec.version       = Uppercrust::VERSION
+  spec.authors       = ["Jan Gorman"]
+  spec.email         = ["gorman.jan@gmail.com"]
+  spec.summary       = %q{Convert your JSON schema files to Mantle compatible Objective-C models}
+  spec.description   = %q{Convert your JSON schema files to Mantle compatible Objective-C models}
+  spec.homepage      = "https://github.com/JanGorman/uppercrust/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_dependency "mustache"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: uppercrust
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jan Gorman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mustache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: aruba
+  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 your JSON schema files to Mantle compatible Objective-C models
+email:
+- gorman.jan@gmail.com
+executables:
+- uppercrust
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/uppercrust
+- features/generator.feature
+- features/support/setup.rb
+- lib/uppercrust.rb
+- lib/uppercrust/cli.rb
+- lib/uppercrust/generator.rb
+- lib/uppercrust/parser.rb
+- lib/uppercrust/tpl/base_header.mustache
+- lib/uppercrust/tpl/base_implementation.mustache
+- lib/uppercrust/tpl/header.mustache
+- lib/uppercrust/tpl/implementation.mustache
+- lib/uppercrust/version.rb
+- spec/uppercrust_spec.rb
+- uppercrust.gemspec
+homepage: https://github.com/JanGorman/uppercrust/
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Convert your JSON schema files to Mantle compatible Objective-C models
+test_files:
+- features/generator.feature
+- features/support/setup.rb
+- spec/uppercrust_spec.rb
+has_rdoc: