storyboardlint 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 774c8e07d47f22213d691de1da856975d002cb78
-  data.tar.gz: 95178dea2c069f16d324a38337e42e46af9bbc3c
+  metadata.gz: cb6bd687ab2eef94fe9d9aaf3fe66d5599c05886
+  data.tar.gz: 979f598428de5417814402939b1e456e04997c8f
 SHA512:
-  metadata.gz: 7e02928fbb6f30432d8ddf7b2af898927837acd7512f0f3e26af9a1444e0ff7f9edf2773373dcf62c3ec40f9457791bb4e1214fddc61deeba9aa0fadc504cb11
-  data.tar.gz: e9612e771af5f3e140ccbe31df832ccdec336916dcf1b98ed3f4b619ac42c0cbf063c5a53c51f80c8bf08a48f4e151406e0844578f08cacbbc32b37d1d0078a5
+  metadata.gz: 5d0978e1b82ac952ee5ea8e7f3ea3286e769a3b9291e0d06f16dc48dd55ce519b6c9736bc41518d9ec6153e105ed85840f0ef0a3f3e2020ae9e4df23e6781a24
+  data.tar.gz: f3cbc4e6c6dfc117cbc7c4a87e4e0cbf74d02cb617bb6312ca2b821a30c4bc1d77a93aa32f9872bb621b2341f9c67206f20ea8cf8c57ea49efc91e620092e4e3

data/README.md

@@ -1,4 +1,56 @@
 StoryboardLint
 ==============
 
-A lint tool for UIStoryboard to find wrong classes and wrong storyboard/segue/reuse identifiers
+A lint tool for UIStoryboard to find wrong classes and wrong storyboard/segue/reuse identifiers.
+
+Background
+----------
+In iOS development, UIStoryboards are a pain to use [for many reasons](http://stackoverflow.com/questions/9404471/when-to-use-storyboard-and-when-to-use-xibs/19457257#19457257).
+Two big reasons are:
+ - You can only use string literals as identifiers for view controllers and segues in your Storyboards. You need those same string literals again in your source code when referencing anything in your Storyboard: So you have your IDs in two or more places and no way to know if the IDs you use in your code actually exist in your Storyboard.
+ - You have no way of knowing whether your Storyboard references classes in your source code that don't exist (anymore).
+
+Fear Not!
+---------
+With StoryboardLint, you can finally make sure that your code and your Storyboards are in sync (at least to a certain degree). StoryboardLint does the following things:
+
+ - Makes sure your `UITableViewCell` and `UICollectionViewCell` reuse identifiers are named according to StoryboardLint's naming convention.
+ - Makes sure your Storyboard and Segue identifiers are named according to StoryboardLint's naming convention.
+ - Makes sure that all custom classes that are references from your Storyboard actually exist is your code.
+ - Makes sure that all string literals in your code that reference reuse identifiers, Storyboard identifiers and Segue identifiers (according to the naming convention) actually exist in your Storyboard(s).
+ - Produces output that is parsable by Xcode so you can easily plug StoryboardLint into your build process:
+
+**Warnings right in your source code:**
+
+![Xcode Warnings](http://i.imgur.com/G24DJhf.png)
+
+**Warnings about bugs in your Storyboard:**
+
+![Xcode Warnings](http://i.imgur.com/rfInSBE.png)
+ 
+Naming Convention
+-----------------
+In order for StoryboardLint to find the string literals in your code that contain reuse/Storyboard/Segue identifiers, you need to prefix them as follows:
+
+ - Reuse Identifiers start with `ruid_`. Example: `ruid_ProductTableViewCell`.
+ - Storyboard Identifiers start with `sb_`. Example: `sb_ProductsViewController`.
+ - Segue Identifiers start with `seg_`. Example: `seg_ProductDetailsSegue`.
+ 
+This should not be too much work and it will be worth it. Ideally you already have string constants for these things in your code, so that you only have to edit two places: your string constant in code and the respective value in your Storyboard.
+
+Installation
+------------
+Just install the Ruby Gem:
+
+    sudo gem install storyboardlint
+    
+In your Xcode Project, simply add a "Run Script" build phase in order to run StoryboardLint every time you build:
+
+1. Go to your project and select your project's target in the "Targets" section.
+2. Go to "Build Phases"
+3. Select from the Menu "Editor -> Add Build Phase -> Add Run Script Build Phase"
+4. Paste this command into the Run Script section: `storyboardlint "$SRCROOT"`
+5. That's it!
+
+
+

data/Rakefile

@@ -16,7 +16,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "https://github.com/jfahrenkrug/StoryboardLint"
   gem.license = "MIT"
   gem.summary = %Q{A lint tool for UIStoryboards to find wrong classes and wrong storyboard/segue/reuse identifiers}
-  gem.description = %Q{It's a pain to to keep identifier strings in your UIStoryboard and it your source code in sync. This tool helps you to do just that.}
+  gem.description = %Q{It's a pain to to keep identifier strings in your UIStoryboard and in your source code in sync. This tool helps you to do just that.}
   gem.email = "johannes@springenwerk.com"
   gem.authors = ["Johannes Fahrenkrug"]
   

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/storyboardlint.rb

@@ -2,12 +2,10 @@
 # Copyright (c) 2014 Johannes Fahrenkrug
 
 require 'nokogiri'
+require 'ostruct'
+require 'optparse'
 
 module StoryboardLint
-  SEGUE_ID_PREFIX = "seg_"
-  STORYBOARD_ID_PREFIX = "sb_"
-  REUSE_ID_PREFIX = "ruid_"
-
   class StoryboardScanner
     def initialize(src_root)
       @src_root = src_root
@@ -66,13 +64,9 @@ module StoryboardLint
     end
   end
 
-  class SourceScanner
-    CLASS_REGEX = /@interface\s+([a-zA-Z_]+\w*)/
-    SEGUE_ID_REGEX = /@"(#{SEGUE_ID_PREFIX}(?:\\"|[^"])+)"/
-    STORYBOARD_ID_REGEX = /@"(#{STORYBOARD_ID_PREFIX}(?:\\"|[^"])+)"/
-    REUSE_ID_REGEX = /@"(#{REUSE_ID_PREFIX}(?:\\"|[^"])+)"/
-    
-    def initialize(src_root)
+  class SourceScanner    
+    def initialize(src_root, matcher)
+      @matcher = matcher
       @src_root = src_root
       @scan_performed = false    
     end
@@ -94,22 +88,22 @@ module StoryboardLint
         source_files.each do |source_file|
           File.readlines(source_file).each_with_index do |line, idx|
             # class names
-            line.scan(CLASS_REGEX).each do |match|
+            line.scan(@matcher.class_regex).each do |match|
               @class_names << {:file => source_file, :line => idx + 1, :class_name => match[0]}
             end
             
             # segue ids
-            line.scan(SEGUE_ID_REGEX).each do |match|
+            line.scan(@matcher.segue_id_regex_source).each do |match|
               @segue_ids << {:file => source_file, :line => idx + 1, :id => match[0]}
             end
             
             # storyboard ids
-            line.scan(STORYBOARD_ID_REGEX).each do |match|
+            line.scan(@matcher.storyboard_id_regex_source).each do |match|
               @storyboard_ids << {:file => source_file, :line => idx + 1, :id => match[0]}
             end
             
             # reuse ids
-            line.scan(REUSE_ID_REGEX).each do |match|
+            line.scan(@matcher.reuse_id_regex_source).each do |match|
               @reuse_ids << {:file => source_file, :line => idx + 1, :id => match[0]}
             end
           end
@@ -140,8 +134,67 @@ module StoryboardLint
     end
   end
   
+  class Matcher
+    DEFAULT_SEGUE_ID_PREFIX = "seg_"
+    DEFAULT_STORYBOARD_ID_PREFIX = "sb_"
+    DEFAULT_REUSE_ID_PREFIX = "ruid_"
+    
+    def initialize(options)
+      options ||= OpenStruct.new
+      
+      @storyboard_id_regex_source = create_source_regex(DEFAULT_STORYBOARD_ID_PREFIX, options.storyboard_prefix, options.storyboard_suffix)
+      @storyboard_id_regex_sb = create_storyboard_regex(DEFAULT_STORYBOARD_ID_PREFIX, options.storyboard_prefix, options.storyboard_suffix)
+      
+      @segue_id_regex_source = create_source_regex(DEFAULT_SEGUE_ID_PREFIX, options.segue_prefix, options.segue_suffix)
+      @segue_id_regex_sb = create_storyboard_regex(DEFAULT_SEGUE_ID_PREFIX, options.segue_prefix, options.segue_suffix)
+      
+      @reuse_id_regex_source = create_source_regex(DEFAULT_REUSE_ID_PREFIX, options.reuse_prefix, options.reuse_suffix)
+      @reuse_id_regex_sb = create_storyboard_regex(DEFAULT_REUSE_ID_PREFIX, options.reuse_prefix, options.reuse_suffix)
+    end
+    
+    def create_source_regex(default_prefix, prefix, suffix)
+      inner_regex_part = %{(?:\\"|[^"])+}
+      if prefix.to_s.empty? and suffix.to_s.empty?
+        return /@"(#{default_prefix}#{inner_regex_part})"/
+      else
+        return /@"(#{prefix}#{inner_regex_part}#{suffix})"/
+      end
+    end
+    
+    def create_storyboard_regex(default_prefix, prefix, suffix)
+      inner_regex_part = %{(?:\\"|[^"])+}
+      if prefix.to_s.empty? and suffix.to_s.empty?
+        sb = /^#{default_prefix}/
+      else        
+        if !prefix.to_s.empty?
+          if !suffix.to_s.empty?
+            sb = /^#{prefix}[\w\s]*#{suffix}$/ 
+          else !prefix.to_s.empty?
+            sb = /^#{prefix}/
+          end
+        else
+          sb = /#{suffix}$/
+        end
+      end
+      
+      sb
+    end
+    
+    def class_regex
+      /@interface\s+([a-zA-Z_]+\w*)/
+    end
+    
+    [:storyboard, :segue, :reuse].each do |name|
+      [:sb, :source].each do |kind|
+        method_name = "#{name}_id_regex_#{kind}"
+        define_method(method_name) { instance_variable_get("@#{method_name}") }
+      end
+    end
+  end
+  
   class Linter
-    def initialize(sb_scanner, source_scanner)
+    def initialize(sb_scanner, source_scanner, matcher)
+      @matcher = matcher
       @sb_scanner = sb_scanner
       @source_scanner = source_scanner
     end
@@ -153,21 +206,13 @@ module StoryboardLint
     end
     
     def check_naming
-      @sb_scanner.segue_ids.each do |seg_id|
-        if seg_id[:id] !~ /$#{SEGUE_ID_PREFIX}/
-          puts "warning: Segue ID '#{seg_id[:id]}' used in #{File.basename(seg_id[:file])} does not start with '#{SEGUE_ID_PREFIX}' prefix."
-        end
-      end
-      
-      @sb_scanner.storyboard_ids.each do |sb_id|
-        if sb_id[:id] !~ /$#{STORYBOARD_ID_PREFIX}/
-          puts "warning: Storyboard ID '#{sb_id[:id]}' used in #{File.basename(sb_id[:file])} does not start with '#{STORYBOARD_ID_PREFIX}' prefix."
-        end
-      end
-      
-      @sb_scanner.reuse_ids.each do |ru_id|
-        if ru_id[:id] !~ /$#{REUSE_ID_PREFIX}/
-          puts "warning: Reuse ID '#{ru_id[:id]}' used in #{File.basename(ru_id[:file])} does not start with '#{REUSE_ID_PREFIX}' prefix."
+      [{:items => @sb_scanner.segue_ids, :regex => @matcher.segue_id_regex_sb, :name => 'Segue ID'},
+       {:items => @sb_scanner.storyboard_ids, :regex => @matcher.storyboard_id_regex_sb, :name => 'Storyboard ID'},
+       {:items => @sb_scanner.reuse_ids, :regex => @matcher.reuse_id_regex_sb, :name => 'Reuse ID'}].each do |data|
+        data[:items].each do |item|
+          if item[:id] !~ data[:regex]
+            puts "warning: #{data[:name]} '#{item[:id]}' used in #{File.basename(item[:file])} does not match '#{data[:regex]}."
+          end
         end
       end
     end
@@ -181,39 +226,75 @@ module StoryboardLint
     end
     
     def check_ids
-      @source_scanner.segue_ids.each do |seg_id|
-        if !@sb_scanner.segue_ids.map {|sb_seg_id| sb_seg_id[:id]}.include?(seg_id[:id])
-          puts "#{seg_id[:file]}:#{seg_id[:line]}: warning: Segue ID '#{seg_id[:id]}' could not be found in any Storyboard."    
-        end
-      end
-      
-      @source_scanner.storyboard_ids.each do |sb_id|
-        if !@sb_scanner.storyboard_ids.map {|sb_sb_id| sb_sb_id[:id]}.include?(sb_id[:id])
-          puts "#{sb_id[:file]}:#{sb_id[:line]}: warning: Storyboard ID '#{sb_id[:id]}' could not be found in any Storyboard."    
-        end
-      end
-      
-      @source_scanner.reuse_ids.each do |ru_id|
-        if !@sb_scanner.reuse_ids.map {|sb_ru_id| sb_ru_id[:id]}.include?(ru_id[:id])
-          puts "#{ru_id[:file]}:#{ru_id[:line]}: warning: Reuse ID '#{ru_id[:id]}' could not be found in any Storyboard."    
+      [{:method_name => :segue_ids, :name => 'Segue ID'},
+       {:method_name => :storyboard_ids, :name => 'Storyboard ID'},
+       {:method_name => :reuse_ids, :name => 'Reuse ID'}].each do |data|
+        @source_scanner.send(data[:method_name]).each do |source_item|
+          if !@sb_scanner.send(data[:method_name]).map {|sb_item| sb_item[:id]}.include?(source_item[:id])
+            puts "#{source_item[:file]}:#{source_item[:line]}: warning: #{data[:name]} '#{source_item[:id]}' could not be found in any Storyboard."    
+          end
         end
       end
     end
     
     def self.run!(*args)
-      puts "StoryboardLint"
-      puts "by Johannes Fahrenkrug, @jfahrenkrug, springenwerk.com"
-      puts
+      options = OpenStruct.new
+      
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: storyboardlint <target directory> [options]"
+        opts.separator  ""
+        opts.separator  "Options"
+
+        opts.on("--storyboard-prefix [PREFIX]", "Storyboard IDs have to begin with PREFIX.") do |prefix|
+          options.storyboard_prefix = prefix
+        end
+        
+        opts.on("--storyboard-suffix [SUFFIX]", "Storyboard IDs have to end with SUFFIX") do |suffix|
+          options.storyboard_suffix = suffix
+        end
+        
+        opts.on("--segue-prefix [PREFIX]", "Segue IDs have to begin with PREFIX") do |prefix|
+          options.segue_prefix = prefix
+        end
+        
+        opts.on("--segue-suffix [SUFFIX]", "Segue IDs have to end with SUFFIX") do |suffix|
+          options.segue_suffix = suffix
+        end
+        
+        opts.on("--reuse-prefix [PREFIX]", "Reuse IDs have to begin with PREFIX") do |prefix|
+          options.reuse_prefix = prefix
+        end
+        
+        opts.on("--reuse-suffix [SUFFIX]", "Reuse IDs have to end with SUFFIX") do |suffix|
+          options.reuse_suffix = suffix
+        end
+        
+        # No argument, shows at tail.  This will print an options summary.
+        # Try it and see!
+        opts.on_tail("-h", "--help", "Show this message") do
+          puts opts
+          exit
+        end
 
-      if args.size < 1
-        puts "Usage: storyboardlint <target directory>"
-        exit
+        # Another typical switch to print the version.
+        opts.on_tail("--version", "Show version") do
+          puts "StoryboardLint v0.1.1"
+          exit
+        end
       end
+      
+      if ARGV.length < 1
+        puts opt_parser
+        exit 0
+      end
+      
+      opt_parser.parse(args)
 
+      matcher = StoryboardLint::Matcher.new(options)
       sb_scanner = StoryboardLint::StoryboardScanner.new(ARGV[0])
-      source_scanner = StoryboardLint::SourceScanner.new(ARGV[0])
+      source_scanner = StoryboardLint::SourceScanner.new(ARGV[0], matcher)
 
-      linter = StoryboardLint::Linter.new(sb_scanner, source_scanner)
+      linter = StoryboardLint::Linter.new(sb_scanner, source_scanner, matcher)
       linter.lint
       
       return 0

data/storyboardlint.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = "storyboardlint"
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Johannes Fahrenkrug"]
-  s.date = "2014-02-19"
-  s.description = "It's a pain to to keep identifier strings in your UIStoryboard and it your source code in sync. This tool helps you to do just that."
+  s.date = "2014-02-20"
+  s.description = "It's a pain to to keep identifier strings in your UIStoryboard and in your source code in sync. This tool helps you to do just that."
   s.email = "johannes@springenwerk.com"
   s.executables = ["storyboardlint"]
   s.extra_rdoc_files = [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: storyboardlint
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Johannes Fahrenkrug
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -52,7 +52,7 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.8.0
-description: It's a pain to to keep identifier strings in your UIStoryboard and it
+description: It's a pain to to keep identifier strings in your UIStoryboard and in
   your source code in sync. This tool helps you to do just that.
 email: johannes@springenwerk.com
 executables: