codependency 1.0.0 → 2.0.0

data/Guardfile

@@ -1,6 +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' }
+  watch( %r{^spec/.+_spec\.rb$}  )
+  watch( %r{^lib/(.+)\.rb$}      ){ |m| "spec/#{m[1]}_spec.rb" }
+  watch( 'spec/spec_helper.rb'   ){ 'spec' }
+  watch( %r{spec/support/.+\.rb} ){ 'spec' }
 end

data/README.md

@@ -18,12 +18,14 @@ Or install it yourself as:
 
 ## Usage
 
-Say you have two files, `bar.rb` and `foo.rb`. `bar` comes before `foo` in a natural naming scheme, but `bar` has a dependency on `foo`. We can express this using a simple comment syntax at the head of the file like this:
+Say you have two files, `bar.rb` and `foo.rb`. `bar` comes before `foo` in a
+natural naming scheme, but `bar` has a dependency on `foo`. We can express
+this using a simple comment syntax at the head of the file like this:
 
 **bar.rb:**
 
 ``` rb
-# require foo
+#= require foo
 
 class Bar
 end
@@ -39,8 +41,9 @@ 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 "bar.rb"
-graph.files # => ["./foo.rb", "./bar.rb"]
+graph = Codependency::Graph.new
+graph.path << '.' # works like PATH, append search paths for this graph
+graph.files # => ["./foo.rb", "./bar.rb"] # returns a topologically sorted list of relative filepaths
 ```
 
 ## Contributing

data/codependency.gemspec

@@ -6,7 +6,8 @@ Gem::Specification.new do |gem|
   gem.email         = ["jeremy.ruppel@gmail.com"]
   gem.description   = %q{A pure ruby, comment-based dependency graph}
   gem.summary       = %q{A pure ruby, comment-based dependency graph}
-  gem.homepage      = ""
+  gem.homepage      = 'https://github.com/jeremyruppel/codependency'
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -15,7 +16,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Codependency::VERSION
 
-  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'
+  gem.add_development_dependency 'rspec',         '2.12.0'
+  gem.add_development_dependency 'guard-rspec',   '1.2.1'
+  gem.add_development_dependency 'rb-fsevent',    '0.9.1'
+  gem.add_development_dependency 'git-approvals', '0.2.0'
 end

data/lib/codependency.rb

@@ -3,4 +3,5 @@ require 'codependency/version'
 module Codependency
   autoload :Graph,  'codependency/graph'
   autoload :Parser, 'codependency/parser'
+  autoload :Path,   'codependency/path'
 end

data/lib/codependency/graph.rb

@@ -2,59 +2,52 @@ require 'tsort'
 
 module Codependency
   class Graph < Hash
-    def initialize( path, options={} )
-      @path, @options = path, options
-
-      super( ){ |h, k| h[ k ] = parser.parse( k ) }
-    end
-    attr_reader :path, :options
-
-    include TSort
 
     ##
-    # the dirname to use for this graph, based on the path
-    def dirname
-      File.dirname path
-    end
-
-    ##
-    # the extname to use for this graph, based on the path
-    def extname
-      File.extname path
+    # Adds a file to the dependency graph. The filename given should be
+    # relative and should not contain an extension, like:
+    #
+    # # require application/user
+    #
+    # Attempts to locate and add all dependencies of this file recursively,
+    # creating our graph.
+    def require( file )
+      self[ file ] ||= parser.parse path[ file ]
+      self[ file ].each do |file|
+        self << file unless key?( file )
+      end
     end
+    alias :<< :require
 
     ##
-    # walk the entire graph and return self
-    def populate
-      walk path
-      self
+    # Returns the sorted list of files as determined by this graph,
+    # relative to the calling file.
+    def files
+      here = Pathname( caller.first.split( ':' ).shift )
+      tsort.map { |file| path[ file ].relative_path_from( here ) }
     end
 
     ##
-    # discover all nodes in this graph by walking it
-    def walk( path )
-      self[ path ].each { |path| walk( path ) unless has_key?( path ) }
+    # The path set for this dependency graph.
+    def path
+      @path ||= Path.new parser.extensions
     end
 
     ##
-    # the parser to use for this graph. shared by all nodes.
+    # The file parser for this dependency graph.
     def parser
-      @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
+      @parser ||= Parser.new
     end
 
     private
 
+    include TSort
+
+    ##
     # tsort interface
     alias :tsort_each_node :each_key
 
+    ##
     # tsort interface
     def tsort_each_child( node, &block )
       fetch( node ).each( &block )

data/lib/codependency/parser.rb

@@ -1,28 +1,24 @@
 module Codependency
   class Parser
 
-    def initialize( options={} )
-      @options = options
-      @comment = options.delete( :comment ) || '#'
-      @dirname = options.delete( :dirname ) || '.'
-      @extname = options.delete( :extname ) || '.rb'
-    end
+    PATTERNS = Hash.new { |hash, key|
+      raise "Unknown extension '#{key}'. Known extensions are #{hash.keys.inspect}."
+    }
+    PATTERNS[ '.rb' ] = /^#= require ([\w\/]+)$/
+    PATTERNS[ '.js' ] = /^\/\/= require ([\w\/]+)$/
 
     ##
-    # determines a file's dependencies based on the configured comment pattern.
+    # Determines a file's dependencies based on the file's extension.
     def parse( file )
+      pattern = PATTERNS[ File.extname( file ) ]
+
       IO.readlines( file ).take_while do |line|
         line =~ pattern
-      end.map { |line| "#{@dirname}/#{line[ pattern, 1 ]}#{@extname}" }
+      end.map { |line| line[ pattern, 1 ] }
     end
 
-    protected
-
-    ##
-    # the comment pattern to use.
-    # TODO allow this to be more configurable
-    def pattern
-      @pattern ||= /^#{@comment} require (.+)$/
+    def extensions
+      PATTERNS.keys
     end
   end
 end

data/lib/codependency/path.rb

@@ -0,0 +1,53 @@
+require 'pathname'
+
+module Codependency
+  class Path < Array
+
+    def initialize( extensions=%w| .rb | )
+      @extensions = Array(extensions)
+    end
+    attr_reader :extensions
+
+    ##
+    # Appends a path to this path set. If the path exists, it
+    # will be expanded. Raises Errno::ENOENT if the path
+    # does not exist. Raises Errno::ENOTDIR if the path
+    # is not a directory.
+    def <<( str )
+      path = Pathname( str )
+
+      case
+      when !path.exist?
+        raise Errno::ENOENT, path.to_path
+      when !path.directory?
+        raise Errno::ENOTDIR, path.to_path
+      else
+        super path.expand_path
+      end
+    end
+
+    ##
+    # Sugar syntax for calling #find if given a string.
+    # Otherwise, behaves like normal array access.
+    def []( path_or_index )
+      if path_or_index.is_a? String
+        find path_or_index
+      else
+        super
+      end
+    end
+
+    ##
+    # Attempts to find the given file in this path set.
+    # Raises Errno::ENOENT if the file cannot be found.
+    def find( str )
+      super lambda { raise Errno::ENOENT, str } do |dir|
+        path = extensions.find do |ext|
+          file = dir.join str + ext
+          break file if file.exist?
+        end
+        break path if path
+      end
+    end
+  end
+end

data/lib/codependency/version.rb

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

data/spec/codependency/graph_spec.rb

@@ -1,74 +1,112 @@
 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
+  it { should be_a( Hash ) }
 
-  describe 'populate', :files => :planets do
-    subject { described_class.new './phobos.rb' }
+  describe '#path' do
+    its( :path ){ should be_a( Codependency::Path ) }
+    its( :path ){ should be_empty }
+  end
 
-    context 'initially' do
-      it { should be_empty }
-    end
+  describe '#require' do
+    let( :dirname  ){ example.example_group.description }
+    let( :basename ){ example.description }
+    let( :file     ){ File.join dirname, basename }
 
-    context 'after calling populate' do
-      before { subject.populate }
+    before { subject.path << './spec/fixtures' }
+    before { subject << file }
 
-      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'   => [ ] ) }
+    describe 'solar_system' do
+      example( 'body'   ){ verify { subject } }
+      example( 'earth'  ){ verify { subject } }
+      example( 'mars'   ){ verify { subject } }
+      example( 'phobos' ){ verify { subject } }
+      example( 'planet' ){ verify { subject } }
     end
-
-    it 'should return itself' do
-      subject.populate.should == subject
+    describe 'breakfast' do
+      example( 'butter'   ){ verify { subject } }
+      example( 'egg'      ){ verify { subject } }
+      example( 'sandwich' ){ verify { subject } }
+      example( 'toast'    ){ verify { subject } }
     end
-  end
-
-  context 'planets', :files => :planets do
-    subject { described_class.new start }
-
-    context 'earth' do
-      let( :start ){ './earth.rb' }
-      its( :files ){ should eq( %w| ./body.rb ./planet.rb ./earth.rb | ) }
+    describe 'lox' do
+      example( 'money'   ){ verify { subject } }
+      example( 'power'   ){ verify { subject } }
+      example( 'respect' ){ verify { subject } }
     end
-
-    context 'phobos' do
-      let( :start ){ './phobos.rb' }
-      its( :files ){ should eq( %w| ./body.rb ./planet.rb ./mars.rb ./phobos.rb | ) }
+    describe 'assets' do
+      example( 'templates/account' ){ verify { subject } }
+      example( 'templates/history' ){ verify { subject } }
+      example( 'templates/user'    ){ verify { subject } }
+      example( 'application'       ){ verify { subject } }
     end
   end
 
-  context 'breakfasts', :files => :breakfasts do
-    subject { described_class.new start, :comment => '//' }
+  describe '#tsort' do
+    let( :dirname  ){ example.example_group.description }
+    let( :basename ){ example.description }
+    let( :file     ){ File.join dirname, basename }
+
+    before { subject.path << './spec/fixtures' }
+    before { subject << file }
 
-    context 'sandwich' do
-      let( :start ){ './sandwich.js' }
-      its( :files ){ should eq( %w| ./butter.js ./egg.js ./toast.js ./sandwich.js | ) }
+    describe 'solar_system' do
+      example( 'body'   ){ verify { subject.tsort } }
+      example( 'earth'  ){ verify { subject.tsort } }
+      example( 'mars'   ){ verify { subject.tsort } }
+      example( 'phobos' ){ verify { subject.tsort } }
+      example( 'planet' ){ verify { subject.tsort } }
+    end
+    describe 'breakfast' do
+      example( 'butter'   ){ verify { subject.tsort } }
+      example( 'egg'      ){ verify { subject.tsort } }
+      example( 'sandwich' ){ verify { subject.tsort } }
+      example( 'toast'    ){ verify { subject.tsort } }
+    end
+    describe 'lox' do
+      example( 'money'   ){ expect { subject.tsort }.to raise_error( TSort::Cyclic ) }
+      example( 'power'   ){ expect { subject.tsort }.to raise_error( TSort::Cyclic ) }
+      example( 'respect' ){ expect { subject.tsort }.to raise_error( TSort::Cyclic ) }
+    end
+    describe 'assets' do
+      example( 'templates/account' ){ verify { subject.tsort } }
+      example( 'templates/history' ){ verify { subject.tsort } }
+      example( 'templates/user'    ){ verify { subject.tsort } }
+      example( 'application'       ){ verify { subject.tsort } }
     end
   end
 
-  context 'circular dependencies', :files => :circular do
-    subject { described_class.new start }
+  describe '#files' do
+    let( :dirname  ){ example.example_group.description }
+    let( :basename ){ example.description }
+    let( :file     ){ File.join dirname, basename }
 
-    let( :start ){ './money.rb' }
+    before { subject.path << './spec/fixtures' }
+    before { subject << file }
 
-    it 'should raise an error' do
-      expect { subject.files }.to raise_error( TSort::Cyclic )
+    describe 'solar_system' do
+      example( 'body'   ){ verify { subject.files } }
+      example( 'earth'  ){ verify { subject.files } }
+      example( 'mars'   ){ verify { subject.files } }
+      example( 'phobos' ){ verify { subject.files } }
+      example( 'planet' ){ verify { subject.files } }
     end
-  end
-
-  context 'subdirectories', :files => :subdirectories do
-    subject { described_class.new start, :comment => '//' }
-
-    context 'application.js' do
-      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 | ) }
+    describe 'breakfast' do
+      example( 'butter'   ){ verify { subject.files } }
+      example( 'egg'      ){ verify { subject.files } }
+      example( 'sandwich' ){ verify { subject.files } }
+      example( 'toast'    ){ verify { subject.files } }
+    end
+    describe 'lox' do
+      example( 'money'   ){ expect { subject.tsort }.to raise_error( TSort::Cyclic ) }
+      example( 'power'   ){ expect { subject.tsort }.to raise_error( TSort::Cyclic ) }
+      example( 'respect' ){ expect { subject.tsort }.to raise_error( TSort::Cyclic ) }
+    end
+    describe 'assets' do
+      example( 'templates/account' ){ verify { subject.files } }
+      example( 'templates/history' ){ verify { subject.files } }
+      example( 'templates/user'    ){ verify { subject.files } }
+      example( 'application'       ){ verify { subject.files } }
     end
   end
 end

data/spec/codependency/graph_spec/codependency_graph/files/assets/application.txt

@@ -0,0 +1,6 @@
+[
+  [0] #<Pathname:../../fixtures/assets/templates/history.js>,
+  [1] #<Pathname:../../fixtures/assets/templates/account.js>,
+  [2] #<Pathname:../../fixtures/assets/templates/user.js>,
+  [3] #<Pathname:../../fixtures/assets/application.js>
+]

data/spec/codependency/graph_spec/codependency_graph/files/assets/templates_account.txt

@@ -0,0 +1,3 @@
+[
+  [0] #<Pathname:../../fixtures/assets/templates/account.js>
+]

data/spec/codependency/graph_spec/codependency_graph/files/assets/templates_history.txt

@@ -0,0 +1,3 @@
+[
+  [0] #<Pathname:../../fixtures/assets/templates/history.js>
+]

data/spec/codependency/graph_spec/codependency_graph/files/assets/templates_user.txt

@@ -0,0 +1,5 @@
+[
+  [0] #<Pathname:../../fixtures/assets/templates/history.js>,
+  [1] #<Pathname:../../fixtures/assets/templates/account.js>,
+  [2] #<Pathname:../../fixtures/assets/templates/user.js>
+]

data/spec/codependency/graph_spec/codependency_graph/files/breakfast/butter.txt

@@ -0,0 +1,3 @@
+[
+  [0] #<Pathname:../../fixtures/breakfast/butter.js>
+]