nutrition_calculator 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb7c8df58d699d0f69ba05ba196c2ffe55f1976e
+  data.tar.gz: d3185d82f8c2dd202a37a6e17e5ce4a05978840b
+SHA512:
+  metadata.gz: b1e6934c01fe8b9586d8b6e2bb88d9d7400f2fe8f1993eac742f19beb7014ea17ef694cb91705c6ddac4280f64306cc2fc2abca551e44b3d3dd2a5c8b7c8409a
+  data.tar.gz: e195e994cb4700b66cbb827ab32f6578b88f113a3884c6e4f120139fc92de83f0f6d5ba2994cd08f57bc523d6cb5cbdccd22c90a49d2e6cd714673a6780ea3fc

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nutrition_calculator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 John Wilger
+
+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,33 @@
+# NutritionCalculator
+
+NutritionCalculator provides a set of core libraries to help track a
+person's individual nutritional goals. It is meant to aid in both
+weight-management and monitoring the nutritional balance of a diet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nutrition_calculator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nutrition_calculator
+
+## Usage
+
+See {NutritionCalculator::CalorieBudgeter}
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/nutrition_calculator/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

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "cucumber/rake/task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Run all cucumber features"
+task :features => 'features:default'
+
+namespace :features do
+  task :default => %w(wip ok)
+
+  Cucumber::Rake::Task.new(:wip) do |t|
+    t.cucumber_opts = "-t @wip"
+  end
+
+  Cucumber::Rake::Task.new(:ok) do |t|
+    t.cucumber_opts = "-t ~@wip -t ~@pending -q --format progress"
+  end
+end
+
+task :default => %w(spec features)
+

data/features/calorie_budgeter.feature

@@ -0,0 +1,181 @@
+Feature: Calculate Remaining Daily Calories
+
+  So that I know how much more I should eat today in order to hit my weekly calorie goal,
+  As a dieter,
+  I want to see my remaining calories for the day, taking into account what I have already consumed this week
+
+  Scenario Outline: Maintain Weight
+    Given my RMR is <daily_rmr> calories per day
+    And my weekly calorie goal is <weekly_goal> calories
+    And I have consumed <prev_days_cal> net calories on prior days this week
+    And it is the <day> day of the week
+    And I have consumed <consumed> calories today
+    And I have burned <burned> calories with exercise today
+
+    When I calculate my remaining calories for the day
+
+    Then I see that my net calorie consumption for the day is <net>
+    And I see that I should consume <remaining> more calories today
+    And I see that I should burn <to_burn> more calories by exercising today
+
+    Examples: RMR 1500
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      1500 |       10500 |             0 | 1st |        0 |      0 |    0 |      1500 |       0 |
+      |      1500 |       10500 |             0 | 1st |      500 |      0 |  500 |      1000 |       0 |
+      |      1500 |       10500 |             0 | 1st |     1500 |      0 | 1500 |         0 |       0 |
+      |      1500 |       10500 |             0 | 1st |     1501 |      0 | 1501 |         0 |       1 |
+
+    Examples: RMR 1500 - with exercise
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      1500 |       10500 |             0 | 1st |        0 |    100 | -100 |      1600 |       0 |
+      |      1500 |       10500 |             0 | 1st |      500 |    100 |  400 |      1100 |       0 |
+      |      1500 |       10500 |             0 | 1st |     1600 |    100 | 1500 |         0 |       0 |
+      |      1500 |       10500 |             0 | 1st |     1601 |    100 | 1501 |         0 |       1 |
+
+    Examples: RMR 1500 - 2nd day of week
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      1500 |       10500 |          1500 | 2nd |        0 |      0 |    0 |      1500 |       0 |
+      |      1500 |       10500 |          1503 | 2nd |        0 |      0 |    0 |      1500 |       0 |
+      |      1500 |       10500 |          1504 | 2nd |        0 |      0 |    0 |      1500 |       1 |
+      |      1500 |       10500 |          1504 | 2nd |      500 |    100 |  400 |      1099 |       0 |
+      |      1500 |       10500 |          1504 | 2nd |     1500 |      0 | 1500 |         0 |       1 |
+      |      1500 |       10500 |          1504 | 2nd |     1600 |    100 | 1500 |         0 |       1 |
+
+    Examples: RMR 2000
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       14000 |             0 | 1st |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |             0 | 1st |      500 |      0 |  500 |      1500 |       0 |
+      |      2000 |       14000 |             0 | 1st |     2000 |      0 | 2000 |         0 |       0 |
+      |      2000 |       14000 |             0 | 1st |     2001 |      0 | 2001 |         0 |       1 |
+
+    Examples: RMR 2000 - with exercise
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       14000 |             0 | 1st |        0 |    100 | -100 |      2100 |       0 |
+      |      2000 |       14000 |             0 | 1st |      500 |    100 |  400 |      1600 |       0 |
+      |      2000 |       14000 |             0 | 1st |     2100 |    100 | 2000 |         0 |       0 |
+      |      2000 |       14000 |             0 | 1st |     2101 |    100 | 2001 |         0 |       1 |
+
+    Examples: RMR 2000 - 2nd day of week
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       14000 |          1997 | 2nd |        0 |      0 |    0 |      2001 |       0 |
+      |      2000 |       14000 |          1998 | 2nd |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |          2000 | 2nd |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |          2003 | 2nd |        0 |      0 |    0 |      2000 |       0 |
+      # must consume at lease RMR every day and you should exercise off the overage
+      |      2000 |       14000 |          2004 | 2nd |        0 |      0 |    0 |      2000 |       1 |
+      |      2000 |       14000 |          2004 | 2nd |      500 |    100 |  400 |      1599 |       0 |
+      |      2000 |       14000 |          2004 | 2nd |     2000 |      0 | 2000 |         0 |       1 |
+      |      2000 |       14000 |          2004 | 2nd |     2100 |    100 | 2000 |         0 |       1 |
+
+    Examples: 3rd day of week
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       14000 |          3997 | 3rd |        0 |      0 |    0 |      2001 |       0 |
+      |      2000 |       14000 |          3998 | 3rd |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |          4000 | 3rd |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |          4002 | 3rd |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |          4003 | 3rd |        0 |      0 |    0 |      2000 |       1 |
+
+    Examples: 4th day of week
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       14000 |          5998 | 4th |        0 |      0 |    0 |      2001 |       0 |
+      |      2000 |       14000 |          5999 | 4th |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |          6000 | 4th |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |          6002 | 4th |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |          6003 | 4th |        0 |      0 |    0 |      2000 |       1 |
+
+    Examples: 5th day of week
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       14000 |          7998 | 5th |        0 |      0 |    0 |      2001 |       0 |
+      |      2000 |       14000 |          7999 | 5th |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |          8000 | 5th |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |          8001 | 5th |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |          8002 | 5th |        0 |      0 |    0 |      2000 |       1 |
+
+    Examples: 6th day of week
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       14000 |          9997 | 6th |        0 |      0 |    0 |      2002 |       0 |
+      |      2000 |       14000 |          9998 | 6th |        0 |      0 |    0 |      2001 |       0 |
+      |      2000 |       14000 |          9999 | 6th |        0 |      0 |    0 |      2001 |       0 |
+      |      2000 |       14000 |         10000 | 6th |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |         10001 | 6th |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |         10002 | 6th |        0 |      0 |    0 |      2000 |       1 |
+
+    Examples: 7th day of week
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       14000 |         11999 | 7th |        0 |      0 |    0 |      2001 |       0 |
+      |      2000 |       14000 |         12000 | 7th |        0 |      0 |    0 |      2000 |       0 |
+      |      2000 |       14000 |         12001 | 7th |        0 |      0 |    0 |      2000 |       1 |
+
+  Scenario Outline: Lose Weight - must consume at least RMR daily
+    Given my RMR is <daily_rmr> calories per day
+    And my weekly calorie goal is <weekly_goal> calories
+    And I have consumed <prev_days_cal> net calories on prior days this week
+    And it is the <day> day of the week
+    And I have consumed <consumed> calories today
+    And I have burned <burned> calories with exercise today
+
+    When I calculate my remaining calories for the day
+
+    Then I see that my net calorie consumption for the day is <net>
+    And I see that I should consume <remaining> more calories today
+    And I see that I should burn <to_burn> more calories by exercising today
+
+    Examples: RMR 2000
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       10500 |             0 | 1st |        0 |      0 |    0 |      2000 |     500 |
+      |      2000 |       10500 |             0 | 1st |      500 |      0 |  500 |      1500 |     500 |
+      |      2000 |       10500 |             0 | 1st |     2000 |      0 | 2000 |         0 |     500 |
+      |      2000 |       10500 |             0 | 1st |     2001 |      0 | 2001 |         0 |     501 |
+
+    Examples: RMR 2000 - with exercise
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       10500 |             0 | 1st |        0 |    100 | -100 |      2000 |     400 |
+      |      2000 |       10500 |             0 | 1st |      500 |    100 |  400 |      1500 |     400 |
+      |      2000 |       10500 |             0 | 1st |     2100 |    100 | 2000 |         0 |     500 |
+      |      2000 |       10500 |             0 | 1st |     2101 |    100 | 2001 |         0 |     501 |
+      |      2000 |       10500 |             0 | 1st |     2000 |    500 | 1500 |         0 |       0 |
+      |      2000 |       10500 |             0 | 1st |        0 |    500 | -500 |      2000 |       0 |
+
+    Examples: 3rd day of week
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       10500 |          3000 | 3rd |        0 |      0 |    0 |      2000 |     500 |
+      |      2000 |       10500 |          3997 | 3rd |        0 |      0 |    0 |      2000 |     699 |
+      |      2000 |       10500 |          3998 | 3rd |        0 |      0 |    0 |      2000 |     700 |
+      |      2000 |       10500 |          4000 | 3rd |        0 |      0 |    0 |      2000 |     700 |
+      |      2000 |       10500 |          4002 | 3rd |        0 |      0 |    0 |      2000 |     700 |
+      |      2000 |       10500 |          4003 | 3rd |        0 |      0 |    0 |      2000 |     701 |
+      |      2000 |       10500 |          4000 | 3rd |     2000 |      0 | 2000 |         0 |     700 |
+      |      2000 |       10500 |          4000 | 3rd |     2000 |    700 | 1300 |         0 |       0 |
+
+  Scenario Outline: Gain Weight
+    Given my RMR is <daily_rmr> calories per day
+    And my weekly calorie goal is <weekly_goal> calories
+    And I have consumed <prev_days_cal> net calories on prior days this week
+    And it is the <day> day of the week
+    And I have consumed <consumed> calories today
+    And I have burned <burned> calories with exercise today
+
+    When I calculate my remaining calories for the day
+
+    Then I see that my net calorie consumption for the day is <net>
+    And I see that I should consume <remaining> more calories today
+    And I see that I should burn <to_burn> more calories by exercising today
+
+    Examples: RMR 2000
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       17500 |             0 | 1st |        0 |      0 |    0 |      2500 |       0 |
+      |      2000 |       17500 |             0 | 1st |      500 |      0 |  500 |      2000 |       0 |
+      |      2000 |       17500 |             0 | 1st |     2500 |      0 | 2500 |         0 |       0 |
+      |      2000 |       17500 |             0 | 1st |     2501 |      0 | 2501 |         0 |       1 |
+
+    Examples: RMR 2000 - with exercise
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       17500 |             0 | 1st |        0 |    500 | -500 |      3000 |       0 |
+      |      2000 |       17500 |             0 | 1st |     2500 |    500 | 2000 |       500 |       0 |
+      |      2000 |       17500 |             0 | 1st |     3001 |    500 | 2501 |         0 |       1 |
+
+    Examples: 3rd day of week
+      | daily_rmr | weekly_goal | prev_days_cal | day | consumed | burned |  net | remaining | to_burn |
+      |      2000 |       17500 |          4997 | 3rd |        0 |      0 |    0 |      2501 |       0 |
+      |      2000 |       17500 |          5000 | 3rd |        0 |      0 |    0 |      2500 |       0 |
+      |      2000 |       17500 |          5003 | 3rd |        0 |      0 |    0 |      2499 |       0 |

data/features/step_definitions/calorie_budgeter_steps.rb

@@ -0,0 +1,39 @@
+Given(/^my RMR is (\d+) calories per day$/) do |rmr|
+  inputs.resting_metabolic_rate = rmr.to_i
+end
+
+Given(/^my weekly calorie goal is (\d+) calories$/) do |cals|
+  inputs.weekly_calorie_goal = cals.to_i
+end
+
+Given(/^I have consumed (\d+) net calories on prior days this week$/) do |cals|
+  inputs.prior_days_calories = cals.to_i
+end
+
+Given(/^it is the (\d+)(st|nd|rd|th) day of the week$/) do |day, _|
+  inputs.current_day_of_week = day.to_i
+end
+
+Given(/^I have consumed (\d+) calories today$/) do |cals|
+  inputs.calories_consumed = cals.to_i
+end
+
+Given(/^I have burned (\d+) calories with exercise today$/) do |cals|
+  inputs.calories_burned = cals.to_i
+end
+
+When(/^I calculate my remaining calories for the day$/) do
+  calculate_remaining_calories
+end
+
+Then(/^I see that my net calorie consumption for the day is (\-?\d+)$/) do |cals|
+  expect(outputs.net_calorie_consumption).to eq cals.to_i
+end
+
+Then(/^I see that I should consume (\d+) more calories today$/) do |cals|
+  expect(outputs.calories_remaining).to eq cals.to_i
+end
+
+Then(/^I see that I should burn (\d+) more calories by exercising today$/) do |cals|
+  expect(outputs.exercise_calories_remaining).to eq cals.to_i
+end

data/features/support/helper_methods.rb

@@ -0,0 +1,18 @@
+require 'nutrition_calculator/calorie_budgeter'
+
+def inputs
+  @inputs ||= NutritionCalculator::CalorieBudgeter.new
+end
+
+def calculate_remaining_calories
+  # Uncomment the following line if you need debugging output
+  # inputs.logger = logger
+end
+
+def outputs
+  inputs
+end
+
+def logger
+  Logger.new(STDERR)
+end

data/lib/nutrition_calculator/cached_outputs_with_recalculation.rb

@@ -0,0 +1,126 @@
+require 'nutrition_calculator/has_logging'
+
+module NutritionCalculator
+
+  # Define an object that turns inputs into outputs. With Caching! And Logging!
+  #
+  # @example
+  #   class Foo
+  #     extend NutritionCalculator::CachedOutputsWithRecalculation
+  #
+  #     def_input :bar
+  #
+  #     def_output :baz do
+  #       bar.expensive_operation
+  #     end
+  #   end
+  #
+  #   x = Foo.new
+  #
+  #   x.baz
+  #   #=> Raises a RuntimeError because input bar was not set
+  #
+  #   a_thing = ExpensiveObject.new
+  #
+  #   x.bar = a_thing
+  #   x.baz
+  #   #=> result of `a_thing.expensive_operation`
+  #
+  #   # `a_thing.expensive_operation` will not be called again
+  #   x.baz
+  #   #=> cached result of `a_thing.expensive_operation`
+  #
+  #   # `a_thing.expensive_operation` will be called again since input is
+  #   # reassigned
+  #   x.bar = a_thing
+  #   x.baz
+  #   #=> result of `a_thing.expensive_operation`
+  #
+  module CachedOutputsWithRecalculation
+    # @private
+    def self.extended(other)
+      other.include(InstanceMethods)
+    end
+
+    # Defines accessors for the named attribute
+    #
+    # Assignment to the named accessor will cause all cached results to be
+    # recalculated the next time they are called.
+    #
+    # @param name [Symbol]
+    def def_input(name)
+      def_input_writer name
+      def_input_reader name
+    end
+
+    # Defines attribute reader methods for the specified calculation
+    #
+    # The result of the block is cached as long as no inputs are re-assigned
+    # after the attribute reader is called. Additionaly, if `#logger` is set,
+    # the result of the calculation will be sent to the DEBUG log when the block
+    # is run.
+    #
+    # @param name [Symbol]
+    # @param block [Proc] will be `instance_eval`ed in the Object as though it
+    #                     were the body of a regular method
+    def def_output(name, &block)
+      define_method(name) do
+        cache_and_debug(name, &block)
+      end
+    end
+
+    private
+
+    def def_input_writer(name)
+      define_method("#{name}=") do |value|
+        recalculate!
+        instance_variable_set("@#{name}", value)
+      end
+    end
+
+    def def_input_reader(name)
+      define_method(name) do
+        require_input name
+        instance_variable_get("@#{name}")
+      end
+    end
+
+    module InstanceMethods
+      include HasLogging
+
+      private
+
+      def cached_values
+        @cached_values ||= {}
+      end
+
+      def recalculate!
+        logger.debug "Input received; clearing cached calculations."
+        @cached_values = {}
+      end
+
+      def cache(name, &block)
+        cached_values.fetch(name) do
+          cached_values[name] = block.call
+        end
+      end
+
+      def require_input(name)
+        unless instance_variable_defined?("@#{name}")
+          raise RuntimeError, "Required input missing: `#{name}`."
+        end
+      end
+
+      def cache_and_debug(name, &block)
+        cache(name) do
+          run_and_debug(name, &block)
+        end
+      end
+
+      def run_and_debug(name, &block)
+        debug_value(name) { instance_eval &block }
+      end
+    end
+    private_constant :InstanceMethods
+  end
+end

data/lib/nutrition_calculator/calorie_budgeter.rb

@@ -0,0 +1,158 @@
+require 'nutrition_calculator/cached_outputs_with_recalculation'
+
+module NutritionCalculator
+  # Calculates Calorie Budget Per Day in Weekly Context
+  #
+  # The `NutritionCalculator::CalorieBudgeter` is used to determine how many
+  # calories you need to consume and how many calories you need to burn via
+  # exercise for a given day in order to stay on target with your diet. In
+  # particular, it ensures that you consume at least enough to satisfy your
+  # resting metabolic rate each day, even if that means you need to burn off
+  # calories via exercise to keep on track. It operates on a weekly basis,
+  # so if you are over-/under-budget on a given day, the goals for the
+  # remainder of the week will be adjusted accordingly.
+  # 
+  # @example
+  #   cb = NutritionCalculator::CalorieBudgeter.new
+  #   
+  #   cb.resting_metabolic_rate = 2_000 # calories per day
+  #   cb.weekly_calorie_goal = 10_500 # creates an average deficit of 500 calories/day
+  #   cb.current_day_of_week = 3 # if your week starts on Monday, this would be Wednesday
+  #   cb.prior_days_calories = 3_524 # net calories from Monday and Tuesday
+  #   
+  #   cb.calories_consumed = 0
+  #   cb.calories_burned = 0
+  #   
+  #   cb.calories_remaining
+  #   #=> 2_000 
+  #   
+  #   cb.exercise_calories_remaining
+  #   #=> 605
+  #   
+  #   cb.calories_consumed = 681 # total calories consumed today
+  #   cb.calories_burned = 1752
+  #   
+  #   cb.calories_remaining
+  #   #=> 2_466
+  #   
+  #   cb.exercise_calories_remaining
+  #   #=> 0
+  class CalorieBudgeter
+    extend CachedOutputsWithRecalculation
+
+    # @!group Inputs
+
+    # @!attribute
+    # @return [Integer] The daily resting metabolic rate in calories
+    def_input :resting_metabolic_rate
+
+    # @!attribute
+    # @return [Integer] The total net calories (consumed - burned) planned for
+    #                   the week
+    def_input :weekly_calorie_goal
+
+    # @!attribute
+    # @return [Integer] The total net calories from all days this week prior
+    #                   to the current day
+    # @example
+    #   If it is currently Wednesday
+    #   And on Monday you consumed 100 calories and burned 75 for a net of 25
+    #   And on Tuesday you consumed 200 calories and burned 100 for a net of 100
+    #   Then you don't care about today's calories
+    #   And the value for this input should be 125 (Monday + Tuesday)
+    def_input :prior_days_calories
+
+    # @!attribute
+    # @return [Integer] The number of the day of the week
+    # @example If you start your week on Monday
+    #   1 - Monday
+    #   2 - Tuesday
+    #   3 - Wednesday
+    #   4 - Thursday
+    #   5 - Friday
+    #   6 - Saturday
+    #   7 - Sunday
+    def_input :current_day_of_week
+
+    # @!attribute
+    # @return [Integer] The total number of calories consumed today
+    def_input :calories_consumed
+
+    # @!attribute
+    # @return [Integer] The total number of calories burned via exercise today
+    def_input :calories_burned
+
+    # @!group Outputs
+
+    # @!attribute [r]
+    # @return [Integer] The net calories for the day (consumed - burned via
+    #                   exercise)
+    def_output :net_calorie_consumption do
+      calories_consumed - calories_burned
+    end
+
+    # @!attribute [r]
+    # @return [Integer] The number of calories remaining to consume today
+    def_output :calories_remaining do
+      [0, remaining_to_target].max
+    end
+
+    # @!attribute [r]
+    # @return [Integer] The number of calories that must still be burned today
+    #                   in order to meet the daily calorie goal
+    def_output :exercise_calories_remaining do
+      [0, predicted_overage].max
+    end
+
+    # @!attribute [r]
+    # @return [Integer] The number of calories that will likely be consumed
+    #                   today (the greater of actual consumption or target
+    #                   consumption).
+    def_output :predicted_calorie_consumption do
+      [target_daily_calorie_consumption, calories_consumed].max
+    end
+
+    # @!attribute [r]
+    # @return [Integer] The number of calories consumed (or predicted to be
+    #                   consumed) that is greater than the daily calorie goal
+    #                   and not yet burned off via exercise
+    def_output :predicted_overage do
+      predicted_calorie_consumption - daily_calorie_goal - calories_burned
+    end
+
+    # @!attribute [r]
+    # @return [Integer] The number of calories that must still be consumed to
+    #                   hit the day's target
+    def_output :remaining_to_target do
+      target_daily_calorie_consumption - calories_consumed
+    end
+
+    # @!attribute [r]
+    # @return [Integer] The number of calories that should be consumed today
+    def_output :target_daily_calorie_consumption do
+      [(daily_calorie_goal + calories_burned), resting_metabolic_rate].max
+    end
+
+    # @!attribute [r]
+    # @return [Integer] The number of net calories that should be consumed today
+    #                   to meet the weekly calorie goal
+    def_output :daily_calorie_goal do
+      (remaining_calories_this_week.to_f / remaining_days_of_week).round
+    end
+
+    # @!attribute [r]
+    # @return [Integer] The number of calories left in the calorie budget for
+    #                   the current week (does not include calories consumed
+    #                   today)
+    def_output :remaining_calories_this_week do
+      weekly_calorie_goal - prior_days_calories
+    end
+
+    # @!attribute [r]
+    # @return [Integer] The number of days remaining in the week, including the
+    #                   current day
+    def_output :remaining_days_of_week do
+      8 - current_day_of_week
+    end
+  end
+end

data/lib/nutrition_calculator/has_logging.rb

@@ -0,0 +1,40 @@
+require 'logger'
+
+module NutritionCalculator
+  # Provides a few logging utilities to the including class/module
+  module HasLogging
+    module NullLogger
+      extend self
+
+      def noop(*args); args; end
+      alias_method :error, :noop
+      alias_method :warn, :noop
+      alias_method :info, :noop
+      alias_method :debug, :noop
+    end
+    private_constant :NullLogger
+
+    attr_writer :logger
+
+    # The logger to which the including class/module should write
+    #
+    # Defaults to a NullLogger, which simply discards all logging attempts as
+    # noops.
+    #
+    # @return [Logger] an object adhering to the Logger interface
+    def logger
+      @logger ||= NullLogger
+    end
+
+    protected
+
+    # Executes the block and both logs and returns the result
+    #
+    # @return [block.call] The result of calling the block provided
+    def debug_value(name, &block)
+      block.call.tap do |value|
+        logger.debug("#{name}: #{value}")
+      end
+    end
+  end
+end

data/lib/nutrition_calculator/version.rb

@@ -0,0 +1,3 @@
+module NutritionCalculator
+  VERSION = "1.0.0"
+end

data/lib/nutrition_calculator.rb

@@ -0,0 +1,5 @@
+require "nutrition_calculator/version"
+
+module NutritionCalculator
+  # Your code goes here...
+end

data/nutrition_calculator.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nutrition_calculator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nutrition_calculator"
+  spec.version       = NutritionCalculator::VERSION
+  spec.authors       = ["John Wilger"]
+  spec.email         = ["johnwilger@gmail.com"]
+  spec.summary       = %q{Nutrition calculators for diet management}
+  spec.description   = %q{
+    NutritionCalculator provides a set of core libraries to help track a
+    person's individual nutritional goals. It is meant to aid in both
+    weight-management and monitoring the nutritional balance of a diet.
+  }
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "cucumber", "~> 1.3.0"
+  spec.add_development_dependency "reek"
+  spec.add_development_dependency "yard"
+end

data/spec/nutrition_calculator/cached_outputs_with_recalculation_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+require 'nutrition_calculator/cached_outputs_with_recalculation'
+
+describe NutritionCalculator::CachedOutputsWithRecalculation do
+  subject {
+    klass = Class.new do
+      extend NutritionCalculator::CachedOutputsWithRecalculation
+
+      def_input :foo
+
+      def_output :baz do
+        foo.bar
+      end
+    end
+
+    klass.new
+  }
+
+  let(:foo_value) { double('FooValue', bar: 'baz') }
+
+  it 'creates attr_accessors for inputs' do
+    subject.foo = :bar
+    expect(subject.foo).to eq :bar
+  end
+
+  it "complains when asked for the value of an input that was not provided" do
+    expect{subject.foo}.to \
+      raise_error(RuntimeError, "Required input missing: `foo`.")
+  end
+
+  it 'creates attr_readers for outputs' do
+    subject.foo = foo_value
+    expect(subject.baz).to eq 'baz'
+  end
+
+  it 'caches the calculated values for output' do
+    subject.foo = foo_value
+    expect(foo_value).to receive(:bar).once.and_return('baz')
+    2.times do
+      subject.baz
+    end
+  end
+
+  it 'clears cached calculations when inputs are changed' do
+    expect(foo_value).to receive(:bar).twice.and_return('baz')
+    2.times do
+      subject.foo = foo_value
+      subject.baz
+    end
+  end
+end

data/spec/nutrition_calculator/calorie_budgeter_spec.rb

@@ -0,0 +1,236 @@
+require 'spec_helper'
+require 'logger'
+require 'nutrition_calculator/calorie_budgeter'
+
+describe NutritionCalculator::CalorieBudgeter do
+  # Uncomment the following line if you need debugging output
+  # before(:each) { subject.logger = Logger.new(STDERR) }
+
+  describe '#net_calorie_consumption' do
+    it 'is the number of calories consumed less any calories burned via exercise' do
+      subject.calories_consumed = 100
+      subject.calories_burned = 10
+      expect(subject.net_calorie_consumption).to eq 90
+    end
+  end
+
+  describe '#remaining_calories_this_week' do
+    it 'is the weekly calorie goal less net calories from previous days' do
+      subject.weekly_calorie_goal = 10_000
+      subject.prior_days_calories = 1_000
+      expect(subject.remaining_calories_this_week).to eq 9000
+    end
+  end
+
+  describe '#daily_calorie_goal' do
+    let(:days_left) { 8 - day }
+    let(:weekly_goal) { 10_000 }
+
+    before(:each) do
+      subject.current_day_of_week = day
+      subject.weekly_calorie_goal = weekly_goal
+      subject.prior_days_calories = weekly_consumed
+    end
+
+    shared_examples_for 'it calculates the daily calorie goal' do
+      it 'is the number of calories remaining for the week divided by the remaining days in the week' do
+        expected = ((weekly_goal - weekly_consumed).to_f / days_left).round
+        expect(subject.daily_calorie_goal).to eq expected
+      end
+    end
+
+    (1..7).each do |day_num|
+      context "on day #{day_num}" do
+        let(:day) { day_num }
+        let(:weekly_consumed) { day_num * 10 }
+        it_behaves_like 'it calculates the daily calorie goal'
+      end
+    end
+  end
+
+  describe '#target_daily_calorie_consumption' do
+    before(:each) do
+      subject.current_day_of_week = 1
+      subject.prior_days_calories = 0
+      subject.resting_metabolic_rate = 2_000
+    end
+
+    context 'when the daily calorie goal is the same as the RMR' do
+      before(:each) do
+        subject.weekly_calorie_goal = 14_000
+      end
+
+      context 'when no calories have been burned via exercise' do
+        before(:each) do
+          subject.calories_burned = 0
+        end
+
+        it 'is equal to the resting metabolic rate' do
+          expect(subject.target_daily_calorie_consumption).to eq 2_000
+        end
+      end
+
+      context 'when calories have been burned via exercise' do
+        before(:each) do
+          subject.calories_burned = 100
+        end
+
+        it 'is equal to the resting metabolic rate plus exercise calories' do
+          expect(subject.target_daily_calorie_consumption).to eq 2_100
+        end
+      end
+    end
+
+    context 'when the daily calorie goal is lower than the RMR' do
+      before(:each) do
+        subject.weekly_calorie_goal = 10_500
+      end
+
+      context 'when no calories have been burned via exercise' do
+        before(:each) do
+          subject.calories_burned = 0
+        end
+
+        it 'is equal to the resting metabolic rate' do
+          expect(subject.target_daily_calorie_consumption).to eq 2_000
+        end
+      end
+
+      context 'when calories burned are less than difference between goal and RMR' do
+        before(:each) do
+          subject.calories_burned = 100
+        end
+
+        it 'is equal to the resting metabolic rate' do
+          expect(subject.target_daily_calorie_consumption).to eq 2_000
+        end
+      end
+
+      context 'when calories burned are equal to the difference between goal and RMR' do
+        before(:each) do
+          subject.calories_burned = 500
+        end
+
+        it 'is equal to the resting metabolic rate' do
+          expect(subject.target_daily_calorie_consumption).to eq 2_000
+        end
+      end
+
+      context 'when calories burned are greater than the difference between goal and RMR' do
+        before(:each) do
+          subject.calories_burned = 501
+        end
+
+        it 'is equal to the daily goal plus calories burned' do
+          expect(subject.target_daily_calorie_consumption).to eq 2_001
+        end
+      end
+    end
+
+    context 'when the daily calorie goal is higher than the RMR' do
+      before(:each) do
+        subject.weekly_calorie_goal = 17_500
+      end
+
+      context 'when no calories have been burned via exercise' do
+        before(:each) do
+          subject.calories_burned = 0
+        end
+
+        it 'is equal to the daily calorie goal rate' do
+          expect(subject.target_daily_calorie_consumption).to eq 2_500 
+        end
+      end
+
+      context 'when any calories have been burned via exercise' do
+        before(:each) do
+          subject.calories_burned = 1
+        end
+
+        it 'is equal to the daily goal plus calories burned' do
+          expect(subject.target_daily_calorie_consumption).to eq 2_501
+        end
+      end
+    end
+  end
+
+  describe '#remaining_to_target' do
+    before(:each) do
+      subject.resting_metabolic_rate = 2_000
+      subject.weekly_calorie_goal = 14_000
+      subject.current_day_of_week = 1
+      subject.prior_days_calories = 0
+      subject.calories_burned = 0
+    end
+
+    it 'is equal to the target daily calorie consumption less any calories already consumed' do
+      subject.calories_consumed = 500
+      expect(subject.remaining_to_target).to eq 1_500
+    end
+
+    it 'can be negative' do
+      subject.calories_consumed = 2_001
+      expect(subject.remaining_to_target).to eq -1
+    end
+  end
+
+  describe 'calories_remaining' do
+    before(:each) do
+      subject.resting_metabolic_rate = 2_000
+      subject.weekly_calorie_goal = 14_000
+      subject.current_day_of_week = 1
+      subject.prior_days_calories = 0
+      subject.calories_burned = 0
+    end
+
+    it 'is usually equal to the calories remaining to target' do
+      subject.calories_consumed = 500
+      expect(subject.calories_remaining).to eq 1_500
+    end
+
+    it 'will not be less than zero' do
+      subject.calories_consumed = 2_001
+      expect(subject.calories_remaining).to eq 0
+    end
+  end
+
+  describe '#predicted_calorie_consumption' do
+    before(:each) do
+      subject.current_day_of_week = 1
+      subject.prior_days_calories = 0
+      subject.resting_metabolic_rate = 2_000
+      subject.weekly_calorie_goal = 14_000
+      subject.calories_burned = 0
+    end
+
+    context 'when net calorie consumption is less than the target daily consumption' do
+      before(:each) do
+        subject.calories_consumed = 1_999
+      end
+
+      it 'is equal to the target daily consumption' do
+        expect(subject.predicted_calorie_consumption).to eq 2_000
+      end
+    end
+
+    context 'when net calorie consumption is equal to the target daily consumption' do
+      before(:each) do
+        subject.calories_consumed = 2_000
+      end
+
+      it 'is equal to the target daily consumption' do
+        expect(subject.predicted_calorie_consumption).to eq 2_000
+      end
+    end
+
+    context 'when net calorie consumption is greater than the target daily consumption' do
+      before(:each) do
+        subject.calories_consumed = 2_001
+      end
+
+      it 'is equal to the net consumption' do
+        expect(subject.predicted_calorie_consumption).to eq 2_001
+      end
+    end
+  end
+end

data/spec/nutrition_calculator_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe NutritionCalculator do
+  it 'has a version number' do
+    expect(NutritionCalculator::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'nutrition_calculator'
+
+RSpec.configure do |c|
+  c.filter_run_including :focus => true
+  c.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: nutrition_calculator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- John Wilger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-10 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: "\n    NutritionCalculator provides a set of core libraries to help track
+  a\n    person's individual nutritional goals. It is meant to aid in both\n    weight-management
+  and monitoring the nutritional balance of a diet.\n  "
+email:
+- johnwilger@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/calorie_budgeter.feature
+- features/step_definitions/.keep
+- features/step_definitions/calorie_budgeter_steps.rb
+- features/support/.keep
+- features/support/helper_methods.rb
+- lib/nutrition_calculator.rb
+- lib/nutrition_calculator/cached_outputs_with_recalculation.rb
+- lib/nutrition_calculator/calorie_budgeter.rb
+- lib/nutrition_calculator/has_logging.rb
+- lib/nutrition_calculator/version.rb
+- nutrition_calculator.gemspec
+- spec/nutrition_calculator/cached_outputs_with_recalculation_spec.rb
+- spec/nutrition_calculator/calorie_budgeter_spec.rb
+- spec/nutrition_calculator_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Nutrition calculators for diet management
+test_files:
+- features/calorie_budgeter.feature
+- features/step_definitions/.keep
+- features/step_definitions/calorie_budgeter_steps.rb
+- features/support/.keep
+- features/support/helper_methods.rb
+- spec/nutrition_calculator/cached_outputs_with_recalculation_spec.rb
+- spec/nutrition_calculator/calorie_budgeter_spec.rb
+- spec/nutrition_calculator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: