kmp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e04c7a5db40803de18e97fc8a9344333a24564c7
+  data.tar.gz: 3e84aa406dde540db0777c52ac910937f392c150
+SHA512:
+  metadata.gz: 8378a07e3ef333d753997415784b82839bcf33a6792d9ed2aba9299fbd63c23ca2559d62e326282589a852caefec5752615068928ac147065ae25d8179193317
+  data.tar.gz: 3f012d995f4e9d71bf4be6a01490ce075e52505a8cfa5e474169d4d2965406b01158992fca3b7635e3657f6d938a21bd8271dd239595bcd7056d7c44f5a9f15a

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: OWLY9jdMqWODfG1u4yXCOhxcxboQ80MtU

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.gem
+.gem
+*.gem

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.4.1
+before_install: gem install bundler -v 1.16.0

data/AUTHORS

@@ -0,0 +1 @@
+Tanvir Hasan

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.1.0
+* initial release
+* implement kmp algorithm

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tanvir002700@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contribution Guidelines
+
+## Steps
+
+1. Fork [the repo](https://github.com/tanvir002700/kmp)
+2. Grab dependencies: `bundle install`
+3. Make sure everything is working: `bundle exec rake spec`
+4. Make your changes
+5. Run your local from bin/console
+6. Test your changes
+7. Create a Pull Request
+8. Celebrate!!!!!
+
+## Notes
+
+When contributing, please make sure to update the AUTHORS file
+when you submit your pull request.

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 kmp.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    kmp (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.1.0)
+    rake (10.5.0)
+    rake-compiler (1.0.4)
+      rake
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.16.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  coveralls (~> 0.8.21)
+  kmp!
+  rake (~> 10.0)
+  rake-compiler (~> 1.0, >= 1.0.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 tanvir hasan
+
+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,58 @@
+# Kmp
+[![Build Status](https://travis-ci.org/tanvir002700/kmp.svg?branch=master)](https://travis-ci.org/tanvir002700/kmp)
+[![Maintainability](https://api.codeclimate.com/v1/badges/69f40101eeb294c05163/maintainability)](https://codeclimate.com/github/tanvir002700/kmp/maintainability)
+[![Coverage Status](https://coveralls.io/repos/github/tanvir002700/kmp/badge.svg?branch=master)](https://coveralls.io/github/tanvir002700/kmp?branch=master)
+[![GitHub last commit (branch)](https://img.shields.io/github/last-commit/tanvir002700/kmp/master.svg)](https://github.com/tanvir002700/kmp)
+[![license](https://img.shields.io/github/license/tanvir002700/kmp.svg)](https://github.com/tanvir002700/kmp/blob/master/LICENSE)
+
+This gem is KMP (Knuth–Morris–Pratt algorithm) implemantation with c Extension.
+A super first substring find technique in a big string.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kmp'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kmp
+
+## Usage
+
+``` ruby
+require 'kmp'
+k = Kmp::String.new 'abcdeab'
+k.match 'ab' #=> [0, 4]
+
+k.length #=> 7
+```
+
+## Complexity
+
+- match function complexity O(N+M), N original text string length, M match string length
+- length complexity O(1)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. For compile c extension run `rake compile`.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tanvir002700/kmp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Kmp project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tanvir002700/kmp/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+require "rake/extensiontask"
+
+Rake::ExtensionTask.new "kmp" do |ext|
+  ext.lib_dir = "lib/kmp"
+end
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/banch_mark.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kmp"
+
+#(0...50).map { ('a'..'z').to_a[rand(26)] }.join
+txt = ''
+10000.times{txt << 'abc'}
+
+t1 = Time.now
+a = Kmp::String.new txt
+b = a.match 'abcabcabcabcabcabc'
+puts Time.now - t1
+puts b.length
+
+t1 = Time.now
+b = txt.enum_for(:scan, /(?=abcabcabcabcabcabc)/).map { Regexp.last_match.offset(0).first }
+puts Time.now - t1
+puts b.size

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kmp"
+
+# 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/ext/kmp/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile "kmp/kmp"

data/ext/kmp/kmp.c

@@ -0,0 +1,14 @@
+#include<ruby.h>
+#include<kmp_string.h>
+
+static VALUE hello_world(VALUE klass)
+{
+  return rb_str_new2("hello world");
+}
+
+void Init_kmp()
+{
+  VALUE mKmp = rb_define_module("Kmp");
+  rb_define_singleton_method(mKmp, "hello_world", hello_world, 0);
+  Init_kmp_string(mKmp);
+}

data/ext/kmp/kmp_string.c

@@ -0,0 +1,106 @@
+#include<ruby.h>
+#include<string.h>
+
+struct Str
+{
+    char * ptr;
+};
+
+static void deallocate(struct Str *str)
+{
+    free(str);
+}
+
+static VALUE allocate(VALUE klass)
+{
+    struct Str * str = (struct Str *)malloc(sizeof(struct Str));
+
+    VALUE obj = Data_Make_Struct(klass, struct Str, NULL, deallocate, str);
+    str->ptr = NULL;
+    return obj;
+}
+
+static VALUE initialize(VALUE self, VALUE rb_string)
+{
+    struct Str * str;
+
+    Check_Type(rb_string, T_STRING);
+    Data_Get_Struct(self, struct Str, str);
+
+    str->ptr = calloc(RSTRING_LEN(rb_string) , sizeof(char));
+    memcpy(str->ptr, StringValuePtr(rb_string), RSTRING_LEN(rb_string));
+
+    rb_iv_set(self, "@str", rb_string);
+    rb_iv_set(self, "@length", INT2NUM(RSTRING_LEN(rb_string)));
+
+    return self;
+}
+
+static int* compute_prefix(char *str)
+{
+    int len = strlen(str);
+
+    int * prefix;
+    prefix = calloc(len+1, sizeof(int));
+
+    prefix[0] = -1;
+    int k = -1;
+
+    for(int i=1; i<len; i++)
+    {
+        while( k>-1 && str[k+1]!=str[i] ) k = prefix[k];
+        if( str[k+1] == str[i] ) k = k+1;
+        prefix[i] = k;
+    }
+    return prefix;
+}
+
+static VALUE match(VALUE self, VALUE rb_str)
+{
+    VALUE positions = rb_ary_new();
+    struct Str * obj;
+    char * str;
+    char * ptrn;
+    int * prefix;
+
+    Data_Get_Struct(self, struct Str, obj);
+    str = calloc(strlen(obj->ptr), sizeof(char));
+    strcpy(str, obj->ptr);
+
+    ptrn = calloc(RSTRING_LEN(rb_str), sizeof(char));
+    memcpy(ptrn, StringValuePtr(rb_str), RSTRING_LEN(rb_str));
+
+    prefix = compute_prefix(ptrn);
+
+    int n = strlen(str);
+    int m = strlen(ptrn);
+
+    int q = -1;
+    for(int i=0; i<n; i++)
+    {
+        while( q>-1 && ptrn[q+1]!=str[i] ) q = prefix[q];
+        if( ptrn[q+1]==str[i] ) q = q+1;
+        if( q==m-1 )
+        {
+            rb_ary_push(positions, INT2NUM(i-m+1));
+            q = prefix[q];
+        }
+    }
+    free(prefix);
+    free(ptrn);
+    free(str);
+
+    return positions;
+}
+
+void Init_kmp_string(VALUE mKmp)
+{
+    VALUE cKmpString = rb_define_class_under(mKmp, "String", rb_cObject);
+
+    rb_define_alloc_func(cKmpString, allocate);
+    rb_define_method(cKmpString, "initialize", initialize, 1);
+    rb_define_method(cKmpString, "match", match, 1);
+    rb_define_attr(cKmpString, "str", 1, 0);
+    rb_define_attr(cKmpString, "length", 1, 0);
+}
+

data/ext/kmp/kmp_string.h

@@ -0,0 +1,7 @@
+#ifndef KMP_STRING
+#define KMP_STRING
+
+#include<ruby.h>
+
+void Init_kmp_string(VALUE mKmp);
+#endif

data/kmp.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kmp/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kmp"
+  spec.version       = Kmp::VERSION
+  spec.authors       = ["tanvir hasan"]
+  spec.email         = ["tanvir002700@gmail.com"]
+
+  spec.summary       = %q{Kmp algorithm implementation with c extension in ruby.}
+  spec.description   = %q{A string matching algorithm wants to find the starting index m in string S[] that matches the search word W[].}
+  spec.homepage      = "https://rubygems.org/gems/kmp"
+  spec.license       = "MIT"
+  spec.metadata      = { 'source_code_uri' => 'https://github.com/tanvir002700/kmp' }
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency 'coveralls', '~> 0.8.21'
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'rake-compiler', '~> 1.0', '>= 1.0.0'
+  spec.extensions = %w[ext/kmp/extconf.rb]
+end

data/lib/kmp.rb

@@ -0,0 +1,3 @@
+require "kmp/version"
+require "kmp/kmp"
+require "kmp/string"

data/lib/kmp/string.rb

@@ -0,0 +1,7 @@
+module Kmp
+  class String
+    def inspect
+      str
+    end
+  end
+end

data/lib/kmp/version.rb

@@ -0,0 +1,3 @@
+module Kmp
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: kmp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tanvir hasan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-02 00:00:00.000000000 Z
+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: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.21
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.21
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A string matching algorithm wants to find the starting index m in string
+  S[] that matches the search word W[].
+email:
+- tanvir002700@gmail.com
+executables: []
+extensions:
+- ext/kmp/extconf.rb
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- AUTHORS
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- banch_mark.rb
+- bin/console
+- bin/setup
+- ext/kmp/extconf.rb
+- ext/kmp/kmp.c
+- ext/kmp/kmp_string.c
+- ext/kmp/kmp_string.h
+- kmp.gemspec
+- lib/kmp.rb
+- lib/kmp/kmp.so
+- lib/kmp/string.rb
+- lib/kmp/version.rb
+homepage: https://rubygems.org/gems/kmp
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/tanvir002700/kmp
+  allowed_push_host: https://rubygems.org
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Kmp algorithm implementation with c extension in ruby.
+test_files: []