runby_pace 0.2.72 → 0.2.73

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTM2ZGQ2YmIyZmNkMGM0NGViOTdiZTQzMjY4YTBmNzA0ZjQ3NWNhZg==
+    NzRhMDJiMDg2YzY0YjdjMTQ4OGFhOTlmMDNmMzA2ODgyM2I2Zjk0Ng==
   data.tar.gz: !binary |-
-    N2I4M2M2MjRhY2IzMDkxZmEwN2NkOTIyMTUzNDc3ZTNkNmFmMDg5Yw==
+    NzAyNmRmMmE3MTcxY2QyYTEzMTRkZDc3OTBmOTFiNTBiYmUzOGQyMw==
 SHA512:
   metadata.gz: !binary |-
-    YWFjOWY4MTU5ZDdmZTI4NWM0Njk5MDcxMTQ2YzdiN2Q0MDY0MTg4MGI3NjBj
-    OTZjZjExMmMxMGIxYzQ3ZTE1NjI5N2JkYTMxMjgwMWViZDU1MDNlNGZlNDYy
-    NGI3MjA1NTVmOGE5YTljOTA0MmE1NDExZDQ2NTU1MDc5NzExNTc=
+    NDhiMWQ5ODE4ZGI4Nzg2ZDVhOTM4MjhiNTU1ZjU0NzVjYTc0ZGNkZjVlMmRj
+    ODRhMWJhMGYyY2RmNjY1MTEzNTIxYjM2NWY4NTlkZmVlOTcxMDczNDM4MTg5
+    ZjlhNTZhMmQxYzJiZmY5NDFhYjk3ZjVkNTI4NmI3OGIxOTgzZTM=
   data.tar.gz: !binary |-
-    NDRkYmFkN2UwNTg5ODI4MTgwYWUzOGJhNDEzYzJkYTEwZWJlY2Y1YzZiNzY1
-    ZGVkODcxYTg5ZDM0MTZkNzViZGYxMzFiYWE1MWE5YjI1ZDM0Zjg0MzM0NDEy
-    MDE4ZDUyYmIzNzkzMWQ1ZTA3ZmRlZmI4YTRiMWYwNTBjMjA2YzY=
+    MDEwNzQ2NWU0MWZiYTk5MGFjNzJhNzJlZThiNGI5ZDRjMjlmODc1ZDE5NDdh
+    YTAzZmZkOGFlYzJmZjI1ZTA0YTY2NjJkMjhiYzQ0ZjYyMGI3MmRjYTI0NzMz
+    ODgyNTU1YTQyZjBjNTkyNjE2ODE5MGNlMjdkZTZiYmUwNDBkYTE=

data/lib/runby_pace/pace_range.rb

@@ -8,6 +8,7 @@ module RunbyPace
       @slow = RunbyPace::PaceTime.new(slow)
     end
 
+    # Create a new pace range from an existing speed range.
     def self.from_speed_range(speed_range)
       fast = RunbyPace::RunMath.convert_speed_to_pace speed_range.fast
       slow = RunbyPace::RunMath.convert_speed_to_pace speed_range.slow

data/lib/runby_pace/pace_time.rb

@@ -17,7 +17,7 @@ module RunbyPace
     def self.from_seconds(total_seconds)
       minutes = total_seconds.abs.to_i / 60
       seconds = total_seconds.abs.to_i % 60
-      PaceTime.new format("#{'%02d'}:#{'%02d'}", minutes, seconds)
+      PaceTime.new format('%02d:%02d', minutes, seconds)
     end
 
     # @param [numeric] total_minutes

data/lib/runby_pace/pace_units.rb

@@ -1,4 +1,7 @@
 module RunbyPace
+  # Represents the distance units (e.g. kilometers, miles) used in paces
+  #  including the human-readable description of each unit
+  #  and the factor used to convert it to kilometers.
   class PaceUnits
     def self.description(units)
       descriptions[units]
@@ -8,13 +11,13 @@ module RunbyPace
       distance_conversion_factors[units]
     end
 
-    private
+    ### -- Private class methods --
 
-    def self.descriptions
+    private_class_method def self.descriptions
       { km: 'Kilometers', mi: 'Miles' }
     end
 
-    def self.distance_conversion_factors
+    private_class_method def self.distance_conversion_factors
       { km: 1.0, mi: 1.612903225806452 }
     end
   end

data/lib/runby_pace/run_math.rb

@@ -1,4 +1,5 @@
 module RunbyPace
+  # An assortment of mathematical functions related to running.
   class RunMath
     def self.convert_pace_to_speed(pace)
       pace = RunbyPace::PaceTime.new(pace)

data/lib/runby_pace/run_type.rb

@@ -1,4 +1,5 @@
 module RunbyPace
+  # Base class for all run types
   class RunType
     def description
       'No description'
@@ -8,7 +9,11 @@ module RunbyPace
     end
   end
 
+  # Extends RunTypes with additional methods.
+  # Since RunTypes is autogenerated in all_run_types.g.rb, we needed a safe way of adding behavior to it
+  #  without complicating the codegen.
   module RunTypes
+    # Returns an initialized run type, given the name of an existing run type
     def self.new_from_name(run_type_name)
       Object.const_get("RunbyPace::RunTypes::#{run_type_name}").new
     end

data/lib/runby_pace/run_types/all_run_types.template

@@ -1,6 +1,7 @@
 # This file is automatically generated by a rake task
 
 module RunbyPace
+  # Encapsulates data and behavior relating to all run types.
   module RunTypes
     def self.all
       %w(__RUN_TYPES__)

data/lib/runby_pace/run_types/distance_run.rb

@@ -1,5 +1,7 @@
 module RunbyPace
   module RunTypes
+    # Defines the venerable "distance run", the backbone of any distance running program.
+    #  Most of your runs should be at this pace. Harder than an "easy run" but still conversational.
     class DistanceRun < RunType
       attr_reader :slow_pace_data, :fast_pace_data
 
@@ -18,6 +20,7 @@ module RunbyPace
         PaceRange.new(fast, slow)
       end
 
+      # Used in testing, contains hashes mapping 5K race times with the recommended pace-per-km for this run type.
       class GoldenPaces
         def self.fast
           { '14:00': '03:44', '15:00': '03:58', '20:00': '05:09', '25:00': '06:18', '30:00': '07:24', '35:00': '08:29', '40:00': '09:33', '42:00': '09:58' }

data/lib/runby_pace/run_types/easy_run.rb

@@ -1,5 +1,6 @@
 module RunbyPace
   module RunTypes
+    # An easy run is basically a jog. It should be conversational.
     class EasyRun < RunType
       attr_reader :slow_pace_data, :fast_pace_data
 
@@ -18,6 +19,7 @@ module RunbyPace
         PaceRange.new(fast, slow)
       end
 
+      # Used in testing, contains hashes mapping 5K race times with the recommended pace-per-km for this run type.
       class GoldenPaces
         def self.fast
           { '14:00': '04:17', '15:00': '04:33', '20:00': '05:53', '25:00': '07:09', '30:00': '08:23', '35:00': '09:33', '40:00': '10:41', '42:00': '11:08' }

data/lib/runby_pace/run_types/fast_tempo_run.rb

@@ -2,6 +2,8 @@ require_relative 'tempo_run'
 
 module RunbyPace
   module RunTypes
+    # The "fast tempo" pace roughly equates to your half-marathon pace.
+    #  It's a pace you could maintain for about an hour, if pressed.
     class FastTempoRun < TempoRun
       def description
         'Fast Tempo Run'

data/lib/runby_pace/run_types/find_divisor.rb

@@ -1,4 +1,5 @@
 module RunbyPace
+  # Extend RunTypes with additional behavior. (See comments for details)
   module RunTypes
     # Currently, to find the radius of the curve in the pace table data for a given run time,
     #   we start with a radius equal to that of the midpoint of the X axis for the data when
@@ -22,19 +23,17 @@ module RunbyPace
           five_k_time = RunbyPace::PaceTime.new(five_k.to_s)
           pace_data = RunbyPace::PaceData.new(first_pace, last_pace, candidate_divisor)
           calculated_pace = pace_data.calc(five_k_time)
-          if !calculated_pace.almost_equals?(golden_pace, allowable_deviation)
+          unless calculated_pace.almost_equals?(golden_pace, allowable_deviation)
             viable_divisor = nil
             break
           end
           viable_divisor = candidate_divisor
         end
 
-        if !viable_divisor.nil?
-          viable_divisors << viable_divisor
-        end
+        viable_divisors << viable_divisor unless viable_divisor.nil?
       end
 
-      if !viable_divisors.empty?
+      unless viable_divisors.empty?
         # puts viable_divisors
         midpoint = (viable_divisors.length - 1) / 2
         return viable_divisors[midpoint]

data/lib/runby_pace/run_types/long_run.rb

@@ -1,5 +1,7 @@
 module RunbyPace
   module RunTypes
+    # Arguably one of the most important run types, the "long run" is harder than an "easy run", but easier than
+    #  a "distance run". It should remain conversational.
     class LongRun < RunType
       attr_reader :slow_pace_data, :fast_pace_data
 
@@ -18,6 +20,7 @@ module RunbyPace
         PaceRange.new(fast, slow)
       end
 
+      # Used in testing, contains hashes mapping 5K race times with the recommended pace-per-km for this run type.
       class GoldenPaces
         def self.fast
           { '14:00': '04:00', '15:00': '04:16', '20:00': '05:31', '25:00': '06:44', '30:00': '07:54', '35:00': '09:01', '40:00': '10:07', '42:00': '10:32' }

data/lib/runby_pace/run_types/slow_tempo_run.rb

@@ -2,6 +2,7 @@ require_relative 'tempo_run'
 
 module RunbyPace
   module RunTypes
+    # The "slow tempo" pace roughly equates to your marathon pace.
     class SlowTempoRun < TempoRun
       def description
         'Slow Tempo Run'

data/lib/runby_pace/run_types/tempo_run.rb

@@ -1,5 +1,6 @@
 module RunbyPace
   module RunTypes
+    # Combines the fast and slow tempo runs into one convenient range of paces
     class TempoRun < RunType
       attr_reader :slow_pace_data, :fast_pace_data
 
@@ -18,6 +19,7 @@ module RunbyPace
         PaceRange.new(fast, slow)
       end
 
+      # Used in testing, contains hashes mapping 5K race times with the recommended pace-per-km for this run type.
       class GoldenPaces
         def self.fast
           { '14:00': '03:07', '15:00': '03:20', '20:00': '04:21', '25:00': '05:20', '30:00': '06:19', '35:00': '07:16', '40:00': '08:12', '42:00': '08:35' }

data/lib/runby_pace/runby_range.rb

@@ -1,4 +1,5 @@
 module RunbyPace
+  # Base class for ranges of Runby data, e.g. PaceRange, SpeedRange, ...
   class RunbyRange
     attr_reader :fast, :slow
 

data/lib/runby_pace/speed_range.rb

@@ -1,6 +1,7 @@
 require_relative 'runby_range'
 
 module RunbyPace
+  # Represents a range of speeds, from fast to slow.
   class SpeedRange < RunbyRange
     def initialize(fast, slow)
       raise 'Invalid speed values' unless fast.is_a?(Numeric) && slow.is_a?(Numeric)
@@ -8,6 +9,7 @@ module RunbyPace
       @slow = slow.round(2)
     end
 
+    # Create a new speed range from an existing pace range.
     def self.from_pace_range(pace_range)
       fast = RunbyPace::RunMath.convert_pace_to_speed pace_range.fast
       slow = RunbyPace::RunMath.convert_pace_to_speed pace_range.slow

data/lib/runby_pace/version.rb

@@ -1,3 +1,3 @@
 module RunbyPace
-  VERSION = "0.2.#{`git rev-list --count HEAD`}"
+  VERSION = "0.2.#{`git rev-list --count HEAD`}".freeze
 end

data/runby_pace.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Ty Walls']
   spec.email         = ['tygerbytes@users.noreply.github.com']
 
-  spec.summary       = %q(Runby Pace is the core logic which simplifies the calculation of target paces used by track and distance runners.)
+  spec.summary       = 'Runby Pace is the core logic which simplifies the calculation of target paces used by track and distance runners.'
   spec.homepage      = 'https://github.com/tygerbytes/runby-pace'
   spec.license       = 'MIT'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runby_pace
 version: !ruby/object:Gem::Version
-  version: 0.2.72
+  version: 0.2.73
 platform: ruby
 authors:
 - Ty Walls
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -97,7 +97,7 @@ homepage: https://github.com/tygerbytes/runby-pace
 licenses:
 - MIT
 metadata:
-  commit-hash: 3bc041f857bfd2ebbfa92367f9f7ecd0a3502f4a
+  commit-hash: e0969155c9dce3802aaba44d908aa7e3efda7d17
 post_install_message: 
 rdoc_options: []
 require_paths: