inci_score 2.0.2 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64259796b3d4a9d134999b66cdbd9bf869340ee5
-  data.tar.gz: ab5a536ebc4841ab86d3f3a3e5d70a88c146b81b
+  metadata.gz: a58af371501ff4990b40385d05ae7589a946378f
+  data.tar.gz: e5f9a46ee5ab3c29a936c3598a10de2755f50686
 SHA512:
-  metadata.gz: a03e0a913ab6c41350a2305de482801abafa191a249e5fe73437e2a444e0e25c0be9f8479f7c442134ca7ed663d8fef63ef7f985d43aeb05d62e33706fe29f42
-  data.tar.gz: 3be018bbc1b8e64cae32bd810161237f50187a1f3e430489968ad865b771450b150ea28b59e3aea841a3c92d31b5f30bebd28c9e8b25ec8c4acf1de5a26565ae
+  metadata.gz: 3ddcaa818e14bdca461c235d11082b83512ec29a6f478d8a797252bfbb98a3377d2c06ad0af21ba0a88df512bcbffd1657fe0dcb8374bd5ac05d46e84c1afdbc
+  data.tar.gz: 75d995e0ce1e3a755e36a074ddace8d51d57d58d15f6720e3a2e6aeb407fbfd8bdb1f1276648ca74cc1372556763455c5caf7d9abbaa994d79af6cf03fbd7187

data/README.md

@@ -7,17 +7,16 @@
   * [Sources](#sources)
 * [API](#api)
   * [Unrecognized components](#unrecognized-components)
-* [Web API](#web-api)
-  * [Starting Puma](#starting-puma)
-  * [Triggering a request](#triggering-a-request)
-* [CLI API](#cli-api)
+* [CLI](#cli)
   * [Refresh catalog](#refresh-catalog)
+  * [HTTP server](#http-server)
+    * [Triggering a request](#triggering-a-request)
+  * [Getting help](#getting-help)
 * [Benchmark](#benchmark)
   * [Levenshtein in C](#levenshtein-in-c)
   * [Platform](#platform)
   * [Wrk](#wrk)
   * [Results](#results)
-  * [Ruby 2.4](#ruby-2.4)
 
 ## Scope
 This gem computes the score of cosmetic components basing on the information provided by the [Biodizionario site](http://www.biodizionario.it/) by Fabrizio Zago.
@@ -74,30 +73,11 @@ inci.unrecognized
 => ["noent1", "noent2"]
 ```
 
-## Web API
-The Web API exposes the *InciScore* library over HTTP via the [Puma](http://puma.io/) application server.
+## CLI
+You can collect INCI data by using the available CLI interface:
 
-### Starting Puma
-Simply start Puma via the *config.ru* file included in the repository by spawning how many workers as your current workstation supports:
 ```shell
-bundle exec puma -w 8 -t 0:2 --preload
-```
-
-### Triggering a request
-The Web API responds with a JSON object representing the original *InciScore::Response* one.  
-
-You can pass the source string directly as a HTTP parameter:
-
-```shell
-curl http://127.0.0.1:9292?src=aqua,dimethicone
-=> {"components":{"aqua":0,"dimethicone":4},"unrecognized":[],"score":53.762874945799766,"valid":true}
-```
-
-## CLI API
-You can collect INCI data by using the available binary:
-
-```shell
-inci_score --src="aqua,dimethicone,pej-10,noent"
+inci_score --src="ingredients: aqua, dimethicone, pej-10, noent"
 
 TOTAL SCORE:
         47.18034913243358
@@ -112,9 +92,37 @@ UNRECOGNIZED:
 ```
 
 ### Refresh catalog
-When using CLI you have the option to fetch a fresh catalog from remote by specifyng a flag:
+You also have the option to fetch a fresh catalog from www.biodizionario.it  by specifyng a flag:
+```shell
+inci_score --fresh --src="aqua, dimethicone"
+```
+
+### HTTP server
+The CLI interface exposes a Web layer based on the [Puma](http://puma.io/) application server.
+The HTTP server is started on the specified port by spawning as many workers as your current workstation supports:
+```shell
+inci_score --http=9292
+```
+Consider all other options are discarded when running HTTP server.
+
+#### Triggering a request
+The HTTP server responds with a JSON representation of the original *InciScore::Response* object.  
+You can pass the source string directly as a HTTP parameter:
+
+```shell
+curl http://127.0.0.1:9292?src=aqua,dimethicone
+=> {"components":{"aqua":0,"dimethicone":4},"unrecognized":[],"score":53.762874945799766,"valid":true}
+```
+
+### Getting help
+You can get CLI interface help by:
 ```shell
-inci_score --fresh --src="aqua,dimethicone,pej-10,noent"
+inci_score --help
+Usage: ./bin/inci_score --src='aqua, parfum, etc' --fresh
+    -s, --src=SRC                    The INCI list: 'aqua, parfum, etc'
+    -f, --fresh                      Fetch a fresh catalog from remote
+        --http=PORT                  Start Puma server on the specified port
+    -h, --help                       Prints this help
 ```
 
 ## Benchmark
@@ -123,7 +131,6 @@ inci_score --fresh --src="aqua,dimethicone,pej-10,noent"
 I noticed the APIs slows down dramatically when dealing with unrecognized components to fuzzy match on.  
 I profiled the code by using the [benchmark-ips](https://github.com/evanphx/benchmark-ips) gem, finding the bottleneck was the pure Ruby implementation of the Levenshtein distance algorithm.  
 After some pointless optimization, i replaced this routine with a C implementation: i opted for the straightforward [Ruby Inline](https://github.com/seattlerb/rubyinline) library to call the C code straight from Ruby.  
-As a result i've got a 10x increment of the throughput, all without scarifying code readability.
 
 ### Platform
 I registered these benchmarks with a MacBook PRO 15 mid 2015 having these specs:
@@ -141,11 +148,7 @@ wrk -t 4 -c 100 -d 30s --timeout 2000 http://127.0.0.1:9292/?src=<list_of_ingred
 ```
 
 ### Results
-| Type               | Ingredients              | Throughput (req/s) | Latency in ms (avg/stdev/max) |
-| :----------------- | :----------------------- | -----------------: | ----------------------------: |
-| exact matching     | aqua,parfum,zeolite      |           48863.58 |               0.31/0.55/10.82 |
-
-## Ruby 2.4
-After upgrading to Ruby 2.4 i doubled the throughput of the matcher (24008.11 vs 48863.58 req/s): i assume Ruby optimization to the [Hash access](https://blog.heroku.com/ruby-2-4-features-hashes-integers-rounding) is the driving reason.  
-I also adopted the new #match? method to avoid creating a MatchData object when i am just checking for predicate.  
-In the end Ruby upgrade is a big deal for my gem and i recommend to give it a try!
+| Ingredients              | Throughput (req/s) | Latency in ms (avg/stdev/max) |
+| :----------------------- | -----------------: | ----------------------------: |
+| aqua,parfum,zeolite      |           26054.91 |               0.63/1.03/79.86 |
+| agua,porfum,zaolite      |             953.44 |              14.67/5.15/82.31 |

data/Rakefile

@@ -13,6 +13,12 @@ namespace :spec do
     t.libs << 'lib'
     t.test_files = FileList['spec/integration/*_spec.rb']
   end
+
+  Rake::TestTask.new(:bench) do |t|
+    t.libs << 'spec'
+    t.libs << 'lib'
+    t.test_files = FileList['spec/bench/*_bench.rb']
+  end
 end
 
 task :default => :"spec:unit"

data/config.ru

@@ -1,3 +1,3 @@
-require 'inci_score/api/app'
+require 'inci_score/app'
 
-run InciScore::API::App
+run InciScore::App

data/lib/inci_score/app.rb

@@ -0,0 +1,19 @@
+require 'rack'
+require 'inci_score'
+
+module InciScore
+  module App
+    extend self
+
+    def catalog
+      @catalog ||= Catalog.fetch
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+      src = req.params["src"]
+      json = src ? Computer.new(src: src, catalog: catalog).call.to_json : %q({"error": "no valid source"})
+      ['200', {'Content-Type' => 'application/json'}, [json]]
+    end
+  end
+end

data/lib/inci_score/cli.rb

@@ -1,5 +1,6 @@
 require "optparse"
 require "inci_score/computer"
+require "inci_score/server"
 
 module InciScore
   class CLI
@@ -9,10 +10,12 @@ module InciScore
       @catalog = catalog
       @src = nil
       @fresh = nil
+      @port = nil
     end
 
-    def call(computer_klass = Computer, fetcher = Fetcher.new)
+    def call(server_klass: Server, computer_klass: Computer, fetcher: Fetcher.new)
       parser.parse!(@args)
+      return server_klass.new(port: @port, preload: true).run if @port
       return @io.puts("Specify inci list as: --src='aqua, parfum, etc'") unless @src
       @io.puts computer_klass.new(src: @src, catalog: catalog(fetcher)).call
     end
@@ -29,6 +32,10 @@ module InciScore
           @fresh = fresh
         end
 
+        opts.on("--http=PORT", "Start Puma server on the specified port") do |port|
+          @port = port
+        end
+
         opts.on("-h", "--help", "Prints this help") do
           @io.puts opts
           exit

data/lib/inci_score/fetcher.rb

@@ -21,21 +21,19 @@ module InciScore
       end
     end
 
-    private
-
-    def doc
+    private def doc
       @src.respond_to?(:value) ? @src.value : @src
     end
 
-    def semaphore(src)
+    private def semaphore(src)
       src.match(/(#{SEMAPHORES.join('|')}).gif$/)[1]
     end
 
-    def normalize(node)
+    private def normalize(node)
       node.text.strip.downcase
     end
 
-    def swap?(desc)
+    private def swap?(desc)
       return false if desc.empty?
       desc == desc.upcase
     end

data/lib/inci_score/recognizer.rb

@@ -13,9 +13,8 @@ module InciScore
     def call
       @component = @rules.reduce(nil) do |component, rule|
         break(component) if component
-        _rule = rule.new(@src, @catalog)
         yield(rule) if block_given?
-        _rule.call
+        rule.call(@src, @catalog)
       end
       [@component, @catalog[@component]] if @component
     end 

data/lib/inci_score/recognizer_rules.rb

@@ -4,36 +4,29 @@ module InciScore
   using Refinements
   class Recognizer
     module Rules
-      class Base
-        TOLERANCE = 3
+      TOLERANCE = 3
 
-        def initialize(src, catalog)
-          @src = src
-          @catalog = catalog
-        end
+      module Key
+        extend self
 
-        def call
-          fail NotmplementedError
+        def call(src, catalog)
+          src if catalog.has_key?(src)
         end
       end
 
-      class Key < Base
-        def call
-          @src if @catalog.has_key?(@src)
-        end
-      end
+      module Levenshtein
+        extend self
 
-      class Levenshtein < Base
         ALTERNATE_SEP  = '/'
 
-        def call
-          size = @src.size
-          initial = @src[0]
-          component, distance = @catalog.reduce([nil, size]) do |min, (_component, _)|
+        def call(src, catalog)
+          size = src.size
+          initial = src[0]
+          component, distance = catalog.reduce([nil, size]) do |min, (_component, _)|
             next min unless _component.start_with?(initial)
             match = (n = _component.index(ALTERNATE_SEP)) ? _component[0, n] : _component
             next min if match.size > (size + TOLERANCE)
-            dist = @src.distance(match)
+            dist = src.distance(match)
             min = [_component, dist] if dist < min[1]
             min
           end
@@ -41,34 +34,36 @@ module InciScore
         end
       end
 
-      class Digits < Base
+      module Digits
+        extend self
+
         MIN_MEANINGFUL = 7
 
-        def call
-          return if @src.size < TOLERANCE
-          digits = @src[0, MIN_MEANINGFUL]
-          @catalog.detect do |component, _| 
+        def call(src, catalog)
+          return if src.size < TOLERANCE
+          digits = src[0, MIN_MEANINGFUL]
+          catalog.detect do |component, _| 
             component.matches?(/^#{Regexp::escape(digits)}/)
           end.to_a.first
         end
       end
 
-      class Tokens < Base
+      module Tokens
+        extend self
+
         UNMATCHABLE = %w[extract oil sodium acid sulfate]
       
-        def call
-          tokens.each do |token|
-            @catalog.each do |component, _| 
+        def call(src, catalog)
+          tokens(src).each do |token|
+            catalog.each do |component, _| 
               return component if component.matches?(/\b#{Regexp.escape(token)}\b/)
             end
           end
           nil
         end
 
-        private 
-        
-        def tokens
-          (@src.split(' ') - UNMATCHABLE).reject { |t| t.size < TOLERANCE }.sort_by!(&:size).reverse!
+        def tokens(src)
+          (src.split(' ') - UNMATCHABLE).reject { |t| t.size < TOLERANCE }.sort_by!(&:size).reverse!
         end
       end
     end

data/lib/inci_score/server.rb

@@ -0,0 +1,35 @@
+require 'etc'
+require 'puma'
+
+module InciScore
+  class Server
+    DEFAULT_HOST = "0.0.0.0"
+
+    def initialize(port: 9292, threads: "1:2", workers: Etc.nprocessors, preload: false, 
+                   config_klass: Puma::Configuration, launcher_klass: Puma::Launcher)
+      @port = port
+      @workers = workers
+      @threads = threads.split(":")
+      @preload = preload
+      @config_klass = config_klass
+      @launcher_klass = launcher_klass
+    end
+
+    def run
+      launcher.run
+    end
+
+    private def launcher
+      @launcher_klass.new(config)
+    end
+
+    private def config
+      @config_klass.new do |c|
+        c.bind "tcp://#{DEFAULT_HOST}:#{@port}"
+        c.workers @workers if @workers > 1
+        c.threads *@threads
+        c.preload_app! if @preload
+      end
+    end
+  end
+end

data/lib/inci_score/version.rb

@@ -1,3 +1,3 @@
 module InciScore
-  VERSION = "2.0.2"
+  VERSION = "2.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inci_score
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.1
 platform: ruby
 authors:
 - costajob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-03 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -143,7 +143,7 @@ files:
 - ext/levenshtein.c
 - inci_score.gemspec
 - lib/inci_score.rb
-- lib/inci_score/api/app.rb
+- lib/inci_score/app.rb
 - lib/inci_score/catalog.rb
 - lib/inci_score/cli.rb
 - lib/inci_score/computer.rb
@@ -157,6 +157,7 @@ files:
 - lib/inci_score/response.rb
 - lib/inci_score/score.rb
 - lib/inci_score/scorer.rb
+- lib/inci_score/server.rb
 - lib/inci_score/version.rb
 - log/.gitignore
 homepage: https://github.com/costajob/inci_score.git

data/lib/inci_score/api/app.rb

@@ -1,21 +0,0 @@
-require 'rack'
-require 'inci_score'
-
-module InciScore
-  module API
-    module App
-      extend self
-
-      def catalog
-        @catalog ||= Catalog.fetch
-      end
-
-      def call(env)
-        req = Rack::Request.new(env)
-        src = req.params["src"]
-        json = src ? Computer.new(src: src, catalog: catalog).call.to_json : %q({"error": "no valid source"})
-        ['200', {'Content-Type' => 'application/json'}, [json]]
-      end
-    end
-  end
-end