RubyGems - xdry - Versions diffs - 0.1.0 - Mend

xdry 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (52) hide show

data/LICENSE +20 -0
data/README.md +11 -0
data/Rakefile +76 -0
data/VERSION +1 -0
data/bin/xdry +4 -0
data/lib/xdry.rb +18 -0
data/lib/xdry/boxing.rb +212 -0
data/lib/xdry/generators/ctor_from_field.rb +91 -0
data/lib/xdry/generators/dealloc.rb +53 -0
data/lib/xdry/generators/dictionary_coding.rb +129 -0
data/lib/xdry/generators/field_from_property.rb +20 -0
data/lib/xdry/generators/property-from-field.rb +22 -0
data/lib/xdry/generators/storing_constructor.rb +72 -0
data/lib/xdry/generators/synthesize.rb +25 -0
data/lib/xdry/generators_support.rb +42 -0
data/lib/xdry/parsing/driver.rb +106 -0
data/lib/xdry/parsing/model.rb +272 -0
data/lib/xdry/parsing/nodes.rb +260 -0
data/lib/xdry/parsing/parsers.rb +166 -0
data/lib/xdry/parsing/parts/selectors.rb +95 -0
data/lib/xdry/parsing/parts/var_types.rb +66 -0
data/lib/xdry/parsing/pos.rb +75 -0
data/lib/xdry/parsing/scope_stack.rb +68 -0
data/lib/xdry/parsing/scopes.rb +61 -0
data/lib/xdry/parsing/scopes_support.rb +143 -0
data/lib/xdry/patching/emitter.rb +60 -0
data/lib/xdry/patching/insertion_points.rb +209 -0
data/lib/xdry/patching/item_patchers.rb +74 -0
data/lib/xdry/patching/patcher.rb +139 -0
data/lib/xdry/run.rb +227 -0
data/lib/xdry/support/enumerable_additions.rb +35 -0
data/lib/xdry/support/string_additions.rb +27 -0
data/lib/xdry/support/symbol_additions.rb +14 -0
data/site/_config.yml +3 -0
data/site/_example +9 -0
data/site/_layouts/default.html +30 -0
data/site/_plugins/example.rb +16 -0
data/site/_plugins/highlight_unindent.rb +17 -0
data/site/index.md +417 -0
data/site/master.css +94 -0
data/spec/boxing_spec.rb +80 -0
data/spec/ctor_from_field_spec.rb +251 -0
data/spec/dealloc_spec.rb +103 -0
data/spec/dictionary_coding_spec.rb +132 -0
data/spec/field_from_prop_spec.rb +72 -0
data/spec/prop_from_field_spec.rb +39 -0
data/spec/readme_samples_spec.rb +76 -0
data/spec/spec.opts +3 -0
data/spec/spec_helper.rb +53 -0
data/spec/synthesize_spec.rb +94 -0
data/xdry.gemspec +103 -0
metadata +141 -0

data/lib/xdry/support/enumerable_additions.rb ADDED Viewed

@@ -0,0 +1,35 @@
+module XDry
+  module EnumerableAdditions
+    def prefix_while
+      result = []
+      each do |item|
+        if yield(item)
+          result << item
+        else
+          break
+        end
+      end
+      return result
+    end
+    def suffix_while
+      result = []
+      reverse_each do |item|
+        if yield(item)
+          result << item
+        else
+          break
+        end
+      end
+      return result.reverse!
+    end
+  end
+  # tried to extend Enumerable here, but it did not work, so resorted to only extending Array
+  Array.send(:include, EnumerableAdditions)
+end

data/lib/xdry/support/string_additions.rb ADDED Viewed

@@ -0,0 +1,27 @@
+module XDry
+  module StringAdditions
+    def blank?
+      self =~ /^\s*$/
+    end
+    def capitalized_identifier
+      case self
+        when 'id', 'uid' then upcase
+        else self[0..0].upcase + self[1..-1]
+      end
+    end
+    def prefixed_as_arg_name
+      prefix = case self when /^[aeiou]/ then 'an' else 'a' end
+      prefix + self.capitalized_identifier
+    end
+  end
+  String.send(:include, StringAdditions)
+end

data/lib/xdry/support/symbol_additions.rb ADDED Viewed

@@ -0,0 +1,14 @@
+module XDry
+  module SymbolAdditions
+    def to_proc
+      proc { |obj, *args| obj.send(self, *args) }
+    end
+  end
+  Symbol.send(:include, SymbolAdditions)
+end

data/site/_config.yml ADDED Viewed

@@ -0,0 +1,3 @@
+safe: false
+lsi: false
+pygments: true

data/site/_example ADDED Viewed

@@ -0,0 +1,9 @@
+{% example %}
+{% highlight objc %}
+{% endhighlight %}
+{% highlight objc %}
+{% endhighlight %}
+{% endexample %}

data/site/_layouts/default.html ADDED Viewed

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>Objective-C boilerplate generator — Extra DRY</title>
+  <link href='http://fonts.googleapis.com/css?family=Pacifico' rel='stylesheet' type='text/css'>
+  <link href='http://fonts.googleapis.com/css?family=PT+Serif' rel='stylesheet' type='text/css'>
+  <link href="master.css" rel="stylesheet" type="text/css" media="screen" charset="utf-8">
+</head>
+<body>
+  <a href="http://github.com/andreyvit/xdry"><img style="position: absolute; top: 0; right: 0; border: 0;" src="http://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" /></a>
+  <div id="container">
+    {{ content }}
+  </div>
+  <script type="text/javascript">
+var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
+document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
+</script>
+<script type="text/javascript">
+try {
+var pageTracker = _gat._getTracker("UA-861679-14");
+pageTracker._trackPageview();
+} catch(err) {}</script>
+</body>
+</html>

data/site/_plugins/example.rb ADDED Viewed

@@ -0,0 +1,16 @@
+module Jekyll
+  class HelloTag < Liquid::Block
+    def initialize(tag_name, text, tokens)
+      super
+      @text = text
+    end
+    def render(context)
+      ['<div class="example">'] + super + ['</div>']
+    end
+  end
+end
+Liquid::Template.register_tag('example', Jekyll::HelloTag)

data/site/_plugins/highlight_unindent.rb ADDED Viewed

@@ -0,0 +1,17 @@
+class Jekyll::HighlightBlock
+  def render_pygments_with_unindent(context, code)
+    code = code.split("\n").collect do |line|
+      if line =~ /^ {4}/
+        line[4..-1]
+      else
+        line
+      end
+    end.join("\n")
+    render_pygments_without_unindent(context, code)
+  end
+  alias_method :render_pygments_without_unindent, :render_pygments
+  alias_method :render_pygments, :render_pygments_with_unindent
+end

data/site/index.md ADDED Viewed

@@ -0,0 +1,417 @@
+---
+title: Home
+layout: default
+---
+Objective-C boilerplate generator
+=================================
+Run Extra D.R.Y. in your Objective-C project folder to automatically add (upon your request):
+* `@property`, `@synthesize`, field declarations,
+* initializing constructors,
+* missing release calls in dealloc,
+* initWithDictionary, dictionaryRepresentation based on the chosen fields.
+Installation
+------------
+Install the command-line utility via RubyGems:
+    sudo gem install xdry
+Basic Usage
+-----------
+Tell XD.R.Y. which changes you want done using bang-commands. For example,
+add `!p` to a field declaration line to generate a property:
+{% example %}
+{% highlight objc %}
+    // Foo.h
+    @interface Foo {
+      Bar *value; !p
+    }
+    @end
+    // Foo.m
+    @implementation Foo
+    @end
+{% endhighlight %}
+{% highlight objc %}
+    // Foo.h
+    @interface Foo {
+      Bar *value;
+    }
+    @property(nonatomic, retain) Bar *value;
+    @end
+    // Foo.m
+    @implementation Foo
+    @synthesize value;
+    - (void)dealloc {
+      [value release], value = nil;
+      [super dealloc];
+    }
+    @end
+{% endhighlight %}
+{% endexample %}
+To run XD.R.Y., open a Terminal, cd to your project folder and execute `xdry`:
+    cd ~/Documents/HelloWorld
+    xdry
+Automatic Changes
+-----------------
+Without any instructions from your side, XD.R.Y. automatically applies the following
+changes:
+* Adds missing release calls to `dealloc` methods:
+{% example %}
+{% highlight objc %}
+    @interface Foo {
+      NSString *value;
+    }
+    @end
+    @implementation Foo
+    @end
+{% endhighlight %}
+{% highlight objc %}
+    @interface Foo {
+      NSString *value;
+    }
+    @end
+    @implementation Foo
+    - (void)dealloc {
+      [value release], value = nil;
+      [super dealloc];
+    }
+    @end
+{% endhighlight %}
+{% endexample %}
+* Adds missing `@synthesize` declarations for properties with no explicit accessor methods:
+{% example %}
+{% highlight objc %}
+    @interface Foo {
+      NSString *value;
+    }
+    @property(nonatomic, copy) NSString *value;
+    @end
+    @implementation Foo
+    @end
+{% endhighlight %}
+{% highlight objc %}
+    @interface Foo {
+      NSString *value;
+    }
+    @property(nonatomic, copy) NSString *value;
+    @end
+    @implementation Foo
+    @synthesize value;
+    @end
+{% endhighlight %}
+{% endexample %}
+* Adds missing fields for declared properties:
+{% example %}
+{% highlight objc %}
+    @interface Foo {
+    }
+    @property(nonatomic, copy) NSString *value;
+    @end
+{% endhighlight %}
+{% highlight objc %}
+    @interface Foo {
+      NSString *value;
+    }
+    @property(nonatomic, copy) NSString *value;
+    @end
+{% endhighlight %}
+{% endexample %}
+Properties, Fields, Constructors
+--------------------------------
+`!p` — generate a property for the given field:
+{% example %}
+{% highlight objc %}
+    @interface Foo {
+      Bar *value; !p
+    }
+    @end
+    @implementation Foo
+    @end
+{% endhighlight %}
+{% highlight objc %}
+    @interface Foo {
+      Bar *value;
+    }
+    @property(nonatomic, retain) Bar *value;
+    @end
+    @implementation Foo
+    @synthesize value;
+    - (void)dealloc {
+      [value release], value = nil;
+      [super dealloc];
+    }
+    @end
+{% endhighlight %}
+{% endexample %}
+`!c` — generate an initializing constructor for the given field(s):
+{% example %}
+{% highlight objc %}
+    @interface Foo {
+      NSString *_something; !c
+    }
+    @end
+    @implementation Foo
+    @end
+{% endhighlight %}
+{% highlight objc %}
+    @interface Foo {
+      NSString *_something;
+    }
+    - (id)initWithSomething:(NSString *)something;
+    @end
+    @implementation Foo
+    - (id)initWithSomething:(NSString *)something {
+      if (self = [super init]) {
+        _something = [something copy];
+      }
+      return self;
+    }
+    @end
+{% endhighlight %}
+{% endexample %}
+Dictionary Coding
+-----------------
+XD.R.Y. can generate `initWithDictionary:(NSDictionary *)dictionary` method, useful for loading objects from a plist. Similarly, an `(NSDictionary *)dictionaryRepresentation` method is generated to produce a plist-friendly dictionary from an object.
+`// persistent` marks a block of fields to read from a dictionary / serialize into a dictionary:
+{% example %}
+{% highlight objc %}
+    @interface Foo {
+      // persistent
+      NSString *_something;
+    }
+    @end
+    @implementation Foo
+    @end
+{% endhighlight %}
+{% highlight objc %}
+    @interface Foo {
+      // persistent
+      NSString *_something;
+    }
+    @end
+    #define SomethingKey @"Something"
+    @implementation Foo
+    - (id)initWithDictionary:(NSDictionary *)dictionary {
+      if (self = [super init]) {
+        id somethingRaw = [dictionary objectForKey:SomethingKey];
+        if (somethingRaw != nil) {
+          _something = [somethingRaw copy];
+        }
+      }
+      return self;
+    }
+    - (NSDictionary *)dictionaryRepresentation {
+      NSMutableDictionary *dictionary = [NSMutableDictionary dictionary];
+      [dictionary setObject:_something forKey:SomethingKey];
+      return dictionary;
+    }
+    @end
+{% endhighlight %}
+{% endexample %}
+To correctly handle serialization and deserialization of arrays,
+you need to hint XD.R.Y. about the item type:
+{% example %}
+{% highlight objc %}
+    @interface Foo {
+      // persistent
+      NSArray *_bars; // of Bar
+    }
+    @end
+    @implementation Foo
+    @end
+{% endhighlight %}
+{% highlight objc %}
+    @interface Foo {
+      // persistent
+      NSArray *_bars; // of Bar
+    }
+    @end
+    @implementation Foo
+    #define BarsKey @"Bars"
+    @implementation Foo
+    - (id)initWithDictionary:(NSDictionary *)dictionary {
+      if (self = [super init]) {
+        id barsRaw = [dictionary objectForKey:BarsKey];
+        if (barsRaw != nil) {
+          NSMutableArray *barsArray = [[NSMutableArray alloc] init];
+          for (NSDictionary *barsItemDict in (NSArray *) barsRaw) {
+            Bar *barsItem = [[Bar alloc] initWithDictionary:barsItemDict];
+            [barsArray addObject:barsItem];
+            [barsItem release];
+          }
+          _bars = barsArray;
+        }
+      }
+      return self;
+    }
+    - (NSDictionary *)dictionaryRepresentation {
+      NSMutableDictionary *dictionary = [NSMutableDictionary dictionary];
+      NSMutableArray *barsArray = [NSMutableArray array];
+      for (Bar *barsItem in _bars) {
+        [barsArray addObject:[barsItem dictionaryRepresentation]];
+      }
+      [dictionary setObject:barsArray forKey:BarsKey];
+      return dictionary;
+    }
+    - (void)dealloc {
+      [_bars release], _bars = nil;
+      [super dealloc];
+    }
+    @end
+{% endhighlight %}
+{% endexample %}
+License and Authors
+-------------------
+Copyright 2010–2011, Andrey Tarantsov.
+Distributed under the MIT license, see LICENSE file for details.
+Contributing
+------------
+Fork the source on GitHub: [http://github.com/andreyvit/xdry](http://github.com/andreyvit/xdry).
+Add a test, make a change, verify that all tests pass, update the docs in site/index.md, send me a pull request.
+Testing prerequisites:
+    sudo gem install rake rspec diff-lcs
+The simplest way to run the tests:
+    rake
+Get a nice colorful table with test results:
+    rspec -b -c -fd .
+When something goes wrong, you want a verbose output:
+    VERBOSE=1 rake
+Site (documentation) prerequisites:
+    sudo gem install jekyll
+    sudo easy_install Pygments
+Regenerate the site using:
+    rake site:build
+(open site/_site/index.html to view the results).
+Don't bother with gh-pages branch.