inci_score 4.2.1 → 4.5.0

data/config/hazards.yml

@@ -1,31 +1,29 @@
-- peg-
-- ppg-
-- dea-
-- mipa-
-- edta-
-- thicone
-- siloxane
-- chlorexidine
-- petrolatum
-- paraffinum liquidum
-- carbomer
-- crosspolymer
-- acrylate
-- styrene
-- copolymer
-- triethanolamine
-- triclosan
-- dmdm
-- hydantoin
-- imidazolidinyl urea
-- diazolidinyl urea
-- formaldheyde
-- methylchloroisothiazolinone
-- methylisothiazolinone
-- sodium hydroxymethylglycinate
-- nonoxynol
-- poloxamer
-- trimonium
-- dimonium
-- glycol
-- glicol
+---
+peg-: 3
+ppg-: 3
+dea-: 3
+mipa-: 3
+edta-: 4
+thicone: 4
+siloxane: 4
+chlorexidine: 4
+petrolatum: 3
+paraffinum: 3
+carbomer: 3
+crosspolymer: 3
+acrylate: 3
+styrene: 3
+copolymer: 3
+triethanolamine: 3
+triclosan: 4
+dmdm: 3
+hydantoin: 3
+imidazolidinyl: 4
+diazolidinyl: 3
+methylchloroisothiazolinone: 3
+methylisothiazolinone: 3
+nonoxynol: 4
+poloxamer: 3
+trimonium: 3
+dimonium: 3
+glycol: 3

data/lib/inci_score/config.rb

@@ -5,6 +5,7 @@ require 'yaml'
 module InciScore
   module Config
     CATALOG = YAML::load_file(File::expand_path('../../../config/catalog.yml', __FILE__)).freeze
+    CIR = File.readlines(File::expand_path('../../../config/cir', __FILE__)).freeze
     HAZARDS = YAML::load_file(File::expand_path('../../../config/hazards.yml', __FILE__)).freeze
   end
 end

data/lib/inci_score/ingredient.rb

@@ -5,14 +5,13 @@ module InciScore
     SLASH = '/'
     SLASH_RULE = /(?<!ate)\//.freeze
     PARENTHESIS = %w[( ) [ ]].freeze
-    DETAILS_RULE = /(\(.+\)|\[.+\])/.freeze
+    PARENTHESIS_RULE = /(\(.+\)|\[.+\])/.freeze
 
-    attr_reader :raw, :tokens, :values
+    attr_reader :raw, :values
 
     def initialize(raw)
       @raw = raw.to_s
-      @tokens = @raw.split(SLASH_RULE).map(&:strip)
-      @values ||= synonims.unshift(name).compact
+      @values = fetch_values
       freeze
     end
 
@@ -22,13 +21,15 @@ module InciScore
 
     private
 
-    def name
-      return tokens.first unless parenthesis?
-      raw.sub(DETAILS_RULE, '').strip
-    end
-
-    def synonims
-      tokens[1, tokens.size].to_a
+    def fetch_values
+      if parenthesis?
+        parenthesis = PARENTHESIS.join
+        parenthesis_values = raw.match(PARENTHESIS_RULE).captures.map { |c| c.delete(parenthesis) }
+        deparenthesized = raw.sub(PARENTHESIS_RULE, '').sub(/\s+/, ' ').strip
+        [deparenthesized].concat(parenthesis_values)
+      else
+        raw.split(SLASH_RULE).map(&:strip)
+      end
     end
 
     def parenthesis?

data/lib/inci_score/recognizer.rb

@@ -4,12 +4,10 @@ module InciScore
   class Recognizer
     DEFAULT_RULES = [Rules::Key, Rules::Levenshtein, Rules::Hazard, Rules::Prefix, Rules::Tokens].freeze
 
-    Component = Struct.new(:name, :hazard)
-
     attr_reader :ingredient, :rules, :applied
 
-    def initialize(ingredient, rules = DEFAULT_RULES, wrapper = Ingredient)
-      @ingredient = wrapper.new(ingredient)
+    def initialize(ingredient, rules = DEFAULT_RULES)
+      @ingredient = Ingredient.new(ingredient)
       @rules = rules
       @applied = []
       freeze
@@ -17,9 +15,7 @@ module InciScore
 
     def call
       return if ingredient.to_s.empty?
-      component = find_component
-      return unless component
-      Component.new(component, Config::CATALOG[component])
+      find_component
     end
 
     private

data/lib/inci_score/recognizer_rules.rb

@@ -7,14 +7,23 @@ module InciScore
     module Rules
       TOLERANCE = 3
 
-      Key = ->(src) { src if Config::CATALOG.has_key?(src) }
+      Component = Struct.new(:name, :hazard)
 
-      Hazard = ->(src) { 'generic-hazard' if Config::HAZARDS.any? { |h| src.include?(h) } }
+      Key = ->(src) do
+        score = Config::CATALOG[src]
+        Component.new(src, score) if score
+      end
+
+      Hazard = ->(src) do
+        if hazard = Config::HAZARDS.detect { |name, _| src.include?(name) }
+          Component.new(src, hazard.last)
+        end
+      end
 
       module Levenshtein
         extend self
 
-        Result = Struct.new(:name, :distance) do
+        Result = Struct.new(:name, :distance, :score) do
           def tolerable?(size)
             distance < TOLERANCE && distance <= (size-1)
           end
@@ -25,14 +34,14 @@ module InciScore
           size = src.size
           farthest = Result.new(nil, size)
           initial = src[0]
-          result = Config::CATALOG.reduce(farthest) do |nearest, (component, _)|
-            next nearest unless component.start_with?(initial)
-            next nearest if component.size > (size + TOLERANCE)
-            d = src.distance(component)
-            nearest = Result.new(component, d) if d < nearest.distance
+          result = Config::CATALOG.reduce(farthest) do |nearest, (name, score)|
+            next nearest unless name.start_with?(initial)
+            next nearest if name.size > (size + TOLERANCE)
+            d = src.distance(name)
+            nearest = Result.new(name, d, score) if d < nearest.distance
             nearest
           end
-          result.name if result.tolerable?(size)
+          Component.new(result.name, result.score) if result.tolerable?(size)
         end
       end
 
@@ -44,7 +53,8 @@ module InciScore
         def call(src)
           return if src.size < TOLERANCE
           digits = src[0, MIN_MEANINGFUL]
-          Config::CATALOG.detect { |component, _| component.start_with?(digits) }.to_a.first
+          pairs = Config::CATALOG.detect { |name, _| name.start_with?(digits) }.to_a.first
+          Component.new(*pairs) if pairs
         end
       end
 
@@ -56,8 +66,8 @@ module InciScore
         def call(src)
           return if src.size <= TOLERANCE
           tokens(src).each do |token|
-            Config::CATALOG.each do |component, _|
-              return component if component.include?(token)
+            Config::CATALOG.each do |name, score|
+              return Component.new(name, score) if name.include?(token)
             end
           end
           nil

data/lib/inci_score/response.rb

@@ -20,16 +20,35 @@ module InciScore
     end
 
     def to_s
+      [score_str, precision_str, components_str, unrecognized_str].join
+    end
+
+    private
+
+    def score_str
       %Q{
 TOTAL SCORE:
-      \t#{score}
+      \t#{score}}
+    end
+
+    def precision_str
+      %Q{
 PRECISION:
-      \t#{precision}
+      \t#{precision}}
+    end
+
+    def components_str
+      return '' if components.empty?
+      %Q{
 COMPONENTS:
-      \t#{components.map { |c| "#{c.name} (#{c.hazard})" }.join(', ')}
+      \t#{components.map { |c| "#{c.name} (#{c.hazard})" }.join(', ')}}
+    end
+
+    def unrecognized_str
+      return '' if unrecognized.empty?
+      %Q{
 UNRECOGNIZED:
-      \t#{unrecognized.join(', ')}
-      }
+      \t#{unrecognized.join(', ')}}
     end
   end
 end

data/lib/inci_score/scorer.rb

@@ -2,7 +2,7 @@
 
 module InciScore
   class Scorer
-    HAZARD_PERCENT = 25
+    HAZARD_RATIO = 25
     WEIGHT_FACTOR = 5
 
     attr_reader :hazards, :size
@@ -15,7 +15,7 @@ module InciScore
 
     def call
       return 0 if hazards.empty?
-      (100 - avg * HAZARD_PERCENT).round(4)
+      (100 - avg * HAZARD_RATIO).round(4)
     end
 
     private
@@ -25,10 +25,8 @@ module InciScore
     end
 
     def avg_weighted
-      return hazards.reduce(&:+) if same_hazard?
-      weighted.reduce(0.0) do |acc,score|
-        acc += score.value
-      end
+      return hazards.sum if same_hazard?
+      weighted.sum(&:value)
     end
 
     def same_hazard?

data/lib/inci_score/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InciScore
-  VERSION = '4.2.1'
+  VERSION = '4.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inci_score
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.5.0
 platform: ruby
 authors:
 - costajob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-04 00:00:00.000000000 Z
+date: 2023-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -106,6 +106,7 @@ files:
 - README.md
 - bin/inci_score
 - config/catalog.yml
+- config/cir
 - config/hazards.yml
 - ext/levenshtein.c
 - lib/inci_score.rb