keybreak 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWE2ZTc3ZjI0YzBkZTZhNmMzMTBkMGYzNGY3OTFlMmQ1NTdjY2RiZQ==
+  data.tar.gz: !binary |-
+    Y2QyMmE5MzllY2MyOTRkNGY2ZWZhYTU4ODc0NGI1MTgwYjNlNWI3Ng==
+SHA512:
+  metadata.gz: !binary |-
+    ZGI3MjdiZTc2YzgyMzg3Zjg5NjhiNGU2NTNiNGI4NWVmMTI3MjlhZDZlNjI0
+    MGY1NzU3YmZkMGE2MGE2ZmQ4NTk5MzRhN2IzNmIwYWU1MjBjY2YxYzA5YmY3
+    YjM5YzAzNTFkODhjMGZmMmQzMWU0YTI2NzhlNzRjNzVmODNkY2E=
+  data.tar.gz: !binary |-
+    ZjAwOWZmNzRhMzhkNjY2MzJjNmQwM2M1NzgzYWZiNzA0MDM0MWU1NTFlYmEy
+    NmE2NTMyMGMyMzRiOTEzYmQ4YjQ5NWZjMWNmYjJjYWI4NmZlMjM3MzM3NGE5
+    ZWE0ZTNmYzU4MGE1ZDQzZmFjZTM0MTQ4MTJhZGRkNzVkY2IwYjA=

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--format documentation

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in keybreak.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 hashimoton
+
+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,292 @@
+# Keybreak
+
+Keybreak is a utility module for Key break processing in Ruby.
+
+## Introduction
+
+### Key break processing
+
+The "key break processing" means, assuming a sorted sequence of column based records which can be grouped by a column,
+doing the same process for each group.
+The column used for the grouping is a "key".
+In processing the record sequence, when the key's value in a record changes from the previous record,
+it is called "key break".
+
+
+### Motivation
+
+A typical key break processing is counting the number of records for each key like below:
+
+```ruby
+count = 0
+prev_key = nil
+
+DATA.each do |line|
+  key = line.chomp.split("\t")[0]
+  
+  if !prev_key.nil? && key != prev_key
+    puts "#{prev_key}:#{count}"
+    count = 0
+  end
+  
+  count += 1
+  prev_key = key
+end
+
+if !prev_key.nil?
+    puts "#{prev_key}:#{count}"
+end
+
+__END__
+a	1
+b	2
+b	3
+c	4
+c	5
+c	6
+d	7
+e	8
+e	9
+```
+
+Note that you have to write "puts" once again after the iteration.
+This is quite troublesome even for such a simple task, and is very my motivation.
+
+With Keybreak module, the code is like below:
+
+```ruby
+require "keybreak"
+
+Keybreak.execute_with_controller do |c, count|
+  c.on(:keystart) {count = 0}
+  c.on(:keyend) {|key| puts "#{key}:#{count}"}
+
+  DATA.each do |line|
+    key = line.chomp.split("\t")[0]
+    c.feed(key)
+    count += 1
+  end
+end
+
+__END__
+a	1
+b	2
+b	3
+c	4
+c	5
+c	6
+d	7
+e	8
+e	9
+```
+
+You need to register event handlers as a key break consists of two events:
+First, the end of current key sequence (:keyend).
+Next, the start of new key sequence (:keystart).
+
+Then call feed() in your record loop.
+The method holds current key, detects a key break, and calls the event handlers accordingly.
+The block given to execute_with_controller makes sure to process the end of the last key.
+
+In many cases, taking a functional approach such as Enumerable#map achieves the task simply.
+But sometimes, a procedural code is needed.
+Keybreak module may assist you to make your key break code simpler.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'keybreak'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install keybreak
+
+
+## Usage
+
+In your ruby source, write the line below:
+
+```ruby
+require "keybreak"
+```
+
+Here are some examples of typical key break processing.
+See [examples](https://github.com/hashimoton/keybreak/tree/master/examples) for full code.
+
+### Print first values for each key
+
+Register a keystart handler which prints the given key and value.
+
+```ruby
+Keybreak.execute_with_controller do |c|
+  c.on(:keystart) {|key, value| puts "#{key}:#{value}"}
+
+  DATA.each do |line|
+    key, value = line.chomp.split("\t")
+    c.feed(key, value)
+  end
+end
+
+__END__
+a	1
+b	2
+b	3
+c	4
+c	5
+c	6
+d	7
+e	8
+e	9
+```
+
+The result will be:
+
+```
+a:1
+b:2
+c:4
+d:7
+e:8
+```
+
+### Print last values for each key
+
+Borrows DATA from above example.
+Register a keyend handler which prints the given key and value.
+
+```ruby
+Keybreak.execute_with_controller do |c|
+  c.on(:keyend) {|key, value| puts "#{key}:#{value}"}
+
+  DATA.each do |line|
+    key, value = line.chomp.split("\t")
+    c.feed(key, value)
+  end
+end
+```
+
+The result will be:
+
+```
+a:1
+b:3
+c:6
+d:7
+e:9
+```
+
+### Print sum of values for each key
+
+Clear sum when a key starts.
+Print sum when the key ends.
+
+```ruby
+Keybreak.execute_with_controller do |c, sum|
+  c.on(:keystart) {sum = 0}
+  c.on(:keyend) {|key| puts "#{key}:#{sum}"}
+
+  DATA.each do |line|
+    key, value = line.chomp.split("\t")
+    c.feed(key)
+    sum += value.to_i
+  end
+end
+```
+
+The result will be:
+
+```
+a:1
+b:5
+c:15
+d:7
+e:17
+```
+
+
+### Print sum of values for each key and sub key
+
+Nest Keybreak.execute_with_controller.
+Give sub key handlers a set of primary key and sub key (an array for instance)
+so that a primary key break is also detected as a sub key break.
+
+```ruby
+Keybreak.execute_with_controller do |c, sum|
+  c.on(:keystart) {sum = 0}
+  c.on(:keyend) {|key| puts "total #{key}:#{sum}"}
+ 
+  Keybreak.execute_with_controller do |sub_c, sub_sum|
+    sub_c.on(:keystart) {sub_sum = 0}
+    sub_c.on(:keyend) do |keys|
+      puts "#{keys[1]}:#{sub_sum}"
+      sum += sub_sum
+    end
+    
+    DATA.each do |line|
+      key, sub_key, value = line.chomp.split("\t")
+      sub_c.feed([key, sub_key])
+      c.feed(key)
+      sub_sum += value.to_i
+    end
+  end
+end
+
+__END__
+a	a1	1
+b	b1	2
+b	b2	3
+c	c1	4
+c	c1	5
+c	c2	6
+d	d1	7
+e	e1	8
+e	e1	9
+```
+
+The result will be:
+
+```
+a1:1
+total a:1
+b1:2
+b2:3
+total b:5
+c1:9
+c2:6
+total c:15
+d1:7
+total d:7
+e1:17
+total e:17
+```
+
+## Development
+
+
+### Test
+
+Run the tests in spec directory:
+
+```
+$ cd keybreak
+$ rake spec
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hashimoton/keybreak.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/examples/count.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+# Print number of each key
+# =>
+# a:1
+# b:2
+# c:3
+# d:1
+# e:2
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "keybreak"
+
+Keybreak.execute_with_controller do |c, count|
+  c.on(:keystart) {count = 0}
+  c.on(:keyend) {|key| puts "#{key}:#{count}"}
+
+  DATA.each do |line|
+    key = line.chomp.split("\t")[0]
+    c.feed(key)
+    count += 1
+  end
+end
+
+__END__
+a	1
+b	2
+b	3
+c	4
+c	5
+c	6
+d	7
+e	8
+e	9

data/examples/first_value.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+# Print first values for each key
+# =>
+# a:1
+# b:2
+# c:4
+# d:7
+# e:8
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "keybreak"
+
+Keybreak.execute_with_controller do |c|
+  c.on(:keystart) {|key, value| puts "#{key}:#{value}"}
+
+  DATA.each do |line|
+    key, value = line.chomp.split("\t")
+    c.feed(key, value)
+  end
+end
+
+__END__
+a	1
+b	2
+b	3
+c	4
+c	5
+c	6
+d	7
+e	8
+e	9

data/examples/last_value.rb

@@ -0,0 +1,31 @@
+# coding: utf-8
+# Print last values for each key
+# =>
+# a:1
+# b:3
+# c:6
+# d:7
+# e:9
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "keybreak"
+
+Keybreak.execute_with_controller do |c|
+  c.on(:keyend) {|key, value| puts "#{key}:#{value}"}
+
+  DATA.each do |line|
+    key, value = line.chomp.split("\t")
+    c.feed(key, value)
+  end
+end
+
+__END__
+a	1
+b	2
+b	3
+c	4
+c	5
+c	6
+d	7
+e	8
+e	9

data/examples/nested_sum.rb

@@ -0,0 +1,49 @@
+# coding: utf-8
+# Print sum of values for each key and sub key
+# =>
+# a1:1
+# total a:1
+# b1:2
+# b2:3
+# total b:5
+# c1:9
+# c2:6
+# total c:15
+# d1:7
+# total d:7
+# e1:17
+# total e:17
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "keybreak"
+
+Keybreak.execute_with_controller do |c, sum|
+  c.on(:keystart) {sum = 0}
+  c.on(:keyend) {|key| puts "total #{key}:#{sum}"}
+ 
+  Keybreak.execute_with_controller do |sub_c, sub_sum|
+    sub_c.on(:keystart) {sub_sum = 0}
+    sub_c.on(:keyend) do |keys|
+      puts "#{keys[1]}:#{sub_sum}"
+      sum += sub_sum
+    end
+    
+    DATA.each do |line|
+      key, sub_key, value = line.chomp.split("\t")
+      sub_c.feed([key, sub_key])
+      c.feed(key)
+      sub_sum += value.to_i
+    end
+  end
+end
+
+__END__
+a	a1	1
+b	b1	2
+b	b2	3
+c	c1	4
+c	c1	5
+c	c2	6
+d	d1	7
+e	e1	8
+e	e1	9

data/examples/sum.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+# Print sum of values for each key
+# =>
+# a:1
+# b:5
+# c:15
+# d:7
+# e:17
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "keybreak"
+
+Keybreak.execute_with_controller do |c, sum|
+  c.on(:keystart) {sum = 0}
+  c.on(:keyend) {|key| puts "#{key}:#{sum}"}
+
+  DATA.each do |line|
+    key, value = line.chomp.split("\t")
+    c.feed(key)
+    sum += value.to_i
+  end
+end
+
+__END__
+a	1
+b	2
+b	3
+c	4
+c	5
+c	6
+d	7
+e	8
+e	9

data/keybreak.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'keybreak/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keybreak"
+  spec.version       = Keybreak::VERSION
+  spec.authors       = ["hashimoton"]
+  spec.email         = ["nhashimoto01@gmail.com"]
+
+  spec.summary       = %q{Keybreak is a utility module for key break processing in Ruby.}
+  spec.homepage      = "https://github.com/hashimoton/keybreak"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/keybreak/controller.rb

@@ -0,0 +1,80 @@
+# coding: utf-8
+
+module Keybreak
+  
+  # Controller of keybreak processing
+  class Controller
+
+    # Generate an instance
+    def initialize()
+      clear
+      @handlers = {}
+      @handlers[:keystart] = DO_NOTHING
+      @handlers[:keyend] = DO_NOTHING
+    end
+    
+    
+    # Registers the given block as a keybreak event handler
+    # Valid keybreak events are:
+    #   :keystart
+    #   :keyend
+    def on(event, &block)
+      @handlers[event] = block
+    end
+    
+    
+    # Detects keybreak and calls the registered handlers
+    # When a new key comes, call the keyend handler with the last key and value,
+    #   then call the keystart handler with the new key and value
+    # For the first key feed, does not call the keyend handler
+    # Use flush() to call the keyend handler for the last fed key
+    def feed(key, *values)
+      if @is_fed
+        if key != @key
+          @handlers[:keyend].call(@key, *@values)
+          @key = key
+          @handlers[:keystart].call(key, *values)
+        end
+      else
+        @is_fed = true
+        @key = key
+        @handlers[:keystart].call(key, *values)
+      end
+      
+      @values = values
+    end
+    
+    
+    # Clears internal data to the status before key feed starts
+    def clear()
+      @is_fed = false
+      @values = []
+    end
+    
+    
+    # Calls the keyend handler once with the last fed key and value,
+    #   then clears internal data to the status before key feed starts
+    # Place this method after the last feed() to complete keybreak process
+    # Does nothing when no key has been fed
+    def flush()
+      if @is_fed
+        @handlers[:keyend].call(@key, *@values)
+      end
+      
+      clear
+    end
+    
+    
+    # Executes the given block and calls flush() finally
+    # Place feed() within the block so that the keybreak handlers are
+    #  called for all keys including the last key
+    def execute(&block)
+      instance_eval(&block)
+      self.flush
+    end
+
+  end # class
+
+end # module
+
+# EOF

data/lib/keybreak/version.rb

@@ -0,0 +1,5 @@
+module Keybreak
+  # Version
+  # MAJOR.MINOR.PATCH
+  VERSION = "0.1.0"
+end

data/lib/keybreak.rb

@@ -0,0 +1,20 @@
+# coding: utf-8
+require "keybreak/version"
+require "keybreak/controller"
+
+# Utilities for keybreak (control-break) processing
+module Keybreak
+
+  # The block which does nothing
+  DO_NOTHING = Proc.new {}
+  
+  
+  # Executes the given block with a Controller instance
+  # Within the block, register your keybreak handlers and feed keys from your data
+  # Then the handlers will be called for all keys including the last key
+  def execute_with_controller(&block)
+      Controller.new.execute(&block)
+  end
+  module_function :execute_with_controller
+
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: keybreak
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hashimoton
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: 
+email:
+- nhashimoto01@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/count.rb
+- examples/first_value.rb
+- examples/last_value.rb
+- examples/nested_sum.rb
+- examples/sum.rb
+- keybreak.gemspec
+- lib/keybreak.rb
+- lib/keybreak/controller.rb
+- lib/keybreak/version.rb
+homepage: https://github.com/hashimoton/keybreak
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Keybreak is a utility module for key break processing in Ruby.
+test_files: []