dogfood 0.1.0

data/lib/dogfood/randomness.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Dogfood
+  class Randomness
+    attr_reader :seed
+
+    def initialize(seed: nil)
+      @seed = seed || Random.new_seed
+      @random = Random.new(@seed)
+    end
+
+    def branch(weights)
+      total = weights.values.sum.to_f
+      threshold = @random.rand * total
+      cumulative = 0.0
+
+      weights.each do |key, weight|
+        cumulative += weight
+        return key if threshold < cumulative
+      end
+
+      weights.keys.last
+    end
+
+    def pick(collection)
+      collection.sample(random: @random)
+    end
+
+    def sample(collection, count)
+      collection.sample(count, random: @random)
+    end
+
+    def rand(range = nil)
+      range ? @random.rand(range) : @random.rand
+    end
+  end
+end

data/lib/dogfood/renderer.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "erb"
+
+module Dogfood
+  class Renderer
+    TEMPLATE_PATH = File.expand_path("templates/day_log.md.erb", __dir__)
+
+    def initialize(result)
+      @result = result
+    end
+
+    def render
+      ERB.new(template, trim_mode: "-").result(binding)
+    end
+
+    private
+
+    def template
+      File.read(TEMPLATE_PATH)
+    end
+
+    def render_story(story)
+      lines = []
+      lines << "#### #{story[:id]}"
+      lines << "**Status:** #{story[:state][:status]}"
+      lines << "**Substatus:** #{story[:state][:substatus] || '-'}"
+      story[:steps].each do |step|
+        lines << "#{step.number}. **#{step.actor}** — #{step.event}"
+        lines << "   - **Action:** #{step.action}"
+        lines << "   - **Notes:** #{step.notes}" unless step.notes.to_s.empty?
+      end
+      lines.join("\n") + "\n"
+    end
+
+    def escape_table_cell(text)
+      text.to_s.gsub("|", "\\|").gsub("\n", "<br>")
+    end
+  end
+end

data/lib/dogfood/scheduler.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Dogfood
+  class Scheduler
+    DEFAULT_DELAYS = {
+      parts_arrival:    { same_day: 0.40, next_day: 0.40, two_to_three_days: 0.15, next_week: 0.05 },
+      customer_approval: { same_day: 0.60, next_day: 0.25, two_to_three_days: 0.10, next_week: 0.05 },
+      payment:          { same_day: 0.70, next_week: 0.20, net_30: 0.10 },
+      core_return:      { next_day: 0.70, two_to_three_days: 0.30 },
+      labor_completion: { same_day: 0.85, next_day: 0.15 }
+    }.freeze
+
+    def initialize(rng, delays: {})
+      @rng = rng
+      @delays = DEFAULT_DELAYS.merge(delays)
+    end
+
+    def schedule(event)
+      distribution = @delays.fetch(event) { raise ArgumentError, "Unknown event: #{event}" }
+      delay_days = resolve_delay(distribution)
+      { delay_days: delay_days, event: event }
+    end
+
+    private
+
+    def resolve_delay(distribution)
+      total = distribution.values.sum.to_f
+      threshold = @rng.rand * total
+      cumulative = 0.0
+      distribution.each do |bucket, weight|
+        cumulative += weight
+        return delay_for(bucket) if threshold < cumulative
+      end
+      delay_for(distribution.keys.last)
+    end
+
+    def delay_for(bucket)
+      case bucket
+      when :same_day then 0
+      when :next_day then 1
+      when :two_to_three_days then @rng.rand(2..3)
+      when :next_week then 7
+      when :net_30 then 30
+      end
+    end
+  end
+end

data/lib/dogfood/step.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Dogfood
+  class Step
+    attr_reader :number, :actor, :event, :action, :notes
+
+    def initialize(number:, actor:, event:, action:, notes: nil)
+      @number = number
+      @actor = actor
+      @event = event
+      @action = action
+      @notes = notes || ""
+    end
+
+    def to_row
+      [number, actor, event, action, notes]
+    end
+  end
+end

data/lib/dogfood/story_base.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Dogfood
+  class StoryBase
+    attr_reader :rng, :steps, :id
+
+    def initialize(rng:, id:)
+      @rng = rng
+      @id = id
+      @steps = []
+      @state = { status: :estimate, substatus: nil }
+      @step_number = 0
+      @next_stage = nil
+    end
+
+    def title
+      raise NotImplementedError
+    end
+
+    def template_key
+      self.class.name.split("::").last.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+    end
+
+    def state
+      @state.dup
+    end
+
+    def advance(day_index:)
+      raise NotImplementedError
+    end
+
+    protected
+
+    def step(actor:, event:, action:, notes: nil)
+      @step_number += 1
+      @steps << Dogfood::Step.new(
+        number: @step_number,
+        actor: actor,
+        event: event,
+        action: action,
+        notes: notes || ""
+      )
+    end
+
+    def update_state(status:, substatus:)
+      @state[:status] = status
+      @state[:substatus] = substatus
+    end
+
+    def branch(weights)
+      @rng.branch(weights)
+    end
+
+    def pick(collection)
+      @rng.pick(collection)
+    end
+
+    def sample(collection, count)
+      @rng.sample(collection, count)
+    end
+
+    def rand(range = nil)
+      @rng.rand(range)
+    end
+  end
+end

data/lib/dogfood/story_builder.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Dogfood
+  class StoryBuilder
+    def initialize(pack:, rng:)
+      @pack = pack
+      @rng = rng
+      @counter = 0
+    end
+
+    def build(fleet_ratio: 0.0, include: nil)
+      @counter += 1
+      id = "WO-#{@counter.to_s.rjust(3, '0')}"
+      name = include || @pack.scenario_keys.sample(random: @rng)
+      klass = @pack.find_scenario(name)
+      klass.new(rng: @rng, id: id)
+    end
+
+    def available_keys
+      @pack.scenario_keys
+    end
+  end
+end

data/lib/dogfood/templates/day_log.md.erb

@@ -0,0 +1,44 @@
+# Shop Simulation
+
+**Generated:** <%= Time.now.strftime("%Y-%m-%d %H:%M:%S") %>
+**Seed:** <%= @result[:seed] %>
+**Days:** <%= @result[:days].length %>
+
+<% @result[:days].each do |day| -%>
+---
+
+## Day <%= day[:index] + 1 %> — <%= day[:date] %>
+
+### Shift briefing
+- New work orders today: <%= day[:morning].length + day[:afternoon].length + day[:evening].length - day[:carry_overs].length %>
+- Carry-overs: <%= day[:carry_overs].length %>
+
+<% unless day[:carry_overs].empty? -%>
+### Carry-overs
+<% day[:carry_overs].each do |wo| -%>
+- **<%= wo[:id] %>**: status `<%= wo[:status] %>` / `<%= wo[:substatus] %>`
+<% end -%>
+<% end -%>
+
+### Morning
+<% day[:morning].each do |story| -%>
+<%= render_story(story) %>
+<% end -%>
+
+### Afternoon
+<% day[:afternoon].each do |story| -%>
+<%= render_story(story) %>
+<% end -%>
+
+### Evening
+<% day[:evening].each do |story| -%>
+<%= render_story(story) %>
+<% end -%>
+
+### End-of-day board
+| WO | Status | Substatus | Next action |
+|----|--------|-----------|-------------|
+<% day[:end_of_day_board].each do |wo| -%>
+| <%= escape_table_cell(wo[:id]) %> | <%= escape_table_cell(wo[:status]) %> | <%= escape_table_cell(wo[:substatus]) %> | <%= escape_table_cell(wo[:substatus] || "Continue") %> |
+<% end -%>
+<% end -%>

data/lib/dogfood/test/smoke.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dogfood
+  module Test
+    # CI smoke-test helper. See SPEC.md 6.
+    module Smoke
+      def self.load_pack(path)
+        Dogfood::Pack.current = nil
+        load path # the pack file sets Dogfood::Pack.current
+        Dogfood::Pack.current or raise "Pack file did not set Dogfood::Pack.current"
+      end
+
+      def self.run_scenario(pack, name, days:, seed:)
+        pack.find_scenario(name)
+        generator = Dogfood::DayGenerator.new(pack: pack, days: days, seed: seed)
+        generator.generate # raises on any exception
+      end
+    end
+  end
+end

data/lib/dogfood/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Dogfood
+  VERSION = "0.1.0"
+end

data/lib/dogfood.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "dogfood/version"
+require_relative "dogfood/randomness"
+require_relative "dogfood/scheduler"
+require_relative "dogfood/ledger"
+require_relative "dogfood/step"
+require_relative "dogfood/story_base"
+require_relative "dogfood/story_builder"
+require_relative "dogfood/pack"
+require_relative "dogfood/day_generator"
+require_relative "dogfood/renderer"
+require_relative "dogfood/dsl/evaluator"
+require_relative "dogfood/dsl/schema"
+require_relative "dogfood/dsl/compiler"
+require_relative "dogfood/dsl/explain_renderer"
+require_relative "dogfood/test/smoke"
+require_relative "dogfood/cli"
+
+module Dogfood
+  NestingTooDeep = Class.new(StandardError)
+end
+
+if defined?(Rails::Engine)
+  require_relative "dogfood/railtie"
+end

data/lib/generators/dogfood/install/install_generator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Dogfood
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      def create_pack_file
+        template "dogfood.rb.tt", "config/dogfood.rb"
+      end
+
+      def create_scenarios_dir
+        empty_directory "config/dogfood"
+        template "example_scenario.yml.tt", "config/dogfood/example.yml"
+      end
+
+      def create_smoke_test
+        template "yml_smoke_test.rb.tt", "test/dogfood/yml_smoke_test.rb"
+      end
+
+      def show_readme
+        say "\nDogfood installed. Edit config/dogfood.rb to register your"
+        say "step modules, then drop scenarios into config/dogfood/*.yml."
+        say "Run `bin/rails dogfood --list` to see them.\n"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: dogfood
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ben D'Angelo
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: Generates realistic multi-day workflows for UX testing. Domain-agnostic;
+  content supplied via packs.
+email:
+- ben@bendangelo.me
+executables:
+- dogfood
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/dogfood
+- lib/dogfood.rb
+- lib/dogfood/cli.rb
+- lib/dogfood/day_generator.rb
+- lib/dogfood/dsl/compiler.rb
+- lib/dogfood/dsl/evaluator.rb
+- lib/dogfood/dsl/explain_renderer.rb
+- lib/dogfood/dsl/schema.rb
+- lib/dogfood/ledger.rb
+- lib/dogfood/pack.rb
+- lib/dogfood/railtie.rb
+- lib/dogfood/randomness.rb
+- lib/dogfood/renderer.rb
+- lib/dogfood/scheduler.rb
+- lib/dogfood/step.rb
+- lib/dogfood/story_base.rb
+- lib/dogfood/story_builder.rb
+- lib/dogfood/templates/day_log.md.erb
+- lib/dogfood/test/smoke.rb
+- lib/dogfood/version.rb
+- lib/generators/dogfood/install/install_generator.rb
+homepage: https://github.com/bendangelo/dogfood
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bendangelo/dogfood
+  source_code_uri: https://github.com/bendangelo/dogfood
+  bug_tracker_uri: https://github.com/bendangelo/dogfood/issues
+  changelog_uri: https://github.com/bendangelo/dogfood/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.15
+specification_version: 4
+summary: Generic multi-day scenario simulation engine
+test_files: []