cotcube-helpers 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 819dae89b6428b3cec4226d40f4afa3b790108b2e7a0f8ff9784b49532a894e9
-  data.tar.gz: 2e4823aa3a4f86efa8d94ff07be306cb991a7bd08504cae0209025127e67d472
+  metadata.gz: 01aae33281c410de2818d90ab99e2125c5841ad2f6148a71c7950eb84bb07c33
+  data.tar.gz: 1e4e1fbeaa9d7a3b71bff8fd0325f77ab390620ddd933992b6a138db48fbd77d
 SHA512:
-  metadata.gz: 46647ed87173997191a22b05072e0ce4b53bba9be4a222d86a92605bf35d9c3d4d33ed0381c6ab3e46106e21851d10f4b9b3b178136bf780bdcf89ce055cc469
-  data.tar.gz: 7acdf173d676c7db61e6e2a1aa3111b22ae00c55768611d7355b4f13216c225f9e5ef9204a23796694b95d21d955e7a53e72d3b62b390e3735786aceb0b67801
+  metadata.gz: 2e15e9005df3ed00b77b90f12d99b67b92838034a2339ff9255b7c4986cbcd7764ed7fc01bf4de5edcd1032bd885d39de4d045529bc34a6826a6e97c9b954cdf
+  data.tar.gz: edf104056c0a4ea83bf3384a4f5c10ed240f6638e04da12053a84322853d036b1f38bb75ddf96146a195bf2861be9f999bf743a80ff2a14968f5dbdc36b7d2a9

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.2 (December 21, 2020)
+  - minor changes
+  - minor fix to parallelize and application of positional arguments
+  - added license and README
+
 ## 0.1.1 (December 21, 2020)
 
 

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Benjamin L. Tischendorf
+
+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,101 @@
+## Cotcube::Helpers
+
+Just a collection of helpers not fitting into other repositories of the Cotcube suite. Also usable aside of Cotcube. Where appropriate, these are provided as core\_extensions, otherwise within the model Cotcube::Helpers
+
+#### Extending Array
+
+##### compact\_or\_nil
+
+Returns the array compacted--or just nil, when the result is empty?
+
+##### split\_by(attr)
+
+This is a rather old implementation. Most probably something I developed before I met Array#group\_by.
+
+##### pairwise(&block) / triplewise(&block)
+
+Yields block on each consecutive pair of the array, hence returning array.size-1 results.
+
+##### triplewise(&block)
+ 
+Yields block on each consecutive triple of the array, hence returning array.size-2 results.
+
+#### Extending Enumerator
+
+##### shy\_peek
+
+Peeks into the successor without raising if there is none available--returning nil instead.
+
+#### Extending Hash
+
+##### keys\_to\_sym
+
+Transforms the keys of a Hash (recursivly for subsequent Arrays and Hashes) into symbols.
+
+#### Extending Range
+
+##### to\_time\_intervals(timezone: Time.find\_zone('America/Chicago'), step:, ranges: nil)
+
+Uses the range of *date alikes* delivered to create an Array of time periods of length :step
+(which is a ActiveSupport::Duration, e.g. 5.minutes or 1.hour). 
+
+When the step is sub-day, the periods are cleared for DST-changes.
+
+When ranges are nil, only periods are returned that are within the full trading hours. This is
+accomplished by the fact, that Sunday is wday==0. If you want to use ranges, just send a an array
+of ranges, providing seconds starting at Sunday morning midnight. Here is the default as example:
+
+```
+    ranges ||= [
+       61200..143999,   # Sun 5pm .. Mon 4pm
+      147600..230399,   # Mon 5pm .. Tue 4pm
+      234000..316799,   # ...
+      320400..403199,
+      406800..489599
+    ]
+```
+
+#### Extending String
+
+##### is\_valid\_json?
+
+#### Subpattern
+
+##### sub(minimum: 1) { [:hyper, :mega] }
+
+sub (should be 'subpattern', but too long) is for use in case / when statements
+it returns a lambda, that checks the case'd expression for matching subpattern
+based on the the giving minimum. E.g. 'a', 'ab' .. 'abcd' will match sub(1){'abcd'}
+but only 'abc' and 'abcd' will match sub(3){'abcd'}
+
+The recommended use within evaluating user input, where abbreviation of incoming commands
+is desirable (h for hoover and hyper, what will translate to sub(2){'hoover'} and sub(2){hyper})
+
+To extend functionality even more, it is possible to send a group of patterns to, like
+sub(2){[:hyper,:mega]}, what will respond truthy to "hy" and "meg" but not to "m" or "hypo"
+
+*paired with keystroke() it allows an easy build of an inputhandler*
+
+#### SimpleOutput
+
+This is a very simple class, that mocks a more complex output handler. It provides puts, print,
+puts! and print!. The actual OutputHandler is another project that needs to be rewritten. Once
+that is done, SimpleOutput will be replaced. The new OutputHandler is a tool to handle information
+flow like logs, to pause and continue output.
+
+#### Input
+
+##### keystroke(quit: false)
+
+A version of STDIN.gets, that does not wait for pressing 'enter' but instantly returns the content
+of the keystroke. 
+
+*paired with subpattern it allows an easy build of an inputhandler*
+
+#### Parallelize
+
+##### parallelize(ary, processes: 1, threads: 1, progress: "", &block)
+
+Based on https://github.com/grosser/parallel, it is a quite convenient way to parallelize tasks. 
+
+

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/cotcube-helpers/parallelize.rb

@@ -1,32 +1,29 @@
 module Cotcube
   module Helpers
 
-    def parallelize(ary, opts = {}, &block)
-      processes =           opts[:processes].nil? ? 1  : opts[:processes]
-      threads_per_process = opts[:threads  ].nil? ? 1  : opts[:threads]
-      progress =            opts[:progress ].nil? ? "" : opts[:progress]
+    def parallelize(ary, processes: 1, threads: 1, progress: "", &block)
       chunks = [] 
-      if processes == 0 or processes == 1
-        r = Parallel.map(ary, in_threads: threads_per_process) {|u| v = yield(u); v}
-      elsif [0,1].include?(threads_per_process)
-        r = Parallel.map(ary, in_processes: processes) {|u| v = yield(u)}
+      if [0,1].include? processes 
+        result = Parallel.map(ary, in_threads: threads) {|u| v = yield(u); v}
+      elsif [0,1].include?(threads)
+        result = Parallel.map(ary, in_processes: processes) {|u| v = yield(u)}
       else
-        ary.each_slice(threads_per_process) {|chunk| chunks << chunk }
+        ary.each_slice(threads) {|chunk| chunks << chunk }
         if progress == "" 
-          r = Parallel.map(chunks, :in_processes => processes) do |chunk|
-            Parallel.map(chunk, in_threads: threads_per_process) do |unit|
+          result = Parallel.map(chunks, :in_processes => processes) do |chunk|
+            Parallel.map(chunk, in_threads: threads) do |unit|
               yield(unit) 
             end
           end
         else
-          r = Parallel.map(ary, :progress => progress, :in_processes => processes) do |chunk|
-            Parallel.map(chunk, in_threads: threads_per_process) do |unit|
+          result = Parallel.map(chunks, :progress => progress, :in_processes => processes) do |chunk|
+            Parallel.map(chunk, in_threads: threads) do |unit|
               yield(unit)
             end
           end
         end
       end
-      return r
+      result
     end
 
   end

data/lib/cotcube-helpers/range_ext.rb

@@ -29,9 +29,9 @@ class Range
     starting_with_dst = result.first.dst?
     seconds_since_sunday_morning = lambda {|x| x.wday * 86400 + x.hour * 3600 + x.min * 60 + x.sec}
     ranges ||= [
-      61200..143999,  
-      147600..230399,
-      234000..316799,
+       61200..143999,   # Sun 5pm .. Mon 4pm
+      147600..230399,   # Mon 5pm .. Tue 4pm
+      234000..316799,   # ...
       320400..403199,
       406800..489599
     ]

data/lib/cotcube-helpers/subpattern.rb

@@ -12,7 +12,7 @@ module Cotcube
     #
     #   To extend functionality even more, it is possible to send a group of patterns to, like
     #   sub(2){[:hyper,:mega]}, what will respond truthy to "hy" and "meg" but not to "m" or "hypo"
-    def sub(minimum = 1)
+    def sub(minimum: 1)
       pattern = yield
       case pattern
       when String, Symbol, NilClass

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cotcube-helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Benjamin L. Tischendorf
@@ -76,6 +76,8 @@ files:
 - ".irbrc.rb"
 - CHANGELOG.md
 - Gemfile
+- LICENSE.txt
+- README.md
 - VERSION
 - cotcube-helpers.gemspec
 - lib/cotcube-helpers.rb