sbconstants 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc188984afc3d543f4350dbd750ccd57a470b664
-  data.tar.gz: 507c97cdb444d0936f05dafa79e467714bfbff8a
+  metadata.gz: 3c4b50bc26a07daef1fcb4070f8940412f76c849
+  data.tar.gz: 7ed715ee91c3a8b0bee9534671efde59eacb135d
 SHA512:
-  metadata.gz: 06db174531943f8749c9b911fed499f2058d6d9c939ac490922660a8c1eb6f94341100174945403712d0795810a7adebea073ee0f7ec1d116d48d2f31467ebab
-  data.tar.gz: 8ed6a07ae457053bc2777a94e190aa5a1720007ea9e991e0c1c79b008d62eb638ab04c4039d8ecfe1ad73804c6afdfc6dc2a1464ed6e59e1e1e829d47a511367
+  metadata.gz: 979b6abf7914096eaf0f0a1f67949024140bf407936028b8069549a5989e4d06796dd59a2e36f5f3fb865237b20bd19629fe65c2c5c792dfb4ee036215904571
+  data.tar.gz: c924cfe629f55a59eb1f15ab5d3cf42a015eff6d2215f15e716c63290386040696fbbe51adb567e200b2896c37721aaaa67b34921b4f15ac551fb5fa842fdc28

data/README.md

@@ -1,6 +1,6 @@
 # sbconstants
 
-Generate a constants file by grabbing identifiers from storyboards in a project. See [my blog post](http://paul-samuels.com/blog/2013/01/31/storyboard-constants/) for more use cases.
+Generate a constants file by grabbing identifiers from storyboards in a project.
 
 ## Installation
 
@@ -34,6 +34,164 @@ Usage: DESTINATION_FILE [options]
     -w, --swift                      Output to a Swift File
 ```
 
+An example usage would look like:
+
+    sbconstants MyApp/Constants/PASStoryboardConstants.h
+    
+**NB** The argument is the destination file to dump the constants into - this needs to be added manually
+    
+Every time `sbconstants` is run it will parse the storyboard files and pull out any constants and then dump them into `PASStoryboardConstants.(h|m)`. This of course means that `PASStoryboardConstants.(h|m)` should not be edited by hand as it will just be clobbered any time we build.
+
+The output of running this tool will look something like this:
+
+`PASStoryboardConstants.h`
+```
+// Auto generated file - any changes will be lost
+
+#import <Foundation/Foundation.h>
+
+#pragma mark - segue.identifier
+extern NSString * const PSBMasterToDetail;
+extern NSString * const PSBMasterToSettings;
+
+#pragma mark - storyboardNames
+extern NSString * const Main;
+
+#pragma mark - tableViewCell.reuseIdentifier
+extern NSString * const PSBAwesomeCell;
+
+```
+
+`PASStoryboardConstants.m`
+```
+
+// Auto generated file - any changes will be lost
+
+#import "PASStoryboardConstants.h"
+
+#pragma mark - segue.identifier
+NSString * const PSBMasterToDetail = @"PSBMasterToDetail";
+NSString * const PSBMasterToSettings = @"PSBMasterToSettings";
+
+#pragma mark - storyboardNames
+NSString * const Main = @"Main";
+
+#pragma mark - tableViewCell.reuseIdentifier
+NSString * const PSBAwesomeCell = @"PSBAwesomeCell";
+
+```
+
+Using the `--swift` flag this would produce
+
+```
+// Auto generated file from SBConstants - any changes may be lost
+
+public enum SegueIdentifier : String {
+    case PSBMasterToDetail = "PSBMasterToDetail"
+    case PSBMasterToSettings = "PSBMasterToSettings"
+}
+
+public enum StoryboardNames : String {
+    case Main = "Main"
+}
+
+public enum TableViewCellreuseIdentifier : String {
+    case PSBAwesomeCell = "PSBAwesomeCell"
+}
+```
+
+The constants are grouped by where they were found in the storyboard xml e.g. `segue.identifier`. This can really help give you some context about where/what/when and why a constant exists.
+
+##Options
+
+Options are fun and there are a few to play with - most of these options are really only any good for debugging.
+
+####`--prefix`
+    -p, --prefix=<prefix>            Only match identifiers with <prefix>
+    
+Using the `prefix` option you can specify that you only want to grab identifiers that start with a certain prefix, which is always nice.
+
+####`--source-dir`
+    -s, --source-dir=<source>        Directory containing storyboards
+    
+If you don't want to run the tool from the root of your app for some reason you can specify the source directory to start searching for storyboard files. The search is recursive using a glob something like `<source-dir>/**/*.storyboard`
+
+####`--dry-run`
+    -d, --dry-run                    Output to STDOUT
+    
+If you just want to run the tool and not write the output to a file then this option will spit the result out to `$stdout`
+
+####`--verbose`
+    -v, --verbose                    Verbose output
+    
+Perhaps you want a little more context about where your identifiers are being grabbed from for debugging purposes. Never fear just use the `--verbose` switch and get output similar to:
+
+`sample output`
+```
+
+#pragma mark - viewController.storyboardIdentifier
+//
+//    info: MainStoryboard[line:43](viewController.storyboardIdentifier)
+// context: <viewController restorationIdentifier="asd" storyboardIdentifier="FirstViewController" id="EPD-sv-vrF" sceneMemberID="viewController">
+//
+NSString * const FirstViewController = @"FirstViewController";
+
+```
+
+####`--queries`
+    -q, --queries=<queries>          YAML file containing queries
+    
+Chances are I've missed some identifiers to search for in the storyboard. You don't want to wait for the `gem` to be updated or have to fork it and fix it. Using this option you can provide a YAML file that contains a description of what identifers to search for. The current one looks something like this (NB this is a great starting point for creating your own yaml):
+
+`queries`
+```
+
+---
+segue: identifier
+view: restorationIdentifier
+? - tableViewCell
+  - collectionViewCell
+: - reuseIdentifier
+? - navigationController
+  - viewController
+  - tableViewController
+  - collectionViewController
+: - storyboardIdentifier
+  - restorationIdentifier
+  
+```
+
+This looks a little funky but it's essentially groups of keys and values (both the key and the value can be an array). This actually gets expanded to the following table:
+
+    +--------------------------+-----------------------+
+    |         node             |      attribute        |
+    + -------------------------+-----------------------+
+    | segue                    | identifier            |
+    | view                     | restorationIdentifier |
+    | tableViewCell            | reuseIdentifier       |
+    | collectionViewCell       | reuseIdentifier       |
+    | navigationController     | storyboardIdentifier  |
+    | viewController           | storyboardIdentifier  |
+    | tableViewController      | storyboardIdentifier  |
+    | collectionViewController | storyboardIdentifier  |
+    | viewController           | restorationIdentifier |
+    | navigationController     | restorationIdentifier |
+    | tableViewController      | restorationIdentifier |
+    | collectionViewController | restorationIdentifier |
+    +--------------------------+-----------------------+
+
+####`--swift`
+
+    -w, --swift                      Output to a Swift File
+    
+Outputs Swift code rather than Objective-C
+
+####`--templates-dir`
+
+    -t, --templates-dir=<templates>  Directory containing the templates to use for code formatting
+    
+See below
+
 ## Custom formatting
 
 If you are running tools that verify your team is sticking to coding conventions you might find that the default output might not fit your requirements. Not to fear you can provide your own templates to decide the formatting you require by passing the `--templates-dir` option with the path to the directory containing the templates to use.

data/lib/sbconstants/cli.rb

@@ -2,20 +2,20 @@ require 'set'
 
 module SBConstants
   class CLI
-    attr_accessor :options, :constants, :sections, :storyboards
+    attr_accessor :options, :constants, :sections, :xibs
 
     def self.run argv
       new(Options.parse(argv)).run
     end
 
     def initialize options
-      self.options     = options
-      self.constants   = Hash.new { |h,k| h[k] = Set.new }
-      self.storyboards = Array.new
+      self.options   = options
+      self.constants = Hash.new { |h,k| h[k] = Set.new }
+      self.xibs      = Array.new
     end
 
     def run
-      parse_storyboards
+      parse_xibs
       refute_key_collisions
       write
     end
@@ -39,7 +39,7 @@ module SBConstants
     end
     
     def sanitise_key key
-      key.gsub(" ", "").gsub("-", "")
+      key.gsub(" ", "").gsub("-", "").gsub("@", "").gsub(":", "").gsub("~", "_")
     end
 
     private
@@ -65,16 +65,17 @@ To resolve the issue remove the ambiguity in naming - search your storyboards fo
     # Parse all found storyboards and build a dictionary of constant => locations
     #
     # A constant key can potentially exist in many files so locations is a collection
-    def parse_storyboards
-      Dir["#{options.source_dir}/**/*.storyboard"].each_with_index do |storyboard, storyboard_index|
+    def parse_xibs
+      Dir["#{options.source_dir}/**/*.{storyboard,xib}"].each_with_index do |xib, xib_index|
 
-        filename = File.basename(storyboard, '.storyboard')
-        storyboards << filename
+        filename = File.basename(xib, '.*')
+        xibs << filename
 
-        constants[filename] << Location.new('storyboardNames', nil, storyboard, filename, storyboard_index + 1)
+        group_name = "#{xib.split(".").last}Names"
 
+        constants[filename] << Location.new(group_name, nil, xib, filename, xib_index + 1)
 
-        File.readlines(storyboard).each_with_index do |line, index|
+        File.readlines(xib, encoding: 'UTF-8').each_with_index do |line, index|
           options.queries.each do |query|
             next unless value = line[query.regex, 1]
             next if value.strip.empty?
@@ -92,7 +93,7 @@ To resolve the issue remove the ambiguity in naming - search your storyboards fo
 
       if options.use_swift
           swift_out = File.open("#{options.output_path}.swift", 'w') unless dry_run
-          SwiftConstantWriter.new(self, swift_out).write
+          SwiftConstantWriter.new(self, swift_out, options.templates_dir).write
           swift_out.close
       else
 

data/lib/sbconstants/identifiers.yml

@@ -1,12 +1,16 @@
 ---
 segue: identifier
 view: restorationIdentifier
+controller: identifier
+tableRow: identifier
 ? - tableViewCell
   - collectionViewCell
+  - collectionReusableView
 : - reuseIdentifier
 ? - navigationController
   - viewController
   - tableViewController
   - collectionViewController
+  - viewControllerPlaceholder
 : - storyboardIdentifier
   - restorationIdentifier

data/lib/sbconstants/objc_constant_writer.rb

@@ -22,7 +22,7 @@ module SBConstants
     end
 
     def header
-      template_with_file "#import <Foundation/Foundation.h>\n\n", File.open(template_file_path("objc_header.erb")).read
+      template_with_file "@import Foundation;\n\n", File.open(template_file_path("objc_header.erb")).read
     end
 
     def implementation

data/lib/sbconstants/section.rb

@@ -8,6 +8,7 @@ module SBConstants
                                .gsub("identifier", "Identifier")
                                .gsub("viewcontroller", "ViewController")
                                .gsub("storyboard", "Storyboard")
+                               .gsub("reuse", "Reuse")
 
       title.slice(0,1).capitalize + title.slice(1..-1)
     end

data/lib/sbconstants/swift_constant_writer.rb

@@ -3,26 +3,38 @@ require 'erb'
 
 module SBConstants
   class SwiftConstantWriter < SimpleDelegator
-    def initialize data_source, swift_out
+    attr_reader :templates_dir
+
+    def initialize data_source, swift_out, templates_dir
       super data_source
       @swift_out = swift_out
+      @templates_dir = templates_dir
     end
 
     def write
       head = %Q{\nimport Foundation"\n}
-      body = %Q{    case <%= sanitise_key(constant) %> = "<%= constant %>"\n}
+      body = %Q{    case <%= sanitise_key(constant) %>\n}
       @swift_out.puts template_with_file head, body
     end
 
-    def templates_dir
-      @templates_dir ||= File.dirname(__FILE__) + '/templates/'
+    def default_templates_dir
+      @default_templates_dir ||= File.dirname(__FILE__) + '/templates'
     end
 
     def template_with_file head, body
       @head = head
       @body = body
-      pre_processed_template = ERB.new(File.open("#{templates_dir}swift_body.erb").read, nil, '<>').result(binding)
+      pre_processed_template = ERB.new(File.open(template_file_path("swift_body.erb")).read, nil, '<>').result(binding)
       ERB.new(pre_processed_template, nil, '<>').result(binding)
     end
+
+    def template_file_path basename
+      if templates_dir && File.exist?("#{templates_dir}/#{basename}")
+        "#{templates_dir}/#{basename}"
+      else
+        "#{default_templates_dir}/#{basename}"
+      end
+    end
+
   end
 end

data/lib/sbconstants/version.rb

@@ -1,3 +1,3 @@
 module SBConstants
-  VERSION = "1.1.2"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sbconstants
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Paul Samuels
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2016-04-06 00:00:00.000000000 Z
 dependencies: []
 description: Generate constants from storyboards in ObjC and Swift.
 email:
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Generate constants from storyboards in Objective-C and Swift.