nodepile 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e332bc4f537c99de9ed8c56812547874ddbe5afc02e0549de02d46c7bca5170
-  data.tar.gz: ef7c4a1c8458dfd2372515773ee360efed304a2b3a7c6c88f569f0aff74a68c9
+  metadata.gz: 0f5e500d69380f252e066be80ecc79f173f9546ebb5c428071fb33c889898b80
+  data.tar.gz: e0e9714d8f0d552a0e0cc24ba5806894cafe9fefbdcbd9e33cf0d51b3a9db916
 SHA512:
-  metadata.gz: 84726023610a366bf199b12f0906d73402fa56875f2b5ba0e4284aa11c22646ceb872ef417beb6f800212d8fe2242f6cf27b5cfada1744ebe34632527b016c01
-  data.tar.gz: 3e81b917b0318e3668207fd6cc720b2a2df5253c2573a630852632bf9d80277b9099e02e311c1d669fd8c72295ef9c682dc1321001d5dc6ab3e501594d241fd0
+  metadata.gz: 7e39d3f127385ed3562ccc4ba8a940665075b70cbff267837be44c304baa3a697b5f7a875285ac65a89ec5849494464d45c6401eef6a71bb499a6e04a9b7352f
+  data.tar.gz: 8cc2401dca81d3e3f24e3234e7e4fc89a911c0c0d89cdbdc28e560d790f72eb2150d7f0504246bf36ed065d1cf960cfaba25d30b2ba153fad98f39a4ce8fba52

data/.rspec

@@ -1,3 +1,5 @@
 --format documentation
 --color
 --require spec_helper
+
+

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
 Style/StringLiterals:
   Enabled: true

data/BACKLOG.md

@@ -0,0 +1,34 @@
+# Development Backlog
+
+## Primary Backlog
+* Implement one or two test cases in spec/pragmas_spec.rb
+* Add a command line program that can take an input file and generate an image file as output in a pretty painless way like "nodepile srcfile.csv outputfile.png"
+* Create a baby simple rack-compatible app to render diagrams and be able to output the flattened data.
+* Add an _emphasis column as a shorthand for certain stylistic modifications: strong, weak, hidden, clear, big, faint, tiny
+* Add a _url column
+* Add a _tooltip column
+* Add a _next column (or something named similar) to allow nested substates.  Note that nested substates may also have a visibility implication.  In particular, that the nested substates can only be seen when viewed from their same nesting level (with blank nesting level being the top level)
+* Add a rakefile command to build/make (see note with 2023-07-15)
+
+## Maybe Someday Backlog
+* NECESSARY? - Add a #yield_flat() to the organizer that will iterate through the summaries
+
+## Supporting Notes
+### Rakefile Commands to Add 2023-07-15
+* Build the gem 
+* List the current version number
+* Increment the current version number
+* Example below was taking almost verbatim from a tutorial
+```ruby
+GEM_NAME = "nodepile"
+GEM_VERSION = "0.0.0"
+
+
+task :publish => :build do
+  system 'gem push ' + GEM_NAME + "-" + GEM_VERSION + ".gem"
+end
+
+task :clean do
+  system "rm *.gem"
+end
+```

data/Rakefile

@@ -1,12 +1,102 @@
 # frozen_string_literal: true
 
+require 'rake'
+require 'yard'
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
+begin
+  require 'bundler/setup'
+  Bundler::GemHelper.install_tasks
+rescue LoadError
+  puts 'although not required, bundler is recommended for running the tests'
+end
+
 require "rubocop/rake_task"
 
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
+end
+
 
 task default: %i[spec rubocop]
+
+# Dave's Dev trinkets below
+LINE_LEVEL_SWEEP_TESTS = [
+    Proc.new {|line| line.match(/^[^#]*binding\.pry/) && "found uncommented binding.pry"},
+    Proc.new {|line| line.match(/^[^#]*binding\.irb/) && "found uncommented binding.irb"},
+    Proc.new {|line| line.match(/^[^#]*debugger/) && "found uncommented debugger invocation"},
+    Proc.new {|line| line.match(/^.*#\s*DEBUG/) && "found debug line"},
+    Proc.new {|line| line.match(/^[^#]*require[^#]+['"]pry/) && "uncommented require of 'pry' code"},
+    Proc.new {|line| line.match(/^[^#]*TDOUT\.puts ([^\s]+)\.inspect/) && "verbose obj going to stdout"},
+    Proc.new {|line| line.match(/^[^#]*debug_mode\s+:console/) && "sentry set with debug_mode :console"},
+]
+
+
+# rake yard   #to generate documentation
+YARD::Rake::YardocTask.new do |t|
+ t.files   = ['lib/**/*.rb', 'README','LICENSE']   # optional
+ #t.options = ['--any', '--extra', '--opts'] # optional
+ t.stats_options = ['--list-undoc']         # optional
+end
+
+def simplify_dir(target_path)
+    this_root = Pathname.new(File.dirname(__FILE__))
+    target = Pathname.new(target_path)
+    target.relative_path_from(this_root)
+end
+
+desc "Serve yard docs on port 8080 with automatic reload"
+task :yardserv do
+    puts "You probably want to run this directly from the command line with:"
+    puts "yard server --reload -p 8080"
+end
+
+
+desc "Build the gem and deploy to rubygems"
+task :publish => :build do
+    File.open(File.join(__dir__,'lib','nodepile','version.rb')){|f|
+        f.each{|line|
+                    if /\s*VERSION\s*=\s*"([^"]+)"/ =~ line
+                        system 'gem push ' + 'pkg/nodepile' + "-" + $1 + ".gem" 
+                        break
+                    end
+                }
+       }
+end
+
+desc "Pre-release sweep of code"
+task :sweep do
+    
+    a = Dir["#{File.dirname(__FILE__)}/**/*.rb"]
+    alert_was_triggered = nil
+    a.each{|fname| 
+        num = 0
+        File.open(fname,"r") do |f|
+            next if fname.match(/\/tests\//)
+            f.each_line do |line|
+                num+= 1
+                LINE_LEVEL_SWEEP_TESTS.each{|proc|     
+                                            err_msg = proc.call(line)
+                                            if err_msg
+                                                if !alert_was_triggered
+                                                    puts "\nSweep found problems in source code..."
+                                                    alert_was_triggered = true
+                                                end
+                                                puts "{#{simplify_dir(fname)} : #{num}} - #{err_msg}"  
+                                            end
+                                           }
+            end  # loop over lines in file
+        end # loop over files
+    
+    } # end loop over sourcecode
+    puts "Hurray! No active debug code found in the project." unless alert_was_triggered
+    
+    # Clean up code elements that may linger
+     FileUtils.rm(Dir["#{File.dirname(__FILE__)}/test/tmp/*"])
+end # sweep task
+
+

data/lib/nodepile/base_structs.rb

@@ -0,0 +1,62 @@
+
+# Define a few basic "interchange" classes tha
+
+module Nodepile
+    
+# Caches the result of named calculations and their parameters and provides
+# a crude flushing
+class CrudeCalculationCache
+    
+    # Used to disable use of cache by all instances of this class.  Note that this
+    # is extremely useful during testing.
+    def self.global_disable_cache(flag) = @@universally_disable_cache = flag
+    
+    # @param disable_cache [Boolean] if truthy, then caching is never triggered
+    #                        for this object
+    def initialize(disable_cache: false)
+       @h = Hash.new
+       @disable_cache = disable_cache
+    end
+   
+    # Empties the entire cache forcing recalculation of some or all entries
+    # @param name [String,Symbol,nil] Name of the calculation or nil if all calculations
+    #               are to be flushed
+    # @param params [] If empty, all cached values for the given name will be flushed
+    def flush_cache(name = nil, *params) 
+        if key.nil?
+            @h.clear
+        elsif params.empty?
+            @h.delete(name) # delete simple keys
+            @h.delete{|(cname,*cparams)| cname == name }
+        else
+            @h.delete([key,*params])
+        end
+        return nil
+    end
+    
+    def form_cache_key(sym,*parms) = parms.empty? ? sym : [sym,*parms]
+    def stuff_cache(val,sym,*parms) = @h[form_cache_key(sym,*parms)] = val
+    def has_cache?(sym,*parms) = @h.include?(form_cache_key(sym,*parms))
+        
+    def fetch_cache(sym,*parms)
+        key = form_cache_key(sym,*parms)
+        raise "This item is not in the cache #{key.inspect}" unless @h.include?(key)
+        return @h[key]
+    end
+   
+    # Will either retrieve the value matching these parameters from the cache
+    # or will do the calculation, cache the value, and return the result
+    def cache(sym,*parms)
+        raise "Calculation block expected" unless block_given?
+        key = form_cache_key(sym,*parms)
+        if @h.include?(key) && !@disable_cache && !@@global_disable_cache
+            return @h[key]
+        else
+            return @h[sym] = yield(*parms)
+        end
+    end
+
+    @@global_disable_cache = false
+end
+    
+end #module Nodepile