nutriscore 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 32fc807c0ac252fb44029dd894b01c6e1a73cdb018818683265bcfbaf28e6414
+  data.tar.gz: e52bbc975c607d50c68f308ccb0c374841a8cfc209b2e176b88c2b1ae22cf97c
+SHA512:
+  metadata.gz: 60a6712c438ea99a6ea46560327fa25f8519bc80aefb8e65a3eaf272568f53a4ce08219731656b02f8eada7ed28bc48385173107ed767221d9002334b3d2cda3
+  data.tar.gz: 36571b3a8c1930043e961ef776f5bbdfa958da5f2759cd029ab555ac5354dbbbc9e2251aa11242a9006cc1b27efa401759764bdbd0f8e629529700c346f2c392

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2019 Questionmark
+Copyright (c) 2019 wvengen
+
+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,126 @@
+# Nutriscore
+
+Consumer food products in some countries have a nutritional score, indicating
+how healthy the product is to eat. Each country has its own approach, but in
+the European Union the _Nutri-Score_ in several countries.
+
+This gem implements the Nutri-Score for Ruby and includes adaptations for different
+countries. The maintainer would be open to integrating other nutritional scores as well.
+
+_**Note:** this is currently under development, the API may change without notice,
+and scoring has not yet been fully verified. Be very careful using this in production._
+
+## Nutri-Score
+
+There are currently two versions of the Nutri-Score in use. The first was
+[developed](https://www.food.gov.uk/business-guidance/nutrient-profiling-model-for-children)
+in the UK by the Food Standards Agency and
+[currently maintainted](https://www.gov.uk/government/publications/the-nutrient-profiling-model)
+by the Department of Health. It is used for regulating food advertisements.
+
+In France, an adapted
+[Nutri-Score](https://www.santepubliquefrance.fr/Sante-publique-France/Nutri-Score)
+was adopted in 2017 for use as a voluntary label on the packaging.
+In 2018, Belgium and Spain adopted the same scheme.
+
+Other countries are evaluating adopting the Nutri-Score as well, including
+The Netherlands. There is also a
+[European citizen's initiative](http://ec.europa.eu/citizens-initiative/public/initiatives/ongoing/details/2019/000008)
+to adopt it Europe-wide.
+
+## Installation
+
+```
+gem install nutriscore
+```
+
+## Usage
+
+The input for all nutritional scores are a product category and nutritional values.
+Which nutrients are required depends on the product category.
+
+```ruby
+require 'nutriscore'
+
+# Fruit fromage frais
+product_a = {
+  energy: 459,                 # kJ/100g
+  fat_saturated: 1.8,          #  g/100g
+  sugar: 13.4,                 #  g/100g
+  sodium: 0.1 / 1000,          #  g/100g
+  fruits_vegetables_nuts: 8,   #  g/100g (= weight-%)
+  fibres: 0.6,                 #  g/100g
+  proteins: 6.5,               #  g/100g
+}
+
+# Compute the french Nutri-Score for a generic product.
+score = Nutriscore::FR::SpecificScore.new(product_a)
+#<Nutriscore::FR::SpecificScore score=0
+#  positive_score=#<Nutriscore::FR::PositiveScore score=4
+#                    fruits_vegetables_nuts=0 fibres=0 proteins=4>
+#  negative_score=#<Nutriscore::FR::NegativeScore score=4
+#                    energy=1 fat_saturated=1 sugar=2 sodium=0>>
+score.score.single
+# => 0
+score.score_class.single
+# => "B"
+```
+
+To be able to work with incomplete information, results are returned as ranges.
+The use of `.single` in the above example converts these to a single value (it
+returns `nil` if there is not enough information to get a single result). The
+following example shows what happens when data is missing.
+
+```ruby
+score = Nutriscore::FR::SpecificScore.new(product_a.merge({ sodium: nil }))
+score.score
+# => 0..10
+score.score.single
+# => nil
+score.score_class
+# => "B".."C"
+score.score_class.single
+# => nil
+```
+
+Please only use `#single` and the regular Ruby `Range` methods on `#score` and `#score_class`.
+Other methods do exist, but are not guaranteed to be stable across releases.
+
+Different categories can use different score classes:
+* `Nutriscore::FR::CheeseScore` for cheese
+* `Nutriscore::FR::FatsScore` for vegetable and animal oils and fats
+* `Nutriscore::FR::MineralWaterScore` for mineral water
+* `Nutriscore::FR::DrinksScore` for other drinks
+* `Nutriscore::FR::SpecificScore` for other food products
+
+## UK
+
+The UK has the same basis for computation, but it is used to determine
+whether a product can be advertised (it must not be less healthy).
+
+```ruby
+score = Nutriscore::UK::SpecificScore.new(product_a)
+score.score
+# => 0
+score.less_healthy?
+# => false
+```
+
+The method `#less_healthy?` is UK-specific, and returns `true`, `false`, or `nil`
+if there is not enough information to make a judgement.
+
+By default, the fibres measurement method is AOAC (which is preferred), but
+it is possible to use fibres values measured with the NSP method:
+
+```ruby
+# Acceptable values for the fibres_method are: :aoac and :nsp.
+score = Nutriscore::UK::SpecificScore.new(product_a, fibres_method: :nsp)
+```
+
+Different categories can use different score classes:
+* `Nutriscore::EN::SpecificScore` for food products
+* `Nutriscore::EN::DrinksScore` for drinks
+
+## License
+
+This software is distributed under the [MIT license](LICENSE).

data/lib/nutriscore.rb

@@ -0,0 +1,3 @@
+require_relative 'nutriscore/version'
+require_relative 'nutriscore/fr'
+require_relative 'nutriscore/uk'

data/lib/nutriscore/common/nutrients.rb

@@ -0,0 +1,26 @@
+require_relative 'range'
+
+module Nutriscore
+  module Common
+    class Nutrients
+
+      def self.wrap(o)
+        if o.is_a?(Nutrients)
+          o
+        else
+          Nutrients.new(o)
+        end
+      end
+
+      def initialize(h)
+        @h = h.transform_values {|v| v && Range.wrap(v) }
+      end
+
+      private
+
+      def method_missing(m)
+        @h[m.to_sym]
+      end
+    end
+  end
+end

data/lib/nutriscore/common/range.rb

@@ -0,0 +1,87 @@
+module Nutriscore
+  module Common
+    # Range class that supports addition, substraction and comparison.
+    # Assumes the objects that the range is composed of is a {{Numeric}}.
+    #
+    # Note that the end range is always included (+exclude_end+ is +false+).
+    class Range < ::Range
+      # Returns a {{Nutriscore::Common::Range}} object from a {{Numeric}} or {{Range}}.
+      def self.wrap(a)
+        if Numeric === a
+          Range.new(a, a)
+        elsif Range === a
+          a
+        elsif ::Range  === a
+          Range.new(a.first, a.last)
+        else
+          raise ArgumentError
+        end
+      end
+
+      def +(a)
+        if Numeric === a
+          Range.new(min + a, max + a)
+        elsif ::Range === a
+          Range.new(min + a.min, max + a.max)
+        else
+          raise ArgumentError
+        end
+      end
+
+      def -(a)
+        if Numeric === a
+          Range.new(min - a, max - a)
+        elsif ::Range === a
+          Range.new(min - a.max, max - a.min)
+        else
+          raise ArgumentError
+        end
+      end
+
+      def *(a)
+        if Numeric === a
+          Range.new(min * a, max * a)
+        elsif ::Range === a
+          Range.new(min * a.min, max * a.max)
+        else
+          raise ArgumentError
+        end
+      end
+
+      def /(a)
+        if Numeric === a
+          Range.new(min / a, max / a)
+        elsif ::Range === a
+          Range.new(min / a.max, max / a.min)
+        else
+          raise ArgumentError
+        end
+      end
+
+      def ==(a)
+        if Numeric === a
+          single == a
+        else
+          super
+        end
+      end
+
+      def to_s
+        if min == max
+          min.to_s
+        else
+          super
+        end
+      end
+
+      def inspect
+        to_s
+      end
+
+      # Returns single value if possible, +nil+ if there is a range of values.
+      def single
+        min if min == max
+      end
+    end
+  end
+end

data/lib/nutriscore/common/score.rb

@@ -0,0 +1,42 @@
+require_relative 'nutrients'
+require_relative 'range'
+
+module Nutriscore
+  module Common
+    class Score
+      attr_reader :nutrients
+
+      def self.nutrient_keys
+        []
+      end
+
+      def score
+        self.class.nutrient_keys.map(&method(:public_send)).reduce(&:+)
+      end
+
+      def initialize(nutrients)
+        @nutrients = Nutrients.wrap(nutrients)
+      end
+
+      def inspect
+        "#<#{self.class} score=#{score} #{inspect_nutrients}>"
+      end
+
+      private
+
+      def score_value(value, extremes)
+        if value.nil?
+          Range.wrap(extremes)
+        else
+          Range.new(yield(value.min), yield(value.max))
+        end
+      end
+
+      def inspect_nutrients
+        self.class.nutrient_keys.map do |key|
+          "#{key}=#{public_send(key)}"
+        end.join(" ")
+      end
+    end
+  end
+end

data/lib/nutriscore/common/score_class_range.rb

@@ -0,0 +1,34 @@
+module Nutriscore
+  module Common
+    # Range of possible score classes.
+    #
+    # This is a standard Ruby {{::Range}} for {{String}}s with some additional helper
+    # methods, similar to {{Nutriscore::Common::Range}} (without the computation parts).
+    class ScoreClassRange < ::Range
+      def ==(a)
+        if String === a
+          single == a
+        else
+          super
+        end
+      end
+
+      def to_s
+        if min == max
+          min.to_s
+        else
+          super
+        end
+      end
+
+      def inspect
+        to_s
+      end
+
+      # Returns single value if possible, +nil+ if there is a range of values.
+      def single
+        min if min == max
+      end
+    end
+  end
+end

data/lib/nutriscore/fr.rb

@@ -0,0 +1,5 @@
+require_relative 'fr/cheese_score'
+require_relative 'fr/drinks_score'
+require_relative 'fr/fats_score'
+require_relative 'fr/mineral_water_score'
+require_relative 'fr/specific_score'

data/lib/nutriscore/fr/cheese_score.rb

@@ -0,0 +1,8 @@
+require_relative 'general_score'
+
+module Nutriscore
+  module FR
+    class CheeseScore < GeneralScore
+    end
+  end
+end

data/lib/nutriscore/fr/concerns/drinks_score_class.rb

@@ -0,0 +1,28 @@
+require_relative '../../common/score_class_range'
+
+module Nutriscore
+  module FR
+    module DrinksScoreClass
+      def score_class
+        return nil if score.nil?
+
+        Nutriscore::Common::ScoreClassRange.new(
+          score_class_single(score.min), 
+          score_class_single(score.max)
+        )
+      end
+
+      private
+
+      def score_class_single(score)
+        if   !score      then nil
+        # mineral water has 'A'
+        elsif score < 2  then 'B'
+        elsif score < 6  then 'C'
+        elsif score < 10 then 'D'
+        else                  'E'
+        end
+      end
+    end
+  end
+end

data/lib/nutriscore/fr/concerns/general_score_class.rb

@@ -0,0 +1,28 @@
+require_relative '../../common/score_class_range'
+
+module Nutriscore
+  module FR
+    module GeneralScoreClass
+      def score_class
+        return nil if score.nil?
+
+        Nutriscore::Common::ScoreClassRange.new(
+          score_class_single(score.min), 
+          score_class_single(score.max)
+        )
+      end
+
+      private
+
+      def score_class_single(score)
+        if   !score      then nil
+        elsif score < 0  then 'A'
+        elsif score < 3  then 'B'
+        elsif score < 11 then 'C'
+        elsif score < 19 then 'D'
+        else                  'E'
+        end
+      end
+    end
+  end
+end

data/lib/nutriscore/fr/concerns/mineral_water_score_class.rb

@@ -0,0 +1,11 @@
+require_relative '../../common/score_class_range'
+
+module Nutriscore
+  module FR
+    module MineralWaterScoreClass
+      def score_class
+        Nutriscore::Common::ScoreClassRange.new('A', 'A')
+      end
+    end
+  end
+end

data/lib/nutriscore/fr/drinks_score.rb

@@ -0,0 +1,61 @@
+require_relative '../common/score'
+require_relative 'concerns/drinks_score_class'
+
+module Nutriscore
+  module FR
+    # this is for drinks
+    class DrinksScore < Nutriscore::Common::Score
+      include DrinksScoreClass
+
+      def self.nutrient_keys
+        [:energy, :sugar, :fruits_vegetables]
+      end
+
+      def energy
+        score_value(@nutrients.energy, 0..10) do |v|
+          if    v ==   0 then  0
+          elsif v <=  30 then  1
+          elsif v <=  60 then  2
+          elsif v <=  90 then  3
+          elsif v <= 120 then  4
+          elsif v <= 150 then  5
+          elsif v <= 180 then  6
+          elsif v <= 210 then  7
+          elsif v <= 240 then  8
+          elsif v <= 270 then  9
+          else                10
+          end
+        end
+      end
+
+      def sugar
+        score_value(@nutrients.sugar, 0..10) do |v|
+          if    v == 0   then  0
+          elsif v <  1.5 then  1
+          elsif v <  3   then  2
+          elsif v <  4.5 then  3
+          elsif v <  6   then  4
+          elsif v <  7.5 then  5
+          elsif v <  9   then  6
+          elsif v < 10.5 then  7
+          elsif v < 12   then  8
+          elsif v < 13.5 then  9
+          else                    10
+          end
+        end
+      end
+
+      def fruits_vegetables
+        # the text mentions % but here we use g/100ml
+        # we'd need to either ask for %, ask for g/100g, or require a density ...
+        score_value(@nutrients.fruits_vegetables, 0..10) do |v|
+          if    v > 80 then 10
+          elsif v > 60 then  4
+          elsif v > 40 then  2
+          else                   0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nutriscore/fr/fats_score.rb

@@ -0,0 +1,44 @@
+require_relative '../common/score'
+require_relative 'concerns/general_score_class'
+
+module Nutriscore
+  module FR
+    # this is for vegetable and animal fats and oils
+    class FatsScore < Nutriscore::Common::Score
+      include GeneralScoreClass
+
+      def self.nutrient_keys
+        [:fat_saturated, :fat_total]
+      end
+
+      def score
+        fat_saturated
+      end
+
+      def fat_saturated
+        score_value(fat_saturated_pct, 0..10) do |v|
+          if    v < 10 then  0
+          elsif v < 16 then  1
+          elsif v < 22 then  2
+          elsif v < 28 then  3
+          elsif v < 34 then  4
+          elsif v < 40 then  5
+          elsif v < 46 then  6
+          elsif v < 52 then  7
+          elsif v < 58 then  8
+          elsif v < 64 then  9
+          else              10
+          end
+        end
+      end
+
+      private
+
+      def fat_saturated_pct
+        fat_saturated = @nutrients.fat_saturated
+        fat_total = @nutrients.fat_total
+        fat_saturated * 100 / fat_total if fat_saturated && fat_total
+      end
+    end
+  end
+end

data/lib/nutriscore/fr/general_score.rb

@@ -0,0 +1,33 @@
+require_relative '../common/nutrients'
+require_relative 'concerns/general_score_class'
+require_relative 'positive_score'
+require_relative 'negative_score'
+
+module Nutriscore
+  module FR
+    class GeneralScore
+      include GeneralScoreClass
+
+      attr_reader :positive, :negative
+
+      def self.nutrient_keys
+        PositiveScore.nutrient_keys | NegativeScore.nutrient_keys
+      end
+
+      def initialize(nutrients)
+        @nutrients = Nutriscore::Common::Nutrients.wrap(nutrients)
+        @positive = PositiveScore.new(@nutrients)
+        @negative = NegativeScore.new(@nutrients)
+      end
+
+      def score
+        @negative.score - @positive.score
+      end
+
+      def inspect
+        "#<#{self.class} score=#{score} " +
+          "positive_score=#{@positive.inspect} negative_score=#{@negative.inspect}>"
+      end
+    end
+  end
+end

data/lib/nutriscore/fr/mineral_water_score.rb

@@ -0,0 +1,10 @@
+require_relative 'drinks_score'
+require_relative 'concerns/mineral_water_score_class'
+
+module Nutriscore
+  module FR
+    class MineralWaterScore < DrinksScore
+      include MineralWaterScoreClass
+    end
+  end
+end

data/lib/nutriscore/fr/negative_score.rb

@@ -0,0 +1,80 @@
+require_relative '../common/score'
+
+module Nutriscore
+  module FR
+    class NegativeScore < Nutriscore::Common::Score
+
+      def self.nutrient_keys
+        [:energy, :fat_saturated, :sugar, :sodium]
+      end
+
+      def energy
+        score_value(@nutrients.energy, 0..10) do |v|
+          if    v > 3350 then 10
+          elsif v > 3015 then  9
+          elsif v > 2680 then  8
+          elsif v > 2345 then  7
+          elsif v > 2010 then  6
+          elsif v > 1675 then  5
+          elsif v > 1340 then  4
+          elsif v > 1005 then  3
+          elsif v >  670 then  2
+          elsif v >  335 then  1
+          else                 0
+          end
+        end
+      end
+
+      def fat_saturated
+        score_value(@nutrients.fat_saturated, 0..10) do |v|
+          if    v > 10 then 10
+          elsif v >  9 then  9
+          elsif v >  8 then  8
+          elsif v >  7 then  7
+          elsif v >  6 then  6
+          elsif v >  5 then  5
+          elsif v >  4 then  4
+          elsif v >  3 then  3
+          elsif v >  2 then  2
+          elsif v >  1 then  1
+          else                   0
+          end
+        end
+      end
+
+      def sugar
+        score_value(@nutrients.sugar, 0..10) do |v|
+          if    v > 45   then 10
+          elsif v > 40   then  9
+          elsif v > 36   then  8
+          elsif v > 31   then  7
+          elsif v > 27   then  6
+          elsif v > 22.5 then  5
+          elsif v > 18   then  4
+          elsif v > 13.5 then  3
+          elsif v >  9   then  2
+          elsif v >  4.5 then  1
+          else                 0
+          end
+        end
+      end
+
+      def sodium
+        score_value(@nutrients.sodium, 0..10) do |v|
+          if    v > 900 then 10
+          elsif v > 810 then  9
+          elsif v > 720 then  8
+          elsif v > 630 then  7
+          elsif v > 540 then  6
+          elsif v > 450 then  5
+          elsif v > 360 then  4
+          elsif v > 270 then  3
+          elsif v > 180 then  2
+          elsif v >  90 then  1
+          else                0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nutriscore/fr/positive_score.rb

@@ -0,0 +1,46 @@
+require_relative '../common/score'
+
+module Nutriscore
+  module FR
+    class PositiveScore < Nutriscore::Common::Score
+
+      def self.nutrient_keys
+        [:fruits_vegetables_nuts, :fibres, :proteins]
+      end
+
+      def fruits_vegetables_nuts
+        score_value(@nutrients.fruits_vegetables_nuts, 0..5) do |v|
+          if    v > 80 then 5
+          elsif v > 60 then 2
+          elsif v > 40 then 1
+          else              0
+          end
+        end
+      end
+
+      def fibres
+        score_value(@nutrients.fibres, 0..5) do |v|
+          if    v > 4.7 then 5
+          elsif v > 3.7 then 4
+          elsif v > 2.8 then 3
+          elsif v > 1.9 then 2
+          elsif v > 0.9 then 1
+          else               0
+          end
+        end
+      end
+
+      def proteins
+        score_value(@nutrients.proteins, 0..5) do |v|
+          if    v > 8.0 then 5
+          elsif v > 6.4 then 4
+          elsif v > 4.8 then 3
+          elsif v > 3.2 then 2
+          elsif v > 1.6 then 1
+          else               0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nutriscore/fr/specific_score.rb

@@ -0,0 +1,22 @@
+require_relative 'general_score'
+require_relative '../common/range'
+
+module Nutriscore
+  module FR
+    # this is for general products
+    class SpecificScore < GeneralScore
+      def score
+        if @negative.score.min < 11 || @positive.fruits_vegetables_nuts.max >= 5
+          @negative.score - @positive.score
+        elsif @negative.score.max >= 11 && @positive.fruits_vegetables_nuts.min < 5
+          @negative.score - @positive.score_without_proteins
+        else
+          Range.new(
+            @negative.score.min - @positive.score.max,
+            @negative.score.max - @positive.score_without_proteins.min
+          )
+        end
+      end
+    end
+  end
+end

data/lib/nutriscore/uk.rb

@@ -0,0 +1,2 @@
+require_relative 'uk/drinks_score'
+require_relative 'uk/specific_score'

data/lib/nutriscore/uk/concerns/drinks_less_healthy.rb

@@ -0,0 +1,16 @@
+module Nutriscore
+  module UK
+    module DrinksLessHealthy
+      def less_healthy?
+        # 'A drink is classified as 'less healthy' where it scores 1 point or more.'
+        if score.min >= 1
+          true
+        elsif score.max < 1
+          false
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/nutriscore/uk/concerns/general_less_healthy.rb

@@ -0,0 +1,16 @@
+module Nutriscore
+  module UK
+    module GeneralLessHealthy
+      def less_healthy?
+        # 'A food is classified as 'less healthy' where it scores 4 points or more.'
+        if score.min >= 4
+          true
+        elsif score.max < 4
+          false
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/nutriscore/uk/drinks_score.rb

@@ -0,0 +1,11 @@
+require_relative 'specific_score'
+require_relative 'concerns/drinks_less_healthy'
+
+module Nutriscore
+  module UK
+    # this is for general products
+    class DrinksScore < SpecificScore
+      include DrinksLessHealthy
+    end
+  end
+end

data/lib/nutriscore/uk/general_score.rb

@@ -0,0 +1,33 @@
+require_relative '../common/nutrients'
+require_relative 'concerns/general_less_healthy'
+require_relative 'positive_score'
+require_relative 'negative_score'
+
+module Nutriscore
+  module UK
+    class GeneralScore
+      include GeneralLessHealthy
+
+      attr_reader :positive, :negative
+
+      def self.nutrient_keys
+        PositiveScore.nutrient_keys | NegativeScore.nutrient_keys
+      end
+
+      def initialize(nutrients, fibres_method: :aoac)
+        @nutrients = Nutriscore::Common::Nutrients.wrap(nutrients)
+        @positive = PositiveScore.new(@nutrients, fibres_method: fibres_method)
+        @negative = NegativeScore.new(@nutrients)
+      end
+
+      def score
+        @negative.score - @positive.score
+      end
+
+      def inspect
+        "#<#{self.class} score=#{score} " +
+          "positive_score=#{@positive.inspect} negative_score=#{@negative.inspect}>"
+      end
+    end
+  end
+end

data/lib/nutriscore/uk/negative_score.rb

@@ -0,0 +1,82 @@
+require_relative '../common/score'
+
+module Nutriscore
+  module UK
+    # This is called 'A'-points in the documentation
+    class NegativeScore < Nutriscore::Common::Score
+
+      def self.nutrient_keys
+        [:energy, :fat_saturated, :sugar, :sodium]
+      end
+
+      def energy
+        score_value(@nutrients.energy, 0..10) do |v|
+          if    v > 3350 then 10
+          elsif v > 3015 then  9
+          elsif v > 2680 then  8
+          elsif v > 2345 then  7
+          elsif v > 2010 then  6
+          elsif v > 1675 then  5
+          elsif v > 1340 then  4
+          elsif v > 1005 then  3
+          elsif v >  670 then  2
+          elsif v >  335 then  1
+          else                 0
+          end
+        end
+      end
+
+      def fat_saturated
+        score_value(@nutrients.fat_saturated, 0..10) do |v|
+          if    v > 10 then 10
+          elsif v >  9 then  9
+          elsif v >  8 then  8
+          elsif v >  7 then  7
+          elsif v >  6 then  6
+          elsif v >  5 then  5
+          elsif v >  4 then  4
+          elsif v >  3 then  3
+          elsif v >  2 then  2
+          elsif v >  1 then  1
+          else               0
+          end
+        end
+      end
+
+      def sugar
+        score_value(@nutrients.sugar, 0..10) do |v|
+          if    v > 45   then 10
+          elsif v > 40   then  9
+          elsif v > 36   then  8
+          elsif v > 31   then  7
+          elsif v > 27   then  6
+          elsif v > 22.5 then  5
+          elsif v > 18   then  4
+          elsif v > 13.5 then  3
+          elsif v >  9   then  2
+          elsif v >  4.5 then  1
+          else                 0
+          end
+        end
+      end
+
+      def sodium
+        score_value(@nutrients.sodium, 0..10) do |v|
+          v *= 1000 if v # comparison is in mg/100g
+          if    v > 900 then 10
+          elsif v > 810 then  9
+          elsif v > 720 then  8
+          elsif v > 630 then  7
+          elsif v > 540 then  6
+          elsif v > 450 then  5
+          elsif v > 360 then  4
+          elsif v > 270 then  3
+          elsif v > 180 then  2
+          elsif v >  90 then  1
+          else                0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nutriscore/uk/positive_score.rb

@@ -0,0 +1,66 @@
+require_relative '../common/score'
+
+module Nutriscore
+  module UK
+    # This is called 'C'-points in the documentation
+    class PositiveScore < Nutriscore::Common::Score
+
+      def initialize(nutrients, fibres_method: :aoac, **opts)
+        super(nutrients, **opts)
+        @fibres_method = fibres_method
+      end
+
+      def self.nutrient_keys
+        [:fruits_vegetables_nuts, :fibres, :proteins]
+      end
+
+      def fruits_vegetables_nuts
+        score_value(@nutrients.fruits_vegetables_nuts, 0..5) do |v|
+          if    v > 80 then 5
+          elsif v > 60 then 2
+          elsif v > 40 then 1
+          else              0
+          end
+        end
+      end
+
+      def fibres
+        score_value(@nutrients.fibres, 0..5) do |v|
+          if @fibres_method == :aoac
+            if    v > 4.7 then 5
+            elsif v > 3.7 then 4
+            elsif v > 2.8 then 3
+            elsif v > 1.9 then 2
+            elsif v > 0.9 then 1
+            else               0
+            end
+          elsif @fibres_method == :nsp
+            if    v > 3.5 then 5
+            elsif v > 2.8 then 4
+            elsif v > 2.1 then 3
+            elsif v > 1.4 then 2
+            elsif v > 0.7 then 1
+            else               0
+            end
+          end
+        end
+      end
+
+      def proteins
+        score_value(@nutrients.proteins, 0..5) do |v|
+          if    v > 8.0 then 5
+          elsif v > 6.4 then 4
+          elsif v > 4.8 then 3
+          elsif v > 3.2 then 2
+          elsif v > 1.6 then 1
+          else               0
+          end
+        end
+      end
+
+      def score_without_proteins
+        (self.class.nutrient_keys - [:proteins]).map(&method(:public_send)).compact.reduce(&:+)
+      end
+    end
+  end
+end

data/lib/nutriscore/uk/specific_score.rb

@@ -0,0 +1,24 @@
+require_relative 'general_score'
+require_relative '../common/range'
+
+module Nutriscore
+  module UK
+    # this is for general products
+    class SpecificScore < GeneralScore
+      def score
+        # 'If a food or drink scores 11 or more ‘A’ points then it cannot score points for protein
+        #  unless it also scores 5 points for fruit, vegetables and nuts.'
+        if @negative.score.min < 11 || @positive.fruits_vegetables_nuts.max >= 5
+          @negative.score - @positive.score
+        elsif @negative.score.max >= 11 && @positive.fruits_vegetables_nuts.min < 5
+          @negative.score - @positive.score_without_proteins
+        else
+          Range.new(
+            @negative.score.min - @positive.score.max,
+            @negative.score.max - @positive.score_without_proteins.min
+          )
+        end
+      end
+    end
+  end
+end

data/lib/nutriscore/version.rb

@@ -0,0 +1,4 @@
+module Nutriscore
+  VERSION      = '0.2.0'
+  VERSION_DATE = '2021-06-07'
+end

data/nutriscore.gemspec

@@ -0,0 +1,25 @@
+$:.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
+require 'nutriscore/version'
+
+Gem::Specification.new do |s|
+  s.name             = 'nutriscore'
+  s.version          = Nutriscore::VERSION
+  s.date             = Nutriscore::VERSION_DATE
+  s.summary          = 'Nutri-score computation for food products.'
+  s.authors          = ['wvengen']
+  s.email            = ['dev-ruby@willem.engen.nl']
+  s.homepage         = 'https://github.com/q-m/nutriscore-ruby'
+  s.license          = 'MIT'
+  s.metadata         = {
+    'bug_tracker_uri' => 'https://github.com/q-m/nutriscore-ruby/issues',
+    'source_code_uri' => 'https://github.com/q-m/nutriscore-ruby',
+  }
+
+  s.files            = `git ls-files *.gemspec lib`.split("\n")
+  s.executables      = `git ls-files bin`.split("\n").map(&File.method(:basename))
+  s.extra_rdoc_files = ['README.md', 'LICENSE']
+  s.require_paths    = ['lib']
+
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-its'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: nutriscore
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- wvengen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: rspec-its
+  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: 
+email:
+- dev-ruby@willem.engen.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/nutriscore.rb
+- lib/nutriscore/common/nutrients.rb
+- lib/nutriscore/common/range.rb
+- lib/nutriscore/common/score.rb
+- lib/nutriscore/common/score_class_range.rb
+- lib/nutriscore/fr.rb
+- lib/nutriscore/fr/cheese_score.rb
+- lib/nutriscore/fr/concerns/drinks_score_class.rb
+- lib/nutriscore/fr/concerns/general_score_class.rb
+- lib/nutriscore/fr/concerns/mineral_water_score_class.rb
+- lib/nutriscore/fr/drinks_score.rb
+- lib/nutriscore/fr/fats_score.rb
+- lib/nutriscore/fr/general_score.rb
+- lib/nutriscore/fr/mineral_water_score.rb
+- lib/nutriscore/fr/negative_score.rb
+- lib/nutriscore/fr/positive_score.rb
+- lib/nutriscore/fr/specific_score.rb
+- lib/nutriscore/uk.rb
+- lib/nutriscore/uk/concerns/drinks_less_healthy.rb
+- lib/nutriscore/uk/concerns/general_less_healthy.rb
+- lib/nutriscore/uk/drinks_score.rb
+- lib/nutriscore/uk/general_score.rb
+- lib/nutriscore/uk/negative_score.rb
+- lib/nutriscore/uk/positive_score.rb
+- lib/nutriscore/uk/specific_score.rb
+- lib/nutriscore/version.rb
+- nutriscore.gemspec
+homepage: https://github.com/q-m/nutriscore-ruby
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/q-m/nutriscore-ruby/issues
+  source_code_uri: https://github.com/q-m/nutriscore-ruby
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Nutri-score computation for food products.
+test_files: []