storyboardlint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 774c8e07d47f22213d691de1da856975d002cb78
+  data.tar.gz: 95178dea2c069f16d324a38337e42e46af9bbc3c
+SHA512:
+  metadata.gz: 7e02928fbb6f30432d8ddf7b2af898927837acd7512f0f3e26af9a1444e0ff7f9edf2773373dcf62c3ec40f9457791bb4e1214fddc61deeba9aa0fadc504cb11
+  data.tar.gz: e9612e771af5f3e140ccbe31df832ccdec336916dcf1b98ed3f4b619ac42c0cbf063c5a53c51f80c8bf08a48f4e151406e0844578f08cacbbc32b37d1d0078a5

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# If you make any changes in this file, please run `bundle install`.
+# If new versions of your installed gems are available, run `bundle update`
+
+gem "nokogiri", "~> 1.5.0"
+
+group :development do
+  gem "bundler", "~> 1.3.5"
+  gem "jeweler", "~> 1.8.0"
+end

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    faraday (0.8.9)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    multi_json (1.8.4)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.1)
+    rdoc (4.1.1)
+      json (~> 1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3.5)
+  jeweler (~> 1.8.0)
+  nokogiri (~> 1.5.0)

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Johannes Fahrenkrug
+
+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,4 @@
+StoryboardLint
+==============
+
+A lint tool for UIStoryboard to find wrong classes and wrong storyboard/segue/reuse identifiers

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "storyboardlint"
+  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.email = "johannes@springenwerk.com"
+  gem.authors = ["Johannes Fahrenkrug"]
+  
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/storyboardlint

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'storyboardlint.rb'
+
+exit StoryboardLint::Linter.run!(*ARGV)

data/lib/storyboardlint.rb

@@ -0,0 +1,222 @@
+# Have fun. Use at your own risk.
+# Copyright (c) 2014 Johannes Fahrenkrug
+
+require 'nokogiri'
+
+module StoryboardLint
+  SEGUE_ID_PREFIX = "seg_"
+  STORYBOARD_ID_PREFIX = "sb_"
+  REUSE_ID_PREFIX = "ruid_"
+
+  class StoryboardScanner
+    def initialize(src_root)
+      @src_root = src_root
+      @scan_performed = false    
+    end
+    
+    def storyboard_files
+      return @sb_files if @sb_files
+  
+      # find all storyboard files...
+      @sb_files = Dir.glob(File.join(@src_root, "**/*.storyboard"))
+    end
+    
+    def scan_files
+      if !@scan_performed
+        @segue_ids ||= []
+        @storyboard_ids ||= []
+        @reuse_ids ||= []
+        @custom_class_names = []
+    
+        storyboard_files.each do |sb_file|
+          sb_source = File.open(sb_file)
+          doc = Nokogiri::XML(sb_source)
+          doc.xpath('//segue').each do |element|
+            seg_id = element.attr('identifier')
+            @segue_ids << {:file => sb_file, :id => seg_id.to_s} if seg_id
+          end
+
+          @storyboard_ids += doc.xpath("//@storyboardIdentifier").to_a.map {|match| {:file => sb_file, :id => match.to_s}}
+          @reuse_ids += doc.xpath("//@reuseIdentifier").to_a.map {|match| {:file => sb_file, :id => match.to_s}}
+          @custom_class_names += doc.xpath("//@customClass").to_a.map {|match| {:file => sb_file, :class_name => match.to_s}}
+        end
+        
+        @scan_performed = true
+      end
+    end
+    
+    def segue_ids
+      scan_files
+      @segue_ids
+    end
+    
+    def storyboard_ids
+      scan_files
+      @storyboard_ids
+    end
+    
+    def reuse_ids
+      scan_files
+      @reuse_ids
+    end
+    
+    def custom_class_names
+      scan_files
+      @custom_class_names
+    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)
+      @src_root = src_root
+      @scan_performed = false    
+    end
+    
+    def source_files
+      return @source_files if @source_files
+  
+      # find all *.h, *.c, *.m and *.mm files
+      @source_files = Dir.glob(File.join(@src_root, "**/*.{h,c,m,mm}"))
+    end
+    
+    def scan_files
+      if !@scan_performed
+        @class_names ||= []
+        @segue_ids ||= []
+        @storyboard_ids ||= []
+        @reuse_ids ||= []
+
+        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|
+              @class_names << {:file => source_file, :line => idx + 1, :class_name => match[0]}
+            end
+            
+            # segue ids
+            line.scan(SEGUE_ID_REGEX).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|
+              @storyboard_ids << {:file => source_file, :line => idx + 1, :id => match[0]}
+            end
+            
+            # reuse ids
+            line.scan(REUSE_ID_REGEX).each do |match|
+              @reuse_ids << {:file => source_file, :line => idx + 1, :id => match[0]}
+            end
+          end
+        end
+        
+        @scan_performed = true
+      end
+    end
+    
+    def class_names
+      scan_files
+      @class_names
+    end
+    
+    def segue_ids
+      scan_files
+      @segue_ids
+    end
+    
+    def storyboard_ids
+      scan_files
+      @storyboard_ids
+    end
+    
+    def reuse_ids
+      scan_files
+      @reuse_ids
+    end
+  end
+  
+  class Linter
+    def initialize(sb_scanner, source_scanner)
+      @sb_scanner = sb_scanner
+      @source_scanner = source_scanner
+    end
+    
+    def lint
+     check_naming
+     check_custom_classes
+     check_ids
+    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."
+        end
+      end
+    end
+    
+    def check_custom_classes
+      @sb_scanner.custom_class_names.each do |custom_class|
+        if !@source_scanner.class_names.map {|cn| cn[:class_name]}.include?(custom_class[:class_name])
+          puts "error: Custom class '#{custom_class[:class_name]}' used in #{File.basename(custom_class[:file])} could not be found in source code."    
+        end
+      end
+    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."    
+        end
+      end
+    end
+    
+    def self.run!(*args)
+      puts "StoryboardLint"
+      puts "by Johannes Fahrenkrug, @jfahrenkrug, springenwerk.com"
+      puts
+
+      if args.size < 1
+        puts "Usage: storyboardlint <target directory>"
+        exit
+      end
+
+      sb_scanner = StoryboardLint::StoryboardScanner.new(ARGV[0])
+      source_scanner = StoryboardLint::SourceScanner.new(ARGV[0])
+
+      linter = StoryboardLint::Linter.new(sb_scanner, source_scanner)
+      linter.lint
+      
+      return 0
+    end
+  end
+end

data/storyboardlint.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "storyboardlint"
+  s.version = "0.1.0"
+
+  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.email = "johannes@springenwerk.com"
+  s.executables = ["storyboardlint"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/storyboardlint",
+    "lib/storyboardlint.rb",
+    "storyboardlint.gemspec"
+  ]
+  s.homepage = "https://github.com/jfahrenkrug/StoryboardLint"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "A lint tool for UIStoryboards to find wrong classes and wrong storyboard/segue/reuse identifiers"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.5.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.3.5"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.0"])
+    else
+      s.add_dependency(%q<nokogiri>, ["~> 1.5.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.3.5"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.0"])
+    end
+  else
+    s.add_dependency(%q<nokogiri>, ["~> 1.5.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.3.5"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.0"])
+  end
+end
+

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: storyboardlint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Johannes Fahrenkrug
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.5
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+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.
+email: johannes@springenwerk.com
+executables:
+- storyboardlint
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/storyboardlint
+- lib/storyboardlint.rb
+- storyboardlint.gemspec
+homepage: https://github.com/jfahrenkrug/StoryboardLint
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A lint tool for UIStoryboards to find wrong classes and wrong storyboard/segue/reuse
+  identifiers
+test_files: []