ast-tdl 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ebd58255ecf60ba24423a07251499fb473c2751363795b9058a99a015a5efae
-  data.tar.gz: f157c466e4feb81fa9ff3f50d65087f236c73083e854ed579f8a616888fa4c0b
+  metadata.gz: acbbd1f514fbcdc7f7c30925602170f3ebe829f688dbf3e562488f9fc88ed87f
+  data.tar.gz: 554f179dec696c7d330acb1884aed681f88f1a03923bd4353eef68bd9ddb2b81
 SHA512:
-  metadata.gz: '08a3b71fd3c412338bb93d6c9aef954bd7a357e8e6dc190560b977ad7b7a0f9b4f4252ced3c5aedaf152ae3853023efc85b4663a2d60aaee24e264eab14ef6fa'
-  data.tar.gz: 6a4a15557718d2abf418b9076f8075344d16308a2478e56a0c90deed727896ade8b539f69a1de270e77e3b0f8a75fb57433860747a5064d901e4479d4a53b341
+  metadata.gz: 2ffa95b47ee68c9091883a974fc84c3c91143594948bd22459a5d462209c877ee9f00919ca1e055b925d8ff35d8f6262f9f40f6e525b4cf9c8931d9827a923ec
+  data.tar.gz: 995761ca6d201f99b4cf9f3fc061279e5332b197b83161e52fa0792a7af3f1d7f4434f4eef4e3d9e3552fdb87cdda0881dd075d9fc380c07f10339d36b462e78

data/README.md

@@ -1,33 +1,56 @@
 # Training Description Language (TDL) for Artificial Sport Trainer (AST)
-
-AST-DSL is a very small domain-specific language
-
-## Objective
+ast-dsl is intended to be a small DSL for practical definition and description of sports training that can be automatically or manually defined and used in conjunction with Artificial Sport Trainer.
 
 ## Installation
-
     $ gem install ast-tdl
 
 ## Language description
+Training Description Language (TDL) is implemented in Ruby. Currently, the description of sports training sessions and intervals is now supported. Those contain various data, such as duration, average heart rate, sport type, and many more.
 
 ## Examples
+```ruby
+EasyTraining = Ast.build :Monday do
+    session("Short swimming session today") {
+	sport               :"swim"
+	info                :"Very easy training"
+        average_heart_rate  :"130"
+        total_duration      :"30"
+    }
+
+    session("Bike ride") {
+        sport               :"bike"
+	info                :"Endurance ride with intervals"
+	average_heart_rate  :"140"
+	total_duration      :"250"
+    }
+
+    interval("Number 1") {
+	sport                   :"swim"
+	info                    :"Moderate"
+        average_heart_rate      :"160"
+        total_duration          :"5"
+        average_heart_rate_rest :"90"
+        total_duration_rest     :"2"
+    }
+end
+```
 
 ### Session
-
 ```ruby
 session("Short swimming session today") {
-	sport :"swim"
-	info  :"Very easy training"
-    avhr  :"130"
-    td    :"30"
+    sport 	        :"swim"
+    info                :"Very easy training"
+    average_heart_rate  :"130"
+    total_duration      :"30"
 }
 ```
-## License
 
+## License
 This package is distributed under the MIT License. This license can be found online at <http://www.opensource.org/licenses/MIT>.
 
 ## Disclaimer
-
 This framework is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk!
 
+## References
 
+Fister Jr, I., Fister, I., Iglesias, A., Galvez, A., Deb, S., & Fister, D. (2021). On deploying the Artificial Sport Trainer into practice. arXiv preprint [arXiv:2109.13334](https://arxiv.org/abs/2109.13334).

data/lib/ast-tdl.rb

@@ -1 +1,3 @@
-require_relative "./ast"
+# frozen_string_literal: true
+
+require_relative './ast'

data/lib/ast.rb

@@ -1,86 +1,85 @@
-require "json"
-
-require_relative "classes"
-require_relative "interval"
-require_relative "session"
+# frozen_string_literal: true
 
+require 'json'
+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
-
+  ##
+  # 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)
+    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
+  ##
+  # 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 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
+    ##
+    # 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 string.
+    def to_s
+      "#{@name} #{@session[0]}"
+    end
 
-		##
-		# Converting a training to a JSON-ized string.
-		def json
-			training_json = {
-				name:      @name,
-				session:   @session.collect  { |s| s.to_hash },
-				interval:  @interval.collect { |i| i.to_hash },
-			}
-			training_json.to_json
-		end
+    ##
+    # Converting a training to a JSON-ized string.
+    def json
+      training_json = {
+        name: @name,
+        session: @session.collect(&:to_hash),
+        interval: @interval.collect(&: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)
-			f.close
-		end
-	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)
+      f.close
+    end
+  end
 end

data/lib/classes.rb

@@ -1,156 +1,148 @@
-require "json"
+# frozen_string_literal: true
 
+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
-		}
-	end
+  # 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
+    {
+      type: @type
+    }
+  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
-		}
-	end
+  # 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
+    {
+      message: @message
+    }
+  end
 end
 
-
 ##
 # 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
-		}
-	end
+  # 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
+    raise ArgumentError, 'Maximum heart rate is 220.' if heart_rate > 220
+
+    @heart_rate = heart_rate
+  end
+
+  ##
+  # Converting +AverageHeartRate+ class to a hash.
+  def to_hash
+    {
+      average_hr: @heart_rate
+    }
+  end
 end
 
-
 ##
 # 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
-		}
-	end
+  # 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
+    {
+      duration: @duration
+    }
+  end
 end
 
-
 ##
 # 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
-		average_heart_rate_json = {
-			average_heart_rate_rest: @average_heart_rate_rest
-		}
-	end
+  # 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
+    raise ArgumentError, 'Maximum heart rate is 220.' if average_heart_rate_rest > 220
+
+    @average_heart_rate_rest = average_heart_rate_rest
+  end
+
+  ##
+  # Converting +AverageHeartRateRest+ class to a hash.
+  def to_hash
+    {
+      average_heart_rate_rest: @average_heart_rate_rest
+    }
+  end
 end
 
-
 ##
 # 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
-		total_duration_rest_json = {
-			total_duration_rest: @total_duration_rest
-		}
-	end
-end
+  # 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
+    {
+      total_duration_rest: @total_duration_rest
+    }
+  end
+end

data/lib/interval.rb

@@ -1,85 +1,87 @@
+# frozen_string_literal: true
+
 ##
 # 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 = []
-		@average_heart_rate = []
-		@total_duration = []
-        @average_heart_rate_rest = []
-        @total_duration_rest = []
-	end
+  ##
+  # Initialization method for the +Interval+ class.
+  # Params:
+  # +name+:: the name of the interval
+  def initialize(_name)
+    @name = []
+    @sport = []
+    @info = []
+    @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
+
+  ##
+  # 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
 
-	##
-	# Building a new Sport object.
-	# Params:
-	# +type+:: the type of the sport
-	def sport(type)
-		@sport << Sport.new(type)
-	end
+  ##
+  # Building a new TotalDuration object.
+  # Params:
+  # +duration+:: the duration in seconds
+  def total_duration(duration)
+    @total_duration << TotalDuration.new(duration)
+  end
 
-	##
-	# Building a new Info object.
-	# Params:
-	# +message+:: the info message
-	def info(message)
-		@info << Info.new(message)
-	end
+  ##
+  # 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
 
-	##
-	# 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
+  ##
+  # 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
 
-	##
-	# Building a new TotalDuration object.
-	# Params:
-	# +duration+:: the duration in seconds
-	def total_duration(duration)
-		@total_duration << TotalDuration.new(duration)
-	end
-    
-	##
-	# 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
-    
-	##
-	# 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 string.
+  def to_s
+    "#{@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_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
+  ##
+  # Converting an interval to a JSON-ized string.
+  def to_hash
+    {
+      name: @name.collect(&:to_hash),
+      sport: @sport.collect(&:to_hash),
+      info: @info.collect(&:to_hash),
+      average_heart_rate: @average_heart_rate.collect(&:to_hash),
+      total_duration: @total_duration.collect(&:to_hash),
+      average_heart_rate_rest: @average_heart_rate_rest.collect(&:to_hash),
+      total_duration_rest: @total_duration_rest.collect(&:to_hash),
+    }
+  end
+end

data/lib/session.rb

@@ -1,65 +1,67 @@
+# frozen_string_literal: true
+
 ##
 # 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 = []
-		@average_heart_rate = []
-		@total_duration = []
-	end
+  ##
+  # Initialization method for the +Session+ class.
+  # Params:
+  # +name+:: the name of the session
+  def initialize(_name)
+    @name = []
+    @sport = []
+    @info = []
+    @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 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
+  ##
+  # Building a new Info object.
+  # Params:
+  # +message+:: the info message
+  def info(message)
+    @info << Info.new(message)
+  end
 
-	##
-	# 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
+  ##
+  # 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
 
-	##
-	# Building a new TotalDuration object.
-	# Params:
-	# +duration+:: the duration in seconds
-	def total_duration(duration)
-		@total_duration << TotalDuration.new(duration)
-	end
+  ##
+  # 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 string.
+  def to_s
+    "#{@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_heart_rate:  @average_heart_rate.collect  { |x| x.to_hash },
-			total_duration:      @total_duration.collect      { |x| x.to_hash },
-		}
-	end
-end
+  ##
+  # Converting a session to a JSON-ized string.
+  def to_hash
+    {
+      name: @name.collect(&:to_hash),
+      sport:	@sport.collect(&:to_hash),
+      info:	@info.collect(&:to_hash),
+      average_heart_rate: @average_heart_rate.collect(&:to_hash),
+      total_duration: @total_duration.collect(&:to_hash),
+    }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ast-tdl
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - firefly-cpp
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-14 00:00:00.000000000 Z
+date: 2022-06-23 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -25,12 +25,13 @@ files:
 - lib/classes.rb
 - lib/interval.rb
 - lib/session.rb
-homepage: https://github.com/firefly-cpp/AST-DSL
-licenses: []
+homepage: https://github.com/firefly-cpp/ast-tdl
+licenses:
+- MIT
 metadata:
-  homepage_uri: https://github.com/firefly-cpp/AST-DSL
-  source_code_uri: https://github.com/firefly-cpp/AST-DSL
-  changelog_uri: https://github.com/firefly-cpp/AST-DSL
+  homepage_uri: https://github.com/firefly-cpp/ast-tdl
+  source_code_uri: https://github.com/firefly-cpp/ast-tdl
+  changelog_uri: https://github.com/firefly-cpp/ast-tdl
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -39,7 +40,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="