Skip to content

Commit 8327bae

Browse files
sergiou87sergiou87
committed
Update license and README
1 parent 5802e82 commit 8327bae

13 files changed

+249
-51
lines changed

‎Example/Source/SPExample.h

+21-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,27 @@
11
//
2-
// SPExample.h
3-
// spgenstrings
2+
// SPExample.h
43
//
5-
// Created by Sergio Padrino on 25/01/14.
6-
// Copyright (c) 2014 Sergio Padrino All rights reserved.
4+
// The MIT License (MIT)
75
//
6+
// Copyright (c) 2014 Sergio Padrino
7+
//
8+
// Permission is hereby granted, free of charge, to any person obtaining a copy of
9+
// this software and associated documentation files (the "Software"), to deal in
10+
// the Software without restriction, including without limitation the rights to
11+
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
12+
// the Software, and to permit persons to whom the Software is furnished to do so,
13+
// subject to the following conditions:
14+
//
15+
// The above copyright notice and this permission notice shall be included in all
16+
// copies or substantial portions of the Software.
17+
//
18+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
20+
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
21+
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
22+
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23+
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24+
825

926
#import <Foundation/Foundation.h>
1027

‎Example/Source/SPExample.m

+21-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,27 @@
11
//
2-
// SPExample.m
3-
// spgenstrings
2+
// SPExample.m
43
//
5-
// Created by Sergio Padrino on 25/01/14.
6-
// Copyright (c) 2014 Sergio Padrino All rights reserved.
4+
// The MIT License (MIT)
75
//
6+
// Copyright (c) 2014 Sergio Padrino
7+
//
8+
// Permission is hereby granted, free of charge, to any person obtaining a copy of
9+
// this software and associated documentation files (the "Software"), to deal in
10+
// the Software without restriction, including without limitation the rights to
11+
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
12+
// the Software, and to permit persons to whom the Software is furnished to do so,
13+
// subject to the following conditions:
14+
//
15+
// The above copyright notice and this permission notice shall be included in all
16+
// copies or substantial portions of the Software.
17+
//
18+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
20+
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
21+
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
22+
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23+
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24+
825

926
#import "SPExample.h"
1027

‎LICENSE

+16-18
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
1-
Copyright (c) 2011, Oliver Drobnik All rights reserved.
1+
The MIT License (MIT)
22

3-
Redistribution and use in source and binary forms, with or without
4-
modification, are permitted provided that the following conditions are met:
3+
Copyright (c) 2014 Sergio Padrino
54

6-
- Redistributions of source code must retain the above copyright notice, this
7-
list of conditions and the following disclaimer.
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
811

9-
- Redistributions in binary form must reproduce the above copyright notice,
10-
this list of conditions and the following disclaimer in the documentation
11-
and/or other materials provided with the distribution.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
1214

13-
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
14-
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15-
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16-
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
17-
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18-
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19-
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
20-
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
21-
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22-
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

‎Readme.markdown

+123-12
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,131 @@
1-
DTLocalizableStringScanner
2-
==========================
1+
## SPLocalizedString
32

4-
This project aims to duplicate and enhance the functionality found in the `genstrings` utility provided by Apple. The Demo builds a command line utility `genstrings2` which works like the original but using more modern techniques. The Core contains classes and categories to add this scanning functionality to [Linguan](http://www.cocoanetics.com/apps/linguan/).
3+
SPLocalizedString is a library to help iOS developers to localize their apps.
54

6-
Documentation
7-
-------------
5+
Features:
86

9-
Documentation can be [browsed online](https://docs.cocoanetics.com/DTLocalizableStringScanner) or installed in your Xcode Organizer via the [Atom Feed URL](https://docs.cocoanetics.com/DTLocalizableStringScanner/DTLocalizableStringScanner.atom).
7+
* Context-based keys
8+
* Plural strings
9+
* Customized ```genstrings``` tool (called ```spgenstrings```) to extract all localizable text from your source code
1010

11-
Follow [@cocoanetics](http://twitter.com/cocoanetics) on Twitter or subscribe to the [Cocoanetics Blog](http://www.cocoanetics.com) for news and updates.
11+
Features of ```spgenstrings```:
1212

13-
License
14-
-------
13+
* Based on the work of [Cocoanetics](http://www.cocoanetics.com/) on [DTLocalizableStringScanner](https://github.com/Cocoanetics/DTLocalizableStringScanner)
14+
* Works with ```SPLocalizedString```
15+
* Merges the extracted localized strings with the ones that you already had (probably already translated)
16+
* Removes unused strings and tables if you wish
1517

16-
It is open source and covered by a standard 2-clause BSD license. That means you have to mention *Cocoanetics* as the original author of this code and reproduce the LICENSE text inside your app.
18+
## Why?
1719

18-
You can purchase a [Non-Attribution-License](https://www.cocoanetics.com/order/?product_id=DTLocalizableStringScanner) for 75 Euros for not having to include the LICENSE text.
20+
Let's face the truth: ```genstrings``` and the key-based NSLocalizedString with comments are not the best tools to localize your apps. Some reasons:
1921

20-
We also accept sponsorship for specific enhancements which you might need. Please [contact us via email](mailto:[email protected]?subject=DTLocalizableStringScanner) for inquiries.
22+
* ```genstrings``` overrides old files with the new ones (with some translations probably). Therefore you have to manage merging them.
23+
* Adding comments with ```NSLocalizedString``` gives the translator a hint about the context, but two strings with the same key and different comments cannot be referenced from your code separately.
24+
* A key-per-context approach forces you to provide default values for your localized strings or create a strings file during the development cycle.
25+
* It's a closed system: you cannot alter the way these two tools work together because they're not open source. If you don't like SPLocalizedString, fork it and make pull requests or build your own tools :)
26+
27+
## Install
28+
29+
1. **Using CocoaPods**
30+
31+
Add SPLocalizedString to your Podfile:
32+
33+
```
34+
platform :ios, "6.0"
35+
pod 'SPLocalizedString'
36+
```
37+
38+
Run the following command:
39+
40+
```
41+
pod install
42+
```
43+
44+
2. **Static Library**
45+
46+
Clone the project or add it as a submodule. Drag *SPLocalizedString.xcodeproj* to your project, add it as a target dependency and link *libSPLocalizedString.a*.
47+
Then, you can simply do:
48+
49+
```
50+
#import <SPLocalizedString/SPLocalizedString.h>
51+
```
52+
53+
3. **Manually**
54+
55+
Clone the project or add it as a submodule. Drag the whole SPLocalizedString folder to your project.
56+
57+
## Usage of SPLocalizedString
58+
59+
Its usage is very similar to NSLocalizedString, but with a fundamental change: aside from the key you don't provide a comment, you provide a *context*. Example:
60+
61+
```objective-c
62+
someLabel.text = SPLocalizedString(@"Name", @"Name label in login screen")
63+
...
64+
otherLabel.text = SPLocalizedString(@"Name", @"Name label in registration screen")
65+
```
66+
67+
Depending on your UI layout, the target languages and other factors, you may need different texts for those two labels even if they have the same text in the beginning. Therefore, SPLocalizedString considers the *context* as part of the key.
68+
69+
In order to fulfill these strings properly, you'll need a Localizable.strings file with the following lines:
70+
71+
```
72+
"(Name label in login screen)Name" = "Name";
73+
"(Name label in registration screen)Name" = "Name";
74+
```
75+
76+
As you can see, for each string the actual key is made of the context and the key you specified with SPLocalizedString.
77+
78+
This file can be automatically generated with ```spgenstrings```. If you don't have a strings file yet, the default value will be the given key (in this case _Name_).
79+
80+
### Plurals
81+
82+
SPLocalizedString provides some useful functions to manage plurals: *SPLocalizedStringPlural*, which accepts an additional parameter after the context indicating the _number_ of elements referenced in the string. For example:
83+
84+
```objective-c
85+
NSString *formatString = SPLocalizedStringPlural(@"You have %d followers.", @"Number of followers label", numberOfFollowers);
86+
followersLabel.text = [NSString stringWithFormat:formatString, numberOfFollowers];
87+
```
88+
89+
In order to fulfill these strings properly, you'll need a Localizable.strings file with the following lines:
90+
91+
```
92+
"(Number of followers label##one)You have %d followers." = "You have %d followers.";
93+
"(Number of followers label##other)You have %d followers." = "You have %d followers.";
94+
```
95+
96+
Again, this file can be automatically generated with ```spgenstrings```. If you don't have a strings file yet, the default value will be the given key (in this case _You have %d followers._).
97+
98+
If you look closely, for one key and context you need 2 strings: one when you have 1 follower (with the *##one* suffix in the context), another one for the rest of cases (with the *##other* suffix in the context). An example would be:
99+
100+
```
101+
"(Number of followers label##one)You have %d followers." = "You have just one follower.";
102+
"(Number of followers label##other)You have %d followers." = "You have %d followers.";
103+
```
104+
105+
## Usage of spgenstrings
106+
107+
```spgenstrings``` is a command line tool. It's based on [genstrings2](https://github.com/Cocoanetics/DTLocalizableStringScanner) (an open source implementation of ```genstrings``` by [Cocoanetics](http://www.cocoanetics.com/)), so it shares most of the options with the original ```genstrings```.
108+
109+
The most common way to use it is:
110+
```bash
111+
spgenstrings -deleteUnusedEntries -deleteUnusedTables -o <output dir> <source files to process...>
112+
```
113+
114+
The ```-deleteUnusedEntries``` and ```-deleteUnusedTables``` options removes old entries and strings files that are not referenced anymore in your source code.
115+
116+
## Contact
117+
118+
SPLocalizedString was created by Sergio Padrino: [@sergiou87](https://twitter.com/sergiou87), based on the work of [Cocoanetics](http://www.cocoanetics.com/) on [DTLocalizableStringScanner](https://github.com/Cocoanetics/DTLocalizableStringScanner).
119+
120+
## Contributing
121+
122+
If you want to contribute to the project just follow this steps:
123+
124+
1. Fork the repository.
125+
2. Clone your fork to your local machine.
126+
3. Create your feature branch.
127+
4. Commit your changes, push to your fork and submit a pull request.
128+
129+
## License
130+
131+
SPLocalizedString is available under the MIT license. See the [LICENSE file](https://github.com/sergiou87/SPLocalizedString/blob/master/LICENSE) for more info.

‎SPLocalizedString/SPLocalizedString.h

+20-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,26 @@
11
//
2-
// SPLocalizedString.h
3-
// genstrings2
2+
// SPLocalizedString.h
43
//
5-
// Created by Sergio Padrino on 25/01/14.
6-
// Copyright (c) 2014 Sergio Padrino All rights reserved.
4+
// The MIT License (MIT)
75
//
6+
// Copyright (c) 2014 Sergio Padrino
7+
//
8+
// Permission is hereby granted, free of charge, to any person obtaining a copy of
9+
// this software and associated documentation files (the "Software"), to deal in
10+
// the Software without restriction, including without limitation the rights to
11+
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
12+
// the Software, and to permit persons to whom the Software is furnished to do so,
13+
// subject to the following conditions:
14+
//
15+
// The above copyright notice and this permission notice shall be included in all
16+
// copies or substantial portions of the Software.
17+
//
18+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
20+
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
21+
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
22+
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23+
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
824

925
#import <Foundation/Foundation.h>
1026

‎SPLocalizedString/SPLocalizedString.m

+20-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,26 @@
11
//
2-
// SPLocalizedString.m
3-
// genstrings2
2+
// SPLocalizedString.m
43
//
5-
// Created by Sergio Padrino on 25/01/14.
6-
// Copyright (c) 2014 Sergio Padrino All rights reserved.
4+
// The MIT License (MIT)
75
//
6+
// Copyright (c) 2014 Sergio Padrino
7+
//
8+
// Permission is hereby granted, free of charge, to any person obtaining a copy of
9+
// this software and associated documentation files (the "Software"), to deal in
10+
// the Software without restriction, including without limitation the rights to
11+
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
12+
// the Software, and to permit persons to whom the Software is furnished to do so,
13+
// subject to the following conditions:
14+
//
15+
// The above copyright notice and this permission notice shall be included in all
16+
// copies or substantial portions of the Software.
17+
//
18+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
20+
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
21+
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
22+
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23+
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
824

925
#import "SPLocalizedString.h"
1026

‎spgenstrings/Core/Source/DTLocalizableStringAggregator.h

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
//
55
// Created by Oliver Drobnik on 02.01.12.
66
// Copyright (c) 2012 Drobnik KG. All rights reserved.
7+
// Copyright (c) 2014 Sergio Padrino All rights reserved.
78
//
89

910
#import <Foundation/Foundation.h>

‎spgenstrings/Core/Source/DTLocalizableStringAggregator.m

+1
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
//
66
// Created by Oliver Drobnik on 02.01.12.
77
// Copyright (c) 2012 Drobnik KG. All rights reserved.
8+
// Copyright (c) 2014 Sergio Padrino All rights reserved.
89
//
910

1011
#import "DTLocalizableStringAggregator.h"

‎spgenstrings/Core/Source/DTLocalizableStringTable.h

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
//
55
// Created by Oliver Drobnik on 1/12/12.
66
// Copyright (c) 2012 Drobnik KG. All rights reserved.
7+
// Copyright (c) 2014 Sergio Padrino All rights reserved.
78
//
89

910
#import <Foundation/Foundation.h>

‎spgenstrings/Core/Source/DTLocalizableStringTable.m

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
//
55
// Created by Oliver Drobnik on 1/12/12.
66
// Copyright (c) 2012 Drobnik KG. All rights reserved.
7+
// Copyright (c) 2014 Sergio Padrino All rights reserved.
78
//
89

910
#import "DTLocalizableStringTable.h"

‎spgenstrings/Core/Source/DTLocalizableStringsParser.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
//
55
// Created by Stefan Gugarel on 2/27/13.
66
// Copyright (c) 2013 Drobnik KG. All rights reserved.
7+
// Copyright (c) 2014 Sergio Padrino All rights reserved.
78
//
89

910

@@ -30,7 +31,7 @@
3031

3132
/**
3233
Parses the file.
33-
@returns Parsed table
34+
@returns `
3435
*/
3536
- (DTLocalizableStringTable *)parse;
3637

‎spgenstrings/Core/Source/DTLocalizableStringsParser.m

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
//
55
// Created by Stefan Gugarel on 2/27/13.
66
// Copyright (c) 2013 Drobnik KG. All rights reserved.
7+
// Copyright (c) 2014 Sergio Padrino All rights reserved.
78
//
89

910
#import "DTLocalizableStringsParser.h"

‎spgenstrings/Core/Source/SPLocalizableStringsValidMacros.h

+21-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,27 @@
11
//
2-
// SPLocalizableStringsValidMacros.h
3-
// spgenstrings
2+
// SPLocalizableStringsValidMacros.h
43
//
5-
// Created by Sergio Padrino on 25/01/14.
6-
// Copyright (c) 2014 Drobnik KG. All rights reserved.
4+
// The MIT License (MIT)
75
//
6+
// Copyright (c) 2014 Sergio Padrino
7+
//
8+
// Permission is hereby granted, free of charge, to any person obtaining a copy of
9+
// this software and associated documentation files (the "Software"), to deal in
10+
// the Software without restriction, including without limitation the rights to
11+
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
12+
// the Software, and to permit persons to whom the Software is furnished to do so,
13+
// subject to the following conditions:
14+
//
15+
// The above copyright notice and this permission notice shall be included in all
16+
// copies or substantial portions of the Software.
17+
//
18+
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
20+
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
21+
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
22+
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23+
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24+
825

926
#import <Foundation/Foundation.h>
1027

0 commit comments

Comments
 (0)