check_xcode_xmls 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c81381382ef0b3eaee3a268b0e65e20c08d549fe
+  data.tar.gz: 7e61924751d164938ff6feeed6a13a0ef9d49f2f
+SHA512:
+  metadata.gz: b6f9e57fc93518f3086acd5c825ed790b7b53ff1f7b4b27d9a2d3595e9316a9ae668a99e13d04aa76bc6aeeb5ec8704e4a95d4e076cc53cdecdd72d867cceaef
+  data.tar.gz: 86598a83f9b6b5e229e9bb35495857c4783b64b5c7a058d85f473efd2d00898bfba07a15bd9e4ebc7a56bba0c59e7d8a9f3d3bef7ecbc52ee1c4cacacb4c76ce

data/bin/check-xcode-xmls

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'check_xcode_xmls'
+
+::CheckXcodeXmls.main(ARGV)

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'check_xcode_xmls'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/check_xcode_xmls/arguments_parser.rb

@@ -0,0 +1,74 @@
+require 'optparse'
+
+# https://docs.ruby-lang.org/en/2.1.0/OptionParser.html
+Options = Struct.new(
+  :input_directory,
+  :ignore_regex_string,
+  :check_constraints_identifiers,
+  :check_use_autolayout
+)
+
+SCRIPT_NAME = 'check-xcode-xmls'.freeze
+
+# Parses command line arguments
+class Parser
+  def self.default_options
+    result = Options.new
+    result.input_directory = '.'
+    result.check_constraints_identifiers = false
+    result.check_use_autolayout = false
+    result
+  end
+  private_class_method :default_options
+
+  def self.parse(argv)
+    # If no arguments supplied, print help
+    argv << '-h' if argv.empty?
+
+    result = default_options
+
+    options_parser = OptionParser.new do |o|
+      o.banner = 'Usage: {SCRIPT_NAME} [input directory]'
+      # nandrei add an ignore option.
+      o.on('-h',
+           '--help',
+           'Prints this help') do
+        puts options_parser
+        exit 0
+      end
+      o.on('-iIGNORE',
+           '--ignore-regex=IGNORE',
+           'Case sensitive ignore files regex. Eg. "Ignore|Debug"') do |v|
+        result.ignore_regex_string = v
+      end
+
+      o.on('--check-constraints-identifiers',
+           'Check files for constraints that don\'t have identifiers') do |_v|
+        result.check_constraints_identifiers = true
+      end
+
+      o.on('--check-use-autolayout',
+           'Find files which don\'t use autolayout') do |_v|
+        result.check_use_autolayout = true
+      end
+    end
+
+    begin
+      options_parser.parse!(argv)
+    rescue StandardError => exception
+      puts exception
+      puts options_parser
+      exit 1
+    end
+
+    result.input_directory = argv.pop
+    if result.input_directory.nil? || !Dir.exist?(result.input_directory)
+      directory = result.input_directory || ''
+      puts 'Can\'t find directory ' + directory
+      Parser.parse %w[--help]
+      exit 0
+    end
+
+    result
+  end
+end

data/lib/check_xcode_xmls/helpers.rb

@@ -0,0 +1,93 @@
+require 'find'
+
+class XcodeXml
+  def self.extension
+    'implement in subclass'
+  end
+
+  def self.check_if_file_uses_autolayout(file, doc_xpath)
+    # <document type="com.apple.InterfaceBuilder3.CocoaTouch.Storyboard.XIB" version="3.0" toolsVersion="14460.31" targetRuntime="iOS.CocoaTouch"
+    # propertyAccessControl="none" useAutolayout="YES" useTraitCollections="YES" useSafeAreas="YES" colorMatched="YES">
+    if doc_xpath.attribute('useAutolayout').nil?
+      return ["#{file}: doesn't use autolayout."]
+    end
+    nil
+  end
+
+  def self.search_constraints_without_identifiers(file, doc_xpath)
+    result = []
+    doc_xpath.children.each do |child|
+      array = search_constraints_without_identifiers(file, child)
+      # puts '----'
+      # puts child
+      if child.name == 'constraint'
+        if child.attr('identifier').nil?
+          array.push("#{file}: constraint with id #{child.attr('id')} doesn't have an identifier.")
+        end
+      end
+      result += array unless array.nil?
+    end
+    result
+  end
+end
+
+class Xib < XcodeXml
+  def self.extension
+    /.xib$/
+  end
+end
+
+class Storyboard < XcodeXml
+  def self.extension
+    /.storyboard$/
+  end
+  # eg. segue identifier
+end
+
+# Convenience utilities.
+
+def find_files(ignore_regex_string, base_path, extension)
+  file_paths = []
+  ignore_regex = Regexp.new(ignore_regex_string) unless ignore_regex_string.nil?
+  # puts ignore_regex
+  Find.find(base_path) do |path|
+    next if File.directory? path
+    next if path !~ extension
+    if ignore_regex
+      next if path =~ ignore_regex
+    end
+
+    file_paths << path
+  end
+  file_paths
+end
+
+require 'nokogiri'
+def parse_xml(
+  check_constraints_identifiers,
+  check_use_autolayout,
+  file
+)
+  string = File.open(file, 'r:UTF-8').read
+  doc = Nokogiri::XML(string)
+  # puts doc.xpath('document').attribute('type')
+  result = []
+
+  [Xib,
+   Storyboard].each do |item|
+
+    next if file !~ item.extension
+
+    if check_constraints_identifiers
+      constraintsValues = item.search_constraints_without_identifiers(file, doc.xpath('document'))
+      result += constraintsValues unless constraintsValues.nil?
+    end
+
+    if check_use_autolayout
+      autolayoutValue = item.check_if_file_uses_autolayout(file, doc.xpath('document'))
+      result += autolayoutValue unless autolayoutValue.nil?
+    end
+  end
+  # result = search_constraints_without_identifiers(file, doc.xpath('document'))
+  result
+end

data/lib/check_xcode_xmls/shell_adapter.rb

@@ -0,0 +1,23 @@
+require_relative 'helpers'
+
+# Adapter which handles shell access.
+class ShellAdapter
+  def process_files(
+    check_constraints_identifiers,
+    check_use_autolayout,
+    ignore_regex_string,
+    base_path
+  )
+    result = []
+    files = find_files(ignore_regex_string, base_path, /.(xib|storyboard)$/)
+
+    files.each do |file|
+      result += parse_xml(
+        check_constraints_identifiers,
+        check_use_autolayout,
+        file
+      )
+    end
+    result
+    end
+end

data/lib/check_xcode_xmls/version.rb

@@ -0,0 +1,3 @@
+module CheckXcodeXmls
+  VERSION = '0.1.0'.freeze
+end

data/lib/check_xcode_xmls.rb

@@ -0,0 +1,27 @@
+require 'check_xcode_xmls/version'
+require 'check_xcode_xmls/arguments_parser.rb'
+require 'check_xcode_xmls/shell_adapter.rb'
+
+module CheckXcodeXmls
+  class Error < StandardError; end
+  # Your code goes here...
+
+  def self.main(args)
+    arguments_string = args.join(' ')
+    options = Parser.parse(args)
+
+    shell = ShellAdapter.new
+    result = shell.process_files(
+      options.check_constraints_identifiers,
+      options.check_use_autolayout,
+      options.ignore_regex_string,
+      options.input_directory
+    )
+
+    puts "#{$PROGRAM_NAME} #{arguments_string}"
+    puts "Total issues: #{result.length || 0}"
+    puts result unless result.nil?
+  end
+end
+
+# TODO: nandrei make switches for each operation

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: check_xcode_xmls
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrei Nagy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Check interface builder files for autolayout constraints without identifiers.
+email:
+- nagy.andrei@gmail.com
+executables:
+- check-xcode-xmls
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/check-xcode-xmls
+- bin/console
+- bin/setup
+- lib/check_xcode_xmls.rb
+- lib/check_xcode_xmls/arguments_parser.rb
+- lib/check_xcode_xmls/helpers.rb
+- lib/check_xcode_xmls/shell_adapter.rb
+- lib/check_xcode_xmls/version.rb
+homepage: https://github.com/andreinagy/check-xcode-xmls
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.2.3
+signing_key: 
+specification_version: 4
+summary: Check that constraints in storyboards and xibs have constraints identifiers.
+test_files: []