diviner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5467393bad061b6c9adef478d9262d95b4fcfeba
+  data.tar.gz: 84806c7d1c6069e34c2403cf8e827d5c47694e1b
+SHA512:
+  metadata.gz: 81db9f09664de05cea912fea3bd44debcfa5c359bfd7af1ee0642c76b6ff25c61f541d67f02b67c1468aacf2776f5842bd9dccd16a53d3d6dd98ef63574c757c
+  data.tar.gz: 9672ed16414963131c794deebfd11b341f0f3c9ac0635c6c5aaf83a06b45960d7848e3561005f029c2de1be8c0503644705fdadfa2eda76a53febf1eb25323ee

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'ruby-stemmer'
+gem 'picky'
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler", "~> 2.0.1"
+  gem "simplecov", ">= 0"
+  gem 'test-unit'
+end

data/Gemfile.lock

@@ -0,0 +1,97 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.6)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.4.0)
+    builder (3.2.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    docile (1.1.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    github_api (0.14.0)
+      addressable (~> 2.4.0)
+      descendants_tracker (~> 0.0.4)
+      faraday (~> 0.8, < 0.10)
+      hashie (>= 3.4)
+      oauth2
+    hashie (3.4.4)
+    highline (1.7.8)
+    i18n (0.7.0)
+    jeweler (2.0.1)
+      builder
+      bundler (>= 1.0)
+      git (>= 1.2.5)
+      github_api
+      highline (>= 1.6.15)
+      nokogiri (>= 1.5.10)
+      rake
+      rdoc
+    json (1.8.3)
+    jwt (1.5.1)
+    mini_portile2 (2.1.0)
+    minitest (5.9.0)
+    multi_json (1.12.1)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    nokogiri (1.6.8)
+      mini_portile2 (~> 2.1.0)
+      pkg-config (~> 1.1.7)
+    oauth2 (1.1.0)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 1.0, < 1.5.2)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    picky (4.31.3)
+      activesupport
+      multi_json (~> 1.3)
+      rack_fast_escape (~> 2009.0)
+    pkg-config (1.1.7)
+    power_assert (0.2.7)
+    rack (1.6.4)
+    rack_fast_escape (2009.06.24)
+      url_escape
+    rake (11.2.2)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    ruby-stemmer (0.9.6)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.2.1)
+    shoulda-matchers (2.8.0)
+      activesupport (>= 3.0.0)
+    simplecov (0.11.2)
+      docile (~> 1.1.0)
+      json (~> 1.8)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    test-unit (3.1.5)
+      power_assert
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    url_escape (2009.06.24)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  jeweler (~> 2.0.1)
+  picky
+  rdoc (~> 3.12)
+  ruby-stemmer
+  shoulda
+  simplecov
+  test-unit
+
+BUNDLED WITH
+   1.12.5

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Ferhat Ziba
+
+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.rdoc

@@ -0,0 +1,52 @@
+= diviner
+
+Inspired by http://bernhardwenzel.com/blog/2013/08/26/google-shopping-taxonomy-algorithm/
+
+It matches from a list of categories the right category to a Product.
+
+A Python version is here: https://github.com/BernhardWenzel/google-taxonomy-matcher
+
+
+== Example
+
+The keys are the method names from your product model.
+
+  keys = [:name, :description, :categories]
+
+You tell in weights how important is that attribute.
+
+  weights = {categories: 3, name: 2, description: 1}
+
+
+That is how you use the matcher
+
+  matcher = Deviner::Match.new(weights)
+  matcher.model(product, keys)
+
+  matcher.match(Category.all) # result will be the matching category
+
+
+If your category parent is not category or the name from your category is not name, then you can change it, by giving it in the options fields
+
+  options = {language: 'de',
+             query_method: :name,
+             parent_method: :category,
+             has_parent: true}
+
+  matcher = Deviner::Match.new(weights)
+
+
+== Contributing to diviner
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2016 Ferhat Ziba. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.name = "diviner"
+  gem.homepage = "http://github.com/fero46/diviner"
+  gem.license = "MIT"
+  gem.summary = "It matches from a list of categories the right category to a Product."
+  gem.description = "It matches from a list of categories the right category to a Product."
+  gem.email = "fero.ziba@gmail.com"
+  gem.authors = ["Ferhat Ziba"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "diviner #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/diviner.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: diviner 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "diviner"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Ferhat Ziba"]
+  s.date = "2016-06-13"
+  s.description = "It matches from a list of categories the right category to a Product."
+  s.email = "fero.ziba@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "diviner.gemspec",
+    "lib/deviner/match.rb",
+    "lib/diviner.rb",
+    "test/helper.rb",
+    "test/test_diviner.rb"
+  ]
+  s.homepage = "http://github.com/fero46/diviner"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.8"
+  s.summary = "It matches from a list of categories the right category to a Product."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ruby-stemmer>, [">= 0"])
+      s.add_runtime_dependency(%q<picky>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<test-unit>, [">= 0"])
+    else
+      s.add_dependency(%q<ruby-stemmer>, [">= 0"])
+      s.add_dependency(%q<picky>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<test-unit>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ruby-stemmer>, [">= 0"])
+    s.add_dependency(%q<picky>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<test-unit>, [">= 0"])
+  end
+end
+

data/lib/deviner/match.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+module Deviner
+  class Match
+    require 'rubygems'
+    require 'lingua/stemmer'
+    require 'picky'
+
+    def initialize(weight=nil, options={})
+      @weights=weight
+      self.options.merge(options)
+    end
+
+
+    def constrains key
+      if @weights.present?
+        return {weight: Picky::Weights::Constant.new(@weights[key].to_i)}
+      else
+        return {weight: Weights::Constant.new()}
+      end
+    end
+
+    def options
+      {language: 'de',
+       query_method: :name,
+       parent_method: :category,
+       has_parent: true}
+    end
+
+    def index(model, keys)
+      myoptions = options
+      myconstrains = proc {|e| constrains(e) }
+      index = Picky::Index.new :model do
+        indexing stems_with: Lingua::Stemmer.new(language: myoptions[:language]),
+                 substitutes_characters_with: Picky::CharacterSubstituters::WestEuropean.new
+
+        for key in keys
+          category key, myconstrains.call(key)
+        end
+      end
+      index.add model
+      index
+    end
+
+    def model(model, keys)
+      @index = index(model, keys)
+      @keys = keys
+      clear_cache
+    end
+
+    def match(categories)
+      result = []
+      for category in categories
+          score = score(category)
+          result << {value: score,  category: category}
+      end
+
+      highest_value = result.map{|x| x[:value]}.sort.last
+      selected_category = nil
+      result.each do |hash|
+        if hash[:value] == highest_value
+          selected_category = hash[:category]
+        end
+      end
+
+      return selected_category
+
+    end
+
+
+    def cache
+      @cache||={}
+    end
+
+    def clear_cache
+      @cache={}
+    end
+
+    def score(category)
+      return 0 if category == nil
+      query = category.send(options[:query_method])
+      query = prepare_query(query)
+      return  cache[query] if cache[query] != nil
+      search = Picky::Search.new @index
+      result = search.search(query)
+      if options[:has_parent]
+        parent = category.send(options[:parent_method])
+      else
+        parent = nil
+      end
+      cache[query] = result.total + score(parent)
+    end
+
+    def prepare_query query
+      query.gsub(",", " OR ").
+            gsub("&", " OR ").
+            gsub("ü", "ue").
+            gsub("ö", "oe").
+            gsub("ä", "ae").
+            gsub("Ü", "Ue").
+            gsub("Ö", "Oe").
+            gsub("Ä", "Ae")
+    end
+
+  end
+end

data/lib/diviner.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+module Deviner
+  autoload :Match, 'deviner/match'
+end

data/test/helper.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+Encoding.default_external = Encoding::UTF_8
+
+require 'simplecov'
+require 'open-uri'
+require 'net/http'
+
+module SimpleCov::Configuration
+  def clean_filters
+    @filters = []
+  end
+end
+
+SimpleCov.configure do
+  clean_filters
+  load_profile 'test_frameworks'
+end
+
+ENV["COVERAGE"] && SimpleCov.start do
+  add_filter "/.rvm/"
+end
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+
+TestCategory = Struct.new :name, :category
+
+def TestCategory.name
+  self[:name]
+end
+
+def TestCategory.category
+  self[:category]
+end
+
+
+firstline = true
+stack = ["dummy"]
+@categories = []
+
+uri = URI("https://www.google.com/basepages/producttype/taxonomy.de-DE.txt")
+taxonomies = Net::HTTP.get(uri).force_encoding("UTF-8")
+
+taxonomies.each_line do |line|
+
+  if firstline
+    firstline = false
+    next
+  end
+
+  names = line.split(" > ").map{|x| x.strip}
+
+  if stack.length > names.length
+    stack.pop
+  end
+
+  if stack.length == names.length
+    stack.pop
+  end
+
+  parent = stack.last
+  category = TestCategory.new(names.last,parent)
+  stack.push(category)
+  @categories << category
+end
+
+
+puts @categories
+
+class MyTestCategory
+
+  def self.categories=(categories)
+    @categories = categories
+  end
+
+  def self.categories
+    @categories
+  end
+end
+
+MyTestCategory.categories= @categories
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'diviner'
+
+class Test::Unit::TestCase
+end

data/test/test_diviner.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+require 'helper'
+
+class TestDiviner < Test::Unit::TestCase
+  should "find simple testcase" do
+    Product = Struct.new :id, :name, :description, :categories
+    keys = [:name, :description, :categories]
+    weights = {categories: 3, name: 2, description: 1}
+    model = Product.new(1,  "Weleda Calendula Massageöl, 100 ml",
+                            "Das Calendula Massageöl für zarte und empfindliche Haut von Weleda
+                                      gibt belebende, wohlig wärmende Impulse. Das hochwertige Hautfunktionsöl
+                                      ist durch schonend hergestellte Ölauszüge von beruhigenden Ringelblumen- und
+                                      Kamillenblüten sowie Birkenblättern auch für empfindliche Haut gut geeignet.
+                                      Auf der Basis von reinem Sonnenblumenöl unterstützt es die natürliche Hautfunktion
+                                      wie z.B. das gesunde Fett-Feuchtigkeitsgleichgewicht der Haut.
+                                      für glatte und geschmeidige Haut  aufgrund hervorragender Gleitfähigkeit besonders
+                                      gut für Massagen  dezent-frischer Citrusduft  belebt die Sinne und verbreitet gute
+                                      Laune  für empfindliche und zarte Haut",
+                         "Drogerie / Körperpflege / Creme, Lotion & Öl / Öl")
+    matcher = Deviner::Match.new(weights)
+    matcher.model(model, keys)
+    assert_equal "Massageöle", matcher.match(MyTestCategory.categories).name
+  end
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: diviner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ferhat Ziba
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-stemmer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: picky
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: test-unit
+  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: It matches from a list of categories the right category to a Product.
+email: fero.ziba@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- ".document"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- diviner.gemspec
+- lib/deviner/match.rb
+- lib/diviner.rb
+- test/helper.rb
+- test/test_diviner.rb
+homepage: http://github.com/fero46/diviner
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: It matches from a list of categories the right category to a Product.
+test_files: []