cells-dependencies 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.md

@@ -0,0 +1,33 @@
+
+# Cell Dependencies
+
+This is little gemmy what let's you declare ahead of render-time
+what other cells a cell depends on. 
+
+Let's say you've got a hot banner that you put in all of your widgets
+
+    class BannerCell < Cell::Rails
+        #... your banner is awesome, and does great stuff.
+    end
+
+You can now declare in your other cells that they use this banner cell
+
+    class WeatherCell < Cell::Rails
+      uses :banner
+      #other great stuff...
+    end
+
+and then query your cell to find out which cells it depends on
+
+    WeatherCell.dependencies #=> [BannerCell]
+
+Dependencies are transitive
+
+    class BannerCell < Cell::Rails
+      uses :logo
+    end
+    
+    WeatherCell.dependencies #=> [BannerCell, LogoCell]
+
+# Why is this useful?
+

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/cells-dependencies.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cell/dependencies/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cells-dependencies"
+  s.version     = Cell::Dependencies::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Charles Lowell"]
+  s.email       = ["cowboyd@thefrontside.net"]
+  s.homepage    = "http://github.com/cowboyd/cells-dependencies"
+  s.summary     = "Say which cells depend on other cells"
+  s.description = "Sometimes its useful to know which cells depend on each other before you actually render them"
+
+  s.rubyforge_project = "cells-dependencies"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency "cells", ">= 3.5.0"
+  
+  s.add_development_dependency "rspec", ">= 2.0.0"
+end

data/lib/cell/dependencies.rb

@@ -0,0 +1,49 @@
+require 'cells'
+require 'cell/dependencies/version'
+require 'active_support/core_ext/class/subclasses'
+    
+module Cell
+  module Dependencies
+
+    def inherited(cls)
+      super
+      cls.extend(Cell::Dependencies)
+    end
+    
+    def uses(*names)
+      @dependencies ||= [] 
+      @dependencies += names
+    end
+
+    def dependencies(seen = Set.new([self]))
+      @dependencies ||= []
+      resolved = @dependencies.map {|n| Cell::Base.class_from_cell_name(n)}
+      resolved.inject(resolved) do |all, dep|
+        if seen.include?(dep)
+          all
+        else
+          seen << dep
+          dep.dependencies(seen) - [self] + all
+        end
+      end
+    end
+    
+    module TotalOrder
+      def total_order
+        seen = Set.new
+        order = []
+        cells = Cell::Base.descendants.sort_by {|cell| cell.cell_name}
+        cells.each do |cell|
+          next if seen.include?(cell)
+          order += cell.dependencies.select {|dep| !seen.include?(dep)} + [cell]
+          seen += order
+        end
+        return order.uniq
+      end
+    end
+
+    Cell::Rails.extend(self)
+    Cell::Rails.extend(TotalOrder)
+  end
+
+end

data/lib/cell/dependencies/version.rb

@@ -0,0 +1,5 @@
+module Cell
+  module Dependencies
+    VERSION = "0.0.1"
+  end
+end

data/spec/cell/dependencies_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Cell::Dependencies do
+
+    before do
+      @cells = {}
+      Cell::Base.stub(:class_from_cell_name) do |name|
+        @cells[name.to_s] or raise "no such cell #{name}"
+      end
+    end
+
+    it "starts out empty" do
+      mock_cell(:A).dependencies.should == []
+    end
+
+    it "can enumerate dependencies" do
+      a = mock_cell(:A)
+      b = mock_cell(:B) do
+        uses :A
+      end
+      c = mock_cell(:C) do
+        uses :B
+      end
+      c.dependencies.should == [a,b]
+    end
+
+    it "can order all cells in order of dependencies" do
+        a = mock_cell(:A) do
+          uses :B, :G
+        end
+        b = mock_cell(:B) do
+          uses :C
+        end
+        c = mock_cell(:C)
+        d = mock_cell(:D)
+        f = mock_cell(:F)
+        g = mock_cell(:G)
+        h = mock_cell(:H) do
+          uses :A,:D
+        end
+        i = mock_cell(:I) do
+          uses :H
+        end
+      Cell::Base.stub(:descendants).and_return(@cells.values)
+        Cell::Rails.total_order.should == [c,b,g,a,d,f,h,i]
+    end
+  
+  def mock_cell(name, &body)
+    Class.new(Cell::Rails).tap do |cell|
+      mc = class << cell;self;end
+      mc.send(:define_method, :to_s) do
+        "#{name}"
+      end
+      mc.send(:define_method, :cell_name) do
+        "#{name}"
+      end
+      @cells[name.to_s] = cell
+      def cell.view_paths
+        ["/mock/cells"]
+      end
+      cell.class_eval(&body) if block_given?
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+
+require 'bundler/setup'
+require 'action_controller'
+require 'rails'
+require 'cell/dependencies'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: cells-dependencies
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Charles Lowell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-23 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cells
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 3
+        - 5
+        - 0
+        version: 3.5.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+description: Sometimes its useful to know which cells depend on each other before you actually render them
+email: 
+- cowboyd@thefrontside.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- cells-dependencies.gemspec
+- lib/cell/dependencies.rb
+- lib/cell/dependencies/version.rb
+- spec/cell/dependencies_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/cowboyd/cells-dependencies
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: cells-dependencies
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Say which cells depend on other cells
+test_files: 
+- spec/cell/dependencies_spec.rb
+- spec/spec_helper.rb