sliding_window 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7064b873b87732312ca43a607a89453258225da9
+  data.tar.gz: 7c38068b3bb1c1944f4deacc703f92640cf233eb
+SHA512:
+  metadata.gz: aecb490e34a82542c0dd7c2b33401c572a0ecd11b9fc84a39bac3359cc2adff7352204f7481bb8923dac891df8de069c5076d03fd0c4d1cf4c8a8cff9338e1a2
+  data.tar.gz: 9c37dabb5be2dcfd607c0c4c82f8bc6684b5ee3b637b90f96cdc70390170baa43e2578dde6f69b628756a681a4a554c0ff82dae8b0767b665217146d17dd400a

data/README.md

@@ -0,0 +1,32 @@
+# Sliding Window [![Build Status](https://travis-ci.org/nathankleyn/sliding_windowsvg)](https://travis-ci.org/nathankleyn/sliding_window) [![RubyGems Version Of gitignore_rb](https://img.shields.io/gem/v/sliding_window.svg)](https://rubygems.org/gems/sliding_window)
+
+Implements the sliding window algorithm. This is useful for traversing phrases during NEL processing.
+
+## Usage
+
+The Gem is called `sliding_window` and you can it is available via [RubyGems](https://rubygems.org/gems/sliding_window):
+
+```sh
+gem install sliding_window
+```
+
+## Examples
+
+A simple example is as follows:
+
+```ruby
+require 'sliding_window'
+
+mapping = {
+  'The Queen' => 'Queen Elizabeth II',
+  'Queen' => 'Queen (band)',
+  'Buckingham Palace' => 'Buckingham Palace'
+}
+
+sliding_window = SlidingWindow.new(%w{The Queen attended a concert at Buckingham Palace where Queen played some music}) do |window|
+  key = window.join(' ')
+  mapping[key] if mapping.include?(key)
+end
+
+sliding_window.to_a # => ['Queen Elizabeth II', 'Buckingham Palace', 'Queen (band)']
+```

data/lib/sliding_window.rb

@@ -0,0 +1,58 @@
+# Implementation of the sliding window algorithm.
+class SlidingWindow
+  include Enumerable
+
+  # Initialize the sliding window. Given a buffer to slide over, the maximum
+  # size of the window, and a block to test whether the window matches anything,
+  # enumerate the sliding window instance to get at the matches.
+  #
+  # buffer - The buffer to slide the window over. It can be any type, as long as
+  #          it responds to `#[]` and `#size`.
+  # max_size - The maximum allowed length of the window. Defaults to 5.
+  # block - A block which will test whether the position of the current window
+  #         matches anything of interest. The block is passed the current window
+  #         into the buffer and is expected to return an object if the window
+  #         matches (it can be anything), otherwise `nil`. The objects returned
+  #         by this block will be yielded to the enumerable.
+  def initialize(buffer, max_size = 5, &block)
+    fail('The given buffer must respond to #[] and #size.') unless buffer.respond_to?(:[]) && buffer.respond_to?(:size)
+    fail('The maximum buffer size must be greater than or equal to one.') if max_size.nil? || max_size < 1
+    fail('A block is required to indicate whether a window matches anything of interest.') unless block_given?
+
+    @buffer = buffer
+    @max_size = max_size
+    @mapper = block
+  end
+
+  # Enumerable yields each time the window matches on something. The internal
+  # window is slid forward as expected.
+  def each
+    position = (0..@max_size - 1)
+
+    loop do
+      window = @buffer[position]
+      match = @mapper.call(window)
+
+      if match.nil?
+        position = (position.begin..position.end - 1)
+        position = slide_unmatched_window(position) if position.end < position.begin
+      else
+        yield match
+        position = slide_matched_window(position)
+      end
+
+      break if position.first >= @buffer.size
+    end
+  end
+
+  private
+
+  def slide_unmatched_window(position)
+    start = position.begin + 1
+    (start..start + @max_size)
+  end
+
+  def slide_matched_window(position)
+    (position.end + 1..position.end + @max_size)
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: sliding_window
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nathan Kleyn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.34.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.34.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+description: Ruby implementation of a sliding window algorithm.
+email: nathan@nathankleyn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/sliding_window.rb
+homepage: https://github.com/username/sliding_window
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Ruby implementation of a sliding window algorithm.
+test_files: []
+has_rdoc: