shookach 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 865cd6643ebbfc5adc8f873a9c7f9b7e5a91fb5f719f03985541aa6cbcd7ef3d
-  data.tar.gz: 35c647ccc636e9441cd2df6d5c1dcc0ccb19eb38cd10b1520b5ee0594940b3d0
+  metadata.gz: da3e8de8ec51fd036c0c153ef9aeb067c5ee33b3277d22b6f20b89b3a1289a31
+  data.tar.gz: f8b4d264dfeff8c7747bbf67e9cedb9f867a2623f1368200011b444af2df01f8
 SHA512:
-  metadata.gz: aeabad7c1dcd7daed2824662243d27f84ab9d7bc320b4df51bae527a321d56814e5e51135a92cc59aa8c29f664fddaa2c1717c8cbf52fd7e8baf7a7377995f4d
-  data.tar.gz: d8aca686d11a684a45f8f0c45b9e4515ec6fad2f9f8d1cc320ccfbba655b5c84e0445c8da9068be0d953bb06653e41bf0125c27dc89d64420a347f009fbef86e
+  metadata.gz: 6a252f3993754a9d4f5330dc7ff1f19cff5a38284bc2860461d8f2c710b6293460a131d47b029344c23737d7497d0efc00e3422c6303fba1b0a3c25daacf61fb
+  data.tar.gz: e72c7b00e9ca92cf268878abe7dd1d47d1f9b252d193bda984130f38de90f66612704700996b34f6944bc911624a3a25a2626d59b7389a7fa25d61e44ec7eeef

data/.gitignore

@@ -0,0 +1,15 @@
+.idea/
+public/output/*.yml
+Gemfile.lock
+*.gem
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in shookach.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Bohdan Chaban
+
+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.md

@@ -0,0 +1,67 @@
+# SHOOKACH
+
+Simple gem for basic full-text search 
+
+## Installation
+
+```sh
+$ gem install shookach
+```
+
+Or with Bundler in your Gemfile.
+
+```ruby
+gem 'shookach'
+```
+
+## Getting started
+
+### Indexing
+
+Index files in `./public/input/` directory and store to `./public/output/`
+
+```ruby
+Shookach.index
+```
+or
+```ruby
+rake shookach:index
+```
+
+Index files from specific directory
+
+```ruby
+Shookach.index({library_path: 'path/to/input/dir/'})
+```
+or
+```ruby
+rake shookach:index['path/to/input/dir/']
+```
+
+Store indexes file to specific directory
+
+```ruby
+Shookach.index({output_path: 'path/to/output/dir/'})
+```
+or
+```ruby
+rake shookach:index[,'path/to/output/dir/']
+```
+
+Index files from specific directory and file to specific directory
+
+```ruby
+Shookach.index({library_path: 'path/to/input/dir/', output_path: 'path/to/output/dir/'})
+```
+or
+```ruby
+rake shookach:index['path/to/input/dir/','path/to/output/dir/']
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/BohdanChaban/shookach.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'shookach'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shookach/version.rb

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

data/public/input/test_file.txt

@@ -0,0 +1,12 @@
+Lorem Ipsum is simply dummy text of the printing and typesetting industry.
+Lorem Ipsum has been the industry's standard dummy text ever since the 1500s,
+when an unknown printer took a galley of type and scrambled it to make a type specimen book.
+It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged.
+It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages,
+and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
+It is a long established fact that a reader will be distracted by the readable content of a page when looking at its layout.
+The point of using Lorem Ipsum is that it has a more-or-less normal distribution of letters,
+as opposed to using 'Content here, content here', making it look like readable English.
+Many desktop publishing packages and web page editors now use Lorem Ipsum as their default model text,
+and a search for 'lorem ipsum' will uncover many web sites still in their infancy.
+Various versions have evolved over the years, sometimes by accident, sometimes on purpose (injected humour and the like).

data/shookach.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require './lib/shookach/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'shookach'
+  s.version     = Shookach::VERSION
+  s.authors     = ['Bohdan Chaban']
+  s.email       = 'b.chaban.91@gmail.com'
+
+  s.summary     = 'Full-text search'
+  s.description = 'A simple gem for full-text search'
+  s.homepage    = 'https://github.com/BohdanChaban/shookach'
+  s.license     = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  s.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.16"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -1,27 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: shookach
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Bohdan Chaban
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 2018-08-08 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: A simple gem for full-text search
 email: b.chaban.91@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/shookach.rb
 - lib/shookach/indexer.rb
 - lib/shookach/railtie.rb
 - lib/shookach/searcher.rb
+- lib/shookach/version.rb
 - lib/tasks/shookach.rake
-homepage: http://rubygems.org/gems/shookach
+- public/input/test_file.txt
+- public/output/.keep
+- shookach.gemspec
+homepage: https://github.com/BohdanChaban/shookach
 licenses:
 - MIT
 metadata: {}