keybreak 0.1.0 → 0.1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWE2ZTc3ZjI0YzBkZTZhNmMzMTBkMGYzNGY3OTFlMmQ1NTdjY2RiZQ==
+    NzllZjEwM2Q1ODQzN2JkN2FkZGZmMjU3ZTUzM2ViMzY5NWVmN2FiNg==
   data.tar.gz: !binary |-
-    Y2QyMmE5MzllY2MyOTRkNGY2ZWZhYTU4ODc0NGI1MTgwYjNlNWI3Ng==
+    NDM4YWQyZDM3NDgyMDlkM2NlMWE4NGM0NGQzNWM2ZDg5YWJkNDIwZA==
 SHA512:
   metadata.gz: !binary |-
-    ZGI3MjdiZTc2YzgyMzg3Zjg5NjhiNGU2NTNiNGI4NWVmMTI3MjlhZDZlNjI0
-    MGY1NzU3YmZkMGE2MGE2ZmQ4NTk5MzRhN2IzNmIwYWU1MjBjY2YxYzA5YmY3
-    YjM5YzAzNTFkODhjMGZmMmQzMWU0YTI2NzhlNzRjNzVmODNkY2E=
+    ZWYyNDMyMDU3ODA1ZDdmNzk2ZjY1NTZkZTUxMjk3Njg4NGNjYWFjYjU1ZmNi
+    NTgyNDMxM2U5NGYwZGZkNmE2NTFkMjNlNWEyYWYwOWYxNjMwMGVhNDhmMDlh
+    YjZiNzcyOTQwMTBjYTc5NjJkYjBiOGQwZTM4NmYyZWI0ODNhZWE=
   data.tar.gz: !binary |-
-    ZjAwOWZmNzRhMzhkNjY2MzJjNmQwM2M1NzgzYWZiNzA0MDM0MWU1NTFlYmEy
-    NmE2NTMyMGMyMzRiOTEzYmQ4YjQ5NWZjMWNmYjJjYWI4NmZlMjM3MzM3NGE5
-    ZWE0ZTNmYzU4MGE1ZDQzZmFjZTM0MTQ4MTJhZGRkNzVkY2IwYjA=
+    ODM0ODkwNjk5MGIxNzMyMmU5ZWZhOWM0Mzc0N2QwOGZmZjkwZTExZmJkODRh
+    ZDViZTI4OGRjMmY0YmJiZTBkYTA1M2Q2ZTVjZDUxZDE1MTk1OGRiYTU4MmRm
+    NDJjZTBkMzRlNGNkNmRlYmQzNjU2MjBhZjY1Y2U1ODY3OGIxNGQ=

data/README.md

@@ -8,6 +8,7 @@ Keybreak is a utility module for Key break processing in Ruby.
 
 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".
@@ -160,6 +161,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
@@ -215,6 +217,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.
 

data/keybreak.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  
+  spec.required_ruby_version = ">= 1.9.3"
 end

data/lib/keybreak/controller.rb

@@ -2,10 +2,10 @@
 
 module Keybreak
   
-  # Controller of keybreak processing
+  # Controller of key break processing
   class Controller
 
-    # Generate an instance
+    # Generates an instance.
     def initialize()
       clear
       @handlers = {}
@@ -14,8 +14,8 @@ module Keybreak
     end
     
     
-    # Registers the given block as a keybreak event handler
-    # Valid keybreak events are:
+    # Registers the given block as a key break event handler.
+    # Valid events are:
     #   :keystart
     #   :keyend
     def on(event, &block)
@@ -23,11 +23,11 @@ module Keybreak
     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
+    # Detects a key break and calls the registered handlers.
+    # When a new key comes, calls 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
@@ -45,17 +45,17 @@ module Keybreak
     end
     
     
-    # Clears internal data to the status before key feed starts
+    # 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
+    # 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 key break process.
+    # Does nothing when no key has been fed.
     def flush()
       if @is_fed
         @handlers[:keyend].call(@key, *@values)
@@ -65,9 +65,9 @@ module Keybreak
     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
+    # Executes the given block and calls flush() finally.
+    # Place feed() within the block so that the key break handlers are
+    # called for all keys including the last key.
     def execute(&block)
       instance_eval(&block)
       self.flush

data/lib/keybreak/version.rb

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

data/lib/keybreak.rb

@@ -2,16 +2,16 @@
 require "keybreak/version"
 require "keybreak/controller"
 
-# Utilities for keybreak (control-break) processing
+# Utilities for key break (control-break) processing
 module Keybreak
 
-  # The block which does nothing
+  # 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
+  # Executes the given block with a Controller instance.
+  # Within the block, register your key break 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keybreak
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - hashimoton
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
@@ -100,3 +100,4 @@ signing_key:
 specification_version: 4
 summary: Keybreak is a utility module for key break processing in Ruby.
 test_files: []
+has_rdoc: