roject 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84a88a1601c05705728fe7e26a4e677653b70e50
-  data.tar.gz: e968d8fa6e8161b388db2e32a54ea0d3eb6f6ab5
+  metadata.gz: 474139482a42d0581c7cfbfe88814a9c40d8d947
+  data.tar.gz: 5f55210e15a6a37eb12611e6baf3cf38d8a8380d
 SHA512:
-  metadata.gz: d81ba53e80e147143fd55b1a64fb7a119f1b707633430f80ade4ea998ae2c361a4a9e867c299ae4a571e157eb7334f6c27e8f54e3fb36894bd85a886272d3a1c
-  data.tar.gz: ffe33a6c6842189bc2c694530542165e3aa42417517f19a0528ceee925df218a1e789961d38ebc3d7911196706ffc7d3059479f81a024e8efbd0466022781b2a
+  metadata.gz: e17d269ae387d6db4d9ffef73f9bc6763b5fefc08477af90c1f3a9f240c4815e51fcb879bf6a1384880d9777b3fbfc99524b5741537d4f24db2026bc0ef9c3c6
+  data.tar.gz: fb3c33d37ae4b9a6a8c57185b68ff3dd148e55e0dd847be01b4430ba18334a30faf738af08ae7772ba363c7782f8cf15eeb611e76fec72aaca7f2aacd6404ac3

data/Rakefile

@@ -85,11 +85,6 @@ namespace :git do
 		sh "git commit -m #{args[:message].inspect}"
 	end
 
-	desc "Pull from repo"
-	task :pull do
-		sh "git pull origin master"
-	end
-
 	desc "Soft git reset"
 	task :reset do
 		sh "git reset"

data/exp/loadsaveable/foo.json

@@ -0,0 +1,3 @@
+{
+	"name": "project"
+}

data/exp/loadsaveable/foo.yaml

@@ -0,0 +1,2 @@
+---
+name: project

data/lib/loadsaveable.rb

@@ -26,6 +26,8 @@ module Roject
 	#
 	# Note: Implementing objects need to respond to the :hash method
 	# 		which returns a hash of the data that needs to be saved
+	# 		and a private config method which sets the data to the 
+	# 		given hash (for unit testing)
 	#
 	# Author:  Anshul Kharbanda
 	# Created: 7 - 10 - 2016

data/lib/parsers.rb

@@ -12,6 +12,7 @@ Created: 7 - 8 - 2016
 =end
 
 require "json"
+require "yaml"
 
 # Roject is a programming project manager written in Ruby.
 #
@@ -62,14 +63,54 @@ module Roject
 			# Parameter: text - the json text to parse
 			#
 			# Return: the hash parsed from the text
-			def self.parse(text); JSON.parse(text, symbolize_names: true); end
+			def self.parse(text); JSON.parse text, symbolize_names: true; end
 
 			# Returns the given hash formatted to pretty json
 			#
 			# Parameter: hash - the hash to format
 			#
 			# Return: the given hash formatted to pretty json
-			def self.format(hash); JSON.pretty_generate(hash, indent: "\t"); end
+			def self.format(hash); JSON.pretty_generate hash, indent: "\t"; end
+		end
+
+		# Parses YAML files
+		#
+		# Author:  Anshul Kharbanda
+		# Created: 7 - 13 - 2016
+		class YAMLParser < Parser
+			# Parses the given yaml text into a hash
+			#
+			# Parameter: text - the yaml text to parse
+			#
+			# Return: the hash parsed from the text
+			def self.parse(text); symbolized YAML.load text; end
+
+			# Returns the given hash formatted to yaml
+			#
+			# Parameter: hash - the hash to format
+			#
+			# Return: the given hash formatted to yaml
+			def self.format(hash); YAML.dump stringified hash end
+
+			private
+
+			# Returns the hash with all of the keys converted to symbols
+			#
+			# Parameter: hash - the hash to symbolize
+			#
+			# Return: the hash with all of the keys converted to symbols
+			def self.symbolized hash
+				hash.each_pair.collect { |k, v| [k.to_sym, v.is_a?(Hash) ? symbolized(v) : v] }.to_h
+			end
+
+			# Returns the hash with all of the keys converted to strings
+			#
+			# Parameter: hash - the hash to stringify
+			#
+			# Return: the hash with all of the keys converted to strings
+			def self.stringified hash
+				hash.each_pair.collect { |k, v| [k.to_s,   v.is_a?(Hash) ? stringified(v) : v] }.to_h
+			end
 		end
 
 		#-----------------------------------------GET------------------------------------------
@@ -82,6 +123,7 @@ module Roject
 		def self.get(filename)
 			case File.extname(filename)
 			when ".json" then return JSONParser
+			when ".yaml" then return YAMLParser
 				
 			# Raise error if extension is not supported
 			else raise LoadError, "#{File.extname(filename)} not supported!" 

data/lib/roject.rb

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

data/spec/parsers_spec.rb

@@ -67,7 +67,51 @@ describe Roject::Parsers do
 		#
 		# Return: the given hash formatted to pretty json
 		describe '::format' do
-			it 'formats the given hash into pretty JSON' do
+			it 'formats the given hash into pretty json' do
+				expect(@parser.format(@hash)).to eql @text
+			end
+		end
+	end
+
+	# Describing Roject::Parsers::YAMLParser
+	#
+	# Parses JSON files
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 11 - 2016
+	describe '::YAMLParser' do
+
+		#----------------------------------BEFORE-----------------------------------
+
+		before :all do 
+			@text = YAML.dump(stringified(@hash))
+			@parser = Roject::Parsers::YAMLParser
+		end
+
+		#----------------------------------METHODS----------------------------------
+
+		# Describing Roject::Parsers::YAMLParser::parse
+		#
+		# Parses the given yaml text into a hash
+		#
+		# Parameter: text - the yaml text to parse
+		#
+		# Return: the hash parsed from the text
+		describe '::parse' do
+			it 'parses the given YAML text into a ruby hash' do
+				expect(@parser.parse(@text)).to eql @hash
+			end
+		end
+
+		# Describing Roject::Parsers::YAMLParser::format
+		#
+		# Returns the object hash formatted to yaml
+		#
+		# Parameter: hash - the hash to format
+		#
+		# Return: the given hash formatted to yaml
+		describe '::format' do
+			it 'formats the given hash into yaml' do
 				expect(@parser.format(@hash)).to eql @text
 			end
 		end
@@ -78,6 +122,7 @@ describe Roject::Parsers do
 	describe '::get' do
 		it 'returns the appropriate parser according to the extension of the given filename' do
 			expect(Roject::Parsers.get("foo.json")).to eql Roject::Parsers::JSONParser
+			expect(Roject::Parsers.get("foo.yaml")).to eql Roject::Parsers::YAMLParser
 		end
 	end
 end

data/spec/shared/loadsaveable_spec.rb

@@ -27,11 +27,12 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 	#---------------------------------------BEFORE----------------------------------------
 
 	before :all do
-		@dir = "exp"
-		@default_hash = { project_name: "project" }
-		@modded_hash = { project_name: "superproject", author: "Anshul Kharbanda" }
-		@pjson_name = "#{@dir}/project.json"
-		@phony_name = "#{@dir}/project.foo"
+		@dir = "exp/loadsaveable"
+		@default_hash = { name: "project" }
+		@modded_hash = { name: "superproject", author: "Anshul Kharbanda" }
+		@pjson_name = "#{@dir}/foo.json"
+		@pyaml_name = "#{@dir}/foo.yaml"
+		@phony_name = "#{@dir}/foo.bar"
 	end
 
 	#--------------------------------------METHODS-----------------------------------------
@@ -80,6 +81,14 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 			end
 		end
 
+		context "with a .yaml filename given" do
+			it "returns a new #{loadsaveable_class.name} from the yaml file with the given filename" do
+				project = loadsaveable_class.load(@pyaml_name)
+				expect(project).to be_an_instance_of loadsaveable_class
+				expect(project.hash).to eql read_yaml(@pyaml_name)
+			end
+		end
+
 		#-----------------------------UNSUPPORTED-----------------------------
 
 		context "with an unsupported file extension given" do
@@ -113,6 +122,13 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 			end
 		end
 
+		context "with a .yaml filename given" do
+			it "saves the project to the given filename in yaml format" do
+				@project.save @pyaml_name
+				expect(read_yaml(@pyaml_name)).to eql @modded_hash
+			end
+		end
+
 		#-----------------------------UNSUPPORTED-----------------------------
 
 		context "with an unsupported file extension given" do
@@ -125,6 +141,7 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 
 		after :all do 
 			write_json @pjson_name, @default_hash
+			write_yaml @pyaml_name, @default_hash
 		end
 	end
 
@@ -169,7 +186,37 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 
 				it "saves the #{loadsaveable_class.name} when the block ends" do
 					# Check if the modded project was saved
-					expect(JSON.parse(IO.read(@pjson_name), symbolize_names: true)).to eql @modded_hash
+					expect(read_json(@pjson_name)).to eql @modded_hash
+				end
+			end
+
+			context "when file is .yaml" do
+				# Declare project local variable
+				project = nil
+
+				it "loads a #{loadsaveable_class.name} from the yaml file with the given filename (calling #load)" do
+					# Declare modded_hash local variable
+					mhash = @modded_hash
+
+					# Open project in a block
+					expect { loadsaveable_class.open @pyaml_name do
+						# Set project to instance
+						project = self
+
+						# Modify project
+						config mhash
+					end }.not_to raise_error
+				end
+
+				it "evaluates the given block in the context of the loaded #{loadsaveable_class.name}" do
+					# Check if project was actually self, and it was successfuly modified
+					expect(project).to be_an_instance_of loadsaveable_class
+					expect(project.hash).to eql @modded_hash
+				end
+
+				it "saves the #{loadsaveable_class.name} when the block ends" do
+					# Check if the modded project was saved
+					expect(read_yaml(@pyaml_name)).to eql @modded_hash
 				end
 			end
 
@@ -181,8 +228,9 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 				end
 			end
 
-			after :all do
+			after :all do 
 				write_json @pjson_name, @default_hash
+				write_yaml @pyaml_name, @default_hash
 			end
 		end
 
@@ -197,6 +245,14 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 				end
 			end
 
+			context "when file is .yaml" do
+				it "loads a #{loadsaveable_class.name} from the yaml file with the given filename (calling #load) and returns it." do
+					project = loadsaveable_class.open @pyaml_name
+					expect(project).to be_an_instance_of loadsaveable_class
+					expect(project.hash).to eql @default_hash
+				end
+			end
+
 			#-----------------------------UNSUPPORTED-----------------------------
 
 			context "when filetype is unsupported" do

data/spec/spec_require.rb

@@ -13,6 +13,7 @@ Created: 7 - 8 - 2016
 
 # Required libraries
 require "json"
+require "yaml"
 
 # Required files for spec
 require_relative "../lib/parsers"
@@ -21,6 +22,26 @@ require_relative "../lib/project"
 # Spec shared examples
 require_relative "shared/loadsaveable_spec"
 
+#-----------------------HASHMOD METHODS------------------------
+
+# Returns the hash with all of the keys converted to symbols
+#
+# Parameter: hash - the hash to symbolize
+#
+# Return: the hash with all of the keys converted to symbols
+def symbolized hash
+	hash.each_pair.collect { |k, v| [k.to_sym, v.is_a?(Hash) ? symbolized(v) : v] }.to_h
+end
+
+# Returns the hash with all of the keys converted to strings
+#
+# Parameter: hash - the hash to stringify
+#
+# Return: the hash with all of the keys converted to strings
+def stringified hash
+	hash.each_pair.collect { |k, v| [k.to_s,   v.is_a?(Hash) ? stringified(v) : v] }.to_h
+end
+
 #------------------------READER METHODS------------------------
 
 # Reads JSON from the file with the given filename
@@ -32,6 +53,15 @@ def read_json filename
 	JSON.parse IO.read(filename), symbolize_names: true
 end
 
+# Reads YAML from the file with the given filename
+#
+# Parameter: filename - the name of the file to read
+# 
+# Return: hash parsed from YAML file
+def read_yaml filename
+	symbolized YAML.load IO.read(filename)
+end
+
 #------------------------WRITER METHODS------------------------
 
 # Writes the given hash as JSON to the file with the 
@@ -41,4 +71,13 @@ end
 # Parameter: hash     - the hash to write
 def write_json filename, hash
 	IO.write filename, JSON.pretty_generate(hash, indent: "\t") 
+end
+
+# Writes the given hash as YAML to the file with the 
+# given filename
+#
+# Parameter: filename - the name of the file to write to
+# Parameter: hash     - the hash to write
+def write_yaml filename, hash
+	IO.write filename, YAML.dump(stringified(hash))
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roject
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Anshul Kharbanda
@@ -77,8 +77,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- exp/project.foo
-- exp/project.json
+- exp/loadsaveable/foo.bar
+- exp/loadsaveable/foo.json
+- exp/loadsaveable/foo.yaml
 - lib/loadsaveable.rb
 - lib/parsers.rb
 - lib/project.rb

data/exp/project.json

@@ -1,3 +0,0 @@
-{
-	"project_name": "project"
-}