exegesis 0.0.4 → 0.0.5

data/lib/exegesis/registerable.rb

@@ -1,57 +1,59 @@
-module Registerable
-  def self.included(base)
-    base.instance_eval do
-      extend  ClassMethods
-      include InstanceMethods
+module Exegesis
+  module Registerable
+    def self.included(base)
+      base.instance_eval do
+        extend  ClassMethods
+        include InstanceMethods
+      end
     end
-  end
 
-  module ClassMethods
-    def create(*args)
-      retrieve(*args) || build(*args)
-    end
+    module ClassMethods
+      def create(*args)
+        retrieve(*args) || build(*args)
+      end
 
-    def retrieve(*args)
-      path = build_path(*args.take(2))
-      registry[path] if registry.has_key?(path)
-    end
+      def retrieve(*args)
+        path = build_path(*args.take(2))
+        registry[path] if registry.has_key?(path)
+      end
 
-    def build(*args)
-      new(*args).tap do |instance|
-        registry.register! instance
+      def build(*args)
+        new(*args).tap do |instance|
+          registry.register! instance
+        end
       end
-    end
 
-    def registry
-      @flyweight ||= Flyweight.new do |dir|
-        if dir.respond_to? :path
-          dir.path
-        else
-          dir
+      def registry
+        @flyweight ||= Flyweight.new do |dir|
+          if dir.respond_to? :path
+            dir.path
+          else
+            dir
+          end
         end
       end
-    end
 
-    def clear_registry!
-      registry.clear!
-    end
+      def clear_registry!
+        registry.clear!
+      end
 
-    def build_path(*args)
-      parent, name = *args
-      return parent if name.nil?
-      File.join(parent.path, name)
+      def build_path(*args)
+        parent, name = *args
+        return parent if name.nil?
+        File.join(parent.path, name)
+      end
     end
-  end
 
-  module InstanceMethods
-    def path
-      build_path(parent, name)
-    end
+    module InstanceMethods
+      def path
+        build_path(parent, name)
+      end
 
-    private
+      private
 
-    def build_path(parent, child)
-      self.class.build_path(parent, child)
+      def build_path(parent, child)
+        self.class.build_path(parent, child)
+      end
     end
   end
 end

data/lib/exegesis/source_file.rb

@@ -17,32 +17,34 @@
 # Collaborators:
 #   SourceFile
 #   SourceFileFactory       -- to build the appropriate subclass based on file extenstion
-class SourceFile
-  include FileSystemEntity
+module Exegesis
+  class SourceFile
+    include FileSystemEntity
 
-  def content
-    fs_interface.read(path)
-  end
+    def content
+      fs_interface.read(path)
+    end
 
-  attr_reader :dependencies
-  def depends_on(file)
-    raise InvalidDependency unless file.is_a?(SourceFile)
-    @dependencies << file
-  end
+    attr_reader :dependencies
+    def depends_on(file)
+      raise InvalidDependency unless file.is_a?(SourceFile)
+      @dependencies << file
+    end
 
-  private
+    private
 
-  def initialize(parent, name, fs_interface = File)
-    raise ArgumentError, "parent must be a directory" unless parent.is_a?(Directory)
+    def initialize(parent, name, fs_interface = File)
+      raise ArgumentError, "parent must be a directory" unless parent.is_a?(Directory)
 
-    @fs_interface = fs_interface
-    @ext = fs_interface.extname(name)
-    @name = name
-    @parent = parent
-    @dependencies = []
+      @fs_interface = fs_interface
+      @ext = fs_interface.extname(name)
+      @name = name
+      @parent = parent
+      @dependencies = []
+    end
+
+    attr_reader :fs_interface
   end
 
-  attr_reader :fs_interface
+  class InvalidDependency < StandardError ; end
 end
-
-class InvalidDependency < StandardError ; end

data/lib/exegesis/version.rb

@@ -1,4 +1,4 @@
 module Exegesis
   #@private
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/integration/flyweight_registerable_spec.rb

@@ -1,9 +1,9 @@
 require 'integration_spec_helper'
 
-describe Flyweight, "mixin", "other objects" do
+describe Exegesis::Flyweight, "mixin", "other objects" do
   before do
     class Example
-      include Registerable
+      include Exegesis::Registerable
       def initialize(parent, name, *args)
         @parent = parent
         @name = name

data/spec/integration/visitor_spec.rb

@@ -1,7 +1,7 @@
 require 'integration_spec_helper'
 
 describe '#visit' do
-  let (:dir) { BaseDirectory.create('./spec/fake_project') }
+  let (:dir) { Exegesis::BaseDirectory.create('./spec/fake_project') }
 
   context 'visitor with a proc' do
     subject { proc { } }

data/spec/shared/file_system_entity_examples.rb

@@ -0,0 +1,15 @@
+shared_examples_for 'a FileSystemEntity' do
+  describe 'api' do
+    it { should respond_to :path      }
+    it { should respond_to :basename  }
+    it { should respond_to :visit     }
+
+    it { should respond_to :parent    }
+    it { should respond_to :container } #alias
+
+    it { should respond_to :name }
+
+    it { should respond_to :ext       }
+    it { should respond_to :extension } #alias
+  end
+end

data/spec/spec_helper.rb

@@ -11,14 +11,17 @@ require 'rspec-spies'
 #include helpers
 Dir["./spec/helpers/*.rb"].each { |file| require file }
 
+#include shared examples
+Dir["./spec/shared/*_examples.rb"].each { |file| require file }
+
 RSpec.configure do |config|
   config.before do
     allow_message_expectations_on_nil
   end
 
   config.after do
-    SourceFile.clear_registry!
-    Directory.clear_registry!
+    Exegesis::SourceFile.clear_registry!
+    Exegesis::Directory.clear_registry!
   end
 
   config.treat_symbols_as_metadata_keys_with_true_values = true

data/spec/unit/base_directory_spec.rb

@@ -1,13 +1,12 @@
 require 'unit_spec_helper'
 
-describe BaseDirectory do
+describe Exegesis::BaseDirectory do
   let (:root)     { double('some path to a project directory').as_null_object }
   let (:searcher) { double('directory searcher like FileSearcher') }
   let (:dir)      { double('fake directory') }
   let (:file)     { double('fake file') }
 
-  let (:project) { BaseDirectory.create(root, searcher) }
-
+  let (:project) { Exegesis::BaseDirectory.create(root, searcher) }
 
   before do
     searcher.stub(:[]).with(root + '*').and_return([dir, file])
@@ -15,30 +14,30 @@ describe BaseDirectory do
     searcher.stub(:search).and_return(searcher)
   end
 
-  context do
-    subject { project }
-
-    describe 'api' do
-      it { should be_a Directory }
-      it { should respond_to :root }
-      it { should respond_to :directories }
-      it { should respond_to :files }
-    end
-
-    describe '#root' do
-      subject { project.root }
-      it { should == root }
-    end
-
-    it { should delegate(:files).to(searcher) }
-    it { should delegate(:directories).to(searcher) }
-
-    #it should also provide interface for
-    #  * creating files/directories
-    #    - something like `directories << Directory('foo')` ?
-    #
-    #  *
-    #
-    #it should also have a #visit method, see the NOTES doc for details on that
+  subject { project }
+
+  it_should_behave_like 'a FileSystemEntity'
+
+  describe 'api' do
+    it { should be_a Exegesis::Directory }
+    it { should respond_to :root }
+    it { should respond_to :directories }
+    it { should respond_to :files }
   end
+
+  describe '#root' do
+    subject { project.root }
+    it { should == root }
+  end
+
+  it { should delegate(:files).to(searcher) }
+  it { should delegate(:directories).to(searcher) }
+
+  #it should also provide interface for
+  #  * creating files/directories
+  #    - something like `directories << Directory('foo')` ?
+  #
+  #  *
+  #
+  #it should also have a #visit method, see the NOTES doc for details on that
 end

data/spec/unit/directory_spec.rb

@@ -1,14 +1,14 @@
 require 'unit_spec_helper'
 
-describe Directory do
+describe Exegesis::Directory do
   let (:parent)      { double('parent directory')               }
   let (:parent_path) { 'parent/'                                }
   let (:name)        { 'subdir/'                                }
   let (:searcher)    { double('searcher')                       }
-  let (:directory)   { Directory.create(parent, name, searcher) }
+  let (:directory)   { Exegesis::Directory.create(parent, name, searcher) }
 
   before do
-    parent.stub(:is_a?).with(Directory).and_return(true)
+    parent.stub(:is_a?).with(Exegesis::Directory).and_return(true)
     parent.stub(:path).and_return(parent_path)
 
     searcher.stub(:new).and_return(searcher)
@@ -16,12 +16,16 @@ describe Directory do
 
   subject { directory }
 
+  it_should_behave_like 'a FileSystemEntity'
+
   describe 'api' do
-    it { should respond_to :directories }
-    it { should respond_to :parent      }
-    it { should respond_to :files       }
-    it { should respond_to :path        }
-    it { should respond_to :children    }
+    it { should respond_to :directories    }
+    it { should respond_to :parent         }
+    it { should respond_to :files          }
+    it { should respond_to :path           }
+    it { should respond_to :children       }
+    it { should respond_to :find_file      }
+    it { should respond_to :find_directory }
 
     its(:class) { should respond_to :create }
   end
@@ -35,4 +39,29 @@ describe Directory do
     it { should be_a String }
     it { should == File.join(parent_path, name) }
   end
+
+  describe '#find_file' do
+    let(:file_foo) { double("sourcefile('foo')", name: 'foo') }
+    let(:file_bar) { double("sourcefile('bar')", name: 'bar') }
+    let(:files) { [file_foo, file_bar] }
+
+    before { directory.stub(:files).and_return files }
+
+    subject { directory.find_file('foo') }
+
+    it { should be file_foo }
+  end
+
+  describe '#find_directory' do
+    let(:directory_foo) { double("directory('foo')", name: 'foo') }
+    let(:directory_bar) { double("directory('bar')", name: 'bar') }
+    let(:directories) { [directory_foo, directory_bar] }
+
+    before { directory.stub(:directories).and_return directories }
+
+    subject { directory.find_directory('foo') }
+
+    it { should be directory_foo }
+  end
+
 end

data/spec/unit/file_searcher_spec.rb

@@ -1,11 +1,11 @@
 require 'unit_spec_helper'
 
-describe FileSearcher do
+describe Exegesis::FileSearcher do
   let (:root)          { double('a fake backend')                      }
   let (:root_path)     { double('a fake path')                         }
   let (:globbed_path)  { double('a fake glob of root_path with *')     }
   let (:fs_interface)  { double('a File System Interface like `File`') }
-  let (:file_searcher) { FileSearcher.new(root, fs_interface)          }
+  let (:file_searcher) { Exegesis::FileSearcher.new(root, fs_interface)          }
   let (:dir)           { double('a fake directory')                    }
   let (:file)          { double('a fake file')                         }
   let (:file_path)     { double('the fake file path')                  }
@@ -27,11 +27,11 @@ describe FileSearcher do
     fs_interface.stub(:join).with(root_path, file).and_return(file_path)
     fs_interface.stub(:join).with(root_path, dir).and_return(dir_path)
 
-    Directory.stub(:new).with(root, dir).and_return(fake_directory_instance)
-    SourceFile.stub(:new).with(root, file).and_return(fake_source_file_instance)
+    Exegesis::Directory.stub(:new).with(root, dir).and_return(fake_directory_instance)
+    Exegesis::SourceFile.stub(:new).with(root, file).and_return(fake_source_file_instance)
 
-    fake_source_file_instance.stub(:is_a?).with(SourceFile).and_return(true)
-    fake_directory_instance.stub(:is_a?).with(Directory).and_return(true)
+    fake_source_file_instance.stub(:is_a?).with(Exegesis::SourceFile).and_return(true)
+    fake_directory_instance.stub(:is_a?).with(Exegesis::Directory).and_return(true)
 
     root.stub(:path).and_return(root_path)
   end
@@ -67,8 +67,8 @@ describe FileSearcher do
       it { should contain(fake_directory_instance)   }
       it { should exclude(fake_source_file_instance) }
 
-      the_class(Directory) { should have_received(:new).with(root, dir) }
-      the_class(SourceFile) { should_not have_received(:new) }
+      the_class(Exegesis::Directory) { should have_received(:new).with(root, dir) }
+      the_class(Exegesis::SourceFile) { should_not have_received(:new) }
     end
 
     describe '#files' do
@@ -78,8 +78,8 @@ describe FileSearcher do
       it { should contain(fake_source_file_instance) }
       it { should exclude(fake_directory_instance)   }
 
-      the_class(Directory) { should_not have_received(:new) }
-      the_class(SourceFile) { should have_received(:new).with(root, file) }
+      the_class(Exegesis::Directory) { should_not have_received(:new) }
+      the_class(Exegesis::SourceFile) { should have_received(:new).with(root, file) }
     end
   end
 end

data/spec/unit/flyweight_spec.rb

@@ -1,10 +1,10 @@
 require 'unit_spec_helper'
 
-describe Flyweight do
-  let (:processor)          { proc { |instance| instance_key }  }
-  let (:flyweight)          { Flyweight.new(&processor)         }
-  let (:instance)           { double('instance')                }
-  let (:instance_key)       { double('instance_key')            }
+describe Exegesis::Flyweight do
+  let (:processor)          { proc { |instance| instance_key }    }
+  let (:flyweight)          { Exegesis::Flyweight.new(&processor) }
+  let (:instance)           { double('instance')                  }
+  let (:instance_key)       { double('instance_key')              }
 
   subject { flyweight }
 
@@ -17,12 +17,12 @@ describe Flyweight do
 
       describe 'unregistering an unused key' do
         it 'raises an error' do
-          expect { flyweight.unregister!(key) }.to raise_error Flyweight::NoEntryError
+          expect { flyweight.unregister!(key) }.to raise_error Exegesis::Flyweight::NoEntryError
         end
 
         describe '#unregister' do
           it 'raises an error' do
-            expect { flyweight.unregister(key) }.to_not raise_error Flyweight::NoEntryError
+            expect { flyweight.unregister(key) }.to_not raise_error Exegesis::Flyweight::NoEntryError
           end
         end
       end
@@ -46,12 +46,12 @@ describe Flyweight do
     describe '#register! and #register' do
       describe 'registering an instance with an already-used key' do
         it 'raises an error' do
-          expect { flyweight.register!(instance) }.to raise_error Flyweight::AlreadyRegisteredError
+          expect { flyweight.register!(instance) }.to raise_error Exegesis::Flyweight::AlreadyRegisteredError
         end
 
         describe '#register' do
           it 'does not raise an error' do
-            expect { flyweight.register(instance) }.to_not raise_error Flyweight::AlreadyRegisteredError
+            expect { flyweight.register(instance) }.to_not raise_error Exegesis::Flyweight::AlreadyRegisteredError
           end
         end
       end