roject 0.7.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5265b6ec336684e4ba63f8fb0348512446e55f16
-  data.tar.gz: 26971fbf99b1b2ccac6d935ab74acaebc78dcd3a
+  metadata.gz: 807cc469992c60c0377a1a0544b487e71f39d6cd
+  data.tar.gz: 290adb3e83bb77773cf86265fe64c9962aa00353
 SHA512:
-  metadata.gz: c7fc1107661b11a7818ffb400fc1da28b76589eed4c78478ab85268cb4735f6669251ae9affb00b7e419631a857e908df01fddd232eb8c074f76187d75c1336c
-  data.tar.gz: 63de4a62904dbf091ce60006df1c5ad46be5be35b86ccc01ea50045640e3f61d067dad914b1a9d32a664dc8f44b28b8f9df316b8b65c10d4f056fd22b33674b9
+  metadata.gz: a886dc73ee4ad3ab267f51b7ef5fa14c78074e581a1d6a83b05546efbce326c3d99be8d2a7909a10da15c508d4387d354f36c1c09cba48136943ca7f1d801b9d
+  data.tar.gz: dc5437b8cd0605dbbfd94497dc3cd810e57a0451c891da46138631fe9c2574d3008d0d53b0b56271dc70a2a405ea2b17d9dca4cbe472d95fc934f8976561cfe2

data/README.md

@@ -1,3 +1,149 @@
 # Roject
 
-Roject is a programming project manager written in Ruby. With Roject, you can create and edit projects based on templates and using simple, customisable commands without a heavy IDE.
+Roject is a programming project manager written in Ruby. With Roject, you can create and edit projects based on templates and using simple, customisable commands without a heavy IDE.
+
+## Table of Contents
+
+ - [Project Script](#project-script)
+ 	- [Config](#config)
+ 	- [Makers](#makers)
+ - [The Command Line](#the-command-line)
+
+## Project Script
+
+A Roject project is configured using a project script in a project directory, create a ruby script called "project.rb". This ruby script is evaluated in the context of a Roject project object and contains information about the project, the types of files that can be made, and the tasks that can be performed.
+
+```ruby
+# Config
+config project_name: "Dre",
+author: "Anshul Kharbanda",
+created: "7 - 23 - 2016",
+short_description: "Forgot about Dre.",
+long_description: "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."
+
+#---------------------------MAKERS---------------------------
+
+# Header file
+file :header, 
+path: "include/@(project_name)/@(path)",
+template: "header.general",
+extension: "h"
+
+# Source file
+file :source, 
+path: "src/@(path)",
+template: "source.general",
+extension: "cpp"
+
+# Module includes a source and include
+task :module do |args|
+	# Add header id
+	args[:header_id] = c_header_id(args[:path])
+
+	# Create source and header
+	make :header, args
+	make :source, args
+end
+```
+
+In this script, the project information (project_name, author, etc.) is configured using the `config` method, which is given a hash of the project info. After which, project makers (automated tasks that can be called via the command line) are defined using the `file` and `task` methods. The `file` method creates a file maker which makes files according to the information given using the command line arguments. The `task` method creates a task maker which executes the given block with the command line arguments.
+
+### Config
+
+Projects are configured using the `config` method:
+
+```ruby
+config project_name: "Dre",
+author: "Anshul Kharbanda",
+created: "7 - 23 - 2016",
+short_description: "Forgot about Dre.",
+long_description: "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."
+```
+
+This command should be passed a hash of project info keys, of which are the following:
+
+|        Key        |            Description             |
+|:-----------------:|:----------------------------------:|
+|   project_name    |      the name of the project       |
+|      author       |       the project's author         |
+|      created      |  the date the project was created  |
+| short_description | a short description of the project |
+| long_description  | a long description of the project  |
+
+There are also optional options to set. The `directory` key is a hash of essential directories. The `templates` key within the `directory` hash determines where project templates are located, and defaults to `_templates`. Of course, this can also be changed to your liking.
+
+```ruby
+config project_name: "Dre",
+author: "Anshul Kharbanda",
+created: "7 - 23 - 2016",
+short_description: "Forgot about Dre.",
+long_description: "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.",
+directory: {
+	templates: "new-templates-dir"
+}
+```
+
+### Makers
+
+Project makers are also specified int the Project script. Makers are automated tasks that create new files. There are two types of makers to date.
+
+#### File Makers
+
+File makers are specified using the `file` method.
+
+```ruby
+file :header, 
+path: "include/@(project_name)/@(path)",
+template: "header.general",
+extension: "h"
+```
+
+Roject uses the [General](http://andydevs.github.io/general) templating library for file and string templates. FileMakers use general templates, project information, and command line arguments to create files of specific types. File templates are located in the `templates` directory (which is set using `config`).
+
+The `file` method is passed a name (used to call the maker via the command line arguments), and a hash of options, which should include the following:
+
+|    Key    |                                        Description                                      |
+|:---------:|:---------------------------------------------------------------------------------------:|
+|   path    |     The path of the file, as a General template string (parsed on creation of the file) |
+| template  |                     The filename of the General template file to format                 |
+| extension |                                     The file extension                                  |
+
+#### Task Makers
+
+Task makers are specified using the `task` method.
+
+```ruby
+# Module includes a source and include
+task :module do |args|
+	# Add header id
+	args[:header_id] = c_header_id(args[:path])
+
+	# Create source and header
+	make :header, args
+	make :source, args
+end
+```
+
+The `task` method is passed the command line name and a block which is called when the task is called from the command line, which takes one hash of arguments parsed from the command line.
+
+## The Command Line
+
+The Roject library comes with the `roject` binary script, from which you call the project makers that were defined.
+
+```
+$ roject [maker name] [command line arguments]
+```
+
+Command line arguments are key-value pairs which follow the following pattern: `[key]:[value]`. The script will search the current directory for a project script, read it, and run the given maker in the context of the project.
+
+---
+Anshul Kharbanda

data/Rakefile

@@ -14,6 +14,7 @@ Created: 7 - 8 - 2016
 # Required libraries
 require "rspec/core/rake_task"
 require "rubygems/tasks"
+require "fileutils"
 
 # Requird files
 require_relative "lib/roject"
@@ -22,6 +23,10 @@ require_relative "lib/roject"
 GEMDIR  = "gem"
 SPECDIR = "spec"
 
+# Test argument sets
+TEST_ARG_SETS = "header path:\"path/to/file\"",
+				"module path:\"path/to/second/file\""
+
 # Default task
 task :default => :spec
 
@@ -51,12 +56,34 @@ namespace :git do
 	end
 
 	desc "Soft git reset"
-	task :reset do
-		sh "git reset"
-	end
+	task :reset do sh "git reset" end
 
 	desc "Hard git reset"
-	task :reset_hard do
-		sh "git reset --hard HEAD"
-	end
+	task :reset_hard do sh "git reset --hard HEAD" end
+end
+
+#----------------------------------SCRIPT----------------------------------
+
+desc "Runs the script with test arguments"
+task :test, [:index] do |task, args|
+	# Changedown to project
+	Dir.chdir "exp/project"
+
+	# Run each test arg set
+	sh "../../bin/roject #{TEST_ARG_SETS[args[:index].to_i]}"
+
+	# Changeup
+	Dir.chdir "../.."
+end
+
+desc "Cleans the project directory"
+task :cleantest do
+	# Changedown to project
+	Dir.chdir "exp/project"
+	
+	# Cleanup
+	FileUtils.rmtree ["include", "src"]
+
+	# Changeup
+	Dir.chdir "../.."
 end

data/bin/roject

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+=begin 
+
+Program: Roject
+
+Roject is a programming project manager written in Ruby.
+With Roject, you can create and edit projects based on templates
+using simple commands without a heavy IDE.
+
+Author:  Anshul Kharbanda
+Created: 7 - 8 - 2016
+
+=end
+
+# Require roject library
+require_relative "../lib/roject"
+
+# Regular expression for parsing arguments
+ARGREGEX = /(?<key>\w+):(?<value>.+)/
+
+# Parses command line arguments into a task
+# and hash of arguments
+# 
+# Parameter: args - the command line arguments
+# 
+# Return: parsed task and hash of arguments
+def parse_arguments args
+	# First argument is the maker
+	makr = args[0].to_sym
+
+	# Parse remaining arguments
+	argh = {}; args[1..-1].each do |arg|
+		ARGREGEX.match(arg) do |match| 
+			argh[match[:key].to_sym] = match[:value]
+		end
+	end
+
+	# Return maker and args
+	return [makr, argh]
+end
+
+# If working dir is project
+if Roject::Project.exist?
+
+	# Parse command line arguments
+	task, args = parse_arguments ARGV
+
+	# Print info
+	puts "making #{task}", "args #{args}"
+
+	# Make maker and args
+	Roject::Project.open { make task, args }
+
+# Else raise error
+else
+	raise IOError, "Could not locate a project script in current directory: #{Dir.getwd}"
+end

data/exp/project/foobar.rb

@@ -2,4 +2,4 @@ config project_name: "Foo",
 author: "Anshul Kharbanda",
 created: "7 - 24 - 2016",
 short_description: "Foo bar",
-long_description: "Foo bar baz ju jar jaz nu nar naz"
+long_description: "Foo bar baz joo jar jaz noo kar kaz"

data/lib/project.rb

@@ -25,7 +25,7 @@ module Roject
 	# Author:  Anshul Kharbanda
 	# Created: 7 - 10 - 2016
 	class Project
-		# Includes
+		# Helper methods for creating and manipulating projects
 		include Helpers
 
 		# Default filename
@@ -43,6 +43,34 @@ module Roject
 			}
 		}
 
+		# 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
+		def self.exist? filename=FILENAME_DEFAULT
+			File.file?(FILENAME_DEFAULT)
+		end
+
+		#-----------------------------------CLASS CONFIG-----------------------------------
+
+		# 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
+		def self.open filename=FILENAME_DEFAULT, &block
+			project = self.load(filename)
+			project.instance_eval(&block) unless block.nil?
+			return project
+		end
+
 		# Loads a Project from the project file with the given filename
 		# 
 		# Parameter: filename - the name of the file to parse
@@ -50,17 +78,23 @@ module Roject
 		#
 		# Return: Project loaded from the file
 		def self.load filename=FILENAME_DEFAULT
-			project = Roject::Project.new
+			project = self.new
 			project.instance_eval(IO.read(filename))
 			return project
 		end
 
-		#----------------------------------INIT AND CONFIG----------------------------------
+		#----------------------------------INSTANCE CONFIG----------------------------------
 
 		# Called upon the initialization of a Project
 		# Creates config and makers hashes
 		def initialize; @config = CONFIG_DEFAULT; @makers = {}; end
 
+		# Reloads the project with the file with the given filename
+		# 
+		# Parameter: filename - the name of the file to parse
+		# 						(defaults to the default filename)
+		def reload(filename=FILENAME_DEFAULT); initialize and instance_eval(IO.read(filename)); end
+
 		# If a hash is given, sets the Project configuration to the hash.
 		# Else, returns the configuration of the Project.
 		#

data/lib/roject.rb

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

data/spec/project_spec.rb

@@ -21,14 +21,20 @@ require_relative "../lib/roject"
 describe Roject::Project do
 	# Do before
 	before :all do
+		# Change to project
 		Dir.chdir "exp/project"
+
+		# Create base project
 		@project = Roject::Project.new
-		@config = Roject::Project::CONFIG_DEFAULT.merge({
+
+		# Foobar file
+		@foofle = "foobar.rb"
+		@foocfg = Roject::Project::CONFIG_DEFAULT.merge({
 			project_name: 	   "Foo",
 			author: 	  	   "Anshul Kharbanda",
 			created: 		   "7 - 24 - 2016",
 			short_description: "Foo bar",
-			long_description:  "Foo bar baz ju lar laz nu kar kaz"
+			long_description:  "Foo bar baz joo jar jaz noo kar kaz"
 		})
 	end
 
@@ -49,37 +55,127 @@ describe Roject::Project do
 
 		context 'with hash given' do
 			it 'configures the Project with the given hash' do
-				expect{@project.config(@config)}.not_to raise_error
-				expect(@project.config).to eql @config
+				expect{@project.config(@foocfg)}.not_to raise_error
+				expect(@project.config).to eql @foocfg
 			end
 		end
 	end
 
-	# Describe Roject::Project::load
+	# Describe Roject::Project loading system
 	#
-	# Loads a Project from the project file with the given filename
-	# 
-	# Parameter: filename - the name of the file to parse
+	# The system of loading and reloading from a file
 	#
-	# Return: Project loaded from the file
-	describe '::load' do
-		context 'with a filename given' do
-			it 'loads a project from the given filename' do
-				expect{@project = Roject::Project.load("project.rb")}.not_to raise_error
-				expect(@project).to be_an_instance_of Roject::Project
+	# 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
+
+			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
 		end
 
-		context 'with no filename given' do
-			it 'loads a project from the default filename' do
-				expect{@project = Roject::Project.load}.not_to raise_error
-				expect(@project).to be_an_instance_of Roject::Project
+		# 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
+
+			# 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
 		end
 
-		after :all do
-			@project.instance_variable_set :@makers, {}
+		# 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
 		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
+
+			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
+		end
+
+		# Delete makers
+		after :all do @project.instance_variable_set :@makers, {} end
 	end
 
 	# Describe Roject::Project makers
@@ -218,5 +314,6 @@ describe Roject::Project do
 		end
 	end
 
+	# Change back to root
 	after :all do Dir.chdir "../.." end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roject
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Anshul Kharbanda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-25 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: general
@@ -70,13 +70,15 @@ description: Roject is a programming project manager written in Ruby. With Rojec
   you can create and edit projects based on templates using simple commands without
   a heavy IDE.
 email: akanshul97@gmail.com
-executables: []
+executables:
+- roject
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/roject
 - exp/project/_templates/header.general
 - exp/project/_templates/source.general
 - exp/project/foobar.rb