nemah 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59e1b71fdd45cf09b6e19ad900d4c06ec6147e6d
+  data.tar.gz: 52ed2eb7953a641a03c5bf17a0e739d99211b184
+SHA512:
+  metadata.gz: d14843fe110208602459b8b29449fc4ab716c9f7d8619f883a57785dd65859f41d6545da30caaf024ddc7fb278f8526269454398e2b4030ecb5176dadcb6c319
+  data.tar.gz: 9ce324455ba1812396ebccfe661eb2c45bf44451874d0858b2adeb25d246b3ec7db13076f6aef1a9cbd0e7c990843664c7068bc063b7ed36178084c31cf170bd

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+/sandi_meter/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - ruby-head
+  - 2.1.0
+  - 2.0.0

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,6 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{spec/support/shared_examples_for_(.+)\.rb}) { 'spec' }
+  watch('spec/spec_helper.rb') { 'spec' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kim Persson and Lennart Fridén
+
+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,44 @@
+# Nemah [![Build Status](https://secure.travis-ci.org/Lavinia/Nemah.png)](http://travis-ci.org/Lavinia/Nemah) [![Code Climate](https://codeclimate.com/github/Lavinia/Nemah.png)](https://codeclimate.com/github/Lavinia/Nemah) ![Gem version](https://badge.fury.io/rb/nemah.png)
+
+Nemah is a library for calculating the proper amount of fodder for your horse. In real life, Nemah is an [Arabian horse](http://en.wikipedia.org/wiki/Arabian_horse) with an immense appetite.
+
+## Requirements
+
+Given that Nemah is an Arabian princess, she wants as many rubies as possible, but no fewer than 2.0.
+
+## Installation.
+
+Add this line to your application's Gemfile:
+
+    gem 'nemah'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nemah
+
+## Usage
+
+### Initial version
+
+* Calculate a horse's need of energy, protein, solids, macrominerals, and selenium.
+* Calculations are made internally with at least three digits precision. Public methods will return values rounded to two decimals by default.
+
+### Yet to be implemented
+
+* Microminerals apart from selenium
+* Balances
+* Fodder
+* Rations
+* Given a horse, its needs, and a list of fodder, calculate suitable rations.
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/nemah.rb

@@ -0,0 +1,2 @@
+require 'nemah/specific_need/mineral_behaviour'
+Dir[File.join(File.dirname(__FILE__), 'nemah', '**', '*.rb')].sort.each { |file| require file }

data/lib/nemah/horse.rb

@@ -0,0 +1,80 @@
+module Nemah
+  class Horse
+    class AttributeRequiredError < ArgumentError
+      def initialize(attribute)
+        super("#{attribute} required")
+      end
+    end
+
+    attr_reader :weight, :gender, :name, :feedability, :workload
+
+    def initialize(attributes)
+      @weight = attributes.fetch(:weight) { raise AttributeRequiredError, :weight }
+      @gender = attributes.fetch(:gender) { raise AttributeRequiredError, :gender }
+      @name = attributes.fetch(:name, '')
+      @feedability = attributes.fetch(:feedability, :normal)
+      @workload = attributes.fetch(:workload, Workload.new)
+      HorseValidator.new(self).assert_validity_of(:feedability, :gender, :weight)
+    end
+
+    def stallion?
+      gender == :stallion
+    end
+
+    def weight_in_deciton
+      weight / 100.00
+    end
+
+    private
+
+    class HorseValidator
+      def initialize(horse)
+        @horse = horse
+      end
+
+      def assert_validity_of(*attributes)
+        attributes.each { |attribute| assert_valid(attribute) }
+      end
+
+      private
+
+      attr_reader :horse
+
+      def assert_valid(attribute)
+        unless allowed_values_for(attribute).include? horse.send(attribute)
+          raise ArgumentError, "#{horse.send(attribute).inspect} is not an allowed #{attribute}"
+        end
+      end
+
+      def allowed_values_for(attribute)
+        case attribute
+        when :gender then allowed_genders
+        when :feedability then allowed_feedabilities
+        when :weight then PositiveWeight.new
+        else
+          Everything.new
+        end
+      end
+
+      def allowed_feedabilities
+        [:easy, :normal, :hard]
+      end
+
+      def allowed_genders
+        [:gelding, :mare, :stallion]
+      end
+
+      class PositiveWeight
+        def include?(weight)
+          weight >= 0
+        end
+      end
+
+      class Everything
+        def include?(_)
+          true
+        end
+      end
+    end
+  end
+end

data/lib/nemah/need.rb

@@ -0,0 +1,41 @@
+module Nemah
+  class Need
+    attr_reader :horse
+
+    def initialize(horse)
+      @horse = horse
+    end
+
+    def calcium
+      Nemah::SpecificNeed::Calcium.new(self)
+    end
+
+    def energy
+      Nemah::SpecificNeed::Energy.new(self)
+    end
+
+    def magnesium
+      Nemah::SpecificNeed::Magnesium.new(self)
+    end
+
+    def phosphor
+      Nemah::SpecificNeed::Phosphor.new(self)
+    end
+
+    def protein
+      Nemah::SpecificNeed::Protein.new(self)
+    end
+
+    def salt
+      Nemah::SpecificNeed::Salt.new(self)
+    end
+
+    def selenium
+      Nemah::SpecificNeed::Selenium.new(self)
+    end
+
+    def solids
+      Nemah::SpecificNeed::Solids.new(self)
+    end
+  end
+end

data/lib/nemah/specific_need/abstract_need.rb

@@ -0,0 +1,49 @@
+module Nemah
+  module SpecificNeed
+    class AbstractNeed
+      attr_reader :need
+
+      def initialize(need)
+        @need = need
+      end
+
+      def ideal(decimals: 2)
+        _ideal.round(decimals)
+      end
+
+      def min(decimals: 2)
+        _min.round(decimals)
+      end
+
+      def max(decimals: 2)
+        _max.round(decimals)
+      end
+
+      def to_rounded_range(decimals: 2)
+        min(decimals: decimals)..max(decimals: decimals)
+      end
+
+      def unit
+        :g
+      end
+
+      private
+
+      def _ideal
+        raise NotImplementedError, '#_ideal() must return an object responding to #round(n)'
+      end
+
+      def _min
+        raise NotImplementedError, '#min() must return an object responding to #round(n)'
+      end
+
+      def _max
+        raise NotImplementedError, '#max() must return an object responding to #round(n)'
+      end
+
+      def horse
+        need.horse
+      end
+    end
+  end
+end

data/lib/nemah/specific_need/calcium.rb

@@ -0,0 +1,13 @@
+module Nemah
+  module SpecificNeed
+    class Calcium < AbstractNeed
+      include Nemah::SpecificNeed::MineralBehaviour
+
+      private
+
+      def factor_table
+        FactorTable.new(no_work: 4.0, below_30: 6.0, below_50: 7.0, below_75: 8.0, above_75: 8.0)
+      end
+    end
+  end
+end

data/lib/nemah/specific_need/energy.rb

@@ -0,0 +1,63 @@
+module Nemah
+  module SpecificNeed
+    class Energy < AbstractNeed
+      def for_maintenance(decimals: 2)
+        (ideal - workload_energy).round(decimals)
+      end
+
+      def for_workload(decimals: 2)
+        workload_energy.round(decimals)
+      end
+
+      def unit
+        :MJ
+      end
+
+      private
+
+      def _ideal
+        0.50 * (horse.weight ** 0.75 ) * feedability_factor * gender_factor + workload_energy
+      end
+
+      def feedability_factor
+        case horse.feedability
+        when :easy then 1.00
+        when :normal then 1.05
+        when :hard then 1.10
+        end
+      end
+
+      def gender_factor
+        (horse.stallion?) ? 1.10 : 1.00
+      end
+
+      def workload_energy
+        energy_addition_for_walk + energy_addition_for_trot_and_canter
+      end
+
+      def energy_addition_for_walk
+        (0.20 * horse.weight_in_deciton * workload.walk / 10.0) * days_per_week_factor
+      end
+
+      def energy_addition_for_trot_and_canter
+        (1.30 * horse.weight_in_deciton * workload.trot_and_canter / 10.0) * days_per_week_factor
+      end
+
+      def days_per_week_factor
+        workload.days_per_week / 7.0
+      end
+
+      def _min
+        [_ideal - 3, 0].max
+      end
+
+      def _max
+        _ideal + 3
+      end
+
+      def workload
+        horse.workload
+      end
+    end
+  end
+end

data/lib/nemah/specific_need/magnesium.rb

@@ -0,0 +1,13 @@
+module Nemah
+  module SpecificNeed
+    class Magnesium < AbstractNeed
+      include Nemah::SpecificNeed::MineralBehaviour
+
+      private
+
+      def factor_table
+        FactorTable.new(no_work: 1.5, below_30: 1.9, below_50: 2.3, below_75: 3.0, above_75: 3.0)
+      end
+    end
+  end
+end

data/lib/nemah/specific_need/mineral_behaviour.rb

@@ -0,0 +1,77 @@
+module Nemah
+  module SpecificNeed
+    module MineralBehaviour
+      def max(decimals: 2)
+        _max
+      end
+
+      private
+
+      def _ideal
+        _min
+      end
+
+      def _min
+        horse.weight_in_deciton * energy_and_workload_factor
+      end
+
+      def _max
+        Float::INFINITY
+      end
+
+      def energy_and_workload_factor
+        EnergyWorkloadRatio.new(energy.for_workload, energy.for_maintenance, factor_table).factor
+      end
+
+      def energy
+        need.energy
+      end
+
+      def factor_table
+        raise NotImplementedError, 'factor_table must return an instance of FactorTable'
+      end
+
+      class FactorTable
+        attr_reader :no_work, :below_30, :below_50, :below_75, :above_75
+
+        def initialize(factors)
+          @no_work = factors.fetch(:no_work)
+          @below_30 = factors.fetch(:below_30)
+          @below_50 = factors.fetch(:below_50)
+          @below_75 = factors.fetch(:below_75)
+          @above_75 = factors.fetch(:above_75)
+        end
+      end
+
+      class EnergyWorkloadRatio
+        def initialize(workload_energy, maintenance_energy, factor_table)
+          @workload_energy = workload_energy
+          @maintenance_energy = maintenance_energy
+          @factor_table = factor_table
+        end
+
+        def factor
+          if workload_energy_quota == 0
+            factor_table.no_work
+          elsif workload_energy_quota < 0.30
+            factor_table.below_30
+          elsif workload_energy_quota < 0.50
+            factor_table.below_50
+          elsif workload_energy_quota < 0.75
+            factor_table.below_75
+          else
+            factor_table.above_75
+          end
+        end
+
+        private
+
+        attr_reader :workload_energy, :maintenance_energy, :factor_table
+
+        def workload_energy_quota
+          workload_energy.to_f / maintenance_energy.to_f
+        end
+      end
+    end
+  end
+end