exegesis 0.0.2

data/lib/exegesis/flyweight.rb

@@ -0,0 +1,130 @@
+# class Flyweight
+#  
+# Responsibilities:
+#   Provide a registry for an arbitrary number of instances which need to be 
+#   accessed as a single instance.
+#
+# Notes:
+#
+# Collaborators:
+#   SourceFile
+#   Directory
+#   Project
+class Flyweight
+  extend Forwardable
+
+  # Create an empty Flyweight with the given key-processing proc.
+  #
+  # @param key_processor [Proc] a proc which turns an instance into it's key.
+  def initialize(&key_processor)
+    clear!
+
+    if block_given?
+      @key_processor = key_processor
+    else
+      @key_processor = proc { |id| id }
+    end
+
+    self
+  end
+
+  # Register an instance in the flyweight. Throw an error if the key is already
+  # used.
+  #
+  # @param instance [Object] the instance to register in the flyweight
+  # @return [Object] the instance given
+  # @raise [AlreadyRegisteredError] when trying to register the same key twice
+  def register!(instance)
+    raise AlreadyRegisteredError if has_key?(instance)
+    register(instance)
+  end
+
+  # Register an instance in the flyweight.
+  #
+  # @param instance [Object] the instance to register in the flyweight
+  # @return [Object] the instance given
+  def register(instance)
+    key = build_key(instance)
+    key_registry[key] = instance
+  end
+
+  # Remove an instance (by key or instance proper) from the flyweight. Throw an
+  # error if no such instance exists
+  #
+  # @param key_or_instance [Object] Either the key under which an instance is
+  #     registered, or the instance itself.
+  # @return [Object] the instance deleted from the flyweight
+  # @raise [NoFlyweightEntryError] when trying to delete a key that isn't
+  #     present in the flyweight
+  def unregister!(key_or_instance)
+    raise NoEntryError unless has_key?(key_or_instance)
+    unregister(key_or_instance)
+  end
+
+  # Remove an instance from the flyweight
+  #
+  # @param key_or_instance [Object] Either the key under which an instance is
+  #     registered, or the instance itself.
+  # @return [Object] the instance deleted from the flyweight
+  def unregister(key_or_instance)
+    proxy_across_keytypes(:delete, key_or_instance)
+  end
+
+  # Whether the flyweight has the given key or instance registered
+  #
+  # @param key_or_instance [Object] Either the key under which an instance is
+  #     registered, or the instance itself.
+  # @return [Boolean] True if the Flyweight has the key or instance, false
+  #     otherwise
+  def has_key?(key_or_instance)
+    proxy_across_keytypes(:has_key?, key_or_instance)
+  end
+
+  # Access the entry under the given key or instance
+  #
+  # NB. If, given an instance that would generate a matching key to an already
+  # registered instance, but perhaps with different data, you'll get back a
+  # reference to the _registered_ instance.
+  #
+  # @param key_or_instance [Object] The key or instance to access.
+  # @return [Object, NilClass] the instance desired, or nil if it doesn't exist
+  def [](key_or_instance)
+    proxy_across_keytypes(:[], key_or_instance)
+  end
+
+  # Clear the Flyweight of all entries.
+  def clear!
+    @key_registry = {}
+    self
+  end
+  alias reset! clear!
+
+  def inspect
+    "Flyweight<#{object_id}, items=#{@key_registry.keys.count}>"
+  end
+
+  private
+
+  # Build a key from an instance via the key_processor
+  def build_key(instance)
+    @key_processor.call(instance)
+  end
+
+  # Proxy a method, aim to use the raw key first, but if that doesn't work, use
+  # the build_key helper and assume you were given an instance.
+  #
+  # NB. This is a bit dirty, but since we don't know what types we're given, we
+  # can't distinguish between key's and instance's without forcing the user to
+  # specifically tell us.
+  def proxy_across_keytypes(method, key)
+    key_registry.send(method, key) || key_registry.send(method, build_key(key))
+  end
+
+  attr_accessor :key_registry
+
+  # An error raised when trying to use an already used key
+  class AlreadyRegisteredError < ArgumentError ; end
+  # An error raised when trying to remove an unused key
+  class NoEntryError < ArgumentError ; end
+end
+

data/lib/exegesis/registerable.rb

@@ -0,0 +1,58 @@
+module Registerable
+  def self.included(base)
+    base.private_class_method :new, :allocate
+    base.instance_eval do
+      extend  ClassMethods
+      include InstanceMethods
+    end
+  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 build(*args)
+      new(*args).tap do |instance|
+        registry.register! instance
+      end
+    end
+
+    def registry
+      @flyweight ||= Flyweight.new do |dir|
+        if dir.respond_to? :path
+          dir.path
+        else
+          dir
+        end
+      end
+    end
+
+    def clear_registry!
+      registry.clear!
+    end
+
+    def build_path(*args)
+      parent, name = *args
+      return parent if name.nil?
+      File.join(parent.path, name)
+    end
+  end
+
+  module InstanceMethods
+    def path
+      build_path(parent, name)
+    end
+
+    private
+
+    def build_path(parent, child)
+      self.class.build_path(parent, child)
+    end
+  end
+end

data/lib/exegesis/source_file.rb

@@ -0,0 +1,45 @@
+# class SourceFile
+#   HAS_A Extension
+#   HAS_A Path
+#   HAS_A Base Name
+#   HAS_MANY SourceFiles (Dependencies)
+#
+# Responsibilities:
+#   Represents a sourcefile on disk, providing access to it's file-system
+#   related information as well as internal information based on the language.
+#
+# Notes:
+#   This will likely work w/ an inheritance heirarchy for each programming
+#   language. Mostly it will be one-level deep, but in the case where a
+#   subsequent language forms a superset/subset, deeper inheritance may occur
+#   (similarly we might have a module for shared subsets, etc).
+#
+# Collaborators:
+#   SourceFile
+#   SourceFileFactory       -- to build the appropriate subclass based on file extenstion
+class SourceFile
+  include FileSystemEntity
+
+  def content
+    File.read(path)
+  end
+
+  attr_reader :dependencies
+  def depends_on(file)
+    raise InvalidDependency unless file.is_a?(SourceFile)
+    @dependencies << file
+  end
+
+  private
+
+  def initialize(parent, name)
+    raise ArgumentError, "parent must be a directory" unless parent.is_a?(Directory)
+
+    @ext = File.extname(name)
+    @name = name
+    @parent = parent
+    @dependencies = []
+  end
+end
+
+class InvalidDependency < StandardError ; end

data/lib/exegesis/version.rb

@@ -0,0 +1,4 @@
+module Exegesis
+  #@private
+  VERSION = "0.0.2"
+end

data/lib/exegesis.rb

@@ -0,0 +1,48 @@
+
+################################################################################
+#load order matters here. These are sorted into load-levels Level-0 files must
+#be loaded before Level-1's, etc. try to keep this sorted. any file after the
+#line is 'load-whenever'
+################################################################################
+
+#Level 0
+require 'rake'
+require 'rake/ext/string'
+
+#Level 1
+require 'exegesis/flyweight'
+
+#Level 2
+require 'exegesis/registerable'
+
+#Level 3
+require 'exegesis/file_system_entity'
+require 'exegesis/file_searcher'
+
+#Level 4
+require 'exegesis/directory'
+require 'exegesis/source_file'
+
+#Level 5
+require 'exegesis/base_directory'
+
+#-------------------------------------------------------------------------------
+#load whenever
+require 'exegesis/version'
+
+################################################################################
+
+
+# Exegesis is a tool for automating many parts of the development of C projects.
+# Following a convention-over-configuration model.
+#
+# It provides tools to:
+#
+#   * Create skeleton projects
+#   * Build
+#   * Testing
+#   * Packaging
+#
+# Though C is presently the only supported language, it is the aim of Exegesis to
+# support tooling for other compiled languages.
+module Exegesis; end

data/spec/fake_project/AUTHORS

@@ -0,0 +1 @@
+Joe Fredette

data/spec/fake_project/Rakefile

@@ -0,0 +1,14 @@
+$:.unshift './'
+require 'build/all'
+
+build do
+  binaries do
+    bin 'grafton'
+  end
+
+  dependencies 
+
+  packages do
+    package "check"
+  end
+end

data/spec/fake_project/config.yml

@@ -0,0 +1,6 @@
+---
+CC: clang
+SRC: src/
+OBJ: obj/
+BIN: bin/
+TEST: test/

data/spec/fake_project/src/grafton.c

@@ -0,0 +1,25 @@
+/*
+ * =====================================================================================
+ *
+ *       Filename:  grafton.c
+ *
+ *    Description:  
+ *
+ *        Version:  1.0
+ *        Created:  08/27/2012 09:09:38
+ *       Revision:  none
+ *       Compiler:  gcc
+ *
+ *         Author:  YOUR NAME (), 
+ *   Organization:  
+ *
+ * =====================================================================================
+ */
+#include <stdlib.h>
+#include <stdio.h>
+#include "node.h"
+
+int main() {
+  printf("hello world\n");
+  return foo();
+}

data/spec/fake_project/src/node.c

@@ -0,0 +1,23 @@
+/*
+ * =====================================================================================
+ *
+ *       Filename:  node.c
+ *
+ *    Description:  
+ *
+ *        Version:  1.0
+ *        Created:  08/27/2012 23:01:12
+ *       Revision:  none
+ *       Compiler:  gcc
+ *
+ *         Author:  YOUR NAME (), 
+ *   Organization:  
+ *
+ * =====================================================================================
+ */
+#include <stdlib.h>
+#include "node.h"
+
+int foo() {
+  return 1;
+}

data/spec/fake_project/src/node.h

@@ -0,0 +1,19 @@
+/*
+ * =====================================================================================
+ *
+ *       Filename:  node.h
+ *
+ *    Description:  
+ *
+ *        Version:  1.0
+ *        Created:  08/27/2012 23:00:57
+ *       Revision:  none
+ *       Compiler:  gcc
+ *
+ *         Author:  YOUR NAME (), 
+ *   Organization:  
+ *
+ * =====================================================================================
+ */
+
+int foo();

data/spec/fake_project/test/example2_test.c

@@ -0,0 +1,29 @@
+/*
+ * =====================================================================================
+ *
+ *       Filename:  example.c
+ *
+ *    Description:  
+ *
+ *        Version:  1.0
+ *        Created:  08/27/2012 07:38:40
+ *       Revision:  none
+ *       Compiler:  gcc
+ *
+ *         Author:  YOUR NAME (), 
+ *   Organization:  
+ *
+ * =====================================================================================
+ */
+/*#include "test_helper.h"*/
+
+START_TEST (test_foo) {
+  fail_unless(1); 
+
+} END_TEST
+
+START_TEST (test_bar) {
+  fail_unless(0); 
+
+} END_TEST
+

data/spec/fake_project/test/example_test.c

@@ -0,0 +1,12 @@
+/*#include "test_helper.h"*/
+
+START_TEST (test_foo) {
+  fail_unless(1); 
+
+} END_TEST
+
+START_TEST (test_bar) {
+  fail_unless(0); 
+
+} END_TEST
+

data/spec/fake_project/test/test_helper.h

@@ -0,0 +1,19 @@
+/*
+ * =====================================================================================
+ *
+ *       Filename:  test_helper.h
+ *
+ *    Description:  Helper file for writing tests
+ *
+ *        Created:  08/25/2012 09:38:50
+ *       Compiler:  clang
+ *
+ *         Author:  Joe Fredette (jfredett@gmail.com), 
+ *
+ * =====================================================================================
+ */
+
+#include <stdlib.h>
+#include <check.h>
+
+

data/spec/helpers/delegates.rb

@@ -0,0 +1,49 @@
+require 'rspec/expectations' 
+
+require 'pry'
+
+module RSpec
+  module Exegesis
+    module DSL
+      module Matchers
+        class DelegateMatcher
+          def initialize(message_to_receive)
+            @message_to_receive = message_to_receive
+          end
+
+          def to(target)
+            @target_object = target
+            self
+          end
+
+          def when_calling(messag)
+            @message_to_send
+            self
+          end
+
+          def matches?(target)
+            target_object.should_receive(message_to_receive)
+            target.send(message_to_send)
+            true
+          end
+
+          def failure_message_for_should
+            "expected to receive ##{message_to_receive} on #{target_object} when sending ##{message_to_send}, but didn't"
+          end
+
+          private 
+          attr_reader :message_to_receive, :target_object
+
+          # default to delegating the message directly
+          def message_to_send
+            @message_to_send || @message_to_receive 
+          end
+        end
+
+        def delegate(message)
+          DelegateMatcher.new(message)
+        end
+      end
+    end
+  end
+end

data/spec/helpers/set_helpers.rb

@@ -0,0 +1,27 @@
+require 'rspec/expectations'
+
+RSpec::Matchers.define :be_a_superset_of do |expected|
+  match do |obj|
+    expected.should be_a_subset_of obj
+  end
+end
+
+RSpec::Matchers.define :be_a_subset_of do |expected|
+  match do |obj|
+    obj.each do |e|
+      expected.include?(e)
+    end
+  end
+end
+
+RSpec::Matchers.define :contain do |expected|
+  match do |obj|
+    obj.include?(expected)
+  end
+end
+
+RSpec::Matchers.define :exclude do |expected|
+  match do |obj|
+    not obj.include?(expected)
+  end
+end

data/spec/helpers/the.rb

@@ -0,0 +1,15 @@
+module RSpec
+  module Exegesis
+    module DSL
+      module Macros
+        def the(sym, &block)
+          context sym do
+            subject { if sym.is_a? Class then sym else send sym end } 
+            it &block
+          end
+        end
+        alias the_class the
+      end
+    end
+  end
+end

data/spec/helpers/they.rb

@@ -0,0 +1,15 @@
+module RSpec
+  module Exegesis
+    module DSL
+      module Macros
+        def they_all(&block)
+          example do
+            subject.map do
+              instance_eval &block
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/helpers/topic.rb

@@ -0,0 +1,82 @@
+__END__
+module RSpec
+  module Exegesis
+    module DSL
+      module Macros
+        def topic(obj, &block)
+          if obj 
+            __context_stack.reset!
+            __context_stack.push_context(obj) do
+              describe '' do
+                subject { __context_stack.current_subject } 
+                block.call
+              end
+            end
+          end
+        end
+
+        def consider(sym, &block)
+          raise "consider must be nested in a topic block" unless __context_stack_available?
+
+          __context_stack.push_context(sym) do
+            context "##{sym}" do
+              binding.pry
+              subject { __context_stack.current_subject }
+              block.call
+            end
+          end
+        end
+
+        def __context_stack
+          @@__context_stack ||= ContextStack.new
+        end
+
+        def __context_stack_available?
+          not (@@__context_stack.nil? || @@__context_stack.empty?)
+        end
+      end
+
+      require 'forwardable'
+      class ContextStack
+        extend Forwardable
+        def initialize
+          reset!
+        end
+
+        delegate [:<<, :push, :pop, :empty?] => :@stack
+
+        def push_context(ctx) 
+          push(ctx)
+          yield
+          pop
+        end
+
+        def reset!
+          @stack = []
+        end
+
+        def current_subject
+          @stack.drop(1).reduce(send(@stack.first)) do |a,e|
+            a = a.send(e)
+          end
+        end
+      end
+    end
+  end
+end
+
+__END__
+
+topic :foo do        | describe :foo do
+                     |   subject { send :foo }
+                     |   @topic = :foo
+                     |
+  consider :bar do   |   context "##{:bar}" do
+                     |     subject { @topic.send(:bar) }
+                     |     @topic = :bar
+                     |
+    it { ... }       |     it { ... }     
+                     | 
+  end                |   end
+end                  | end
+