objc-dependency-tree-generator 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b6b0351faa1f74bd5a917b14aa2e7128a691072
+  data.tar.gz: da939623b1714a74fc5d169138aa05811a9f77dc
+SHA512:
+  metadata.gz: 6c8f1df4fb705e21ac0483e70d5a970eabf971b930adb4cd61135c854588b78fbfa31c28aef2dfc14f0edc42aec5c2c7d8ef90209d3e7ce8fdc23ffb00826ae7
+  data.tar.gz: 543b476b3a16346fc2438dbcb812925d3eac677198b1e864940cfd01ffdc66a2a2386725a8932be0f5c0e6111227852c84d86524e05e2a081d9216de66fa7a29

data/bin/objc_dependency_tree_generator

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require 'objc_dependency_tree_generator'
+
+# resolve options from command line
+options = ObjCDependencyTreeGenerator.parse_command_line_options
+
+# creating generator
+generator = ObjCDependencyTreeGenerator.new options
+
+puts generator.dependencies_to_s

data/lib/objc_dependencies_generator.rb

@@ -0,0 +1,61 @@
+class ObjcDependenciesGenerator
+
+  def generate_dependencies(object_files_dir, include_dwarf_info)
+
+    #Searching all the .o files and showing its information through nm call
+    symbol_names_in_files_in_dir(object_files_dir) do |line|
+      # See of output here
+      # https://gist.github.com/PaulTaykalo/8d2618ea9741ea772004
+
+      # Capturing filename as a source and class name as the dest
+      match = /[^\w]*([^\.\/]+)\.o.*_OBJC_CLASS_\$_(.*)/.match(line)
+      next unless match
+
+      source, dest = match[1, 2]
+
+      yield source, dest
+    end
+
+    return unless include_dwarf_info
+
+    object_files_in_dir(object_files_dir) do |filename|
+
+      source = /.*\/(.+)\.o/.match(filename)[1]
+      yield source, nil
+
+      # Full output example https://gist.github.com/PaulTaykalo/62cd5d545301c8355cb5
+      # With grep output example https://gist.github.com/PaulTaykalo/9d5ecbce8a30a412cdbe
+      dwarfdump_tag_pointers_in_file(filename) do |tag_pointer_line|
+
+        # Finding the name in types
+        # AT_type( {0x00000456} ( objc_object ) )
+        tag_pointer_for_class = /.*?AT_type\(\s\{.*?\}.*\(\s((function|const)\s)?([A-Z][^\)]+?)\*?\s\).*/.match(tag_pointer_line)
+        next unless tag_pointer_for_class
+
+        dest = tag_pointer_for_class[3]
+
+        yield source, dest
+      end
+    end
+  end
+
+  def symbol_names_in_files_in_dir(object_files_dir)
+    IO.popen("find \"#{object_files_dir}\" -name \"*.o\" -exec /usr/bin/nm -o {} \\;") { |f|
+      f.each { |line| yield line }
+    }
+  end
+
+  def object_files_in_dir(object_files_dir)
+    IO.popen("find \"#{object_files_dir}\" -name \"*.o\"") { |f|
+      f.each { |line| yield line }
+    }
+  end
+
+  def dwarfdump_tag_pointers_in_file(filename)
+    IO.popen("dwarfdump \"#{filename.strip}\" | grep -A1 TAG_pointer_type") { |fd|
+      fd.each { |line| yield line }
+    }
+  end
+
+
+end

data/lib/objc_dependency_tree_generator.rb

@@ -0,0 +1,135 @@
+# encoding: UTF-8
+require 'optparse'
+require 'yaml'
+require 'json'
+require 'objc_dependency_tree_generator_helper'
+require 'swift_dependencies_generator'
+require 'objc_dependencies_generator'
+
+class ObjCDependencyTreeGenerator
+
+  def initialize(options)
+    @options = options
+    @options[:derived_data_project_pattern] = '*-*' unless @options[:derived_data_project_pattern]
+
+    @exclusion_prefixes = @options[:exclusion_prefixes] ? @options[:exclusion_prefixes] : 'NS|UI|CA|CG|CI|CF'
+    @object_files_directory = @options[:search_directory]
+  end
+
+  def self.parse_command_line_options
+    options = {}
+
+#Defaults
+    options[:derived_data_paths] = ['~/Library/Developer/Xcode/DerivedData', '~/Library/Caches/appCode*/DerivedData']
+    options[:project_name] = ''
+    options[:output_format] = 'json'
+
+
+    parser = OptionParser.new do |o|
+      o.separator 'General options:'
+
+      o.on('-p PATH', 'Path to directory where are your .o files were placed by the compiler') { |directory|
+        options[:search_directory] = directory
+      }
+      o.on('-D DERIVED_DATA', 'Path to directory where DerivedData is') { |derived_data|
+        options[:derived_data_paths] = [derived_data]
+        options[:derived_data_project_pattern] = '*'
+      }
+      o.on('-s PROJECT_NAME', 'Search project .o files by specified project name') { |project_name|
+        options[:project_name] = project_name
+      }
+      o.on('-t TARGET_NAME', 'Target of project') { |target_name|
+        options[:target_name] = target_name
+      }
+      o.on('-e PREFIXES', "Prefixes of classes those will be exсluded from visualization. \n\t\t\t\t\tNS|UI\n\t\t\t\t\tUI|CA|MF") { |exclusion_prefixes|
+        options[:exclusion_prefixes] = exclusion_prefixes
+      }
+
+      o.on('-d', '--use-dwarf-info', 'Use DWARF Information also') { |v|
+        options[:use_dwarf] = v
+      }
+      o.on('-w', '--swift-dependencies', 'Generate swift project dependencies') { |v|
+        options[:swift_dependencies] = v
+      }
+      o.on('-f FORMAT', 'Output format. json by default. Possible values are [json-pretty|json|json-var|yaml]') { |f|
+        options[:output_format] = f
+      }
+
+      o.separator 'Common options:'
+      o.on_tail('-h', 'Prints this help') { puts o; exit }
+      o.parse!
+    end
+
+    options
+
+  end
+
+  def find_dependencies
+    if !@options or @options.empty?
+      return {}
+    end
+
+    unless @object_files_directory
+      @object_files_directory =
+          find_project_output_directory(@options[:derived_data_paths],
+                                        @options[:project_name],
+                                        @options[:derived_data_project_pattern],
+                                        @options[:target_name])
+      return {} unless @object_files_directory
+    end
+
+    unless @object_files_directory
+      puts parser.help
+      exit 1
+    end
+
+
+    links = {}
+    links_block = lambda { |source, dest|
+      links[source] = {} unless links[source]
+      if source != dest and is_valid_dest?(dest, @exclusion_prefixes)
+        links[source][dest] = 'set up'
+      end
+    }
+
+    if @options[:swift_dependencies]
+      SwiftDependenciesGenerator.new.generate_dependencies(@object_files_directory, &links_block)
+    else
+      ObjcDependenciesGenerator.new.generate_dependencies(@object_files_directory, @options[:use_dwarf], &links_block)
+    end
+
+    links
+  end
+
+  def dependencies_to_s
+    links = find_dependencies
+    s = ''
+    if @options[:output_format] == 'json-var'
+      s+= <<-THEEND
+   var dependencies =
+      THEEND
+    end
+
+    json_result = {}
+    json_links = []
+
+    links_count = 0
+    links.each do |source, dest_hash|
+      links_count = links_count + dest_hash.length
+      dest_hash.each do |dest, _|
+        json_links += [{'source' => source, 'dest' => dest}]
+      end
+    end
+    json_result['links'] = json_links
+    json_result['source_files_count'] = links.length
+    json_result['links_count'] = links_count
+
+
+    s = s + JSON.pretty_generate(json_result) if @options[:output_format] == 'json-pretty'
+    s = s + json_result.to_json if @options[:output_format] == 'json' || @options[:output_format] == 'json-var'
+    s = s + json_result.to_yaml if @options[:output_format] == 'yaml'
+    s
+  end
+
+
+end

data/lib/objc_dependency_tree_generator_helper.rb

@@ -0,0 +1,55 @@
+def find_project_output_directory(derived_data_paths, project_prefix, project_suffix_pattern, target_name)
+
+  return nil unless derived_data_paths
+
+  paths = []
+
+  # looking for derived data
+  derived_data_paths.each do |derived_data_path|
+    IO.popen("find #{derived_data_path} -depth 1 -name \"#{project_prefix}#{project_suffix_pattern}\" -type d  -exec find {} -name \"i386\" -o -name \"armv*\" -o -name \"x86_64\" -type d \\; ") { |f|
+      f.each do |line|
+        paths << line
+      end
+    }
+  end
+
+  $stderr.puts "There were #{paths.length} directories found"
+  if paths.empty?
+    $stderr.puts "Cannot find projects that starts with '#{project_prefix}'"
+    exit 1
+  end
+
+  filtered_by_target_paths = paths
+
+  if target_name
+    filtered_by_target_paths = paths.find_all { |path| /#{target_name}[^\.]*\.build\/Objects-normal/.match path }
+    $stderr.puts "After target filtration there is #{filtered_by_target_paths.length} directories left"
+    if paths.empty?
+      $stderr.puts "Cannot find projects that starts with '#{project_prefix}'' and has target name that starts with '#{target_name}'"
+      exit 1
+    end
+  end
+
+  paths_sorted_by_time = filtered_by_target_paths.sort_by { |f| File.ctime(f.chomp) }
+
+  last_modified_dir = paths_sorted_by_time.last.chomp
+  $stderr.puts "Last modifications were in\n#{last_modified_dir}\ndirectory at\n#{File.ctime(last_modified_dir)}"
+
+  last_modified_dir
+end
+
+def is_primitive_swift_type?(dest)
+  /^(BOOL|Int|Int32|Int64|Int16|Int8|UInt|UInt32|UInt64|UInt16|UInt8|String|Character|Bool|Float|Double|Dictionary|Array|Set|AnyObject|Void)$/.match(dest) != nil
+end
+
+def is_filtered_swift_type?(dest)
+  /(ClusterType|ScalarType|LiteralType)$/.match(dest) != nil #or /^([a-z])/.match(dest) != nil
+end
+
+def is_filtered_objc_type?(dest)
+  /^(dispatch_)|(DISPATCH_)/.match(dest) != nil #or /^([a-z])/.match(dest) != nil
+end
+
+def is_valid_dest?(dest, exclusion_prefixes)
+  dest != nil and /^(#{exclusion_prefixes})/.match(dest) == nil and /^(<\s)?\w/.match(dest) != nil and !is_primitive_swift_type?(dest) and !is_filtered_swift_type?(dest) and !is_filtered_objc_type?(dest)
+end

data/lib/swift_dependencies_generator.rb

@@ -0,0 +1,56 @@
+class SwiftDependenciesGenerator
+
+  def generate_dependencies(object_files_dir)
+    # This thing need to be commented :) It's removes too many connections
+    # YAML.add_domain_type("", "private") { |type, val|
+    #   'AnyObject'
+    # }
+
+    swift_deps_files_in_dir(object_files_dir) do |my_text_file|
+      # puts my_text_file
+      begin
+        dependencies = YAML.load_file(my_text_file)
+      rescue Exception => e
+        $stderr.puts 'Cannot read file  ' + my_text_file + ' : This is possibly because output file was changed:' + e.message
+        next
+      end
+      provided_objs = dependencies['provides']
+      top_level_deps = dependencies['top-level']
+
+      # support Xcode 7 format
+      provided_objs = dependencies['provides-top-level'] if provided_objs.nil?
+      top_level_deps = dependencies['depends-top-level'] if top_level_deps.nil?
+
+      next if provided_objs.nil?
+      next if top_level_deps.nil?
+
+      if provided_objs.length == 1
+        provided_objs.each do |source|
+          yield source, nil
+          top_level_deps.each do |dest|
+            yield source, dest unless provided_objs.include?(dest)
+          end
+        end
+
+      else
+
+        filename = '< ' + File.basename(my_text_file, '.swiftdeps') +' >'
+        provided_objs.each do |source|
+          yield source, filename
+        end
+
+        yield filename, nil
+
+        top_level_deps.each do |dest|
+          yield filename, dest unless provided_objs.include?(dest)
+        end
+      end
+    end
+  end
+
+  def swift_deps_files_in_dir(object_files_dir)
+    Dir.glob("#{object_files_dir}/*.swiftdeps") { |file| yield file }
+  end
+
+
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: objc-dependency-tree-generator
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Paul Taykalo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-20 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Tool that allows to generate Objective-C and Swift dependency tree from object files
+  For usages examples run:
+  objc_dependency_tree_generator -h
+email: tt.kilew@gmail.com
+executables:
+- objc_dependency_tree_generator
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/objc_dependency_tree_generator.rb
+- lib/objc_dependency_tree_generator_helper.rb
+- lib/objc_dependencies_generator.rb
+- lib/swift_dependencies_generator.rb
+- bin/objc_dependency_tree_generator
+homepage: https://github.com/PaulTaykalo/objc-dependency-visualizer
+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.14
+signing_key: 
+specification_version: 4
+summary: Objective-C and Swift dependency tree generator
+test_files: []