codependency 0.3.1 → 1.0.0

data/README.md

@@ -2,8 +2,6 @@
 
 Codependency is a simple comment-based dependency graph that you can use on arbitrary files.
 
-It uses the program `tsort` under the hood, so sorry windoze I guess?
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -41,8 +39,8 @@ end
 Then, we create a dependency graph to determine the order in which the files might need to be loaded, inserted, or compiled:
 
 ``` rb
-graph = Codependency::Graph.new %w| bar.rb foo.rb |
-graph.files # => ["foo.rb", "bar.rb"]
+graph = Codependency::Graph.new "bar.rb"
+graph.files # => ["./foo.rb", "./bar.rb"]
 ```
 
 ## Contributing

data/codependency.gemspec

@@ -4,8 +4,8 @@ require File.expand_path('../lib/codependency/version', __FILE__)
 Gem::Specification.new do |gem|
   gem.authors       = ["Jeremy Ruppel"]
   gem.email         = ["jeremy.ruppel@gmail.com"]
-  gem.description   = %q{Simple comment-based dependency graph for arbitrary files}
-  gem.summary       = %q{Simple comment-based dependency graph for arbitrary files}
+  gem.description   = %q{A pure ruby, comment-based dependency graph}
+  gem.summary       = %q{A pure ruby, comment-based dependency graph}
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($\)

data/lib/codependency.rb

@@ -2,8 +2,5 @@ require 'codependency/version'
 
 module Codependency
   autoload :Graph,  'codependency/graph'
-  autoload :Node,   'codependency/node'
   autoload :Parser, 'codependency/parser'
 end
-
-class CircularDependencyError < StandardError; end

data/lib/codependency/graph.rb

@@ -1,46 +1,63 @@
-require 'open3'
+require 'tsort'
 
 module Codependency
-  class Graph
-    def initialize( start, options={} )
-      @options = options
-      @nodes   = Hash.new { |h, k| h[ k ] = Node.new( k, parser ) }
-      @start   = @nodes[ start ]
-    end
-
-    ##
-    # a topologically sorted list of all dependencies of the `start` file.
-    def files
-      deps = resolve( @start, [ ] ).map( &:dependencies ).join ' '
+  class Graph < Hash
+    def initialize( path, options={} )
+      @path, @options = path, options
 
-      cmd, out, err = Open3.popen3 "echo '#{deps}' | tsort"
+      super( ){ |h, k| h[ k ] = parser.parse( k ) }
+    end
+    attr_reader :path, :options
 
-      if msg = err.gets
-        raise CircularDependencyError, msg
-      end
+    include TSort
 
-      out.readlines.map( &:chomp ).reverse
+    ##
+    # the dirname to use for this graph, based on the path
+    def dirname
+      File.dirname path
     end
 
-    protected
-
     ##
-    # adds a node's dependencies to a list (memo).
-    # intended to be used recursively.
-    def resolve( node, list )
-      list << node
+    # the extname to use for this graph, based on the path
+    def extname
+      File.extname path
+    end
 
-      node.edges.map { |filename| @nodes[ filename ] }.each do |dep|
-        resolve dep, list unless list.include?( dep )
-      end
+    ##
+    # walk the entire graph and return self
+    def populate
+      walk path
+      self
+    end
 
-      list
+    ##
+    # discover all nodes in this graph by walking it
+    def walk( path )
+      self[ path ].each { |path| walk( path ) unless has_key?( path ) }
     end
 
     ##
     # the parser to use for this graph. shared by all nodes.
     def parser
-      @parser ||= Parser.new @options
+      @parser ||= begin
+        Parser.new options.merge( :dirname => dirname, :extname => extname )
+      end
+    end
+
+    ##
+    # a topologically sorted list of all dependencies of the `start` file.
+    def files
+      populate.tsort
+    end
+
+    private
+
+    # tsort interface
+    alias :tsort_each_node :each_key
+
+    # tsort interface
+    def tsort_each_child( node, &block )
+      fetch( node ).each( &block )
     end
   end
 end

data/lib/codependency/parser.rb

@@ -4,6 +4,8 @@ module Codependency
     def initialize( options={} )
       @options = options
       @comment = options.delete( :comment ) || '#'
+      @dirname = options.delete( :dirname ) || '.'
+      @extname = options.delete( :extname ) || '.rb'
     end
 
     ##
@@ -11,7 +13,7 @@ module Codependency
     def parse( file )
       IO.readlines( file ).take_while do |line|
         line =~ pattern
-      end.map { |line| line[ pattern, 1 ] }
+      end.map { |line| "#{@dirname}/#{line[ pattern, 1 ]}#{@extname}" }
     end
 
     protected

data/lib/codependency/version.rb

@@ -1,3 +1,3 @@
 module Codependency
-  VERSION = '0.3.1'
+  VERSION = '1.0.0'
 end

data/spec/codependency/graph_spec.rb

@@ -1,45 +1,74 @@
 require 'spec_helper'
 
 describe Codependency::Graph do
+  describe 'accessors' do
+    subject { described_class.new 'planets/phobos.rb' }
+    its( :path    ){ should eq( 'planets/phobos.rb' ) }
+    its( :dirname ){ should eq( 'planets' ) }
+    its( :extname ){ should eq( '.rb' ) }
+    its( :options ){ should eq( { } ) }
+  end
+
+  describe 'populate', :files => :planets do
+    subject { described_class.new './phobos.rb' }
+
+    context 'initially' do
+      it { should be_empty }
+    end
+
+    context 'after calling populate' do
+      before { subject.populate }
+
+      it { should include( './phobos.rb' => [ './body.rb', './mars.rb' ] ) }
+      it { should include( './mars.rb'   => [ './planet.rb' ] ) }
+      it { should include( './planet.rb' => [ './body.rb' ] ) }
+      it { should include( './body.rb'   => [ ] ) }
+    end
+
+    it 'should return itself' do
+      subject.populate.should == subject
+    end
+  end
+
   context 'planets', :files => :planets do
-    subject { Codependency::Graph.new graph }
+    subject { described_class.new start }
 
     context 'earth' do
-      let( :graph ){ 'earth.rb' }
-      its( :files ){ should eq( %w| body.rb planet.rb earth.rb | ) }
+      let( :start ){ './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 | ) }
+      let( :start ){ './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 => '//' }
+    subject { described_class.new start, :comment => '//' }
 
     context 'sandwich' do
-      let( :graph ){ 'sandwich.js' }
-      its( :files ){ should eq( %w| butter.js egg.js toast.js sandwich.js | ) }
+      let( :start ){ './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 }
+    subject { described_class.new start }
 
-    let( :graph ){ 'money.rb' }
+    let( :start ){ './money.rb' }
 
     it 'should raise an error' do
-      expect { subject.files }.to raise_error( CircularDependencyError )
+      expect { subject.files }.to raise_error( TSort::Cyclic )
     end
   end
 
   context 'subdirectories', :files => :subdirectories do
-    subject { Codependency::Graph.new graph, :comment => '//' }
+    subject { described_class.new start, :comment => '//' }
 
     context 'application.js' do
-      let( :graph ){ 'application.js' }
-      its( :files ){ should eq( %w| templates/user/history.js templates/user/account.js templates/user.js application.js | ) }
+      let( :start ){ 'assets/application.js' }
+      its( :files ){ should eq( %w| assets/templates/user/history.js assets/templates/user/account.js assets/templates/user.js assets/application.js | ) }
     end
   end
 end

data/spec/codependency/parser_spec.rb

@@ -5,45 +5,45 @@ describe Codependency::Parser do
     let( :parser ){ Codependency::Parser.new }
 
     context 'body' do
-      subject { parser.parse( 'body.rb' ) }
+      subject { parser.parse( './body.rb' ) }
       it { should eq( [ ] ) }
     end
     context 'earth' do
-      subject { parser.parse( 'earth.rb' ) }
-      it { should eq( [ 'planet' ] ) }
+      subject { parser.parse( './earth.rb' ) }
+      it { should eq( [ './planet.rb' ] ) }
     end
     context 'mars' do
-      subject { parser.parse( 'mars.rb' ) }
-      it { should eq( [ 'planet' ] ) }
+      subject { parser.parse( './mars.rb' ) }
+      it { should eq( [ './planet.rb' ] ) }
     end
     context 'phobos' do
-      subject { parser.parse( 'phobos.rb' ) }
-      it { should eq( [ 'body', 'mars' ] ) }
+      subject { parser.parse( './phobos.rb' ) }
+      it { should eq( [ './body.rb', './mars.rb' ] ) }
     end
     context 'planet' do
-      subject { parser.parse( 'planet.rb' ) }
-      it { should eq( [ 'body' ] ) }
+      subject { parser.parse( './planet.rb' ) }
+      it { should eq( [ './body.rb' ] ) }
     end
   end
 
   context 'breakfasts', :files => :breakfasts do
-    let( :parser ){ Codependency::Parser.new :comment => '//' }
+    let( :parser ){ Codependency::Parser.new :comment => '//', :extname => '.js' }
 
     context 'butter' do
-      subject { parser.parse( 'butter.js' ) }
+      subject { parser.parse( './butter.js' ) }
       it { should eq( [ ] ) }
     end
     context 'egg' do
-      subject { parser.parse( 'egg.js' ) }
-      it { should eq( [ 'butter' ] ) }
+      subject { parser.parse( './egg.js' ) }
+      it { should eq( [ './butter.js' ] ) }
     end
     context 'toast' do
-      subject { parser.parse( 'toast.js' ) }
-      it { should eq( [ 'butter' ] ) }
+      subject { parser.parse( './toast.js' ) }
+      it { should eq( [ './butter.js' ] ) }
     end
     context 'sandwich' do
-      subject { parser.parse( 'sandwich.js' ) }
-      it { should eq( [ 'egg', 'toast' ] ) }
+      subject { parser.parse( './sandwich.js' ) }
+      it { should eq( [ './egg.js', './toast.js' ] ) }
     end
   end
 end

data/spec/support/breakfasts_context.rb

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

data/spec/support/circular_context.rb

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

data/spec/support/planets_context.rb

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

data/spec/support/subdirectories_context.rb

@@ -1,20 +1,20 @@
 shared_context 'subdirectories', :files => :subdirectories do
 
   before do
-    file 'application.js', <<-EOS
+    file 'assets/application.js', <<-EOS
     // require templates/user
     EOS
 
-    file 'templates/user.js', <<-EOS
+    file 'assets/templates/user.js', <<-EOS
     // require templates/user/history
     // require templates/user/account
     EOS
 
-    file 'templates/user/history.js', <<-EOS
+    file 'assets/templates/user/history.js', <<-EOS
     var History = { }
     EOS
 
-    file 'templates/user/account.js', <<-EOS
+    file 'assets/templates/user/account.js', <<-EOS
     var Account = { }
     EOS
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: codependency
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-23 00:00:00.000000000 Z
+date: 2012-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -59,7 +59,7 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.9.1
-description: Simple comment-based dependency graph for arbitrary files
+description: A pure ruby, comment-based dependency graph
 email:
 - jeremy.ruppel@gmail.com
 executables: []
@@ -75,11 +75,9 @@ files:
 - codependency.gemspec
 - lib/codependency.rb
 - lib/codependency/graph.rb
-- lib/codependency/node.rb
 - lib/codependency/parser.rb
 - lib/codependency/version.rb
 - spec/codependency/graph_spec.rb
-- spec/codependency/node_spec.rb
 - spec/codependency/parser_spec.rb
 - spec/spec_helper.rb
 - spec/support/breakfasts_context.rb
@@ -110,10 +108,9 @@ rubyforge_project:
 rubygems_version: 1.8.19
 signing_key: 
 specification_version: 3
-summary: Simple comment-based dependency graph for arbitrary files
+summary: A pure ruby, comment-based dependency graph
 test_files:
 - spec/codependency/graph_spec.rb
-- spec/codependency/node_spec.rb
 - spec/codependency/parser_spec.rb
 - spec/spec_helper.rb
 - spec/support/breakfasts_context.rb

data/lib/codependency/node.rb

@@ -1,26 +0,0 @@
-module Codependency
-  class Node
-    def initialize( filename, parser )
-      raise Errno::ENOENT, filename unless File.exist?( filename )
-      @filename = filename
-      @parser   = parser
-    end
-    attr_reader :filename, :parser
-
-    ##
-    # all of this node's edges
-    def edges
-      @edges ||= begin
-        parser.parse( filename ).map do |f|
-          "#{f}#{File.extname( filename )}"
-        end
-      end
-    end
-
-    ##
-    # a string representing this node's edges, formatted for `tsort`.
-    def dependencies
-      edges.map { |edge| [ filename, edge ] }.flatten.join ' '
-    end
-  end
-end

data/spec/codependency/node_spec.rb

@@ -1,25 +0,0 @@
-require 'spec_helper'
-
-describe Codependency::Node do
-  let( :parser ){ double 'Parser', :parse => [ 'body' ] }
-
-  context 'when the file exists', :files => :planets do
-    subject { Codependency::Node.new 'planet.rb', parser }
-    its( :edges ){ should eq( [ 'body.rb' ] ) }
-  end
-
-  context 'when the file does not exist' do
-    it 'should raise an error' do
-      expect {
-        Codependency::Node.new 'pluto.rb', parser
-      }.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