card-mod-monkey 0.11.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd42d4f0bc0d9579387e2ea1635f65a4b3eda7a9a652133c12e4d9c1946f70cf
+  data.tar.gz: 935dcf7306c5cbc030875a27120694be45b96178fa9ccaa01e7dfdd2e4d85a0a
+SHA512:
+  metadata.gz: 041023b89d990c023a10f44c940c07d9e568fe2e0ce43e3db7ed71674f62819d781756cba231aaf950ff0adc7aaaede6ae2bb5aba55293784b43ea6d6ca0140c
+  data.tar.gz: 0762cacbac60d29f7d83a89b2c95b74e4a1d140573afa6b6f44b45e5b01fc3e499d526b52f02898292ab7d4af0f94415f4755c1835fbf3215c4cc58eb02e23d3

data/db/migrate_core_cards/20160812112513_add_developer_cards.rb

@@ -0,0 +1,11 @@
+# -*- encoding : utf-8 -*-
+
+class AddDeveloperCards < Cardio::Migration
+  def up
+    ensure_card name: "*debug",
+                codename: "debug"
+    ensure_card name: "*debug+*right+*read",
+                type_id: Card::PointerID,
+                content: "[[Administrator]]"
+  end
+end

data/lib/card/mod/monkey.rb

@@ -0,0 +1,10 @@
+require "colorize"
+require "html2haml"
+# require "sprockets"
+# require "phantomjs"
+require "better_errors"
+require "binding_of_caller"
+require "pry-byebug"
+require "pry-rescue"
+require "pry-rails"
+require "pry-stack_explorer"

data/lib/cardio/pry.rb

@@ -0,0 +1,111 @@
+module Cardio
+  # These commands are available in the console when using binding.pry for breakpoints.
+  module Pry
+    require "rails/console/app"
+    require "cardio/pry/commands"
+    include Rails::ConsoleMethods
+    include Commands
+
+    def create name="test card", content="some content", type="basic"
+      if name.is_a? Hash
+        Card.create! name
+      elsif content.is_a? Hash
+        Card.create! content.merge(name: name)
+      else
+        Card.create! name: name, content: content, type: type
+      end
+    end
+
+    def update name="test card", *args
+      card_attr = {}
+      if args.first.is_a? String
+        card_attr[:content] = args.shift
+        card_attr.merge!(args.first)
+      else
+        card_attr = args.first
+      end
+      Card.fetch(name).update_attributes card_attr
+    end
+
+    # Shortcut for fetching cards. You can continue to work with the
+    # last fetched card by calling `fe` without arguments.
+    # If the first call of `fe` is without argument, fe points to the card "Home"
+    # Example:
+    #    fe.name    # => "Home"
+    #    fe "Basic"
+    #    fe.name    # => "Basic"
+    #    fe.type    # => "cardtype"
+    def fe name=nil
+      if name
+        @fe = Card.fetch name
+      else
+        @fe ||= Card.fetch "home"
+      end
+    end
+
+    def cr name=nil, content="some content", type="basic"
+      if name
+        @cr = create name, content, type
+      else
+        @cr ||= create
+      end
+    end
+
+    def ab
+      Card::Auth.as_bot
+    end
+
+    # use syntax highlighting if html is detected
+    def puts *args
+      text = args.first
+      return super unless args.size == 1 && htmlish?(text)
+      html = Nokogiri::XML text, &:noblanks
+      puts_html(html, text) { |*super_args| super(*super_args) }
+    end
+
+    def htmlish? text
+      text.is_a?(String) && (text.match?(%r{</\w+>}) || text.include?("\e"))
+    end
+
+    def puts_html html, text, &block
+      if html.errors.present?
+        puts_html_errors html, text, &block
+      else
+        puts_highlighted_html html, &block
+      end
+    end
+
+    def puts_html_errors html, text
+      yield text
+      puts
+      yield "WARNING: detected invalid html".red
+      yield html.errors
+    end
+
+    def puts_highlighted_html html
+      # yield "with syntax highlighting:\n"
+      yield CodeRay.scan(html.root.to_s, :html).term
+    end
+
+    def hputs text
+      text = Nokogiri::XML(text, &:noblanks).root.to_s
+      print CodeRay.scan(text, :html).term
+      print "\n"
+    end
+
+    def _a
+      @_array ||= (1..6).to_a
+    end
+
+    def _h
+      @_hash ||= { hello: "world", free: "of charge" }
+    end
+
+    def _u
+      @_user ||= Card.fetch "Joe User"
+    end
+
+    intro = File.read File.expand_path("../pry/intro.txt", __FILE__)
+    puts intro
+  end
+end

data/lib/cardio/pry/commands.rb

@@ -0,0 +1,63 @@
+module Cardio
+  module Pry
+    # Pry command configuration
+    module Commands
+      class << self
+        def alias_command *args
+          ::Pry.config.commands.alias_command(*args)
+        end
+
+        def block_command *args
+          ::Pry.commands.block_command(*args)
+        end
+      end
+
+      ::Pry.config.editor = proc { |file, line| "mine #{file}:#{line}" }
+
+      alias_command "h", "hist -T 20", desc: "Last 20 commands"
+      alias_command "hg", "hist -T 20 -G", desc: "Up to 20 commands matching expression"
+      alias_command "hG", "hist -G", desc: "Commands matching expression ever used"
+      alias_command "hr", "hist -r", desc: "hist -r <command number> to run a command"
+      alias_command "clear", "break --delete-all", desc: "remove all break points"
+
+      # Hit Enter to repeat last command
+      ::Pry::Commands.command(/^$/, "repeat last command") do
+        pry_instance.run_command ::Pry.history.to_a.last
+      end
+
+      if defined?(PryByebug)
+        ::Pry.commands.alias_command "c", "continue"
+        ::Pry.commands.alias_command "s", "step"
+        ::Pry.commands.alias_command "n", "next"
+        ::Pry.commands.alias_command "f", "finish"
+      end
+
+      # breakpoint commands
+      block_command "try", "play expression in current line" do |offset|
+        line = target.eval("__LINE__")
+        line = line.to_i + offset.to_i if offset
+        run "play -e #{line}"
+      end
+
+      block_command "breakview",
+                    "set break point where view is rendered" do |view_name, cardish|
+        breakpoint = "break #{Cardio.gem_root}/lib/card/format/render.rb:43"
+
+        breakpoint += " if view.to_sym == \\'#{view_name}\\'.to_sym" if view_name
+        breakpoint += " && card.key == \\'#{cardish}\\'.to_name.key" if cardish
+        run breakpoint
+      end
+
+      block_command "breaknest", "set break point where nest is rendered" do |card_key|
+        breakpoint = "break #{Cardio.gem_root}/lib/card/format/nest.rb:19"
+        if card_key
+          breakpoint += " if cardish.to_name.key == \\'#{card_key}\\'.to_name.key"
+        end
+        run breakpoint
+      end
+
+      alias_command "bv", "breakview"
+      alias_command "bn", "breaknest"
+    end
+  end
+end

data/lib/cardio/pry/intro.txt

@@ -0,0 +1,34 @@
+== Command history ==
+h     : hist -T 20 Last 20 commands
+hg    : hist -T 20 -G Up to 20 commands matching expression
+hG    : hist -G Commands matching expression ever used
+hr    : hist -r hist -r <command number> to run a command
+Hit Enter to repeat last command
+
+== Variables ==
+_u : Card["Joe User"]
+_a : [1, 2, 3, 4, 5, 6]
+_h : { hello: "world", free: "of charge" }
+
+== Card commands ==
+create : Card.create :name=>$1, :content=>($2||"some content"), :type=>($3||"basic")
+update : Card.update :name=>$1, :content=>($2||"some content"), :type=>($3||"basic")
+ab     : Card::Auth.as_bot
+cr     : create card and assign it to cr
+         (default: name=>"test card", content=>"some content", type=>"basic")
+fe     : fetch card and assign it to fe (default: "Home")
+
+== Breakpoints ==
+breakview (bv) : set break point where view is rendered
+                 (takes a view name and a card mark as optional argument)
+breaknest (bn) : set break point where nest is rendered
+                 (takes a card mark as optional argument)
+clear          : remove all break points
+
+== Helpful debugger shortcuts ==
+hputs : puts with html syntax highlighting
+n     : next
+s     : step
+c     : continue
+f     : finish
+try   : execute current line (without stepping forward)

data/set/all/event_viz.rb

@@ -0,0 +1,64 @@
+# the events method is a developer's tool for visualizing the event order
+# for a given card.
+# For example, from a console you might run
+#
+#   puts mycard.events :update
+#
+# to see the order of events that will be executed on mycard.
+# The indention and arrows (^v) indicate event dependencies.
+#
+# Note: as of yet, the functionality is a bit rough.  It does not display events
+# that are called directly from within other events,
+# and certain event requirements (like the presence of an 'act') may
+# prevent events from showing up in the tree.
+def events action
+  @action = action
+  events = Director::Stages::STAGES.map { |stage| events_tree "#{stage}_stage" }
+  @action = nil
+  print_events events
+end
+
+def events_tree filt
+  try("_#{filt}_callbacks")&.each_with_object({ name: filt }) do |callback, hash|
+    events_branch hash, callback.kind, callback.filter if callback.applies? self
+  end
+end
+
+private
+
+def print_events events, prefix="", depth=0
+  depth += 1
+  space = " " * (depth * 2)
+  text = ""
+  events.each do |event|
+    text += print_event_pre event, depth, space
+    text += print_event_main event, prefix
+    text += print_event_post event, depth, space
+  end
+  text
+end
+
+def print_event_pre event, depth, space
+  if event[:before]
+    print_events event[:before], space + "v  ", depth
+  elsif event[:around]
+    print_events event[:around], space + "vv ", depth
+  else
+    ""
+  end
+end
+
+def print_event_main event, prefix
+  "#{prefix}#{event[:name]}\n"
+end
+
+def print_event_post event, depth, space
+  return "" unless event[:after]
+
+  print_events event[:after], space + "^  ", depth
+end
+
+def events_branch hash, kind, filter
+  hash[kind] ||= []
+  hash[kind] << events_tree(filter)
+end

data/set/all/view_viz.rb

@@ -0,0 +1,23 @@
+format :html do
+  view :views_by_format do
+    format_views =
+      self.class.ancestors.each_with_object({}) do |format_class, hash|
+        views =
+          format_class.instance_methods.map do |method|
+            next unless method.to_s =~ /^_view_(.+)$/
+            Regexp.last_match(1)
+          end.compact
+        next unless  views.present?
+        format_class.name =~ /^Card(::Set)?::(.+?)$/ #::(\w+Format)
+        hash[Regexp.last_match(2)] = views
+      end
+    accordion_group format_views
+  end
+
+  view :views_by_name do
+    views = methods.map do |method|
+      Regexp.last_match(1) if method.to_s.match?(/^_view_(.+)$/)
+    end.compact.sort
+    list_group views
+  end
+end

data/set/right/debug.rb

@@ -0,0 +1,88 @@
+def virtual?
+  new?
+end
+
+format :html do
+  view :core do
+    core_section_config(card.left).map do |item|
+      section(*item)
+    end
+  end
+
+  def core_section_config subject
+    [["Sets", tabs("set modules" => set_modules_accordion(subject),
+                   "all modules" => singleton_modules_list(subject),
+                   "patterns"    => set_patterns_breadcrumb(subject))],
+     ["Views", tabs("by format" => subformat(subject)._render_views_by_format,
+                    "by name" => subformat(subject)._render_views_by_name)],
+     ["Events", tabs(create: "<pre>#{subject.events(:create)}</pre>",
+                     update: "<pre>#{subject.events(:update)}</pre>",
+                     delete: "<pre>#{subject.events(:delete)}</pre>")],
+     ["Cache/DB Comparison", cache_comparison_table(subject)]]
+  end
+
+  # rubocop:disable AccessorMethodName
+  def set_modules_accordion subject
+    sets = subject.set_modules.each_with_object({}) do |sm, hash|
+      ans = sm.ancestors
+      ans.shift
+      hash[sm.to_s] = ans
+    end
+    accordion_group sets
+  end
+
+  def set_patterns_breadcrumb subject
+    links = subject.patterns.reverse.map { |pattern| link_to_card pattern.to_s }
+    breadcrumb links
+  end
+  # rubocop:enable AccessorMethodName
+
+  def singleton_modules_list subject
+    all_mods = subject.singleton_class.ancestors.map(&:to_s)
+    all_mods.shift
+    list_group all_mods
+  end
+
+  def cache_comparison_table subject
+    cache_card = Card.fetch(subject.key)
+    db_card    = Card.find_by_key(subject.key)
+    return unless cache_card && db_card
+    table(
+      %i[name updated_at updater_id content inspect].map do |field|
+        [field.to_s,
+         h(cache_card.send(field)),
+         h(db_card.send(field))]
+      end,
+      header: ["Field", "Cache Val", "Database Val"]
+    )
+  end
+
+  def section title, content
+    %(
+      <h2>#{title}</h2>
+      #{content}
+    )
+  end
+
+  def class_locations klass
+    methods = defined_methods(klass)
+    file_groups = methods.group_by { |sl| sl[0] }
+    file_counts = file_groups.map do |file, sls|
+      lines = sls.map { |sl| sl[1] }
+      count = lines.size
+      line = lines.min
+      { file: file, count: count, line: line }
+    end
+    file_counts.sort_by! { |fc| fc[:count] }
+    file_counts.map { |fc| [fc[:file], fc[:line]] }
+  end
+
+  def defined_methods klass
+    methods =
+      klass.methods(false).map { |m| klass.method(m) } +
+      klass.instance_methods(false).map { |m| klass.instance_method(m) }
+    methods.map!(&:source_location)
+    methods.compact!
+    methods
+  end
+end

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: card-mod-monkey
+version: !ruby/object:Gem::Version
+  version: 0.11.0
+platform: ruby
+authors:
+- Ethan McCutchen
+- Philipp Kühl
+- Gerry Gleason
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: card
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.101.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.101.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: html2haml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.88'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.88'
+- !ruby/object:Gem::Dependency
+  name: better_errors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rescue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-stack_explorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- info@decko.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- db/migrate_core_cards/20160812112513_add_developer_cards.rb
+- lib/card/mod/monkey.rb
+- lib/cardio/pry.rb
+- lib/cardio/pry/commands.rb
+- lib/cardio/pry/intro.txt
+- set/all/event_viz.rb
+- set/all/view_viz.rb
+- set/right/debug.rb
+homepage: http://decko.org
+licenses:
+- GPL-3.0
+metadata:
+  card-mod: monkey
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: dev support for mod developers (monkeys)
+test_files: []