codependency 0.2.0 → 0.3.0

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+  watch(%r{spec/support/.+\.rb}){ 'spec' }
+end

data/codependency.gemspec

@@ -15,5 +15,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Codependency::VERSION
 
-  gem.add_development_dependency 'rspec', '>= 2.10.0'
+  gem.add_development_dependency 'rspec',       '2.11.0'
+  gem.add_development_dependency 'guard-rspec', '1.2.1'
+  gem.add_development_dependency 'rb-fsevent',  '0.9.1'
 end

data/lib/codependency.rb

@@ -5,3 +5,5 @@ module Codependency
   autoload :Node,   'codependency/node'
   autoload :Parser, 'codependency/parser'
 end
+
+class CircularDependencyError < StandardError; end

data/lib/codependency/graph.rb

@@ -1,3 +1,5 @@
+require 'open3'
+
 module Codependency
   class Graph
     def initialize( start, options={} )
@@ -6,24 +8,37 @@ module Codependency
       @start   = @nodes[ start ]
     end
 
+    ##
+    # a topologically sorted list of all dependencies of the `start` file.
     def files
-      [ ].tap { |list| resolve @start, list }.reverse.map &:filename
+      deps = resolve( @start, [ ] ).map( &:dependencies ).join ' '
+
+      cmd, out, err = Open3.popen3 "echo '#{deps}' | tsort"
+
+      if msg = err.gets
+        raise CircularDependencyError, msg
+      end
+
+      out.readlines.map( &:chomp ).reverse
     end
 
     protected
 
+    ##
+    # adds a node's dependencies to a list (memo).
+    # intended to be used recursively.
     def resolve( node, list )
-      list << node # TODO if the node were in the list here,
-                   # would that indicate a circular dependency?
-      node.dependencies.map { |filename| @nodes[ filename ] }.each do |dep|
-        if list.include?( dep )
-          list << list.slice!( list.index( dep ) )
-        else
-          resolve dep, list
-        end
+      list << node
+
+      node.edges.map { |filename| @nodes[ filename ] }.each do |dep|
+        resolve dep, list unless list.include?( dep )
       end
+
+      list
     end
 
+    ##
+    # the parser to use for this graph. shared by all nodes.
     def parser
       @parser ||= Parser.new @options
     end

data/lib/codependency/node.rb

@@ -9,8 +9,20 @@ module Codependency
     end
     attr_reader :filename, :parser
 
+    ##
+    # all of this node's edges
+    def edges
+      @edges ||= begin
+        parser.parse( filename ).map do |f|
+          dirname.join( "#{f}#{extname}" ).to_s
+        end
+      end
+    end
+
+    ##
+    # a string representing this node's edges, formatted for `tsort`.
     def dependencies
-      parser.parse( filename ).map { |f| dirname.join( "#{f}#{extname}" ).to_s }
+      edges.map { |edge| [ filename, edge ] }.flatten.join ' '
     end
 
     protected

data/lib/codependency/parser.rb

@@ -6,6 +6,8 @@ module Codependency
       @comment = options.delete( :comment ) || '#'
     end
 
+    ##
+    # determines a file's dependencies based on the configured comment pattern.
     def parse( file )
       IO.readlines( file ).take_while do |line|
         line =~ pattern
@@ -14,6 +16,9 @@ module Codependency
 
     protected
 
+    ##
+    # the comment pattern to use.
+    # TODO allow this to be more configurable
     def pattern
       @pattern ||= /^#{@comment} require (.+)$/
     end

data/lib/codependency/version.rb

@@ -1,3 +1,3 @@
 module Codependency
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/codependency/graph_spec.rb

@@ -20,7 +20,17 @@ describe Codependency::Graph do
 
     context 'sandwich' do
       let( :graph ){ 'sandwich.js' }
-      its( :files ){ should eq( %w| butter.js toast.js egg.js sandwich.js | ) }
+      its( :files ){ should eq( %w| butter.js egg.js toast.js sandwich.js | ) }
+    end
+  end
+
+  context 'circular dependencies', :files => :circular do
+    subject { Codependency::Graph.new graph }
+
+    let( :graph ){ 'money.rb' }
+
+    it 'should raise an error' do
+      expect { subject.files }.to raise_error( CircularDependencyError )
     end
   end
 end

data/spec/codependency/node_spec.rb

@@ -5,7 +5,7 @@ describe Codependency::Node do
 
   context 'when the file exists', :files => :planets do
     subject { Codependency::Node.new 'planet.rb', parser }
-    its( :dependencies ){ should eq( [ 'body.rb' ] ) }
+    its( :edges ){ should eq( [ 'body.rb' ] ) }
   end
 
   context 'when the file does not exist' do
@@ -15,4 +15,11 @@ describe Codependency::Node do
       }.to raise_error( Errno::ENOENT, 'No such file or directory - pluto.rb' )
     end
   end
+
+  describe 'dependencies', :files => :planets do
+    let( :parser ){ double 'Parser', :parse => [ 'body', 'mars' ] }
+    subject { Codependency::Node.new 'phobos.rb', parser }
+
+    its( :dependencies ){ should eq( 'phobos.rb body.rb phobos.rb mars.rb' ) }
+  end
 end

data/spec/spec_helper.rb

@@ -4,7 +4,5 @@ Dir[ './spec/support/*.rb' ].each { |f| require f }
 
 RSpec.configure do |config|
   config.color_enabled = true
-  config.formatter     = :documentation
-
   config.include FileSystemStubs
 end

data/spec/support/circular_context.rb

@@ -0,0 +1,25 @@
+shared_context 'circular dependencies', :files => :circular do
+
+  before do
+    file 'money.rb', <<-EOS
+    # require power
+
+    class Money
+    end
+    EOS
+
+    file 'power.rb', <<-EOS
+    # require respect
+
+    class Power
+    end
+    EOS
+
+    file 'respect.rb', <<-EOS
+    # require money
+
+    class Respect
+    end
+    EOS
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codependency
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-29 00:00:00.000000000 Z
+date: 2012-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - '='
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
 description: Simple comment-based dependency graph for arbitrary files
 email:
 - jeremy.ruppel@gmail.com
@@ -36,6 +68,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -50,6 +83,7 @@ files:
 - spec/codependency/parser_spec.rb
 - spec/spec_helper.rb
 - spec/support/breakfasts_context.rb
+- spec/support/circular_context.rb
 - spec/support/file_system_stubs.rb
 - spec/support/planets_context.rb
 homepage: ''
@@ -82,5 +116,6 @@ test_files:
 - spec/codependency/parser_spec.rb
 - spec/spec_helper.rb
 - spec/support/breakfasts_context.rb
+- spec/support/circular_context.rb
 - spec/support/file_system_stubs.rb
 - spec/support/planets_context.rb