meilisearch-rails 0.1.0

data/lib/meilisearch/configuration.rb

@@ -0,0 +1,15 @@
+module MeiliSearch
+  module Configuration
+    def configuration
+      @@configuration || raise(NotConfigured, "Please configure MeiliSearch. Set MeiliSearch.configuration = {meilisearch_host: 'YOUR_MEILISEARCH_HOST', meilisearch_api_key: 'YOUR_API_KEY'}")
+    end
+
+    def configuration=(configuration)
+      @@configuration = configuration
+    end
+
+    def client
+      ::MeiliSearch::Client.new(@@configuration[:meilisearch_host], @@configuration[:meilisearch_api_key])
+    end
+  end
+end

data/lib/meilisearch/ms_job.rb

@@ -0,0 +1,9 @@
+module MeiliSearch
+  class MSJob < ::ActiveJob::Base
+    queue_as :meilisearch
+
+    def perform(record, method)
+      record.send(method)
+    end
+  end
+end

data/lib/meilisearch/pagination.rb

@@ -0,0 +1,19 @@
+module MeiliSearch
+  module Pagination
+
+    autoload :WillPaginate, 'meilisearch/pagination/will_paginate'
+    autoload :Kaminari, 'meilisearch/pagination/kaminari'
+
+    def self.create(results, total_hits, options = {})
+      return results if MeiliSearch.configuration[:pagination_backend].nil?
+      begin
+        backend = MeiliSearch.configuration[:pagination_backend].to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase } # classify pagination backend name
+        page = Object.const_get(:MeiliSearch).const_get(:Pagination).const_get(backend).create(results, total_hits, options)
+        page
+      rescue NameError
+        raise(BadConfiguration, "Unknown pagination backend")
+      end
+    end
+    
+  end
+end

data/lib/meilisearch/pagination/kaminari.rb

@@ -0,0 +1,40 @@
+unless defined? Kaminari
+  raise(MeiliSearch::BadConfiguration, "MeiliSearch: Please add 'kaminari' to your Gemfile to use kaminari pagination backend")
+end
+
+require "kaminari/models/array_extension"
+
+module MeiliSearch
+  module Pagination
+    class Kaminari < ::Kaminari::PaginatableArray
+
+      def initialize(array, options)
+        super(array, options)
+      end
+
+      def limit(num)
+        # noop
+        self
+      end
+
+      def offset(num)
+        # noop
+        self
+      end
+
+      class << self
+        def create(results, total_hits, options = {})
+          offset = ((options[:page] - 1) * options[:per_page])
+          array = new results, :limit => options[:per_page], :offset => offset, :total_count => total_hits
+          if array.empty? and !results.empty?
+            # since Kaminari 0.16.0, you need to pad the results with nil values so it matches the offset param
+            # otherwise you'll get an empty array: https://github.com/amatsuda/kaminari/commit/29fdcfa8865f2021f710adaedb41b7a7b081e34d
+            results = ([nil] * offset) + results
+            array = new results, :offset => offset, :limit => options[:per_page], :total_count => total_hits
+          end
+          array
+        end
+      end
+    end
+  end
+end

data/lib/meilisearch/pagination/will_paginate.rb

@@ -0,0 +1,19 @@
+begin
+  require 'will_paginate/collection'
+rescue LoadError
+  raise(MeiliSearch::BadConfiguration, "MeiliSearch: Please add 'will_paginate' to your Gemfile to use will_paginate pagination backend")
+end
+
+module MeiliSearch
+  module Pagination
+    class WillPaginate
+      def self.create(results, total_hits, options = {})
+        ::WillPaginate::Collection.create(options[:page], options[:per_page], total_hits) do  |pager|
+          start = (options[:page] - 1) * options[:per_page]
+          paginated_results = results[start, options[:per_page]]
+          pager.replace paginated_results
+        end
+      end
+    end
+  end
+end

data/lib/meilisearch/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails'
+
+module MeiliSearch
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "meilisearch/tasks/meilisearch.rake"
+    end
+  end
+  class Engine < Rails::Engine
+  end
+end

data/lib/meilisearch/tasks/meilisearch.rake

@@ -0,0 +1,19 @@
+namespace :meilisearch do
+
+  desc "Reindex all models"
+  task :reindex => :environment do
+    MeiliSearch::Utilities.reindex_all_models
+  end
+
+  desc "Set settings to all indexes"
+  task :set_all_settings => :environment do
+    MeiliSearch::Utilities.set_settings_all_models
+  end
+  
+  desc "Clear all indexes"
+  task :clear_indexes => :environment do
+    puts "clearing all indexes"
+    MeiliSearch::Utilities.clear_all_indexes
+  end
+
+end

data/lib/meilisearch/utilities.rb

@@ -0,0 +1,48 @@
+module MeiliSearch
+  module Utilities
+    class << self
+      def get_model_classes
+        if Rails.application && defined?(Rails.autoloaders) && Rails.autoloaders.zeitwerk_enabled?
+          Zeitwerk::Loader.eager_load_all
+        elsif Rails.application
+          Rails.application.eager_load!
+        end
+        MeiliSearch.instance_variable_get :@included_in
+      end
+
+      def clear_all_indexes
+        get_model_classes.each do |klass|
+          klass.clear_index!
+        end
+      end
+
+      def reindex_all_models
+        klasses = get_model_classes
+
+        puts ''
+        puts "Reindexing #{klasses.count} models: #{klasses.to_sentence}."
+        puts ''
+
+        klasses.each do |klass|
+          puts klass
+          puts "Reindexing #{klass.count} records..."
+          klass.ms_reindex
+        end
+      end
+
+      def set_settings_all_models
+        klasses = get_model_classes
+
+        puts ''
+        puts "Pushing settings for #{klasses.count} models: #{klasses.to_sentence}."
+        puts ''
+
+        klasses.each do |klass|
+          puts "Pushing #{klass} settings..."
+          klass.ms_set_settings
+        end
+      end
+    end
+  end
+end
+

data/lib/meilisearch/version.rb

@@ -0,0 +1,3 @@
+module MeiliSearch
+  VERSION = '0.1.0'
+end

data/meilisearch-rails.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+require File.join(File.dirname(__FILE__), 'lib', 'meilisearch', 'version')
+
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name = "meilisearch-rails"
+  s.version = MeiliSearch::VERSION
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Meili"]
+  s.date = Date.today
+  s.description = "MeiliSearch integration for Ruby on Rails. See https://github.com/meilisearch/MeiliSearch"
+  s.email = "bonjour@meilisearch.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.md"
+  ]
+  s.files = [
+    ".rspec",
+    "Gemfile",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "meilisearch-rails.gemspec",
+    "lib/meilisearch-rails.rb",
+    "lib/meilisearch/ms_job.rb",
+    "lib/meilisearch/configuration.rb",
+    "lib/meilisearch/pagination.rb",
+    "lib/meilisearch/pagination/kaminari.rb",
+    "lib/meilisearch/pagination/will_paginate.rb",
+    "lib/meilisearch/railtie.rb",
+    "lib/meilisearch/tasks/meilisearch.rake",
+    "lib/meilisearch/utilities.rb",
+    "lib/meilisearch/version.rb",
+    "spec/spec_helper.rb",
+    "spec/utilities_spec.rb"
+  ]
+  s.homepage = "http://github.com/meilisearch/meilisearch-rails"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.summary = "MeiliSearch integration for Ruby on Rails."
+  s.add_dependency(%q<json>, [">= 1.5.1"])
+  s.add_dependency(%q<meilisearch>, [">= 0.15.3"])
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'bundler'
+require 'timeout'
+require 'dotenv/load'
+require 'faker'
+Bundler.setup :test
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'meilisearch-rails'
+require 'rspec'
+require 'rails/all'
+
+raise "missing MEILISEARCH_HOST or MEILISEARCH_API_KEY environment variables" if ENV['MEILISEARCH_HOST'].nil? || ENV['MEILISEARCH_API_KEY'].nil?
+
+Thread.current[:meilisearch_hosts] = nil
+
+RSpec.configure do |c|
+  c.mock_with :rspec
+  c.filter_run :focus => true
+  c.run_all_when_everything_filtered = true
+  c.formatter = 'documentation'
+
+  c.around(:each) do |example|
+    Timeout::timeout(120) {
+      example.run
+    }
+  end
+
+  # Remove all indexes setup in this run in local or CI
+  c.after(:suite) do
+    safe_index_list.each do |index|
+      MeiliSearch.client.delete_index(index['name'])
+    end
+  end
+end
+
+# A unique prefix for your test run in local or CI
+SAFE_INDEX_PREFIX = "rails_#{SecureRandom.hex(8)}".freeze
+
+# avoid concurrent access to the same index in local or CI
+def safe_index_uid(name)
+  "#{SAFE_INDEX_PREFIX}_#{name}"
+end
+
+# get a list of safe indexes in local or CI
+def safe_index_list
+  list = MeiliSearch.client.indexes()
+  list = list.select { |index| index["name"].include?(SAFE_INDEX_PREFIX) }
+  list.sort_by { |index| index["primary"] || "" }
+end

data/spec/utilities_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
+
+MeiliSearch.configuration = { :meilisearch_host => ENV['MEILISEARCH_HOST'], :meilisearch_api_key => ENV['MEILISEARCH_API_KEY'] }
+
+describe MeiliSearch::Utilities do
+
+  before(:each) do
+    @included_in = MeiliSearch.instance_variable_get :@included_in
+    MeiliSearch.instance_variable_set :@included_in, []
+
+    class Dummy
+      include MeiliSearch
+
+      def self.model_name
+        "Dummy"
+      end
+
+      meilisearch
+    end
+  end
+
+  after(:each) do
+    MeiliSearch.instance_variable_set :@included_in, @included_in
+  end
+
+  it "should get the models where MeiliSearch module was included" do
+    (MeiliSearch::Utilities.get_model_classes - [Dummy]).should == []
+  end
+
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: meilisearch-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Meili
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: meilisearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.15.3
+description: MeiliSearch integration for Ruby on Rails. See https://github.com/meilisearch/MeiliSearch
+email: bonjour@meilisearch.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/meilisearch-rails.rb
+- lib/meilisearch/configuration.rb
+- lib/meilisearch/ms_job.rb
+- lib/meilisearch/pagination.rb
+- lib/meilisearch/pagination/kaminari.rb
+- lib/meilisearch/pagination/will_paginate.rb
+- lib/meilisearch/railtie.rb
+- lib/meilisearch/tasks/meilisearch.rake
+- lib/meilisearch/utilities.rb
+- lib/meilisearch/version.rb
+- meilisearch-rails.gemspec
+- spec/spec_helper.rb
+- spec/utilities_spec.rb
+homepage: http://github.com/meilisearch/meilisearch-rails
+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: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: MeiliSearch integration for Ruby on Rails.
+test_files: []