ast-tdl 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2f857804cef121dd1c5f2a8e41ab0d27098517e03ee15c8316bc0e62d7707093
-  data.tar.gz: 2235c16bf905edf99c00693477e5b9c0f037b084c39ca541bec49f00031f9cdb
+  metadata.gz: 757763f7548180daaeaf4e4d427a9837584d0f3b68ef8b08fc2cefffab8b293e
+  data.tar.gz: 4518d44a21c598c06872b1b5c60d13cd62816fd192e550c80a7e45f9617c4306
 SHA512:
-  metadata.gz: 62436ef8167db994e207f1309c7a41a9b022ceae7ca85f82f57b9f630134965859ceb845953b99c5858a3a16613961ba04507451252a27597da9702e86458655
-  data.tar.gz: 10e94fd67a4301721b0b600b4786fe73d5527493a3c192d85e1f7d8c290fe376a79f4e3ebab62f63eba8748b7af025fbf59cd1d4203b608634e5f0ae31f644b5
+  metadata.gz: cf4a6d62f36951fcf352b6c93d31d4ba2a170169b1a82e7beb493b3283c7df5f1eecef2f62bdd94a18f86437e647665a8d2f5c5af357e82925b1ea199a10d642
+  data.tar.gz: d594576289625b607ebb359fbbe5e22623fafd0f9dcf904d33cc088b479dbfdba1c6b9c022c65e2534891cd7ae7295d770ee93d3bea322464d65f243dea30b3b

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,33 +1,61 @@
 # Training Description Language (TDL) for Artificial Sport Trainer (AST)
 
-AST-DSL is a very small domain-specific language
+## 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.
 
-## Objective
+## Feature diagram
+![scheme](https://user-images.githubusercontent.com/73126820/175337865-77344476-b7c8-45d4-bda2-0aca82aebefd.png)
 
 ## 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 'ast'
+# frozen_string_literal: true
+
+require_relative './ast'

data/lib/ast.rb

@@ -1,53 +1,85 @@
-require 'json'
+# 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
-	def self.build(name, &block)
-		training = Training.new(name)
-		training.instance_eval(&block)
-		return training
-	end
-
-	class Training
-		def initialize(name)
-			@name = name
-			@session = []
-            @interval = []
-		end
-
-		def session(name, &block)
-			training_type = Session.new(name)
-			training_type.instance_eval(&block)
-			@session << training_type
-		end
-
-		def interval(name, &block)
-			interval_data = Interval.new(name)
-			interval_data.instance_eval(&block)
-			@interval << interval_data
-		end
-
-		def to_s
-			str = "#{@name} #{@session[0]}"
-		end
-
-		def json
-			training_json = {
-				name:      @name,
-				session:   @session.collect  { |x| x.to_hash },
-				interval:  @interval.collect { |x| x.to_hash },
-			}
-			training_json.to_json
-		end
-
-		def save_to_file(filename)
-			f = File.open(filename, "w")
-			f.puts(json)
-			f.close
-		end
-	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
+
+    ##
+    # 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
+      "#{@name} #{@session[0]}"
+    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
 end

data/lib/classes.rb

@@ -1,86 +1,148 @@
-require 'json'
+# frozen_string_literal: true
 
+require 'json'
 
+##
+# This class represents a sport with a type.
 class Sport
-	attr_reader :type
-
-	def initialize(type)
-		@type = type
-	end
-
-	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
-	attr_reader :message
-
-	def initialize(message)
-		@message = message
-	end
-
-	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
 
-class Avhr
-	attr_reader :heart_rate
-
-	def initialize(heart_rate)
-		@heart_rate = heart_rate
-	end
-
-	def to_hash
-		info_json = {
-			average_hr: @heart_rate
-		}
-	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
 
-class Td
-	attr_reader :duration
-
-	def initialize(duration)
-		@duration = duration
-    end
-
-	def to_hash
-		td_json = {
-			duration: @duration
-		}
-	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
 
-class AvhrRest
-	attr_reader :avhr_rest
-
-	def initialize(avhr_rest)
-		@avhr_rest = avhr_rest
-	end
-
-	def to_hash
-		avhr_json = {
-			average_hr_rest: @avhr_rest
-		}
-	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
 
-class TdRest
-	attr_reader :td_rest
-
-	def initialize(td_rest)
-		@td_rest = td_rest
-	end
-
-	def to_hash
-		td_json = {
-			duration_rest: @td_rest
-		}
-	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

data/lib/interval.rb

@@ -1,51 +1,87 @@
+# frozen_string_literal: true
+
+##
+# This class represents an interval.
 class Interval
-	def initialize(name)
-		@name = []
-		@sport = []
-		@info = []
-		@avhr = []
-		@td = []
-        @avhr_rest = []
-        @td_rest = []
-	end
-
-	def sport(type)
-		@sport << Sport.new(type)
-	end
-
-	def info(message)
-		@info << Info.new(message)
-	end
-
-	def avhr(heart_rate)
-		@avhr << Avhr.new(heart_rate)
-	end
-
-	def td(duration)
-		@td << Td.new(duration)
-	end
-    
-	def avhr_rest(heart_rate_rest)
-		@avhr_rest << AvhrRest.new(heart_rate_rest)
-	end
-    
-	def td_rest(duration_rest)
-		@td_rest << TdRest.new(duration_rest)
-    end
-        
-	def to_s
-		str = "#{@sport[0].type} #{@info[0].message}"
-	end
-
-	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 },
-		}
-	end
-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 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
+    "#{@sport[0].type} #{@info[0].message}"
+  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,42 +1,67 @@
-require 'json'
-
+# frozen_string_literal: true
 
+##
+# This class represents a session.
 class Session
-	def initialize(name)
-		@name = []
-		@sport = []
-		@info = []
-		@avhr = []
-		@td = []
-	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
 
-	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
 
-	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
 
-	def avhr(heart_rate)
-		@avhr << Avhr.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
 
-	def td(duration)
-		@td << Td.new(duration)
-	end
+  ##
+  # Building a new TotalDuration object.
+  # Params:
+  # +duration+:: the duration in seconds
+  def total_duration(duration)
+    @total_duration << TotalDuration.new(duration)
+  end
 
-	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
 
-	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 },
-		}
-	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.1
+  version: 0.0.4
 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-28 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -19,18 +19,20 @@ 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-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 +41,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:
   - - ">="