Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ksoichiro/rdotm

Objective-C resource definition generator like Android app's R.java.
https://github.com/ksoichiro/rdotm

android cli code-generation ios objective-c

Last synced: 3 months ago
JSON representation

Objective-C resource definition generator like Android app's R.java.

Host: GitHub
URL: https://github.com/ksoichiro/rdotm
Owner: ksoichiro
License: mit
Created: 2014-08-01T13:49:16.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2014-10-26T02:29:15.000Z (over 10 years ago)
Last Synced: 2024-07-29T19:20:14.850Z (7 months ago)
Topics: android, cli, code-generation, ios, objective-c
Language: Go
Homepage:
Size: 934 KB
Stars: 42
Watchers: 4
Forks: 4
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # rdotm

[![Build Status](https://travis-ci.org/ksoichiro/rdotm.svg?branch=master)](https://travis-ci.org/ksoichiro/rdotm)

[![Coverage Status](https://img.shields.io/coveralls/ksoichiro/rdotm/master.svg)](https://coveralls.io/r/ksoichiro/rdotm?branch=master)

rdotm(R.m) is the Objective-C resource definition generator like Android app's `R.java`.

[![Demo](testdata/images/demo.gif)](testdata/images/demo.gif)

## Features

### Color reference method generation

#### What is it?

A tool to generate code that makes you possible to access color resources via method:  

`#FF0099CC` -> `[R color_title]`

Hex color expressions are converted when executing this tool.  

(Generated colors are written using `[UIColor colorWithRed:green:blue:alpha]`.)

So if you have a utility method like `[UIColor colorWithHexString]` to convert hex strings on runtime, your app could be a little bit faster.

### Integer reference method generation

#### What is it?

A tool to generate code that makes you possible to access integer resources via method:  

`20` -> `[R integer_max_length_name]`  

`20` -> `[R integer_max_length_name]`

### String reference method generation

#### What is it?

A tool to generate code that makes you possible to access string resources via method:  

`anything` -> `[R string_something]`

#### Why should I use Android XML format?

Because you can share resource files with Android app project.

#### Why not NSLocalizedString?

You can use `Localizable.strings` and `NSLocalizedString`, but it has a problem that even if you have some typos you will not be noticed while compiling them.

For example, if you define a string like this:

```c

"something" = "anything";

```

then you can refer this string with the following code:

```objc

// OK, this will be @"anything"

NSString *s = NSLocalizedString(@"something", nil);

```

but you may mistype it:

```objc

// This is typo, but it won't cause any compile errors

NSString *s = NSLocalizedString(@"s0mething", nil);

```

This means that you must run the app manually and detect this bug with your eyes, or write some test codes to detect it.

### Drawable reference method generation

#### What is it?

A tool to generate code that makes you possible to access image resources via method:  

`res/drawable/[email protected]` -> `[R drawable_star]`

Suffix like `@2x` will be ignored, so `star.png` and `[email protected]` will be identified as the same images.

## Install

There are several methods to install rdotm.

### Release binary

[Get the latest release binary](https://github.com/ksoichiro/rdotm/releases/latest) is the easiest way to install it if you don't have golang environment.  

Note that the latest release may be stable but not always the "latest".  

If you want to use the truly latest version, install it with `go get` or `gom`.

### Homebrew

For OS X users, you can install it with [Homebrew](http://brew.sh/).

```sh

$ brew tap ksoichiro/rdotm

$ brew install rdotm

```

### Install as a golang package

If you want to install it as a global command, try this:

```sh

$ go get github.com/ksoichiro/rdotm

```

### Use gom (recommended)

If you use this tool in a Xcode build process,

using [gom](https://github.com/mattn/gom) is the recommended way.  

With this tool, you can manage rdotm's version in your VCS.

```sh

$ go get github.com/mattn/gom

$ echo "gom 'github.com/ksoichiro/rdotm'" > Gomfile

$ gom install

$ tree -L 5

.

├── Gomfile

└── _vendor

    ├── bin

    │   └── rdotm

    └── src

        └── github.com

            └── ksoichiro

                └── rdotm

```

Now you can use rdotm tool like following command:

```sh

$ PATH=_vendor/bin:$PATH rdotm -res ...

or

$ _vendor/bin/rdotm -res ...

```

See sample codes in `testdata/xcode` directories for details.

## Usage

### Basic

```sh

$ rdotm -res /path/to/res -out /path/to/output/dir

```

`res` directory should be the Android app's resource structure.  

Example:

```

res

├── drawable

│   ├── star.png

│   └── [email protected]

└── values

    ├── colors.xml

    └── strings.xml

```

### Options

| Option | Default | Description |

| ------ | ------- | ----------- |

| `-class` | R | Class name to overwrite default value(R). |

| `-clean` | false | Clean output directory before execution. |

| `-localize` | false | Enable localization using `NSLocalizedStringFromTable`. |

| `-ps` | string_ | Prefix for generated string methods. |

| `-pi` | integer_ | Prefix for generated integer methods. |

| `-pc` | color_ | Prefix for generated color methods. |

| `-pd` | drawable_ | Prefix for generated drawable methods. |

| `-pia` | array_integer_ | Prefix for generated integer array methods. |

| `-psa` | array_string_ | Prefix for generated string array methods. |

| `-types` | string,integer,color,drawable,integer-array,string-array | Types of resources. Separate with commas. |

## Example

### Input file

res/values/strings.xml

```xml

    Demo

    Hello, world!

```

res/values/integers.xml

```xml

    10

```

res/values/colors.xml

```xml

    #bef

    #990099cc

```

res/values/arrays.xml

```xml

    

        10

        20

        30

    

    

        hoge

        fuga

        piyo

    

```

res/drawables

```

res/drawable

├── star.png

└── [email protected]

```

### Output file

R.h

```objc

// DO NOT EDIT.

// This file is automatically generated by rdotm tool.

// https://github.com/ksoichiro/rdotm

#import 

@interface R : NSObject

/** Demo */

+ (NSString *)string_title_top;

/** Hello, world! */

+ (NSString *)string_label_message;

/** 10 */

+ (NSInteger)integer_sample_number;

/** #bef */

+ (UIColor *)color_default_bg;

/** #990099cc */

+ (UIColor *)color_default_text;

+ (UIImage *)drawable_star;

+ (NSArray *)array_integer_foobar;

+ (NSArray *)array_string_blurblur;

@end

```

R.m

```objc

// DO NOT EDIT.

// This file is automatically generated by rdotm tool.

// https://github.com/ksoichiro/rdotm

#import "R.h"

@implementation R

+ (NSString *)string_title_top { return @"Demo"; }

+ (NSString *)string_label_message { return @"Hello, world!"; }

+ (NSInteger)integer_sample_number { return 10; }

+ (UIColor *)color_default_bg { return [UIColor colorWithRed:187/255.0 green:238/255.0 blue:255/255.0 alpha:255/255.0]; }

+ (UIColor *)color_default_text { return [UIColor colorWithRed:0/255.0 green:153/255.0 blue:204/255.0 alpha:153/255.0]; }

+ (UIImage *)drawable_star { return [UIImage imageNamed:@"star"]; }

+ (NSArray *)array_integer_foobar { return @[@10, @20, @30]; }

+ (NSArray *)array_string_blurblur { return @[@"hoge", @"fuga", @"piyo"]; }

@end

```

#### If the localize option is enabled...

R.m

```objc

// DO NOT EDIT.

// This file is automatically generated by rdotm tool.

// https://github.com/ksoichiro/rdotm

#import "R.h"

@implementation R

+ (NSString *)string_title_top { return NSLocalizedStringFromTable(@"title_top", @"R", nil); }

+ (NSString *)string_label_message { return NSLocalizedStringFromTable(@"label_message", @"R", nil); }

+ (NSInteger)integer_sample_number { return 10; }

+ (UIColor *)color_default_bg { return [UIColor colorWithRed:187/255.0 green:238/255.0 blue:255/255.0 alpha:255/255.0]; }

+ (UIColor *)color_default_text { return [UIColor colorWithRed:0/255.0 green:153/255.0 blue:204/255.0 alpha:153/255.0]; }

+ (UIImage *)drawable_star { return [UIImage imageNamed:@"star"]; }

@end

```

Base.lproj/R.strings

```c

// DO NOT EDIT.

// This file is automatically generated by rdotm tool.

// https://github.com/ksoichiro/rdotm

"title_top" = "Demo";

"label_message" = "Hello, world!";

```

ja.lproj/R.strings

```c

// DO NOT EDIT.

// This file is automatically generated by rdotm tool.

// https://github.com/ksoichiro/rdotm

"title_top" = "デモ";

"label_message" = "こんにちは、世界！";

```

## License

Copyright (c) 2014 Soichiro Kashima  

Licensed under MIT license.  

See the bundled [LICENSE](https://github.com/ksoichiro/rdotm/blob/master/LICENSE) file for details.