cobradeps 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 995be0ba3bdb1d3cdcae0a097b800a46534db785
+  data.tar.gz: c338653327cf27c0ae37d6e683d53744f5b4ce18
+SHA512:
+  metadata.gz: 5efcc9f3c41d77dfa4a04a0a9361c01f2b6b7ea4025b913be9b4556c1840b4e45b380b6983b8f868f2dab8c6d009a8f38797a27167e46e537f3ee7d9fa6657a6
+  data.tar.gz: bd4b369f022a5999f61f9c7507155baec464dbfd511fd92848b56369e614c241eb254054e31e8c7e26dc583974aff862537800a5c63729a9f7f8915ff6dcd79a

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Stephan Hagemann
+
+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,71 @@
+# cobradeps [![Build Status](https://travis-ci.org/shageman/cobradeps.svg?branch=master)](https://travis-ci.org/shageman/cobradeps) [![Gem Version](https://badge.fury.io/rb/cobradeps.svg)](http://badge.fury.io/rb/cobradeps) [![Code Climate](https://codeclimate.com/github/shageman/cobradeps.png)](https://codeclimate.com/github/shageman/cobradeps) [![Dependency Status](https://gemnasium.com/shageman/cobradeps.svg)](https://gemnasium.com/shageman/cobradeps)
+
+Prints and exports the dependencies within component-based Ruby/Rails applications (#cobra)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cobradeps'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cobradeps
+
+## Usage
+
+    cobradeps [OPTION] [application path]
+
+    Component-based Ruby/Rails dependency grapher.
+
+    Options are...
+        -t, --text                       DEFAULT Outputs a textual representation of the dependencies
+        -g, --graph                      Outputs graph.png to the current directory
+        -d, --dot                        Outputs graph.dot to the current directory
+
+        -h, -H, --help                   Display this help message.
+
+## Example
+
+There are sample #cobra folder structures in `spec/examples`. Here is the graph generated for the letters app structure:
+
+![Letters graph](https://raw.githubusercontent.com/shageman/cobradeps/master/spec/examples/letters.png)
+
+## #cobra extension to Gemfile
+
+The :path option used for #cobras is typically a relative path. Because of that all gems and apps transitively including a
+gem need to state the relative path to every gem with a path relatuive to their root. For an app, this is the reason why it is
+unclear which gems it really directly depends on. That's why all dependencies of apps are omitted from the output graph.
+
+To include direct dependencies of an application, add an additional option to the `gem` line from the Gemfile like so:
+
+    gem "B", path: "../B", direct: true
+    gem "C", path: "../C"
+    gem "D", path: "../D"
+    gem "E1", path: "../E1"
+    gem "E2", path: "../E2"
+    gem "F", path: "../F"
+
+This is the [Gemfile of app A](https://github.com/shageman/cobradeps/blob/master/spec/examples/letters/A/Gemfile)
+from the letters example of which you see the graph above.
+
+##TODOs
+
+* support windows folders (searching for a couple slashes)
+* support windows: don't shell out to find gemspecs and gemfiles
+* info if no gem file found for gem
+* warn if gem has name different than folder
+* warn if same gem name is found with path and without
+* error if there are multiple gem specs
+* error if there is not gem file in root
+
+
+## License
+
+Copyright (c) 2014 Stephan Hagemann, stephan.hagemann@gmail.com, [@shageman](http://twitter.com/shageman)
+
+Released under the MIT license. See LICENSE file for details.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/cobradeps

@@ -0,0 +1,50 @@
+#!/usr/bin/ruby
+
+require_relative "../lib/cobradeps"
+
+def help_text
+  <<-USAGE
+cobradeps [OPTION] [application path]
+
+Component-based Ruby/Rails dependency grapher.
+
+Options are...
+    -t, --text                       DEFAULT Outputs a textual representation of the dependencies
+    -g, --graph                      Outputs graph.png to the current directory
+    -d, --dot                        Outputs graph.dot to the current directory
+
+    -h, -H, --help                   Display this help message.
+  USAGE
+end
+
+option = "-t"
+path = nil
+
+case ARGV.size
+  when 0
+  when 1
+    if ARGV[0].start_with? "-"
+      option = ARGV[0]
+    else
+      path = ARGV[0]
+    end
+  when 2
+    option = ARGV[0]
+    path = ARGV[1]
+  else
+    puts "Incorrect invocation. Please see help:\n\n"
+    puts help_text
+    exit 1
+end
+
+if option
+  if %w(--help -h -H).include? option
+    puts help_text
+  elsif %w(-g --graph).include? option
+    Cbradeps.output_graph path
+  elsif %w(-d --dot).include? option
+    Cbradeps.output_dot path
+  elsif %w(-t --text).include? option
+    Cbradeps.output_text path
+  end
+end

data/cobradeps.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cobradeps'
+  spec.version       = '0.1.1'
+  spec.authors       = ['Stephan Hagemann']
+  spec.email         = ['stephan.hagemann@gmail.com']
+  spec.summary       = %q{Prints and exports the dependencies within component-based Ruby/Rails applications}
+  spec.description   = <<-DOC
+Component-based Ruby/Rails applications use local 'path' gem references to structure an application. This gem provides
+utilities for printing and exporting such dependencies.
+DOC
+
+  spec.homepage      = 'https://github.com/shageman/cobradeps'
+  spec.license       = 'MIT'
+
+  spec.files         = %w(
+                          bin/cobradeps
+                          cobradeps.gemspec
+                          Gemfile
+                          lib/cobradeps/gemfile_scraper.rb
+                          lib/cobradeps.rb
+                          LICENSE
+                          Rakefile
+                          README.md
+                          )
+
+  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_dependency 'ruby-graphviz'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/cobradeps.rb

@@ -0,0 +1,89 @@
+require 'set'
+require 'pathname'
+require 'graphviz'
+
+module Cbradeps
+  require_relative "cobradeps/gemfile_scraper"
+
+  def self.output_text(root_path = nil)
+    path = root_path || current_path
+    app = GemfileScraper.new(path)
+
+    outputs "APP"
+    outputs app.to_s
+
+    outputs "\n\nDEPENDENCIES"
+    cobra_deps = app.transitive_cobra_dependencies.to_set
+
+    cobra_deps.each do |dep|
+      outputs "\n#{dep[:options][:path]}"
+      gem = GemfileScraper.new(dep[:options][:path])
+      outputs gem.to_s
+
+      cobra_deps = cobra_deps.merge gem.cobra_dependencies
+    end
+
+    outputs "\n\n ALL PARTS"
+    outputs cobra_deps.to_a
+  end
+
+  def self.output_graph(root_path = nil)
+    path = root_path || current_path
+    graph(path).output(:png => "graph.png")
+  end
+
+  def self.output_dot(root_path = nil)
+    path = root_path || current_path
+    graph(path).output(:dot => "graph.dot")
+  end
+
+  def self.current_path
+    `pwd`.chomp
+  end
+
+  private_class_method :current_path
+
+  def self.graph(path)
+    g = GraphViz.new(:G, :type => :digraph, concentrate: true)
+
+    app = GemfileScraper.new(path)
+
+    app_node = g.add_nodes(app.name)
+    outputs "Added #{app.name} node"
+
+    cobra_deps = app.transitive_cobra_dependencies.to_set
+    gem_nodes = {}
+
+    cobra_deps.each do |dep|
+      gem = GemfileScraper.new(dep[:options][:path])
+      gem_node = g.add_nodes(gem.name)
+      gem_nodes[gem.name] = gem_node
+      outputs "Added #{gem.name} node"
+      if dep[:options][:direct]
+        outputs "Added edge from #{app.name} to #{gem.name}"
+        g.add_edges(app_node, gem_node)
+      end
+    end
+
+    cobra_deps.each do |dep|
+      gem = GemfileScraper.new(dep[:options][:path])
+      gem_node = gem_nodes[gem.name]
+
+      gem_cobra_deps = gem.cobra_dependencies
+      gem_cobra_deps.each do |nest_dep|
+        nest_gem = GemfileScraper.new(nest_dep[:options][:path])
+        g.add_edges(gem_node, gem_nodes[nest_gem.name])
+        outputs "Added edge from #{gem.name} to #{nest_gem.name}"
+      end
+    end
+    g
+  end
+
+  private_class_method :graph
+
+  def self.outputs(arg)
+    puts arg
+  end
+
+  private_class_method :outputs
+end

data/lib/cobradeps/gemfile_scraper.rb

@@ -0,0 +1,93 @@
+module Cbradeps
+  class GemfileScraper
+    def initialize(root_path)
+      @root_path = root_path
+    end
+
+    def name
+      Pathname.new(@root_path).basename.to_s
+    end
+
+    def to_s
+      cobra_dependencies
+    end
+
+    def cobra_dependencies
+      dirdep = direct_dependencies
+      transitive_cobra_dependencies.select do |dep|
+        dirdep.include?(dep[:name]) || dep[:options][:direct]
+      end
+    end
+
+    def transitive_cobra_dependencies
+      gem_dependencies.inject([]) do |memo, dep|
+        if !!dep[:options][:path]
+          absolute_dep = dep.clone
+          absolute_dep[:options][:path] = File.expand_path(File.join(@root_path, dep[:options][:path]))
+          memo << dep
+        end
+        memo
+      end
+    end
+
+    private
+
+    def raw_gemspec
+      path = File.expand_path(File.join(@root_path, "#{underscore(name)}.gemspec"))
+      File.exist?(path) ? File.read(path) : ""
+    end
+
+    def direct_dependencies
+      raw_gemspec.split("\n").inject([]) do |memo, line|
+        match = line.match(/add_(?:development_)?dependency\s+["']([^'"]+)["']/)
+        memo << match[1] if match
+        memo
+      end
+    end
+
+    def raw_gemfile
+      path = File.expand_path(File.join(@root_path, "Gemfile"))
+      File.read(path)
+    end
+
+    def gem_dependencies
+      raw_gemfile.split("\n").inject([]) do |memo, line|
+        match = line.match(/gem\s+["']([^'"]+)["'](.*)/)
+        if match
+          memo << {name: match[1], options: OptionParser.new(match[2]).parse}
+        end
+        memo
+      end
+    end
+
+    def underscore(string)
+      string.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+          gsub(/([a-z\d])([A-Z])/, '\1_\2').
+          tr("-", "_").
+          downcase
+    end
+
+    class OptionParser
+      def initialize(options)
+        @options = options
+      end
+
+      def parse
+        {}.merge(path).merge(direct)
+      end
+
+      private
+
+      def path
+        match = @options.match(/path(?:\s*=>|:)\s+["']([^'"]+)["']/)
+        match ? {path: match[1]} : {}
+      end
+
+      def direct
+        match = @options.match(/direct(?:\s*=>|:)\s+true/)
+        match ? {direct: true} : {}
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: cobradeps
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Stephan Hagemann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: rspec
+  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: |
+  Component-based Ruby/Rails applications use local 'path' gem references to structure an application. This gem provides
+  utilities for printing and exporting such dependencies.
+email:
+- stephan.hagemann@gmail.com
+executables:
+- cobradeps
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/cobradeps
+- cobradeps.gemspec
+- Gemfile
+- lib/cobradeps/gemfile_scraper.rb
+- lib/cobradeps.rb
+- LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/shageman/cobradeps
+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.3
+signing_key: 
+specification_version: 4
+summary: Prints and exports the dependencies within component-based Ruby/Rails applications
+test_files: []