cocoapods-dependency-graph 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f7e970165190f39fda0730defde8735b2adfb0ba85cc6a35add519dc0f3e55b6
+  data.tar.gz: b4d5435fb27e0eab9b8fc747926aa5080f59c6f13a8f3bac857e01d92f739c82
+SHA512:
+  metadata.gz: 0ead64f867b33a4bfa127574ee90672461b9c2e6ff6c1259a705168bd5e0c13b8790c18016b9200be7a6acb265b569c0be7512d626ba1b9569b84a4f95d1ea9f
+  data.tar.gz: 9ae60778070e00ebb18f47b2ba87bec61881d899a8552b4000dae0304058e27d2b7513c68f9f85fa7cdeae28802d270fd71939c76c12de9eb701df5d060650e1

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg
+.idea/

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cocoapods-dependency-graph.gemspec
+gemspec
+
+group :development do
+  gem 'cocoapods'
+
+  gem 'mocha'
+  gem 'bacon'
+  gem 'mocha-on-bacon'
+  gem 'prettybacon'
+  gem 'fast_excel'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 RY Zheng
+
+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,54 @@
+# cocoapods-dependency-graph
+
+A Cocoapods plugin to create the dependency graph and help you manage dependencies in your project.
+
+
+## Installation
+### Install Dependency 
+    $ gem install rgl
+
+### Install 
+
+```
+$ gem install cocoapods-dependency-graph
+```
+
+### Build and Install Plugin
+
+    $ git clone git@github.com:sueLan/cocoapods-dependency-graph.git
+    $ cd cocoapods-dependency-graph
+    $ gem build cocoapods-dependency-graph.gemspec  && gem install cocoapods-dependency-graph  --user-install
+
+## Usage 
+
+1. add `plugin` in the `Podfile`
+
+```
+plugin 'cocoapods-dependency-graph'
+```
+
+2. run `pod install` 
+3. output files in the project folder
+
+In the `Podfile`, you can define `dependency_output` to decide which kind of output file this plugin generates. 
+
+```
+dependency_output :json 
+dependency_output :excel
+dependency_output :graph
+```
+There are 3 symbols to control the output format. You can choose one of them. If you don't define `dependency_output`, by default, this plugin generates `graph.jpg` and `graph.dot`. 
+
+The following are output files you can generate: 
+
+- `dependency_json.json`: JSON file for dependencies. You can view the json in any JSON becauty tool you like. 
+
+  <img src="README.assets/image-20201007205410006.png" alt="image-20201007205410006" style="zoom:50%;" />
+
+- `graph.jpg`: A png picture shows the dependency graph
+
+  ![image-20201007213841235](README.assets/image-20201007213841235.png)
+
+- `graph.dot`: A dot file which represents the dependency graph. [A site](https://dreampuf.github.io/GraphvizOnline/) that can process the dot language.  Or you can use [Graphviz](https://www.graphviz.org/theory/)
+
+- `cocoapods-dependency-list.xlsx`: xlsx file for dependency list.  

data/Rakefile

@@ -0,0 +1,13 @@
+require 'bundler/gem_tasks'
+
+def specs(dir)
+  FileList["spec/#{dir}/*_spec.rb"].shuffle.join(' ')
+end
+
+desc 'Runs all the specs'
+task :specs do
+  sh "bundle exec bacon #{specs('**')}"
+end
+
+task :default => :specs
+

data/cocoapods-dependency-graph.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cocoapods-dependency-graph/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cocoapods-dependency-graph'
+  spec.version       = CocoapodsDependencyGraph::VERSION
+  spec.authors       = ['Rongyan Zheng']
+  spec.email         = ['scutryzheng@gmail.com']
+  spec.description   = %q{A short description of cocoapods-dependency-graph.}
+  spec.summary       = %q{A longer description of cocoapods-dependency-graph.}
+  spec.homepage      = 'https://github.com/EXAMPLE/cocoapods-dependency-graph'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/cocoapods-dependency-graph/command.rb

@@ -0,0 +1 @@
+require 'cocoapods-dependency-graph/command/graph'

data/lib/cocoapods-dependency-graph/command/graph.rb

@@ -0,0 +1,44 @@
+module Pod
+  class Command
+    # This is an example of a cocoapods plugin adding a top-level subcommand
+    # to the 'pod' command.
+    #
+    # You can also create subcommands of existing or new commands. Say you
+    # wanted to add a subcommand to `list` to show newly deprecated pods,
+    # (e.g. `pod list deprecated`), there are a few things that would need
+    # to change.
+    #
+    # - move this file to `lib/pod/command/list/deprecated.rb` and update
+    #   the class to exist in the the Pod::Command::List namespace
+    # - change this class to extend from `List` instead of `Command`. This
+    #   tells the plugin system that it is a subcommand of `list`.
+    # - edit `lib/cocoapods_plugins.rb` to require this file
+    #
+    # @todo Create a PR to add your plugin to CocoaPods/cocoapods.org
+    #       in the `plugins.json` file, once your plugin is released.
+    #
+    class Dependency < Command
+      self.summary = 'Short description of cocoapods-dependency-graph.'
+
+      self.description = <<-DESC
+        Longer description of cocoapods-dependency-graph.
+      DESC
+
+      self.arguments = 'NAME'
+
+      def initialize(argv)
+        @name = argv.shift_argument
+        super
+      end
+
+      def validate!
+        super
+        help! 'A Pod name is required.' unless @name
+      end
+
+      def run
+        UI.puts "Add your implementation for the cocoapods-dependency-graph plugin in #{__FILE__}"
+      end
+    end
+  end
+end

data/lib/cocoapods-dependency-graph/gem_version.rb

@@ -0,0 +1,3 @@
+module CocoapodsDependencyGraph
+  VERSION = "1.0.2"
+end

data/lib/cocoapods-dependency-graph/generator/excel_generator.rb

@@ -0,0 +1,49 @@
+require 'fast_excel'
+
+module Dependency 
+  class ExcelGenerator
+    attr_accessor :workbook
+    attr_accessor :worksheet
+  
+    def create_excel
+      filename = 'cocoapods_dependency_list.xlsx' 
+      File.delete(filename) if File.file?(filename)
+
+      @workbook = FastExcel.open(filename, constant_memory: true)
+      @worksheet = workbook.add_worksheet("cocoapods-dependency-list")
+      @worksheet.auto_width = true
+    end
+
+    def create_title()
+      @worksheet.append_row(["module name", "local", "source", "version", "homepage", "summary"], @workbook.bold_format)
+    end
+
+    def create_row(spec) 
+      return unless spec.source
+      local = spec.local? if spec.source
+      summary = spec.root.attributes_hash['summary']
+      worksheet << [spec.module_name, local, spec.source, spec.version, spec.homepage, summary]
+    end
+
+    # @param [Array<Specification>] specs a list specification
+    def create_content(specs) 
+      specs.each { | spec | 
+        create_row(spec)
+      } 
+    end
+
+    def close_excel 
+      @workbook.close
+    end
+    
+    # @param  [UmbrellaTargetDescription] umbrella_target the CocoaPods umbrella targets generated by the installer.
+    # @param  [Hash{<String, Specification>}] module_spec_hash 
+    #
+    def generate(umbrella_target, module_spec_hash)
+      create_excel
+      create_title
+      create_content(umbrella_target.specs)
+      close_excel
+    end 
+  end
+end

data/lib/cocoapods-dependency-graph/generator/graph_generator.rb

@@ -0,0 +1,39 @@
+require 'rgl/adjacency'
+require 'rgl/dot'
+
+module Dependency 
+  class GraphGenerator 
+    def dependency_spces(spec) 
+      dependencies = []
+      spec.dependencies.each { | dependency |
+        d_spec = @module_spec_hash[dependency.name]
+        next unless d_spec.source
+        dependencies << d_spec 
+      }
+      dependencies
+    end
+
+    def dfs_graph(parent, specs) 
+      specs.each { | spec |
+        next unless spec.source
+        @graph.add_edge(parent, spec)
+        dfs_graph(spec, dependency_spces(spec))
+      }
+    end
+
+    # @param  [UmbrellaTargetDescription] umbrella_target the CocoaPods umbrella targets generated by the installer.
+    # @param  [Hash{<String, Specification>}] module_spec_hash 
+    #
+    def generate(umbrella_target, module_spec_hash)
+      @graph = RGL::DirectedAdjacencyGraph.new
+      @module_spec_hash = module_spec_hash
+       
+      target_name = umbrella_target.cocoapods_target_label
+      root_node = {:target => target_name} 
+      dfs_graph(root_node, umbrella_target.specs)
+      
+      @graph.print_dotted_on
+      @graph.write_to_graphic_file('jpg')
+    end
+  end
+end

data/lib/cocoapods-dependency-graph/generator/json_generator.rb

@@ -0,0 +1,66 @@
+require 'json'
+
+module Dependency 
+  class JsonGenerator 
+    # @param [Array<Specification>] specs a list specification
+    def create_hash(target_name, specs)
+      dependencies = Array.new
+      specs.each { | spec |
+        next unless spec.source
+        dependencies << SpecNode.new(spec).to_hash
+      }
+      
+      {:target_name => dependencies}
+    end
+
+    def self.module_spec_hash 
+      @@module_spec_hash
+    end
+
+    # @param  [UmbrellaTargetDescription] umbrella_target the CocoaPods umbrella targets generated by the installer.
+    # @param  [Hash{<String, Specification>}] module_spec_hash 
+    #
+    def generate(umbrella_target, module_spec_hash)
+      @@module_spec_hash = module_spec_hash
+      target_name = umbrella_target.cocoapods_target_label
+      dependency_hash = create_hash(target_name, umbrella_target.specs)
+      # puts dependency_hash.to_json
+      File.open("cocoapods_dependency_json.json","w") do |f|
+        f.write(dependency_hash.to_json)
+      end
+    end
+
+    class SpecNode 
+      def spec_brief_info(spec)
+        spec_brief = Hash.new
+        spec_brief[:name] = spec.name
+        spec_brief[:module_name] = spec.module_name
+        spec_brief[:source] = spec.source
+        spec_brief[:version] = spec.version
+        spec_brief[:homepage] = spec.homepage
+        spec_brief[:local] =  spec.local? if spec.source
+        spec_brief[:summary] = spec.root.attributes_hash['summary']
+        spec_brief[:subspec] = spec.subspecs 
+  
+        spec_brief
+      end
+
+      def initialize(spec) 
+        @name = spec_brief_info(spec)
+        @dependencies = []
+        spec.dependencies.each { | dependency |
+          d_spec = JsonGenerator.module_spec_hash[dependency.name]
+          next unless d_spec.source
+          @dependencies << SpecNode.new(d_spec).to_hash
+        }
+      end 
+
+      def to_hash() 
+        res = Hash.new
+        res[:name] = @name          
+        res[:dependencies] = @dependencies
+        res
+      end
+    end
+  end
+end

data/lib/cocoapods_dependency_graph.rb

@@ -0,0 +1,81 @@
+require 'cocoapods-dependency-graph/gem_version'
+require 'cocoapods'
+require 'fileutils'
+require_relative 'cocoapods-dependency-graph/generator/excel_generator'
+require_relative 'cocoapods-dependency-graph/generator/json_generator'
+require_relative 'cocoapods-dependency-graph/generator/graph_generator'
+
+module Output 
+  GRAPH = :graph
+  JSON = :json
+  EXCEL = :excel
+end
+
+# attr_accessor for class variable.
+def class_attr_accessor(symbol)
+    self.class.send(:attr_accessor, symbol)
+end
+
+module Pod    
+  class Podfile
+    module DSL
+      def dependency_output(output_symbol)
+        puts "read dependency_output #{output_symbol}"
+        DSL.dependency_output_format = output_symbol 
+      end
+
+      private
+      class_attr_accessor :dependency_output_format
+      DSL.dependency_output_format = Output::GRAPH
+    end
+  end
+end
+
+module Dependency
+  class Graph
+    attr_accessor :output_class_hash
+
+    def init_output_hash
+      @output_class_hash = {
+        :graph => 'Dependency::GraphGenerator', 
+        :json => 'Dependency::JsonGenerator', 
+        :excel => 'Dependency::ExcelGenerator'
+      }
+    end
+
+    # @param [Array<UmbrellaTargetDescription>] The list of
+    #         the CocoaPods umbrella targets generated by the installer.
+    #
+    def generate(umbrella_targets)
+      unless umbrella_targets.length() > 0
+        puts "No target detected"
+      end
+
+      umbrella_target = umbrella_targets[0]
+      
+      module_spec_hash = {}
+      umbrella_target.specs.each { | spec |
+        module_spec_hash[spec.name] = spec
+      } 
+      
+      init_output_hash
+      output_key = Pod::Podfile::DSL.dependency_output_format
+      puts "#{output_key} key"
+      output_key = Output::GRAPH unless output_key
+    
+      puts "output key #{output_key}, #{@output_class_hash}"
+      generator_string = @output_class_hash[output_key]
+
+      puts "gen #{generator_string}"
+      unless generator_string 
+        puts "The dependency_output should be one of #{Output::GRAPH}, #{Output::JSON}, and #{Output::EXCEL}"
+        return 
+      end
+
+      generator_class = Object.const_get(generator_string)
+      puts "gener class #{generator_class}"
+      generator_class.new.generate(umbrella_target,module_spec_hash)
+    end
+  end
+end
+

data/lib/cocoapods_plugin.rb

@@ -0,0 +1,9 @@
+require 'cocoapods-dependency-graph/command'
+require_relative 'cocoapods_dependency_graph'
+
+module Dependency
+  # Register the post_install hook. The context is passed when running block 
+  Pod::HooksManager.register('cocoapods-dependency-graph', :post_install) do |installer_context|
+    Graph.new.generate(installer_context.umbrella_targets)
+  end
+end

data/spec/command/graph_spec.rb

@@ -0,0 +1,12 @@
+require File.expand_path('../../spec_helper', __FILE__)
+
+module Pod
+  describe Command::Graph do
+    describe 'CLAide' do
+      it 'registers it self' do
+        Command.parse(%w{ graph }).should.be.instance_of Command::Graph
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'pathname'
+ROOT = Pathname.new(File.expand_path('../../', __FILE__))
+$:.unshift((ROOT + 'lib').to_s)
+$:.unshift((ROOT + 'spec').to_s)
+
+require 'bundler/setup'
+require 'bacon'
+require 'mocha-on-bacon'
+require 'pretty_bacon'
+require 'pathname'
+require 'cocoapods'
+
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+
+require 'cocoapods_plugin'
+
+#-----------------------------------------------------------------------------#
+
+module Pod
+
+  # Disable the wrapping so the output is deterministic in the tests.
+  #
+  UI.disable_wrap = true
+
+  # Redirects the messages to an internal store.
+  #
+  module UI
+    @output = ''
+    @warnings = ''
+
+    class << self
+      attr_accessor :output
+      attr_accessor :warnings
+
+      def puts(message = '')
+        @output << "#{message}\n"
+      end
+
+      def warn(message = '', actions = [])
+        @warnings << "#{message}\n"
+      end
+
+      def print(message)
+        @output << message
+      end
+    end
+  end
+end
+
+#-----------------------------------------------------------------------------#

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: cocoapods-dependency-graph
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Rongyan Zheng
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-22 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'
+description: A short description of cocoapods-dependency-graph.
+email:
+- scutryzheng@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cocoapods-dependency-graph.gemspec
+- lib/cocoapods-dependency-graph/command.rb
+- lib/cocoapods-dependency-graph/command/graph.rb
+- lib/cocoapods-dependency-graph/gem_version.rb
+- lib/cocoapods-dependency-graph/generator/excel_generator.rb
+- lib/cocoapods-dependency-graph/generator/graph_generator.rb
+- lib/cocoapods-dependency-graph/generator/json_generator.rb
+- lib/cocoapods_dependency_graph.rb
+- lib/cocoapods_plugin.rb
+- spec/command/graph_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/EXAMPLE/cocoapods-dependency-graph
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A longer description of cocoapods-dependency-graph.
+test_files:
+- spec/command/graph_spec.rb
+- spec/spec_helper.rb