cbradeps 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 598aa087f1c0d76bf8e9964e2733830616b22d14
-  data.tar.gz: 61357cb006c3eacf330da000049645f8e91ab989
+  metadata.gz: 84d0bc8abac7615cd7742fde3e869b067abe7f8b
+  data.tar.gz: ed5829ba4f8cc78d587471b98ef9bf1aafdba549
 SHA512:
-  metadata.gz: 51b39c58ddb86d21926b3e1a5c11bd66e451cde05f4e17fe5c00ee0b8de509d29fadf5905eccf547d7e866cb37320d41f3c0ea9cb7a0203e3bf7f0bd99294249
-  data.tar.gz: f2ab318356e17cc3281ef371a6ce48eea0aa112b21a43bb6b1f89460557da0decb3698280d355e0fce1deca725b805c60d176f8a5b40cbcac96e697f9d7bc25b
+  metadata.gz: b6680de6d79145b20984c00c53397a0e7a701c83156003fe4fa524ce947883d94423988f699bf02d768cda6c6212784e47e320354957f59b9f4f94f200e7ebff
+  data.tar.gz: 98e97f8445d30e037b77ec6b968c4bcd18e3e0d58acfcb4ec0d60fbad7840cd331cf4902e98ce8e2e24a9acb3870af36566e30728b4f0a9da5f2ecad3dc70e75

data/README.md

@@ -1,6 +1,6 @@
-# cbradeps
+# cbradeps [![Build Status](https://travis-ci.org/shageman/cbradeps.svg?branch=master)](https://travis-ci.org/shageman/cbradeps) [![Gem Version](https://badge.fury.io/rb/cbradeps.svg)](http://badge.fury.io/rb/cbradeps) [![Code Climate](https://codeclimate.com/github/shageman/cbradeps.png)](https://codeclimate.com/github/shageman/cbradeps) [![Dependency Status](https://gemnasium.com/shageman/cbradeps.svg)](https://gemnasium.com/shageman/cbradeps)
 
-Prints and exports the dependencies within component-based Ruby/Rails applications
+Prints and exports the dependencies within component-based Ruby/Rails applications (#cbra)
 
 ## Installation
 
@@ -18,16 +18,43 @@ Or install it yourself as:
 
 ## Usage
 
-    cbradeps [application path]
-    
+    cbradeps [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 #cbra folder structures in `spec/examples`. Here is the graph generated for the letters app structure:
+
+![Letters graph](https://raw.githubusercontent.com/shageman/cbradeps/master/spec/examples/letters.png)
+
+## #cbra extension to Gemfile
+
+The :path option used for #cbras 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/cbradeps/blob/master/spec/examples/letters/A/Gemfile)
+from the letters example of which you see the graph above.
+
 ##TODOs
 
-* optionally output dotfile for all deps
 * 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
@@ -39,8 +66,6 @@ Or install it yourself as:
 
 ## License
 
-    Copyright (c) 2014 Stephan Hagemann
-    twitter.com/shageman
-    stephan.hagemann@gmail.com
+Copyright (c) 2014 Stephan Hagemann, stephan.hagemann@gmail.com, [@shageman](http://twitter.com/shageman)
 
-    Released under the MIT license. See LICENSE file for details.
+Released under the MIT license. See LICENSE file for details.

data/bin/cbradeps

@@ -23,7 +23,11 @@ path = nil
 case ARGV.size
   when 0
   when 1
-    path = ARGV[0]
+    if ARGV[0].start_with? "-"
+      option = ARGV[0]
+    else
+      path = ARGV[0]
+    end
   when 2
     option = ARGV[0]
     path = ARGV[1]
@@ -40,7 +44,7 @@ if option
     Cbradeps.output_graph path
   elsif %w(-d --dot).include? option
     Cbradeps.output_dot path
-  else %w(-t --text).include? option
+  elsif %w(-t --text).include? option
     Cbradeps.output_text path
   end
 end

data/cbradeps.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'cbradeps'
-  spec.version       = '0.1.0'
+  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}
@@ -13,7 +13,7 @@ Component-based Ruby/Rails applications use local 'path' gem references to struc
 utilities for printing and exporting such dependencies.
 DOC
 
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/shageman/cbradeps'
   spec.license       = 'MIT'
 
   spec.files         = %w(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cbradeps
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Stephan Hagemann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2014-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-graphviz
@@ -84,7 +84,7 @@ files:
 - LICENSE
 - Rakefile
 - README.md
-homepage: ''
+homepage: https://github.com/shageman/cbradeps
 licenses:
 - MIT
 metadata: {}