roject 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 474139482a42d0581c7cfbfe88814a9c40d8d947
-  data.tar.gz: 5f55210e15a6a37eb12611e6baf3cf38d8a8380d
+  metadata.gz: b97c2ef08f7a1a34af079cd290aa1add5150c73d
+  data.tar.gz: 30d00e93047cb2d05b1b85509fb9d7f56db47864
 SHA512:
-  metadata.gz: e17d269ae387d6db4d9ffef73f9bc6763b5fefc08477af90c1f3a9f240c4815e51fcb879bf6a1384880d9777b3fbfc99524b5741537d4f24db2026bc0ef9c3c6
-  data.tar.gz: fb3c33d37ae4b9a6a8c57185b68ff3dd148e55e0dd847be01b4430ba18334a30faf738af08ae7772ba363c7782f8cf15eeb611e76fec72aaca7f2aacd6404ac3
+  metadata.gz: 7706843324ed9f3939834ad416e2626ac74192d491e61b756d27f428059e8d28c9588b52d95e04d2f62a6ed4691b2365124ca9032fb331c0c611e466f0c2ac14
+  data.tar.gz: 8b6fd585b035bc4383467250c3f7040bd7dc027b26342f9283db032e8b4e25b2309552a33da284b48a8e11696fb1c2d4808f3c50c744668b4aa4eebbdf5e3684

data/Rakefile

@@ -13,6 +13,7 @@ Created: 7 - 8 - 2016
 
 # Required libraries
 require "rspec/core/rake_task"
+require "rubygems/tasks"
 
 # Requird files
 require_relative "lib/roject"
@@ -21,55 +22,19 @@ require_relative "lib/roject"
 GEMDIR  = "gem"
 SPECDIR = "spec"
 
+# Default task
+task :default => :spec
+
 #----------------------------------RSPEC----------------------------------
 
-RSpec::Core::RakeTask.new :spec do |task|
+RSpec::Core::RakeTask.new do |task|
 	task.pattern    = "#{SPECDIR}/*_spec.rb"
-	task.rspec_opts = "--format documentation", 
-					  "--color"
+	task.rspec_opts = "--format documentation --color"
 end
 
 #-----------------------------------GEM-----------------------------------
 
-namespace :gem do
-	
-	#----------------------------------GEM CLEAR TASKS----------------------------------
-
-	namespace :clear do
-		desc "Clear all gems"
-		task :all do
-			sh "rm #{GEMDIR}/*.gem"	
-		end
-
-		desc "Clear old gems"
-		task :old do
-			sh "rm #{FileList.new("#{GEMDIR}/*.gem")
-							 .exclude("#{GEMDIR}/roject-#{Roject::VERSION}.gem")}"
-		end
-	end
-
-	#----------------------------------GEM BUILD TASKS----------------------------------
-
-	desc "Build gem and push to Rubygems"
-	task :push => "#{GEMDIR}/roject-#{Roject::VERSION}.gem" do |task|
-		sh "gem push #{task.source}"
-	end
-
-	desc "Build gem and install locally"
-	task :install => "#{GEMDIR}/roject-#{Roject::VERSION}.gem" do |task|
-		sh "gem install #{task.source}"
-	end
-
-	desc "Just buid gem"
-	task :build => "#{GEMDIR}/roject-#{Roject::VERSION}.gem"
-
-	#-------------------------------BUILD GEM FROM GEMSPEC------------------------------
-
-	file "#{GEMDIR}/roject-#{Roject::VERSION}.gem" => "roject.gemspec" do |task|
-		sh "gem build #{task.source}"
-		sh "mv #{File.basename(task.name)} #{File.dirname(task.name)}"
-	end
-end
+Gem::Tasks.new
 
 #-----------------------------------GIT-----------------------------------
 
@@ -94,7 +59,4 @@ namespace :git do
 	task :reset_hard do
 		sh "git reset --hard HEAD"
 	end
-end
-
-# Default spec
-task :default => "spec"
+end

data/exp/loadsaveable/foo.yml

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

data/lib/loadsaveable.rb

@@ -22,12 +22,11 @@ module Roject
 	# Implementing objects can be loaded from and saved to files in
 	# any of the supported data storage formats.
 	#
-	# Formats: json
+	# Formats: json, yaml
 	#
-	# 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)
+	# Note: Implementing objects must have a constructor with takes a single hash 
+	# 		argument and respond to the :hash method which returns a hash of the 
+	# 		data that needs to be saved 
 	#
 	# Author:  Anshul Kharbanda
 	# Created: 7 - 10 - 2016

data/lib/parsers.rb

@@ -11,6 +11,7 @@ Created: 7 - 8 - 2016
 
 =end
 
+# Parser libraries
 require "json"
 require "yaml"
 
@@ -26,9 +27,10 @@ module Roject
 	module Parsers
 		# Generic class parses files of a given type
 		#
-		# Subclasses must respond to :parse and :generate methods
+		# Subclasses must respond to :parse, :format, and :extension methods
 		# 	- parse recieves a string and returns a hash
-		# 	- generate recieves a hash and returns a string
+		# 	- format recieves a hash and returns a string
+		# 	- extensions returns all of the supported extensions of the Parser
 		#
 		# Author:  Anshul Kharbanda
 		# Created: 7 - 11 - 2016
@@ -39,15 +41,32 @@ module Roject
 			# Returns the descendants of Parser
 			#
 			# Return: the descendants of Parser
-			def self.descendents
+			def self.descendants
 				ObjectSpace.each_object(Class).select {|c| c < self}
 			end
 
-			# Returns the extension name of the parser filetype
+			# Returns true if the parser is to be used for the given filename
 			#
-			# Return: the extension name of the parser filetype
-			def self.extension
-				"." + PARSER_REGEX.match(self.name)[:name].downcase
+			# Return: true if the parser is to be used for the given filename
+			def self.for_filename? filename
+				extensions.include? File.extname(filename)
+			end
+		end
+
+		# Returns the parser for the given filename
+		#
+		# Parameter: filename - the name of the file to parse
+		#
+		# Return: the parser for the given filename
+		def self.get(filename)
+			# Get parser from filename
+			parser = Parser.descendants.find { |klass| klass.for_filename? filename }
+
+			# Raise LoadError if no parser is found, else return parser
+			if parser.nil?
+				raise LoadError, "#{File.extname(filename)} not supported!"
+			else
+				return parser
 			end
 		end
 
@@ -58,6 +77,11 @@ module Roject
 		# Author:  Anshul Kharbanda
 		# Created: 7 - 11 - 2016
 		class JSONParser < Parser
+			# Returns the extensions supported for JSON
+			# 
+			# Return: the extensions supported for JSON
+			def self.extensions; [".json"]; end
+
 			# Parses the given json text into a hash
 			#
 			# Parameter: text - the json text to parse
@@ -78,6 +102,11 @@ module Roject
 		# Author:  Anshul Kharbanda
 		# Created: 7 - 13 - 2016
 		class YAMLParser < Parser
+			# Returns the extensions supported for YAML
+			# 
+			# Return: the extensions supported for YAML
+			def self.extensions; [".yaml", ".yml"]; end
+
 			# Parses the given yaml text into a hash
 			#
 			# Parameter: text - the yaml text to parse
@@ -112,22 +141,5 @@ module Roject
 				hash.each_pair.collect { |k, v| [k.to_s,   v.is_a?(Hash) ? stringified(v) : v] }.to_h
 			end
 		end
-
-		#-----------------------------------------GET------------------------------------------
-
-		# Returns the parser for the given filename
-		#
-		# Parameter: filename - the name of the file to parse
-		#
-		# Return: the parser for the given filename
-		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!" 
-			end
-		end
 	end
 end

data/lib/project.rb

@@ -34,9 +34,6 @@ module Roject
 			@project = hash
 		end
 
-		# This is a test method and is depricated by default. Do not use!
-		def config(hash); @project = hash; end
-
 		# Returns a hash of the data contained in the project
 		#
 		# Return: a hash of the data contained in 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.2.1"
+	VERSION = "0.3.0"
 end

data/spec/project_spec.rb

@@ -21,5 +21,20 @@ require_relative "spec_require"
 # Author:  Anshul Kharbanda
 # Created: 7 - 8 - 2016
 describe Roject::Project do
-	include_examples "loadsaveable", Roject::Project
+	# Describing LoadSaveable include
+	# 
+	# Implementing objects can be loaded from and saved to files in
+	# any of the supported data storage formats.
+	#
+	# Formats: json, yaml
+	#
+	# Note: Implementing objects must have a constructor with takes a single hash 
+	# 		argument and respond to the :hash method which returns a hash of the 
+	# 		data that needs to be saved 
+	#
+	# Author:  Anshul Kharbanda
+	# Created: 7 - 10 - 2016
+	describe 'include LoadSaveable' do
+		include_examples "loadsaveable", Roject::Project
+	end
 end

data/spec/shared/loadsaveable_spec.rb

@@ -32,6 +32,7 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 		@modded_hash = { name: "superproject", author: "Anshul Kharbanda" }
 		@pjson_name = "#{@dir}/foo.json"
 		@pyaml_name = "#{@dir}/foo.yaml"
+		@pyml_name = "#{@dir}/foo.yml"
 		@phony_name = "#{@dir}/foo.bar"
 	end
 
@@ -89,6 +90,14 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 			end
 		end
 
+		context "with a .yml filename given" do
+			it "returns a new #{loadsaveable_class.name} from the yml file with the given filename" do
+				project = loadsaveable_class.load(@pyml_name)
+				expect(project).to be_an_instance_of loadsaveable_class
+				expect(project.hash).to eql read_yaml(@pyml_name)
+			end
+		end
+
 		#-----------------------------UNSUPPORTED-----------------------------
 
 		context "with an unsupported file extension given" do
@@ -129,6 +138,13 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 			end
 		end
 
+		context "with a .yml filename given" do
+			it "saves the project to the given filename in yml format" do
+				@project.save @pyml_name
+				expect(read_yaml(@pyml_name)).to eql @modded_hash
+			end
+		end
+
 		#-----------------------------UNSUPPORTED-----------------------------
 
 		context "with an unsupported file extension given" do
@@ -142,6 +158,7 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 		after :all do 
 			write_json @pjson_name, @default_hash
 			write_yaml @pyaml_name, @default_hash
+			write_yaml @pyml_name,  @default_hash
 		end
 	end
 
@@ -174,7 +191,7 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 						project = self
 
 						# Modify project
-						config mhash
+						initialize mhash
 					end }.not_to raise_error
 				end
 
@@ -204,7 +221,7 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 						project = self
 
 						# Modify project
-						config mhash
+						initialize mhash
 					end }.not_to raise_error
 				end
 
@@ -220,6 +237,36 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 				end
 			end
 
+			context "when file is .yml" do
+				# Declare project local variable
+				project = nil
+
+				it "loads a #{loadsaveable_class.name} from the yml 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 @pyml_name do
+						# Set project to instance
+						project = self
+
+						# Modify project
+						initialize 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(@pyml_name)).to eql @modded_hash
+				end
+			end
+
 			#-----------------------------UNSUPPORTED-----------------------------
 
 			context "when filetype is unsupported" do
@@ -231,6 +278,7 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 			after :all do 
 				write_json @pjson_name, @default_hash
 				write_yaml @pyaml_name, @default_hash
+				write_yaml @pyml_name,  @default_hash
 			end
 		end
 
@@ -253,6 +301,14 @@ shared_examples "loadsaveable" do |loadsaveable_class|
 				end
 			end
 
+			context "when file is .yml" do
+				it "loads a #{loadsaveable_class.name} from the yml file with the given filename (calling #load) and returns it." do
+					project = loadsaveable_class.open @pyml_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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roject
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Anshul Kharbanda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-13 00:00:00.000000000 Z
+date: 2016-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: general
@@ -80,6 +80,8 @@ files:
 - exp/loadsaveable/foo.bar
 - exp/loadsaveable/foo.json
 - exp/loadsaveable/foo.yaml
+- exp/loadsaveable/foo.yml
+- exp/project/project.yaml
 - lib/loadsaveable.rb
 - lib/parsers.rb
 - lib/project.rb