RubyGems - ast-tdl - Versions diffs - 0.2.2 → 0.2.3 - Mend

ast-tdl 0.2.2 → 0.2.3

Files changed (11) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c8570f5e5872a125474d6136f9aaadf1f8b2e66e8fab322195809d138c726f9
-  data.tar.gz: 7bbb277292d148b02004394b424fa10d7edd05bb72f408932124f2934b8e1100
+  metadata.gz: c48bcca740ece68b00917b86f939a85316347e9e3e661d76aa0531b67e6aec55
+  data.tar.gz: 27f8a21215981993e870a81e1f9eecf65d9ba6adfac388fc307acb95e3089240
 SHA512:
-  metadata.gz: 8c7792b0ed3c40eb833a303ac9f7fdd791d1c810f981ef122ab4b4d53feb356ea1fc26d4cf2e41d22bb93c74c23e63ec84608f5da14d20d1d94591f3036cf90a
-  data.tar.gz: 1611041a04c44bdf8d7d01ff1ec98ab2c84d737586454211841a5a5794ba21e76bb3efec554195654a5ba1f5bee524602bcb279057b20cc1d8dcc99c27f29d14
+  metadata.gz: 7b816baa2b094710c6b58281ce2ca0ab24214ccabd59b8ed75332ad9487b9ea6451b27d83c75e5a85bfc521dbdd35c5044e44f1c9d932334dd4a6b80bc86baac
+  data.tar.gz: 283ed4403d1f6e6d2961e68850763785bc5119a665d013db1867b1d115fa52f1e84cc2222e352df0c00d2f1e5308a0d8b6b804f04e0e96f3e1540ade5077cfbb

data/LICENSE CHANGED Viewed

@@ -1,21 +1,21 @@
-MIT License
-Copyright (c) 2022 Iztok Fister Jr.
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+Copyright (c) 2022-2024 Iztok Fister Jr.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md CHANGED Viewed

@@ -1,91 +1,124 @@
-# Training Description Language (TDL) for Artificial Sport Trainer (AST)
----
-[![DOI](https://img.shields.io/badge/DOI-10.1109/ISCMI53840.2021.9654817-blue)](https://doi.org/10.1109/ISCMI53840.2021.9654817)
-## Motivation
-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.
-According to sports theory, three major types of sports trainings exist:
-- speed trainings,
-- interval trainings and
-- power trainings.
-Speed trainings are intended for supplying an athlete with energy, coordination and power adaptation. This type of sports training is often used by middle-distance athletes, as they can be very useful for enhancing their performance.
-Interval training has been described for the first time by Reindell and Roskamm, however, it was popularized by the famous Chech athlete Emil Zatopek. This type of training consists of a speed phase that is followed by a recovery phase. This sequence is repeated for several times where the number of repetitions depends on interval training plan.
-Power trainings have been proven to be an effective method for increasing muscle mass. Consequently, in most cases they are used at extreme sports, such as weight lifting, where the lactate amount in blood is significant.
-## Feature diagram
-![ast-tdl](https://user-images.githubusercontent.com/73126820/193033601-6c94b328-30a4-4b25-86a3-0fb81cebca3d.png)
-## Installation
-```sh
-$ gem install ast-tdl
-```
-## Language description
-Training Description Language (TDL) is implemented in Ruby. All three major training types (speed, interval and power) can be described in TDL.
-Speed training sessions are described with their name, sport type, proposed average heart rate and total duration, while the additional information is optional.
-Interval training sessions, as well as their speed counterparts, are described with their name, type of sport and optional information. However, heart rate and duration of intervals are described separately for both speed and recovery phase. Additionally, number of repetitions and interval training type are also described along with forementioned features.
-Power training sessions are described with their names and sport types, but opposed to speed and interval they are described with series, which are furtherly described with their name, intensity level from 1 to 10 and number of repetitions.
-## Examples
-### Example of a sports training
-```ruby
-Ast.build do
-  speed('Swimming with the dolphins') do
-    sport                   Sport::SWIMMING
-    info                    :"Very easy training"
-    average_heart_rate      :"130"
-    total_duration          :"30"
-  end
-  speed('Cross the country') do
-    sport                   Sport::CYCLING
-    info                    :"Endurance ride"
-    average_heart_rate      :"140"
-    total_duration          :"120"
-  end
-  interval('Following Emil Zatopek') do
-    sport                   Sport::RUNNING
-    info                    :Hard
-    speed_duration          :"1"
-    recovery_duration       :"1"
-    speed_heart_rate        :"180"
-    recovery_heart_rate     :"90"
-    repetitions             :"10"
-    type                    :fixed
-  end
-  power('As strong as an ox') do
-    sport                   Sport::WEIGHT_LIFTING
-    series('Little ox') do
-      intensity:   :"5"
-      repetitions  :"20"
-    end
-    series('Big ox') do
-      intensity    :"10"
-      repetitions  :"80"
-    end
-  end
-end
-```
-The description of the sports training consists of four sessions: two speed sessions, one interval sesssion and one power session. The first, swimming speed session is relatively easy, as the planned heart rate throughout the whole session is prescribed to be 130 bpm, and it lasts for half an hour. The next, cycling speed session is described as a 2-hour endurance ride with the prescribed average heart rate of 140 bpm. The third session is a hard, running interval training. It consists of 10 fixed intervals, where speed phase and recovery duration are 1 minute each. The proposed heart rate during speed phases is set at 180 bpm, while in recovery phases it is set to half the speed heart rate: 90 bpm. The final, weight lifting power session consists of two series, the first being of middle intensity with 20 repetitions and the second being of extreme intensity with 80 repetitions.
-## 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).
-Lukač, L. (2022). Aplikacija koncepta digitalnega dvojčka v športu [online]. University of Maribor, Faculty of Electrical Engineering and Computer Science. [Access: 29th September, 2022].
+<h1 align="center">
+  Training Description Language (TDL) for Artificial Sport Trainer (AST)
+</h1>
+<p align="center">
+  <img alt="Gem package" src="https://img.shields.io/gem/v/ast-tdl?color=blue" href="https://rubygems.org/gems/ast-tdl">
+  <img alt="AUR package" src="https://img.shields.io/aur/version/ruby-ast-tdl?color=blue&label=Arch%20Linux&logo=arch-linux" href="https://aur.archlinux.org/packages/ruby-ast-tdl">
+</p>
+<p align="center">
+  <img alt="DOI" src="https://img.shields.io/badge/DOI-10.3390/app122412741-blue" href="https://doi.org/10.3390/app122412741">
+</p>
+<p align="center">
+  <a href="#-motivation">💡 Motivation</a> •
+  <a href="#-feature-diagram">✨ Feature diagram</a> •
+  <a href="#-installation">📦 Installation</a> •
+  <a href="#️-language-description">🗣️ Language description</a> •
+  <a href="#-examples">🚀 Examples</a> •
+  <a href="#-license">🔑 License</a> •
+  <a href="#-references">📝 References</a>
+</p>
+## 💡 Motivation
+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.
+According to sports theory, three major types of sports training exist:
+- speed training ⚡
+- interval training ⏱️
+- power training 💪
+Speed training is intended to supply an athlete with energy, coordination and power adaptation. This type of sports training is often used by middle-distance athletes, as it can enhance their performance.
+Interval training was first described by Reindell and Roskamm, however, it was popularized by the famous Chech athlete Emil Zatopek. This type of training consists of a speed phase followed by a recovery phase. This sequence is repeated several times, and the number of repetitions depends on the interval training plan.
+Power training has been proven to be an effective method for increasing muscle mass. Consequently, in most cases, they are used in extreme sports, such as weight lifting, where the lactate amount in blood is significant.
+## ✨ Feature diagram
+![ast-tdl](https://user-images.githubusercontent.com/73126820/193033601-6c94b328-30a4-4b25-86a3-0fb81cebca3d.png)
+## 📦 Installation
+To install `ast-dsl` with gem, use:
+```sh
+$ gem install ast-tdl
+```
+To install `ast-tdl` on Alpine, use:
+```sh
+$ apk add ruby-ast-tdl
+```
+To install `ast-dsl` on Arch Linux, use an [AUR helper](https://wiki.archlinux.org/title/AUR_helpers):
+```sh
+$ yay -Syyu ruby-ast-tdl
+```
+## 🗣️ Language description
+Training Description Language (TDL) is implemented in Ruby. All three major training types (speed, interval and power) can be described in TDL.
+Speed training sessions are described with their name, sport type, proposed average heart rate and total duration, while additional information is optional.
+Interval training sessions and their speed counterparts are described with their name, type of sport and optional information. However, heart rate and duration of intervals are described separately for both the speed and recovery phases. Additionally, the number of repetitions and interval training types are also described along with the features mentioned earlier.
+Power training sessions are described with their names and sports types. However, as opposed to speed and interval they are described with series, which are further described with their name, intensity level from 1 to 10 and number of repetitions.
+## 🚀 Examples
+### Example of a sports training
+```ruby
+Ast.build do
+  speed('Swimming with the dolphins') do
+    sport                   Sport::SWIMMING
+    info                    :"Very easy training"
+    average_heart_rate      :"130"
+    total_duration          :"30"
+  end
+  speed('Cross the country') do
+    sport                   Sport::CYCLING
+    info                    :"Endurance ride"
+    average_heart_rate      :"140"
+    total_duration          :"120"
+  end
+  interval('Following Emil Zatopek') do
+    sport                   Sport::RUNNING
+    info                    :Hard
+    speed_duration          :"1"
+    recovery_duration       :"1"
+    speed_heart_rate        :"180"
+    recovery_heart_rate     :"90"
+    repetitions             :"10"
+    type                    :fixed
+  end
+  power('As strong as an ox') do
+    sport                   Sport::WEIGHT_LIFTING
+    series('Little ox') do
+      intensity:   :"5"
+      repetitions  :"20"
+    end
+    series('Big ox') do
+      intensity    :"10"
+      repetitions  :"80"
+    end
+  end
+end
+```
+The description of the sports training consists of four sessions: two speed sessions, one interval session and one power session. The first (swimming speed) session is relatively easy, as the planned heart rate during the 30-minute session is prescribed to be 130 BPM. The second (cycling speed) session is described as a 2-hour endurance ride with the prescribed average heart rate of 140 BPM. The third session is a hard, running interval training. It consists of 10 fixed intervals, where the speed phase and recovery duration are 1 minute each. The proposed heart rate during speed phases is set at 180 BPM, while it is set to half the heart rate (90 BPM) in recovery phases. The final (weight-lifting) power session consists of two series: the first is moderate intensity with 20 repetitions, and the second is high intensity with 80 repetitions.
+## 🔑 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
+Lukač, L., Fister Jr., I., Fister, I. "[Digital Twin in Sport: From an Idea to Realization](https://www.mdpi.com/2076-3417/12/24/12741)." Applied Sciences 12.24 (2022): 12741.
+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).
+Lukač, L. (2022). [Aplikacija koncepta digitalnega dvojčka v športu](https://dk.um.si/IzpisGradiva.php?id=82612). University of Maribor, Faculty of Electrical Engineering and Computer Science. [Access: 29th September, 2022].

data/lib/ast-tdl.rb CHANGED Viewed

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

data/lib/ast.rb CHANGED Viewed

@@ -1,103 +1,103 @@
-# frozen_string_literal: true
-require 'json'
-require_relative 'interval'
-require_relative 'power'
-require_relative 'speed'
-require_relative 'sport'
-##
-# 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:
-  # +block+:: training data
-  def self.build(&block)
-    training = Training.new()
-    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
-      @speed = []
-      @interval = []
-      @power = []
-    end
-    ##
-    # Building a new speed session from the domain specific language.
-    # Params:
-    # +name+:: the name of the speed session
-    # +block+:: speed session data
-    def speed(name, &block)
-      training_type = Speed.new(name)
-      training_type.instance_eval(&block)
-      @speed << 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 power session from the domain specific language.
-    # Params:
-    # +name+:: the name of the power session
-    # +block+:: power session data
-    def power(name, &block)
-      power_data = Power.new(name)
-      power_data.instance_eval(&block)
-      @power << power_data
-    end
-    ##
-    # Converting a training to a string.
-    def to_s
-      speed_number = @speed.length
-      interval_number = @interval.length
-      power_number = @power.length
-      "TRAINING DATA:\n"\
-      "Speed sessions: #{speed_number}\n"\
-      "Interval sessions: #{interval_number}\n"\
-      "Power sessions: #{power_number}\n\n"
-    end
-    ##
-    # Converting a training to a JSON-ized string.
-    def json
-      training_json = {
-        speed: @speed.collect(&:to_hash),
-        interval: @interval.collect(&:to_hash),
-        power: @power.collect(&:to_hash)
-      }
-      JSON.pretty_generate(training_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("../trainings/#{filename}", 'w')
-      f.puts(json)
-      f.close
-    end
-  end
-end
+# frozen_string_literal: true
+require 'json'
+require_relative 'interval'
+require_relative 'power'
+require_relative 'speed'
+require_relative 'sport'
+##
+# 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:
+  # +block+:: training data
+  def self.build(&block)
+    training = Training.new()
+    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
+      @speed = []
+      @interval = []
+      @power = []
+    end
+    ##
+    # Building a new speed session from the domain specific language.
+    # Params:
+    # +name+:: the name of the speed session
+    # +block+:: speed session data
+    def speed(name, &block)
+      training_type = Speed.new(name)
+      training_type.instance_eval(&block)
+      @speed << 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 power session from the domain specific language.
+    # Params:
+    # +name+:: the name of the power session
+    # +block+:: power session data
+    def power(name, &block)
+      power_data = Power.new(name)
+      power_data.instance_eval(&block)
+      @power << power_data
+    end
+    ##
+    # Converting a training to a string.
+    def to_s
+      speed_number = @speed.length
+      interval_number = @interval.length
+      power_number = @power.length
+      "TRAINING DATA:\n"\
+      "Speed sessions: #{speed_number}\n"\
+      "Interval sessions: #{interval_number}\n"\
+      "Power sessions: #{power_number}\n\n"
+    end
+    ##
+    # Converting a training to a JSON-ized string.
+    def json
+      training_json = {
+        speed: @speed.collect(&:to_hash),
+        interval: @interval.collect(&:to_hash),
+        power: @power.collect(&:to_hash)
+      }
+      JSON.pretty_generate(training_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("../trainings/#{filename}", 'w')
+      f.puts(json)
+      f.close
+    end
+  end
+end

data/lib/interval.rb CHANGED Viewed

@@ -1,139 +1,139 @@
-# frozen_string_literal: true
-require_relative 'sport'
-##
-# This class represents an interval.
-class Interval
-  ##
-  # Initialization method for the +Interval+ class.
-  # Params:
-  # +name+:: the name of the interval
-  def initialize(name)
-    @name = name
-    @sport = ''
-    @info = ''
-    @speed_duration = 0
-    @recovery_duration = 0
-    @speed_heart_rate = 0
-    @recovery_heart_rate = 0
-    @repetitions = 0
-    @type = ''
-  end
-  ##
-  # Adding a sport to the object.
-  # Params:
-  # +type+:: the type of the sport
-  def sport(type)
-    raise 'The sport name has to be from the Sport class collection.' unless Sport.values.include? type
-    @sport = type
-  end
-  ##
-  # Adding an info message to the object.
-  # Params:
-  # +message+:: the info message
-  def info(message)
-    @info = message
-  end
-  ##
-  # Adding a speed duration of an interval to the object.
-  # Params:
-  # +speed_duration+:: the duration of the speed segment in minutes
-  def speed_duration(speed_duration)
-    speed_duration_str = speed_duration.to_s
-    speed_duration_int = speed_duration.to_s.to_i
-    raise 'The given speed duration is not an integer.' if speed_duration_str != speed_duration_str.to_i.to_s
-    raise 'The speed duration has to be 1 minute at least.' if speed_duration_int < 1
-    @speed_duration = speed_duration_int
-  end
-  ##
-  # Adding a recovery duration of an interval to the object.
-  # Params:
-  # +recovery_duration+:: the duration of the recovery segment in minutes
-  def recovery_duration(recovery_duration)
-    recovery_duration_str = recovery_duration.to_s
-    recovery_duration_int = recovery_duration.to_s.to_i
-    raise 'The given recovery duration is not an integer.' if recovery_duration_str != recovery_duration_str.to_i.to_s
-    raise 'The recovery duration has to be 1 minute at least.' if recovery_duration_int < 1
-    @recovery_duration = recovery_duration_int
-  end
-  ##
-  # Adding a speed heart rate of an interval to the object.
-  # Params:
-  # +speed_heart_rate+:: the average speed heart rate in bpm
-  def speed_heart_rate(speed_heart_rate)
-    speed_hr_str = speed_heart_rate.to_s
-    speed_hr_int = speed_heart_rate.to_s.to_i
-    raise 'The given average heart rate is not an integer.' if speed_hr_str != speed_hr_str.to_i.to_s
-    raise 'The speed heart rate should be between 60 and 205 bpm.' if speed_hr_int < 60 || speed_hr_int > 205
-    @speed_heart_rate = speed_hr_int
-  end
-  ##
-  # Adding a recovery heart rate of an interval to the object.
-  # Params:
-  # +recovery_heart_rate+:: the average speed heart rate in bpm
-  def recovery_heart_rate(recovery_heart_rate)
-    recovery_hr_str = recovery_heart_rate.to_s
-    recovery_hr_int = recovery_heart_rate.to_s.to_i
-    raise 'The given average heart rate is not an integer.' if recovery_hr_str != recovery_hr_str.to_i.to_s
-    raise 'The recovery heart rate should be between 60 and 205 bpm.' if recovery_hr_int < 60 || recovery_hr_int > 205
-    @recovery_heart_rate = recovery_hr_int
-  end
-  ##
-  # Adding a number of repetitions to the object.
-  # Params:
-  # +repetitions+:: number of interval repetitions
-  def repetitions(repetitions)
-    repetitions_str = repetitions.to_s
-    repetitions_int = repetitions.to_s.to_i
-    raise 'The given number of repetitions is not an integer.' if repetitions_str != repetitions_str.to_i.to_s
-    raise 'The minimum number of repetitions is 1.' if repetitions_int < 1
-    @repetitions = repetitions_int
-  end
-  ##
-  # Adding an interval type to the object.
-  # Params:
-  # +type+:: interval type
-  def type(type)
-    @type = type
-  end
-  ##
-  # Converting an interval to a string.
-  def to_s
-    "#{@sport} #{@info}"
-  end
-  ##
-  # Converting an interval to a JSON-ized string.
-  def to_hash
-    hash = {
-      name: @name,
-      sport: @sport,
-      info: @info,
-      speed_duration: @speed_duration,
-      recovery_duration: @recovery_duration,
-      speed_heart_rate: @speed_heart_rate,
-      recovery_heart_rate: @recovery_heart_rate,
-      repetitions: @repetitions,
-      type: @type
-    }
-    hash[:info] = @info if @info
-    hash
-  end
-end
+# frozen_string_literal: true
+require_relative 'sport'
+##
+# This class represents an interval.
+class Interval
+  ##
+  # Initialization method for the +Interval+ class.
+  # Params:
+  # +name+:: the name of the interval
+  def initialize(name)
+    @name = name
+    @sport = ''
+    @info = ''
+    @speed_duration = 0
+    @recovery_duration = 0
+    @speed_heart_rate = 0
+    @recovery_heart_rate = 0
+    @repetitions = 0
+    @type = ''
+  end
+  ##
+  # Adding a sport to the object.
+  # Params:
+  # +type+:: the type of the sport
+  def sport(type)
+    raise 'The sport name has to be from the Sport class collection.' unless Sport.values.include? type
+    @sport = type
+  end
+  ##
+  # Adding an info message to the object.
+  # Params:
+  # +message+:: the info message
+  def info(message)
+    @info = message
+  end
+  ##
+  # Adding a speed duration of an interval to the object.
+  # Params:
+  # +speed_duration+:: the duration of the speed segment in minutes
+  def speed_duration(speed_duration)
+    speed_duration_str = speed_duration.to_s
+    speed_duration_int = speed_duration.to_s.to_i
+    raise 'The given speed duration is not an integer.' if speed_duration_str != speed_duration_str.to_i.to_s
+    raise 'The speed duration has to be 1 minute at least.' if speed_duration_int < 1
+    @speed_duration = speed_duration_int
+  end
+  ##
+  # Adding a recovery duration of an interval to the object.
+  # Params:
+  # +recovery_duration+:: the duration of the recovery segment in minutes
+  def recovery_duration(recovery_duration)
+    recovery_duration_str = recovery_duration.to_s
+    recovery_duration_int = recovery_duration.to_s.to_i
+    raise 'The given recovery duration is not an integer.' if recovery_duration_str != recovery_duration_str.to_i.to_s
+    raise 'The recovery duration has to be 1 minute at least.' if recovery_duration_int < 1
+    @recovery_duration = recovery_duration_int
+  end
+  ##
+  # Adding a speed heart rate of an interval to the object.
+  # Params:
+  # +speed_heart_rate+:: the average speed heart rate in bpm
+  def speed_heart_rate(speed_heart_rate)
+    speed_hr_str = speed_heart_rate.to_s
+    speed_hr_int = speed_heart_rate.to_s.to_i
+    raise 'The given average heart rate is not an integer.' if speed_hr_str != speed_hr_str.to_i.to_s
+    raise 'The speed heart rate should be between 60 and 205 bpm.' if speed_hr_int < 60 || speed_hr_int > 205
+    @speed_heart_rate = speed_hr_int
+  end
+  ##
+  # Adding a recovery heart rate of an interval to the object.
+  # Params:
+  # +recovery_heart_rate+:: the average speed heart rate in bpm
+  def recovery_heart_rate(recovery_heart_rate)
+    recovery_hr_str = recovery_heart_rate.to_s
+    recovery_hr_int = recovery_heart_rate.to_s.to_i
+    raise 'The given average heart rate is not an integer.' if recovery_hr_str != recovery_hr_str.to_i.to_s
+    raise 'The recovery heart rate should be between 60 and 205 bpm.' if recovery_hr_int < 60 || recovery_hr_int > 205
+    @recovery_heart_rate = recovery_hr_int
+  end
+  ##
+  # Adding a number of repetitions to the object.
+  # Params:
+  # +repetitions+:: number of interval repetitions
+  def repetitions(repetitions)
+    repetitions_str = repetitions.to_s
+    repetitions_int = repetitions.to_s.to_i
+    raise 'The given number of repetitions is not an integer.' if repetitions_str != repetitions_str.to_i.to_s
+    raise 'The minimum number of repetitions is 1.' if repetitions_int < 1
+    @repetitions = repetitions_int
+  end
+  ##
+  # Adding an interval type to the object.
+  # Params:
+  # +type+:: interval type
+  def type(type)
+    @type = type
+  end
+  ##
+  # Converting an interval to a string.
+  def to_s
+    "#{@sport} #{@info}"
+  end
+  ##
+  # Converting an interval to a JSON-ized string.
+  def to_hash
+    hash = {
+      name: @name,
+      sport: @sport,
+      info: @info,
+      speed_duration: @speed_duration,
+      recovery_duration: @recovery_duration,
+      speed_heart_rate: @speed_heart_rate,
+      recovery_heart_rate: @recovery_heart_rate,
+      repetitions: @repetitions,
+      type: @type
+    }
+    hash[:info] = @info if @info
+    hash
+  end
+end

data/lib/power.rb CHANGED Viewed

@@ -1,55 +1,55 @@
-# frozen_string_literal: true
-require_relative 'series'
-require_relative 'sport'
-##
-# This class represents a power training session.
-class Power
-  ##
-  # Initialization method for the +Power+ class.
-  # Params:
-  # +name+:: the name of the power session
-  def initialize(name)
-    @name = name
-    @series = []
-    @sport = ''
-  end
-  ##
-  # Building a new series from the domain specific language.
-  # Params:
-  # +name+:: the name of the series
-  # +block+:: power session data
-  def series(name, &block)
-    series_data = Series.new(name)
-    series_data.instance_eval(&block)
-    @series << series_data
-  end
-  ##
-  # Adding a sport type to the object.
-  # Params:
-  # +type+:: the type of the sport
-  def sport(type)
-    raise 'The sport name has to be from the Sport class collection.' unless Sport.values.include? type
-    @sport = type
-  end
-  ##
-  # Converting a speed session to a string.
-  def to_s
-    @name
-  end
-  ##
-  # Converting a session to a JSON-ized string.
-  def to_hash
-    {
-      name: @name,
-      sport: @sport,
-      series: @series.collect(&:to_hash)
-    }
-  end
-end
+# frozen_string_literal: true
+require_relative 'series'
+require_relative 'sport'
+##
+# This class represents a power training session.
+class Power
+  ##
+  # Initialization method for the +Power+ class.
+  # Params:
+  # +name+:: the name of the power session
+  def initialize(name)
+    @name = name
+    @series = []
+    @sport = ''
+  end
+  ##
+  # Building a new series from the domain specific language.
+  # Params:
+  # +name+:: the name of the series
+  # +block+:: power session data
+  def series(name, &block)
+    series_data = Series.new(name)
+    series_data.instance_eval(&block)
+    @series << series_data
+  end
+  ##
+  # Adding a sport type to the object.
+  # Params:
+  # +type+:: the type of the sport
+  def sport(type)
+    raise 'The sport name has to be from the Sport class collection.' unless Sport.values.include? type
+    @sport = type
+  end
+  ##
+  # Converting a speed session to a string.
+  def to_s
+    @name
+  end
+  ##
+  # Converting a session to a JSON-ized string.
+  def to_hash
+    {
+      name: @name,
+      sport: @sport,
+      series: @series.collect(&:to_hash)
+    }
+  end
+end

data/lib/series.rb CHANGED Viewed

@@ -1,57 +1,57 @@
-# frozen_string_literal: true
-##
-# This class represents a series in power training session.
-class Series
-  ##
-  # Initialization method for the +Series+ class.
-  # Params:
-  # +name+:: the name of the series
-  def initialize(name)
-    @name = name
-    @intensity = 0
-    @repetitions = 0
-  end
-  ##
-  # Adding an intensity in the range [1, 10] to the series.
-  # Params:
-  # +intensity+:: intensity level
-  def intensity(intensity)
-    intensity_str = intensity.to_s
-    intensity_int = intensity.to_s.to_i
-    raise 'The given intensity level is not an integer.' if intensity_str != intensity_str.to_i.to_s
-    raise 'The intensity level should be between 1 and 10.' if intensity_int < 1 || intensity_int > 10
-    @intensity = intensity_int
-  end
-  ##
-  # Adding a number of repetitions to the object.
-  # Params:
-  # +repetitions+:: number of repetitions inside of a series
-  def repetitions(repetitions)
-    repetitions_str = repetitions.to_s
-    repetitions_int = repetitions.to_s.to_i
-    raise 'The given number of repetitions is not an integer.' if repetitions_str != repetitions_str.to_i.to_s
-    raise 'The minimum number of repetitions is 1.' if repetitions_int < 1
-    @repetitions = repetitions_int
-  end
-  ##
-  # Converting a speed session to a string.
-  def to_s
-    @name
-  end
-  ##
-  # Converting a session to a JSON-ized string.
-  def to_hash
-    {
-      name: @name,
-      intensity: @intensity,
-      repetitions: @repetitions
-    }
-  end
-end
+# frozen_string_literal: true
+##
+# This class represents a series in power training session.
+class Series
+  ##
+  # Initialization method for the +Series+ class.
+  # Params:
+  # +name+:: the name of the series
+  def initialize(name)
+    @name = name
+    @intensity = 0
+    @repetitions = 0
+  end
+  ##
+  # Adding an intensity in the range [1, 10] to the series.
+  # Params:
+  # +intensity+:: intensity level
+  def intensity(intensity)
+    intensity_str = intensity.to_s
+    intensity_int = intensity.to_s.to_i
+    raise 'The given intensity level is not an integer.' if intensity_str != intensity_str.to_i.to_s
+    raise 'The intensity level should be between 1 and 10.' if intensity_int < 1 || intensity_int > 10
+    @intensity = intensity_int
+  end
+  ##
+  # Adding a number of repetitions to the object.
+  # Params:
+  # +repetitions+:: number of repetitions inside of a series
+  def repetitions(repetitions)
+    repetitions_str = repetitions.to_s
+    repetitions_int = repetitions.to_s.to_i
+    raise 'The given number of repetitions is not an integer.' if repetitions_str != repetitions_str.to_i.to_s
+    raise 'The minimum number of repetitions is 1.' if repetitions_int < 1
+    @repetitions = repetitions_int
+  end
+  ##
+  # Converting a speed session to a string.
+  def to_s
+    @name
+  end
+  ##
+  # Converting a session to a JSON-ized string.
+  def to_hash
+    {
+      name: @name,
+      intensity: @intensity,
+      repetitions: @repetitions
+    }
+  end
+end

data/lib/speed.rb CHANGED Viewed

@@ -1,83 +1,83 @@
-# frozen_string_literal: true
-require_relative 'sport'
-##
-# This class represents a speed training session.
-class Speed
-  ##
-  # Initialization method for the +Speed+ class.
-  # Params:
-  # +name+:: the name of the speed session
-  def initialize(name)
-    @name = name
-    @sport = ''
-    @info = ''
-    @average_heart_rate = 0
-    @total_duration = 0
-  end
-  ##
-  # Adding a sport type to the object.
-  # Params:
-  # +type+:: the type of the sport
-  def sport(type)
-    raise 'The sport name has to be from the Sport class collection.' unless Sport.values.include? type
-    @sport = type
-  end
-  ##
-  # Adding a message to the object.
-  # Params:
-  # +message+:: the info message
-  def info(message)
-    @info = message
-  end
-  ##
-  # Adding an average heart rate to the object.
-  # Params:
-  # +heart_rate+:: the average heart rate in bpm
-  def average_heart_rate(heart_rate)
-    heart_rate_str = heart_rate.to_s
-    heart_rate_int = heart_rate.to_s.to_i
-    raise 'The given average heart rate is not an integer.' if heart_rate_str != heart_rate_str.to_i.to_s
-    raise 'The average heart rate should be between 60 and 205 bpm.' if heart_rate_int < 60 || heart_rate_int > 205
-    @average_heart_rate = heart_rate_int
-  end
-  ##
-  # Adding a total duration to the object.
-  # Params:
-  # +duration+:: the duration in minutes
-  def total_duration(duration)
-    duration_str = duration.to_s
-    duration_int = duration.to_s.to_i
-    raise 'The given average heart rate is not an integer.' if duration_str != duration_str.to_i.to_s
-    raise 'The duration has to be 1 minute at least.' if duration_int < 1
-    @total_duration = duration_int
-  end
-  ##
-  # Converting a speed session to a string.
-  def to_s
-    "#{@sport} #{@info}"
-  end
-  ##
-  # Converting a session to a JSON-ized string.
-  def to_hash
-    hash = {
-      name: @name,
-      sport:	@sport,
-      average_heart_rate: @average_heart_rate,
-      total_duration: @total_duration
-    }
-    hash[:info] = @info if @info != ''
-    hash
-  end
-end
+# frozen_string_literal: true
+require_relative 'sport'
+##
+# This class represents a speed training session.
+class Speed
+  ##
+  # Initialization method for the +Speed+ class.
+  # Params:
+  # +name+:: the name of the speed session
+  def initialize(name)
+    @name = name
+    @sport = ''
+    @info = ''
+    @average_heart_rate = 0
+    @total_duration = 0
+  end
+  ##
+  # Adding a sport type to the object.
+  # Params:
+  # +type+:: the type of the sport
+  def sport(type)
+    raise 'The sport name has to be from the Sport class collection.' unless Sport.values.include? type
+    @sport = type
+  end
+  ##
+  # Adding a message to the object.
+  # Params:
+  # +message+:: the info message
+  def info(message)
+    @info = message
+  end
+  ##
+  # Adding an average heart rate to the object.
+  # Params:
+  # +heart_rate+:: the average heart rate in bpm
+  def average_heart_rate(heart_rate)
+    heart_rate_str = heart_rate.to_s
+    heart_rate_int = heart_rate.to_s.to_i
+    raise 'The given average heart rate is not an integer.' if heart_rate_str != heart_rate_str.to_i.to_s
+    raise 'The average heart rate should be between 60 and 205 bpm.' if heart_rate_int < 60 || heart_rate_int > 205
+    @average_heart_rate = heart_rate_int
+  end
+  ##
+  # Adding a total duration to the object.
+  # Params:
+  # +duration+:: the duration in minutes
+  def total_duration(duration)
+    duration_str = duration.to_s
+    duration_int = duration.to_s.to_i
+    raise 'The given average heart rate is not an integer.' if duration_str != duration_str.to_i.to_s
+    raise 'The duration has to be 1 minute at least.' if duration_int < 1
+    @total_duration = duration_int
+  end
+  ##
+  # Converting a speed session to a string.
+  def to_s
+    "#{@sport} #{@info}"
+  end
+  ##
+  # Converting a session to a JSON-ized string.
+  def to_hash
+    hash = {
+      name: @name,
+      sport:	@sport,
+      average_heart_rate: @average_heart_rate,
+      total_duration: @total_duration
+    }
+    hash[:info] = @info if @info != ''
+    hash
+  end
+end

data/lib/sport.rb CHANGED Viewed

@@ -1,15 +1,15 @@
-# frozen_string_literal: true
-require 'ruby-enum'
-##
-# This class represents a collection of sports.
-class Sport
-  include Ruby::Enum
-  define :CYCLING, 'cycling'
-  define :RUNNING, 'running'
-  define :SWIMMING, 'swimming'
-  define :CROSS_COUNTRY_SKIING, 'cross country skiing'
-  define :WEIGHT_LIFTING, 'weight lifting'
-end
+# frozen_string_literal: true
+require 'ruby-enum'
+##
+# This class represents a collection of sports.
+class Sport
+  include Ruby::Enum
+  define :CYCLING, 'cycling'
+  define :RUNNING, 'running'
+  define :SWIMMING, 'swimming'
+  define :CROSS_COUNTRY_SKIING, 'cross country skiing'
+  define :WEIGHT_LIFTING, 'weight lifting'
+end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ast-tdl
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - firefly-cpp
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2024-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-enum
@@ -64,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: An experimental and minimalistic Training Description Language for Artificial