defgen 0.0.1

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 defgen.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    defgen (0.0.1)
+      xcodeproj
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    coderay (1.0.8)
+    colored (1.2)
+    diff-lcs (1.1.3)
+    guard (1.6.0)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (2.3.3)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    i18n (0.6.1)
+    listen (0.6.0)
+    lumberjack (1.0.2)
+    method_source (0.8.1)
+    multi_json (1.5.0)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    rb-fsevent (0.9.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+    slop (3.3.3)
+    thor (0.16.0)
+    xcodeproj (0.4.0)
+      activesupport (~> 3.2.6)
+      colored (~> 1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  defgen!
+  guard
+  guard-rspec
+  rb-fsevent
+  rspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012-2013 Paul Samuels
+
+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,151 @@
+##NSUserDefaults using properties
+
+Using properties to access data from `NSUserDefaults` is a million times better than using the verbose API. To do this you simply make a category on `NSUserDefaults` and then chuck in some boiler plate code to hook it all up.
+
+It couldn't be simpler...
+
+##Defgen makes it simpler
+
+Boiler plate is boring so why write it? Using Defgen we can have the computer write it for us. Supply a `Defaultfile` written in the super simple DSL and `defgen` will do the rest.
+
+##Features
+
+This is firmly in the realms of Proof of Concept at the minute but.
+
+- Uses class prefix used in your Xcodeproj
+- Uses the OrganizationName in your Xcodeproj
+- Customizable boiler plate
+- No runtime tricks and all the `NSUserDefault` supported types are supported
+- Automatically updates your Xcodeproj
+
+##Usage
+
+####Step 1. Supply a Defaultfile
+
+    # ├── AwesomeApp/
+    #     ├── AwesomeApp/
+    #     ├── AwesomeApp.xcodeproj/
+    #     ├── Defaultfile           <----- Your Defaultfile
+
+    # Defaultfile
+    array      'cheatCodes'
+    bool       'firstUse'
+    data       'someData'
+    dictionary 'config'
+    float      'ratio'
+    integer    'year'
+    object     'mmmmmm'
+    string     'name'
+    double     'betterRatio'
+    url        'homepage'
+    
+The DSL should be pretty self explanatory call the `type` of the object followed by what you want to call it.
+    
+####Step 2. Run Defgen
+
+    $ defgen
+
+####Step 3. Enjoy the generated boiler plate
+
+###Customisation
+
+If you don't like the supplied boiler plate then you can tweak it.
+
+####Step 1. Call generate the stubs
+
+    $ defgen stubs
+    
+This will generate the templates in your current project so that you can edit as much as you like
+
+    create  defgen/constant.erb
+    create  defgen/getter.erb
+    create  defgen/implementation.erb
+    create  defgen/interface.erb
+    create  defgen/property.erb
+    create  defgen/setter.erb
+
+##Example input/output/usage
+
+####Input
+
+    #Defaultfile
+    
+    array 'aliases'
+    
+####Output
+
+    //
+    //  NSUserDefaults+PASProperties.h
+    //  AwesomeApp
+    //
+    //  Created by Paul Samuels on 04/01/2013.
+    //  Copyright (c) 2013 Paul Samuels. All rights reserved.
+    // 
+    //  This is an autogenerated file any changes will be lost when running `defgen`
+    //
+
+    #import <Foundation/Foundation.h>
+
+    @interface NSUserDefaults (PASProperties)
+
+    @property (nonatomic, strong) NSArray *pas_aliases;
+
+    @end
+    
+    //
+    //  NSUserDefaults+PASProperties.m
+    //  AwesomeApp
+    //
+    //  Created by Paul Samuels on 04/01/2013.
+    //  Copyright (c) 2013 Paul Samuels. All rights reserved.
+    // 
+    //  This is an autogenerated file any changes will be lost when running `defgen`
+    //
+
+    #import "NSUserDefaults+PASProperties.h"
+
+    NSString * const PASAliases = @"PASAliases";
+
+    @implementation NSUserDefaults (PASProperties)
+
+    - (NSArray *)pas_aliases;
+    {
+      return [self arrayForKey:PASAliases];
+    }
+
+    - (void)setPas_aliases:(NSArray *)aliases;
+    {
+      [self setObject:aliases forKey:PASAliases];
+    }
+
+    @end
+    
+####Usage
+
+    #import "NSUserDefaults+PASProperties.h"
+    
+    ...
+    
+    userDefaults.pas_aliases = @[ @1, @2 ];
+    NSLog(@"%@", userDefaults.pas_aliases);
+    
+## Installation
+
+    $ gem install defgen
+
+## 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
+
+##Wish List
+
+- Support for provising customer getter e.g. `(nonatomic, strong, getter=isValid)`
+- Support for overriding ownership qualifiers
+
+##Licence
+
+Defgen is available under the MIT license. See the LICENSE file for more info.

data/Rakefile

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

data/bin/defgen

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'defgen'
+
+Defgen::CLI.start

data/defgen.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'defgen/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "defgen"
+  gem.version       = Defgen::VERSION
+  gem.authors       = ["Paul Samuels"]
+  gem.email         = ["paulio1987@gmail.com"]
+  gem.description   = %q{Build an NSUserDefaults category using a simple DSL}
+  gem.summary       = %q{Build an NSUserDefaults category using a simple DSL}
+  gem.homepage      = "https://github.com/paulsamuels/Defgen"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency 'xcodeproj'
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "guard"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "rb-fsevent"
+end

data/lib/defgen/cli.rb

@@ -0,0 +1,47 @@
+require 'Thor'
+require 'fileutils'
+
+module Defgen
+  class CLI < Thor
+
+    desc "stubs", "Generate template stubs"
+    def stubs
+      TemplateGenerator.create_stubs
+    end
+      
+    desc "parse", 'Parse a "Defaultfile" and modify the Xcodeproj'
+    method_option :filename, default: 'Defaultfile', 
+    aliases: '-f',
+    desc:    'Specify the input file path'
+    def parse
+      
+      path = Dir['*.xcodeproj'].first
+      
+      if path.nil?
+        puts('.xcodeproj file not found')
+        puts
+        help
+        exit 1 
+      end
+      
+      unless File.exist? options[:filename]      
+        puts('no Defaultfile found')
+        puts
+        help
+        exit 1
+      end
+      
+      proj = XcodeprojAdapter.new(Xcodeproj::Project.new(path), path)
+      
+      defaultfile = DefaultfileBuilder.build { |builder|
+        builder.project_settings = proj
+        builder.parser           = DefaultfileParser
+        builder.defaultfile      = File.open(options[:filename]).read
+      }
+      
+      Installer.install(path, defaultfile, proj)
+    end
+      
+    default_task :parse
+  end
+end

data/lib/defgen/decorators/getter_decorator.rb

@@ -0,0 +1,17 @@
+require 'delegate'
+
+module Defgen
+  class GetterDecorator < SimpleDelegator    
+    def objc_type
+      super.strip
+    end
+    
+    def prefix
+      super.downcase
+    end
+    
+    def get_binding
+      binding
+    end
+  end
+end

data/lib/defgen/decorators/setter_decorator.rb

@@ -0,0 +1,11 @@
+module Defgen
+  class SetterDecorator < GetterDecorator    
+    def message_prefix
+      object_setter ? 'Object' : super.upcase_first
+    end
+    
+    def prefix
+      super.downcase.upcase_first
+    end
+  end
+end

data/lib/defgen/decorators.rb

@@ -0,0 +1,2 @@
+require 'defgen/decorators/getter_decorator'
+require 'defgen/decorators/setter_decorator'

data/lib/defgen/defaultfile.rb

@@ -0,0 +1,65 @@
+require 'date'
+
+module Defgen
+  class Defaultfile
+    attr_accessor :project_settings
+    attr_reader :class_properties
+    
+    def initialize class_properties, project_settings
+      @class_properties     = class_properties
+      self.project_settings = project_settings
+    end
+    
+    def to_iface
+      render TemplateGenerator.interface_template
+    end
+    
+    def to_imp
+      render TemplateGenerator.implementation_template
+    end
+    
+    private
+    
+    def render template
+      prefix       = project_settings.prefix
+      project_name = project_settings.name
+      author       = project_settings.organization
+      
+      ERB.new(template, nil, '<>').result binding
+    end
+        
+    def key_constants
+      padding = class_properties.max_by { |p| p.key.length }.key.length
+      constant_template = TemplateGenerator.constant_template
+      
+      String.new.tap { |out|
+        class_properties.each do |property|
+          out << ERB.new(constant_template).result(binding)
+        end
+      }
+    end
+    
+    def accessors
+      getter_template = TemplateGenerator.getter_template
+      setter_template = TemplateGenerator.setter_template
+      
+      String.new.tap { |out|
+        class_properties.each do |property| 
+          out << ERB.new(getter_template).result(GetterDecorator.new(property).get_binding) + "\n"
+          out << ERB.new(setter_template).result(SetterDecorator.new(property).get_binding)
+          out << "\n" unless class_properties.last == property
+        end
+      }
+    end
+    
+    def properties
+      property_template = TemplateGenerator.property_template
+      
+      String.new.tap { |out|
+        class_properties.each do |property|
+          out << ERB.new(property_template).result(property.get_binding)
+        end
+      }
+    end
+  end
+end

data/lib/defgen/defaultfile_builder.rb

@@ -0,0 +1,14 @@
+module Defgen
+  class DefaultfileBuilder
+    attr_accessor :parser, :project_settings, :defaultfile
+    
+    def self.build
+      new.tap { |instance| yield(instance) }.build
+    end
+    
+    def build
+      properties = parser.parse(defaultfile).each do |property| property.prefix = project_settings.prefix end
+      Defaultfile.new properties, project_settings
+    end
+  end
+end

data/lib/defgen/defaultfile_parser.rb

@@ -0,0 +1,41 @@
+module Defgen
+  class DefaultfileParser
+    def self.parse string
+      new.parse string
+    end
+    
+    def initialize
+      @properties = []
+    end
+    
+    [
+      [ 'array',      'array',      'NSArray *',      :strong, true  ],
+      [ 'bool',       'bool',       'BOOL ',          :assign, false ],
+      [ 'data',       'data',       'NSData *',       :strong, true  ],
+      [ 'dictionary', 'dictionary', 'NSDictionary *', :strong, true  ],
+      [ 'float',      'float',      'float ',         :assign, false ],
+      [ 'integer',    'integer',    'NSInteger ',     :assign, false ],
+      [ 'object',     'object',     'id ',            :strong, true  ],
+      [ 'string',     'string',     'NSString *',     :copy,   true  ],
+      [ 'double',     'double',     'double ',        :assign, false ],
+      [ 'url',        'URL',        'NSURL *',        :strong, false ]
+    ].each do |method_name, prefix, objc_type, ownership, object_setter|
+      define_method method_name do |name|
+        Property.new do |property, attributes|
+          property.name           = name
+          property.object_setter  = object_setter
+          property.message_prefix = prefix
+          property.objc_type      = objc_type
+          attributes.ownership    = ownership
+          
+          @properties << property
+        end
+      end
+    end
+    
+    def parse string
+      instance_eval string
+      @properties
+    end
+  end
+end

data/lib/defgen/generators/template/template_generator.rb

@@ -0,0 +1,38 @@
+require 'thor/group'
+
+class TemplateGenerator < Thor::Group
+  include Thor::Actions
+
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  templates = Dir.glob("#{source_root}/*.erb")
+  TEMPLATES = templates.map { |f| File.basename(f, '.erb') }
+  
+  TEMPLATES.each do |template|
+    const_set "#{template.upcase}_SOURCE", File.join(source_root, "#{template}.erb")
+    const_set "#{template.upcase}_DEST", "defgen/#{template}.erb"
+    
+    self.class.send :define_method, "#{template}_template" do
+      load_template const_get("#{template.upcase}_SOURCE"), const_get("#{template.upcase}_DEST")
+    end
+  end
+  
+  def self.create_stubs
+    new.create_stubs
+  end
+  
+  def create_stubs
+    TEMPLATES.map(&:upcase).each do |template_file|
+      template self.class.const_get("#{template_file}_SOURCE"), self.class.const_get("#{template_file}_DEST")
+    end
+  end
+    
+  private
+  
+  def self.load_template source, destination
+    return File.open(destination).read if File.exist? destination
+    ERB.new(File.open(source).read).result
+  end
+end

data/lib/defgen/generators/template/templates/constant.erb

@@ -0,0 +1 @@
+NSString * const <%%= property.key.ljust(padding) %> = @"<%%= property.key %>";

data/lib/defgen/generators/template/templates/getter.erb

@@ -0,0 +1,4 @@
+- (<%%= objc_type %>)<%%= prefix %>_<%%= parameter %>;
+{
+  return [self <%%= message_prefix %>ForKey:<%%= key %>];
+}

data/lib/defgen/generators/template/templates/implementation.erb

@@ -0,0 +1,19 @@
+//
+//  NSUserDefaults+<%%= prefix %>Properties.m
+//  <%%= project_name %>
+//
+//  Created by <%%= author %> on <%= Date.today.strftime('%d/%m/%Y') %>.
+//  Copyright (c) <%= Date.today.year %> <%%= author %>. All rights reserved.
+// 
+//  This is an autogenerated file any changes will be lost when running `defgen`
+//
+
+#import "NSUserDefaults+<%%= prefix %>Properties.h"
+
+<%%= key_constants %>
+
+@implementation NSUserDefaults (<%%= prefix %>Properties)
+
+<%%= accessors %>
+
+@end

data/lib/defgen/generators/template/templates/interface.erb

@@ -0,0 +1,17 @@
+//
+//  NSUserDefaults+<%%= prefix %>Properties.h
+//  <%%= project_name %>
+//
+//  Created by <%%= author %> on <%= Date.today.strftime('%d/%m/%Y') %>.
+//  Copyright (c) <%= Date.today.year %> <%%= author %>. All rights reserved.
+// 
+//  This is an autogenerated file any changes will be lost when running `defgen`
+//
+
+#import <Foundation/Foundation.h>
+
+@interface NSUserDefaults (<%%= prefix %>Properties)
+
+<%%= properties %>
+
+@end

data/lib/defgen/generators/template/templates/property.erb

@@ -0,0 +1 @@
+@property <%%= attributes %> <%%= objc_type %><%%= prefix.downcase %>_<%%= name %>;

data/lib/defgen/generators/template/templates/setter.erb

@@ -0,0 +1,4 @@
+- (void)set<%%= prefix %>_<%%= name %>:(<%%= objc_type %>)<%%= parameter %>;
+{
+  [self set<%%= message_prefix %>:<%%= parameter %> forKey:<%%= key %>];
+}

data/lib/defgen/generators/template.rb

@@ -0,0 +1 @@
+require 'defgen/generators/template/template_generator'

data/lib/defgen/generators.rb

@@ -0,0 +1 @@
+require 'defgen/generators/template'