ast-tdl 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f857804cef121dd1c5f2a8e41ab0d27098517e03ee15c8316bc0e62d7707093
-  data.tar.gz: 2235c16bf905edf99c00693477e5b9c0f037b084c39ca541bec49f00031f9cdb
+  metadata.gz: 1ebd58255ecf60ba24423a07251499fb473c2751363795b9058a99a015a5efae
+  data.tar.gz: f157c466e4feb81fa9ff3f50d65087f236c73083e854ed579f8a616888fa4c0b
 SHA512:
-  metadata.gz: 62436ef8167db994e207f1309c7a41a9b022ceae7ca85f82f57b9f630134965859ceb845953b99c5858a3a16613961ba04507451252a27597da9702e86458655
-  data.tar.gz: 10e94fd67a4301721b0b600b4786fe73d5527493a3c192d85e1f7d8c290fe376a79f4e3ebab62f63eba8748b7af025fbf59cd1d4203b608634e5f0ae31f644b5
+  metadata.gz: '08a3b71fd3c412338bb93d6c9aef954bd7a357e8e6dc190560b977ad7b7a0f9b4f4252ced3c5aedaf152ae3853023efc85b4663a2d60aaee24e264eab14ef6fa'
+  data.tar.gz: 6a4a15557718d2abf418b9076f8075344d16308a2478e56a0c90deed727896ade8b539f69a1de270e77e3b0f8a75fb57433860747a5064d901e4479d4a53b341

data/lib/ast-tdl.rb

@@ -1 +1 @@
-require 'ast'
+require_relative "./ast"

data/lib/ast.rb

@@ -1,49 +1,82 @@
-require 'json'
+require "json"
 
-require_relative 'classes'
-require_relative 'interval'
-require_relative 'session'
+require_relative "classes"
+require_relative "interval"
+require_relative "session"
 
 
+##
+# This module is intended to be used for building trainings
+# from the domain specific language AST-TDL.
 module Ast
+	##
+	# Building a new training from the domain specific language.
+	# Params:
+	# +name+:: the name of the training
+	# +block+:: training data 
 	def self.build(name, &block)
 		training = Training.new(name)
 		training.instance_eval(&block)
 		return training
 	end
 
+
+	##
+	# This class represents a training with a name, sessions and intervals.
 	class Training
+		##
+		# Initialization method for the +Training+ class.
+		# Params:
+		# +name+:: the name of the training
 		def initialize(name)
 			@name = name
 			@session = []
             @interval = []
 		end
 
+		##
+		# Building a new session from the domain specific language.
+		# Params:
+		# +name+:: the name of the session
+		# +block+:: session data 
 		def session(name, &block)
 			training_type = Session.new(name)
 			training_type.instance_eval(&block)
 			@session << training_type
 		end
 
+		##
+		# Building a new interval from the domain specific language.
+		# Params:
+		# +name+:: the name of the interval
+		# +block+:: interval data 
 		def interval(name, &block)
 			interval_data = Interval.new(name)
 			interval_data.instance_eval(&block)
 			@interval << interval_data
 		end
 
+		##
+		# Converting a training to a string.
 		def to_s
 			str = "#{@name} #{@session[0]}"
 		end
 
+		##
+		# Converting a training to a JSON-ized string.
 		def json
 			training_json = {
 				name:      @name,
-				session:   @session.collect  { |x| x.to_hash },
-				interval:  @interval.collect { |x| x.to_hash },
+				session:   @session.collect  { |s| s.to_hash },
+				interval:  @interval.collect { |i| i.to_hash },
 			}
 			training_json.to_json
 		end
 
+		##
+		# Saving a training to a JSON file.
+		# Params:
+		# +filename+:: the desired name of the file
 		def save_to_file(filename)
 			f = File.open(filename, "w")
 			f.puts(json)

data/lib/classes.rb

@@ -1,13 +1,22 @@
-require 'json'
+require "json"
 
 
+##
+# This class represents a sport with a type.
 class Sport
+	# The type of a sport.
 	attr_reader :type
 
+	##
+	# Initialization method for the +Sport+ class.
+	# Params:
+	# +type+:: the type of the sport
 	def initialize(type)
 		@type = type
 	end
 
+	##
+	# Converting +Sport+ class to a hash.
 	def to_hash
 		sport_json = {
 			type: @type
@@ -15,13 +24,23 @@ class Sport
 	end
 end
 
+
+##
+# This class represents information with a message.
 class Info
+	# The info message.
 	attr_reader :message
 
+	##
+	# Initialization method for the +Info+ class.
+	# Params:
+	# +message+:: the info message
 	def initialize(message)
 		@message = message
 	end
 
+	##
+	# Converting +Info+ class to a hash.
 	def to_hash
 		info_json = {
 			message: @message
@@ -29,13 +48,28 @@ class Info
 	end
 end
 
-class Avhr
+
+##
+# This class represents an average heart rate.
+class AverageHeartRate
+	# An average heart rate.
 	attr_reader :heart_rate
 
+	##
+	# Initialization method for the +AverageHeartRate+ class.
+	# Params:
+	# +heart_rate+:: the average heart rate
 	def initialize(heart_rate)
+		heart_rate = heart_rate.to_s.to_i
+		if heart_rate > 220
+			raise ArgumentError.new("Maximum heart rate is 220.")
+		end
+
 		@heart_rate = heart_rate
 	end
 
+	##
+	# Converting +AverageHeartRate+ class to a hash.
 	def to_hash
 		info_json = {
 			average_hr: @heart_rate
@@ -43,13 +77,23 @@ class Avhr
 	end
 end
 
-class Td
+
+##
+# This class represents a total duration of a session or an interval.
+class TotalDuration
+	# The total duration in seconds.
 	attr_reader :duration
 
+	##
+	# Initialization method for the +TotalDuration+ class.
+	# Params:
+	# +duration+:: the total duration
 	def initialize(duration)
 		@duration = duration
     end
 
+	##
+	# Converting +TotalDuration+ class to a hash.
 	def to_hash
 		td_json = {
 			duration: @duration
@@ -57,30 +101,56 @@ class Td
 	end
 end
 
-class AvhrRest
-	attr_reader :avhr_rest
 
-	def initialize(avhr_rest)
-		@avhr_rest = avhr_rest
+##
+# This class represents an average heart rate in the resting period.
+class AverageHeartRateRest
+	# The average rest heart rate.
+	attr_reader :average_heart_rate_rest
+
+	##
+	# Initialization method for the +AverageHeartRateRest+ class.
+	# Params:
+	# +average_heart_rate_rest+:: the average heart rate
+	def initialize(average_heart_rate_rest)
+		average_heart_rate_rest = average_heart_rate_rest.to_s.to_i
+		if average_heart_rate_rest > 220
+			raise ArgumentError.new("Maximum heart rate is 220.")
+		end
+
+		@average_heart_rate_rest = average_heart_rate_rest
 	end
 
+	##
+	# Converting +AverageHeartRateRest+ class to a hash.
 	def to_hash
-		avhr_json = {
-			average_hr_rest: @avhr_rest
+		average_heart_rate_json = {
+			average_heart_rate_rest: @average_heart_rate_rest
 		}
 	end
 end
 
-class TdRest
-	attr_reader :td_rest
 
-	def initialize(td_rest)
-		@td_rest = td_rest
+##
+# This class represents a total duration of a session or an
+# interval in the resting period.
+class TotalDurationRest
+	# The total duration in seconds.
+	attr_reader :total_duration_rest
+
+	##
+	# Initialization method for the +TotalDurationRest+ class.
+	# Params:
+	# +total_duration_rest+:: the total rest duration
+	def initialize(total_duration_rest)
+		@total_duration_rest = total_duration_rest
 	end
 
+	##
+	# Converting +TotalDurationRest+ class to a hash.
 	def to_hash
-		td_json = {
-			duration_rest: @td_rest
+		total_duration_rest_json = {
+			total_duration_rest: @total_duration_rest
 		}
 	end
-end
+end

data/lib/interval.rb

@@ -1,51 +1,85 @@
+##
+# This class represents an interval.
 class Interval
+	##
+	# Initialization method for the +Interval+ class.
+	# Params:
+	# +name+:: the name of the interval
 	def initialize(name)
 		@name = []
 		@sport = []
 		@info = []
-		@avhr = []
-		@td = []
-        @avhr_rest = []
-        @td_rest = []
+		@average_heart_rate = []
+		@total_duration = []
+        @average_heart_rate_rest = []
+        @total_duration_rest = []
 	end
 
+	##
+	# Building a new Sport object.
+	# Params:
+	# +type+:: the type of the sport
 	def sport(type)
 		@sport << Sport.new(type)
 	end
 
+	##
+	# Building a new Info object.
+	# Params:
+	# +message+:: the info message
 	def info(message)
 		@info << Info.new(message)
 	end
 
-	def avhr(heart_rate)
-		@avhr << Avhr.new(heart_rate)
+	##
+	# Building a new AverageHeartRate object.
+	# Params:
+	# +heart_rate+:: the average heart rate in bpm
+	def average_heart_rate(heart_rate)
+		@average_heart_rate << AverageHeartRate.new(heart_rate)
 	end
 
-	def td(duration)
-		@td << Td.new(duration)
+	##
+	# Building a new TotalDuration object.
+	# Params:
+	# +duration+:: the duration in seconds
+	def total_duration(duration)
+		@total_duration << TotalDuration.new(duration)
 	end
     
-	def avhr_rest(heart_rate_rest)
-		@avhr_rest << AvhrRest.new(heart_rate_rest)
+	##
+	# Building a new AverageHeartRateRest object.
+	# Params:
+	# +heart_rate_rest+:: the average rest heart rate in bpm
+	def average_heart_rate_rest(heart_rate_rest)
+		@average_heart_rate_rest << AverageHeartRateRest.new(heart_rate_rest)
 	end
     
-	def td_rest(duration_rest)
-		@td_rest << TdRest.new(duration_rest)
+	##
+	# Building a new TotalDurationRest object.
+	# Params:
+	# +duration rest+:: the rest duration in seconds
+	def total_duration_rest(duration_rest)
+		@total_duration_rest << TotalDurationRest.new(duration_rest)
     end
         
+	##
+	# Converting an interval to a string.
 	def to_s
 		str = "#{@sport[0].type} #{@info[0].message}"
 	end
 
+	##
+	# Converting an interval to a JSON-ized string.
 	def to_hash
 		interval_json = {
-			name:        	  @name.collect  	  { |x| x.to_hash },
-			sport:        	  @sport.collect 	  { |x| x.to_hash },
-			info:        	  @info.collect  	  { |x| x.to_hash },
-			average_hr:  	  @avhr.collect  	  { |x| x.to_hash },
-			duration:    	  @td.collect    	  { |x| x.to_hash },
-			average_hr_rest:  @avhr_rest.collect  { |x| x.to_hash },
-			duration_rest:    @td_rest.collect    { |x| x.to_hash },
+			name:        	 		  @name.collect  	  				{ |x| x.to_hash },
+			sport:        	 		  @sport.collect 	  				{ |x| x.to_hash },
+			info:        	  		  @info.collect  	  			    { |x| x.to_hash },
+			average_heart_rate:  	  @average_heart_rate.collect  	    { |x| x.to_hash },
+			total_duration:    	  	  @total_duration.collect    	    { |x| x.to_hash },
+			average_heart_rate_rest:  @average_heart_rate_rest.collect  { |x| x.to_hash },
+			total_duration_rest: 	  @total_duration_rest.collect      { |x| x.to_hash },
 		}
 	end
 end

data/lib/session.rb

@@ -1,42 +1,65 @@
-require 'json'
-
-
+##
+# This class represents a session.
 class Session
+	##
+	# Initialization method for the +Session+ class.
+	# Params:
+	# +name+:: the name of the session
 	def initialize(name)
 		@name = []
 		@sport = []
 		@info = []
-		@avhr = []
-		@td = []
+		@average_heart_rate = []
+		@total_duration = []
 	end
 
+	##
+	# Building a new Sport object.
+	# Params:
+	# +type+:: the type of the sport
 	def sport(type)
 		@sport << Sport.new(type)
 	end
 
+	##
+	# Building a new Info object.
+	# Params:
+	# +message+:: the info message
 	def info(message)
 		@info << Info.new(message)
 	end
 
-	def avhr(heart_rate)
-		@avhr << Avhr.new(heart_rate)
+	##
+	# Building a new AverageHeartRate object.
+	# Params:
+	# +heart_rate+:: the average heart rate in bpm
+	def average_heart_rate(heart_rate)
+		@average_heart_rate << AverageHeartRate.new(heart_rate)
 	end
 
-	def td(duration)
-		@td << Td.new(duration)
+	##
+	# Building a new TotalDuration object.
+	# Params:
+	# +duration+:: the duration in seconds
+	def total_duration(duration)
+		@total_duration << TotalDuration.new(duration)
 	end
 
+	##
+	# Converting a session to a string.
 	def to_s
 		str = "#{@sport[0].type} #{@info[0].message}"
 	end
 
+	##
+	# Converting a session to a JSON-ized string.
 	def to_hash
 		session_json = {
-			name:        @name.collect  { |x| x.to_hash },
-			sport:       @sport.collect { |x| x.to_hash },
-			info:        @info.collect  { |x| x.to_hash },
-			average_hr:  @avhr.collect  { |x| x.to_hash },
-			duration:    @td.collect    { |x| x.to_hash },
+			name:        		 @name.collect			      { |x| x.to_hash },
+			sport:				 @sport.collect 			  { |x| x.to_hash },
+			info:				 @info.collect  			  { |x| x.to_hash },
+			average_heart_rate:  @average_heart_rate.collect  { |x| x.to_hash },
+			total_duration:      @total_duration.collect      { |x| x.to_hash },
 		}
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ast-tdl
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - firefly-cpp