kcomp 0.1.1 → 0.1.2

data/README.rdoc

@@ -2,10 +2,14 @@
 
 This is a simple command-line compiler for CodeKit .kit files for those of us who don't have it, aren't on Macs, or simply prefer the command line  Usage is pretty simple:
 
-  kcomp SRC-DIR DEST-DIR
+  kcomp [-s SOURCEDIR] [-d DESTDIR] [-f]
 
 if the arguemnts are omitted, they will both be assumed to be the CWD. Documentation on the .kit file format can be found at http://incident57.com/codekit/kit.php.
 
+== WARNING!
+
+This thing is hacky as hell. I started with the spec, and basically iterated until diff showed no difference between those files compiled by codekit and those compiled by this tool. I reserve every possible right to have screwed up fantastically.
+
 == Contributing to kcomp
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/bin/kcomp

@@ -1,4 +1,24 @@
 #!/usr/bin/env ruby
 require File.dirname(__FILE__) + "/../lib/kcomp"
+require 'optparse'
 
-KComp.compile! ARGV[0] || ".", ARGV[1] || "."
+options = {:src => '.', :dest => '.'}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: kcomp [options]"
+  opts.on("-s", "--source SOURCE", "The source parent directory for all .kit files") do |src|
+    options[:src] = src
+  end
+  opts.on("-d", "--destination DESTINATION", "The output directory") do |dest|
+    options[:dest] = dest
+  end
+  opts.on("-f", "--flatten", "Flatten all output in destination directory") do
+    options[:flatten] = true
+  end
+  opts.on_tail("-h", "--help", "Print this help message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+KComp.compile! options[:src], options[:dest], options

data/kcomp.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "kcomp"
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeremy Holland"]
@@ -43,17 +43,13 @@ Gem::Specification.new do |s|
     "spec/support/test-src/_partial1.kit",
     "spec/support/test-src/_partial2.kit",
     "spec/support/test-src/_partial3.kit",
-    "spec/support/test-src/inc1.kit",
     "spec/support/test-src/inc10.kit",
     "spec/support/test-src/inc11.kit",
     "spec/support/test-src/inc12.kit",
-    "spec/support/test-src/inc2.kit",
-    "spec/support/test-src/inc4.kit",
     "spec/support/test-src/inc5.kit",
     "spec/support/test-src/inc7.kit",
     "spec/support/test-src/inc8.kit",
     "spec/support/test-src/inc9.kit",
-    "spec/support/test-src/somedir/inc3.kit",
     "spec/support/test-src/somedir/inc6.kit",
     "spec/support/test-src/test-inclusion.kit"
   ]

data/lib/kcomp.rb

@@ -1,24 +1,30 @@
 require 'rgl/adjacency'
 require 'rgl/topsort'
 require 'fileutils'
+require 'pry'
 require File.dirname(__FILE__) + "/errors"
 
 class KComp
-  def initialize(src, dest)
+  def initialize(src, dest, opts={})
+    @options = opts
     @depdg = RGL::DirectedAdjacencyGraph.new
     @texts = {}
-    @ctexts = {}
-    @vars = {}
+    @compiled = []
     @src = src = src =~ /\/$/ ? src : src + "/"
+    if @src !~ /^[.\/]/
+      @src = "./" + @src
+    end
     @dest = dest = dest =~ /\/$/ ? dest : dest + "/"
-    build_vertices src
+    if @dest !~ /^[.\/]/
+      @dest = "./" + @dest
+    end
+    build_vertices @src
     @vertices = @depdg.to_a
-    build_edges src
+    build_edges @src
     check_for_cycles
     @tsort = @depdg.topsort_iterator
     @reversedg = @depdg.reverse
     @rtsort = @reversedg.topsort_iterator
-    define_variables
   end
 
   def dependency_digraph
@@ -39,51 +45,60 @@ class KComp
   end
 
   private
-    def define_variables
-      @tsort.each do |v|
-        rf = f = @texts[v]
-        vars = {}
-        f.scan(/(<!-- ?[$@]([A-Za-z_][A-Za-z0-9_\-]*) ?[ :=] *(.+) *-->)/).each do |var|
-          vars[var[1]] = var.last.strip
-          rf.gsub! var.first, ""
-        end
-        define_variables_for_vertex v, vars
-      end
-    end
 
-    def define_variables_for_vertex(v, vars)
-      @vars[v] ||= {}
-      @vars[v].merge! vars
-      @depdg.adjacent_vertices(v).each do |dep|
-        define_variables_for_vertex dep, vars
-      end
-    end
-
-    def compile_files(dest)
-      @rtsort.each do |v|
-        rf = f = @texts[v]
-        f.scan(/(<!--!!! (.+) !!!-->)/).each do |import|
-          rf.gsub! import.first, @ctexts[import.last]
-        end
-        f.scan(/(<!-- ?[$@]([A-Za-z_][A-Za-z0-9_\-]*) ?-->)/).each do |import|
-          if @vars[v][import.last].nil?
-            raise UndefinedVariableError, "Variable #{import.last} not defined."
+    def compile_inclusion(vertex, dest, ovars={}, inclusion=false)
+      vars = ovars.dup
+      f = @texts[vertex].dup
+      rf = f.dup
+      if (vertex !~ /_[^\/]+\.kit$/ || inclusion)
+        f.scan(/(<!-- *[$@]([A-Za-z0-9_][A-Za-z0-9_]*) *-->)|(<!-- ?[$@]([A-Za-z0-9_][A-Za-z0-9_]*) ?[ :=] *(.+) *-->)|(<!--!!! (.+) !!!-->)/).each do |import|
+          begin
+            if (import[0].nil? && import[2].nil?)
+              rf.gsub! import[5], compile_inclusion(import[6], dest, vars, true).rstrip
+            elsif (import[5].nil? && import[2].nil?)
+              rf.gsub! import[0], vars[import[1]]
+            else
+              vars[import[3]] = import[4].strip
+              rf.gsub!(import[2] + "\n", "")
+              rf.gsub!(import[2], "")
+            end
           end
-          rf.gsub! import.first, @vars[v][import.last]
         end
-        @ctexts[v] = rf.gsub(/\n+/, "\n")
-        if (v !~ /_[^\/]+\.kit$/)
-          filename = dest + v.gsub(@src, "").gsub(/\.kit$/, ".html")
-          dirname = filename.gsub(/\/[^\/]+$/, "")
+        if (vertex !~ /_[^\/]+\.kit$/)
+          unless @options[:flatten]
+            filename = dest + vertex.gsub(@src, "").gsub(/\.kit$/, detect_format(rf))
+            dirname = filename.gsub(/\/[^\/]+$/, "")
+          else
+            filename = dest + vertex.gsub(/([^\/]+\/)+/, "").gsub(/\.kit$/, detect_format(rf))
+            dirname = filename.gsub(/\/[^\/]+$/, "")
+          end
           puts "Compiling #{filename}"
           unless Dir.exists?(dirname)
             FileUtils.mkdir_p dirname
           end
           File.open(filename, 'w+') do |file|
-            file.write @ctexts[v]
+            file.write rf
           end
         end
       end
+      rf
+    end
+
+    def compile_files(dest)
+      @tsort.each do |v|
+        compile_inclusion(v, dest)
+      end
+    end
+
+    def detect_format(text)
+      case text
+      when /<\?php/
+        ".php"
+      when /<%=?/
+        ".erb"
+      else
+        ".html"
+      end
     end
 
     def check_for_cycles
@@ -108,11 +123,11 @@ class KComp
 
     def build_edges(src)
       @depdg.vertices.each do |v|
-        add_edges(src, v)
+        add_edges(src, v, v.gsub(src, "").gsub(/\/[^\/]+$/, "") + "/")
       end
     end
 
-    def add_edges(src, vertex)
+    def add_edges(src, vertex, subdir="")
       rf = f = File.read(vertex)
       f.scan(/(<!-- ?@(?:import|include) ['"]?((?:[A-Za-z0-9_\/\-.]+(?:, *)?)+)['"]? ?-->)/).each do |import|
         repl = []
@@ -121,14 +136,14 @@ class KComp
           if incl !~ /\.\w+$/
             incl = "#{incl}.kit"
           end
-          if @vertices.include?(src + incl)
-            match = src + incl
-          elsif @vertices.include?(src + "_" + incl)
-            match = src + "_" + incl
+          if @vertices.include?(src + subdir + incl)
+            match = src + subdir + incl
+          elsif @vertices.include?(src + subdir + incl.gsub(/\/([^\/]+)$/, "/_#{$1}"))
+            match = src + subdir + "_" + incl
           else
             match = @vertices.select { |v| v =~ /#{incl}$/ }.first
             if match.nil?
-              match = @vertices.select { |v| v =~ /_#{incl}$/ }.first
+              match = @vertices.select { |v| v =~ /#{incl.gsub(/([^\/]+\/)+/, "")}$/ }.first
             end
           end
           if match.nil?
@@ -142,8 +157,8 @@ class KComp
       @texts[vertex] = rf
     end
 
-  def self.compile!(src, dest)
-    kc = KComp.new src, dest
+  def self.compile!(src, dest, opts={})
+    kc = KComp.new src, dest, opts
     kc.compile!
   end
 end

data/spec/kcomp_spec.rb

@@ -16,135 +16,20 @@ describe KComp do
     let(:comp) { KComp.new GOOD_SRC, DEST }
     let(:undef) { KComp.new UNDEFINED_VAR_SRC, DEST }
 
-    describe "dependency_digraph" do
-      let(:dg) { comp.dependency_digraph }
-      let(:adjv) { dg.adjacent_vertices(GOOD_SRC + "/test-inclusion.kit") }
-      it "should contain a node for each .kit file in the directory" do
-        dg.should include(GOOD_SRC + "/_partial1.kit")
-        dg.should include(GOOD_SRC + "/_partial2.kit")
-        dg.should include(GOOD_SRC + "/_partial3.kit")
-        dg.should include(GOOD_SRC + "/inc1.kit")
-        dg.should include(GOOD_SRC + "/inc2.kit")
-        dg.should include(GOOD_SRC + "/somedir/inc3.kit")
-        dg.should include(GOOD_SRC + "/inc4.kit")
-        dg.should include(GOOD_SRC + "/inc5.kit")
-        dg.should include(GOOD_SRC + "/somedir/inc6.kit")
-        dg.should include(GOOD_SRC + "/inc7.kit")
-        dg.should include(GOOD_SRC + "/inc8.kit")
-        dg.should include(GOOD_SRC + "/inc9.kit")
-        dg.should include(GOOD_SRC + "/inc10.kit")
-        dg.should include(GOOD_SRC + "/inc11.kit")
-        dg.should include(GOOD_SRC + "/inc12.kit")
-        dg.should include(GOOD_SRC + "/test-inclusion.kit")
-      end
-
-      it "should have directed edges indicating dependency relations" do
-        adjv.should include(GOOD_SRC + "/_partial1.kit")
-        adjv.should include(GOOD_SRC + "/_partial2.kit")
-        adjv.should include(GOOD_SRC + "/inc1.kit")
-        adjv.should include(GOOD_SRC + "/inc2.kit")
-        adjv.should include(GOOD_SRC + "/somedir/inc3.kit")
-        adjv.should include(GOOD_SRC + "/inc4.kit")
-        adjv.should include(GOOD_SRC + "/inc5.kit")
-        adjv.should include(GOOD_SRC + "/somedir/inc6.kit")
-        adjv.should include(GOOD_SRC + "/inc7.kit")
-        adjv.should include(GOOD_SRC + "/inc8.kit")
-        adjv.should include(GOOD_SRC + "/inc9.kit")
-        adjv.should include(GOOD_SRC + "/inc10.kit")
-      end
-
-      it "should not have any directed edges for undependent or indirectly dependent files" do
-        adjv = dg.adjacent_vertices(GOOD_SRC + "/test-inclusion.kit")
-        adjv.should_not include(GOOD_SRC + "/test-inclusion.kit")
-        adjv.should_not include(GOOD_SRC + "/inc11.kit")
-        adjv.should_not include(GOOD_SRC + "/inc12.kit")
-        adjv.should_not include(GOOD_SRC + "/_partial3.kit")
-      end
-    end
-
-    describe "reverse_dependency_digraph" do
-      let(:dg) { comp.reverse_dependency_digraph }
-      let(:adjv1) { dg.adjacent_vertices(GOOD_SRC + "/inc4.kit") }
-      let(:adjv2) { dg.adjacent_vertices(GOOD_SRC + "/inc11.kit") }
-      let(:adjv3) { dg.adjacent_vertices(GOOD_SRC + "/_partial3.kit") }
-
-      it "should contain a node for each .kit file in the directory" do
-        dg.should include(GOOD_SRC + "/_partial1.kit")
-        dg.should include(GOOD_SRC + "/_partial2.kit")
-        dg.should include(GOOD_SRC + "/_partial3.kit")
-        dg.should include(GOOD_SRC + "/inc1.kit")
-        dg.should include(GOOD_SRC + "/inc2.kit")
-        dg.should include(GOOD_SRC + "/somedir/inc3.kit")
-        dg.should include(GOOD_SRC + "/inc4.kit")
-        dg.should include(GOOD_SRC + "/inc5.kit")
-        dg.should include(GOOD_SRC + "/somedir/inc6.kit")
-        dg.should include(GOOD_SRC + "/inc7.kit")
-        dg.should include(GOOD_SRC + "/inc8.kit")
-        dg.should include(GOOD_SRC + "/inc9.kit")
-        dg.should include(GOOD_SRC + "/inc10.kit")
-        dg.should include(GOOD_SRC + "/inc11.kit")
-        dg.should include(GOOD_SRC + "/inc12.kit")
-        dg.should include(GOOD_SRC + "/test-inclusion.kit")
-      end
-
-      it "should have directed edges indicating dependent relations" do
-        adjv1.should include(GOOD_SRC + "/test-inclusion.kit")
-        adjv2.should include(GOOD_SRC + "/inc10.kit")
-        adjv3.should include(GOOD_SRC + "/inc10.kit")
-      end
-
-      it "should not have any directed edges for undependent or indirectly dependent files" do
-        adjv1.should_not include(GOOD_SRC + "/inc10.kit")
-        adjv2.should_not include(GOOD_SRC + "/test-inclusion.kit")
-        adjv3.should_not include(GOOD_SRC + "/test-inclusion.kit")
-      end
-    end
-
-    describe "files" do
-      let(:files) { comp.files }
-
-      it "should return an array of all .kit files" do
-        files.should include(GOOD_SRC + "/_partial1.kit")
-        files.should include(GOOD_SRC + "/_partial2.kit")
-        files.should include(GOOD_SRC + "/_partial3.kit")
-        files.should include(GOOD_SRC + "/inc1.kit")
-        files.should include(GOOD_SRC + "/inc2.kit")
-        files.should include(GOOD_SRC + "/somedir/inc3.kit")
-        files.should include(GOOD_SRC + "/inc4.kit")
-        files.should include(GOOD_SRC + "/inc5.kit")
-        files.should include(GOOD_SRC + "/somedir/inc6.kit")
-        files.should include(GOOD_SRC + "/inc7.kit")
-        files.should include(GOOD_SRC + "/inc8.kit")
-        files.should include(GOOD_SRC + "/inc9.kit")
-        files.should include(GOOD_SRC + "/inc10.kit")
-        files.should include(GOOD_SRC + "/inc11.kit")
-        files.should include(GOOD_SRC + "/inc12.kit")
-        files.should include(GOOD_SRC + "/test-inclusion.kit")
-      end
-
-      it "should order the files topologically by dependency" do
-        files.index(GOOD_SRC + "/_partial3.kit").should > files.index(GOOD_SRC + "/inc10.kit")
-        files.index(GOOD_SRC + "/inc11.kit").should > files.index(GOOD_SRC + "/inc10.kit")
-        files.index(GOOD_SRC + "/_partial1.kit").should > files.index(GOOD_SRC + "/test-inclusion.kit")
-        files.index(GOOD_SRC + "/inc10.kit").should > files.index(GOOD_SRC + "/test-inclusion.kit")
-      end
-    end
-
     describe "compile!" do
 
       it "should create any destination directories it needs (as dictated by the source directory structure)" do
         FileUtils.rm_rf DEST + "/*"
-        capture_stdout do
-          comp.compile!
-        end
+        comp.compile!
         Dir.exists?(DEST + "/somedir").should be_true
       end
 
       it "should create a single html file for each regular kit file" do
-        File.exists?(DEST + "/inc1.html").should be_true
-        File.exists?(DEST + "/inc2.html").should be_true
-        File.exists?(DEST + "/somedir/inc3.html").should be_true
-        File.exists?(DEST + "/inc4.html").should be_true
+        comp.compile!
+        File.exists?(DEST + "/inc1.html").should be_false
+        File.exists?(DEST + "/inc2.html").should be_false
+        File.exists?(DEST + "/somedir/inc3.html").should be_false
+        File.exists?(DEST + "/inc4.html").should be_false
         File.exists?(DEST + "/inc5.html").should be_true
         File.exists?(DEST + "/somedir/inc6.html").should be_true
         File.exists?(DEST + "/inc7.html").should be_true
@@ -157,6 +42,7 @@ describe KComp do
       end
 
       it "should not create an html file for partials" do
+        comp.compile!
         File.exists?(DEST + "/partial1.html").should be_false
         File.exists?(DEST + "/partial2.html").should be_false
         File.exists?(DEST + "/partial3.html").should be_false
@@ -164,10 +50,7 @@ describe KComp do
 
       describe "generated files" do
         it "should contain any valid variable references" do
-          File.read(DEST + "/inc1.html").should =~ /VAR 1/
-          File.read(DEST + "/inc2.html").should =~ /VAR 2/
-          File.read(DEST + "/somedir/inc3.html").should =~ /VAR 3/
-          File.read(DEST + "/inc4.html").should =~ /VAR 4/
+          comp.compile!
           f = File.read(DEST + "/test-inclusion.html")
           f.should =~ /VAR 1/
           f.should =~ /VAR 2/
@@ -184,6 +67,7 @@ describe KComp do
         end
 
         it "should contain any inclusions" do
+          comp.compile!
           f = File.read(DEST + "/inc10.html")
           f.scan(/INCLUSION 11/).length.should == 1
           f.scan(/PARTIAL 3/).length.should == 1
@@ -216,11 +100,6 @@ describe KComp do
           f.scan(/VAR 12/).length.should == 1
         end
       end
-
-      it "should strip out any repeated newlines" do
-        f = File.read(DEST + "/test-inclusion.html")
-        f.should_not =~ /\n\n+/
-      end
     end
 
   end
@@ -229,7 +108,7 @@ describe KComp do
     describe "compile!" do
       it "should create a new KComp instance with the provided source and destination directories and delegate compilation thereto" do
         kcomp = mock('KComp')
-        KComp.should_receive(:new).with('blah', 'hat').and_return kcomp
+        KComp.should_receive(:new).with('blah', 'hat', {}).and_return kcomp
         kcomp.should_receive(:compile!)
         KComp.compile!('blah', 'hat')
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kcomp
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -157,17 +157,13 @@ files:
 - spec/support/test-src/_partial1.kit
 - spec/support/test-src/_partial2.kit
 - spec/support/test-src/_partial3.kit
-- spec/support/test-src/inc1.kit
 - spec/support/test-src/inc10.kit
 - spec/support/test-src/inc11.kit
 - spec/support/test-src/inc12.kit
-- spec/support/test-src/inc2.kit
-- spec/support/test-src/inc4.kit
 - spec/support/test-src/inc5.kit
 - spec/support/test-src/inc7.kit
 - spec/support/test-src/inc8.kit
 - spec/support/test-src/inc9.kit
-- spec/support/test-src/somedir/inc3.kit
 - spec/support/test-src/somedir/inc6.kit
 - spec/support/test-src/test-inclusion.kit
 homepage: http://github.com/awebneck/kcomp
@@ -185,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 785217893617116794
+      hash: 2103192968802245187
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/spec/support/test-src/inc1.kit

@@ -1,3 +0,0 @@
-INCLUSION 1
-
-<!-- @var1 -->

data/spec/support/test-src/inc2.kit

@@ -1,3 +0,0 @@
-INCLUSION 2
-
-<!--@var2-->

data/spec/support/test-src/inc4.kit

@@ -1,3 +0,0 @@
-INCLUSION 4
-
-<!--$var4-->

data/spec/support/test-src/somedir/inc3.kit

@@ -1,3 +0,0 @@
-INCLUSION 3
-
-<!-- $var3 -->