xcres 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66662fa71e28ebba0f9e8709d34eaa747884acd5
-  data.tar.gz: 848102aa3b625215e7523bfec8e216e6c9d2b80f
+  metadata.gz: 07f166368a1c3c20e976d5cb5dac003e1f0b0e87
+  data.tar.gz: 164c9556d5bbf9054c05cd869e349219bd615e64
 SHA512:
-  metadata.gz: 22ab34d31c641dfae88fe78ef6e5c19e9a60e6b1244f269f511343b7a6f72461640c7cf8d6b845b414dba357a27a981c85de16a42879dfa69bcd7804fc790467
-  data.tar.gz: 477d6500c3aa810f1d97f04203e00965cbe0ab11b2c9f2977a5ccaecc090d9c2250a721da0e009298bf32fb3a3bc5adce0ea82eefde001abfd5f2df8cbe5c475
+  metadata.gz: ee5805f7a5e36fc235ae813606a5bb738eb19a9ad89f6ccaf578e1996158470e5f76b49f210e25dd80635087af7810aa146df365f85cc8b59d160a7fff992380
+  data.tar.gz: f0db23ce61854cbd8ad7095e5884ef057f5031c3524ec1dde941d675fb316cd1ef9f678b92e667add56c6e112c98e40ddc1768ae5ceab5c249d4124a3a38764a

data/Gemfile.lock

@@ -1,42 +1,41 @@
 PATH
   remote: .
   specs:
-    xcres (0.4.4)
+    xcres (0.5.0)
       activesupport (>= 3.2.15, < 4)
       clamp (~> 0.6.3)
       colored (~> 1.2)
-      libxml-ruby
       xcodeproj (~> 0.18)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (3.2.19)
+    activesupport (3.2.22)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     ast (2.0.0)
     bacon (1.2.0)
-    clamp (0.6.3)
+    claide (0.9.1)
+    clamp (0.6.5)
     clintegracon (0.5.2)
       colored (~> 1.2)
       diffy
     coderay (1.1.0)
     colored (1.2)
     diffy (3.0.6)
-    i18n (0.6.11)
+    i18n (0.7.0)
     inch (0.4.10)
       pry
       sparkr (>= 0.2.0)
       term-ansicolor
       yard (~> 0.8.7)
-    libxml-ruby (2.7.0)
     metaclass (0.0.4)
     method_source (0.8.2)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
       mocha (>= 0.13.0)
-    multi_json (1.10.1)
+    multi_json (1.11.2)
     parser (2.2.0.pre.4)
       ast (>= 1.1, < 3.0)
       slop (~> 3.4, >= 3.4.5)
@@ -61,8 +60,9 @@ GEM
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     tins (1.3.2)
-    xcodeproj (0.19.4)
-      activesupport (~> 3.0)
+    xcodeproj (0.28.2)
+      activesupport (>= 3)
+      claide (~> 0.9.1)
       colored (~> 1.2)
     yard (0.8.7.4)
 
@@ -81,3 +81,6 @@ DEPENDENCIES
   rake
   rubocop
   xcres!
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -26,18 +26,43 @@ capitalization or converting name scheme from *train-case* or *snake_case* to
 *camelCase* and vice versa.
 
 It will warn you in Xcode on build, if certain resources or string keys can't be
-references, because their name contain invalid chars, duplicates in the
+referenced, because their name contain invalid chars, duplicates in the
 *camelCase* variant with another key, or would be equal to a protected compiler
 keyword.
 
 The generated index could look like below.
 
-While this is still **Objective-C**, `xcres` is compatible with **Swift**.
-All you need to do is to add an import to the generated header to your
-project's bridging header.
+`xcres` can generate code both as **Swift** or **Objective-C**.
+If you are using both in your project choose **Objective-C** and add an import to
+the generated header to your project's bridging header.
 
+**Swift**
+```swift
+public class R {
+    public enum Images: String {
+        /// doge.jpeg
+        case doge = "doge.jpeg"
+    }
+    public enum ImagesAssets: String {
+        /// AppIcon
+        case app = "AppIcon"
+        /// LaunchImage
+        case launch = "LaunchImage"
+        /// DefaultAvatar
+        case defaultAvatar = "DefaultAvatar"
+    }
+    public enum Strings: String {
+        /// Title shown if a wrong password was entered.
+        case errorTitleWrongPassword = "error_title_wrong_password"
+        /// Message shown if a wrong password was entered.
+        case errorMessageWrongPassword = "error_message_wrong_password"
+    }
+}
+```
+
+**Objective-C**
 ```objc
-const struct R {
+FOUNDATION_EXTERN const struct R {
     struct Images {
         /// doge.jpeg
         __unsafe_unretained NSString *doge;
@@ -78,6 +103,12 @@ $ [sudo] gem install xcres
 Use the automatic integration to add a build phase to your project,
 by executing the following command:
 
+**Swift**
+```bash
+$ xcres install --swift
+```
+
+**Objective-C**
 ```bash
 $ xcres install
 ```
@@ -145,6 +176,12 @@ NSLocalizedString(@"error_message_wrong_password", @"Message shown if a wrong pa
 
 Just write:
 
+**Swift**
+```swift
+R.Strings.errorMessageWrongPassword.localizedValue
+```
+
+**Objective-C**
 ```objc
 NSLocalizedString(R.Strings.errorMessageWrongPassword, @"Message shown if a wrong password was entered.")
 ```
@@ -179,6 +216,7 @@ your project to non-natural language keys.
 ## Credits
 
 The logo was designed by [@kuchengnom](https://github.com/kuchengnom).
+Swift support was implemented by [@timbodeit](https://github.com/timbodeit).
 
 
 ## License

data/lib/xcres/analyzer/strings_analyzer.rb

@@ -233,7 +233,7 @@ module XCRes
         strings = read_strings_file(path)
 
         # Reject generated identifiers used by Interface Builder
-        strings.reject! { |key, _| /^[a-zA-Z0-9]{3}(-[a-zA-Z0-9]{3}){2}/.match(key) }
+        strings.reject! { |key, _| /^[a-zA-Z0-9]{3}-[a-zA-Z0-9]{2,3}-[a-zA-Z0-9]{3}/.match(key) }
 
         keys = Hash[strings.map do |key, value|
           [key, { value: key, comment: value.gsub(/[\r\n]/, ' ') }]

data/lib/xcres/builder/resources_builder.rb

@@ -13,12 +13,29 @@ class XCRes::ResourcesBuilder < XCRes::FileBuilder
 //
 EOS
 
-  COMPILER_KEYWORDS = %w{
+  OBJC_COMPILER_KEYWORDS = %w{
     auto break case char const continue default do double else enum extern float
     for goto if inline int long register restrict return short signed sizeof
     static struct switch typedef union unsigned void volatile while
   }
 
+  SWIFT_COMPILER_KEYWORDS = %w{
+    class deinit enum extension func import init internal let operator private
+    protocol public static struct subscript typealias var break case continue
+    default do else fallthrough for if in return switch where while as
+    dynamicType false is nil self Self super true
+  }
+
+  SWIFT_EXTENSIONS = <<EOS
+public extension %s.Strings {
+    public var localizedValue: String {
+        return NSLocalizedString(self.rawValue,
+                                 bundle: NSBundle(forClass: R.self),
+                                 comment: "")
+    }
+}
+EOS
+
   # @return [String]
   #         the name of the constant in the generated file(s)
   attr_accessor :resources_constant_name
@@ -29,6 +46,12 @@ EOS
   attr_accessor :documented
   alias :documented? :documented
 
+  # @return [Bool]
+  #         whether Swift code should be generated,
+  #         Objective-C used if false, false by default
+  attr_accessor :swift
+  alias :swift? :swift
+
   # @return [Hash{String => {String => String}}]
   #         the sections, which will been written to the built files
   attr_reader :sections
@@ -38,6 +61,7 @@ EOS
   def initialize
     @sections = {}
     self.documented = true
+    self.swift = false
   end
 
   # Extract resource name from #output_path, if not customized
@@ -63,7 +87,8 @@ EOS
       end
 
       # Skip compiler keywords
-      if COMPILER_KEYWORDS.include? transformed_key
+      compiler_keywords = swift? ? SWIFT_COMPILER_KEYWORDS : OBJC_COMPILER_KEYWORDS
+      if compiler_keywords.include? transformed_key
         logger.warn "Skip invalid key: '%s'. (Was transformed to keyword '%s')", key, transformed_key
         next
       end
@@ -77,14 +102,11 @@ EOS
   def build
     super
 
-    # Build file contents and write them to disk
-    write_file_eventually "#{output_path}.h", (build_contents do |h_file|
-      build_header_contents h_file
-    end)
-
-    write_file_eventually "#{output_path}.m", (build_contents do |m_file|
-      build_impl_contents m_file
-    end)
+    if swift?
+      build_and_write_swift
+    else
+      build_and_write_objc
+    end
   end
 
   protected
@@ -118,7 +140,26 @@ EOS
         end
       end
 
-      result
+      # If the first character is not a letter, prefix it with an underscore
+      result.gsub(/^[^_a-z]/i, '_\0')
+    end
+
+    def build_and_write_swift
+      # Build file contents and write them to disk
+      write_file_eventually "#{output_path}.swift", (build_contents do |swift_file|
+        build_swift_contents swift_file
+      end)
+    end
+
+    def build_and_write_objc
+      # Build file contents and write them to disk
+      write_file_eventually "#{output_path}.h", (build_contents do |h_file|
+        build_header_contents h_file
+      end)
+
+      write_file_eventually "#{output_path}.m", (build_contents do |m_file|
+        build_impl_contents m_file
+      end)
     end
 
     def build_header_contents h_file
@@ -126,7 +167,7 @@ EOS
       h_file.writeln
       h_file.writeln '#import <Foundation/Foundation.h>'
       h_file.writeln
-      h_file.writeln 'extern const struct %s {' % resources_constant_name
+      h_file.writeln 'FOUNDATION_EXTERN const struct %s {' % resources_constant_name
       h_file.section do |struct|
         enumerate_sections do |section_key, enumerate_keys|
           struct.writeln 'struct %s {' % section_key
@@ -164,9 +205,33 @@ EOS
       m_file.writeln '};'
     end
 
+    def build_swift_contents swift_file
+      swift_file.writeln BANNER
+      swift_file.writeln 'public class %s {' % resources_constant_name
+      swift_file.section do |struct|
+        enumerate_sections do |section_key, enumerate_keys|
+          struct.writeln 'public enum %s: String {' % section_key
+          struct.section do |section_struct|
+            enumerate_keys.call do |key, value, comment|
+              if documented?
+                section_struct.writeln '/// %s' % (comment || value) #unless comment.nil?
+              end
+              section_struct.writeln 'case %s = "%s"' % [key, value]
+            end
+          end
+          struct.writeln '}'
+        end
+      end
+      swift_file.writeln '}'
+      swift_file.writeln
+      swift_file.writeln SWIFT_EXTENSIONS % resources_constant_name
+    end
+
     def enumerate_sections
       # Iterate sections ordered by key
       for section_key, section_content in @sections.sort
+        next if section_content.length == 0
+
         # Pass section key and block to yield the keys ordered
         proc = Proc.new do |&block|
           for key, value in section_content.sort

data/lib/xcres/command/build_command.rb

@@ -36,7 +36,11 @@ class XCRes::BuildCommand < XCRes::ProjectCommand
       end
     end
 
-    success 'Successfully updated: %s', "#{output_path}.h"
+    if swift?
+      success 'Successfully updated: %s', "#{output_path}.swift"
+    else
+      success 'Successfully updated: %s', "#{output_path}.h"
+    end
   end
 
   def derive_resources_constant_name
@@ -72,6 +76,7 @@ class XCRes::BuildCommand < XCRes::ProjectCommand
     builder.output_path = output_path
     builder.logger = logger
     builder.documented = documented?
+    builder.swift = swift?
     builder.resources_constant_name = resources_constant_name
 
     yield builder

data/lib/xcres/command/install_command.rb

@@ -100,28 +100,35 @@ class XCRes::InstallCommand < XCRes::ProjectCommand
 
     # Set shell script
     script_output_path = output_path.relative_path_from(src_root_path)
-    build_phase.shell_script = "xcres --no-ansi build $PROJECT_FILE_PATH $SRCROOT/#{script_output_path}\n"
+    documented_argument = documented? ? "--documented" : "--no-documented"
+    swift_argument = swift? ? "--swift" : "--no-swift"
+    build_phase.shell_script = "xcres --no-ansi build #{documented_argument} #{swift_argument} $PROJECT_FILE_PATH $SRCROOT/#{script_output_path}\n"
     build_phase.show_env_vars_in_log = '0'
 
     # Find or create 'Resources' group in 'Supporting Files'
     res_group = parent_group.groups.find { |g| g.name == 'Resources' }
     res_group ||= parent_group.new_group('Resources', Pathname('Resources'))
 
-    # Find or create references to resources index files
-    h_file = res_group.find_file_by_path('R.h') || res_group.new_file('R.h')
-    m_file = res_group.find_file_by_path('R.m') || res_group.new_file('R.m')
-
-    # Add .m file to source build phase, if it doesn't not already exist there
-    target.source_build_phase.add_file_reference(m_file, true)
-
-    # Add .h file to prefix header
-    prefix_headers.each do |path|
-      realpath = src_root_path + path
-      next unless File.exist?(realpath)
-      File.open(realpath, 'a+') do |f|
-        import_snippet = "#import \"#{h_file.path}\"\n"
-        unless f.readlines.include?(import_snippet)
-          f.write "\n#{import_snippet}"
+    if swift?
+      # Find or create references to resources index files
+      swift_file = res_group.find_file_by_path('R.swift') || res_group.new_file('R.swift')
+      # Add .swift file to source build phase, if it doesn't not already exist there
+      target.source_build_phase.add_file_reference(swift_file, true)
+    else
+      # Find or create references to resources index files
+      h_file = res_group.find_file_by_path('R.h') || res_group.new_file('R.h')
+      m_file = res_group.find_file_by_path('R.m') || res_group.new_file('R.m')
+      # Add .m file to source build phase, if it doesn't not already exist there
+      target.source_build_phase.add_file_reference(m_file, true)
+      # Add .h file to prefix header
+      prefix_headers.each do |path|
+        realpath = src_root_path + path
+        next unless File.exist?(realpath)
+        File.open(realpath, 'a+') do |f|
+          import_snippet = "#import \"#{h_file.path}\"\n"
+          unless f.readlines.include?(import_snippet)
+            f.write "\n#{import_snippet}"
+          end
         end
       end
     end

data/lib/xcres/command/project_command.rb

@@ -9,6 +9,7 @@ class XCRes::ProjectCommand < XCRes::Command
   option ['--[no-]documented'], :flag, 'Add documentation to the generated files', default: true
   #option ['-d', '--dry-run'], :flag, 'Does nothing on the file system'
 
+  option ['--[no-]swift'], :flag, 'Generate file as Swift code', default: false
   option ['-t', '--target'], 'TARGET', 'Target to search & analyze', attribute_name: :target_name
   option ['-x', '--exclude'], 'FILE_PATTERN', 'File pattern which should be excluded (default: ["InfoPlist.strings"])', multivalued: true, attribute_name: :exclude_file_patterns, default: ['InfoPlist.strings']
   option ['-n', '--name'], 'NAME', 'Name of the resources constant (default: `basename OUTPUT_PATH`)', attribute_name: :resources_constant_name

data/lib/xcres/version.rb

@@ -4,6 +4,6 @@ module XCRes
   #
   #   XCRes’s version, following [semver](http://semver.org).
   #
-  VERSION = "0.4.4"
+  VERSION = "0.5.0"
 
 end

data/spec/fixtures/Example/Example/en.lproj/Localizable.strings

@@ -16,3 +16,4 @@
 
 // Strings from Storyboards
 "123-abc-3e7.text" = "Hello Storyboards";
+"123-ab-3e7.text" = "Hello Storyboards";

data/spec/integration.rb

@@ -56,6 +56,10 @@ describe_cli 'xcres' do
     describe 'with resource which has a protected name' do
       behaves_like cli_spec('build-keyword-clash', '', 'build Example .')
     end
+
+    describe 'with swift' do
+      behaves_like cli_spec('build-swift', '', 'build --swift Example .')
+    end
   end
 
   describe 'Install' do
@@ -74,6 +78,10 @@ describe_cli 'xcres' do
     describe 'with moved supporting files' do
       behaves_like cli_spec('install-moved-supporting-files', '', 'install Example')
     end
+
+    describe 'with Swift' do
+      behaves_like cli_spec('install-swift', '', 'install --swift Example')
+    end
   end
 
   describe 'Get help' do

data/spec/integration/build-keyword-clash/after/R.h

@@ -7,7 +7,5 @@
 
 #import <Foundation/Foundation.h>
 
-extern const struct R {
-    struct Strings {
-    } Strings;
+FOUNDATION_EXTERN const struct R {
 } R;