stronglyboards 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 74195599601bd31170e951aaf41ecbf811a32694
+  data.tar.gz: 495710653267bd90a9d856e72ce367281d538cea
+SHA512:
+  metadata.gz: 287f024d27278f24ec0263189ef00e62fbb76eb6b4a29dc649ed9cae589c61cd7af71b4ad87667e2f902eb8304bedd3d2197aa92732017cf7ade87abcaa2019e
+  data.tar.gz: 1a39d4402e55a4915b83b92fed4ceaf6f8724dfba923a36abda590caed519a405f99ab26afbdee6b6542ec7e8858c30e89a091a5b578eb907d6977bd0995c4e2

data/.gitignore

@@ -0,0 +1,83 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Below covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Steve Wilford
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# Overview #
+
+Stronglyboards generates code that can be used to provide a strongly-typed interface to [iOS Storyboards](https://developer.apple.com/library/ios/recipes/xcode_help-IB_storyboard/chapters/AboutStoryboards.html).
+
+Reduce mistakes introduced when using string based storyboard and view controller identifiers.
+
+It is inspired by [Natalie](https://github.com/krzyzanowskim/Natalie) but is a [Ruby gem](https://rubygems.org) and generates a slightly different API,
+ and I believe [competition is a good thing](https://vimeo.com/124317403).
+
+# Features
+
+- Safe instantiation of:-
+  - storyboards,
+  - the storyboard's initial view controller,
+  - view controllers with storyboard identifiers
+- Outputs **Objective-C** or **Swift** depending on your preference.
+- Integrates seamlessly into your project.
+  - Creates a build phase to automatically keep the generated code up-to-date with storyboard changes.
+- Supports **localized** and non-localized Storyboards.
+
+# Todo #
+
+- Segues
+- Table and Collection View cells
+- More...
+
+# Installation & Basic Usage #
+
+Use the `gem` command to install Stronglyboards:
+
+```gem install stronglyboards```
+
+Run stronglyboards on your Xcode project file:
+
+```stronglyboards install MyProject.xcodeproj```
+
+By default it will generate Objective-C files in the current directory.
+
+Stronglyboards will automatically add the generated files into your project
+and setup a new "Run Script" build phase to keep up-to-date with any
+storyboard changes you might make.
+
+# Usage #
+
+`install <PROJECT>`
+
+This will install Stronglyboards into the specified Xcode project. Replace `<PROJECT>` with your `.xcodeproj` file.
+
+`update <PROJECT>`
+
+This will attempt to update Stronglyboards in a project where it is already installed. Replace `<PROJECT>` with your `.xcodeproj` file.
+Note that things will likely go wrong if you have manually renamed any of the generated files.
+
+`uninstall <PROJECT>`
+
+This will attempt to remove Stronglyboards from a project where it has been previously installed. Replace `<PROJECT>` with your `.xcodeproj` file.
+Note that things will likely go wrong if you have manually renamed any of the generated files.
+
+# Installation Options #
+
+`--output` specifies the name of the output file(s).
+You can use this parameter to output to a different directory.
+e.g. `Classes/GeneratedStoryboardAPI`.
+You should **not** provide a file extension as part of this file name.
+This is an optional parameter, default is `Stronglyboards`.
+Note that this path is essentially a template, the actual generated filenames
+will be different.
+
+`--language` specifies the output language as either `objc` or `swift`.
+This is an optional parameter, default is `objc`.
+
+`--prefix` specifies a string to be used as the prefix for all generated classes.
+This is an optional parameter, default is no prefix.
+Note that the prefix does not affect the output file name.
+
+# Contributing #
+
+Submit an issue, or ideally a pull request.
+
+# Authors & Contributors #
+
+- [@nxsteveo](http://twitter.com/nxsteveo)
+- \<Your name here>
+
+# License #
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Steve Wilford
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/bin/stronglyboards

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'stronglyboards'

data/lib/stronglyboards.rb

@@ -0,0 +1,253 @@
+require 'xcodeproj'
+require 'optparse'
+require 'thor'
+require 'yaml'
+
+require_relative 'stronglyboards/version'
+require_relative 'stronglyboards/lock_file'
+require_relative 'stronglyboards/storyboard'
+require_relative 'stronglyboards/source_generator_objc'
+require_relative 'stronglyboards/source_generator_swift'
+
+module Stronglyboards
+
+  class Stronglyboards < Thor
+
+    BUILD_SCRIPT_NAME = 'Update Stronglyboards'
+
+    # ---- Begin external interface ----
+
+    desc 'install PROJECT', 'Installs Stronglyboards into your .xcodeproj file'
+    option :output, :desc => 'Path to the output file'
+    option :language, :default => 'objc', :desc => 'Output language (objc [default], swift)'
+    option :prefix, :default => '', :desc => 'Class and category method prefix'
+    def install(project_file)
+      lock_file = LockFile.new(project_file)
+      if lock_file.exists?
+        puts 'It appears that Stronglyboards has already been installed on this project.'
+        exit
+      end
+
+      puts "Installing Stronglyboards into #{project_file}"
+
+      # Open the existing Xcode project
+      project = Xcodeproj::Project.open(project_file)
+
+      # Do main processing
+      process(project, options)
+
+      # Finalise installation
+      lock_file.update(options)
+      project.save
+    end
+
+    desc 'update', 'Updates the generated source code for the project'
+    def update(project_file)
+      configuration = require_lock_file(project_file).contents
+
+      puts "Updating Stronglyboards in #{project_file}"
+
+      # Open the Xcode project
+      project = Xcodeproj::Project.open(project_file)
+
+      process(project, configuration)
+    end
+
+    desc 'uninstall PROJECT', 'Uninstalls Stronglyboards from the specified .xcodeproj file.'
+    def uninstall(project_file)
+      lock_file = require_lock_file(project_file)
+      configuration = lock_file.contents
+
+      base_output_file = configuration[:output]
+      language = configuration[:language]
+      prefix = configuration[:prefix]
+
+      puts "Uninstalling Stronglyboards from #{project_file}"
+
+      files_to_delete = Array.new
+
+      # Open the Xcode project
+      project = Xcodeproj::Project.open(project_file)
+      project_root = project.path.dirname
+
+      # Gather the targets that we're interested in
+      targets = interesting_targets(project)
+
+      targets.each do |target|
+        # Find and delete the build script phase for this target
+        target.build_phases.select { |phase|
+          phase.is_a? Xcodeproj::Project::PBXShellScriptBuildPhase and phase.name == BUILD_SCRIPT_NAME
+        }.each { |phase|
+          target.build_phases.delete(phase)
+        }
+
+        # Get a source generator for this target
+        output_file = base_output_file_for_target(base_output_file, target, prefix)
+        source_generator = source_generator(language, prefix, output_file)
+
+        # Gather the files that would have been generated for this target.
+        # Bare in mind that this target may have been created since the
+        # last time the install or update command ran, so there may be
+        # files in this list that don't actually exist.
+        files_to_delete << source_generator.output_files
+      end
+
+      # Expand the paths of the files to be deleted to be absolute
+      files_to_delete.flatten!.uniq!
+      paths_to_delete = files_to_delete.collect do |file|
+        project_root + file.file.path
+      end
+
+      # Look through each target to see if this file is a member,
+      # removing it from the source build phase if necessary.
+      # TODO: There's got to be a better way, question asked.
+      # http://stackoverflow.com/questions/32908231/how-to-get-the-targets-for-a-pbxfilereference-in-xcodeproj
+      targets.each do |target|
+        target.source_build_phase.files.each do |build_file|
+          full_path = build_file.file_ref.real_path
+          if paths_to_delete.include?(full_path)
+
+            # Need to get a reference to the underlying file reference
+            # as it will be removed when the build file is removed
+            # from the target's build phase.
+            file = build_file.file_ref
+
+            # Remove the file from the build phase, project, and file system
+            target.source_build_phase.remove_build_file(build_file)
+            file.remove_from_project
+            File.delete(full_path)
+          end
+        end
+      end
+
+      # Iterate through the files to delete to get rid of any non-source files
+      files_to_delete.each do |file|
+        unless file.is_source
+          full_path = File.realpath(file.file)
+          file_ref = project.reference_for_path(full_path)
+          file_ref.remove_from_project
+          File.delete(full_path)
+        end
+      end
+
+      project.save
+
+      # Finally delete the lock file
+      lock_file.delete
+    end
+
+    # ---- End external interface ----
+
+    private
+    def process(project, options)
+      base_output_file = options[:output]
+      language = options[:language]
+      prefix = options[:prefix]
+
+      interesting_targets(project).each do |target|
+
+        # Provide a default output filename
+        output_file = base_output_file_for_target(base_output_file, target, prefix)
+
+        # Instantiate a source generator appropriate for the selected language
+        source_generator = source_generator(language, prefix, output_file)
+
+        # Iterate the target's resource files looking for storyboards
+        target.resources_build_phase.files.each do |build_file|
+          next unless build_file.display_name.end_with? Storyboard::EXTENSION
+
+          file_or_group = build_file.file_ref
+
+          if file_or_group.is_a? Xcodeproj::Project::Object::PBXFileReference
+            # Getting the real path is sufficient for non-localized storyboards
+            # as it will return the absolute path to the .storyboard
+            path = file_or_group.real_path
+          elsif file_or_group.is_a? Xcodeproj::Project::Object::PBXVariantGroup
+            # Localized storyboards will be a group and will
+            # need the path constructing from the Base storyboard.
+            base_storyboard_file = file_or_group.children.find { |f| f.name == 'Base' }
+            if base_storyboard_file == nil
+              puts "No Base storyboard found for #{file_or_group}!!!"
+              next
+            end
+            path = base_storyboard_file.real_path
+          end
+
+          storyboard = Storyboard.new(path)
+
+          source_generator.add_storyboard(storyboard)
+        end # end project file iterator
+
+        output_files = source_generator.parse_storyboards
+
+        # Add the output files to the target
+        add_files_to_target(project, target, output_files)
+        add_build_script(project, target)
+      end
+    end
+
+    private
+    def interesting_targets(project)
+      project.native_targets.select { |target| target.product_type == 'com.apple.product-type.application' }
+    end
+
+    private
+    def base_output_file_for_target(base_file, target, prefix)
+      if base_file == nil
+        base_file = prefix + 'Stronglyboards'
+      end
+      base_file + "_#{target.name}"
+    end
+
+    private
+    def add_files_to_target(project, target, output_files)
+      puts "Adding files to target \"#{target}\""
+
+      output_files.each do |output_file|
+        # Insert the file into the root group in the project
+        file_reference = project.new_file(output_file.file)
+
+        # Add the file to the target to ensure it is compiled
+        target.source_build_phase.add_file_reference(file_reference) if output_file.is_source
+      end
+
+    end
+
+    private
+    def add_build_script(project, target)
+      puts 'Adding build script'
+
+      phase = project.new(Xcodeproj::Project::Object::PBXShellScriptBuildPhase)
+      phase.name = BUILD_SCRIPT_NAME
+      phase.shell_script = 'stronglyboards update ${PROJECT_NAME}'
+      target.build_phases.insert(0, phase)
+    end
+
+    private
+    def source_generator(language, prefix, output_file)
+      case language
+         when 'objc'
+           SourceGeneratorObjC.new(prefix, output_file)
+         when 'swift'
+           SourceGeneratorSwift.new(prefix, output_file)
+         else
+           puts 'Language must be objc or swift.'
+           exit
+       end
+    end
+
+    private
+    def require_lock_file(project_file)
+      lock_file = LockFile.new(project_file)
+      unless lock_file.exists?
+        puts 'Stronglyboards must first be installed using the install command.'
+        exit
+      end
+      lock_file
+    end
+
+  end
+
+  Stronglyboards.start(ARGV)
+
+end

data/lib/stronglyboards/lock_file.rb

@@ -0,0 +1,34 @@
+module Stronglyboards
+  class LockFile
+
+    def initialize(project_file)
+      @path = File.dirname(project_file) + '/' + LOCK_FILE_NAME
+    end
+
+    def contents
+      # Load the lock file containing configuration
+      file = File.open(@path, 'r')
+      YAML::load(file)
+    end
+
+    def update(options)
+      puts "Writing lock file at #{@path}"
+      File.open(@path, 'w+') do |file|
+        file.write(YAML::dump(options))
+      end
+    end
+
+    def delete
+      File.delete(@path)
+    end
+
+    def exists?
+      File.exists?(@path)
+    end
+
+    private
+
+      LOCK_FILE_NAME = 'Stronglyboards.lock'
+
+  end
+end

data/lib/stronglyboards/source_generator.rb

@@ -0,0 +1,43 @@
+module Stronglyboards
+
+  class OutputFile < Struct.new(:file, :is_source)
+  end
+
+  class AbstractSourceGenerator
+
+    protected
+    attr_accessor :prefix
+
+    public
+    def initialize(prefix, output_file_name)
+      @prefix = prefix
+      @storyboards = Array.new
+
+      @implementation_file = File.open(output_file_name, 'w+')
+    end
+
+    # Gathers a set of view controller classes from all storyboards
+    protected
+    def view_controller_classes
+      @storyboards.collect { |storyboard|
+        storyboard.view_controllers.collect { |vc| vc.class_name }
+      }.flatten.uniq
+    end
+
+    public
+    def add_storyboard(storyboard)
+      @storyboards.push(storyboard)
+    end
+
+    public
+    def parse_storyboards
+      raise 'This method should be overridden.'
+    end
+
+    public
+    def output_files
+      [OutputFile.new(@implementation_file, true)]
+    end
+
+  end
+end

data/lib/stronglyboards/source_generator_objc.rb

@@ -0,0 +1,175 @@
+require_relative 'source_generator'
+
+module Stronglyboards
+  class SourceGeneratorObjC < AbstractSourceGenerator
+
+    def initialize(prefix, output_file_name)
+      @implementation_file_path = output_file_name + '.m'
+
+      super(prefix, @implementation_file_path)
+
+      @header_file_path = output_file_name + '.h'
+      @header_file = File.open(@header_file_path, 'w+')
+    end
+
+    # Parses the storyboards
+    public
+    def parse_storyboards
+
+      puts "Header:         #{@header_file_path}"
+      puts "Implementation: #{@implementation_file_path}"
+
+      # Generate framework and header imports
+      @header_file.write("@import UIKit;\n\n")
+      @implementation_file.write("#import \"#{File.basename(@header_file_path)}\"\n\n")
+
+      @header_file.write("NS_ASSUME_NONNULL_BEGIN\n\n")
+
+      # Generate the base storyboard class
+      base_class_name = create_base_storyboard_class
+
+      # Generate forward declaration of view controller classes
+      view_controller_classes.each do |class_name|
+        @header_file.write("@class #{class_name};\n")
+      end
+      @header_file.write("\n")
+
+      # Generate classes for each storyboard
+      @storyboards.each { |s| create_storyboard_class(s, base_class_name) }
+
+      # Generate the storyboard category
+      create_storyboard_category
+
+      @header_file.write("\n\nNS_ASSUME_NONNULL_END")
+
+      output_files
+    end
+
+    private
+    def create_base_storyboard_class
+      class_name = "#{@prefix}Stronglyboard"
+
+      # Create the public interface
+      interface = Array.new
+      interface.push("@interface #{class_name} : NSObject")
+      interface.push('@property (nonatomic, strong, readonly) UIStoryboard *storyboard;')
+      interface.push('@end')
+
+      # Create the private interface to expose the storyboard as a read-write property
+      implementation = Array.new
+      implementation.push("@interface #{class_name} ()")
+      implementation.push('@property (nonatomic, strong) UIStoryboard *storyboard;')
+      implementation.push('@end')
+
+      # Create the implementation of the base storyboard class
+      implementation.push("@implementation #{class_name}")
+      implementation.push('- (instancetype)initWithName:(NSString *)name bundle:(NSBundle *)bundleOrNil {')
+      implementation.push("\tself = [super init];")
+      implementation.push("\tif (self) {")
+      implementation.push("\t\t_storyboard = [UIStoryboard storyboardWithName:name bundle:bundleOrNil];")
+      implementation.push("\t}")
+      implementation.push("\treturn self;")
+      implementation.push('}')
+      implementation.push('@end')
+
+      # Convert to string
+      interface = interface.join("\n")
+      implementation = implementation.join("\n")
+
+      @header_file.write(interface + "\n\n")
+      @implementation_file.write(implementation + "\n\n")
+
+      class_name
+    end
+
+    # Generate the class for the provided storyboard
+    private
+    def create_storyboard_class(storyboard, base_class_name)
+      class_name = storyboard.class_name(@prefix)
+      puts "Processing storyboard class #{class_name}."
+
+      interface = Array.new(1, "@interface #{class_name} : #{base_class_name}")
+      implementation = Array.new(1, "@implementation #{class_name}")
+
+      storyboard.view_controllers.each do |vc|
+        if vc.initial_view_controller?
+          method_signature = "- (#{vc.class_name} *)instantiateInitialViewController;"
+          method_body = create_initial_view_controller_instantiation(vc)
+        else
+          method_signature = "- (#{vc.class_name} *)instantiate#{vc.storyboard_identifier}ViewController;"
+          method_body = create_view_controller_instantiation(vc)
+        end
+
+        interface.push(method_signature)
+        implementation.push(method_signature + ' {')
+        implementation.push("\t" + method_body)
+        implementation.push('}')
+      end # view controller iterator
+
+      interface.push('@end')
+      implementation.push('@end')
+
+      # Convert to string
+      interface = interface.join("\n")
+      implementation = implementation.join("\n")
+
+      # Output to files
+      @header_file.write(interface)
+      @header_file.write("\n\n")
+      @implementation_file.write(implementation)
+      @implementation_file.write("\n\n")
+    end
+
+    # Generate the category for UIStoryboard with methods
+    # for each storyboard that has been provided.
+    private
+    def create_storyboard_category
+      interface = Array.new(1, '@interface UIStoryboard (Stronglyboards)')
+      implementation = Array.new(1, '@implementation UIStoryboard (Stronglyboards)')
+
+      @storyboards.each do |storyboard|
+        method_signature = "+(#{storyboard.class_name(@prefix)} *)#{storyboard.lowercase_name(@prefix)}Storyboard;"
+        interface.push(method_signature)
+        implementation.push(method_signature + ' {')
+        implementation.push("\t" + create_storyboard_instantiation(storyboard))
+        implementation.push('}')
+      end
+      interface.push('@end')
+      implementation.push('@end')
+
+      # Convert to a string
+      interface = interface.join("\n")
+      implementation = implementation.join("\n")
+
+      # Output to file
+      puts 'Writing UIStoryboard category.'
+      @header_file.write(interface)
+      @implementation_file.write(implementation)
+
+    end
+
+    # ---- Helpers ----
+
+    public
+    def output_files
+      super.push OutputFile.new(@header_file, false)
+    end
+
+    private
+    def create_storyboard_instantiation(storyboard)
+      class_name = storyboard.class_name(@prefix)
+      "return [[#{class_name} alloc] initWithName:@\"#{storyboard.name}\" bundle:nil];"
+    end
+
+    private
+    def create_initial_view_controller_instantiation(view_controller)
+      "return (#{view_controller.class_name} *)[self.storyboard instantiateInitialViewController];"
+    end
+
+    private
+    def create_view_controller_instantiation(view_controller)
+      "return (#{view_controller.class_name} *)[self.storyboard instantiateViewControllerWithIdentifier:@\"#{view_controller.storyboard_identifier}\"];"
+    end
+
+  end
+end

data/lib/stronglyboards/source_generator_swift.rb

@@ -0,0 +1,107 @@
+require_relative 'source_generator'
+require_relative 'view_controller'
+
+module Stronglyboards
+  class SourceGeneratorSwift < AbstractSourceGenerator
+
+    public
+    def initialize(prefix, output_file_name)
+      @implementation_file_path = output_file_name + '.swift'
+
+      super(prefix, @implementation_file_path)
+    end
+
+    def parse_storyboards
+
+      puts "Source file: #{@implementation_file_path}"
+
+      # Generate framework imports
+      @implementation_file.write("import UIKit\n\n")
+
+      # Generate the base storyboard class
+      base_class_name = create_base_storyboard_class
+
+      # Generate classes for each storyboard
+      @storyboards.each { |s| create_storyboard_class(s, base_class_name) }
+
+      # Generate the storyboard category
+      create_storyboard_category
+
+      output_files
+    end
+
+    private
+    def create_base_storyboard_class
+      class_name = "#{@prefix}Stronglyboard"
+      output = Array.new(1, "class #{class_name} {")
+      output.push "\tlet storyboard: UIStoryboard"
+      output.push "\tinit(name: String, bundle: NSBundle?) {"
+      output.push "\t\tstoryboard = UIStoryboard(name: name, bundle: bundle)"
+      output.push "\t}"
+      output.push '}'
+
+      # Convert to string and write to file
+      output = output.join("\n")
+      @implementation_file.write(output + "\n\n")
+
+      class_name
+    end
+
+    # Generate the class for the provided storyboard
+    private
+    def create_storyboard_class(storyboard, base_class_name)
+      class_name = storyboard.class_name(@prefix)
+      puts "Processing storyboard class #{class_name}."
+
+      output = Array.new(1, "class #{class_name} : #{base_class_name} {")
+
+      storyboard.view_controllers.each do |vc|
+        cast = " as! #{vc.class_name}" unless vc.class_name == ViewController::UIVIEWCONTROLLER
+        if vc.initial_view_controller?
+          cast = '!' if vc.class_name == ViewController::UIVIEWCONTROLLER
+          output.push "\tfunc instantiateInitialViewController() -> #{vc.class_name} {"
+          output.push "\t\treturn self.storyboard.instantiateInitialViewController()#{cast}"
+        else
+          output.push "\tfunc instantiate#{vc.storyboard_identifier}ViewController() -> #{vc.class_name} {"
+          output.push "\t\treturn self.storyboard.instantiateViewControllerWithIdentifier(\"#{vc.storyboard_identifier}\") #{cast}"
+        end
+        output.push "\t}"
+      end # view controller iterator
+
+      # End the storyboard subclass
+      output.push '}'
+
+      # Convert to string
+      output = output.join("\n")
+
+      # Output to files
+      @implementation_file.write(output)
+      @implementation_file.write("\n\n")
+    end
+
+    # Generate the category for UIStoryboard with methods
+    # for each storyboard that has been provided
+    private
+    def create_storyboard_category
+      output = Array.new(1, 'extension UIStoryboard {')
+
+      @storyboards.each do |storyboard|
+        class_name = storyboard.class_name(@prefix)
+        func_name = "#{storyboard.lowercase_name(@prefix)}Storyboard"
+        output.push "\tclass func #{func_name}() -> #{class_name} {"
+        output.push "\t\treturn #{class_name}(name: \"#{storyboard.name}\", bundle: nil)"
+        output.push "\t}"
+      end
+
+      output.push '}'
+
+      # Convert to a string
+      output = output.join("\n")
+
+      # Output to file
+      puts 'Writing UIStoryboard category.'
+      @implementation_file.write(output)
+    end
+
+  end
+end

data/lib/stronglyboards/storyboard.rb

@@ -0,0 +1,69 @@
+require 'nokogiri'
+require_relative 'view_controller'
+
+module Stronglyboards
+  class Storyboard
+
+    EXTENSION = '.storyboard'
+
+    attr_reader :name
+    attr_reader :view_controllers
+
+    def initialize(full_path)
+      @name = File.basename(full_path, EXTENSION)
+
+      file = File.open(full_path)
+      @xml = Nokogiri::XML(file)
+      file.close
+
+      @view_controllers = Array.new
+
+      # Find the initial view controller
+      initial_view_controller = find_initial_view_controller
+      @view_controllers.push(initial_view_controller) if initial_view_controller
+
+      # Find other view controllers
+      @view_controllers += find_view_controllers_with_storyboard_identifiers
+    end
+
+    # Searches for the initial view controller
+    private
+    def find_initial_view_controller
+      initial_vc_identifier = @xml.at_xpath('document').attr('initialViewController')
+      view_controller_xml = object_with_identifier(initial_vc_identifier) if initial_vc_identifier
+      if view_controller_xml
+        ViewController.new(view_controller_xml, true)
+      end
+    end
+
+    # Searches for view controllers
+    private
+    def find_view_controllers_with_storyboard_identifiers
+      view_controllers = @xml.xpath('//scene/objects/*[@storyboardIdentifier]')
+      view_controllers.collect { |xml| ViewController.new(xml) } if view_controllers
+    end
+
+    # --------- Helpers ---------
+
+    private
+    def object_with_identifier(identifier)
+      @xml.at_xpath("//scene/objects/*[@id='#{identifier}']")
+    end
+
+    public
+    def class_name(prefix = nil)
+      prefix + @name + 'Storyboard'
+    end
+
+    def lowercase_name(prefix = nil)
+      lower = @name.dup
+      lower[0] = lower[0].downcase
+      if prefix == nil || prefix.length == 0
+        lower
+      else
+        prefix.downcase + '_' + lower
+      end
+    end
+
+  end
+end

data/lib/stronglyboards/version.rb

@@ -0,0 +1,3 @@
+module Stronglyboards
+  VERSION = "0.0.2"
+end

data/lib/stronglyboards/view_controller.rb

@@ -0,0 +1,47 @@
+module Stronglyboards
+  class ViewController
+
+    attr_reader :class_name
+    attr_reader :storyboard_identifier
+
+    UIVIEWCONTROLLER = 'UIViewController'
+    UITABLEVIEWCONTROLLER = 'UITableViewController'
+    UINAVIGATIONCONTROLLER = 'UINavigationController'
+    UITABBARCONTROLLER = 'UITabBarController'
+    UICOLLECTIONVIEWCONTROLLER = 'UICollectionViewController'
+    UISPLITVIEWCONTROLLER = 'UISplitViewController'
+    UIPAGEVIEWCONTROLLER = 'UIPageViewController'
+
+    def initialize(xml, is_initial_view_controller = false)
+      @class_name = xml.attr('customClass') || class_name_from_type(xml)
+      @storyboard_identifier = xml.attr('storyboardIdentifier')
+      @is_initial_view_controller = is_initial_view_controller
+    end
+
+    def initial_view_controller?
+      @is_initial_view_controller
+    end
+
+    # Determines the name of the class from this view controller's type
+    private
+    def class_name_from_type(xml)
+      case xml.name
+        when 'viewController'
+          UIVIEWCONTROLLER
+        when 'tableViewController'
+          UITABLEVIEWCONTROLLER
+        when 'navigationController'
+          UINAVIGATIONCONTROLLER
+        when 'tabBarController'
+          UITABBARCONTROLLER
+        when 'collectionViewController'
+          UICOLLECTIONVIEWCONTROLLER
+        when 'splitViewController'
+          UISPLITVIEWCONTROLLER
+        when 'pageViewController'
+          UIPAGEVIEWCONTROLLER
+      end
+    end
+
+  end
+end

data/stronglyboards.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stronglyboards/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'stronglyboards'
+  spec.version     = Stronglyboards::VERSION
+  spec.date        = '2015-10-16'
+
+  spec.summary     = 'A strongly-typed interface for your storyboards, view controllers, and segues.'
+  spec.description = 'Generates a strongly-typed interface for your storyboards, view controllers, and segues.'
+  spec.license     = 'MIT'
+
+  spec.authors     = ['Steve Wilford']
+  spec.email       = 'steve@offtopic.io'
+  spec.homepage    = 'http://stevewilford.co.uk/stronglyboards'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_runtime_dependency 'xcodeproj', '>= 0.28.2'
+  spec.add_runtime_dependency 'nokogiri', '>= 1.6.6.2'
+  spec.add_runtime_dependency 'thor', '>= 0.19.1'
+
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: stronglyboards
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Steve Wilford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.28.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.28.2
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+description: Generates a strongly-typed interface for your storyboards, view controllers,
+  and segues.
+email: steve@offtopic.io
+executables:
+- stronglyboards
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- LICENSE.md
+- README.md
+- bin/stronglyboards
+- lib/stronglyboards.rb
+- lib/stronglyboards/lock_file.rb
+- lib/stronglyboards/source_generator.rb
+- lib/stronglyboards/source_generator_objc.rb
+- lib/stronglyboards/source_generator_swift.rb
+- lib/stronglyboards/storyboard.rb
+- lib/stronglyboards/version.rb
+- lib/stronglyboards/view_controller.rb
+- stronglyboards.gemspec
+homepage: http://stevewilford.co.uk/stronglyboards
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: A strongly-typed interface for your storyboards, view controllers, and segues.
+test_files: []