Class: ObjCDependencyTreeGenerator

Inherits:
Object
  • Object
show all
Defined in:
lib/objc_dependency_tree_generator.rb

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ObjCDependencyTreeGenerator

Returns a new instance of ObjCDependencyTreeGenerator.



11
12
13
14
15
16
17
 
# File 'lib/objc_dependency_tree_generator.rb', line 11

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_directories = @options[:search_directories]
end

Class Method Details

.parse_command_line_options ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/objc_dependency_tree_generator.rb', line 19

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' ,'Path to directory where are your .o files were placed by the compiler', Array) { |directory|
      options[:search_directories] = Array(options[:search_directories]) | Array(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' 'Target of project', Array) { |target_name|
      options[:target_names] = Array(options[:target_names]) | Array(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 [dot|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

Instance Method Details

#dependencies_to_s ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/objc_dependency_tree_generator.rb', line 104

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

  if @options[:output_format] == 'dot'
    indent = "\t"
    s = "digraph dependencies {\n#{indent}node [fontname=monospace, fontsize=9, shape=box, style=rounded]\n"
    json_links.each do |link|
      s += "#{indent}\"#{link['source']}\" -> \"#{link['dest']}\"\n"
    end
    s += "}\n"
  else
    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'
  end
  s
end

#find_dependencies ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/objc_dependency_tree_generator.rb', line 67

def find_dependencies
  if !@options or @options.empty?
    return {}
  end

  unless @object_files_directories
    @object_files_directories =
        find_project_output_directory(@options[:derived_data_paths],
                                      @options[:project_name],
                                      @options[:derived_data_project_pattern],
                                      @options[:target_names])
    return {} unless @object_files_directories
  end

  unless @object_files_directories
    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_directories, &links_block)
  else
    ObjcDependenciesGenerator.new.generate_dependencies(@object_files_directories, @options[:use_dwarf], &links_block)
  end

  links
end