depression 0.0.3 → 0.1.0

data/README.md

@@ -0,0 +1,75 @@
+Easy Resolution of Before/After Relations For Ruby
+==================================================
+
+Depression resolves before/after relations by forming a graph of them and
+flattening it. It supports simple before/after as well as "greedy" relations.
+
+Getting Started
+---------------
+
+    $ gem install depression
+
+After installation the first steps are really easy. You simply need a bunch of
+objects that respond to `#name` as well as `#relations` and return something
+more or less unique and a hash, resp.
+
+    require "depression"
+    
+    Item = Struct.new(:name, :relations)
+    items = [
+      Item.new(:foo, {}),
+      Item.new(:bar, :before => [:foo]),
+      Item.new(:baz, :after => [:foo])
+    ]
+    
+    sorted = Depression.process(items)
+    puts sorted.map {|i| i.name }.join(",")
+    # bar,foo,baz
+
+Greedy Relations
+----------------
+
+TODO
+
+Resolving Conflicts
+-------------------
+
+TODO
+
+Resolving Circular Relations
+----------------------------
+
+TODO
+
+Dependencies
+------------
+
+* [mocha](https://rubygems.org/gems/mocha) and
+  [test-unit](https://rubygems.org/gems/test-unit) for development
+
+Runs fine on Ruby 1.9.2 and JRuby 1.5.6.
+
+To do & Ideas
+-------------
+
+* Gracefully drop greedy relations if they conflict with normal relations
+* Implement a "friendly" mode that simply drops "older" relations until a
+  circular relation is resolved
+* Visualize various stages of relation resolution (probably via GraphViz)
+* Maybe switch to TSort
+
+Contributing
+------------
+
+1. Fork at [github.com/lgierth/depression](https://github.com/lgierth/depression)
+2. Create a new branch
+3. Commit, commit, commit!
+4. Open a Pull Request
+
+You can also open an issue for discussion first, if you want.
+
+License
+-------
+
+Depression is subject to an MIT-style license that can be found in the LICENSE
+file.

data/depression.gemspec

@@ -10,13 +10,10 @@ Gem::Specification.new do |s|
   s.authors     = ["Lars Gierth"]
   s.email       = ["lars.gierth@gmail.com"]
   s.homepage    = "http://rubygems.org/gems/depression"
-  s.summary     = %q{Easy resolution of before/after relations for Ruby}
-  s.description = %q{depression resolves before/after relations ny forming a
-                     graph of them and flattening it. Simple before/after
-                     relations are supported as well as "greedy" relations
-                     (before/after all other items) with simple relations being
-                     more important in the case of a conflict. Circular
-                     dependencies are detected and cause an exception.}
+  s.summary     = %q{Easy Resolution of Before/After Relations For Ruby}
+  s.description = %q{Depression resolves before/after relations by forming a
+                     graph of them and flattening it. It supports simple
+                     before/after as well as "greedy" relations.}
 
   s.add_development_dependency "test-unit"
   s.add_development_dependency "mocha"

data/lib/depression/version.rb

@@ -1,3 +1,3 @@
 class Depression
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/test/depression_test.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/helper"
+require File.expand_path("../helper", __FILE__)
 
 class DepressionTest < Test::Unit::TestCase
   def setup

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: depression
 version: !ruby/object:Gem::Version 
-  hash: 25
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 3
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - Lars Gierth
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-23 00:00:00 +01:00
+date: 2011-01-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,7 +25,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
@@ -40,19 +38,15 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
   version_requirements: *id002
 description: |-
-  depression resolves before/after relations ny forming a
-                       graph of them and flattening it. Simple before/after
-                       relations are supported as well as "greedy" relations
-                       (before/after all other items) with simple relations being
-                       more important in the case of a conflict. Circular
-                       dependencies are detected and cause an exception.
+  Depression resolves before/after relations by forming a
+                       graph of them and flattening it. It supports simple
+                       before/after as well as "greedy" relations.
 email: 
 - lars.gierth@gmail.com
 executables: []
@@ -64,7 +58,7 @@ extra_rdoc_files: []
 files: 
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - depression.gemspec
 - lib/depression.rb
@@ -85,7 +79,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -94,7 +87,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -104,6 +96,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Easy resolution of before/after relations for Ruby
+summary: Easy Resolution of Before/After Relations For Ruby
 test_files: []
 

data/README.rdoc

@@ -1,7 +0,0 @@
-= Easy resolution of before/after relations for Ruby
-
-== Todo
-
-* Drop greedy relations if they conflict with simple relations.
-* Implement a "friendly" mode that doesn't raise errors but simply drops
-  "older" relations until a circular relation is resolved.