dependy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b4acecc9e415eba14a8d7121602594c4dac663e
+  data.tar.gz: 38092ec7142d20edb7c692ce32287ec09e390d09
+SHA512:
+  metadata.gz: 13db82cec156decb88936c0bb66c5cc3888ce3a731ca1f3d1f082e1152bec4c40dcdd79d6ad8941b0a6bcc9b825c52c4341ae549d960c6d07d271a9fb91e2aba
+  data.tar.gz: 0e8609c51091d5d082fe6446a78b6e43c654a65df4cc1db847f3817b7b438ef85b664def18ee3ced9fb3ffa7489a74ce7bba36bd57ee98e6f61108b5dbbadcef

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,4 @@
+addons:
+  code_climate:
+    repo_token:
+      secure: 932d6a9695c9d94394b22f7de7e6f9f6261cc11c28f23718316396ea017a92db

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'travis', '~> 1.6.11'
+gem 'thor', '~> 0.19'
+
+gemspec
+
+group :development, :test do
+  gem 'codeclimate-test-reporter', '~> 0.3.0', require: false
+  gem 'rspec', '~> 2.14.1'
+  gem 'rake', '~> 10.1.0'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Slavko Krucaj
+
+MIT License
+
+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,7 @@
+# dependy [![Build Status](https://travis-ci.org/SlavkoKrucaj/dependy.svg?branch=master)](https://travis-ci.org/SlavkoKrucaj/dependy) [![Code Climate](https://codeclimate.com/github/SlavkoKrucaj/dependy/badges/gpa.svg)](https://codeclimate.com/github/SlavkoKrucaj/dependy) [![Test Coverage](https://codeclimate.com/github/SlavkoKrucaj/dependy/badges/coverage.svg)](https://codeclimate.com/github/SlavkoKrucaj/dependy)
+
+A gem command line tool which helps you maintain dependencies for `Objective-C` projects
+
+## License
+
+MIT license. See the LICENSE file for more info.

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks(name: 'dependy')
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+desc 'run specs'
+task default: :spec

data/bin/dependy

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../lib/dependy/cli'
+
+Dependy::Cli.start

data/dependy.gemspec

@@ -0,0 +1,14 @@
+# coding: utf-8
+Gem::Specification.new do |gem|
+  gem.name = 'dependy'
+  gem.version = '0.1.0'
+  gem.authors = ['Slavko Krucaj']
+  gem.email = ['slavko.krucaj@gmail.com']
+  gem.description = %q{Analyzing class dependency graphs}
+  gem.summary = %q{Tool for inspecting class dependency graphs}
+  gem.license = 'MIT'
+
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files = gem.files.grep(%r{^spec/})
+end

data/lib/dependy.rb

@@ -0,0 +1,6 @@
+require 'dependy/graph/graph_reader'
+require 'dependy/operations/cycle_finder'
+require 'dependy/operations/unused_nodes_finder'
+require 'dependy/operations/extractor'
+require 'dependy/operations/folder_extractor'
+

data/lib/dependy/cli.rb

@@ -0,0 +1,65 @@
+require 'thor'
+require 'dependy'
+
+module Dependy
+  class Cli < Thor
+    class_option :root_folder, type: :string, aliases: '-r', required: true, desc: 'Folder containing classes'
+    class_option :ignore_folders, type: :string, aliases: '-i', required: true, desc: 'Ignored folders'
+    class_option :pattern, type: :string, aliases: '-p', required: true, desc: 'Pattern you are looking for in the files, i.e. {h,m}'
+
+    desc 'cycle', 'Scans the folder, and looks for cycles in dependencies'
+    def cycle
+      cycle_finder.cycles.each { |cycle| p cycle }
+    end
+
+    desc 'unused', 'Scans the folder, and looks for unused files'
+    def unused
+      unused_nodes_finder.unused_nodes.each { |unused_node| p unused_node }
+    end
+
+    desc 'extract', 'Example of what you get if you try to extract file "ApiCall"'
+    method_option :file, type: :string, aliases: '-f', required: true, desc: 'File to extract'
+    def extract
+      puts extractor.extract([options[:file]])
+    end
+
+    desc 'folder', 'Example of what you get if you try to extract folder "ApiLayer"'
+    method_option :folder, type: :string, aliases: '-f', required: true, desc: 'Folder to extract from'
+    def folder
+      puts folder_extractor.extract(options[:folder], ['Helpers', 'Translator'])
+    end
+
+    private
+    def cycle_finder
+      Operations::CycleFinder.new(graph)
+    end
+
+    def unused_nodes_finder
+      Operations::UnusedNodesFinder.new(graph)
+    end
+
+    def extractor
+      Operations::Extractor.new(graph)
+    end
+
+    def folder_extractor
+      Operations::FolderExtractor.new(graph)
+    end
+
+    def graph
+      graph_reader.read
+    end
+
+    def graph_reader
+      Dependy::Graph::GraphReader.new(root_folder, [ignore_folder], '{h,m}')
+    end
+
+    def root_folder
+      options[:root_folder]
+    end
+
+    def ignore_folder
+      options[:ignore_folders].split(' ')
+    end
+  end
+end

data/lib/dependy/graph/graph.rb

@@ -0,0 +1,31 @@
+module Dependy
+  module Graph
+    class Graph < Hash
+      def initialize(parent_child_list = [])
+        parent_child_list.each do |parent, child|
+          add_node_to_graph(parent)
+          add_node_to_graph(child)
+          add_relationship_between(parent, child)
+        end
+      end
+
+      def parents_for(node_name)
+        self[node_name][:parents]
+      end
+
+      def children_for(node_name)
+        self[node_name][:children]
+      end
+
+      private
+      def add_node_to_graph(node_name)
+        self[node_name] = {parents: [], children: []} unless has_key?(node_name)
+      end
+
+      def add_relationship_between(parent, child)
+        self[parent][:children] << child
+        self[child][:parents] << parent
+      end
+    end
+  end
+end

data/lib/dependy/graph/graph_reader.rb

@@ -0,0 +1,53 @@
+require 'dependy/graph/graph'
+
+module Dependy
+  module Graph
+    class GraphReader
+      def initialize(root_folder, excluded_folders = [], pattern = '*')
+        @root_folder = root_folder
+        @excluded_folders = excluded_folders
+        @pattern = pattern
+      end
+
+      def read
+        Graph.new(objects_to_scan)
+      end
+
+      private
+      attr_reader :root_folder, :excluded_folders, :pattern
+
+      def objects_to_scan
+        Dir.glob(lookup_pattern(root_folder)).inject([]) do |result, file|
+          scan_file(file).map do |import|
+            result.push([filename(file), import]) unless import.empty?
+          end
+          result
+        end
+      end
+
+      def scan_file(file)
+        all_imports_in_file(file) - [filename(file)] - objects_to_exclude
+      end
+
+      def filename(file)
+        File.basename(file, '.*')
+      end
+
+      def objects_to_exclude
+        @objects_to_exclude ||= excluded_folders.map do |excluded_folder|
+          Dir.glob(lookup_pattern(excluded_folder)).map do |file|
+            File.basename(file, '.*')
+          end
+        end.flatten.uniq
+      end
+
+      def lookup_pattern(folder)
+        "#{folder}/**/*.#{pattern}"
+      end
+
+      def all_imports_in_file(file)
+        File.read(file).scan(/^#import "(.*)\.h"$/).flatten
+      end
+    end
+  end
+end

data/lib/dependy/operations/cycle_finder.rb

@@ -0,0 +1,27 @@
+require 'tsort'
+
+module Dependy
+  module Operations
+    class CycleFinder
+      def initialize(graph = {})
+        @graph = graph
+      end
+
+      def cycles
+        strongly_connected_components.select { |scc| scc.count > 1 }
+      end
+
+      private
+      include TSort
+      attr_reader :graph
+
+      def tsort_each_node(&block)
+        graph.each_key(&block)
+      end
+
+      def tsort_each_child(node_name, &block)
+        graph.children_for(node_name).each(&block)
+      end
+    end
+  end
+end

data/lib/dependy/operations/extractor.rb

@@ -0,0 +1,32 @@
+require 'dependy/graph/graph'
+
+module Dependy
+  module Operations
+    class Extractor
+      def initialize(graph = {})
+        @graph = graph
+      end
+
+      def extract(nodes = [], ignore_nodes = [])
+        nodes_to_extract(nodes) - ignore_nodes
+      end
+
+      private
+      attr_reader :graph
+
+      def nodes_to_extract(nodes)
+        nodes.map do |node_name|
+          extract_node(node_name)
+        end.flatten.uniq
+      end
+
+      def extract_node(node_name, current_result = [])
+        current_result << node_name
+        graph.children_for(node_name).each do |child_name|
+          extract_node(child_name, current_result) unless current_result.include?(child_name)
+        end
+        current_result
+      end
+    end
+  end
+end

data/lib/dependy/operations/folder_extractor.rb

@@ -0,0 +1,30 @@
+module Dependy
+  module Operations
+    class FolderExtractor
+
+      def initialize(graph)
+        @graph = graph
+        @extractor = Extractor.new(graph)
+      end
+
+      def extract(folders = [], ignore_nodes = [])
+        extractor.extract(all_nodes_in_folders(folders), ignore_nodes)
+      end
+
+      private
+      attr_reader :graph, :extractor
+
+      def all_nodes_in_folders(folders = [])
+        folders.map { |folder| scan_folder(folder) }.flatten.uniq
+      end
+
+      def scan_folder(folder)
+        Dir.glob(lookup_pattern(folder)).map { |file| File.basename(file, '.*') }
+      end
+
+      def lookup_pattern(folder)
+        "#{folder}/**/*{h,m}"
+      end
+    end
+  end
+end

data/lib/dependy/operations/unused_nodes_finder.rb

@@ -0,0 +1,18 @@
+require 'dependy/graph/graph'
+
+module Dependy
+  module Operations
+    class UnusedNodesFinder
+      def initialize(graph = {})
+        @graph = graph
+      end
+
+      def unused_nodes
+        graph.select { |node_name| graph.parents_for(node_name).count == 0 }.keys
+      end
+
+      private
+      attr_reader :graph
+    end
+  end
+end

data/spec/dependy/graph/graph_reader_spec.rb

@@ -0,0 +1,41 @@
+require 'dependy/graph/graph_reader'
+
+describe Dependy::Graph::GraphReader do
+  context 'when given all the info' do
+    subject(:graph) {
+      root_folder = 'spec/fixtures/root_folder'
+      ignore_folder = 'spec/fixtures/ignore_folder'
+      pattern = '{h,m}'
+      described_class.new(root_folder, [ignore_folder], pattern)
+    }
+
+    it 'reads the graph' do
+      expected = {
+        'File1' => {parents: [], children: ['File2', 'File4', 'File3']},
+        'File2' => {parents: ['File1'], children: ['File3']},
+        'File4' => {parents: ['File1'], children: []},
+        'File3' => {parents: ['File2', 'File1'], :children => []}
+      }
+      expect(subject.read).to eql(expected)
+    end
+  end
+
+  context 'when given only root folder' do
+    subject(:graph) {
+      root_folder = 'spec/fixtures/root_folder'
+      pattern = '{h,m}'
+      described_class.new(root_folder, [], pattern)
+    }
+
+    it 'reads the graph' do
+      expected = {
+        'File1' => {parents: [], children: ['File2', 'File4', 'File5', 'File3']},
+        'File2' => {parents: ['File1'], children: ['File3']},
+        'File4' => {parents: ['File1'], children: []},
+        'File5' => {parents: ['File1'], children: []},
+        'File3' => {parents: ['File2', 'File1'], :children => []}
+      }
+      expect(subject.read).to eql(expected)
+    end
+  end
+end

data/spec/dependy/graph/graph_spec.rb

@@ -0,0 +1,46 @@
+require 'dependy/graph/graph'
+
+describe Dependy::Graph::Graph do
+  subject(:graph) { described_class.new([%w(parent child)]) }
+
+  context 'when creating graph' do
+    before do
+      @expected_graph = {
+        'parent' => {parents: [], children: ['child']},
+        'child' => {parents: ['parent'], children: []}
+      }
+    end
+
+    it 'should properly setup relationships' do
+      expect(graph).to eql(@expected_graph)
+    end
+  end
+
+  describe '#parents_for' do
+    context 'when node contains parents' do
+      it 'returns an array of parents' do
+        expect(graph.parents_for('parent')).to eql([])
+      end
+    end
+
+    context 'when node does NOT contain parents' do
+      it 'returns an empty array' do
+        expect(graph.parents_for('child')).to eql(['parent'])
+      end
+    end
+  end
+
+  describe '#children_for' do
+    context 'when node contains children' do
+      it 'returns an array of children' do
+        expect(graph.children_for('parent')).to eql(['child'])
+      end
+    end
+
+    context 'when node does NOT contain children' do
+      it 'returns an empty array' do
+        expect(graph.children_for('child')).to eql([])
+      end
+    end
+  end
+end

data/spec/dependy/operations/cycle_finder_spec.rb

@@ -0,0 +1,20 @@
+require 'dependy/operations/cycle_finder'
+require_relative '../../spec_helper'
+
+describe Dependy::Operations::CycleFinder do
+  context 'when graph contains cycles' do
+    subject(:cycle_finder) { described_class.new(GraphFactory.graph_with_cycles) }
+
+    it 'returns an array of found cycles' do
+      expect(subject.cycles).to eql([['2', '3'], ['1', '4']])
+    end
+  end
+
+  context 'when graph does NOT contain cycles' do
+    subject(:cycle_finder) { described_class.new(GraphFactory.graph_without_cycles) }
+
+    it 'returns an empty array' do
+      expect(subject.cycles).to eql([])
+    end
+  end
+end

data/spec/dependy/operations/extractor_spec.rb

@@ -0,0 +1,14 @@
+require 'dependy/operations/extractor'
+require_relative '../../spec_helper'
+
+describe Dependy::Operations::Extractor do
+  subject(:extractor) { described_class.new(GraphFactory.graph_with_cycles) }
+
+  it 'extracts node and all of its parents' do
+    expect(subject.extract(['3'])).to eql(['3', '2'])
+  end
+
+  it 'should NOT extract ignored nodes' do
+    expect(subject.extract(['3'], ['2'])).to eql(['3'])
+  end
+end

data/spec/dependy/operations/unused_node_finder_spec.rb

@@ -0,0 +1,20 @@
+require 'dependy/operations/unused_nodes_finder'
+require_relative '../../spec_helper'
+
+describe Dependy::Operations::UnusedNodesFinder do
+  context 'when node with no parents exist' do
+    subject(:unused_node_finder) { described_class.new(GraphFactory.graph_without_cycles) }
+
+    it 'returns unused nodes' do
+      expect(subject.unused_nodes).to eql(['1'])
+    end
+  end
+
+  context 'when all the nodes are used' do
+    subject(:unused_node_finder) { described_class.new(GraphFactory.graph_with_cycles) }
+
+    it 'returns empty array' do
+      expect(subject.unused_nodes).to eql([])
+    end
+  end
+end

data/spec/fixtures/graph_factory.rb

@@ -0,0 +1,11 @@
+require 'dependy/graph/graph'
+
+class GraphFactory
+  def self.graph_with_cycles
+    Dependy::Graph::Graph.new([['1', '2'], ['1', '4'], ['2', '3'], ['3', '2'], ['4', '1']])
+  end
+
+  def self.graph_without_cycles
+    Dependy::Graph::Graph.new([['1', '2'], ['2', '3'], ['2', '4']])
+  end
+end

data/spec/fixtures/ignore_folder/File5.m

@@ -0,0 +1 @@
+#import "File5.h"

data/spec/fixtures/ignore_folder/File6.h

@@ -0,0 +1 @@
+#import "File5.h"

data/spec/fixtures/ignore_folder/File6.m

@@ -0,0 +1 @@
+#import "File6.h"

data/spec/fixtures/root_folder/File1.h

@@ -0,0 +1,3 @@
+#import "File2.h"
+#import "File4.h"
+#import "File5.h"

data/spec/fixtures/root_folder/File1.m

@@ -0,0 +1,2 @@
+#import "File1.h"
+#import "File3.h"

data/spec/fixtures/root_folder/File2.h

@@ -0,0 +1 @@
+#import "File3.h"

data/spec/fixtures/root_folder/File2.m

@@ -0,0 +1 @@
+#import "File2.h"

data/spec/fixtures/root_folder/File3.h

@@ -0,0 +1 @@
+import "File1.h"

data/spec/fixtures/root_folder/File3.m

@@ -0,0 +1 @@
+import "File3.h"

data/spec/fixtures/root_folder/File4.m

@@ -0,0 +1 @@
+#import "File4.h"

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'fixtures/graph_factory'
+require 'codeclimate-test-reporter'
+
+CodeClimate::TestReporter.start

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: dependy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Slavko Krucaj
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-15 00:00:00.000000000 Z
+dependencies: []
+description: Analyzing class dependency graphs
+email:
+- slavko.krucaj@gmail.com
+executables:
+- dependy
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/dependy
+- dependy.gemspec
+- lib/dependy.rb
+- lib/dependy/cli.rb
+- lib/dependy/graph/graph.rb
+- lib/dependy/graph/graph_reader.rb
+- lib/dependy/operations/cycle_finder.rb
+- lib/dependy/operations/extractor.rb
+- lib/dependy/operations/folder_extractor.rb
+- lib/dependy/operations/unused_nodes_finder.rb
+- spec/dependy/graph/graph_reader_spec.rb
+- spec/dependy/graph/graph_spec.rb
+- spec/dependy/operations/cycle_finder_spec.rb
+- spec/dependy/operations/extractor_spec.rb
+- spec/dependy/operations/unused_node_finder_spec.rb
+- spec/fixtures/graph_factory.rb
+- spec/fixtures/ignore_folder/File5.h
+- spec/fixtures/ignore_folder/File5.m
+- spec/fixtures/ignore_folder/File6.h
+- spec/fixtures/ignore_folder/File6.m
+- spec/fixtures/root_folder/File1.h
+- spec/fixtures/root_folder/File1.m
+- spec/fixtures/root_folder/File2.h
+- spec/fixtures/root_folder/File2.m
+- spec/fixtures/root_folder/File3.h
+- spec/fixtures/root_folder/File3.m
+- spec/fixtures/root_folder/File4.h
+- spec/fixtures/root_folder/File4.m
+- spec/spec_helper.rb
+homepage: 
+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.4.1
+signing_key: 
+specification_version: 4
+summary: Tool for inspecting class dependency graphs
+test_files:
+- spec/dependy/graph/graph_reader_spec.rb
+- spec/dependy/graph/graph_spec.rb
+- spec/dependy/operations/cycle_finder_spec.rb
+- spec/dependy/operations/extractor_spec.rb
+- spec/dependy/operations/unused_node_finder_spec.rb
+- spec/fixtures/graph_factory.rb
+- spec/fixtures/ignore_folder/File5.h
+- spec/fixtures/ignore_folder/File5.m
+- spec/fixtures/ignore_folder/File6.h
+- spec/fixtures/ignore_folder/File6.m
+- spec/fixtures/root_folder/File1.h
+- spec/fixtures/root_folder/File1.m
+- spec/fixtures/root_folder/File2.h
+- spec/fixtures/root_folder/File2.m
+- spec/fixtures/root_folder/File3.h
+- spec/fixtures/root_folder/File3.m
+- spec/fixtures/root_folder/File4.h
+- spec/fixtures/root_folder/File4.m
+- spec/spec_helper.rb