objc-crust 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c38f4e65442b2a8585ae7d466dc55a18d884369e
+  data.tar.gz: 1f3340948ae50a5c828a4b5f218bcf0e9d204d0d
+SHA512:
+  metadata.gz: 6920b79a71584c0ffdfd153b61f1628148d7dc63adc6f1ad04f307cb1c4575c2b060517f750f8247d30e3f6bdcc4eadaeb8db0a0b7e2a207f2ce366fc2149870
+  data.tar.gz: 49666e4c54ee7649f016438864f0c7bb83df322e5eda2b27d4b75063da115b39e5bd2ea20c3171730880277bfffdeb04fab0ab09d84a3c7bb3b5fbac41041361

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    crust (0.0.1)
+      json
+      mustache
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.3)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    cucumber (1.3.6)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.0)
+      multi_json (~> 1.7.5)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.4)
+    ffi (1.9.0)
+    gherkin (2.12.1)
+      multi_json (~> 1.3)
+    json (1.8.0)
+    multi_json (1.7.9)
+    multi_test (0.0.2)
+    mustache (0.99.4)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  bundler (~> 1.3)
+  crust!
+  cucumber
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Jan Gorman
+
+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,124 @@
+![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 objc-crust
+
+## Usage
+
+    $ crust 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
+* Wiki
+* Add the option to prefix the generated class names

data/Rakefile

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

data/crust.gemspec

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

data/lib/crust.rb

@@ -0,0 +1,48 @@
+require 'crust/version'
+require 'crust/generate'
+
+require 'json'
+
+module Crust
+  class Generator
+
+    def self.generate(path, base_only)
+      if File.readable?(path)
+
+        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
+
+      else
+        puts "Cannot read path #{path}"
+      end
+    end
+
+    private
+
+    def self.read_files(path, base_only)
+      files = File.file?(File.absolute_path(path)) ? [File.absolute_path(path)] : Dir.glob(File.join(File.absolute_path(path), '**', '*.json'))
+
+      output = []
+      files.each do |json_file|
+        data = JSON.parse(File.open(json_file, 'r') { |f| f.read })
+        output << Generate.new(json_file, data, base_only)
+      end
+      output
+    end
+
+  end
+end

data/lib/crust/cli.rb

@@ -0,0 +1,15 @@
+require 'thor'
+require 'crust'
+
+module Crust
+  class CLI < Thor
+
+    desc 'generate', 'Generates the Objective-C file(s)'
+    method_options :path => :string, :base_only => :boolean
+
+    def generate
+      puts Crust::Generator.generate(options[:path], options[:base_only])
+    end
+
+  end
+end

data/lib/crust/generate.rb

@@ -0,0 +1,169 @@
+require 'mustache'
+
+class Generate
+
+  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
+
+  # @return [array]
+  def generate_files
+    output = {}
+
+    output["_#{@generated_class}.h"] = Mustache.render(File.read(File.dirname(__FILE__) + '/tpl/base_header.mustache'),
+                                                       :class_name => @generated_class,
+                                                       :extends_class => @extends_class,
+                                                       :import => @import,
+                                                       :description => @data['description'],
+                                                       :properties => @properties)
+
+    output["_#{@generated_class}.m"] = Mustache.render(File.read(File.dirname(__FILE__) + '/tpl/base_implementation.mustache'),
+                                                       :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(File.read(File.dirname(__FILE__) + '/tpl/header.mustache'),
+                                                        :class_name => @generated_class)
+
+      output["#{@generated_class}.m"] = Mustache.render(File.read(File.dirname(__FILE__) + '/tpl/implementation.mustache'),
+                                                        :class_name => @generated_class)
+    end
+
+    output
+  end
+
+  # @param [array] properties
+  # @return [array]
+  def get_contains(properties)
+    contains = []
+
+    properties.each do |name, type_info|
+      if 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
+
+  # @param [array] properties
+  # @return [array]
+  def get_array_converters(properties)
+    array_converters = []
+
+    properties.each do |name, type_info|
+      if 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
+
+  # @param [hash] data
+  # @return [string]
+  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
+
+  # @param [hash] data
+  # @return [string]
+  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
+
+  # @param [array] keys
+  # @return [array]
+  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
+
+  # @param [array] properties
+  # @return [array]
+  def extract_properties(properties)
+    extracted_properties = []
+
+    properties.each do |name, type_info|
+      type = match_type(type_info['type'])
+      extracted_properties << "@property(nonatomic#{self.retained(type) ? ', copy' : ''}, readonly) #{type} #{self.retained(type) ? '*' : ''}#{name};"
+    end
+
+    extracted_properties
+  end
+
+  # @param [string] type
+  # @return [boolean]
+  def retained(type)
+    type != 'NSInteger' && type != 'BOOL'
+  end
+
+  # @param [string] in_type
+  # @return [string]
+  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
+
+  # @param [string] file_name
+  # @return [string]
+  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/crust/tpl/base_header.mustache

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

data/lib/crust/tpl/base_implementation.mustache

@@ -0,0 +1,37 @@
+// 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}}
+#import "NSValueTransformer+MTLPredefinedTransformerAdditions.h"
+{{/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/crust/tpl/header.mustache

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

data/lib/crust/tpl/implementation.mustache

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

data/lib/crust/version.rb

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

data/spec/crust_spec.rb

@@ -0,0 +1,12 @@
+require 'crust'
+require 'json'
+
+spec_dir = File.expand_path(File.dirname(__FILE__))
+
+describe Crust::Generator do
+
+  it 'generate crust' do
+    Crust::Generator.generate(spec_dir, true)
+  end
+
+end

data/spec/data/address.json

@@ -0,0 +1,37 @@
+{
+    "description": "An Address following the convention of http://microformats.org/wiki/hcard",
+    "type": "object",
+    "properties": {
+        "post-office-box": {
+            "type": "string"
+        },
+        "extended-address": {
+            "type": "string"
+        },
+        "street-address": {
+            "type": "string"
+        },
+        "locality": {
+            "type": "string",
+            "required": true
+        },
+        "region": {
+            "type": "string",
+            "required": true
+        },
+        "postal-code": {
+            "type": "string"
+        },
+        "country-name": {
+            "type": "string",
+            "required": true
+        }
+    },
+    "dependencies": {
+        "post-office-box": "street-address",
+        "extended-address": "street-address",
+        "street-address": "region",
+        "locality": "region",
+        "region": "country-name"
+    }
+}

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: objc-crust
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jan Gorman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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'
+- !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: json
+  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'
+description: Convert your JSON schema files to Mantle compatible Objective-C models
+email:
+- gorman.jan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- crust.gemspec
+- lib/crust.rb
+- lib/crust/cli.rb
+- lib/crust/generate.rb
+- lib/crust/tpl/base_header.mustache
+- lib/crust/tpl/base_implementation.mustache
+- lib/crust/tpl/header.mustache
+- lib/crust/tpl/implementation.mustache
+- lib/crust/version.rb
+- spec/crust_spec.rb
+- spec/data/address.json
+homepage: https://github.com/JanGorman/crust/
+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.14
+signing_key: 
+specification_version: 4
+summary: Convert your JSON schema files to Mantle compatible Objective-C models
+test_files:
+- spec/crust_spec.rb
+- spec/data/address.json