dep_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4ca40a4559da05ca3d360b7086bbb736d7fa739
+  data.tar.gz: bbb084ba4e7f24567dd2a3f68a6fa811e43160f6
+SHA512:
+  metadata.gz: 327601748f93d1726d9ab698db95ae49ca23e55d602f61675413682178f7c58ef2167f13a7442027994f23882b826d420b2f931b507665fead107875ea9d9a42
+  data.tar.gz: d66c2185ab1b869d40d6c31f5bbd44f7724f8e186d0e96c2b74581ae032d8886adfd15d0c1dded1bc91b195f90e85658ab2fad5937b99009995c1a6d82a1d01d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at lj94409@alipay.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dep_check.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 卡迩
+
+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,41 @@
+# DepCheck
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dep_check`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dep_check'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dep_check
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/dep_check. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/depcheck

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dep_check"
+
+ DepCheck::DepChecker.run(ARGV)
+

data/bin/setup

@@ -0,0 +1,9 @@
+#!/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
+brew install graphviz

data/dep_check.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dep_check/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dep_check"
+  spec.version       = DepCheck::VERSION
+  spec.authors       = ["卡迩"]
+  spec.email         = ["lj94409@alipay.com"]
+
+  spec.summary       = %q{Circular depency checker for cocoapods based project. }
+  spec.description   = %q{Circular depency checker for cocoapods based project. Use Graphviz for visualize the dependency graph.}
+  spec.homepage      = "http://gitlab.alipay-inc.com/lj94409"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "ruby-graphviz", "~> 1.2"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "cocoapods"
+
+end

data/lib/dep_check.rb

@@ -0,0 +1,9 @@
+require "dep_check/version"
+require 'rubygems'
+
+module DepCheck
+  # Your code goes here...
+  require  'dep_check/DepChecker'
+  
+
+end

data/lib/dep_check/CircularDependencyError.rb

@@ -0,0 +1,29 @@
+#循环依赖检测时用到的一个异常类型,便于抛异常时传递参数
+class CircularDependencyError < StandardError
+  attr_accessor :from
+  attr_accessor :to 
+  attr_accessor :path
+  attr_accessor :message
+
+  # @param [String]         from      循环依赖上端点
+  # @param [String]         to        循环依赖下端点
+  # @param [Array<String>]  path      循环依赖路径上的节点名
+  # @param [String]         message   附加消息
+  def initialize(from, to , path , message = 'Circular dependency detected!')
+    @from = from
+    @to = to
+    @path = path
+    @message = message
+  end
+
+  def to_s
+    path_message = String.new
+    @path.each { |name|
+      path_message << name + '--->'
+    }
+    path_message << @to
+
+    "#{super} \n #{@message} \n #{@from} <---> #{@to} . \n Full Path: #{path_message} "
+  end
+  
+end

data/lib/dep_check/DepChecker.rb

@@ -0,0 +1,203 @@
+# encoding: utf-8
+#依赖关系校验类
+
+  require 'cocoapods'
+  require "dep_check/CircularDependencyError"
+  require "dep_check/Node"
+  require 'claide'
+  require 'colored'
+
+module DepCheck
+  class DepChecker < CLAide::Command
+
+     self.abstract_command = true
+
+     self.description = <<-DESC
+        cocoapods依赖关系校验. 查找循环依赖路径/构建模块依赖关系图.
+      DESC
+     self.command = 'depcheck'
+
+     self.summary = "cocoapods依赖关系校验"
+
+      def self.options
+        [
+          ['--repo=[master|other_repo_name]', 'Use a cocoapods spec repo to run the check, defaults to master'],
+          ['--repo-update', 'Fetch external podspecs and run `pod repo update` before calculating the dependency graph'],
+          ['--graphviz', 'Outputs the dependency graph in Graphviz format to <podspec name>.gv or Podfile.gv'],
+          ['--image', 'Outputs the dependency graph as an image to <podsepc name>.png or Podfile.png'],
+        ].concat(super)
+      end
+
+      def self.arguments
+        [
+          CLAide::Argument.new('PODSPEC', false)
+        ].concat(super)
+      end
+
+      def initialize(argv)
+        @podspec_name = argv.shift_argument
+        @repo_name =  argv.option('repo', 'master')
+        @repo_update = argv.flag?('repo-update', false)
+        @produce_graphviz_output = argv.flag?('graphviz', false)
+        @produce_image_output = argv.flag?('image', false)
+        super
+      end
+
+      def validate!
+        super
+        if @podspec_name
+          require 'pathname'
+          path = Pathname.new(@podspec_name)
+          if path.exist?
+            @podspec = Specification.from_file(path)
+          else
+            @podspec = SourcesManager.
+              search(Dependency.new(@podspec_name)).
+              specification.
+              subspec_by_name(@podspec_name)
+          end
+        end
+        if (@produce_image_output || @produce_graphviz_output) && Executable.which('dot').nil?
+          raise Informative, 'GraphViz must be installed and `dot` must be in ' \
+            '$PATH to produce image or graphviz output.'
+        end
+      end
+
+
+      def run
+        builded = []
+        Pod::UI.puts "1. Buiding dependency graph for #{@podspec_name}... \n ".green
+        Pod::UI.puts "All dependencies : \n".blue
+        dep_graph_build(@repo_name,@podspec_name,builded,[]) 
+        Pod::UI.puts "Done! \n".blue
+
+
+        Pod::UI.puts "2. Circular dependency check #{@podspec_name}... \n".green
+        unresolved = []
+        begin
+          dep_resolve(builded.first,[],unresolved)
+        rescue Exception => e
+          Pod::UI.puts e.to_s.red
+          circular_found = true
+        end
+        if !circular_found
+          Pod::UI.puts "No Circular dependency found! \n".green
+        end
+        Pod::UI.puts "Done! \n".blue
+
+        if @produce_image_output || @produce_graphviz_output
+            Pod::UI.puts "3. Visualizing graph for #{@podspec_name}... \n".green
+        end
+        graphviz_image_output(graphviz_data(builded,@podspec_name),@podspec_name)  if @produce_image_output
+        graph_dot_output(graphviz_data(builded,@podspec_name),@podspec_name) if @produce_graphviz_output
+
+      end
+
+
+
+
+    #通过模块名称或者模块podspec文件路径 得到一个spec[Specification]对象
+    def podspec_with_name(repo, name)
+      if name
+        path = Pathname.new(name)
+        if path.exist?
+          podspec = Pod::Specification.from_file(path)
+        else
+          podspec = repo.specification(name,repo.versions(name).first)
+        end
+      end
+    end
+
+    # 构建依赖关系图 
+    # @param [Source]         repo    依赖关系图建立过程中使用的podspec仓库
+    # @param [Specification]  spec    待构建的spec
+    # @param [Array<Node>]    builded 已经构建完成的Node数组
+    # @param [Array<Node>]    nodes   已经存在的Node数组
+    def dep_graph_build(repo,spec,builded,nodes)
+
+        node = unique_node(spec.attributes_hash['name'],nodes)
+        # puts "resolving  " + node.name
+        builded.push(node)
+      
+        tunples = spec.all_dependencies.map { |dep| 
+            {:node => unique_node(dep.name,nodes),:dep => dep}
+        }
+
+        tunples.each { |t|
+            node.addEdge(t[:node])
+        }
+
+        tunples.each { |t|
+            dep_spec =  podspec_with_name(repo,t[:dep].name)
+            if builded.count(t[:node]) == 0
+                dep_graph_build(repo,dep_spec,builded,nodes)
+            end
+        }
+        return builded
+    end
+
+    # 循环依赖检测算法实现
+    def dep_resolve(node, resolved, unresolved)
+      unresolved.push(node)
+      node.edges.each { |edge|
+         if resolved.count(edge) == 0 #if edge not in resolved
+            if unresolved.count(edge) != 0 #if edge in unresolved
+                path = []
+                unresolved.each { |n| path << n.name }
+                Pod::UI.puts "ERROR: Circular dependency detected! #{node.name} <---> #{edge.name}".red
+                raise  CircularDependencyError.new(node.name,edge.name,path) 
+            end
+            dep_resolve(edge, resolved, unresolved)
+         end
+      }
+      resolved.push(node)
+      unresolved.delete(node)
+    end
+
+    # 通过节点名称获得一个唯一的节点
+    def unique_node(name,nodes)
+        exist_nodes = nodes.select { |n| n.name == name }
+        if exist_nodes.empty?
+            node = Node.new(name)
+            nodes.push(node)
+        else
+            node = exist_nodes.first
+        end
+        node
+    end
+
+
+    #利用 GraphViz 构建可视化图数据 
+    def graphviz_data(builded, output_file_basename)
+      @graphviz ||= begin
+        require 'graphviz'
+        graph = GraphViz::new(output_file_basename, :type => :digraph)
+        builded.each { |node|
+            graph_node_from = graph.add_node(node.name)
+            if !node.edges.empty?
+                node.edges.each { |subNode|
+                  graph_node_to = graph.add_node(subNode.name)
+                  graph.add_edge(graph_node_from,graph_node_to)
+                } 
+            end
+        }
+        graph
+      end
+    end
+
+    # 以.png格式输出一个依赖关系图
+    def graph_image_out(graph, output_file_basename)
+        graph.output( :png => "#{output_file_basename}.png")
+    end
+
+
+    # 以.gv格式输出一个依赖关系图
+    def graph_dot_output(graph, output_file_basename)
+      graph.output( :dot => "#{output_file_basename}.gv")
+    end
+
+  end
+end
+
+
+

data/lib/dep_check/Node.rb

@@ -0,0 +1,27 @@
+#依赖关系图中的一个Node
+module DepCheck
+  class Node
+    attr_accessor :edges
+    attr_accessor :name
+    def initialize(name)
+      @name = name
+      @edges = []
+    end
+    
+    def addEdge(node)
+      @edges.push(node)
+    end
+    
+    def ==(other)
+      @name == other.name
+    end
+
+    def to_hash
+      {:name=>@name,:edges=>@edges}
+    end
+
+    def to_s
+      @name
+    end
+  end
+end

data/lib/dep_check/version.rb

@@ -0,0 +1,3 @@
+module DepCheck
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: dep_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 卡迩
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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: cocoapods
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Circular depency checker for cocoapods based project. Use Graphviz for
+  visualize the dependency graph.
+email:
+- lj94409@alipay.com
+executables:
+- depcheck
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/depcheck
+- bin/setup
+- dep_check.gemspec
+- lib/dep_check.rb
+- lib/dep_check/CircularDependencyError.rb
+- lib/dep_check/DepChecker.rb
+- lib/dep_check/Node.rb
+- lib/dep_check/version.rb
+homepage: http://gitlab.alipay-inc.com/lj94409
+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.1
+signing_key: 
+specification_version: 4
+summary: Circular depency checker for cocoapods based project.
+test_files: []