roject 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa3fe871560329e9b7190ad7bd2463fdafe4e9c2
-  data.tar.gz: 5997c6dbd154d69ba4f3af0e597b1f6c3cbcf34f
+  metadata.gz: 08bd9ebfc4cf93c5b28cbef2ec86690f62589d92
+  data.tar.gz: f87d74bc4a8fae6c85103bf5d859ac58790d5d33
 SHA512:
-  metadata.gz: 7d8da665ec2267de39a037f90012177071a3d4b08ecb78f438342d2e85bcda66675310524a7c4c0204c2a798c2218862a1b344d316c41d874c7b066066053bb0
-  data.tar.gz: cac8c7b65096d1b5a539ab01ed355df674b755e50665b1a30dde3e648a7357c1ecbef77a49380e656b7afff3bde4c57d26fc4d112859e5d080894af1fdc07c76
+  metadata.gz: ffdcacbc7fe089cbd09a4b1a23eefdfa1f29a2f8b9db770d04e10e99504fc4c4052dbf1522f3bf6264b8f97c0e73ed373ce3c96a8561d66f1f85f7ebe435d3c8
+  data.tar.gz: 15fd4b18682878fd2ef4d54e6ea745611938ff48962f5dd032d81e8d7c1e3067aa025cde6b8e9f25bcd2934f6cb09035c7b1161ede9072f41f077f0250f9d342

data/exp/project/_templates/main.general

@@ -0,0 +1,22 @@
+// Include libraries
+#include <iostream>
+
+// Namespaces
+using namespace std;
+
+/**
+ * The main function of the program
+ *
+ * @at;param argc the number of command line arguments
+ * @at;param argv the array of command line arguments
+ *
+ * @at;return exit status
+ */
+int main(int argc, const char **argv)
+{
+	// Code
+	cout << "Hello World!" << endl;
+
+	// System Exit
+	return 0;
+}

data/exp/project/_templates/makefile.general

@@ -0,0 +1,55 @@
+# -------------------------------- CONFIG --------------------------------
+
+TARGET = @(project_name -> lowercase)
+
+SHELL = /bin/bash -O globstar
+CC    = g++
+
+COMPILE = $(CC) -c
+LINK    = $(CC)
+
+CFLAGS = -Wall -std=c++14
+LFLAGS = -Wall
+INCLUD = -Iinclude
+LIBRAR = -Llib
+
+# -------------------------------- FOLDER --------------------------------
+
+INCDIR = include
+SRCDIR = src
+OBJDIR = obj
+BINDIR = bin
+INSDIR = /usr/bin
+
+# -------------------------------- FILES  --------------------------------
+
+INCLUDS = $(shell ls $(INCDIR)/**/*.h)
+SOURCES = $(shell ls $(SRCDIR)/**/*.cpp)
+OBJECTS = $(patsubst $(SRCDIR)/%.cpp, $(OBJDIR)/%.o, $(SOURCES))
+BINARY  = $(BINDIR)/$(TARGET)
+
+# -------------------------------- TASKS  --------------------------------
+
+$(BINARY): $(OBJECTS)
+	@at;echo $(SOURCES)
+	@at;test -d $(@at;D) || mkdir $(@at;D)
+	@at;echo building $@at;
+	@at;$(LINK) $^ -o $@at; $(LFLAGS) $(LIBRAR)
+
+$(OBJDIR)/%.o: $(SRCDIR)/%.cpp $(INCLUDS)
+	@at;test -d $(@at;D) || mkdir $(@at;D)
+	@at;echo compiling $<
+	@at;$(COMPILE) $< -o $@at; $(CPPFLAGS) $(INCLUD)
+
+clean:
+	@at;echo Cleaning up...
+	@at;rm -r $(OBJDIR) $(BINDIR)
+
+install:
+	cp $(BINDIR)/$(TARGET) $(INSDIR)
+
+uninstall:
+	rm $(INSDIR)/$(TARGET)
+
+run:
+	$(BINARY)

data/exp/project/output/main.cpp

@@ -0,0 +1,22 @@
+// Include libraries
+#include <iostream>
+
+// Namespaces
+using namespace std;
+
+/**
+ * The main function of the program
+ *
+ * @param argc the number of command line arguments
+ * @param argv the array of command line arguments
+ *
+ * @return exit status
+ */
+int main(int argc, const char **argv)
+{
+	// Code
+	cout << "Hello World!" << endl;
+
+	// System Exit
+	return 0;
+}

data/exp/project/output/testheader.h

@@ -1,11 +1,11 @@
 /*
 
-Program: Dre
+Program: Foo
 
-Nowadays everybody wanna talk like they got somethin' to say but nothin' comes out when they move their lips just a bunch of gibberish and they all acting like they forgot about Dre.
+Foo bar baz joo jar jaz noo kar kaz
 
 Author:  Anshul Kharbanda
-Created: 7 - 23 - 2016
+Created: 7 - 24 - 2016
 
 */
 

data/exp/project/output/testsource.cpp

@@ -1,14 +1,14 @@
 /*
 
-Program: Dre
+Program: Foo
 
-Nowadays everybody wanna talk like they got somethin' to say but nothin' comes out when they move their lips just a bunch of gibberish and they all acting like they forgot about Dre.
+Foo bar baz joo jar jaz noo kar kaz
 
 Author:  Anshul Kharbanda
-Created: 7 - 23 - 2016
+Created: 7 - 24 - 2016
 
 */
 
-#include "Dre/path/to/file.h"
+#include "Foo/path/to/file.h"
 
 // Code

data/lib/project.rb

@@ -109,7 +109,7 @@ module Roject
 		#
 		# Parameter: name - the name of the maker to run
 		# Parameter: args - the args to pass to the file
-		def make(name, args)
+		def make name, args={}
 			if @makers.has_key? name
 				@makers[name].make self, args
 			else

data/lib/roject.rb

@@ -20,5 +20,5 @@ require_relative "project"
 # Created: 7 - 8 - 2016
 module Roject
 	# The Version of Roject
-	VERSION = "1.0.1"
+	VERSION = "1.0.2"
 end

data/spec/project_spec.rb

@@ -36,281 +36,276 @@ describe Roject::Project do
 			short_description: "Foo bar",
 			long_description:  "Foo bar baz joo jar jaz noo kar kaz"
 		})
+
+		# Project info
+		@path   = "path/to/file"
+		@config = @foocfg
+
+		# ----------------------FILE MAKERS----------------------
+
+		@header = {
+			name:      :header,
+			path:      "include/@(project_name)/@(path)",
+			template:  "header.general",
+			extension: "h",
+			out:       "include/#{@config[:project_name]}/#{@path}.h",
+			text:      IO.read("output/testheader.h")
+		}
+
+		@source = {
+			name:      :source,
+			path:      "src/@(path)",
+			template:  "source.general",
+			extension: "cpp",
+			out:       "src/#{@path}.cpp",
+			text:      IO.read("output/testsource.cpp")
+		}
+
+		@makefile = {
+			name:      :makefile,
+			path:      "Makefile",
+			template:  "makefile.general",
+			extension: nil,
+			out:       "Makefile",
+			text:      IO.read("output/Makefile")
+		}
+
+		@main = {
+			name:      :main,
+			path:      "src/main",
+			template:  "main.general",
+			extension: "cpp",
+			out:       "src/main.cpp",
+			text:      IO.read("output/main.cpp")
+		}
+
+		# ----------------------TASK MAKERS----------------------
+
+		@module = {
+			name:  :module,
+			block: Proc.new do |args|
+				args[:header_id] = c_header_id(args[:path])
+				make :header, args
+				make :source, args
+			end
+		}
+
+		@init = {
+			name:  :init,
+			block: Proc.new do |args|
+				make :makefile
+				make :main
+			end
+		}
 	end
 
-	# Describe Roject::Project#config
+	# Describe Roject::Project::exist?
 	#
-	# If a hash is given, sets the Project configuration to the hash.
-	# Else, returns the configuration of the Project.
-	# 
-	# Parameter: hash - the hash to configure the project with
+	# Check if a project file exists in the current directory
+	#
+	# Parameter: filename - the filename to check
+	# 						(defaults to the default filename)
 	# 
-	# Return: the configuration of the Project
-	describe '#config' do
-		context 'with no arguments given' do
-			it 'returns the configuration of the Project' do
-				expect(@project.config).to eql Roject::Project::CONFIG_DEFAULT
-			end
+	# Returns: true if the project file exists in the current 
+	# 		   directory
+	describe '::exist?' do
+		it 'checks if the given project filename exists in the current directory' do
+			expect(Roject::Project).to be_exist(@foofle)
 		end
 
-		context 'with hash given' do
-			it 'configures the Project with the given hash' do
-				expect{@project.config(@foocfg)}.not_to raise_error
-				expect(@project.config).to eql @foocfg
-			end
+		it 'checks the default project filename if no filename is given' do
+			expect(Roject::Project).to be_exist
 		end
 	end
 
-	# Describe Roject::Project loading system
+	# Describe Roject::Project::load
 	#
-	# The system of loading and reloading from a file
+	# Loads a Project from the project file with the given filename
+	# 
+	# Parameter: filename - the name of the file to parse
 	#
-	# Author:  Anshul Kharbanda
-	# Created: 7 - 25 - 2016
-	describe 'loading' do
-		# Describe Roject::Project::exist?
-		#
-		# Check if a project file exists in the current directory
-		#
-		# Parameter: filename - the filename to check
-		# 						(defaults to the default filename)
-		# 
-		# Returns: true if the project file exists in the current 
-		# 		   directory
-		describe '::exist?' do
-			context 'with a filename given' do
-				it 'checks if the given project filename exists in the current directory' do
-					expect(Roject::Project).to be_exist(@foofle)
-				end
-			end
+	# Return: Project loaded from the file
+	describe '::load' do
+		# Check when filename is given
+		it 'loads a project from the given filename' do
+			# Test loading foobar.rb file
+			expect{@project = Roject::Project.load(@foofle)}.not_to raise_error
+			expect(@project).to be_an_instance_of Roject::Project
+			expect(@project.config).to eql @foocfg
+		end
 
-			context 'with no filename given' do
-				it 'checks if the default project filename exists in the current directory' do
-					expect(Roject::Project).to be_exist
-				end
-			end
+		# Check when filename is not given
+		it 'loads a project from the default filename (if no filename is given)' do
+			# Test loading default file
+			expect{@project = Roject::Project.load}.not_to raise_error
+			expect(@project).to be_an_instance_of Roject::Project
 		end
 
-		# Describe Roject::Project::load
-		#
-		# Loads a Project from the project file with the given filename
-		# 
-		# Parameter: filename - the name of the file to parse
-		#
-		# Return: Project loaded from the file
-		describe '::load' do
-			# Check when filename is given
-			context 'with a filename given' do
-				it 'loads a project from the given filename' do
-					# Test loading foobar.rb file
-					expect{@project = Roject::Project.load(@foofle)}.not_to raise_error
-					expect(@project).to be_an_instance_of Roject::Project
-					expect(@project.config).to eql @foocfg
-				end
-			end
+		# Delete makers
+		after :all do @project.instance_variable_set :@makers, {} end
+	end
 
-			# Check when filename is not given
-			context 'with no filename given' do
-				it 'loads a project from the default filename' do
-					# Test loading default file
-					expect{@project = Roject::Project.load}.not_to raise_error
-					expect(@project).to be_an_instance_of Roject::Project
-				end
-			end
+	# Describe Roject::Project::open
+	# 
+	# Alias for load if no block is given. Evaluates the given
+	# block in the context of the project if block is given
+	#
+	# Parameter: filename - the name of the file to parse
+	# 						(defaults to the default filename)
+	# Parameter: block    - the block to evaluate within the 
+	# 						context of the project
+	# 
+	# Return: Project loaded from the file
+	describe '::open' do
+		# Check for when no block is given
+		it 'loads the project and returns it with no block given' do
+			expect { @project = Roject::Project.open }.not_to raise_error
+			expect(@project).to be_an_instance_of Roject::Project
 		end
 
-		# Describe Roject::Project::open
-		# 
-		# Alias for load if no block is given. Evaluates the given
-		# block in the context of the project if block is given
-		#
-		# Parameter: filename - the name of the file to parse
-		# 						(defaults to the default filename)
-		# Parameter: block    - the block to evaluate within the 
-		# 						context of the project
-		# 
-		# Return: Project loaded from the file
-		describe '::open' do
-			# Check for when block is given
-			context 'with a block given' do
-				it 'loads the project and evaluates it within the given block' do
-					project = nil
-					expect { Roject::Project.open { project = self } }.not_to raise_error
-					expect(project).to be_an_instance_of Roject::Project
-				end
-			end
-
-			# Check for when no block is given
-			context 'with no block given' do
-				it 'loads the project' do
-					expect { @project = Roject::Project.open }.not_to raise_error
-					expect(@project).to be_an_instance_of Roject::Project
-				end
-			end
+		# Check for when block is given
+		it 'loads the project and evaluates in the context of the project (if block given)' do
+			project = nil
+			expect { Roject::Project.open { project = self } }.not_to raise_error
+			expect(project).to be_an_instance_of Roject::Project
 		end
 
-		# Describe Roject::Project#reload
-		#
-		# Reloads the project with the file with the given filename
-		# 
-		# Parameter: filename - the name of the file to parse
-		# 						(defaults to the default filename)
-		describe '#reload' do
-			context 'with a filename given' do
-				it 'loads the given filename into the project' do
-					# Test loading foobar.rb file
-					expect{@project.reload("foobar.rb")}.not_to raise_error
-					expect(@project).to be_an_instance_of Roject::Project
-					expect(@project.config).to eql @foocfg
-				end
-			end
+		# Delete makers
+		after :all do @project.instance_variable_set :@makers, {} end
+	end
 
-			context 'with no filename given' do
-				it 'loads the default filename into the project' do
-					# Test loading default file
-					expect{@project.reload}.not_to raise_error
-					expect(@project).to be_an_instance_of Roject::Project
-				end
-			end
+	# Describe Roject::Project#reload
+	#
+	# Reloads the project with the file with the given filename
+	# 
+	# Parameter: filename - the name of the file to parse
+	# 						(defaults to the default filename)
+	describe '#reload' do
+		# Test loading foobar.rb file
+		it 'loads the given filename into the project' do
+			expect{@project.reload("foobar.rb")}.not_to raise_error
+			expect(@project).to be_an_instance_of Roject::Project
+			expect(@project.config).to eql @foocfg
+		end
+
+		# Test loading default file
+		it 'loads the default filename (if no filename is given)' do
+			expect{@project.reload}.not_to raise_error
+			expect(@project).to be_an_instance_of Roject::Project
 		end
 
 		# Delete makers
 		after :all do @project.instance_variable_set :@makers, {} end
 	end
 
-	# Describe Roject::Project makers
-	#
-	# The system of automating tasks in Roject
+	# Describe Roject::Project#config
 	#
-	# Author:  Anshul Kharbanda
-	# Created: 7 - 24 - 2016
-	describe 'makers' do
-		# Before all
-		before :all do
-			@path = "path/to/file"
-			@config = @project.config
-
-			# ----------------------FILE INFO----------------------
-
-			@header = {
-				name:      :header,
-				path:      "include/@(project_name)/@(path)",
-				template:  "header.general",
-				extension: "h",
-				out:       "include/#{@config[:project_name]}/#{@path}.h",
-				text:      IO.read("output/testheader.h")
-			}
-
-			@source = {
-				name:      :source,
-				path:      "src/@(path)",
-				template:  "source.general",
-				extension: "cpp",
-				out:       "src/#{@path}.cpp",
-				text:      IO.read("output/testsource.cpp")
-			}
-
-			# ----------------------TASK INFO----------------------
-
-			@module = {
-				name:  :module,
-				block: Proc.new do |args|
-					args[:header_id] = c_header_id(args[:path])
-					make :header, args
-					make :source, args
-				end
-			}
+	# If a hash is given, sets the Project configuration to the hash.
+	# Else, returns the configuration of the Project.
+	# 
+	# Parameter: hash - the hash to configure the project with
+	# 
+	# Return: the configuration of the Project
+	describe '#config' do
+		it 'returns the configuration of the Project with no arguments given' do
+			expect(@project.config).to eql Roject::Project::CONFIG_DEFAULT
+		end
+
+		it 'configures the Project if a configuration hash is given' do
+			expect{@project.config(@foocfg)}.not_to raise_error
+			expect(@project.config).to eql @foocfg
 		end
+	end
 
-		# Describe Roject::Project#file
-		#
-		# Creates a file maker with the given name and hash
-		#
-		# Parameter: name - the name of the maker
-		# Parameter: hash - the hash arguments of the maker
-		describe '#file' do
-			it 'creates a file maker with the given name and hash of arguments' do
-				# Each file type
-				[@header, @source].each do |ft|
-					# Create filemaker
-					@project.file ft[:name], ft
-
-					# Get Filemaker
-					fmkr = @project.instance_variable_get(:@makers)[ft[:name]]
-					expect(fmkr).to be_an_instance_of Roject::FileMaker
-
-					# Path
-					expect(fmkr.instance_variable_get(:@path)).to be_an_instance_of General::GTemplate
-					expect(fmkr.instance_variable_get(:@path).to_s).to eql ft[:path]
-
-					# Template
-					expect(fmkr.instance_variable_get(:@template)).to be_an_instance_of General::GIO
-					expect(fmkr.instance_variable_get(:@template).source).to eql "#{@config[:directory][:templates]}/#{ft[:template]}"
-
-					# Extension
-					expect(fmkr.instance_variable_get(:@extension)).to eql ft[:extension]
-				end
+	# Describe Roject::Project#file
+	#
+	# Creates a file maker with the given name and hash
+	#
+	# Parameter: name - the name of the maker
+	# Parameter: hash - the hash arguments of the maker
+	describe '#file' do
+		it 'creates a file maker with the given name and hash of arguments' do
+			# Each file type
+			[@header, @source, @makefile, @main].each do |ft|
+				# Create filemaker
+				@project.file ft[:name], ft
+				fmkr = @project.instance_variable_get(:@makers)[ft[:name]]
+
+				# Filemaker
+				expect(fmkr).to be_an_instance_of Roject::FileMaker
+
+				# Path
+				expect(fmkr.instance_variable_get(:@path)).to be_an_instance_of General::GTemplate
+				expect(fmkr.instance_variable_get(:@path).to_s).to eql ft[:path]
+
+				# Template
+				expect(fmkr.instance_variable_get(:@template)).to be_an_instance_of General::GIO
+				expect(fmkr.instance_variable_get(:@template).source).to eql "#{@config[:directory][:templates]}/#{ft[:template]}"
+
+				# Extension
+				expect(fmkr.instance_variable_get(:@extension)).to eql ft[:extension]
 			end
 		end
+	end
 
-		# Describe Roject::Project#task
-		#
-		# Creates a task maker with the given name and block
-		#
-		# Parameter: name - the name of the recipie
-		# Parameter: block - the recipie block
-		describe '#task' do
-			it 'creates a task maker with the given name and block' do
+	# Describe Roject::Project#task
+	#
+	# Creates a task maker with the given name and block
+	#
+	# Parameter: name - the name of the recipie
+	# Parameter: block - the recipie block
+	describe '#task' do
+		it 'creates a task maker with the given name and block' do
+			[@module, @init].each do |tk|
 				# Create taskmaker
-				@project.task @module[:name], &@module[:block]
+				@project.task tk[:name], &tk[:block]
+				tmkr = @project.instance_variable_get(:@makers)[tk[:name]]
 
-				# Get filemaker
-				tmkr = @project.instance_variable_get(:@makers)[@module[:name]]
+				# Check taskmaker
 				expect(tmkr).to be_an_instance_of Roject::TaskMaker
 			end
 		end
+	end
 
-		# Describe Roject::Project#make
-		#
-		# Runs the maker of the given name with the given args
-		#
-		# Parameter: name - the name of the maker to run
-		# Parameter: args - the args to pass to the file
-		describe '#make' do
-			# Creating filetype
-			context 'with a file maker name given' do
-				it 'creates a file of the given type with the given arguments' do
-					# Each file type
-					[@header, @source].each do |ft|
-						# Make Header
-						@project.make ft[:name], 
-						path: @path,
-						header_id: @project.c_header_id(@path)
-
-						# Test output
-						expect(File).to be_file(ft[:out])
-						expect(IO.read(ft[:out])).to eql ft[:text]
-					end
-				end
+	# Describe Roject::Project#make
+	#
+	# Runs the maker of the given name with the given args
+	#
+	# Parameter: name - the name of the maker to run
+	# Parameter: args - the args to pass to the file
+	describe '#make' do
+		# Creating filetype
+		it 'creates the given filetype with the given arguments if a file maker name is given' do
+			# Each file type
+			[@header, @source, @makefile, @main].each do |ft|
+				# Make Header
+				@project.make ft[:name], 
+				path: @path,
+				header_id: @project.c_header_id(@path)
+
+				# Test output
+				expect(File).to be_file(ft[:out])
+				expect(IO.read(ft[:out])).to eql ft[:text]
 			end
+		end
+
+		# Performing task
+		it 'performs the given task with the given arguments if task maker name is given' do
+			# Do module tasks
+			@project.make @module[:name], path: @path
 
-			# Performing task
-			context 'with a task maker name given' do
-				it 'performs the task of the given name with the given arguments' do
-					# Do task
-					@project.make @module[:name], path: @path
-
-					# Each header
-					[@header, @source].each do |file|
-						# Test output
-						expect(File).to be_file(file[:out])
-						expect(IO.read(file[:out])).to eql file[:text]
-					end
-				end
+			# Each header
+			[@header, @source].each do |file|
+				# Test output
+				expect(File).to be_file(file[:out])
+				expect(IO.read(file[:out])).to eql file[:text]
 			end
+		end
 
-			# Do afterwards
-			after :each do FileUtils.rmtree ["include", "src"] end
+		# Delete files
+		after :all do 
+			FileUtils.rmtree ["include", "src"]
+			FileUtils.rm "Makefile"
 		end
 	end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roject
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Anshul Kharbanda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: general
@@ -80,8 +80,11 @@ files:
 - Rakefile
 - bin/roject
 - exp/project/_templates/header.general
+- exp/project/_templates/main.general
+- exp/project/_templates/makefile.general
 - exp/project/_templates/source.general
 - exp/project/foobar.rb
+- exp/project/output/main.cpp
 - exp/project/output/testheader.h
 - exp/project/output/testsource.cpp
 - exp/project/project.rb