tcxread 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 467aa1170c1d1e4187ad0bf62cdf274e3323427e1a17b373761d9e15344f3246
-  data.tar.gz: 3bb6690e5169d24ea3a18cbcea16af923a3d203a1f230364b5db2e68363ced11
+  metadata.gz: 3d133eea1f6023a5ede73c5598671052bb312ea47d621d9dfe49bb6faa4cb4a6
+  data.tar.gz: 7650d1a88ec174b8e963ddc3a21319fca4157d016ccdf9d08b81c11873de02ea
 SHA512:
-  metadata.gz: 8fa40c28c9ead5bbdbdb3d3c7a79958f7145f6b53398771af1776be3e6d44c25d2e0e9ec8165026d4c54789dccad0550fd69e882e1471dec322feb79a3a3c059
-  data.tar.gz: ff9edd51b84495ce42b3db1ea53a807f23df2c97b264524f5f274a9b2b9a815efcedd6d0e7c2bc540268a4655a85c3cdd183ce1aa1f732edc22476bcbf53e157
+  metadata.gz: ade42be5169a40e65f05eedb6546727ffb3bf9ba00a4d6fe412ed0a6546dc675b643ac818aec909f238661771acbe68973fb557f9ef26143fe4a4c2506a51ecb
+  data.tar.gz: 7bccd7b16ddd291a1963b03b458fbcb2fad41b162810a0187f309c35cb37af61d8f669d5333d9dab9f094ec16dabfb15548cf271e30fa515045a07428bd8669b

data/README.md

@@ -38,24 +38,27 @@ $ gem install tcxread
 ```ruby
 require 'tcxread'
 
-data = TCXRead.new('23.tcx')
-
-puts "Distance meters: #{data.total_distance_meters}, " \
-     "Time seconds: #{data.total_time_seconds}, " \
-     "Calories: #{data.total_calories}, " \
-     "Total ascent: #{data.total_ascent}, " \
-     "Total descent: #{data.total_descent}, " \
-     "Max altitude: #{data.max_altitude}, " \
-     "Average heart rate: #{data.average_heart_rate}, " \
-     "Average watts: #{data.average_watts}, " \
-     "Max watts: #{data.max_watts}, " \
-     "Average speed: #{data.average_speed_all}, " \
-     "Average speed (moving): #{data.average_speed_moving}, " \
-     "Average cadence (moving): #{data.average_cadence_biking}, " \
-     "Average cadence: #{data.average_cadence_all}"
-
+data = TCXRead.load_file('23.tcx')
+
+puts [
+  "Distance meters: #{data.total_distance_meters}",
+  "Time seconds: #{data.total_time_seconds}",
+  "Calories: #{data.total_calories}",
+  "Total ascent: #{data.total_ascent}",
+  "Total descent: #{data.total_descent}",
+  "Max altitude: #{data.max_altitude}",
+  "Average heart rate: #{data.average_heart_rate}",
+  "Average watts: #{data.average_watts}",
+  "Max watts: #{data.max_watts}",
+  "Average speed: #{data.average_speed_all}",
+  "Average speed (moving): #{data.average_speed_moving}",
+  "Average cadence (moving): #{data.average_cadence_biking}",
+  "Average cadence: #{data.average_cadence_all}"
+].join("\n")
 ```
 
+Use `TCXRead.parse(data)` to parse raw TCX data.
+
 ## 💾 Datasets
 
 Datasets available and used in the examples on the following links: [DATASET1](http://iztok-jr-fister.eu/static/publications/Sport5.zip), [DATASET2](http://iztok-jr-fister.eu/static/css/datasets/Sport.zip), [DATASET3](https://github.com/firefly-cpp/tcx-test-files).

data/lib/tcxread.rb

@@ -43,10 +43,9 @@ class TCXRead
               :average_speed_all, :average_speed_moving
 
   # Initializes the TCXRead object and parses the TCX file.
-  # @param file_path [String] The file path of the TCX file to process.
-  def initialize(file_path)
-    @file_path = file_path
-    @doc = Nokogiri::XML(File.open(file_path))
+  # @param file_path_or_xml [String] The file path of the TCX file to process or a Nokogiri::XML document.
+  def initialize(file_path_or_xml)
+    @doc = file_path_or_xml.is_a?(Nokogiri::XML::Document) ? file_path_or_xml : Nokogiri::XML(File.open(file_path_or_xml))
     @doc.root.add_namespace_definition('ns3', 'http://www.garmin.com/xmlschemas/ActivityExtension/v2')
 
     @total_distance_meters = 0
@@ -66,6 +65,20 @@ class TCXRead
     parse
   end
 
+  # Returns a TCXRead object from a File or file path.
+  # @param file_or_path [String, File] The file path or a Fule of the TCX file to process.
+  def self.load_file(file_or_path)
+    TCXRead.new(Nokogiri::XML(file_or_path.is_a?(File) ? file_or_path : File.open(file_or_path)))
+  end
+
+  # Returns a TCXRead object from raw TCX data.
+  # @param data [String] TCX data to load.
+  def self.parse(data)
+    TCXRead.new(Nokogiri::XML(data))
+  end
+
+  private
+
   # Parses the TCX file and computes metrics for all activities.
   def parse
     activities = parse_activities
@@ -88,8 +101,6 @@ class TCXRead
     @average_speed_moving = speed_results[:average_speed_moving]
   end
 
-  private
-
   # Parses activities from the TCX file.
   # @return [Array<Hash>] An array of parsed activity data.
   def parse_activities

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tcxread
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - firefly-cpp
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,7 +23,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.11'
-description:
 email:
 - iztok@iztok-jr-fister.eu
 executables: []
@@ -41,7 +39,6 @@ metadata:
   homepage_uri: https://github.com/firefly-cpp/tcxread
   source_code_uri: https://github.com/firefly-cpp/tcxread
   changelog_uri: https://github.com/firefly-cpp/tcxread
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -56,8 +53,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: tcx reader/parser in Ruby
 test_files: []