ghazel-ffi-clang 0.2.0.2 → 0.2.1

data/spec/clang/compilation_database_spec.rb

@@ -0,0 +1,178 @@
+# Copyright, 2014, by Masahiro Sano.
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require 'spec_helper'
+
+describe CompilationDatabase do
+	let(:dirpath) { fixture_path('') }
+	let(:cdb) { CompilationDatabase.new(dirpath) }
+	let(:file) { '/home/xxxxx/src/llvm-trunk/lib/Support/APFloat.cpp' }
+
+	it "can be created" do
+		expect(cdb).to be_kind_of(CompilationDatabase)
+	end
+
+	it "raises DatabaseLoadError if cannot be created" do
+		expect{CompilationDatabase.new('/not/exist/directory')}.to raise_error FFI::Clang::CompilationDatabase::DatabaseLoadError
+	end
+
+	it "calls compilation_database_dispose on GC" do
+		cdb.autorelease = false
+		expect(Lib).to receive(:compilation_database_dispose).with(cdb).once
+		expect{cdb.free}.not_to raise_error
+	end
+
+	describe '#compile_commands' do
+		let(:not_found_file) { '/home/xxxxx/not_found_file_path' }
+
+		it "returns compile commands used for a file" do
+			expect(cdb.compile_commands(file)).to be_kind_of(CompilationDatabase::CompileCommands)
+			expect(cdb.compile_commands(file).size).to eq(1)
+		end
+
+		it "returns compile commands if the specified file is not found" do
+			expect(cdb.compile_commands(not_found_file)).to be_kind_of(CompilationDatabase::CompileCommands)
+			expect(cdb.compile_commands(not_found_file).size).to eq(0)
+		end
+	end
+
+	describe '#all_compile_commands', from_3_3: true do
+		it "returns all compile commands in the database" do
+			expect(cdb.all_compile_commands).to be_kind_of(CompilationDatabase::CompileCommands)
+			expect(cdb.all_compile_commands.size).to eq(3)
+		end
+	end
+
+	describe CompilationDatabase::CompileCommands do
+		let(:commands) { cdb.compile_commands(file) }
+
+		it "calls compile_commands_dispose on GC" do
+			commands.autorelease = false
+			expect(Lib).to receive(:compile_commands_dispose).with(commands).once
+			expect{commands.free}.not_to raise_error
+		end
+
+		describe '#size' do
+			it "returns the number of CompileCommand" do
+				expect(commands.size).to be_kind_of(Integer)
+				expect(commands.size).to eq(1)
+			end
+
+			it "returns the number of CompileCommand", from_3_3: true do
+				expect(cdb.all_compile_commands.size).to eq(3)
+			end
+		end
+
+		describe '#command' do
+			it "returns the I'th CompileCommand" do
+				expect(commands.command(0)).to be_kind_of(CompilationDatabase::CompileCommand)
+			end
+		end
+
+		describe "#commands" do
+			it "returns all CompileCommand as Array" do
+				expect(commands.commands).to be_kind_of(Array)
+				expect(commands.commands.first).to be_kind_of(CompilationDatabase::CompileCommand)
+				expect(commands.commands.size).to eq(commands.size)
+			end
+		end
+
+		describe "#each" do
+			let(:spy) { double(stub: nil) }
+			it "calls block once for each CompileCommand" do
+				expect(spy).to receive(:stub).exactly(commands.size).times
+				commands.each { spy.stub }
+			end
+		end
+	end
+
+	describe CompilationDatabase::CompileCommand do
+		let(:cmd) { cdb.compile_commands(file).first }
+
+		describe '#directory' do
+			it "returns the working directory" do
+				expect(cmd.directory).to be_kind_of(String)
+				expect(cmd.directory).to eq('/home/xxxxx/src/build-trunk/lib/Support')
+			end
+		end
+
+		describe '#num_args' do
+			it "returns the number of CompileCommand" do
+				expect(cmd.num_args).to be_kind_of(Integer)
+				expect(cmd.num_args).to eq(31)
+			end
+		end
+
+		describe '#arg' do
+			it "returns the I'th argument value" do
+				expect(cmd.arg(0)).to be_kind_of(String)
+				expect(cmd.arg(0)).to eq('/opt/llvm/3.4/bin/clang++')
+			end
+		end
+
+		describe '#args' do
+			it "returns all argument values as Array" do
+				expect(cmd.args).to be_kind_of(Array)
+				expect(cmd.args.first).to be_kind_of(String)
+				expect(cmd.args.size).to eq(cmd.num_args)
+			end
+		end
+
+		describe '#num_mapped_sources', from_3_4: true do
+			# TODO: a case which has mapped sources
+
+			it "returns the number of source mappings" do
+				# expect(cmd.num_mapped_sources).to be_kind_of(Integer)
+				# expect(cmd.num_mapped_sources).to eq(0)
+			end
+		end
+
+		describe '#mapped_source_path', from_3_4: true do
+			it "returns the I'th mapped source path" do
+				# TODO: a case which returns real source path
+				# expect(cmd.mapped_source_path(0)).to be_kind_of(String)
+			end
+
+			it "returns nil if the index exceeds element size" do
+				# expect(cmd.mapped_source_path(1000)).to be_nil
+			end
+		end
+
+		describe '#mapped_source_content', from_3_4: true do
+			it "returns the I'th mapped source content" do
+				# TODO: a case which returns real source path
+				# expect(cmd.mapped_source_content(0)).to be_kind_of(String)
+			end
+
+			it "returns nil if the index exceeds element size" do
+				# expect(cmd.mapped_source_content(1000)).to be_nil
+			end
+		end
+
+		describe '#mapped_sources', from_3_4: true do
+			# TODO: a case which has mapped sources
+
+			it "returns all mapped sources as Array" do
+				# expect(cmd.mapped_sources).to be_kind_of(Array)
+				# expect(cmd.mapped_sources.size).to eq(cmd.num_mapped_sources)
+			end
+		end
+	end
+end

data/spec/clang/diagnostic_spec.rb

@@ -30,7 +30,8 @@ describe Diagnostic do
 	end
 
 	it "calls dispose_diagnostic on GC" do
-		expect(Lib).to receive(:dispose_diagnostic).with(diagnostic).at_least(:once)
+		diagnostic.autorelease = false
+		expect(Lib).to receive(:dispose_diagnostic).with(diagnostic).once
 		expect{diagnostic.free}.not_to raise_error
 	end
 

data/spec/clang/index_spec.rb

@@ -32,7 +32,8 @@ describe Index do
 	let(:index) { Index.new }
 
 	it "calls dispose_index_debug_unit on GC" do
-		expect(Lib).to receive(:dispose_index).with(index).at_least(:once)
+		index.autorelease = false
+		expect(Lib).to receive(:dispose_index).with(index).once
 		expect{index.free}.not_to raise_error
 	end
 
@@ -53,7 +54,7 @@ describe Index do
 
 	describe '#create_translation_unit' do
 		before :all do
-			system("clang -c #{fixture_path('simple.c')} -emit-ast -o #{TMP_DIR}/simple.ast")
+			system("#{CLANG_COMPILER} -c #{fixture_path('simple.c')} -emit-ast -o #{TMP_DIR}/simple.ast")
 		end
 
 		it "can create translation unit from a ast file" do

data/spec/clang/token_spec.rb

@@ -34,6 +34,7 @@ describe Tokens do
 	end
 
 	it "calls dispose_tokens on GC" do
+		tokens.autorelease = false
 		expect(Lib).to receive(:dispose_tokens).at_least(:once)
 		expect{tokens.free}.not_to raise_error
 	end

data/spec/clang/translation_unit_spec.rb

@@ -46,7 +46,8 @@ describe TranslationUnit do
 	end
 
 	it "calls dispose_translation_unit on GC" do
-		expect(Lib).to receive(:dispose_translation_unit).with(tu)
+		tu.autorelease = false
+		expect(Lib).to receive(:dispose_translation_unit).with(tu).once
 		expect{tu.free}.not_to raise_error
 	end
 
@@ -207,6 +208,7 @@ describe TranslationUnit do
 
 		describe "#self.release" do
 			it "releases data by calling 'clang_disposeCXTUResourceUsage'" do
+				ru.autorelease = false
 				expect{ ru.free }.not_to raise_error
 			end
 		end

data/spec/clang/utils_spec.rb

@@ -31,9 +31,8 @@ describe FFI::Clang::Utils do
 
 	describe '#self.self.clang_version' do
 		let (:version) { Utils::clang_version }
-		it "returns only a version of clang as string" do
-			expect(version).to be_kind_of(String)
-			expect(version).to match(/^\d+\.\d+$/)
+		it "returns only a version of clang as array [major, minor]" do
+			expect(version).to be_kind_of(Array)
 		end
 	end
 

data/spec/fixtures/compile_commands.json

@@ -0,0 +1,17 @@
+[
+{
+  "directory": "/home/xxxxx/src/build-trunk/lib/Support",
+  "command": "/opt/llvm/3.4/bin/clang++   -D_DEBUG -D_GNU_SOURCE -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS  -fPIC -fvisibility-inlines-hidden -Wall -W -Wno-unused-parameter -Wwrite-strings -Wmissing-field-initializers -pedantic -Wno-long-long -Wcovered-switch-default -Wnon-virtual-dtor -fno-rtti  -ffunction-sections -fdata-sections -O3  -I/home/xxxxx/src/build-trunk/lib/Support -I/home/xxxxx/src/llvm-trunk/lib/Support -I/home/xxxxx/src/build-trunk/include -I/home/xxxxx/src/llvm-trunk/include    -UNDEBUG -fno-exceptions -o CMakeFiles/LLVMSupport.dir/APFloat.cpp.o -c /home/xxxxx/src/llvm-trunk/lib/Support/APFloat.cpp",
+  "file": "/home/xxxxx/src/llvm-trunk/lib/Support/APFloat.cpp"
+},
+{
+  "directory": "/home/xxxxx/src/build-trunk/lib/Support",
+  "command": "/opt/llvm/3.4/bin/clang++   -D_DEBUG -D_GNU_SOURCE -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS  -fPIC -fvisibility-inlines-hidden -Wall -W -Wno-unused-parameter -Wwrite-strings -Wmissing-field-initializers -pedantic -Wno-long-long -Wcovered-switch-default -Wnon-virtual-dtor -fno-rtti  -ffunction-sections -fdata-sections -O3  -I/home/xxxxx/src/build-trunk/lib/Support -I/home/xxxxx/src/llvm-trunk/lib/Support -I/home/xxxxx/src/build-trunk/include -I/home/xxxxx/src/llvm-trunk/include    -UNDEBUG -fno-exceptions -o CMakeFiles/LLVMSupport.dir/APInt.cpp.o -c /home/xxxxx/src/llvm-trunk/lib/Support/APInt.cpp",
+  "file": "/home/xxxxx/src/llvm-trunk/lib/Support/APInt.cpp"
+},
+{
+  "directory": "/home/xxxxx/src/build-trunk/lib/Support",
+  "command": "/opt/llvm/3.4/bin/clang++   -D_DEBUG -D_GNU_SOURCE -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS  -fPIC -fvisibility-inlines-hidden -Wall -W -Wno-unused-parameter -Wwrite-strings -Wmissing-field-initializers -pedantic -Wno-long-long -Wcovered-switch-default -Wnon-virtual-dtor -fno-rtti  -ffunction-sections -fdata-sections -O3  -I/home/xxxxx/src/build-trunk/lib/Support -I/home/xxxxx/src/llvm-trunk/lib/Support -I/home/xxxxx/src/build-trunk/include -I/home/xxxxx/src/llvm-trunk/include    -UNDEBUG -fno-exceptions -o CMakeFiles/LLVMSupport.dir/APSInt.cpp.o -c /home/xxxxx/src/llvm-trunk/lib/Support/APSInt.cpp",
+  "file": "/home/xxxxx/src/llvm-trunk/lib/Support/APSInt.cpp"
+}
+]

data/spec/fixtures/completion.cxx

@@ -0,0 +1,8 @@
+#include <vector>
+
+std::vector<int> v1;
+std::vector<> v2;
+
+int main(void) {
+  v1.
+}

data/spec/spec_helper.rb

@@ -5,6 +5,15 @@ include FFI::Clang
 
 TMP_DIR = File.expand_path("../tmp/", __FILE__)
 
+if ENV['LLVM_CONFIG']
+  llvm_bindir = `#{ENV['LLVM_CONFIG']} --bindir`.chomp
+  CLANG_COMPILER = File.expand_path('clang', llvm_bindir)
+  CLANGPP_COMPILER = File.expand_path('clang++', llvm_bindir)
+else
+  CLANG_COMPILER = 'clang'
+  CLANGPP_COMPILER = 'clang++'
+end
+
 module ClangSpecHelper
 	def fixture_path(path)
 		File.join File.expand_path("../fixtures", __FILE__), path

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: ghazel-ffi-clang
 version: !ruby/object:Gem::Version
-  version: 0.2.0.2
+  version: 0.2.1
+  prerelease: 
 platform: ruby
 authors:
 - Jari Bakken
@@ -9,25 +10,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -35,6 +39,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -42,29 +47,33 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby FFI bindings for libclang C interface.
@@ -85,16 +94,21 @@ files:
 - ext/teapot.rb
 - ffi-clang.gemspec
 - lib/ffi/clang.rb
+- lib/ffi/clang/code_completion.rb
 - lib/ffi/clang/comment.rb
+- lib/ffi/clang/compilation_database.rb
 - lib/ffi/clang/cursor.rb
 - lib/ffi/clang/diagnostic.rb
 - lib/ffi/clang/file.rb
 - lib/ffi/clang/index.rb
 - lib/ffi/clang/lib.rb
+- lib/ffi/clang/lib/code_completion.rb
 - lib/ffi/clang/lib/comment.rb
+- lib/ffi/clang/lib/compilation_database.rb
 - lib/ffi/clang/lib/cursor.rb
 - lib/ffi/clang/lib/diagnostic.rb
 - lib/ffi/clang/lib/file.rb
+- lib/ffi/clang/lib/inclusions.rb
 - lib/ffi/clang/lib/index.rb
 - lib/ffi/clang/lib/source_location.rb
 - lib/ffi/clang/lib/source_range.rb
@@ -111,7 +125,9 @@ files:
 - lib/ffi/clang/unsaved_file.rb
 - lib/ffi/clang/utils.rb
 - lib/ffi/clang/version.rb
+- spec/clang/code_completion_spec.rb
 - spec/clang/comment_spec.rb
+- spec/clang/compilation_database_spec.rb
 - spec/clang/cursor_spec.rb
 - spec/clang/diagnostic_spec.rb
 - spec/clang/file_spec.rb
@@ -124,6 +140,8 @@ files:
 - spec/clang/utils_spec.rb
 - spec/fixtures/a.c
 - spec/fixtures/canonical.c
+- spec/fixtures/compile_commands.json
+- spec/fixtures/completion.cxx
 - spec/fixtures/docs.c
 - spec/fixtures/docs.cc
 - spec/fixtures/docs.h
@@ -135,29 +153,32 @@ files:
 homepage: ''
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.24
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Ruby FFI bindings for libclang C interface.
 test_files:
+- spec/clang/code_completion_spec.rb
 - spec/clang/comment_spec.rb
+- spec/clang/compilation_database_spec.rb
 - spec/clang/cursor_spec.rb
 - spec/clang/diagnostic_spec.rb
 - spec/clang/file_spec.rb
@@ -170,6 +191,8 @@ test_files:
 - spec/clang/utils_spec.rb
 - spec/fixtures/a.c
 - spec/fixtures/canonical.c
+- spec/fixtures/compile_commands.json
+- spec/fixtures/completion.cxx
 - spec/fixtures/docs.c
 - spec/fixtures/docs.cc
 - spec/fixtures/docs.h