physical-activity-recorder 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f9e41c3250cff321feb8fb316662143990c00c4
+  data.tar.gz: 63653632eab5ab579713b718bcdecea1fcceafcf
+SHA512:
+  metadata.gz: 1f5090c61230835334db7ebdab28194ac4cabe0a3f823b4088265da725561558cd3511cf886257b70bc0bef094db4ca3666c99364bcbd8ecac494d2bc52960e7
+  data.tar.gz: 412098950dc2cac286aeb170ddd03b6f5e26bdfe754a5d5102f6ec6b1f8a70a1a53e0f7637cec403cc262e8ea71a7702586e4811ef0d16a382b13b3a8b2b1461

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.idea/
+/.yardoc/
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+Gemfile.lock

data/.yardopts

@@ -0,0 +1,9 @@
+--readme README.md
+--charset utf-8
+--markup markdown
+--markup-provider redcarpet
+--default-return void
+--name-tag doctest
+--hide-tag doctest
+lib/*.rb lib/**/*.rb -
+*.md LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Before bundle 2.0, `:github` uses insecure `git` protocol.
+git_source(:github) do |repo_name|
+  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?("/")
+  "https://github.com/#{repo_name}.git"
+end
+
+# Specify your gem's dependencies in physical-activity-recorder-activity-recorder.gemspec
+gemspec
+
+# Need to use my branch of rubydoctest.
+gem 'rubydoctest', github: 'weakish/rubydoctest', branch: 'weakish'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jakukyo Friel
+
+MIT License
+
+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,150 @@
+# physical-activity-recorder
+
+`physical-activity-recorder` is a command line tool to record and plan physical activity.
+
+## Installation
+
+### Command line
+
+Install via `gem`:
+
+    ; gem install physical-activity-recorder
+
+You may add `sudo` before the above command to install it globally.
+
+You can also clone this repo and run `rake install`.
+
+### Library
+
+Although `physical-activity-recorder` is a command line tool,
+you can also use it as a library.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'physical-activity-recorder'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Command line usage
+
+### tl;tr
+
+```sh
+; physical-activity-recorder help
+Usage:
+            physical-activity-recorder moderate_minutes [vigorous_minutes, notes]
+            physical-activity-recorder query
+```
+
+### Walkthrough
+
+You do half an hour of running:
+
+```sh
+; physical-activity-recorder 0 30 'running'
+Soft: YYYY-MM-DD; Hard: YYYY-MM-DD
+```
+
+That is, it is best to exercise again before *Soft*.
+If you are a bit lazy, you can postpone it to before *Hard*.
+
+[United States Department of Agriculture](http://www.choosemyplate.gov/physical-activity/amount.html)
+recommends at least 2 hours and 30 minutes of moderate activity each week,
+and suggests 5 or more hours activity per week
+can provide even more health benefits.
+*Soft* and *Hard* are roughly calculated based on this.
+(There may be some slight differences for implement simplicity.)
+
+With vigorous activities, you get similar health benefits in half the time it takes you with moderate ones.
+
+There is a simple rule to distinguish moderate and vigorous activity:
+
+- When you do moderate activity, you cannot sing.
+- When you do vigorous activity, you cannot speak.
+
+See [What is Physical Activity?](http://www.choosemyplate.gov/physical-activity/what.html)
+for examples of moderate and vigorous activity.
+
+
+Say, next day you do 2 hours of walking briskly:
+
+```sh
+; physical-activity-recorder 120 0 'walking'
+Soft: YYYY-MM-DD; Hard: YYYY-MM-DD
+```
+
+You can omit notes if you only want to record time:
+
+```sh
+; physical-activity-recorder 120
+```
+
+This will extend *Soft* and *Hard*.
+
+Be aware:
+
+1.  If you exercise less than 10 minutes, it will be recorded but *Soft* and *Hard* will not be extended.
+    You'd better exercise more than 10 minutes at a time.
+2.  *Soft* and *Hard* won't exceed 7 days from now.
+    Dedicating several days to exercises does not mean you need no exercise for several weeks.
+
+You can query *Soft* and *Hard* via
+
+```sh
+; physical-activity-recorder query
+```
+
+or if you are lazy:
+
+```sh
+; physical-activity-recorder q
+```
+
+Exercising records are stored in:
+
+1. `PHYSICAL_ACTIVITY_RECORDS` if this environment varibale is set
+2. `physical-activity-recorder` under `$XDG_CONFIG_HOME` or `~/.config` otherwise
+
+The data store format is [Daybreak](http://propublica.github.io/daybreak/).
+
+## Library usage
+
+```ruby
+require `physical-activity-recorder`
+Physical_activity_recorder.func [arguments]
+```
+
+func is one of the following:
+
+- `record`
+- `add_to_records`
+- `plan`
+
+
+See [documentation](http://www.rubydoc.info/gems/physical-activity-recorder/) for more information.
+
+### Testing
+
+We use [RubyDoctest](http://rubygems.org/gems/rubydoctest) for testing.
+(Note that before my pull requests get merged, you need to use [my branch](https://github.com/weakish/rubydoctest/).)
+
+There is a rake task for it:
+
+```sh
+rake test
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/weakish/physical-activity-recorder/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Signing commits with gpg is optional, but preferred.

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler/gem_tasks'
+require 'rake/clean'
+
+
+task :default => :test
+
+desc 'Run doctests'
+task :test do
+  sh 'bundle exec rubydoctest lib/*.rb'
+end
+
+desc 'Generate docs'
+task('doc') { sh 'bundle exec yard doc' }
+CLEAN.include 'doc'
+

data/bin/physical-activity-recorder

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'physical-activity-recorder'
+require 'moneta'
+require 'xdg'
+
+SYNOPSIS = 'Usage:
+            physical-activity-recorder moderate_minutes [vigorous_minutes, notes]
+            physical-activity-recorder query'
+
+
+# getopts :: Hash
+def getopts
+    { current_time: Time.now,
+      moderate_minutes: ARGV[0].to_i,
+      vigorous_minutes:  ARGV[1].to_i || 0,
+      notes: ARGV[2] || '',
+    }
+end
+
+
+def record_activity(records, opts)
+  new_record = Physical_activity_recorder.record(opts[:current_time], opts[:moderate_minutes], opts[:vigorous_minutes], opts[:notes])
+  Physical_activity_recorder.add_to_records(new_record, records)
+end
+
+def plan_activity(ends, opts)
+  ends = Physical_activity_recorder.plan(opts[:current_time], ends[:soft], ends[:hard],
+                                         opts[:moderate_minutes], opts[:vigorous_minutes])
+end
+
+def main
+  if ARGV.length > 3
+    abort "ArgumentError\n\n#{SYNOPSIS}\n"
+  elsif ARGV[0] =~ /^[-h]/
+    puts SYNOPSIS
+  else
+      begin
+        opts = getopts
+
+        activity_records= XDG['CONFIG_HOME'].to_s + '/physical-activity-recorder'
+        moneta_store = ENV['PHYSICAL_ACTIVITY_RECORDS'] || activity_records
+        records = Moneta.new(:Daybreak, file: moneta_store)
+        ends = {}
+        ends[:soft] = records['soft_end'] || Time.now
+        ends[:hard] = records['hard_end'] || Time.now
+
+        if ARGV[0] =~ /^[0-9]/
+          record_activity(records, opts)
+
+          ends = plan_activity(ends, opts)
+          records['soft_end'] = ends[:soft]
+          records['hard_end'] = ends[:hard]
+        end
+      ensure
+        records.close
+        puts "Soft: #{ends[:soft].strftime('%F') }; Hard: #{ends[:hard].strftime('%F')}"
+      end
+  end
+end
+
+main

data/lib/physical-activity-recorder.rb

@@ -0,0 +1,143 @@
+require 'physical-activity-recorder/version'
+require 'time-lord'
+
+# Record and plan physical activity.
+# Usage:
+# ```ruby
+# require `physical-activity-recorder`
+# Physical_activity_recorder.func [arguments]
+# ```
+
+
+module Physical_activity_recorder
+
+  # @doctest prepare time
+  #   >> time = Time.at(1000000000)
+  #   => 2001-09-09 09:46:40 +0800
+
+  module_function
+
+  # Record physical activity.
+  #
+  # @param [Time]
+  # @param [Fixnum]
+  # @param [Fixnum]
+  # @param [String]
+  # @return [{String => (Fixnum, Fixnum, String)}]
+  #
+  # @doctest record
+  #   >> record = Physical_activity_recorder.method(:record)
+  #   >> record_1 = record[time, 50]
+  #   => {"2001-09-09" =>[50, 0, ""]}
+  #   >> record_2 = record[time, 180, 10]
+  #   => {"2001-09-09"=>[180, 10, ""]}
+  #   >> record_3 = record[time, 0, 2, 'running']
+  #   => {"2001-09-09"=>[0, 2, "running"]}
+   
+  def record(activity_time=Time.now, moderate_minutes=0, vigorous_minutes=0, activity_notes='')
+    {activity_time.strftime('%F') => [moderate_minutes, vigorous_minutes, activity_notes]}
+  end
+
+
+  # Add record.
+  #
+  # @param [{String => (Fixnum, Fixnum, String)}]
+  # @param [{String => (Fixnum, Fixnum, String)}]
+  # @return [void]
+  #
+  # @doctest prepare records
+  #   >> records = {"2001-01-01" =>[1, 2, ""]}
+  #   => {"2001-01-01"=>[1, 2, ""]}
+  #   >> add_to_records = Physical_activity_recorder.method(:add_to_records)
+  #
+  # @doctest do not add empty records
+  #   >> add_to_records[{"2011-01-01" =>[0, 0, "empty"]}, records]; records
+  #   => {"2001-01-01"=>[1, 2, ""]}
+  #
+  # @doctest add new record (nonexist date)
+  #   >> add_to_records[record_1, records]; records
+  #   => {"2001-01-01"=>[1, 2, ""], "2001-09-09"=>[50, 0, ""]}
+  #
+  # @doctest add new record (exist date)
+  #   >> add_to_records[record_2, records]; records
+  #   => {"2001-01-01"=>[1, 2, ""], "2001-09-09"=>[230, 10, ""]}
+  #   >> add_to_records[record_3, records]; records
+  #   => {"2001-01-01"=>[1, 2, ""], "2001-09-09"=>[230, 12, "running"]}
+
+  def add_to_records(new_record, records)
+    activity_time = new_record.keys[0]
+    if records.key?(activity_time)
+      old = records[activity_time]
+      new = (0..2).map do |i|
+        old[i] + new_record[activity_time][i]
+      end
+      records[activity_time] = new
+    # do not add empty records
+    elsif new_record[activity_time].first(2).reduce(:+) == 0
+      records
+    else
+      records[activity_time] = new_record[activity_time]
+    end
+  end
+
+
+  # Plan physical activity
+  #
+  # @param [Time]
+  # @param [Time]
+  # @param [Time]
+  # @param [Fixnum]
+  # @param [Fixnum]
+  # @return [{Symbol => Time}]
+  #
+  # @doctest first plan
+  #   >> time = Time.at(1000000000)
+  #   => 2001-09-09 09:46:40 +0800
+  #   >> plan = Physical_activity_recorder.method(:plan)
+  #   >> ends = plan[time, time, time, 30, 0]
+  #   => {:soft=>2001-09-10 00:46:40 +0800, :hard=>2001-09-10 15:46:40 +0800}
+  #
+  # @doctest second plan
+  #   >> plan[time, ends[:soft], ends[:hard], 180, 0]
+  #   => {:soft=>2001-09-13 18:46:40 +0800, :hard=>2001-09-16 09:46:40 +0800}
+  # @doctest plan within 7 days
+  #   >> plan[time, time, time, 2000, 0]
+  #   => {:soft=>2001-09-16 09:46:40 +0800, :hard=>2001-09-16 09:46:40 +0800}
+  #   >> plan[time, time, time, 3000, 3000]
+  #   => {:soft=>2001-09-16 09:46:40 +0800, :hard=>2001-09-16 09:46:40 +0800}
+
+  def plan(current_time=Time.now, current_soft_end=Time.now, current_hard_end=Time.now, moderate_minutes=0, vigorous_minutes=0)
+    # Activity should be done for at least 10 minutes at a time.
+    if moderate_minutes + vigorous_minutes < 10
+      hard_end = current_hard_end
+      soft_end = current_soft_end
+    else
+      # With vigorous activities, you get similar health benefits in half the time it takes you with moderate ones.
+      increment_time = moderate_minutes + vigorous_minutes * 2
+      # United States Department of Agriculture recommends at least 2 hours and 30 minutes each week
+      # of aerobic physical activity at a moderate level.
+      # 2 hours and 30 minutes is 150 (2 * 60 + 30) minutes per week,
+      # and we set the hard end based on 168 (24 * 7) minutes per week, i.e. 1 minute for 1 hour.
+      # I chose 168 for implement simplicity.
+      hard_end = current_hard_end + increment_time.hours
+
+      # United States Department of Agriculture suggests
+      # 5 or more hours activity per week can provide even more health benefits.
+      # 5 hours is  300 (5 * 60) minutes per week,
+      # and we set the soft end based on 336 (24 * 7 * 2) minutes per week, i.e. 2 minutes for 1 hour.
+      # Again, I chose 336 for  implement simplicity.
+      soft_end = current_soft_end + (increment_time / 2).to_i.hours
+    end
+
+    # soft end and hard end should not exceed 7 days (1 week).
+    result = {soft: soft_end, hard: hard_end}
+    result.each do |k, v|
+      result[k] = if v  - current_time < 7.days
+            v
+          else
+            current_time + 7.days
+          end
+    end
+    result
+  end
+end

data/lib/physical-activity-recorder/version.rb

@@ -0,0 +1,3 @@
+module Physical_activity_recorder
+  VERSION = '0.0.1'
+end

data/physical-activity-recorder.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'physical-activity-recorder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'physical-activity-recorder'
+  spec.version       = Physical_activity_recorder::VERSION
+  spec.authors       = ['Jakukyo Friel']
+  spec.email         = ['weakish@gmail.com']
+  spec.summary       = %q{Record and plan your physical activity.}
+  spec.description   = %q{Record and plan your physical activity at moderate and vigorous levels.}
+  spec.homepage      = 'https://github.com/weakish/physical-activity-recorder'
+  spec.license       = 'MIT'
+
+  spec.metadata      = {
+                        'repository' => 'https://github.com/weakish/physical-activity-recorder',
+                        'documentation' => 'http://www.rubydoc.info/gems/physical-activity-recorder/',
+                        'issues' => 'https://github.com/weakish/physical-activity-recorder/issues/',
+                        'wiki' => 'https://github.com/weakish/physical-activity-recorder/wiki/',
+                       }
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.bindir        = 'bin'
+
+
+  spec.add_runtime_dependency 'time-lord', '~> 1.0'
+  spec.add_runtime_dependency 'moneta', '~> 0.8'
+  spec.add_runtime_dependency 'daybreak', '~> 0.3'
+  spec.add_runtime_dependency 'xdg', '~> 2.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'redcarpet', '~> 3.2'
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: physical-activity-recorder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jakukyo Friel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: time-lord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: moneta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: daybreak
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: xdg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Record and plan your physical activity at moderate and vigorous levels.
+email:
+- weakish@gmail.com
+executables:
+- physical-activity-recorder
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/physical-activity-recorder
+- lib/physical-activity-recorder.rb
+- lib/physical-activity-recorder/version.rb
+- physical-activity-recorder.gemspec
+homepage: https://github.com/weakish/physical-activity-recorder
+licenses:
+- MIT
+metadata:
+  repository: https://github.com/weakish/physical-activity-recorder
+  documentation: http://www.rubydoc.info/gems/physical-activity-recorder/
+  issues: https://github.com/weakish/physical-activity-recorder/issues/
+  wiki: https://github.com/weakish/physical-activity-recorder/wiki/
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Record and plan your physical activity.
+test_files: []
+has_rdoc: