xdry 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011, Andrey Tarantsov <andreyvit@gmail.com>
+
+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,11 @@
+Extra DRY: Objective-C boilerplate generator
+============================================
+
+Automatically adds:
+
+* `@property`, `@synthesize`, field declarations,
+* initializing constructors,
+* missing release calls in dealloc,
+* initWithDictionary, dictionaryRepresentation based on the chosen fields.
+
+See http://andreyvit.github.com/xdry/ for usage and installation instructions.

data/Rakefile

@@ -0,0 +1,76 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "xdry"
+    gem.summary = %Q{eXtra D.R.Y. for Xcode}
+    gem.description = %Q{
+        Autogenerates all kinds of funky stuff (like accessors) in Xcode projects
+    }.strip
+    gem.email = "andreyvit@gmail.com"
+    gem.homepage = "http://github.com/mockko/xdry"
+    gem.authors = ["Andrey Tarantsov"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # http://www.rubygems.org/read/chapter/20
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+namespace :site do
+  desc "Regenerate the site using Jekyll"
+  task :build do
+    Dir.chdir 'site' do
+      system "jekyll"
+    end
+  end
+
+  desc "Open a generated site in a web browser"
+  task :open => [:build] do
+    system "open site/_site/index.html"
+  end
+
+  desc "Regenerate the site and update gh-pages branch"
+  task :update => [:build] do
+    mods = `git status --porcelain --untracked-files=no`
+    if mods.strip.size > 0
+      system "git status --short --untracked-files=no"
+      puts
+      puts "** There are uncommitted changes. Please commit or stash them before updating the site."
+      exit
+    end
+
+    source_commit = `git rev-parse HEAD`.strip
+
+    ENV['GIT_INDEX_FILE'] = File.expand_path('.git/index-gh-pages')
+    ENV['GIT_WORK_TREE'] = File.expand_path('site/_site')
+    ENV['GIT_DIR'] = File.expand_path('.git')
+    Dir.chdir 'site/_site' do
+      system "git update-index --add --remove #{Dir["**/*"].join(' ')}"
+      tree=`git write-tree`.strip
+      puts "Tree = #{tree}"
+      parent=`git rev-parse refs/heads/gh-pages`.strip
+      puts "Parent = #{parent}"
+      commit=`echo "Generate the site from source repository commit #{source_commit}" | git commit-tree #{tree} -p #{parent}`.strip
+      puts "Commit = #{commit}"
+      system "git update-ref -m 'Generate the site from source repository commit #{source_commit}' refs/heads/gh-pages #{commit}"
+    end
+  end
+
+  desc "Push an updated site to GitHub"
+  task :push do
+    system "git push origin gh-pages"
+  end
+
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/xdry

@@ -0,0 +1,4 @@
+#! /usr/bin/env ruby
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+require 'xdry'
+XDry.run(ARGV)

data/lib/xdry.rb

@@ -0,0 +1,18 @@
+
+module XDry
+  INDENT_STEP = "\t"  # FIXME: all usages of this should be changed to something smart
+  FIELD_PREFIX = "_"  # FIXME: all usages of this should be changed to something smart
+end
+
+%w{
+    support/string_additions support/symbol_additions support/enumerable_additions
+    parsing/parts/var_types parsing/parts/selectors
+    parsing/nodes parsing/model parsing/pos parsing/parsers
+    parsing/scopes_support parsing/scopes
+    parsing/scope_stack parsing/driver
+
+    patching/emitter patching/patcher patching/insertion_points patching/item_patchers
+
+    boxing generators_support run
+  }.each { |name| require File.join(File.dirname(__FILE__), 'xdry', name) }
+Dir[File.join(File.dirname(__FILE__), 'xdry', 'generators', '*.rb')].each { |f| require f }

data/lib/xdry/boxing.rb

@@ -0,0 +1,212 @@
+module XDry
+
+  module RetainPolicy
+
+    module ASSIGN_VALUE
+      def self.retain expr
+        expr
+      end
+
+      def self.release out, expr
+      end
+
+      def self.release_and_clear out, var_name
+      end
+    end
+
+    module ASSIGN_REF
+      def self.retain expr
+        expr
+      end
+
+      def self.release out, expr
+      end
+
+      def self.release_and_clear out, var_name
+        out << "#{var_name} = nil;";
+      end
+    end
+
+    module COPY
+      def self.retain expr
+        "[#{expr} copy]"
+      end
+
+      def self.release out, expr
+        out << "[#{expr} release]";
+      end
+
+      def self.release_and_clear out, var_name
+        out << "[#{var_name} release], #{var_name} = nil;";
+      end
+    end
+
+    module RETAIN
+      def self.retain expr
+        "[#{expr} retain]"
+      end
+
+      def self.release out, expr
+        out << "[#{expr} release]";
+      end
+
+      def self.release_and_clear out, var_name
+        out << "[#{var_name} release], #{var_name} = nil;";
+      end
+    end
+
+  end
+
+  module Boxing
+
+    class Boxer
+      def unbox_retained out, object_expr, tempvar_prefix
+        retain_policy.retain(unbox(out, object_expr, tempvar_prefix))
+      end
+    end
+
+    class NSNumberConverter < Boxer
+      def initialize repr_selector, init_selector
+        @init_selector = init_selector
+        @repr_selector = repr_selector
+      end
+
+      def box out, data_expr, tempvar_prefix
+        "[NSNumber #{@init_selector}:#{data_expr}]"
+      end
+
+      def unbox out, object_expr, tempvar_prefix
+        "[#{object_expr} #{@repr_selector}]"
+      end
+
+      def retain_policy; RetainPolicy::ASSIGN_VALUE; end
+    end
+
+    class DateConverter < Boxer
+      def box out, data_expr, tempvar_prefix
+        SIMPLE_CONVERTIONS['double'].box out, "[#{data_expr} timeIntervalSinceReferenceDate]"
+      end
+
+      def unbox out, object_expr, tempvar_prefix
+        number = SIMPLE_CONVERTIONS['double'].unbox(out, object_expr)
+        "[NSDate dateWithTimeIntervalSinceReferenceDate:#{number}]"
+      end
+
+      def retain_policy; RetainPolicy::RETAIN; end
+    end
+
+    class NopConverter < Boxer
+      def box out, data_expr, tempvar_prefix
+        data_expr
+      end
+
+      def unbox out, object_expr, tempvar_prefix
+        object_expr
+      end
+
+      def retain_policy; RetainPolicy::RETAIN; end
+    end
+
+    class StringConverter < Boxer
+      def box out, data_expr, tempvar_prefix
+        data_expr
+      end
+
+      def unbox out, object_expr, tempvar_prefix
+        object_expr
+      end
+
+      def retain_policy; RetainPolicy::COPY; end
+    end
+
+    class ArrayConverter < Boxer
+      def initialize item_type, init_selector, repr_selector
+        @item_type = item_type
+        @init_selector = init_selector
+        @repr_selector = repr_selector
+      end
+
+      def box out, data_expr, tempvar_prefix
+        array_var = "#{tempvar_prefix}Array"
+        item_var  = "#{tempvar_prefix}Item"
+
+        out << "NSMutableArray *#{array_var} = [NSMutableArray array];"
+        out.block "for (#{@item_type} *#{item_var} in #{data_expr})" do
+          out << "[#{array_var} addObject:[#{item_var} #{@repr_selector}]];"
+        end
+        "#{array_var}"
+      end
+
+      def unbox out, object_expr, tempvar_prefix
+        unbox_internal out, object_expr, tempvar_prefix, "[NSMutableArray array]"
+      end
+
+      def unbox_retained out, object_expr, tempvar_prefix
+        unbox_internal out, object_expr, tempvar_prefix, "[[NSMutableArray alloc] init]"
+      end
+
+      def retain_policy; RetainPolicy::COPY; end
+
+    private
+
+      def unbox_internal out, object_expr, tempvar_prefix, array_init
+        array_var = "#{tempvar_prefix}Array"
+        item_dict_var  = "#{tempvar_prefix}ItemDictionary"
+        item_var  = "#{tempvar_prefix}Item"
+
+        out << "NSMutableArray *#{array_var} = #{array_init};"
+        out.block "for (NSDictionary *#{item_dict_var} in (NSArray *) #{object_expr})" do
+          out << "#{@item_type} *#{item_var} = [[#{@item_type} alloc] #{@init_selector}:#{item_dict_var}];"
+          out << "[#{array_var} addObject:#{item_var}];"
+          out << "[#{item_var} release];"
+        end
+        "#{array_var}"
+      end
+    end
+
+    SIMPLE_CONVERTIONS = {
+      'int' => NSNumberConverter.new('intValue', 'numberWithInt'),
+      'NSInteger' => NSNumberConverter.new('integerValue', 'numberWithInteger'),
+      'NSUInteger' => NSNumberConverter.new('unsignedIntegerValue', 'numberWithUnsignedInteger'),
+      'BOOL' => NSNumberConverter.new('boolValue', 'numberWithBool'),
+      'float' => NSNumberConverter.new('floatValue', 'numberWithFloat'),
+      'CGFloat' => NSNumberConverter.new('floatValue', 'numberWithFloat'),
+      'double' => NSNumberConverter.new('doubleValue', 'numberWithDouble'),
+      'NSTimeInterval' => NSNumberConverter.new('doubleValue', 'numberWithDouble'),
+    }
+
+    POINTER_CONVERTIONS = {
+      'NSDate' => DateConverter.new,
+      'NSString' => StringConverter.new,
+    }
+
+    def self.converter_for type
+      case type
+      when SimpleVarType
+        SIMPLE_CONVERTIONS[type.name]
+      when PointerVarType
+        case type.name
+        when 'NSArray', 'NSMutableArray'
+          return ArrayConverter.new(type.type_hint || 'NSObject', 'initWithDictionary', 'dictionaryRepresentation')
+        end
+        POINTER_CONVERTIONS[type.name]
+      else
+        nil
+      end
+    end
+
+    def self.retain_policy_of type
+      if conv = converter_for(type)
+        conv.retain_policy
+      else
+        case type
+          when PointerVarType then RetainPolicy::RETAIN
+          when IdVarType      then RetainPolicy::ASSIGN_REF
+          when SimpleVarType  then RetainPolicy::ASSIGN_VALUE
+        end
+      end
+    end
+
+  end
+
+end

data/lib/xdry/generators/ctor_from_field.rb

@@ -0,0 +1,91 @@
+
+module XDry
+module Generators
+
+  class ConstructorFromField < Generator
+    id "ctor-from-field"
+
+    def process_class oclass
+      attributes = oclass.attributes.select { |a| a.wants_constructor? }
+      return if attributes.empty?
+
+      patch_implementation! oclass, attributes
+      patch_interface! oclass, attributes
+    end
+
+    def patch_implementation! oclass, attributes
+      impl_selector_def = impl_selector_def_for(attributes)
+
+      init_code = Emitter.capture do |o|
+        o.method "(id)#{impl_selector_def}" do
+          o.if "self = [super init]" do
+          end
+          o << "return self;"
+        end
+      end
+
+      MethodPatcher.new(patcher, oclass, impl_selector_def.selector, ImplementationStartIP.new(oclass), init_code) do |omethod|
+        impl = omethod.impl
+        ip = InsideConstructorIfSuperIP.new(impl)
+
+        lines = Emitter.capture do |o|
+          attributes.zip(impl_selector_def.components).each do |oattr, selector_component|
+            name, type = oattr.name, oattr.type
+            capitalized_name = name.capitalized_identifier
+
+            retain_policy = Boxing.retain_policy_of type
+
+            unless impl.children.any? { |n| NLine === n && n.line =~ /^(?:self\s*.\s*#{oattr.name}|#{oattr.field_name})\s*=/ }
+
+              var_name = impl.start_node.selector_def.var_name_after_keyword(selector_component.keyword)
+
+              field_ref = oattr.field_name
+              field_ref = "self->#{field_ref}" if field_ref == var_name
+
+              retained = retain_policy.retain(var_name)
+              o << "#{field_ref} = #{retained};"
+            end
+          end
+        end
+
+        ip.insert @patcher, lines unless lines.empty?
+      end
+    end
+
+    def patch_interface! oclass, attributes
+      intf_selector_def = intf_selector_def_for(attributes)
+
+      omethod = oclass.find_method(intf_selector_def.selector)
+      unless omethod && omethod.has_header?
+
+        ip = BeforeInterfaceEndIP.new(oclass)
+        lines = Emitter.capture do |o|
+          o << "- (id)#{intf_selector_def};"
+        end
+        ip.insert patcher, [""] + lines + [""]
+
+      end
+    end
+
+    def impl_selector_def_for attributes
+      CompoundSelectorDef.new(attributes.each_with_index.collect { |a, i| selector_component_for(a, i, true) })
+    end
+
+    def intf_selector_def_for attributes
+      CompoundSelectorDef.new(attributes.each_with_index.collect { |a, i| selector_component_for(a, i, false) })
+    end
+
+    def selector_component_for attribute, index, is_impl
+      keyword = attribute.name
+      keyword = "initWith#{keyword.capitalized_identifier}" if index == 0
+
+      arg_name = attribute.name
+      arg_name = arg_name.prefixed_as_arg_name if is_impl && arg_name == attribute.field_name
+
+      SelectorComponent.new("#{keyword}:", arg_name, attribute.type)
+    end
+
+  end
+
+end
+end

data/lib/xdry/generators/dealloc.rb

@@ -0,0 +1,53 @@
+
+module XDry
+module Generators
+
+  DEALLOC_CODE = [
+    "",
+    "- (void)dealloc {",
+    "\t[super dealloc];",
+    "}",
+    "",
+  ]
+
+  class Dealloc < Generator
+    id "dealloc"
+
+    def process_class oclass
+
+      MethodPatcher.new(patcher, oclass, 'dealloc', ImplementationStartIP.new(oclass), DEALLOC_CODE) do |dealloc_method|
+        impl = dealloc_method.impl
+        ip = BeforeSuperCallIP.new(impl)
+
+        existing_releases = impl.children.select { |child| child.is_a? NReleaseCall }
+        lines = generate_release_calls_if(oclass) do |oattr|
+          !existing_releases.any? { |n| n.expr == oattr.field_name || n.expr == "self.#{oattr.name}" }
+        end
+
+        ip.insert @patcher, lines unless lines.empty?
+      end
+    end
+
+  private
+
+    def generate_release_calls_if oclass
+      dealloc_out = Emitter.new
+
+      oclass.attributes.each do |oattr|
+        next if not oattr.has_field_def?
+
+        field_name = oattr.field_name
+        retain_policy = Boxing.retain_policy_of(oattr.type)
+
+        if yield(oattr)
+          retain_policy.release_and_clear dealloc_out, field_name
+        end
+      end
+
+      dealloc_out.lines
+    end
+
+  end
+
+end
+end