runby_pace 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77f387051e46c4f6f78a9b473bd489481138c165
+  data.tar.gz: e8f3e809926fac438a1101500600f67818d94e22
+SHA512:
+  metadata.gz: 85f384bccd0ffc9db3aef47f13bff41a0f0134227020eaf65647b33d07188fe9da17ec4c497f383266f5586b5a0395870c6129695af8adeedbbbaa3f2726c539
+  data.tar.gz: 042add614397d1516a5c25a2301011396d04c218b7cd4b5d8544e08a29601736ebd16e912fd1e845279b1dfb33f142cca4f0b29d00f85badd024e3751eb482d4

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem 'coveralls', require: false
+end
+
+group :development, :test do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'rb-notifu'
+end
+
+# Specify your gem's dependencies in runby_pace.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,72 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+
+  notification :notifu, time: 5, nosound: true, xp: true
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ty Walls
+
+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

@@ -0,0 +1,55 @@
+# RunbyPace
+
+RunbyPace contains the core logic for calculating the target "paces" used by runners. By "runners" I mean  the common
+ humanoid biped variety, complete with oscillating appendages and prolific perspiration. :)
+
+| | |
+| --- | --- |
+| **Build** | [![Build Status](https://travis-ci.org/tygerbytes/runby-pace.svg?branch=master)](https://travis-ci.org/tygerbytes/runby-pace) |
+| **Coverage** | [![Coverage Status](https://coveralls.io/repos/github/tygerbytes/runby-pace/badge.svg?branch=master)](https://coveralls.io/github/tygerbytes/runby-pace?branch=master) |
+
+Any sort of running program will include runs at varying paces, easy runs, distance runs, tempo runs, long runs, and
+ then the gambit of "interval" type runs, such as 1500m pace repetitions, 5K and 10K pace reps, cruise intervals, and
+ so on. Many runners typically consult pace tables based on their most recent time for a 5K race. So assuming your most
+ recent 5K time was 20 minutes, and you're supposed to run a "long run", you find your most recent 5K time in the
+ Long Run table, and it tells you that you should try to maintain a pace of 5:30-6:19 minutes per kilometer.
+
+So this is great, but a little tedious. RunbyPace automates this whole process by calculating all of the paces for you.
+ All you need is your current 5K time and some Ruby, and you're off running at just the right pace.
+
+Note that this project is currently being developed, so the gem doesn't even exist yet. Coming soon!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'runby_pace'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install runby_pace
+
+## Usage
+
+TODO: Coming soon... When the class interfaces are fleshed out.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tygerbytes/runby-pace.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/_guard-core

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "_guard-core")

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'runby_pace'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("guard", "guard")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/runby_pace/pace_data.rb

@@ -0,0 +1,69 @@
+module RunbyPace
+
+  class PaceData
+
+    # The number of data points plotted on our line of 5K times.
+    #  We take 5K times from 14:00 to 42:00 with a sample rate
+    #  of 30 seconds, and out pops 57.
+    DATA_POINTS_COUNT = 57
+
+    # The midpoint along the X axis of our pace data "graph"
+    MIDPOINT_X = 28
+
+    # The fastest pace within the run type data set.
+    #  Given a personal record of 14 minutes for a 5K race,
+    #  this is the prescribed pace for this run type.
+    attr_reader :fastest_pace_km
+
+    # The slowest pace for the run type data set.
+    #  Given a personal record of 42 minutes for a 5K race,
+    #  this is the prescribed pace for this run type.
+    attr_reader :slowest_pace_km
+
+    # For maximum flexibility, we assume the radius of the curve
+    #  of the pace data to be equal to the X axis midpoint, a perfect circle.
+    #  Use the midpoint_radius_divisor to reduce the height of the curve
+    #  until it matches that of the data. (See #curve_minutes)
+    attr_reader :midpoint_radius_divisor
+
+    def initialize(fastest_pace_km, slowest_pace_km, midpoint_radius_divisor)
+      @fastest_pace_km = RunbyPace::PaceTime.new(fastest_pace_km)
+      @slowest_pace_km = RunbyPace::PaceTime.new(slowest_pace_km)
+      @midpoint_radius_divisor = midpoint_radius_divisor
+    end
+
+    # Calculate the slope of the line between the fastest and slowest paces
+    def slope
+      (@slowest_pace_km.total_minutes - @fastest_pace_km.total_minutes) / (DATA_POINTS_COUNT - 1)
+    end
+
+    # Calculate the prescribed pace for the given 5K time
+    def calc(five_k_time)
+      five_k_time = RunbyPace::PaceTime.new(five_k_time)
+      x2 = ((five_k_time.total_minutes * 2) - (MIDPOINT_X - 1)) - 1
+      RunbyPace::PaceTime.from_minutes(slope * x2 + @fastest_pace_km.total_minutes + curve_minutes(x2))
+    end
+
+    private
+
+    # Since the paces for each 5K time do not progress in a straight line
+    #  when plotted on a graph, but rather a curve with its highest point near
+    #  the center, we must add some seconds to the calculated time depending on
+    #  where we are on the line.
+    # Paces near the start and end of the line need little to no time added,
+    #  whereas paces near the middle need the most time added.
+    # The default curve radius is the same as the midpoint of the X axis,
+    #  forming a circle. Use #midpoint_radius_divisor to reduce it's size.
+    def curve_minutes(x_axis)
+      return 0 if @midpoint_radius_divisor == 0
+      midpoint_reduction = x_axis
+      midpoint = MIDPOINT_X
+      if midpoint_reduction > midpoint
+        midpoint_reduction = midpoint - (midpoint_reduction - midpoint)
+        midpoint_reduction = 0 if midpoint_reduction < 0
+      end
+      # TODO: Use an actual curve instead of a triangle to calculate the number of minutes to add.
+      midpoint_reduction / @midpoint_radius_divisor / 60
+    end
+  end
+end

data/lib/runby_pace/pace_range.rb

@@ -0,0 +1,15 @@
+module RunbyPace
+
+  class PaceRange
+    attr_reader :fast, :slow
+
+    def initialize(fast, slow)
+      @fast = RunbyPace::PaceTime.new(fast)
+      @slow = RunbyPace::PaceTime.new(slow)
+    end
+
+    def to_s
+      "#{@fast}-#{@slow}"
+    end
+  end
+end

data/lib/runby_pace/pace_time.rb

@@ -0,0 +1,102 @@
+module RunbyPace
+
+  class PaceTime
+    attr_reader :time_s, :minutes_part, :seconds_part
+
+    def initialize(time)
+      if time.is_a?(String) || time.is_a?(Symbol)
+        init_from_string(time)
+      elsif time.is_a?(PaceTime)
+        init_from_clone(time)
+      end
+    end
+
+    # @param [numeric] total_seconds
+    def self.from_seconds(total_seconds)
+      minutes = total_seconds.abs.to_i / 60
+      seconds = total_seconds.abs.to_i % 60
+      PaceTime.new("#{'%02d' % minutes}:#{'%02d' % seconds}")
+    end
+
+    # @param [numeric] total_minutes
+    def self.from_minutes(total_minutes)
+      self.from_seconds(total_minutes * 60.0)
+    end
+
+    def to_s
+      @time_s
+    end
+
+    def total_seconds
+      @minutes_part * 60 + @seconds_part
+    end
+
+    def total_minutes
+      @minutes_part + (@seconds_part / 60.0)
+    end
+
+    # @param [PaceTime] value
+    def -(value)
+      if value.is_a?(PaceTime)
+        PaceTime.from_seconds(total_seconds - value.total_seconds)
+      end
+    end
+
+    # @param [PaceTime] value
+    def +(value)
+      if value.is_a?(PaceTime)
+        PaceTime.from_seconds(total_seconds + value.total_seconds)
+      end
+    end
+
+    def ==(value)
+      if value.is_a?(PaceTime)
+        total_seconds == value.total_seconds
+      elsif value.is_a?(String)
+        @time_s == value
+      end
+    end
+
+    def >(value)
+      if value.is_a?(PaceTime)
+        total_seconds > value.total_seconds
+      end
+    end
+
+    def >=(value)
+      if value.is_a?(PaceTime)
+        total_seconds >= value.total_seconds
+      end
+    end
+
+    def <(value)
+      if value.is_a?(PaceTime)
+        total_seconds < value.total_seconds
+      end
+    end
+
+    def <=(value)
+      if value.is_a?(PaceTime)
+        total_seconds <= value.total_seconds
+      end
+    end
+
+    private
+
+    def init_from_string(time)
+      raise 'Invalid time format' if !time.match(/(-)?\d\d:\d\d/)
+      @time_s = time.to_s
+      parts = time.to_s.split(':')
+      @minutes_part = parts[0].to_i
+      @seconds_part = parts[1].to_i
+      raise 'Seconds must be less than 60' if @seconds_part.abs > 59
+    end
+
+    # @param [PaceTime] time
+    def init_from_clone(time)
+      @time_s = time.time_s
+      @minutes_part = time.minutes_part
+      @seconds_part = time.seconds_part
+    end
+  end
+end

data/lib/runby_pace/run_type.rb

@@ -0,0 +1,7 @@
+module RunbyPace
+
+  class RunType
+    def pace(five_k_time)
+    end
+  end
+end

data/lib/runby_pace/run_types/long_run.rb

@@ -0,0 +1,20 @@
+module RunbyPace
+
+  module RunTypes
+
+    class LongRun < RunType
+      attr_reader :slow_pace_data, :fast_pace_data
+
+      def initialize
+        @slow_pace_data = PaceData.new('04:39', '11:53', 1.55)
+        @fast_pace_data = PaceData.new('04:00', '10:32', 1.99)
+      end
+
+      def pace(five_k_time)
+        fast = @fast_pace_data.calc(five_k_time)
+        slow = @slow_pace_data.calc(five_k_time)
+        PaceRange.new(fast, slow)
+      end
+    end
+  end
+end

data/lib/runby_pace/version.rb

@@ -0,0 +1,3 @@
+module RunbyPace
+  VERSION = '0.2.0'
+end

data/lib/runby_pace.rb

@@ -0,0 +1,7 @@
+
+require 'runby_pace/version'
+Dir[File.dirname(__FILE__) + '/runby_pace/*.rb'].each { |file| require file }
+Dir[File.dirname(__FILE__) + '/runby_pace/run_types/*.rb'].each { |file| require file }
+
+module RunbyPace
+end

data/runby_pace.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'runby_pace/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'runby_pace'
+  spec.version       = RunbyPace::VERSION
+  spec.authors       = ['Ty Walls']
+  spec.email         = ['tygerbytes@users.noreply.github.com']
+
+  spec.summary       = %q{Runby Pace is the core logic which simplifies the calculation target paces used by track and distance runners.}
+  spec.homepage      = 'https://github.com/tygerbytes/runby-pace'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: runby_pace
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Ty Walls
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- tygerbytes@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/_guard-core
+- bin/console
+- bin/guard
+- bin/setup
+- lib/runby_pace.rb
+- lib/runby_pace/pace_data.rb
+- lib/runby_pace/pace_range.rb
+- lib/runby_pace/pace_time.rb
+- lib/runby_pace/run_type.rb
+- lib/runby_pace/run_types/long_run.rb
+- lib/runby_pace/version.rb
+- runby_pace.gemspec
+homepage: https://github.com/tygerbytes/runby-pace
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Runby Pace is the core logic which simplifies the calculation target paces
+  used by track and distance runners.
+test_files: []