codependency 0.1.0 → 0.2.0

data/lib/codependency/graph.rb

@@ -1,28 +1,31 @@
 module Codependency
   class Graph
-    def initialize( filenames )
-      @nodes = Hash[ filenames.map { |f| [ f, Node.new( f ) ] } ]
+    def initialize( start, options={} )
+      @options = options
+      @nodes   = Hash.new { |h, k| h[ k ] = Node.new( k, parser ) }
+      @start   = @nodes[ start ]
     end
-    attr_reader :nodes
 
     def files
-      nodes.reduce( [ ] ) do |list, (filename, node)|
-        resolve node, list
-        list
-      end
+      [ ].tap { |list| resolve @start, list }.reverse.map &:filename
     end
 
     protected
 
     def resolve( node, list )
-      unless list.include? node.filename
-        node.dependencies.each do |dep|
-          # TODO need to check here to make sure
-          # we actually have a node for this dependency
-          resolve nodes[ dep ], 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.filename
       end
     end
+
+    def parser
+      @parser ||= Parser.new @options
+    end
   end
 end

data/lib/codependency/node.rb

@@ -2,11 +2,12 @@ require 'pathname'
 
 module Codependency
   class Node
-    def initialize( filename )
-      raise Errno::ENOENT unless File.exist?( filename )
+    def initialize( filename, parser )
+      raise Errno::ENOENT, filename unless File.exist?( filename )
       @filename = filename
+      @parser   = parser
     end
-    attr_reader :filename
+    attr_reader :filename, :parser
 
     def dependencies
       parser.parse( filename ).map { |f| dirname.join( "#{f}#{extname}" ).to_s }
@@ -25,9 +26,5 @@ module Codependency
     def path
       @path ||= Pathname.new filename
     end
-
-    def parser
-      @parser ||= Parser.new
-    end
   end
 end

data/lib/codependency/parser.rb

@@ -1,6 +1,11 @@
 module Codependency
   class Parser
 
+    def initialize( options={} )
+      @options = options
+      @comment = options.delete( :comment ) || '#'
+    end
+
     def parse( file )
       IO.readlines( file ).take_while do |line|
         line =~ pattern
@@ -10,7 +15,7 @@ module Codependency
     protected
 
     def pattern
-      @pattern ||= /^# require (.+)$/
+      @pattern ||= /^#{@comment} require (.+)$/
     end
   end
 end

data/lib/codependency/version.rb

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

data/spec/codependency/graph_spec.rb

@@ -1,16 +1,26 @@
 require 'spec_helper'
 
 describe Codependency::Graph do
-  let( :path ){ File.join( File.dirname( __FILE__ ), '../fixtures' ) }
-  subject { Codependency::Graph.new Dir[ File.join( path, '*.rb' ) ] }
+  context 'planets', :files => :planets do
+    subject { Codependency::Graph.new graph }
 
-  its( :files ){ should eq(
-    [
-      "#{path}/body.rb",
-      "#{path}/planet.rb",
-      "#{path}/earth.rb",
-      "#{path}/mars.rb",
-      "#{path}/phobos.rb"
-    ]
-  ) }
+    context 'earth' do
+      let( :graph ){ 'earth.rb' }
+      its( :files ){ should eq( %w| body.rb planet.rb earth.rb | ) }
+    end
+
+    context 'phobos' do
+      let( :graph ){ 'phobos.rb' }
+      its( :files ){ should eq( %w| body.rb planet.rb mars.rb phobos.rb | ) }
+    end
+  end
+
+  context 'breakfasts', :files => :breakfasts do
+    subject { Codependency::Graph.new graph, :comment => '//' }
+
+    context 'sandwich' do
+      let( :graph ){ 'sandwich.js' }
+      its( :files ){ should eq( %w| butter.js toast.js egg.js sandwich.js | ) }
+    end
+  end
 end

data/spec/codependency/node_spec.rb

@@ -1,19 +1,18 @@
 require 'spec_helper'
 
 describe Codependency::Node do
-  let( :path ){ File.join( File.dirname( __FILE__ ), '../fixtures' ) }
+  let( :parser ){ double 'Parser', :parse => [ 'body' ] }
 
-  context 'when the file exists' do
-    subject { Codependency::Node.new "#{path}/planet.rb" }
-
-    its( :dependencies ){ should eq( [ "#{path}/body.rb" ] ) }
+  context 'when the file exists', :files => :planets do
+    subject { Codependency::Node.new 'planet.rb', parser }
+    its( :dependencies ){ should eq( [ 'body.rb' ] ) }
   end
 
   context 'when the file does not exist' do
     it 'should raise an error' do
       expect {
-        Codependency::Node.new "#{path}/pluto.rb"
-      }.to raise_error( Errno::ENOENT )
+        Codependency::Node.new 'pluto.rb', parser
+      }.to raise_error( Errno::ENOENT, 'No such file or directory - pluto.rb' )
     end
   end
 end

data/spec/codependency/parser_spec.rb

@@ -1,31 +1,49 @@
 require 'spec_helper'
 
 describe Codependency::Parser do
-  let( :path   ){ File.join( File.dirname( __FILE__ ), '../fixtures' ) }
-  let( :parser ){ Codependency::Parser.new }
+  context 'planets', :files => :planets do
+    let( :parser ){ Codependency::Parser.new }
 
-  context 'body' do
-    subject { parser.parse( "#{path}/body.rb" ) }
-    it { should eq( [ ] ) }
+    context 'body' do
+      subject { parser.parse( 'body.rb' ) }
+      it { should eq( [ ] ) }
+    end
+    context 'earth' do
+      subject { parser.parse( 'earth.rb' ) }
+      it { should eq( [ 'planet' ] ) }
+    end
+    context 'mars' do
+      subject { parser.parse( 'mars.rb' ) }
+      it { should eq( [ 'planet' ] ) }
+    end
+    context 'phobos' do
+      subject { parser.parse( 'phobos.rb' ) }
+      it { should eq( [ 'body', 'mars' ] ) }
+    end
+    context 'planet' do
+      subject { parser.parse( 'planet.rb' ) }
+      it { should eq( [ 'body' ] ) }
+    end
   end
 
-  context 'earth' do
-    subject { parser.parse( "#{path}/earth.rb" ) }
-    it { should eq( [ 'planet' ] ) }
-  end
-
-  context 'mars' do
-    subject { parser.parse( "#{path}/mars.rb" ) }
-    it { should eq( [ 'planet' ] ) }
-  end
-
-  context 'phobos' do
-    subject { parser.parse( "#{path}/phobos.rb" ) }
-    it { should eq( [ 'body', 'mars' ] ) }
-  end
+  context 'breakfasts', :files => :breakfasts do
+    let( :parser ){ Codependency::Parser.new :comment => '//' }
 
-  context 'planet' do
-    subject { parser.parse( "#{path}/planet.rb" ) }
-    it { should eq( [ 'body' ] ) }
+    context 'butter' do
+      subject { parser.parse( 'butter.js' ) }
+      it { should eq( [ ] ) }
+    end
+    context 'egg' do
+      subject { parser.parse( 'egg.js' ) }
+      it { should eq( [ 'butter' ] ) }
+    end
+    context 'toast' do
+      subject { parser.parse( 'toast.js' ) }
+      it { should eq( [ 'butter' ] ) }
+    end
+    context 'sandwich' do
+      subject { parser.parse( 'sandwich.js' ) }
+      it { should eq( [ 'egg', 'toast' ] ) }
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,10 @@
 require 'codependency'
 
+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/breakfasts_context.rb

@@ -0,0 +1,24 @@
+shared_context 'breakfast foods', :files => :breakfasts do
+
+  before do
+    file 'butter.js', <<-EOS
+    var Butter = { }
+    EOS
+
+    file 'egg.js', <<-EOS
+    // require butter
+    var Egg = { }
+    EOS
+
+    file 'toast.js', <<-EOS
+    // require butter
+    var Toast = { }
+    EOS
+
+    file 'sandwich.js', <<-EOS
+    // require egg
+    // require toast
+    var Sandwich = { }
+    EOS
+  end
+end

data/spec/support/file_system_stubs.rb

@@ -0,0 +1,10 @@
+module FileSystemStubs
+
+  ##
+  # stubs the filesystem methods that codependency
+  # uses to retrieve file contents
+  def file( filename, contents )
+    File.stub( :exist?  ).with( filename ){ true }
+    IO.stub( :readlines ).with( filename ){ contents.strip.split( /^\s+/ ) }
+  end
+end

data/spec/support/planets_context.rb

@@ -0,0 +1,38 @@
+shared_context 'solar system', :files => :planets do
+
+  before do
+    file 'body.rb', <<-EOS
+    class Body
+    end
+    EOS
+
+    file 'earth.rb', <<-EOS
+    # require planet
+
+    class Earth
+    end
+    EOS
+
+    file 'mars.rb', <<-EOS
+    # require planet
+
+    class Mars
+    end
+    EOS
+
+    file 'phobos.rb', <<-EOS
+    # require body
+    # require mars
+
+    class Phobos
+    end
+    EOS
+
+    file 'planet.rb', <<-EOS
+    # require body
+
+    class Planet
+    end
+    EOS
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codependency
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-09 00:00:00.000000000Z
+date: 2012-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -48,12 +48,10 @@ files:
 - spec/codependency/graph_spec.rb
 - spec/codependency/node_spec.rb
 - spec/codependency/parser_spec.rb
-- spec/fixtures/body.rb
-- spec/fixtures/earth.rb
-- spec/fixtures/mars.rb
-- spec/fixtures/phobos.rb
-- spec/fixtures/planet.rb
 - spec/spec_helper.rb
+- spec/support/breakfasts_context.rb
+- spec/support/file_system_stubs.rb
+- spec/support/planets_context.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -82,9 +80,7 @@ test_files:
 - spec/codependency/graph_spec.rb
 - spec/codependency/node_spec.rb
 - spec/codependency/parser_spec.rb
-- spec/fixtures/body.rb
-- spec/fixtures/earth.rb
-- spec/fixtures/mars.rb
-- spec/fixtures/phobos.rb
-- spec/fixtures/planet.rb
 - spec/spec_helper.rb
+- spec/support/breakfasts_context.rb
+- spec/support/file_system_stubs.rb
+- spec/support/planets_context.rb

data/spec/fixtures/body.rb

@@ -1,2 +0,0 @@
-class Body
-end

data/spec/fixtures/earth.rb

@@ -1,4 +0,0 @@
-# require planet
-
-class Earth
-end

data/spec/fixtures/mars.rb

@@ -1,4 +0,0 @@
-# require planet
-
-class Mars
-end

data/spec/fixtures/phobos.rb

@@ -1,5 +0,0 @@
-# require body
-# require mars
-
-class Phobos
-end

data/spec/fixtures/planet.rb

@@ -1,4 +0,0 @@
-# require body
-
-class Planet
-end