objc-referee 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36c9f2903bc7f510e0a34800fce52cf0a878f39d
-  data.tar.gz: ced79e3acb02c3044e7b8dd26c6e19a7dfc10088
+  metadata.gz: f60008ff9e0157920cdbf6c4404e6414e56893a8
+  data.tar.gz: cde3171f49c6a231cb1df75c098fe3672151c016
 SHA512:
-  metadata.gz: 20f102e50fcc1886f61ba630cb8676ded8b29587fa223176fb84d267cbeeaf45332fb9c85e12be6870416c886e8ad7769f07981df54d693fd283cdafd30ee850
-  data.tar.gz: b9f6a89b2a98626348b7b8cbc8dd7fa91b8bf610c25c24f7f9e0c3f51e682b9932175d163a082eff47fb9612414ba35bfe6c01f4470d5a9bff3934ed576df1fe
+  metadata.gz: 52d9458d5bc961f6d7aebcdb5dd5e90f81b1fd93cd45b64a8cb6f4f31240df2b92cbcdd7cbde8db1792bd77e026323df646aa0c2ed2c394103b1890070b3d30b
+  data.tar.gz: 5361f120a1d0acd261a9011b856696f66b963490febcffcf86b4e30f8b4a77d146a763b05d505640fc9e4187d3bc60c8ea427b2928f93ccb88f8918877e8c37c

data/.rubocop.yml

@@ -7,7 +7,7 @@ AllCops:
 
 # Give us... a little more room.
 Metrics/LineLength:
-  Max: 120
+  Max: 140
 
 # This cop seems to produce a few false-positives.
 Style/Next:

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-08-20 17:16:11 -0400 using RuboCop version 0.33.0.
+# on 2015-11-04 13:39:32 -0500 using RuboCop version 0.33.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -8,9 +8,27 @@
 
 # Offense count: 3
 Metrics/AbcSize:
-  Max: 23
+  Max: 33
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 2
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 138
 
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 32
+  Max: 40
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 6
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 11

data/CHANGELOG.md

@@ -2,7 +2,21 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/) and this file attempts to follow the guidelines provided by [Keep a CHANGELOG](http://keepachangelog.com/).
 
+## [Unreleased][unreleased]
+Coming soon.
+
+## [0.2.0] - 2015-09-02
+### Added
+- Ensures Gemspec has a minimum Ruby version. Choosing 2.x, as this is default on Yosemite machines.
+- Adds in Swift code generation via `--language swift`. To keep compatibility with older versions, the default is still `objc`. Swift code generation will output a file `Resources.swift`.
+- An autogeneration warning has been added to the output files. Notes that changes to the given files will eventually be lost.
+- Ability to specify the `NSBundle` the resources should be accessed from. Handy for developing frameworks with resources.
+  - By default (if no bundle is specified) the main bundle will be used.
+  - The `--bundle-id` flag can set a custom bundle ID.
+
 ## [0.1.1] - 2015-09-02
 Initial public release.
 
-[0.1.1]: https://github.com/dynamit/referee/v0.1.1
+[unreleased]: https://github.com/dynamit/referee/compare/0.2.0...HEAD
+[0.2.0]: https://github.com/dynamit/referee/compare/0.2.0...HEAD
+[0.1.1]: https://github.com/Dynamit/referee/tree/0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    objc-referee (0.1.0)
+    objc-referee (0.1.1)
       mustache (~> 1.0, >= 1.0.2)
       nokogiri (~> 1.6, >= 1.6.6.2)
       xcodeproj (~> 0.20.1)

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/Dynamit/referee.svg?branch=master)](https://travis-ci.org/Dynamit/referee) [![Gem Version](https://badge.fury.io/rb/objc-referee.svg)](http://badge.fury.io/rb/objc-referee)
 
-Referee is a script that generates Objective-C classes and macros for easily referencing your resources in code, providing IDE auto-complete and compile-time safety for your app.
+Referee is a script that generates Objective-C or Swift objects for easily referencing your resources in code, providing IDE auto-complete and compile-time safety for your app.
 
 The currently supported resource types are:
 
@@ -31,6 +31,13 @@ UIViewController *someViewController = TSTResources.viewControllers.SomeViewCont
 [someViewController performSegue:TSTResources.segues.SomeSegue];
 ```
 
+Using Swift, this code will look like:
+
+```swift
+let someViewController = Resources.ViewControllers.SomeViewController()
+someViewController.performSegue(Resources.Segues.SomeSegue)
+```
+
 Now, if you change an identifier in your storyboard, your code won't compile unless it matches as well, providing you with the confidence that your code and UI are in sync.
 
 ## Installation
@@ -61,18 +68,24 @@ Finally, if you are using a `Gemfile` to manage Ruby dependencies for your app o
 ## Xcode Integration
 This script was designed to be easily integrated into your Xcode project workflow.
 
-Begin by adding a Run Script to your Build Phases. For the script portion, enter:
+Begin by adding a Run Script to your Build Phases. For the script portion, enter one of the following:
 
-    /usr/local/bin/referee --prefix <your class prefix>
+    /usr/local/bin/referee --prefix <your class prefix>   # for Objective-C
+    /usr/local/bin/referee --language swift               # for Swift
 
 _**Ensure that this Run Script runs before the Compile Sources step. Otherwise, your new changes won't get compiled!**_
 
-Build the project and open your source folder. By default, at the root of that folder there should be two new files: `<Prefix>Resources.h` and `<Prefix>Resources.m`. Add these files to the Xcode project, ensuring "Copy Files" is _not_ selected.
+Build the project and open your source folder. When using Objective-C, there should be two new files at the root of that folder: `<Prefix>Resources.h` and `<Prefix>Resources.m`. Add these files to the Xcode project, ensuring "Copy Files" is _not_ selected. When using Swift, a single file called `Resources.swift` will be generated. Follow the same steps to add the files to Xcode.
 
 From now on, when you make changes in your Storyboard files, they will be reflected in these source files upon compiling.
 
 If you need to setup different paths or configure `referee` further, check the `--help` flag for more information and documentation.
 
+## Custom Frameworks
+It is possible to generate resource accessors for a custom `.framework` with embedded resources simply by switching the generated code's accessed Bundle.
+
+By default, all resources will be accessed from the Main Bundle, however, the `--bundle-id com.example.bundle-id` flag allows setting a custom Bundle Identifier. This allows you to access resources inside of a custom, third-party framework.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/referee/cli.rb

@@ -24,6 +24,8 @@ module Referee
                   prefix: nil,
                   output: default_output_directory,
                   error_on_missing_storyboard_ids: false,
+                  language: 'objc',
+                  bundle_id: nil,
                   verbose: false }
 
       optparse = OptionParser.new do |opts|
@@ -43,6 +45,14 @@ module Referee
           options[:error_on_missing_storyboard_ids] = true
         end
 
+        opts.on('-l', '--language LANGUAGE', 'Toggle language between objc and swift') do |language|
+          options[:language] = language.downcase
+        end
+
+        opts.on('-b', '--bundle-id IDENTIFIER', 'Set the bundle identifier in the generated code (Main bundle by default)') do |bundle_id|
+          options[:bundle_id] = bundle_id
+        end
+
         opts.on('-v', '--verbose', 'Enable verbose mode') do
           options[:verbose] = true
         end
@@ -63,12 +73,23 @@ module Referee
       Configuration.new(options)
     end
 
+    def validate_bundle_id(bundle_id)
+      # Note: `nil` bundle ID will indicate main bundle default.
+      # We'll accept nil or a "<something>.<something>..." format.
+      bundle_regex = /[-a-zA-Z0-9]+(\.[-a-zA-Z0-9])+/
+      (!bundle_id || bundle_id.match(bundle_regex))
+    end
+
     def validate_config
+      is_swift = (@config.language == 'swift')
       output_valid = File.exist?(@config.output) && File.writable?(@config.output)
-      build_output.die 'Class prefix must be provided' unless @config.prefix
+      build_output.die 'Class prefix must be provided' unless is_swift || @config.prefix
+      build_output.info 'Class prefix will ignored...' if is_swift && @config.prefix
       build_output.die 'Output directory must exist and be writable' unless output_valid
       build_output.die 'An Xcode project is required!' unless @config.project
       build_output.die 'Xcode project must exist!' unless File.exist?(@config.project)
+      build_output.die 'Invalid language specified!' unless %w(swift objc).index(@config.language)
+      build_output.die 'Invalid bundle identifier' unless validate_bundle_id(@config.bundle_id)
       build_output.info 'Loaded and validated configuration...'
     end
 

data/lib/referee/codegenerator.rb

@@ -9,6 +9,16 @@ module Referee
     public
 
     def generate!
+      if @config.language == 'objc'
+        generate_objc!
+      else
+        generate_swift!
+      end
+    end
+
+    private
+
+    def generate_objc!
       # Substitute out template information.
       iface = renderer.render_interface(dictionary_representation)
       impl = renderer.render_implementation(dictionary_representation)
@@ -22,7 +32,16 @@ module Referee
       File.write(implementation_path, impl)
     end
 
-    private
+    def generate_swift!
+      # Substitute out template information.
+      swift_impl = renderer.render_swift_implementation(dictionary_representation)
+
+      # Generate path.
+      file_path = resource_file('swift')
+
+      # Write to file.
+      File.write(file_path, swift_impl)
+    end
 
     def dictionary_representation
       @dictionary_representation ||= create_dictionary_representation
@@ -49,8 +68,13 @@ module Referee
     end
 
     def resource_file(extension)
-      filename = "#{@config.prefix}Resources.#{extension}"
-      File.join(@config.output, filename)
+      if @config.language == 'objc'
+        filename = "#{@config.prefix}Resources.#{extension}"
+        File.join(@config.output, filename)
+      else
+        filename = "Resources.#{extension}"
+        File.join(@config.output, filename)
+      end
     end
 
     def renderer

data/lib/referee/configuration.rb

@@ -1,7 +1,8 @@
 module Referee
   # Configuration container.
   class Configuration
-    attr_accessor :project, :prefix, :output, :error_on_missing_storyboard_ids, :verbose
+    attr_accessor :project, :prefix, :output, :error_on_missing_storyboard_ids, :verbose, :language,
+                  :bundle_id
 
     def initialize(config)
       config.each do |key, value|

data/lib/referee/project.rb

@@ -37,7 +37,7 @@ module Referee
         segues = segues(xml)
 
         # Add to resources collection
-        group = ResourceGroup.new(storyboard, table_cells, collection_cells, non_empty_view_controllers, segues)
+        group = ResourceGroup.new(storyboard, table_cells, collection_cells, non_empty_view_controllers, segues, @config)
         @resources << group
 
         # Check for missing view controller IDs in this storyboard.

data/lib/referee/renderable.rb

@@ -1,7 +1,7 @@
 module Referee
   # Abstract class defining how renderable resources must behave.
   class Renderable
-    attr_accessor :type
+    attr_accessor :type, :swift_type
 
     def initialize
       fail 'Abstract class Renderable may not be instantiated!'
@@ -17,6 +17,27 @@ module Referee
       fail 'Subclasses must implement implementation()!'
     end
 
+    # NOTE: Subclasses must implement this method.
+    def swift_implementation
+      fail 'Subclasses must implement swift_implementation()!'
+    end
+
+    def bundle_accessor(bundle_id)
+      if bundle_id
+        "[NSBundle bundleWithIdentifier:\"#{bundle_id}\"]"
+      else
+        '[NSBundle mainBundle]'
+      end
+    end
+
+    def swift_bundle_accessor(bundle_id)
+      if bundle_id
+        "NSBundle(identifier: \"#{bundle_id}\")"
+      else
+        'NSBundle.mainBundle()'
+      end
+    end
+
     def methodize_name(name)
       name.gsub(/[^a-zA-Z0-9]/, '')
     end
@@ -30,5 +51,15 @@ module Referee
       clean_name = methodize_name(name)
       "- (#{@type})#{clean_name}\n{\n\treturn #{body};\n}"
     end
+
+    def simple_swift_method(name, body)
+      clean_name = methodize_name(name)
+      "func #{clean_name}() -> #{@swift_type} {\n\t\t\treturn #{body}\n\t\t}"
+    end
+
+    def simple_swift_string_case(name)
+      clean_name = methodize_name(name)
+      "case #{clean_name} = \"#{name}\""
+    end
   end
 end

data/lib/referee/renderables/collectioncell.rb

@@ -4,6 +4,7 @@ module Referee
     def initialize(identifier)
       @identifier = identifier
       @type = 'NSString *'
+      @swift_type = 'String'
     end
 
     def declaration
@@ -13,5 +14,9 @@ module Referee
     def implementation
       simple_method_implementation @identifier, "@\"#{@identifier}\""
     end
+
+    def swift_implementation
+      simple_swift_string_case @identifier
+    end
   end
 end

data/lib/referee/renderables/segue.rb

@@ -4,6 +4,7 @@ module Referee
     def initialize(identifier)
       @identifier = identifier
       @type = 'NSString *'
+      @swift_type = 'String'
     end
 
     def declaration
@@ -13,5 +14,9 @@ module Referee
     def implementation
       simple_method_implementation @identifier, "@\"#{@identifier}\""
     end
+
+    def swift_implementation
+      simple_swift_string_case @identifier
+    end
   end
 end

data/lib/referee/renderables/storyboard.rb

@@ -1,9 +1,13 @@
 module Referee
   # Renderable implementation for UIStoryboards in a project.
   class Storyboard < Renderable
-    def initialize(name)
+    attr_accessor :name, :config
+
+    def initialize(name, config)
       @name = name
       @type = 'UIStoryboard *'
+      @swift_type = 'UIStoryboard'
+      @config = config
     end
 
     def declaration
@@ -11,8 +15,15 @@ module Referee
     end
 
     def implementation
-      body = "[UIStoryboard storyboardWithName:@\"#{@name}\" bundle:[NSBundle mainBundle]]"
+      bundle = bundle_accessor(@config.bundle_id)
+      body = "[UIStoryboard storyboardWithName:@\"#{@name}\" bundle:#{bundle}]"
       simple_method_implementation @name, body
     end
+
+    def swift_implementation
+      bundle = swift_bundle_accessor(@config.bundle_id)
+      body = "UIStoryboard(name: \"#{@name}\", bundle: #{bundle})"
+      simple_swift_method @name, body
+    end
   end
 end

data/lib/referee/renderables/tablecell.rb

@@ -4,6 +4,7 @@ module Referee
     def initialize(identifier)
       @identifier = identifier
       @type = 'NSString *'
+      @swift_type = 'String'
     end
 
     def declaration
@@ -13,5 +14,9 @@ module Referee
     def implementation
       simple_method_implementation @identifier, "@\"#{@identifier}\""
     end
+
+    def swift_implementation
+      simple_swift_string_case @identifier
+    end
   end
 end

data/lib/referee/renderables/viewcontroller.rb

@@ -1,12 +1,14 @@
 module Referee
   # Renderable implementation for UIViewControllers embedded in storyboards.
   class ViewController < Renderable
-    attr_accessor :name, :storyboard
+    attr_accessor :name, :storyboard, :config
 
-    def initialize(name, storyboard)
+    def initialize(name, storyboard, config)
       @name = name
       @storyboard = storyboard
       @type = 'UIViewController *'
+      @swift_type = 'UIViewController'
+      @config = config
     end
 
     def declaration
@@ -14,9 +16,17 @@ module Referee
     end
 
     def implementation
-      body = "[[UIStoryboard storyboardWithName:@\"#{@storyboard}\" bundle:[NSBundle mainBundle]] " \
+      bundle = bundle_accessor(@config.bundle_id)
+      body = "[[UIStoryboard storyboardWithName:@\"#{@storyboard}\" bundle:#{bundle}] " \
              "instantiateViewControllerWithIdentifier:@\"#{@name}\"]"
       simple_method_implementation @name, body
     end
+
+    def swift_implementation
+      bundle = swift_bundle_accessor(@config.bundle_id)
+      body = "UIStoryboard(name: \"#{@name}\", bundle: #{bundle})." \
+             "instantiateViewControllerWithIdentifier(\"#{@name}\")"
+      simple_swift_method @name, body
+    end
   end
 end

data/lib/referee/resourcegroup.rb

@@ -1,14 +1,15 @@
 module Referee
   # Representation of all of the resources contained in a given storyboard.
   class ResourceGroup
-    attr_accessor :storyboard, :table_cells, :collection_cells, :view_controllers, :segues
+    attr_accessor :storyboard, :table_cells, :collection_cells, :view_controllers, :segues, :config
 
-    def initialize(storyboard, table_cells, collection_cells, view_controllers, segues)
+    def initialize(storyboard, table_cells, collection_cells, view_controllers, segues, config)
       @storyboard = storyboard
       @table_cells = table_cells
       @collection_cells = collection_cells
       @view_controllers = view_controllers
       @segues = segues
+      @config = config
     end
 
     def storyboard_name
@@ -17,7 +18,7 @@ module Referee
     end
 
     def storyboard
-      Storyboard.new(storyboard_name)
+      Storyboard.new(storyboard_name, @config)
     end
 
     def table_cells
@@ -29,7 +30,7 @@ module Referee
     end
 
     def view_controllers
-      @view_controllers.map { |c| ViewController.new(c, storyboard_name) }
+      @view_controllers.map { |c| ViewController.new(c, storyboard_name, @config) }
     end
 
     def segues

data/lib/referee/templaterenderer.rb

@@ -3,6 +3,7 @@ module Referee
   class TemplateRenderer
     INTERFACE_TEMPLATE_NAME = 'interface.h'
     IMPLEMENTATION_TEMPLATE_NAME = 'implementation.m'
+    SWIFT_TEMPLATE_NAME = 'default.swift'
 
     private
 
@@ -28,5 +29,10 @@ module Referee
     def render_interface(dict)
       template(INTERFACE_TEMPLATE_NAME).call(dict)
     end
+
+    # Renders the Swift implementation file as a string.
+    def render_swift_implementation(dict)
+      template(SWIFT_TEMPLATE_NAME).call(dict)
+    end
   end
 end

data/lib/referee/version.rb

@@ -1,4 +1,4 @@
 # Version information.
 module Referee
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/objc-referee.gemspec

@@ -20,6 +20,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '~> 2.0'
+
   spec.add_development_dependency 'bundler', '~> 1.8'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rubocop', '~> 0.33.0'

data/resources/default.swift

@@ -0,0 +1,43 @@
+/** THIS FILE IS AUTOGENERATED. DO NOT EDIT. CHANGES WILL BE DESTROYED. */
+
+import Foundation
+import UIKit
+
+struct Resources {
+    static let Storyboards = _Storyboards()
+    static let ViewControllers = _ViewControllers()
+
+    /// UIStoryboard accessors.
+    struct _Storyboards {
+        {{# storyboards #}}
+        {{{ swift_implementation }}}
+        {{/ storyboards }}
+    }
+
+    {{# table_cells #}}
+    /// UITableViewCell identifier accessors.
+    enum TableViewCells: String {
+        {{{ swift_implementation }}}
+    }
+    {{/ table_cells }}
+
+    {{# collection_cells #}}
+    enum CollectionViewCells: String {
+        {{{ swift_implementation }}}
+    }
+    {{/ collection_cells }}
+
+    /// UIViewController accessors.
+    struct _ViewControllers {
+        {{# view_controllers #}}
+        {{{ swift_implementation }}}
+        {{/ view_controllers }}
+    }
+
+    {{# segues #}}
+    /// Segue accessors.
+    enum Segues: String {
+        {{{ swift_implementation }}}
+    }
+    {{/ segues }}
+}

data/resources/implementation.m

@@ -1,3 +1,5 @@
+/** THIS FILE IS AUTOGENERATED. DO NOT EDIT. CHANGES WILL BE DESTROYED. */
+
 #import "{{ prefix }}Resources.h"
 
 /** UIStoryboard accessors. */

data/resources/interface.h

@@ -1,3 +1,5 @@
+/** THIS FILE IS AUTOGENERATED. DO NOT EDIT. CHANGES WILL BE DESTROYED. */
+
 @import UIKit;
 
 /** ATTENTION: Use this macro to access resources. */

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: objc-referee
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Colin Drake
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2015-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -172,6 +172,7 @@ files:
 - lib/referee/templaterenderer.rb
 - lib/referee/version.rb
 - objc-referee.gemspec
+- resources/default.swift
 - resources/implementation.m
 - resources/interface.h
 homepage: http://dynamit.com
@@ -184,9 +185,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="