codependency 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in codependency.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jeremy Ruppel
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+# Codependency
+
+Codependency is a simple comment-based dependency graph that you can use on arbitrary files. At the moment, it only supports ruby-style comments, files with the `.rb` extension, and files in the same flat directory.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'codependency'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install codependency
+
+## 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:
+
+**bar.rb:**
+
+``` rb
+# require foo
+
+class Bar
+end
+```
+
+**foo.rb:**
+
+``` rb
+class Foo
+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"]
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+

data/codependency.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-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.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "codependency"
+  gem.require_paths = ["lib"]
+  gem.version       = Codependency::VERSION
+
+  gem.add_development_dependency 'rspec', '>= 2.10.0'
+end

data/lib/codependency.rb

@@ -0,0 +1,7 @@
+require 'codependency/version'
+
+module Codependency
+  autoload :Graph,  'codependency/graph'
+  autoload :Node,   'codependency/node'
+  autoload :Parser, 'codependency/parser'
+end

data/lib/codependency/graph.rb

@@ -0,0 +1,28 @@
+module Codependency
+  class Graph
+    def initialize( filenames )
+      @nodes = Hash[ filenames.map { |f| [ f, Node.new( f ) ] } ]
+    end
+    attr_reader :nodes
+
+    def files
+      nodes.reduce( [ ] ) do |list, (filename, node)|
+        resolve node, list
+        list
+      end
+    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
+        end
+        list << node.filename
+      end
+    end
+  end
+end

data/lib/codependency/node.rb

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

data/lib/codependency/parser.rb

@@ -0,0 +1,16 @@
+module Codependency
+  class Parser
+
+    def parse( file )
+      IO.readlines( file ).take_while do |line|
+        line =~ pattern
+      end.map { |line| line[ pattern, 1 ] }
+    end
+
+    protected
+
+    def pattern
+      @pattern ||= /^# require (.+)$/
+    end
+  end
+end

data/lib/codependency/version.rb

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

data/spec/codependency/graph_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Codependency::Graph do
+  let( :path ){ File.join( File.dirname( __FILE__ ), '../fixtures' ) }
+  subject { Codependency::Graph.new Dir[ File.join( path, '*.rb' ) ] }
+
+  its( :files ){ should eq(
+    [
+      "#{path}/body.rb",
+      "#{path}/planet.rb",
+      "#{path}/earth.rb",
+      "#{path}/mars.rb",
+      "#{path}/phobos.rb"
+    ]
+  ) }
+end

data/spec/codependency/node_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Codependency::Node do
+  let( :path ){ File.join( File.dirname( __FILE__ ), '../fixtures' ) }
+
+  context 'when the file exists' do
+    subject { Codependency::Node.new "#{path}/planet.rb" }
+
+    its( :dependencies ){ should eq( [ "#{path}/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 )
+    end
+  end
+end

data/spec/codependency/parser_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Codependency::Parser do
+  let( :path   ){ File.join( File.dirname( __FILE__ ), '../fixtures' ) }
+  let( :parser ){ Codependency::Parser.new }
+
+  context 'body' do
+    subject { parser.parse( "#{path}/body.rb" ) }
+    it { should eq( [ ] ) }
+  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 'planet' do
+    subject { parser.parse( "#{path}/planet.rb" ) }
+    it { should eq( [ 'body' ] ) }
+  end
+end

data/spec/fixtures/body.rb

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

data/spec/fixtures/earth.rb

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

data/spec/fixtures/mars.rb

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

data/spec/fixtures/phobos.rb

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

data/spec/fixtures/planet.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'codependency'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = :documentation
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: codependency
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Ruppel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-09 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+description: Simple comment-based dependency graph for arbitrary files
+email:
+- jeremy.ruppel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- 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/fixtures/body.rb
+- spec/fixtures/earth.rb
+- spec/fixtures/mars.rb
+- spec/fixtures/phobos.rb
+- spec/fixtures/planet.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.19
+signing_key: 
+specification_version: 3
+summary: Simple comment-based dependency graph for arbitrary files
+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