cotcube-helpers 0.1.7.4 → 0.1.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a685d90173074f0ee3490602a9108cec0f8a8ff6e616fce2db1ef3566d0f2ef6
-  data.tar.gz: b08e52e6e47a233658765b4fdb3aab72d649aefff91eabb46e8cbcef6542e84e
+  metadata.gz: 2bfb21e47e19a7dfd33125d42d4d049d8654fbf84e36edfe081a3878e751439e
+  data.tar.gz: 847d6eb7b98df85dc11aadc294147542071fdb4ff83d86faac3e0ef14d204d47
 SHA512:
-  metadata.gz: b8ced4fffb8f219416f05fe6daf3e891499e788d58d1ca4ea233cfff18998972b3aa9f0be10abdda3081671e534d0346201cfa7f5442b0bc996b75a6f3b1208b
-  data.tar.gz: 853ae393f9f3ba54321d82d2dba17e61fd6f85a4609029dee619ddcab10b2c2e5aa5dd6e7105f3f88e1e072b60034f7657a4cb53baed8188ddb67347326bce7a
+  metadata.gz: b2a0020f5c8277b6882dbe7a00e2c885c1e86eb56b22529236b086554b7b69b398afaa1b013bb02b8f4d23f7a7444000dac77e283c7c92ecaa8e2e255e44c6f9
+  data.tar.gz: b8638126b407e5c4e74a0866fa7497d1c3f29af6f143b94fbca775987de78f350df75b239fd68dcc339aaa4858254b5957c3b9a1e4a4aff40d8c3b487a84a5b4

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## 0.1.9.2 (July 24, 2021)
+  - added missing module_functions
+  - init: minor fix
+  - datetime_ext: added warning comment / TODO, as switch from to daylight time will produce erroneous results
+  - constants: minor fix (typo)
+  - array_ext: added param to provide a default return value if result is an empty array
+
+## 0.1.9.1 (May 07, 2021)
+  - moved 'get_id_set' to Cotcube::Helpers
+  - minor fix to suppress some warning during build
+
+## 0.1.9 (May 07, 2021)
+  - added constants, init and symbols to helpers
+
+## 0.1.8 (April 18, 2021)
+  - datetime_ext: Date.cw provides a range of (Date..Date) representing the according calendar week
+
 ## 0.1.7.4 (March 13, 2021)
   - hotfix on 0.1.7.3
 

data/VERSION

@@ -1 +1 @@
-0.1.7.4
+0.1.9.2

data/cotcube-helpers.gemspec

@@ -26,9 +26,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activesupport'
+  spec.add_dependency 'activesupport', '~> 6'
+  spec.add_dependency 'colorize',      '~> 0.8'
 
-  spec.add_development_dependency 'rake'
+
+  spec.add_development_dependency 'rake', '~> 13'
   spec.add_development_dependency 'rspec', '~>3.6'
   spec.add_development_dependency 'yard', '~>0.9'
 end

data/lib/cotcube-helpers.rb

@@ -17,16 +17,25 @@ require_relative 'cotcube-helpers/subpattern'
 require_relative 'cotcube-helpers/parallelize'
 require_relative 'cotcube-helpers/simple_output'
 require_relative 'cotcube-helpers/simple_series_stats'
+require_relative 'cotcube-helpers/constants'
 require_relative 'cotcube-helpers/input'
 require_relative 'cotcube-helpers/reduce'
+require_relative 'cotcube-helpers/symbols'
+require_relative 'cotcube-helpers/init'
+require_relative 'cotcube-helpers/get_id_set'
 
 module Cotcube
   module Helpers
     module_function :sub,
                     :parallelize,
+                    :config_path,
+                    :config_prefix,
                     :reduce,
                     :simple_series_stats,
-                    :keystroke
+                    :keystroke,
+                    :symbols,
+                    :get_id_set,
+                    :init
 
     # please not that module_functions of source provided in private files must be published there
   end

data/lib/cotcube-helpers/array_ext.rb

@@ -29,10 +29,10 @@ class Array
   # This method iterates over an Array by calling the given block on all 2 consecutive elements
   # it returns a Array of self.size - 1
   #
-  def pairwise(ret=nil, &block)
+  def pairwise(ret=nil, empty: nil, &block)
     raise ArgumentError, 'Array.one_by_one needs an arity of 2 (i.e. |a, b|)' unless block.arity == 2
-    raise ArgumentError, 'Each element of Array should respond to []=, at least the last one fails.' unless self.last.respond_to?(:[]=)
-    return [] if size <= 1
+    raise ArgumentError, 'Each element of Array should respond to []=, at least the last one fails.' if not ret.nil? and not  self.last.respond_to?(:[]=)
+    return empty ||= [] if size <= 1
 
     each_index.map do |i|
       next if i.zero?
@@ -47,7 +47,7 @@ class Array
   # same as pairwise, but with arity of three
   def triplewise(ret=nil, &block)
     raise ArgumentError, 'Array.triplewise needs an arity of 3 (i.e. |a, b, c|)' unless block.arity == 3
-    raise ArgumentError, 'Each element of Array should respond to []=, at least the last one fails.' unless self.last.respond_to?(:[]=)
+    raise ArgumentError, 'Each element of Array should respond to []=, at least the last one fails.' if not ret.nil? and not self.last.respond_to?(:[]=)
     return [] if size <= 2
 
     each_index.map do |i|

data/lib/cotcube-helpers/constants.rb

@@ -0,0 +1,33 @@
+#frozen_string_literal: true
+
+module Cotcube
+  module Helpers
+    SYMBOL_EXAMPLES = [
+      { id: '13874U', symbol: 'ET', ticksize: 0.25, power: 1.25, months: 'HMUZ', bcf: 1.0, reports: 'LF', format: '8.2f', name: 'S&P 500 MICRO' },
+      { id: '209747', symbol: 'NM', ticksize: 0.25, power: 0.5,  monhts: 'HMUZ', bcf: 1.0, reports: 'LF', format: '8.2f', name: 'NASDAQ 100 MICRO' }
+    ].freeze
+
+    COLORS         = %i[light_red light_yellow light_green red yellow green cyan magenta blue].freeze
+
+    MONTH_COLOURS  = { 'F' => :cyan,  'G' => :green,   'H' => :light_green,
+                       'J' => :blue,  'K' => :yellow,  'M' => :light_yellow,
+                       'N' => :cyan,  'Q' => :magenta, 'U' => :light_magenta,
+                       'V' => :blue,  'X' => :red,     'Z' => :light_red }.freeze
+
+    MONTHS         = { 'F' => 1,  'G' =>  2, 'H' =>  3,
+                       'J' => 4,  'K' =>  5, 'M' =>  6,
+                       'N' => 7,  'Q' =>  8, 'U' =>  9,
+                       'V' => 10, 'X' => 11, 'Z' => 12,
+                        1 => 'F',  2 => 'G',  3 => 'H',
+                        4 => 'J',  5 => 'K',  6 => 'M',
+                        7 => 'N',  8 => 'Q',  9 => 'U',
+                       10 => 'V', 11 => 'X', 12 => 'Z' }.freeze
+
+
+    CHICAGO  = Time.find_zone('America/Chicago')
+
+    DATE_FMT = '%Y-%m-%d'
+
+  end
+end
+

data/lib/cotcube-helpers/datetime_ext.rb

@@ -4,9 +4,42 @@
 class DateTime
   # based on the fact that sunday is 'wday 0' plus that trading week starts
   #   sunday 0:00 (as trading starts sunday 5pm CT to fit tokyo monday morning)
+  #
+  # TODO: there is a slight flaw, that 1 sunday per year is 1 hour too short and another is 1 hour too long
+  #
   def to_seconds_since_sunday_morning
     wday * 86_400 + hour * 3600 + min * 60 + sec
   end
 
   alias to_sssm to_seconds_since_sunday_morning
 end
+
+class Date
+
+  # creates a range of 2 dates, of the given calendar week, Monday to Sunday
+  def self.cw( week: , year: Date.today.year )
+    form = '%Y %W %w'
+    build_range = lambda {|w|
+      begin
+        ( DateTime.strptime("#{year} #{w} 1", form).to_date..
+          DateTime.strptime("#{year} #{w} 0", form).to_date)
+      rescue
+        # beyond Dec 31st #strptime must be called with cw:0 to keep it working
+        ( DateTime.strptime("#{year} #{w} 1", form).to_date..
+          DateTime.strptime("#{year+1} 0  0", form).to_date)
+      end
+    }
+    case week
+    when :current
+      build_range.call(Date.today.cweek)
+    when :last
+      wday = Date.today.wday
+      build_range.call((Date.today - (wday.zero? ? 7 : wday)).cweek)
+    when Integer
+      raise ArgumentError, "'#{week}' is not supported as calendar week, choose from (1..53)" if week <= 0 or week > 53
+      build_range.call(week)
+    else
+      raise ArgumentError, "'#{week}' is not a supported format for calendar week"
+    end
+  end
+end

data/lib/cotcube-helpers/get_id_set.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Cotcube
+  module Helpers
+
+    def get_id_set(symbol: nil, id: nil, contract: nil, config: init)
+      contract = contract.to_s.upcase if contract.is_a? Symbol
+      id       =       id.to_s.upcase if       id.is_a? Symbol
+      symbol   =   symbol.to_s.upcase if   symbol.is_a? Symbol
+
+      if contract.is_a?(String) && (contract.length == 5)
+        c_symbol = contract[0..1]
+        if (not symbol.nil?) && (symbol != c_symbol)
+          raise ArgumentError,
+                "Mismatch between given symbol #{symbol} and contract #{contract}"
+        end
+
+        symbol = c_symbol
+      end
+
+      unless symbol.nil?
+        sym = symbols.select { |s| s[:symbol] == symbol.to_s.upcase }.first
+        if sym.nil? || sym[:id].nil?
+          raise ArgumentError,
+                "Could not find match in #{config[:symbols_file]} for given symbol #{symbol}"
+        end
+        raise ArgumentError, "Mismatching symbol #{symbol} and given id #{id}" if (not id.nil?) && (sym[:id] != id)
+
+        return sym
+      end
+      unless id.nil?
+        sym = symbols.select { |s| s[:id] == id.to_s }.first
+        if sym.nil? || sym[:id].nil?
+          raise ArgumentError,
+                "Could not find match in #{config[:symbols_file]} for given id #{id}"
+        end
+        return sym
+      end
+      raise ArgumentError, 'Need :id, :symbol or valid :contract '
+    end
+  end
+end
+

data/lib/cotcube-helpers/init.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Cotcube
+  module Helpers
+
+    def config_prefix
+      os = Gem::Platform.local.os
+      case os
+      when 'linux'
+        ''
+      when 'freebsd'
+        '/usr/local'
+      else
+        raise RuntimeError, "Unsupported architecture: #{os}"
+      end
+    end
+
+    def config_path
+      config_prefix + '/etc/cotcube'
+    end
+
+    def init(config_file_name: nil, 
+             gem_name: nil,
+             debug: false)
+      gem_name ||= self.ancestors.first.to_s
+      config_file_name = "#{gem_name.downcase}.yml"
+      config_file = config_path + "/#{config_file_name}"
+
+      if File.exist?(config_file)
+        config      = YAML.load(File.read config_file).transform_keys(&:to_sym)
+      else
+        config      = {} 
+      end
+
+      defaults = { 
+        data_path: '/var/cotcube/' + name,
+      }
+
+      config = defaults.merge(config)
+      puts "CONFIG is '#{config}'" if debug
+
+      config
+    end
+  end
+end
+

data/lib/cotcube-helpers/symbols.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Cotcube
+  # Missing top level documentation
+  module Helpers
+
+  def symbols(config: init, type: nil, symbol: nil)
+      if config[:symbols_file].nil?
+        SYMBOL_EXAMPLES
+      else
+        CSV
+          .read(config[:symbols_file], headers: %i{ id symbol ticksize power months type bcf reports format name})
+          .map{|row| row.to_h }
+          .map{|row| [ :ticksize, :power, :bcf ].each {|z| row[z] = row[z].to_f}; row[:format] = "%#{row[:format]}f"; row }
+          .reject{|row| row[:id].nil? }
+          .tap{|all| all.select!{|x| x[:type] == type} unless type.nil? }
+          .tap { |all| all.select! { |x| x[:symbol] == symbol } unless symbol.nil? }
+      end
+    end
+
+  end
+end

metadata

@@ -1,43 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: cotcube-helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.7.4
+  version: 0.1.9.2
 platform: ruby
 authors:
 - Benjamin L. Tischendorf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-13 00:00:00.000000000 Z
+date: 2021-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -82,9 +96,12 @@ files:
 - cotcube-helpers.gemspec
 - lib/cotcube-helpers.rb
 - lib/cotcube-helpers/array_ext.rb
+- lib/cotcube-helpers/constants.rb
 - lib/cotcube-helpers/datetime_ext.rb
 - lib/cotcube-helpers/enum_ext.rb
+- lib/cotcube-helpers/get_id_set.rb
 - lib/cotcube-helpers/hash_ext.rb
+- lib/cotcube-helpers/init.rb
 - lib/cotcube-helpers/input.rb
 - lib/cotcube-helpers/parallelize.rb
 - lib/cotcube-helpers/range_ext.rb
@@ -96,6 +113,7 @@ files:
 - lib/cotcube-helpers/swig/date.rb
 - lib/cotcube-helpers/swig/fill_x.rb
 - lib/cotcube-helpers/swig/recognition.rb
+- lib/cotcube-helpers/symbols.rb
 homepage: https://github.com/donkeybridge/cotcube-helpers
 licenses:
 - BSD-4-Clause