ast-tdl 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acbbd1f514fbcdc7f7c30925602170f3ebe829f688dbf3e562488f9fc88ed87f
-  data.tar.gz: 554f179dec696c7d330acb1884aed681f88f1a03923bd4353eef68bd9ddb2b81
+  metadata.gz: 7e1cae6b9c56c969808cd16ff2d58ec838db46745cf3f6b9b1eb3583536ad93b
+  data.tar.gz: '0841bfa32e170d22ec587d027086ce4816a86d8116627c8f365000010ebd224a'
 SHA512:
-  metadata.gz: 2ffa95b47ee68c9091883a974fc84c3c91143594948bd22459a5d462209c877ee9f00919ca1e055b925d8ff35d8f6262f9f40f6e525b4cf9c8931d9827a923ec
-  data.tar.gz: 995761ca6d201f99b4cf9f3fc061279e5332b197b83161e52fa0792a7af3f1d7f4434f4eef4e3d9e3552fdb87cdda0881dd075d9fc380c07f10339d36b462e78
+  metadata.gz: 179ff4d41c5e51f81f2298bd6363fdbd58afe24b729274a4fc50eb04ffacb3eec453726da1817f4995c55d9923d5202e15c1083f5a7e762993fb7aab08edba48
+  data.tar.gz: 9e644b6a2f48ec60038a31c503a7d65fbfa4cc8bc89c19f8e9f2da31700f6299794eb292f37cfc2df72b05c9c8d92f8beb420f94c779055761d5fabfe9ca154c

data/LICENSE

@@ -0,0 +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.

data/README.md

@@ -1,6 +1,11 @@
 # Training Description Language (TDL) for Artificial Sport Trainer (AST)
+
+## 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.
 
+## Feature diagram
+![scheme](https://user-images.githubusercontent.com/73126820/177509075-977b2e18-ebb7-40ce-9af9-ed7715717bf3.png)
+
 ## Installation
     $ gem install ast-tdl
 
@@ -9,40 +14,54 @@ Training Description Language (TDL) is implemented in Ruby. Currently, the descr
 
 ## 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"
-    }
+Ast.build('My first training') do
+  session('Short swimming session') do
+    sport               :swim
+    info                :"Very easy training"
+    average_heart_rate  :"130"
+    total_duration      :"30"
+  end
+
+  session('Bike ride') do
+    sport               :cycling
+    info                :"Endurance ride with intervals"
+    average_heart_rate  :"140"
+    total_duration      :"120"
+  end
+
+  interval('Sample interval') do
+    sport                   :cycling
+    info                    :Moderate
+    speed_duration          :"5"
+    recovery_duration       :"5"
+    speed_heart_rate        :"180"
+    recovery_heart_rate     :"90"
+    repetitions             :"10"
+  end
 end
 ```
 
 ### Session
 ```ruby
-session("Short swimming session today") {
-    sport 	        :"swim"
-    info                :"Very easy training"
-    average_heart_rate  :"130"
-    total_duration      :"30"
-}
+session('Bike ride') do
+  sport               :cycling
+  info                :"Endurance ride with intervals"
+  average_heart_rate  :"140"
+  total_duration      :"120"
+end
+```
+
+### Interval
+```ruby
+interval('Sample interval') do
+  sport                :cycling
+  info                 :Moderate
+  speed_duration       :"5"
+  recovery_duration    :"5"
+  speed_heart_rate     :"180"
+  recovery_heart_rate  :"90"
+  repetitions          :"10"
+end
 ```
 
 ## License
@@ -53,4 +72,4 @@ This framework is provided as-is, and there are no guarantees that it fits your
 
 ## 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).
+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.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'json'
-require_relative 'classes'
 require_relative 'interval'
 require_relative 'session'
 
@@ -69,7 +68,7 @@ module Ast
         session: @session.collect(&:to_hash),
         interval: @interval.collect(&:to_hash)
       }
-      training_json.to_json
+      JSON.pretty_generate(training_json)
     end
 
     ##

data/lib/interval.rb

@@ -7,81 +7,104 @@ 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 = []
+  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
 
   ##
-  # Building a new Sport object.
+  # Adding a sport to the object.
   # Params:
   # +type+:: the type of the sport
   def sport(type)
-    @sport << Sport.new(type)
+    @sport = type
   end
 
   ##
-  # Building a new Info object.
+  # Adding an info message to the object.
   # Params:
   # +message+:: the info message
   def info(message)
-    @info << Info.new(message)
+    @info = message
   end
 
   ##
-  # Building a new AverageHeartRate object.
+  # Adding a speed duration of an interval to the object.
   # Params:
-  # +heart_rate+:: the average heart rate in bpm
-  def average_heart_rate(heart_rate)
-    @average_heart_rate << AverageHeartRate.new(heart_rate)
+  # +speed_duration+:: the duration of the speed segment in minutes
+  def speed_duration(speed_duration)
+    @speed_duration = speed_duration.to_s.to_i
   end
 
   ##
-  # Building a new TotalDuration object.
+  # Adding a recovery duration of an interval to the object.
   # Params:
-  # +duration+:: the duration in seconds
-  def total_duration(duration)
-    @total_duration << TotalDuration.new(duration)
+  # +recovery_duration+:: the duration of the recovery segment in minutes
+  def recovery_duration(recovery_duration)
+    @recovery_duration = recovery_duration.to_s.to_i
   end
 
   ##
-  # Building a new AverageHeartRateRest object.
+  # Adding a speed heart rate of an interval to the 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)
+  # +speed_heart_rate+:: the average speed heart rate in bpm
+  def speed_heart_rate(speed_heart_rate)
+    @speed_heart_rate = speed_heart_rate.to_s.to_i
   end
 
   ##
-  # Building a new TotalDurationRest object.
+  # Adding a recovery heart rate of an interval to the object.
   # Params:
-  # +duration rest+:: the rest duration in seconds
-  def total_duration_rest(duration_rest)
-    @total_duration_rest << TotalDurationRest.new(duration_rest)
+  # +recovery_heart_rate+:: the average speed heart rate in bpm
+  def recovery_heart_rate(recovery_heart_rate)
+    @recovery_heart_rate = recovery_heart_rate.to_s.to_i
+  end
+
+  ##
+  # Adding a number of repetitions to the object.
+  # Params:
+  # +repetitions+:: number of interval repetitions
+  def repetitions(repetitions)
+    @repetitions = repetitions.to_s.to_i
+  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[0].type} #{@info[0].message}"
+    "#{@sport} #{@info}"
   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),
+    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/session.rb

@@ -7,61 +7,63 @@ 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 = []
+  def initialize(name)
+    @name = name
+    @sport = ''
+    @info = ''
+    @average_heart_rate = 0
+    @total_duration = 0
   end
 
   ##
-  # Building a new Sport object.
+  # Adding a sport type to the object.
   # Params:
   # +type+:: the type of the sport
   def sport(type)
-    @sport << Sport.new(type)
+    @sport = type
   end
 
   ##
-  # Building a new Info object.
+  # Adding a message to the object.
   # Params:
   # +message+:: the info message
   def info(message)
-    @info << Info.new(message)
+    @info = message
   end
 
   ##
-  # Building a new AverageHeartRate object.
+  # Adding an average heart rate to the object.
   # Params:
   # +heart_rate+:: the average heart rate in bpm
   def average_heart_rate(heart_rate)
-    @average_heart_rate << AverageHeartRate.new(heart_rate)
+    @average_heart_rate = heart_rate.to_s.to_i
   end
 
   ##
-  # Building a new TotalDuration object.
+  # Adding a total duration to the object.
   # Params:
-  # +duration+:: the duration in seconds
+  # +duration+:: the duration in minutes
   def total_duration(duration)
-    @total_duration << TotalDuration.new(duration)
+    @total_duration = duration.to_s.to_i
   end
 
   ##
   # Converting a session to a string.
   def to_s
-    "#{@sport[0].type} #{@info[0].message}"
+    "#{@sport} #{@info}"
   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),
+    hash = {
+      name: @name,
+      sport:	@sport,
+      average_heart_rate: @average_heart_rate,
+      total_duration: @total_duration,
     }
+
+    hash[:info] = @info if @info != ''
+    hash
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ast-tdl
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
 - firefly-cpp
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+date: 2022-07-07 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -19,10 +19,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/ast-tdl.rb
 - lib/ast.rb
-- lib/classes.rb
 - lib/interval.rb
 - lib/session.rb
 homepage: https://github.com/firefly-cpp/ast-tdl

data/lib/classes.rb

@@ -1,148 +0,0 @@
-# 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
-    {
-      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
-    {
-      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
-    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
-    {
-      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
-    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: @total_duration_rest
-    }
-  end
-end