conscriptor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 34181222df46d9b305f28dacb4d0bfe5580b167149c3af54c1b7eb6b283afc10
+  data.tar.gz: b70506321c62b6b27a59b24fabe7686965282d3c9729ac370fe2d4c04c082103
+SHA512:
+  metadata.gz: f1d63a3b20b4d384122eb13050d55689dc1406793bea7595a1fe501551201a2e58424c13865545fa6ec151e2239fc47689756aed0c2f75795b223035a5bed5e2
+  data.tar.gz: 3e69376b0f1a274f9e35d896c0b7734ee64d624a25bd656e3a436b1703db4d36780c9f66d539be85440cbfb30dec14cbd5b46ff8ba5ab53670eb8d30717dd0cc

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jeremy Lightsmith
+
+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,51 @@
+# Conscriptor
+
+[![Gem Version](https://badge.fury.io/rb/conscriptor.svg)](https://rubygems.org/gems/conscriptor)
+[![Circle](https://circleci.com/gh/jeremylightsmith/conscriptor/tree/main.svg?style=shield)](https://app.circleci.com/pipelines/github/jeremylightsmith/conscriptor?branch=main)
+[![Code Climate](https://codeclimate.com/github/jeremylightsmith/conscriptor/badges/gpa.svg)](https://codeclimate.com/github/jeremylightsmith/conscriptor)
+
+This is several tools that we have found extremely useful when writing scripts or debugging code in ruby and rails projects.
+
+---
+
+- [Quick start](#quick-start)
+- [Examples](#examples)
+- [Support](#support)
+- [License](#license)
+- [Code of conduct](#code-of-conduct)
+- [Contribution guide](#contribution-guide)
+
+## Quick start
+
+```
+$ gem install conscriptor
+```
+
+```ruby
+require "conscriptor"
+```
+
+## Examples
+
+```ruby
+include Conscriptor
+
+tbd...
+
+```
+
+## Support
+
+If you want to report a bug, or have ideas, feedback or questions about the gem, [let me know via GitHub issues](https://github.com/jeremylightsmith/conscriptor/issues/new) and I will do my best to provide a helpful answer. Happy hacking!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE.txt).
+
+## Code of conduct
+
+Everyone interacting in this project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).
+
+## Contribution guide
+
+Pull requests are welcome!

data/lib/conscriptor.rb

@@ -0,0 +1,103 @@
+require_relative 'conscriptor/event_counter'
+require_relative 'conscriptor/hierarchical_context_logger'
+require_relative 'conscriptor/histogram'
+require_relative 'conscriptor/progress_reporter'
+require_relative 'conscriptor/say'
+
+module Conscriptor
+  autoload :VERSION, 'conscriptor/version'
+  include Conscriptor::Say
+  include Conscriptor::Histogram
+
+  def clog
+    @clog ||= Conscriptor::HierarchicalContextLogger.new
+  end
+
+  def counts
+    $counts ||= Conscriptor::EventCounter.new # rubocop:disable Style/GlobalVars
+  end
+
+  def safe_transaction
+    ActiveRecord::Base.transaction do
+      begin
+        yield
+        say "job's done"
+      rescue StandardError
+        say 'nope'
+        raise
+      end
+
+      counts.dump
+      commit_or_rollback
+    end
+  end
+
+  # save an active record, even if it has errors
+  def save_even_with_errors(obj)
+    return if obj.save
+
+    counts.record_and_print('!'.yellow, "Error saving: #{obj.errors.full_messages.join(',')}")
+    obj.save validate: false
+  end
+
+  def app_backtrace(exception)
+    bc = ActiveSupport::BacktraceCleaner.new
+    bc.clean(exception.backtrace)
+  end
+
+  def print_error
+    puts $ERROR_INFO.message.red
+    puts app_backtrace($ERROR_INFO).map { |b| "    #{b}" }.join("\n").red
+  end
+
+  def catch_exceptions(message='')
+    yield
+  rescue StandardError
+    print message.red
+    print_backtrace
+  end
+
+  def commit_or_rollback
+    puts "\nCommit? (y/n)"
+
+    if $stdin.gets.chomp == 'y'
+      puts 'Committing.'
+    else
+      puts 'Rolling Back.'
+      raise ActiveRecord::Rollback
+    end
+  end
+
+  def time(name)
+    start = Time.now
+    retval = nil
+    begin
+      retval = yield
+    ensure
+      ((@times ||= {})[name] ||= []) << Time.now - start
+    end
+    retval
+  end
+
+  def print_times
+    puts 'Printing Times'.bold
+    @times.each do |name, times|
+      puts "  #{name} (#{times.count} times) : #{times.sum / times.count}s (avg)"
+    end
+  end
+
+  # usage:
+  # start_timer total: Lesson.count, report_every: 100
+  def start_timer(name: nil, total: nil, report_every: nil, log: nil)
+    @progress = Conscriptor::ProgressReporter.new(name: name, total: total, report_every: report_every, log: log)
+  end
+
+  def inc_timer(by: 1)
+    @progress.inc(by: by)
+  end
+
+  # lines in a file
+  def num_lines(file)
+    `wc -l < #{file}`.to_i
+  end
+end

data/lib/conscriptor/event_counter.rb

@@ -0,0 +1,88 @@
+require_relative './histogram'
+require 'logger'
+
+module Conscriptor
+  class EventCounter
+    include Histogram
+
+    def initialize(logger=Logger.new($stdout))
+      @logger = logger
+      clear
+    end
+
+    def record(event)
+      record_many(event, 1)
+    end
+
+    def record_and_print(symbol, event)
+      record(event)
+      print symbol
+      @key[event] = symbol
+    end
+
+    def record_many(event, how_many)
+      @counts[event] ||= 0
+      @counts[event] += how_many
+    end
+
+    def [](event)
+      @counts[event]
+    end
+
+    def record_error(event, error)
+      (@errors[event] ||= []) << error
+    end
+
+    def clear(*keys)
+      if keys.empty?
+        @counts = {}
+        @errors = {}
+      else
+        keys.each do |key|
+          @counts.delete(key)
+          @errors.delete(key)
+        end
+      end
+      @key = {}
+    end
+
+    def empty?
+      @counts.empty?
+    end
+
+    def errors?
+      !@errors.empty?
+    end
+
+    def to_s
+      @counts.map { |k, v| "#{k} = #{v}" }.sort.join(', ')
+    end
+
+    def dump
+      @logger.info("\n#{@counts.sort_by { |_k, v| -v }.map { |k, v| "#{k} = #{v}" }.join("\n")}")
+
+      unless @errors.empty?
+        require 'colorize'
+
+        @errors.each do |event, errors|
+          @logger.info "Error #{event} (#{errors.count}):\n#{histogram(errors)}".red
+        end
+      end
+
+      print_key
+    end
+
+    def print_key
+      return if @key.empty?
+
+      puts "\nKey"
+      @key.each do |event, symbol|
+        puts "    #{symbol} = #{event} (#{@counts[event]})"
+      end
+    end
+
+    def to_h
+      @counts
+    end
+  end
+end

data/lib/conscriptor/hierarchical_context_logger.rb

@@ -0,0 +1,54 @@
+# this will include hierarchical context ONLY when you log. so you can add parents and grandparents of a lesson,
+# and only when you call "info" will those print out.
+#
+# Allows you to track layers of context, e.g. multiple levels of iteration schools -> conference_reports -> widgets.
+#
+# Historical context: there's a bunch of code in lesson importing that was managing hierarchical logging before this
+# code was born, and we could probably use this here.
+module Conscriptor
+  class HierarchicalContextLogger
+    attr_writer :context
+
+    def initialize
+      @context = []
+      @printed_context = []
+    end
+
+    # write a message with the context printed as well
+    def info(message)
+      @context.length.times do |level|
+        puts_at_level @context[level], level if @context[0..level] != @printed_context[0..level]
+      end
+      @printed_context = @context.dup
+      puts_at_level message, @context.length
+    end
+
+    def with_context(thing)
+      push_context(thing)
+      yield
+    ensure
+      pop_context
+    end
+
+    # ideally, use #with_context instead
+    # adds a level of context, e.g. 'school' or 'user'
+    def push_context(thing)
+      @context.push(thing)
+    end
+
+    # ideally, use #with_context instead
+    def pop_context
+      @context.pop
+    end
+
+    def pop_context_to(level:)
+      @context.pop while @context.length > level
+    end
+
+    private
+
+    def puts_at_level(message, level)
+      puts "#{'   ' * level}#{message}"
+    end
+  end
+end

data/lib/conscriptor/histogram.rb

@@ -0,0 +1,22 @@
+module Conscriptor
+  module Histogram
+    # Takes an array of values, groups them by identity and counts them, then produces a string output that
+    # can be printed.
+    #
+    # 928  Foo
+    # 55   Bar
+    # 5    Baz
+    def histogram(things, indent: '')
+      occurences = {}
+      things.each do |thing|
+        occurences[thing] = (occurences[thing] || 0) + 1
+      end
+      lines = occurences
+              .sort_by { |a, b| [b, a.to_s] }
+              .reverse
+              .map { |thing, count| "#{count}\t #{thing}" }
+
+      "#{indent}#{lines.join("\n#{indent}")}"
+    end
+  end
+end

data/lib/conscriptor/progress_reporter.rb

@@ -0,0 +1,34 @@
+require 'logger'
+
+module Conscriptor
+  class ProgressReporter
+    attr_reader :count
+
+    def initialize(total:, name: nil, report_every: 1, logger: nil)
+      @name = name
+      @total = total
+      @report_every = report_every || 1
+      @logger = logger || Logger.new($stdout)
+      @count = 0
+      @start_time = Time.now
+    end
+
+    def inc(name: @name, by: 1)
+      @count += by
+
+      if @count % @report_every == 0 # rubocop:disable Style/GuardClause
+        percent_complete = 100 * @count / @total
+        time_spent = Time.now - @start_time
+        time_left = @total * time_spent / @count - time_spent
+
+        @logger.info "#{name} #{@count}/#{@total} (#{percent_complete}%)" \
+                     " #{(time_spent / 60).round(1)}m spent," \
+                     " #{(time_left / 60).round(1)}m to go-ish"
+      end
+    end
+
+    def done?
+      @count >= @total
+    end
+  end
+end

data/lib/conscriptor/say.rb

@@ -0,0 +1,9 @@
+module Conscriptor
+  module Say
+    def say(what)
+      `say #{what}`
+    rescue StandardError
+      # ignore
+    end
+  end
+end

data/lib/conscriptor/version.rb

@@ -0,0 +1,3 @@
+module Conscriptor
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: conscriptor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Lightsmith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-07-13 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- jeremy.lightsmith@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/conscriptor.rb
+- lib/conscriptor/event_counter.rb
+- lib/conscriptor/hierarchical_context_logger.rb
+- lib/conscriptor/histogram.rb
+- lib/conscriptor/progress_reporter.rb
+- lib/conscriptor/say.rb
+- lib/conscriptor/version.rb
+homepage: https://github.com/jeremylightsmith/conscriptor
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/jeremylightsmith/conscriptor/issues
+  changelog_uri: https://github.com/jeremylightsmith/conscriptor/releases
+  source_code_uri: https://github.com/jeremylightsmith/conscriptor
+  homepage_uri: https://github.com/jeremylightsmith/conscriptor
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Helpful utilities for writing scripts in ruby
+test_files: []