nutrition_calculator 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdf1b1d1d82d53bc441aa174ac25a7c18230ba18
-  data.tar.gz: 89dfd108e4ae7d1aa81935174bd61c26728a2dd4
+  metadata.gz: d192a9cd1ea3c900f999599597c9c6f9549e3dc7
+  data.tar.gz: 6ea66889e0f2ea5be1f40f1bf1557220c37de9b6
 SHA512:
-  metadata.gz: fd8e4e88e9e99e18c4311b2c43e95d78bd6cd79e95fdfd1c8eaf4589e3072ad789dd4e1814762315097639e2a409e4c1ec91251b3307f1176e2bc29bfc6c8bc1
-  data.tar.gz: 3d9120ab0259503793d2b40a70248b97a360f387b642e400f2e18868f9c26c839e0f6dd756fc100767588ec719384a683fa7bfe976b45baedf0d9068cc7efd06
+  metadata.gz: a3de99ed764a0e07b3234f75968530828fb931b93771754750a3b0195726c11ca7868ca9d8bb0eb5304d78e71413e8c2cb1f8204821b2feabfcb0322127d7548
+  data.tar.gz: 2a9cc36e2a69593def04b9834310acea0eb916a9ee5cbdb56576cd8b14ba965e2046e4c010d1fc0af17b486a67d61e6b312caf394ac8c06fe950f053ef011bf9

data/bin/run_calorie_budgeter

@@ -54,57 +54,26 @@ end
 $:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
 
 require 'nutrition_calculator/calorie_budgeter'
+require 'nutrition_calculator/data_summarizer'
 require 'yaml'
-require 'date'
-
 
 def data
   @data ||= YAML.load_file(ARGV.first)
 end
 
-def current_day_num
-  day = Date.today.wday
-  day = 7 if day == 0 # Sunday is the 7th day of the diet week
-  day
-end
-
-def data_for_day(day_num)
-  data.fetch(day_num) do
-    { 'calories_burned' => 0, 'calories_consumed' => 0 }
-  end
-end
-
-def prior_days_net_calories
-  values = (1...current_day_num).map { |day_num|
-    day_data = data_for_day(day_num)
-    day_data['calories_consumed'] - day_data['calories_burned']
-  }
-  values.reduce { |sum, daily_net_calories|
-    sum + daily_net_calories
-  }
-end
-
-def today
-  data_for_day(current_day_num)
-end
-
-def calories_burned_today
-  today['calories_burned']
-end
-
-def calories_consumed_today
-  today['calories_consumed']
-end
-
+summarizer = NutritionCalculator::DataSummarizer.new(source_data: data)
 cb = NutritionCalculator::CalorieBudgeter.new
+
 # 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 = current_day_num
-cb.prior_days_calories = prior_days_net_calories
-cb.calories_burned = calories_burned_today
-cb.calories_consumed = calories_consumed_today
+
+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/lib/nutrition_calculator/cached_outputs_with_recalculation.rb

@@ -10,6 +10,10 @@ module NutritionCalculator
   #
   #     def_input :bar
   #
+  #     def_input :spam, validate_with: ->(value) {
+  #       value != 'ham'
+  #     }
+  #
   #     def_output :baz do
   #       bar.expensive_operation
   #     end
@@ -20,6 +24,11 @@ module NutritionCalculator
   #   x.baz
   #   #=> Raises a RuntimeError because input bar was not set
   #
+  #   x.spam = 'ham'
+  #   #=> Raises a
+  #     NutritionCalculator::CachedOutputsWithRecalculation::InvalidInputError
+  #     because the validation returned false.
+  #
   #   a_thing = ExpensiveObject.new
   #
   #   x.bar = a_thing
@@ -37,6 +46,8 @@ module NutritionCalculator
   #   #=> result of `a_thing.expensive_operation`
   #
   module CachedOutputsWithRecalculation
+    class InvalidInputError < RuntimeError; end
+
     # @private
     def self.extended(other)
       other.include(InstanceMethods)
@@ -48,8 +59,8 @@ module NutritionCalculator
     # recalculated the next time they are called.
     #
     # @param name [Symbol]
-    def def_input(name)
-      def_input_writer name
+    def def_input(name, validate_with: ->(_) { true })
+      def_input_writer name, validator: validate_with
       def_input_reader name
     end
 
@@ -71,8 +82,9 @@ module NutritionCalculator
 
     private
 
-    def def_input_writer(name)
+    def def_input_writer(name, validator:)
       define_method("#{name}=") do |value|
+        validate_input!(name, value, validator)
         recalculate!
         instance_variable_set("@#{name}", value)
       end
@@ -96,6 +108,13 @@ module NutritionCalculator
         @cached_values ||= {}
       end
 
+      def validate_input!(name, value, validator)
+        success = validator.(value)
+        if !success
+          raise InvalidInputError, "#{value.inspect} is not a valid input value for '##{name}'."
+        end
+      end
+
       def recalculate!
         logger.debug "Input received; clearing cached calculations."
         @cached_values = {}

data/lib/nutrition_calculator/calorie_budgeter.rb

@@ -44,12 +44,17 @@ module NutritionCalculator
 
     # @!attribute
     # @return [Integer] The daily resting metabolic rate in calories
-    def_input :resting_metabolic_rate
+    def_input :resting_metabolic_rate, validate_with: ->(value) {
+      value.kind_of?(Integer) \
+        && value > 0
+    }
 
     # @!attribute
     # @return [Integer] The total net calories (consumed - burned) planned for
     #                   the week
-    def_input :weekly_calorie_goal
+    def_input :weekly_calorie_goal, validate_with: ->(value) {
+      value.kind_of?(Integer)
+    }
 
     # @!attribute
     # @return [Integer] The total net calories from all days this week prior
@@ -60,7 +65,9 @@ module NutritionCalculator
     #   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
+    def_input :prior_days_calories, validate_with: ->(value) {
+      value.kind_of?(Integer)
+    }
 
     # @!attribute
     # @return [Integer] The number of the day of the week
@@ -72,15 +79,23 @@ module NutritionCalculator
     #   5 - Friday
     #   6 - Saturday
     #   7 - Sunday
-    def_input :current_day_of_week
+    def_input :current_day_of_week, validate_with: ->(value) {
+      (1..7).include?(value)
+    }
 
     # @!attribute
     # @return [Integer] The total number of calories consumed today
-    def_input :calories_consumed
+    def_input :calories_consumed, validate_with: ->(value) {
+      value.kind_of?(Integer) \
+        && value >= 0
+    }
 
     # @!attribute
     # @return [Integer] The total number of calories burned via exercise today
-    def_input :calories_burned
+    def_input :calories_burned, validate_with: ->(value) {
+      value.kind_of?(Integer) \
+        && value >= 0
+    }
 
     # @!group Outputs
 

data/lib/nutrition_calculator/data_summarizer.rb

@@ -0,0 +1,50 @@
+require 'date'
+
+module NutritionCalculator
+  class DataSummarizer
+    SUNDAY = 7
+    MONDAY = 1
+
+    def initialize(source_data:, calendar: Date)
+      self.source_data = source_data
+      self.calendar = calendar
+    end
+
+    def prior_days_net_calories
+      return 0 if current_day == MONDAY
+      values = (1...current_day).map { |day| net_calories_for_day(day) }
+      values.reduce { |weekly_net, daily_net| weekly_net + daily_net }
+    end
+
+    def calories_consumed_today
+      source_data_for_day(current_day)['calories_consumed']
+    end
+
+    def calories_burned_today
+      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.
+    def current_day
+      day = calendar.today.wday
+      day = SUNDAY if day < MONDAY
+      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']
+    end
+
+    def source_data_for_day(day)
+      source_data.fetch(day) do
+        {'calories_consumed' => 0, 'calories_burned' => 0}
+      end
+    end
+  end
+end

data/lib/nutrition_calculator/version.rb

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

data/spec/nutrition_calculator/cached_outputs_with_recalculation_spec.rb

@@ -8,6 +8,10 @@ describe NutritionCalculator::CachedOutputsWithRecalculation do
 
       def_input :foo
 
+      def_input :spam, validate_with: ->(value) {
+        value != 'ham'
+      }
+
       def_output :baz do
         foo.bar
       end
@@ -28,6 +32,21 @@ describe NutritionCalculator::CachedOutputsWithRecalculation do
       raise_error(RuntimeError, "Required input missing: `foo`.")
   end
 
+  context 'when an input has a validator' do
+    it 'raises an exception on assignment if the validation fails' do
+      expect { subject.spam = 'ham' }.to \
+        raise_error(
+          NutritionCalculator::CachedOutputsWithRecalculation::InvalidInputError,
+          "#{'ham'.inspect} is not a valid input value for '#spam'."
+        )
+    end
+
+    it 'does not raise an exception if the validation passes' do
+      subject.foo = 'canned ham'
+      expect(subject.foo).to eq 'canned ham'
+    end
+  end
+
   it 'creates attr_readers for outputs' do
     subject.foo = foo_value
     expect(subject.baz).to eq 'baz'

data/spec/nutrition_calculator/data_summarizer_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'nutrition_calculator/data_summarizer'
+
+describe NutritionCalculator::DataSummarizer do
+  let(:source_data) {{
+    1 => {
+      'calories_consumed' => 1000,
+      'calories_burned' => 500
+    },
+    2 => {
+      'calories_consumed' => 1001,
+      'calories_burned' => 500
+    },
+    3 => {
+      'calories_consumed' => 1000,
+      'calories_burned' => 501
+    },
+    4 => {
+      'calories_consumed' => 1002,
+      'calories_burned' => 500
+    },
+    5 => {
+      'calories_consumed' => 1000,
+      'calories_burned' => 502
+    },
+    6 => {
+      'calories_consumed' => 1003,
+      'calories_burned' => 500
+    },
+    7 => {
+      'calories_consumed' => 1000,
+      'calories_burned' => 503
+    },
+  }}
+
+  let(:calendar) { double(:calendar, today: today) }
+
+  subject { described_class.new(source_data: source_data, calendar: calendar) }
+
+  context "on day 1" do
+    let(:today) { Date.new(2015,2,16) }
+
+    it 'reports prior_days_net_calories as 0' do
+      expect(subject.prior_days_net_calories).to eq 0
+    end
+
+    it 'reports calories burned today' do
+      expect(subject.calories_burned_today).to eq 500
+    end
+
+    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) }
+
+    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
+    end
+
+    it 'reports calories burned today' do
+      expect(subject.calories_burned_today).to eq 503
+    end
+
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nutrition_calculator
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - John Wilger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,11 +121,13 @@ files:
 - lib/nutrition_calculator.rb
 - lib/nutrition_calculator/cached_outputs_with_recalculation.rb
 - lib/nutrition_calculator/calorie_budgeter.rb
+- lib/nutrition_calculator/data_summarizer.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_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -160,6 +162,7 @@ test_files:
 - features/support/helper_methods.rb
 - 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_spec.rb
 - spec/spec_helper.rb
 has_rdoc: