add rake rubex:clobber task. Add tests for checking sanity with external C structs

Author: v0dro

lib/rubex/compiler.rb

@@ -27,6 +27,8 @@ class << self
       #    programs.
       # @param files [Array[String]] nil An Array specifying the file names to
       #   compile w.r.t the source_dir directory.
+      # @param invoker [Symbol] nil Determines whether the invoker is a command line
+      #   program or a rake task. Affect build directory for rake task.
       #
       # TODO: The path can be relative to the source_dir if source_dir is specified.
       def compile path,
@@ -37,7 +39,8 @@ def compile path,
                   make: false,
                   debug: false,
                   source_dir: nil,
-                  files: nil
+                  files: nil,
+                  invoker: nil
         CONFIG.flush
         CONFIG.debug = debug
         CONFIG.add_link "m" # link cmath libraries
@@ -54,8 +57,9 @@ def compile path,
         elsif test && multi_file
           return [tree, supervisor, ext]
         end
-        write_files target_name, supervisor, ext, target_dir: target_dir, force: force
-        full_path = build_path(target_dir, target_name)
+        write_files target_name, supervisor, ext, target_dir: target_dir, force: force,
+                    invoker: invoker
+        full_path = build_path(target_dir, target_name, invoker: invoker)
         load_extconf full_path
         run_make full_path if make
       end
@@ -120,10 +124,12 @@ def extract_target_name path
       # @param directory [String] nil Target directory in which files are to be placed.
       # @param force [Boolean] false Recreate the target directory and rewrite the
       #   files whether they are already present or not.
-      def write_files target_name, supervisor, ext, target_dir: nil, force: false
-        path = build_path(target_dir, target_name)
+      # @param invoker [Symbol|NilClass] nil Determines the build directory based on whether
+      #   it being invoked by a rake task or cmd.
+      def write_files target_name, supervisor, ext, target_dir: nil, force: false, invoker: nil
+        path = build_path(target_dir, target_name, invoker: invoker)
         FileUtils.rm_rf(path) if force && Dir.exist?(path)
-        Dir.mkdir(path) unless Dir.exist?(path)
+        FileUtils.mkdir_p(path) unless Dir.exist?(path)
 
         write_to_file "#{path}/#{Rubex::COMMON_UTILS_FILE}.h",
                       supervisor.header(Rubex::COMMON_UTILS_FILE).to_s
@@ -147,10 +153,19 @@ def run_make path
         end
       end
 
-      def build_path directory, target_name
+      # Create build path for outputting .c and .h files. Will check whether the calling
+      #   process is a rake task or cmd.
+      #
+      # @param directory [String] The directory inside which this build path will exist.
+      # @param target_name [String] Name of the folder inside the directory.
+      # @param invoker [Symbol|NilClass] nil The calling program. Can be :rake or :cmd.      
+      def build_path directory, target_name, invoker: nil
         directory = (directory ? directory.to_s : Dir.pwd)
        unless directory.end_with?(target_name)
-          directory += "/#{target_name}"
+         directory += "/#{target_name}"
+         if invoker == :rake
+           directory += "/build"
+         end
        end
         directory
       end

lib/rubex/rake_task.rb

@@ -41,7 +41,19 @@ def define_compile_tasks
         desc "Compile a Rubex file into a shared object."
         task :compile do
           file_name = "#{@ext_dir}/#{@name}#{@source_pattern[1..-1]}"
-          Rubex::Compiler.compile file_name, target_dir: "#{@ext_dir}"
+          Rubex::Compiler.compile file_name, target_dir: "#{@ext_dir}", invoker: :rake
+        end
+
+        desc "Delete all generated files inside build/ folder."
+        task :clobber do
+          path = "#{@ext_dir}/#{@name}/build"
+          Dir.chdir(path) do
+            FileUtils.rm(
+              Dir.glob(
+              "#{path}/*.{c,h,so,o,bundle,dll}") + ["Makefile", "extconf.rb"], force: true
+            )
+          end
+          FileUtils.rmdir(path)
         end
       end
       Rake::ExtensionTask.new(@name)

spec/external_c_struct_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Rubex do
+  test_case = 'external_c_struct'
+
+  context "Case: #{test_case}" do
+    before do
+      @path = path_str test_case
+    end
+
+    context ".ast" do
+      it "generates the AST" do
+        t = Rubex::Compiler.ast(@path + '.rubex')
+      end
+    end
+
+    context ".compile" do
+      it "compiles to valid C file" do
+        t,c,e = Rubex::Compiler.compile(@path + '.rubex', test: true)
+      end
+    end
+
+    context "Black Box testing" do
+      it "compiles and checks for valid output" do
+        setup_and_teardown_compiled_files(test_case) do |dir|
+          require_relative "#{dir}/#{test_case}.#{os_extension}"
+
+          expect(HelloFile.new.foo).to eq(false)
+        end
+      end
+    end
+  end
+end

spec/fixtures/external_c_struct/external_c_struct.rubex

@@ -0,0 +1,16 @@
+lib "<stdio.h>"
+  struct FILE
+  end
+
+  alias FILE = struct FILE
+end
+
+struct hello
+  FILE f
+end
+
+class HelloFile
+  def foo
+    FILE a
+  end
+end

spec/rake_task_spec.rb

@@ -32,7 +32,7 @@
   end
 end
 
-describe "rake" do
+describe "rake", hell: true do
   context "rubex:compile" do
     before do
       Rake::Task.clear
@@ -46,18 +46,18 @@
       end
       Rake::Task["rubex:compile"].invoke
 
-      expect(File.exist?("#{ext_path}/#{name}/#{name}.c")).to eq(true)
-      expect(File.exist?("#{ext_path}/#{name}/extconf.rb")).to eq(true)
+      build_path = "#{ext_path}/#{name}/build"
+      expect(File.exist?("#{build_path}/#{name}.c")).to eq(true)
+      expect(File.exist?("#{build_path}/extconf.rb")).to eq(true)
 
       # delete generated files
-      dir = "#{ext_path}/#{name}"
-      Dir.chdir(dir) do
+      Dir.chdir(build_path) do
         FileUtils.rm(
           Dir.glob(
-          "#{dir}/*.{c,h,so,o,bundle,dll}") + ["Makefile", "extconf.rb"], force: true
+          "#{build_path}/*.{c,h,so,o,bundle,dll}") + ["Makefile", "extconf.rb"], force: true
         )
       end
-      FileUtils.rmdir(dir)
+      FileUtils.rmdir(build_path)
     end
 
     it "compiles a multiple file program" do
@@ -69,6 +69,25 @@
     end
   end
 
+  context "rake:clobber" do
+    before do
+      Rake::Task.clear
+    end
+
+    it "clobbers generated files inside build/ directory." do
+      ext_path = "#{Dir.pwd}/spec/fixtures/rake_task/single_file"
+      name = "test"
+      Rubex::RakeTask.new(name) do
+        ext ext_path
+      end
+      Rake::Task["rubex:compile"].invoke
+      Rake::Task["rubex:clobber"].invoke
+
+      expect(!File.exist?("#{ext_path}/#{name}/build/#{name}.c")).to eq(true)
+      expect(!File.exist?("#{ext_path}/#{name}/build/extconf.rb")).to eq(true)
+    end
+  end
+
   context "rake:compile:install" do
     before do
       Rake::Task.clear