class_dependencies 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Trampoline Systems Ltd
+
+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.rdoc

@@ -0,0 +1,32 @@
+= class_dependencies
+
+say you have a bunch of classes which have dependencies amongst them, e.g. you have
+A and B which both have a common parent, say Top, and they have a common operation
+but you have to do it to A before you do it to B. then :
+
+  class Top ; include Sonar::ClassDependencies ; end
+  class A < Top ; end
+  class B < Top ; depends_on :a ; end
+
+  Top.ordered_dependencies
+  =>[:a, :b]
+  Top.ordered_dependent_classes
+  =>[A, B]
+
+== Install
+
+  gem install class_dependencies
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Trampoline Systems Ltd. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "class_dependencies"
+    gem.summary = %Q{manage dependencies amongst classes from a hierarchy}
+    gem.description = %Q{provides class methods for declaring and querying dependencies amongst classes in a hierarchy}
+    gem.email = "craig@trampolinesystems.com"
+    gem.homepage = "http://github.com/mccraigmccraig/class_dependencies"
+    gem.authors = ["mccraig mccraig of the clan mccraig"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "class_dependencies #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/class_dependencies.rb

@@ -0,0 +1,98 @@
+require 'set'
+
+# when included, defines a class method on the module
+# which can be used to declare dependencies amongst descendants
+# of that module
+# e.g.
+# class Top ; include Sonar::ClassDependencies ; end
+# class A < Top ; depends_on :b ; end
+# class B < Top ; depends_on :c ; end
+# class C < Top ; end
+#
+# Top.ordered_dependencies
+# => [:c, :b, :a]
+# Top.ordered_dependent_classes
+# => [C, B, A]
+#
+module Sonar
+  module ClassDependencies
+    class << self
+
+      # generates a method from a closure returning the value
+      def generate_closure_value_method(obj, method_name, value)
+        obj.send(:define_method, method_name) do
+          value
+        end
+      end
+
+      def included(mod)
+        mod.instance_eval do
+          class << self
+            ClassDependencies::generate_closure_value_method(self, :class_dependencies, {})
+            ClassDependencies::generate_closure_value_method(self, :descendants, [])
+            include( ClassMethods )
+          end 
+        end
+      end
+    end
+    
+    module ClassMethods
+      def inherited(subclass)
+        descendants << subclass.to_s.underscore.to_sym
+      end
+
+      def class_to_sym(klass)
+        klass.to_s.underscore.to_sym
+      end
+
+      def sym_to_class(sym)
+        eval(sym.to_s.camelize)
+      end
+
+      def depends_on(dep)
+        add_dependency(self, dep)
+      end
+
+      def all_dependencies_of(from)
+        from_sym = class_to_sym(from)
+        find_dependencies_of(from_sym, Set.new()).delete(from).to_a
+      end
+
+      def ordered_dependencies
+        descendants.sort do |a,b| 
+          if all_dependencies_of(a).include?(b)
+            +1
+          elsif all_dependencies_of(b).include?(a)
+            -1
+          else
+            0
+          end
+        end
+      end
+
+      def ordered_dependent_classes
+        ordered_dependencies.map{|sym| sym_to_class(sym)}
+      end
+
+      private
+
+      def add_dependency(from, to)
+        from_sym = class_to_sym(from)
+        to_sym = class_to_sym(to)
+        return if from_sym == to_sym
+        deps = (class_dependencies[from_sym] ||= [])
+        raise "circular dependency" if all_dependencies_of(to_sym).include?(from_sym)
+        deps << to_sym
+        nil
+      end
+
+      def find_dependencies_of(from, deps)
+        deps << from
+        (class_dependencies[from]||[]).each do |dep|
+          find_dependencies_of(dep, deps) if !deps.include?(dep)
+        end
+        deps
+      end
+    end
+  end
+end

data/spec/class_dependencies_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+# camelize and underscore take from ActiveSupport
+module Inflector
+  extend self
+  
+  def camelize(lower_case_and_underscored_word, first_letter_in_uppercase = true)
+    if first_letter_in_uppercase
+      lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    else
+      lower_case_and_underscored_word.first.downcase + camelize(lower_case_and_underscored_word)[1..-1]
+    end
+  end
+
+  def underscore(camel_cased_word)
+    camel_cased_word.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+  end
+end
+class String
+  def camelize
+    Inflector::camelize(self)
+  end
+  def underscore
+    Inflector::underscore(self)
+  end
+end
+
+describe "ClassDependencies" do
+  
+  class Top
+    include Sonar::ClassDependencies
+  end
+
+  class A < Top
+    depends_on :b
+  end
+
+  class B < Top
+    depends_on :c
+  end
+
+  class C < Top
+  end
+  
+
+  it "should correctly order class dependences" do
+    Top.ordered_dependencies.should == [:c, :b, :a]
+  end
+
+  it "should record dependency declarations" do
+    Top.class_dependencies.should == {:a=>[:b], :b=>[:c]}
+  end
+  
+  it "should record class inheritance" do
+    Top.descendants == [:a, :b, :c]
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'class_dependencies'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: class_dependencies
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- mccraig mccraig of the clan mccraig
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-22 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: provides class methods for declaring and querying dependencies amongst classes in a hierarchy
+email: craig@trampolinesystems.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/class_dependencies.rb
+- spec/class_dependencies_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mccraigmccraig/class_dependencies
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: manage dependencies amongst classes from a hierarchy
+test_files: 
+- spec/class_dependencies_spec.rb
+- spec/spec_helper.rb