spree_autosuggest 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5b38a670393d80a848069359a6395823e607224
+  data.tar.gz: 3771398c33b1725348eabcea5671ea7486f87088
+SHA512:
+  metadata.gz: f730d30937901a9374273b12f41fc667fa0c4a581f91a8f7612ef132f7ac63470473cdc7b14a764bd8cbd1f720551c61020629cbaf980ceabb3321f19c05d7e3
+  data.tar.gz: 9c0c2265efe52c575dbea8ada953b2c011dca597e7ae064a3235112f15130d50cb8fdc141db0b19b19bf6059c944eb40bb8b9631827cdd542ba2c5be91dbfeaf

data/.gitignore

@@ -0,0 +1,11 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+tmp
+nbproject
+*.swp
+spec/dummy
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

@@ -0,0 +1,2 @@
+source 'http://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright (c) 2012 Demidov Aleksey
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,12 @@
+Spree Autosuggest
+=================
+
+This extension adds suggestions for product search.
+
+### Installation
+
+1. Add to Gemfile: `gem 'spree_autosuggest', :git => 'git://github.com/evrone/spree_autosuggest.git'`
+2. Run `rails g spree_autosuggest:install`
+3. Run `rake spree_autosuggest:seed` to add all Taxon & Product names to the autosuggest database
+
+**NOTE:** This extension works only with Spree 1.0 and higher.

data/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]
+
+spec = eval(File.read('spree_autosuggest.gemspec'))
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+desc "Generates a dummy app for testing"
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_autosuggest'
+  Rake::Task['common:test_app'].invoke
+end

data/Versionfile

@@ -0,0 +1,3 @@
+"1.0.x" => { :branch => "master"}
+"1.1.x" => { :branch => "master"}
+"1.2.x" => { :branch => "master"}

data/app/assets/javascripts/store/autosuggest.js.coffee

@@ -0,0 +1,79 @@
+class @Autosuggest
+  constructor: (selector, options = {}) ->
+    @search_field = $(selector)
+    return if @search_field.length == 0
+
+    @settings =
+      from_db: 15
+      to_display: 5
+      keyswitch: true
+    @settings = $.extend @settings, options
+
+    @cache = {}
+
+    $.extend true, $.ui.autocomplete::, @extension_methods()
+    @search_field.autocomplete(
+      @settings,
+      source: (request, response) =>
+        @finder(request, response))
+      .bind "keydown.autocomplete", (event) =>
+        @fire_keybinds(event)
+
+  # TODO: rewrite
+  fire_keybinds: (event) ->
+    if event.keyCode == $.ui.keyCode.RIGHT
+      elem = $(@search_field.data('autocomplete').menu.active).find('a')
+      if elem.length > 0
+        elem.trigger('click')
+      else
+        $('li.ui-menu-item:first a').trigger('mouseenter').trigger('click')
+
+  finder: (request, response) ->
+    term = request.term.toLowerCase()
+    cached = @from_cache(term)
+    return response cached if cached
+    $.getJSON "/suggestions", request, (data) =>
+      @cache[term] = data
+      response @from_cache(term)
+
+  from_cache: (term) ->
+    result = false
+    $.each @cache, (key, data) =>
+      if term.indexOf(key) is 0 and data.length < @settings.from_db
+        result = @filter_terms(data, term).slice(0, @settings.to_display)
+    result
+
+  filter_terms: (array, term) ->
+      matcher = new RegExp($.ui.autocomplete.escapeRegex(term), "i")
+      $.grep array, (value) =>
+        source = value.label or value.value or value
+
+        return true if matcher.test(source)
+        if @settings.keyswitch
+          matcher.test(@keyswitch(source))
+
+  extension_methods: ->
+    _renderItem: (ul, item) ->
+        item.label = item.label.replace(new RegExp("(" + $.ui.autocomplete.escapeRegex(@term) + ")", "gi"), "<strong>$1</strong>")
+        $("<li></li>").data("item.autocomplete", item).append("<a>" + item.label + "</a>").appendTo ul
+
+  keyswitch: (str) ->
+    ru = "йцукенгшщзхъфывапролджэячсмитьбюёЙЦУКЕНГШЩЗХЪФЫВАПРОЛДЖЭЯЧСМИТЬБЮЁ"
+    en = "qwertyuiop[]asdfghjkl;'zxcvbnm,.`QWERTYUIOP{}ASDFGHJKL:\"ZXCVBNM<>~"
+
+    if ru.indexOf(str.match("[^Wd_]")) is -1
+      from = en
+      to = ru
+    else
+      from = ru
+      to = en
+
+    switched = ""
+    for char in str
+      fromIndex = from.indexOf(char)
+      if fromIndex < 0
+        switched += char
+      else
+        switched += to[fromIndex]
+
+    switched

data/app/assets/javascripts/store/spree_autosuggest.js.coffee.erb

@@ -0,0 +1,13 @@
+//= require store/autosuggest
+
+$ ->
+  suggestOn = '<%= Spree::Autosuggest::Config.field %>'
+
+  $("input[name=#{suggestOn}]:not(.ui-autocomplete-input)").on "focus", ->
+    new Autosuggest(this,
+      from_db: <%= Spree::Autosuggest::Config.rows_from_db %>
+      to_display: <%= Spree::Autosuggest::Config.rows_to_display %>
+      delay: 100
+      minLength: 1
+      keyswitch: true )
+

data/app/controllers/base_controller_decorator.rb

@@ -0,0 +1,16 @@
+Spree::BaseController.class_eval do
+  after_filter :save_search
+
+
+  def save_search
+    keywords = @searcher.try!(:keywords)
+
+    if @products.present? and keywords.present?
+      query = Spree::Suggestion.find_or_initialize_by_keywords(keywords)
+
+      query.items_found = @products.size
+      query.increment(:count)
+      query.save
+    end
+  end
+end

data/app/controllers/spree/suggestions_controller.rb

@@ -0,0 +1,13 @@
+class Spree::SuggestionsController < Spree::BaseController
+
+  def index
+    suggestions = Spree::Suggestion.relevant(params['term'])
+
+    if request.xhr?
+      render :json => suggestions.map(&:keywords)
+    else
+      render_404
+    end
+  end
+
+end

data/app/models/spree/suggestion.rb

@@ -0,0 +1,15 @@
+class Spree::Suggestion < ActiveRecord::Base
+  validates :keywords, :presence => true
+
+  def self.relevant(term)
+    config = Spree::Autosuggest::Config
+
+    select(:keywords).
+      where("count >= ?", config.min_count).
+      where("items_found != 0").
+      where("keywords LIKE ? OR keywords LIKE ?", term + '%', KeySwitcher.switch(term) + '%').
+      order("(#{config.count_weight}*count + #{config.items_found_weight}*items_found) DESC").
+      limit(config.rows_from_db)
+  end
+
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Spree::Core::Engine.routes.draw do
+  get 'suggestions', :to => 'suggestions#index'
+end

data/db/migrate/20120216142515_create_spree_suggestions.rb

@@ -0,0 +1,12 @@
+class CreateSpreeSuggestions < ActiveRecord::Migration
+  def change
+    create_table :spree_suggestions do |t|
+      t.string :keywords
+      t.integer :count
+      t.integer :items_found
+      t.timestamps
+    end
+
+    add_index :spree_suggestions, [:keywords, :count, :items_found]
+  end
+end

data/lib/generators/spree_autosuggest/install/install_generator.rb

@@ -0,0 +1,23 @@
+module SpreeAutosuggest
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      def add_javascripts
+        append_file "app/assets/javascripts/spree/frontend.js", "//= require store/spree_autosuggest\n"
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_autosuggest'
+      end
+
+      def run_migrations
+         res = ask "Would you like to run the migrations now? [Y/n]"
+         if res == "" || res.downcase == "y"
+           run 'bundle exec rake db:migrate'
+         else
+           puts "Skiping rake db:migrate, don't forget to run it!"
+         end
+      end
+    end
+  end
+end

data/lib/key_switcher.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+module KeySwitcher
+  extend self
+
+  def switch(str)
+
+    ru = "йцукенгшщзхъфывапролджэячсмитьбюёЙЦУКЕНГШЩЗХЪФЫВАПРОЛДЖЭЯЧСМИТЬБЮЁ".split('')
+    en = "qwertyuiop[]asdfghjkl;'zxcvbnm,.`QWERTYUIOP{}ASDFGHJKL:\"ZXCVBNM<>~".split('')
+
+    return str unless letters = str.match(/([^\W\d_])/)
+
+    first_letter = letters[0]
+    mapping = first_letter.in?(ru) ? Hash[ru.zip(en)] : Hash[en.zip(ru)]
+
+    str.split('').inject('') { |result, char| result << (mapping[char] || char) }
+
+  end
+end
+

data/lib/spree/suggestion_configuration.rb

@@ -0,0 +1,8 @@
+class Spree::SuggestionConfiguration < Spree::Preferences::Configuration
+  preference :rows_to_display,    :integer, :default => 5
+  preference :rows_from_db,       :integer, :default => 15
+  preference :count_weight,       :integer, :default => 2
+  preference :items_found_weight, :integer, :default => 1
+  preference :min_count,          :integer, :default => 5
+  preference :field,              :string,  :default => 'keywords'
+end

data/lib/spree_autosuggest/engine.rb

@@ -0,0 +1,27 @@
+module Spree::Autosuggest
+end
+
+module SpreeAutosuggest
+  class Engine < Rails::Engine
+    engine_name 'spree_autosuggest'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    initializer "spree.suggestion.preferences", :after => "spree.environment" do |app|
+      Spree::Autosuggest::Config = Spree::SuggestionConfiguration.new
+    end
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_autosuggest.rb

@@ -0,0 +1,2 @@
+require 'spree_core'
+require 'spree_autosuggest/engine'

data/lib/tasks/seed.rake

@@ -0,0 +1,22 @@
+namespace :spree_autosuggest do
+  task :seed => :environment do
+    # all taxons with more than two words
+    Spree::Taxon.where('parent_id IS NOT NULL').each do |taxon|
+      searcher = Spree::Config.searcher_class.new(:taxon => taxon.id)
+      query = Spree::Suggestion.find_or_initialize_by_keywords(taxon.name)
+      query.items_found = searcher.retrieve_products.size
+      query.count = Spree::Autosuggest::Config[:min_count] + 1
+      query.save
+    end
+
+    # all product names
+    Spree::Product.find_each do |product|
+      query = Spree::Suggestion.find_or_initialize_by_keywords(product.name)
+      query.items_found = 1
+      query.count = Spree::Autosuggest::Config[:min_count] + 1
+      query.save
+    end
+
+    # spree pages extension?
+  end
+end

data/script/rails

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_PATH = File.expand_path('../..',  __FILE__)
+load File.expand_path('../../spec/dummy/script/rails',  __FILE__)

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+
+require 'rspec/rails'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f }
+
+# Requires factories defined in spree_core
+require 'spree/core/testing_support/factories'
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+end

data/spree_autosuggest.gemspec

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_autosuggest'
+  s.version     = '2.0.0'
+  s.summary     = 'Search suggestions for Spree'
+  s.description = 'Search suggestions for Spree'
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.author            = 'Demidov Aleksey, Alexander Balashov'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+  s.add_dependency 'spree_core', '>= 1.0.0.rc3'
+
+  s.add_development_dependency 'capybara', '1.0.1'
+  s.add_development_dependency 'factory_girl'
+  s.add_development_dependency 'ffaker'
+  s.add_development_dependency 'rspec-rails',  '~> 2.7'
+  s.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: spree_autosuggest
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Demidov Aleksey, Alexander Balashov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: spree_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc3
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  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: ffaker
+  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-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Search suggestions for Spree
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- Versionfile
+- app/assets/javascripts/store/autosuggest.js.coffee
+- app/assets/javascripts/store/spree_autosuggest.js.coffee.erb
+- app/controllers/base_controller_decorator.rb
+- app/controllers/spree/suggestions_controller.rb
+- app/models/spree/suggestion.rb
+- config/routes.rb
+- db/migrate/20120216142515_create_spree_suggestions.rb
+- lib/generators/spree_autosuggest/install/install_generator.rb
+- lib/key_switcher.rb
+- lib/spree/suggestion_configuration.rb
+- lib/spree_autosuggest.rb
+- lib/spree_autosuggest/engine.rb
+- lib/tasks/seed.rake
+- script/rails
+- spec/spec_helper.rb
+- spree_autosuggest.gemspec
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- none
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Search suggestions for Spree
+test_files:
+- spec/spec_helper.rb