nutrition_calculator 1.0.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d192a9cd1ea3c900f999599597c9c6f9549e3dc7
-  data.tar.gz: 6ea66889e0f2ea5be1f40f1bf1557220c37de9b6
+  metadata.gz: 6bea8053da1b46ce8fa17fcec9d5b1a26bc76aed
+  data.tar.gz: b267488d45929aca0494205317222a5e3337d967
 SHA512:
-  metadata.gz: a3de99ed764a0e07b3234f75968530828fb931b93771754750a3b0195726c11ca7868ca9d8bb0eb5304d78e71413e8c2cb1f8204821b2feabfcb0322127d7548
-  data.tar.gz: 2a9cc36e2a69593def04b9834310acea0eb916a9ee5cbdb56576cd8b14ba965e2046e4c010d1fc0af17b486a67d61e6b312caf394ac8c06fe950f053ef011bf9
+  metadata.gz: 790daa540bea0f2c0589ed225234d242085ca89191bccee879f66ab49b70c7ad57ccd0de69bdd796fe944be2b328e0e65d2b008924160d5e079f472236c2931b
+  data.tar.gz: a495afdf1964d806e1ebb928fc54ed7267046fa72fc2370140a1728dcd112298075104a6b2d99a83fe916dd0e6292f5a14b9561547c0e4b4194688e270c4a457

data/bin/run_calorie_budgeter

@@ -55,25 +55,28 @@ $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
 
 require 'nutrition_calculator/calorie_budgeter'
 require 'nutrition_calculator/data_summarizer'
+require 'nutrition_calculator/diet_period'
 require 'yaml'
 
 def data
   @data ||= YAML.load_file(ARGV.first)
 end
 
-summarizer = NutritionCalculator::DataSummarizer.new(source_data: data)
-cb = NutritionCalculator::CalorieBudgeter.new
+diet_period = NutritionCalculator::DietPeriod.new(
+  start_date: data['start_date'],
+  length: data['period_length'],
+  resting_metabolic_rate: data['resting_metabolic_rate'],
+  weight_loss_goal_in_kg: data['weight_loss_goal_in_kg']
+)
+
+summarizer = NutritionCalculator::DataSummarizer.new(source_data: data,
+                                                     diet_period: diet_period)
+
+cb = NutritionCalculator::CalorieBudgeter.new(diet_period: diet_period,
+                                              source_data: summarizer)
 
 # require 'logger'
 # cb.logger = Logger.new(STDERR)
-#
-cb.resting_metabolic_rate = data['resting_metabolic_rate']
-cb.weekly_calorie_goal = data['weekly_calorie_goal']
-
-cb.current_day_of_week = summarizer.current_day
-cb.prior_days_calories = summarizer.prior_days_net_calories
-cb.calories_burned = summarizer.calories_burned_today
-cb.calories_consumed = summarizer.calories_consumed_today
 
 puts "You have consumed #{cb.calories_consumed} calories today."
 puts "You have burned #{cb.calories_burned} calories today."

data/features/step_definitions/calorie_budgeter_steps.rb

@@ -11,7 +11,8 @@ Given(/^I have consumed (\d+) net calories on prior days this week$/) do |cals|
 end
 
 Given(/^it is the (\d+)(st|nd|rd|th) day of the week$/) do |day, _|
-  inputs.current_day_of_week = day.to_i
+  day = day.to_i
+  inputs.num_days_to_budget = 8 - day
 end
 
 Given(/^I have consumed (\d+) calories today$/) do |cals|

data/lib/nutrition_calculator/calorie_budgeter.rb

@@ -16,9 +16,14 @@ module NutritionCalculator
   #   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.weekly_calorie_goal = 10_500   # creates an average deficit of 500
+  #                                     # calories/day
+  #
+  #   cb.num_days_to_budget = 5         # The number of days remaining in the
+  #                                     # week, including the current day
+  #
+  #   cb.prior_days_calories = 3_524    # net calories from days 1 and 2
   #   
   #   cb.calories_consumed = 0
   #   cb.calories_burned = 0
@@ -40,6 +45,23 @@ module NutritionCalculator
   class CalorieBudgeter
     extend CachedOutputsWithRecalculation
 
+    def initialize(diet_period: nil, source_data: nil)
+      self.diet_period = diet_period if diet_period
+      self.source_data = source_data if source_data
+    end
+
+    def diet_period=(diet_period)
+      self.resting_metabolic_rate = diet_period.resting_metabolic_rate
+      self.weekly_calorie_goal = diet_period.net_calorie_goal
+      self.num_days_to_budget = diet_period.days_remaining
+    end
+
+    def source_data=(source_data)
+      self.prior_days_calories = source_data.prior_days_net_calories
+      self.calories_consumed = source_data.calories_consumed_today
+      self.calories_burned = source_data.calories_burned_today
+    end
+
     # @!group Inputs
 
     # @!attribute
@@ -70,16 +92,10 @@ module NutritionCalculator
     }
 
     # @!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, validate_with: ->(value) {
+    # @return [Integer] The number of days across which to budget the remaining
+    #                   net calorie goal for the week. This includes the current
+    #                   day.
+    def_input :num_days_to_budget, validate_with: ->(value) {
       (1..7).include?(value)
     }
 
@@ -152,7 +168,7 @@ module NutritionCalculator
     # @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
+      (remaining_calories_this_week.to_f / num_days_to_budget).round
     end
 
     # @!attribute [r]
@@ -162,12 +178,5 @@ module NutritionCalculator
     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/data_summarizer.rb

@@ -1,18 +1,15 @@
-require 'date'
-
 module NutritionCalculator
   class DataSummarizer
-    SUNDAY = 7
-    MONDAY = 1
-
-    def initialize(source_data:, calendar: Date)
+    def initialize(source_data:, diet_period:)
       self.source_data = source_data
-      self.calendar = calendar
+      self.diet_period = diet_period
     end
 
     def prior_days_net_calories
-      return 0 if current_day == MONDAY
-      values = (1...current_day).map { |day| net_calories_for_day(day) }
+      return 0 if current_day == 0
+      values = (0...current_day).map { |day|
+        net_calories_for_day(day)
+      }
       values.reduce { |weekly_net, daily_net| weekly_net + daily_net }
     end
 
@@ -24,18 +21,13 @@ module NutritionCalculator
       source_data_for_day(current_day)['calories_burned']
     end
 
-    # TODO: this probably isn't the right place to put this, since it looks like
-    # it does need to be exposed to the CalorieBudgeter as well. Still, this is
-    # better than having it live in the CLI script itself for now.
+    private
+    attr_accessor :source_data, :diet_period
+
     def current_day
-      day = calendar.today.wday
-      day = SUNDAY if day < MONDAY
-      day
+      diet_period.current_day
     end
 
-    private
-    attr_accessor :source_data, :calendar
-
     def net_calories_for_day(day)
       data = source_data_for_day(day)
       data['calories_consumed'] - data['calories_burned']

data/lib/nutrition_calculator/diet_period.rb

@@ -0,0 +1,81 @@
+require 'date'
+require 'nutrition_calculator/cached_outputs_with_recalculation'
+
+module NutritionCalculator
+  class DietPeriod
+    extend CachedOutputsWithRecalculation
+    include Comparable
+
+    CALORIES_PER_KG = 7_500
+
+    def initialize(length:, start_date:, resting_metabolic_rate:,
+                   weight_loss_goal_in_kg:, calendar: Date)
+      self.length = length
+      self.start_date = start_date
+      self.resting_metabolic_rate = resting_metabolic_rate
+      self.weight_loss_goal_in_kg = weight_loss_goal_in_kg
+      self.calendar = calendar
+    end
+
+    def_input :length, validate_with: ->(value) {
+      value.kind_of?(Integer) \
+        && value > 0
+    }
+
+    def_input :start_date, validate_with: ->(value) {
+      value.kind_of?(Date)
+    }
+    alias_method :to_date, :start_date
+
+    def_input :resting_metabolic_rate, validate_with: ->(value) {
+      value.kind_of?(Integer) \
+        && value > 0
+    }
+
+    def_input :weight_loss_goal_in_kg, validate_with: ->(value) {
+      value.kind_of?(Numeric)
+    }
+
+    def_output :current_day do
+      (calendar.today - current_cycle_start_date).to_i
+    end
+
+    def_output :days_remaining do
+      length - current_day
+    end
+
+    def_output :net_calorie_goal do
+      rmr_for_period - planned_calorie_deficit
+    end
+
+    def succ
+      self.clone.tap do |period|
+        period.start_date = start_date + length
+      end
+    end
+
+    def <=>(other)
+      start_date <=> other.to_date
+    end
+
+    private
+
+    attr_accessor :calendar
+
+    def current_cycle_start_date
+      current_cycle.start_date
+    end
+
+    def current_cycle
+      (self..calendar.today).to_a.last
+    end
+
+    def rmr_for_period
+      resting_metabolic_rate * length
+    end
+
+    def planned_calorie_deficit
+      (weight_loss_goal_in_kg * CALORIES_PER_KG).ceil
+    end
+  end
+end

data/lib/nutrition_calculator/version.rb

@@ -1,3 +1,3 @@
 module NutritionCalculator
-  VERSION = "1.0.4"
+  VERSION = "1.2.0"
 end

data/spec/nutrition_calculator/calorie_budgeter_spec.rb

@@ -23,18 +23,18 @@ describe NutritionCalculator::CalorieBudgeter do
   end
 
   describe '#daily_calorie_goal' do
-    let(:days_left) { 8 - day }
     let(:weekly_goal) { 10_000 }
+    let(:days_left_in_week) { 8 - day }
 
     before(:each) do
-      subject.current_day_of_week = day
+      subject.num_days_to_budget = days_left_in_week
       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
+        expected = ((weekly_goal - weekly_consumed).to_f / days_left_in_week).round
         expect(subject.daily_calorie_goal).to eq expected
       end
     end
@@ -50,7 +50,7 @@ describe NutritionCalculator::CalorieBudgeter do
 
   describe '#target_daily_calorie_consumption' do
     before(:each) do
-      subject.current_day_of_week = 1
+      subject.num_days_to_budget = 7
       subject.prior_days_calories = 0
       subject.resting_metabolic_rate = 2_000
     end
@@ -158,7 +158,7 @@ describe NutritionCalculator::CalorieBudgeter do
     before(:each) do
       subject.resting_metabolic_rate = 2_000
       subject.weekly_calorie_goal = 14_000
-      subject.current_day_of_week = 1
+      subject.num_days_to_budget = 7
       subject.prior_days_calories = 0
       subject.calories_burned = 0
     end
@@ -178,7 +178,7 @@ describe NutritionCalculator::CalorieBudgeter do
     before(:each) do
       subject.resting_metabolic_rate = 2_000
       subject.weekly_calorie_goal = 14_000
-      subject.current_day_of_week = 1
+      subject.num_days_to_budget = 7
       subject.prior_days_calories = 0
       subject.calories_burned = 0
     end
@@ -196,7 +196,7 @@ describe NutritionCalculator::CalorieBudgeter do
 
   describe '#predicted_calorie_consumption' do
     before(:each) do
-      subject.current_day_of_week = 1
+      subject.num_days_to_budget = 7
       subject.prior_days_calories = 0
       subject.resting_metabolic_rate = 2_000
       subject.weekly_calorie_goal = 14_000

data/spec/nutrition_calculator/data_summarizer_spec.rb

@@ -3,42 +3,44 @@ require 'nutrition_calculator/data_summarizer'
 
 describe NutritionCalculator::DataSummarizer do
   let(:source_data) {{
-    1 => {
+    0 => {
       'calories_consumed' => 1000,
       'calories_burned' => 500
     },
-    2 => {
+    1 => {
       'calories_consumed' => 1001,
       'calories_burned' => 500
     },
-    3 => {
+    2 => {
       'calories_consumed' => 1000,
       'calories_burned' => 501
     },
-    4 => {
+    3 => {
       'calories_consumed' => 1002,
       'calories_burned' => 500
     },
-    5 => {
+    4 => {
       'calories_consumed' => 1000,
       'calories_burned' => 502
     },
-    6 => {
+    5 => {
       'calories_consumed' => 1003,
       'calories_burned' => 500
     },
-    7 => {
+    6 => {
       'calories_consumed' => 1000,
       'calories_burned' => 503
     },
   }}
 
-  let(:calendar) { double(:calendar, today: today) }
+  let(:diet_period) { double(:diet_period, current_day: current_day) }
 
-  subject { described_class.new(source_data: source_data, calendar: calendar) }
+  subject {
+    described_class.new(source_data: source_data, diet_period: diet_period)
+  }
 
-  context "on day 1" do
-    let(:today) { Date.new(2015,2,16) }
+  context "on day 0" do
+    let(:current_day) { 0 }
 
     it 'reports prior_days_net_calories as 0' do
       expect(subject.prior_days_net_calories).to eq 0
@@ -51,14 +53,10 @@ describe NutritionCalculator::DataSummarizer do
     it 'reports calories consumed today' do
       expect(subject.calories_consumed_today).to eq 1000
     end
-
-    it 'reports that the current day number is 1' do
-      expect(subject.current_day).to eq 1
-    end
   end
 
-  context "on day 7" do
-    let(:today) { Date.new(2015,2,22) }
+  context "on day 6" do
+    let(:current_day) { 6 }
 
     it 'reports prior_days_net_calories as the sum of calories consumed less the sum of calories burned' do
       expect(subject.prior_days_net_calories).to eq 3_003
@@ -71,9 +69,5 @@ describe NutritionCalculator::DataSummarizer do
     it 'reports calories consumed today' do
       expect(subject.calories_consumed_today).to eq 1000
     end
-
-    it 'reports that the current day number is 7' do
-      expect(subject.current_day).to eq 7
-    end
   end
 end

data/spec/nutrition_calculator/diet_period_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+require 'nutrition_calculator/diet_period'
+
+describe NutritionCalculator::DietPeriod do
+  CALORIES_PER_KG = 7_500
+
+  subject {
+    described_class.new(length: period_length, start_date: start_date,
+                        resting_metabolic_rate: rmr,
+                        weight_loss_goal_in_kg: loss_goal,
+                        calendar: calendar)
+  }
+
+  let(:calendar) { double(:calendar, today: current_date) }
+
+  let(:rmr) { 2000 }
+
+  let(:expected_net_calorie_goal) {
+    (rmr * period_length) - (loss_goal * CALORIES_PER_KG)
+  }
+
+  let(:start_date) { Date.new(2015,2,16) }
+  let(:current_date) { Date.new(2015,2,16) }
+
+  context 'when the period is 7 days long' do
+    let(:period_length) { 7 }
+    let(:loss_goal) { 0.5 }
+
+    it 'calculates the calorie budget for the entire period' do
+      expect(subject.net_calorie_goal).to eq expected_net_calorie_goal
+    end
+
+    context 'it is the first day of the first cycle of the period' do
+      let(:current_date) { Date.new(2015,2,16) }
+
+      it 'reports that today is the 0th day of the period' do
+        expect(subject.current_day).to eq 0
+      end
+
+      it 'reports that there are 7 days remaining in the period' do
+        expect(subject.days_remaining).to eq 7
+      end
+    end
+
+    context 'it is the last day of the first cycle of the period' do
+      let(:current_date) { Date.new(2015,2,22) }
+
+      it 'reports that today is the 6th day of the period' do
+        expect(subject.current_day).to eq 6
+      end
+
+      it 'reports that there is 1 day remaining in the period' do
+        expect(subject.days_remaining).to eq 1
+      end
+    end
+
+    context 'it is the first day of the third cycle of the period' do
+      let(:current_date) { Date.new(2015,3,2) }
+
+      it 'reports that today is the 0th day of the period' do
+        expect(subject.current_day).to eq 0
+      end
+
+      it 'reports that there are 7 days remaining in the period' do
+        expect(subject.days_remaining).to eq 7
+      end
+    end
+
+    context 'it is the last day of the first cycle of the period' do
+      let(:current_date) { Date.new(2015,3,8) }
+
+      it 'reports that today is the 6th day of the period' do
+        expect(subject.current_day).to eq 6
+      end
+
+      it 'reports that there is 1 day remaining in the period' do
+        expect(subject.days_remaining).to eq 1
+      end
+    end
+  end
+
+  context 'when the period is 10 days long' do
+    let(:period_length) { 10 }
+    let(:loss_goal) { 0.5 }
+
+    it 'calculates the calorie budget for the entire period' do
+      expect(subject.net_calorie_goal).to eq expected_net_calorie_goal
+    end
+
+    context 'it is the first day of the first cycle of the period' do
+      let(:current_date) { Date.new(2015,2,16) }
+
+      it 'reports that today is the 0th day of the period' do
+        expect(subject.current_day).to eq 0
+      end
+
+      it 'reports that there are 10 days remaining in the period' do
+        expect(subject.days_remaining).to eq 10
+      end
+    end
+
+    context 'it is the last day of the first cycle of the period' do
+      let(:current_date) { Date.new(2015,2,25) }
+
+      it 'reports that today is the 9th day of the period' do
+        expect(subject.current_day).to eq 9
+      end
+
+      it 'reports that there is 1 day remaining in the period' do
+        expect(subject.days_remaining).to eq 1
+      end
+    end
+
+    context 'it is the first day of the third cycle of the period' do
+      let(:current_date) { Date.new(2015,3,8) }
+
+      it 'reports that today is the 0th day of the period' do
+        expect(subject.current_day).to eq 0
+      end
+
+      it 'reports that there are 7 days remaining in the period' do
+        expect(subject.days_remaining).to eq 10
+      end
+    end
+
+    context 'it is the last day of the third cycle of the period' do
+      let(:current_date) { Date.new(2015,3,17) }
+
+      it 'reports that today is the 6th day of the period' do
+        expect(subject.current_day).to eq 9
+      end
+
+      it 'reports that there is 1 day remaining in the period' do
+        expect(subject.days_remaining).to eq 1
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nutrition_calculator
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.2.0
 platform: ruby
 authors:
 - John Wilger
@@ -122,12 +122,14 @@ files:
 - lib/nutrition_calculator/cached_outputs_with_recalculation.rb
 - lib/nutrition_calculator/calorie_budgeter.rb
 - lib/nutrition_calculator/data_summarizer.rb
+- lib/nutrition_calculator/diet_period.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/data_summarizer_spec.rb
+- spec/nutrition_calculator/diet_period_spec.rb
 - spec/nutrition_calculator_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -163,6 +165,7 @@ test_files:
 - spec/nutrition_calculator/cached_outputs_with_recalculation_spec.rb
 - spec/nutrition_calculator/calorie_budgeter_spec.rb
 - spec/nutrition_calculator/data_summarizer_spec.rb
+- spec/nutrition_calculator/diet_period_spec.rb
 - spec/nutrition_calculator_spec.rb
 - spec/spec_helper.rb
 has_rdoc: