diecut 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b476ce0ef0d2ba317287aa92d5b92c641b586ed5
-  data.tar.gz: d3249cb202a081d0531a1015e829cd347f50ce06
+  metadata.gz: 107febe45026dd5f8483a22c823ff7df081d9376
+  data.tar.gz: 3ad4f743f9aaa20bbe24a5c72a31d4c1ef813048
 SHA512:
-  metadata.gz: e1ee0f0789205ffad28377709c60ec1aa54862c5db09bc07cbc15ebd65f7187235fc87bd3ac3ecf78c299cd4f4ebd3efcb84dc4aba31ee13c62c7e225bb44ffb
-  data.tar.gz: 045e339e9a7c88f8a22a8741b5bf24ddab0f3018d9b20c2efeb9855a622ab92917a49dde445367176e30ddf2be93069d66e83d2ef0a57f4ac898c0b405ec2603
+  metadata.gz: 4d6837550e1a368a23781bfdd8c0b66450ad3ed19f6d831102cc9b4541285dbdbe4cf45010fa7b767a3babdc29fb78ddff405dfd89d5c5cfa289a5dd6903549f
+  data.tar.gz: 450068202354f5fe74a57f309beeaeb08e11c2eceb4adeb74ca8083d2570679333567d449b616e750146cbf06041d1f363e22f8945b955dff4c5db940c0d4b4d

data/lib/diecut/cli.rb

@@ -3,37 +3,81 @@ require 'diecut'
 require 'diecut/mill'
 
 module Diecut
-  class KindCli < Thor
-    include Thor::Actions
+  module Cli
+    class KindGroup < Thor::Group
+      def self.subclass_for(kind, mediator = nil, example_ui = nil)
+        mediator ||= Diecut.mediator(kind)
+        example_ui ||= mediator.build_example_ui
 
-    desc "generate TARGET", "Generate code"
-    def generate(target_dir)
-      self.destination_root = target_dir
+        Class.new(self) do
+          def self.kind
+            @kind
+          end
 
-      mill = Mill.new(self.class.kind)
-      mill.activate_plugins {|name| options["with-#{name}"] }
+          mediator.plugins.each do |plugin|
+            class_option "with-#{plugin.name}", :default => plugin.default_active?
+          end
 
-      ui = mill.user_interface
-      options.delete_if{|_, value| value.nil?}
-      ui.from_hash(options)
+          setup_subclass(mediator, example_ui)
+        end.tap do |klass|
+          klass.instance_variable_set("@kind", kind)
+        end
+      end
 
-      mill.churn(ui) do |path, contents|
-        create_file(path, contents)
+      def self.setup_subclass(mediator, example_ui)
       end
     end
 
-    method_option :all_on => false
-    desc "lint", "Check well-formed-ness of code generators"
-    def lint
-      require 'diecut/linter'
-      mill = Mill.new(self.class.kind)
-      if options["all_on"]
-        mill.activate_plugins{ true }
-      else
+    class Generate < KindGroup
+      include Thor::Actions
+
+      def self.setup_subclass(mediator, example_ui)
+        example_ui.field_names.each do |field|
+          class_option(field, {
+            :desc     => example_ui.description(field) || field,
+            :required => example_ui.required?(field),
+            :default  => example_ui.default_for(field)
+          })
+        end
+      end
+
+      def files
+        self.destination_root = target_dir
+
+        mill = Mill.new(self.class.kind)
         mill.activate_plugins {|name| options["with-#{name}"] }
+
+        ui = mill.user_interface
+        options.delete_if{|_, value| value.nil?}
+        ui.from_hash(options)
+
+        mill.churn(ui) do |path, contents|
+          create_file(path, contents)
+        end
       end
+    end
 
-      puts Linter.new(mill).report
+    class TargetedGenerate < Generate
+      argument :target_dir, :required => true, :type => :string, :banner => "The directory to use as the root of generated output"
+    end
+
+    class Lint < KindGroup
+      class_option :all_on, :default => false, :type => :boolean
+
+      def lint
+        require 'diecut/linter'
+        require 'diecut/error-report'
+        mill = Mill.new(self.class.kind)
+        Diecut.issue_handler = Diecut::ErrorHandling::Reporter.new(mill)
+
+        if options["all_on"]
+          mill.activate_plugins{ true }
+        else
+          mill.activate_plugins{|name| options["with-#{name}"] }
+        end
+
+        puts Linter.new(mill).report
+      end
     end
   end
 
@@ -42,29 +86,15 @@ module Diecut
       mediator = Diecut.mediator(plugin_kind)
       example_ui = mediator.build_example_ui
 
-      klass = Class.new(KindCli) do
-        class << self
-          def kind(value = nil)
-            if @kind.nil?
-              @kind = value
-            end
-            @kind
-          end
-        end
-
-        mediator.plugins.each do |plugin|
-          class_option "with-#{plugin.name}", :default => plugin.default_active?
-        end
+      Class.new(Thor) do
+        gen = Cli::TargetedGenerate.subclass_for(plugin_kind, mediator, example_ui)
+        method_options(gen.class_options)
+        register gen, "generate", "#{plugin_kind} generate TARGET", "Generate #{plugin_kind} output"
 
-        example_ui.field_names.each do |field|
-          method_option(field, {:for => :generate, :desc => example_ui.description(field) || field,
-            :required => example_ui.required?(field), :default => example_ui.default_for(field)})
-        end
+        lint = Cli::Lint.subclass_for(plugin_kind, mediator, example_ui)
+        method_options(lint.class_options)
+        register lint, "lint", "#{plugin_kind} lint", "Check well-formed-ness of #{plugin_kind} code generators"
       end
-
-      klass.kind(plugin_kind)
-
-      klass
     end
 
     def self.add_kind(kind)

data/lib/diecut/configurable.rb

@@ -1,4 +1,6 @@
 require 'calibrate'
+require 'diecut/errors'
+
 module Diecut
   class Configurable
     include Calibrate::Configurable
@@ -58,14 +60,14 @@ module Diecut
             if from_value.is_a?(Class) and from_value < Calibrate::Configurable
               into_value.absorb_context(from_value)
             else
-              raise "Field clash: #{name.inspect} is already a complex value, but a simple value in the absorbed configurable"
+              raise FieldClash, "#{name.inspect} is already a complex value, but a simple value in the absorbed configurable"
             end
           else
             unless from_value.is_a?(Class) and from_value < Calibrate::Configurable
               # Noop - maybe should compare the default values? - should always
               # be nil right now...
             else
-              raise "Field clash: #{name.inspect} is already a simple value, but a complex value on the absorbed configurable"
+              raise FieldClash, "#{name.inspect} is already a simple value, but a complex value on the absorbed configurable"
             end
           end
         end

data/lib/diecut/context-handler.rb

@@ -3,12 +3,17 @@ module Diecut
   class ContextHandler
     attr_accessor :context_class, :ui_class, :plugins
 
+    def issue_handler
+      @issue_handler ||= Diecut.issue_handler
+    end
+    attr_writer :issue_handler
+
     def apply_simple_defaults
       plugins.each do |plugin|
         plugin.context_defaults.each do |default|
           next unless default.simple?
           begin
-            apply_simple_default(default)
+            apply_simple_default(plugin, default)
           rescue Error
             raise Error, "Plugin #{plugin.name.inspect} failed"
           end
@@ -19,7 +24,7 @@ module Diecut
     def apply_to_ui
       plugins.each do |plugin|
         plugin.options.each do |option|
-          apply_option_to_ui(option)
+          apply_option_to_ui(plugin, option)
         end
       end
     end
@@ -43,21 +48,25 @@ module Diecut
       end
     end
 
-    def apply_simple_default(default)
+    def apply_simple_default(plugin, default)
       target = context_class.walk_path(default.context_path).last
       if target.metadata.nil?
-        raise UnusedDefault, "No template uses a value at #{default.context_path.inspect}"
+        issue_handler.unused_default(plugin.name, context_path)
       else
         target.metadata.default_value = default.value
         target.metadata.is(:defaulting)
       end
     end
 
-    def apply_option_to_ui(option)
+    def apply_option_to_ui(plugin, option)
       ui_class.options_hash[option.name] = option
 
       if option.has_context_path?
         context_metadata = context_class.walk_path(option.context_path).last.metadata
+        if context_metadata.nil?
+          issue_handler.missing_context_field(plugin.name, option.name, option.context_path)
+          return
+        end
         if option.has_default?
           ui_class.setting(option.name, option.default_value)
         elsif context_metadata.is?(:defaulting)

data/lib/diecut/error-report.rb

@@ -0,0 +1,58 @@
+require 'diecut/errors'
+require 'diecut/report'
+require 'diecut/report-builders/missing-context-field'
+require 'diecut/report-builders/unused-default'
+require 'diecut/report-builders/invalid-plugin'
+require 'diecut/report-builders/exception-report'
+
+module Diecut
+  module ErrorHandling
+    class Reporter < Base
+      def initialize(mill)
+        @mill = mill
+      end
+
+      def missing_context_field_report
+        @missing_context_field_report ||= ReportBuilders::MissingContextField.new(@mill)
+      end
+
+      def unused_default_report
+        @unused_default_report ||= ReportBuilders::UnusedDefault.new(@mill)
+      end
+
+      def invalid_plugin_report
+        @invalid_plugin_report ||= ReportBuilders::InvalidPlugin.new(@mill)
+      end
+
+      def exception_report
+        @exception_report ||= ReportBuilders::Exceptions.new(@mill)
+      end
+
+      def missing_context_field(plugin_name, option_name, context_path)
+        missing_context_field_report.add(option_name, context_path, plugin_name)
+      end
+
+      def unused_default(plugin_name, context_path)
+        unused_default_report.add(context_path, plugin_name)
+      end
+
+      def invalid_plugin(name, context_path, value)
+        invalid_plugin_report.add(name, context_path, value)
+      end
+
+      def handle_exception(ex)
+        raise unless ex.is_a? Diecut::Error
+        exception_report.add(ex.class.name, ex.message, (ex.backtrace || [""]).first)
+      end
+
+      def reports
+        [
+          missing_context_field_report.go,
+          unused_default_report.go,
+          invalid_plugin_report.go,
+          exception_report.go
+        ]
+      end
+    end
+  end
+end

data/lib/diecut/errors.rb

@@ -1,4 +1,71 @@
 module Diecut
+  module ErrorHandling
+    class Base
+      def missing_context_field_message(option_name, context_path)
+        "No template uses a value at #{context_path.inspect}, provided by #{option_name}"
+      end
+
+      def unused_default_message(context_path)
+        "No template uses a value at #{context_path.inspect}, provided as a default"
+      end
+
+      def invalid_plugin_message(name, context_path, value)
+        "Default on #{context_path.inspect} from plugin #{name} has both a simple default value (#{value}) and a dynamic block value, which isn't allowed."
+      end
+
+      def missing_context_field(plugin_name, option_name, context_path)
+        issue(missing_context_field_message(option_name, context_path))
+      end
+
+      def unused_default(plugin_name, context_path)
+        issue(usused_default_message(context_path))
+      end
+
+      def invalid_plugin(name, context_path, value)
+        issue invalid_plugin_message(name, context_path, value)
+      end
+
+      def handle_exception(ex)
+        if Error === ex
+          issue(ex.message)
+        else
+          raise
+        end
+      end
+    end
+
+    class Silent < Base
+      def issue(message)
+      end
+    end
+
+    class AllWarn < Base
+      def issue(message)
+        warn message
+      end
+    end
+
+    class FatalRaise < AllWarn
+      def invalid_plugin(name, context_path, value)
+        raise InvalidPlugin, invalid_plugin_message(name, context_path, value)
+      end
+    end
+
+    class AllRaise < FatalRaise
+      def handle_exception(ex)
+        raise
+      end
+
+      def missing_context_field(option_name, context_path)
+        raise MissingContext, missing_context_field_message(option_name, context_path)
+      end
+
+      def unused_default(context_path)
+        raise UnusedDefault, unused_default_message(context_path)
+      end
+    end
+  end
+
   class Error < RuntimeError;
     def message
       if cause.nil?
@@ -9,6 +76,8 @@ module Diecut
     end
   end
   class UnusedDefault < Error; end
+  class MissingContext < Error; end
   class OverriddenDefault < Error; end
-  class InvalidConfig < Error; end
+  class InvalidPlugin < Error; end
+  class FieldClash < Error; end
 end

data/lib/diecut/linter.rb

@@ -1,6 +1,12 @@
-require 'diecut/report'
+require 'diecut/report-builder'
+
+require 'diecut/report-builders/template-list'
+require 'diecut/report-builders/overridden-context-defaults'
+require 'diecut/report-builders/option-collision'
+require 'diecut/report-builders/orphaned-field'
 
 module Diecut
+
   class Linter
     def initialize(mill)
       @mill = mill
@@ -10,12 +16,13 @@ module Diecut
     def report
       @ui = mill.user_interface
 
-      formatter = ReportFormatter.new([
-        option_collision_report,
-        orphaned_fields,
-        overridden_context_defaults
-      ])
-
+      reports = ReportBuilder.all_kinds.map do |kind|
+        kind.new(mill).go
+      end
+      if Diecut.issue_handler.respond_to?(:reports)
+        reports += Diecut.issue_handler.reports
+      end
+      formatter = ReportFormatter.new( reports)
       formatter.to_s
     end
 
@@ -49,129 +56,5 @@ module Diecut
         end
       end
     end
-
-    def overridden_context_defaults
-      Report.new("Overridden context defaults", ["Output field", "Default value", "Source plugin"]).tap do |report|
-        default_values = Hash.new{|h,k| h[k]=[]}
-        each_default do |default, plugin|
-          next unless default.simple?
-
-          default_values[default.context_path] << [default, plugin]
-        end
-
-        default_values.each do |key, set|
-          default_values[key] = set.find_all do |plugin|
-            !set.any?{|child|
-              next if child == plugin
-              Diecut.plugin_loader.strict_sequence?(plugin[1], child[1])
-            }
-          end
-        end
-
-        default_values.each_value do |set|
-          if set.length > 1
-            set.each do |default, plugin|
-
-              report.add(default.context_path.join("."), default.value, plugin.name)
-            end
-          end
-        end
-
-        unless report.empty?
-          report.fail("Multiple plugins assign different values to be rendered")
-          report.advice = unindent(<<-EOA)
-          This is a problem because each plugin may be assuming it's default
-          value, and since there's no guarantee in which order the plugins are
-          loaded, the actual default value is difficult to predict. In general,
-          this kind of override behavior can be difficult to reason about.
-
-          Either the collision is accidental, in which case the default value
-          should be removed from one plugin or the other. If the override is
-          intentional, then the overriding plugin's gem should depend on the
-          overridden one's - since you are overriding the value intentionally,
-          it makes sense to ensure that the value is there to override. Diecut
-          will load plugins such that the dependant plugins are loaded later,
-          which solves the predictability problem.
-          EOA
-        end
-      end
-    end
-
-    def option_collision_report
-      Report.new("Option collisions", ["Output target", "Option name", "Source plugin"]).tap do |report|
-        option_targets = Hash.new{|h,k| h[k]=[]}
-        each_option do |option, plugin|
-          next unless option.has_context_path?
-          option_targets[option.context_path] << [plugin, option]
-        end
-        option_targets.each_value do |set|
-          if set.length > 1
-            set.each do |plugin, option|
-              report.add(option.context_path.join("."), option.name, plugin.name)
-            end
-          end
-        end
-
-        unless report.empty?
-          report.fail("Multiple options assign the same values to be rendered")
-          report.advice = unindent(<<-EOA)
-          This is problem because two options in the user interface both change
-          rendered values. If a user supplies both with different values, the
-          output isn't predictable (either one might take effect).
-
-          Most likely, this is a simple error: remove options from each group
-          that targets the same rendered value until only one remains. It may
-          also be that one option has a typo - that there's a rendering target
-          that's omitted.
-          EOA
-        end
-      end
-    end
-
-    def orphaned_fields
-      Report.new("Template fields all have settings", ["Output field", "Source file"]).tap do |report|
-        context_class = mill.context_class
-
-        required_fields = {}
-
-        context_class.field_names.each do |field_name|
-          if context_class.field_metadata(field_name).is?(:required)
-            required_fields[field_name.to_s] = []
-          end
-        end
-
-        mill.templates.all_templates.each do |template|
-          template.reduced.leaf_fields.each do |field|
-            field = field.join(".")
-            if required_fields.has_key?(field)
-              required_fields[field] << template.path
-            end
-          end
-        end
-
-        each_option do |option, plugin|
-          next unless option.has_context_path?
-          field = option.context_path.join(".")
-          required_fields.delete(field)
-        end
-
-        required_fields.each do |name, targets|
-          targets.each do |target|
-            report.add(name, target)
-          end
-        end
-
-        unless report.empty?
-          report.status = "WARN"
-          report.advice = unindent(<<-EOA)
-          These fields might not receive a value during generation, which will
-          raise an error at use time.
-
-          It's possible these fields are set in a resolve block in one of the
-          plugins - Diecut can't check for that yet.
-          EOA
-        end
-      end
-    end
   end
 end

data/lib/diecut/mediator.rb

@@ -40,10 +40,10 @@ module Diecut
     # < User gets involved >
     #
     def build_example_ui
-      ui_class = Class.new(UIConfig)
+      ui_class = UIConfig.build_subclass("Example UI")
 
       handler = ContextHandler.new
-      handler.context_class = Class.new(Configurable)
+      handler.context_class = Configurable.build_subclass("dummy context")
       handler.ui_class = ui_class
       handler.plugins = @plugins
 
@@ -54,7 +54,7 @@ module Diecut
     end
 
     def build_ui_class(context_class)
-      ui_class = Class.new(UIConfig)
+      ui_class = UIConfig.build_subclass("User Interface")
 
       handler = ContextHandler.new
       handler.context_class = context_class

data/lib/diecut/mill.rb

@@ -1,5 +1,6 @@
 require 'valise'
 require 'diecut'
+require 'diecut/errors'
 require 'diecut/template-set'
 
 module Diecut
@@ -8,7 +9,7 @@ module Diecut
       @kind = kind
     end
     attr_reader :kind
-    attr_writer :valise, :mediator, :templates
+    attr_writer :valise, :mediator, :templates, :issue_handler
 
     def mediator
       @mediator ||= Diecut.mediator(kind)
@@ -29,12 +30,17 @@ module Diecut
     end
 
     def valise
-      @valise ||= mediator.activated_plugins.map do |plugin|
-        stem = plugin.stem_for(kind)
-        Valise::Set.define do
-          ro stem.template_dir
-        end.stemmed(stem.stem)
-      end.reduce{|left, right| left + right}.sub_set(kind)
+      @valise ||=
+        begin
+          stems = mediator.activated_plugins.map do |plugin|
+            plugin.stem_for(kind)
+          end
+          Valise::Set.define do
+            stems.each do |stem|
+              ro stem.template_dir
+            end
+          end
+        end
     end
 
     def load_files

data/lib/diecut/plugin-description.rb

@@ -22,6 +22,11 @@ module Diecut
     attr_reader :default_activated, :name, :source_path, :context_defaults,
       :options, :resolve_block
 
+    def issue_handler
+      @issue_handler ||= Diecut.issue_handler
+    end
+    attr_writer :issue_handler
+
     def kinds
       @kind_stems.keys
     end
@@ -67,7 +72,7 @@ module Diecut
     #
     def for_kind(kind, templates = nil, stem = nil)
       stem ||= [kind]
-      templates ||= "templates"
+      templates ||= "diecut_templates"
       templates = File.expand_path(templates, File.dirname(caller_locations(1..1).first.absolute_path))
       @kind_stems[kind] = KindStem.new(kind, stem, templates)
     end
@@ -112,6 +117,7 @@ module Diecut
           [context_path]
         end
       if value != NO_VALUE and not block.nil?
+        issue_handler.invalid_plugin(name, context_path, value)
         raise InvalidPlugin, "Default on #{name.inspect} both has a simple default value (#{value}) and a dynamic block value, which isn't allowed."
       end
       @context_defaults << ContextDefault.new(context_path, value, block)

data/lib/diecut/report-builder.rb

@@ -0,0 +1,114 @@
+require 'diecut/report'
+
+module Diecut
+  class ReportBuilder
+    def self.all_kinds
+      @all_kinds ||= []
+    end
+
+    def self.register
+      ReportBuilder.all_kinds << self
+    end
+
+    def initialize(mill)
+      @mill = mill
+    end
+    attr_reader :mill
+
+    def unindent(text)
+      return if text.nil?
+      indent = text.scan(/(^[ \t]*)\S/).map{|cap| cap.first}.max_by(&:length)
+      text.gsub(%r{^#{indent}},'')
+    end
+
+    def each_plugin
+      mill.mediator.activated_plugins.each do |plugin|
+        yield plugin
+      end
+    end
+
+    def each_default
+      each_plugin do |plugin|
+        plugin.context_defaults.each do |default|
+          yield default, plugin
+        end
+      end
+    end
+
+    def each_option
+      each_plugin do |plugin|
+        plugin.options.each do |option|
+          yield option, plugin
+        end
+      end
+    end
+
+    def each_template
+      mill.templates.templates.each do |name, template|
+        yield name, template
+      end
+    end
+
+    def report
+      @report ||= build_report
+    end
+
+    def build_report
+      Report.new(report_name, report_fields)
+    end
+
+    def strict_sequence?(first, second)
+      return false if first == second
+      Diecut.plugin_loader.strict_sequence?(first, second)
+    end
+
+    def go
+      collect
+      review
+      report
+    end
+
+    def report_status
+      report.empty? ? 'OK' : 'FAIL'
+    end
+
+    def pass_summary
+      nil
+    end
+
+    def fail_summary
+      nil
+    end
+
+    def other_summary
+      nil
+    end
+
+    def pass_advice
+      nil
+    end
+
+    def fail_advice
+      nil
+    end
+
+    def other_advice
+      nil
+    end
+
+    def review
+      report.status = report_status.to_s.upcase
+      case report.status
+      when "OK", "PASS"
+        report.summary = pass_summary
+        report.advice = unindent(pass_advice)
+      when 'FAIL'
+        report.summary = fail_summary
+        report.advice = unindent(fail_advice)
+      else
+        report.summary = other_summary
+        report.advice = unindent(other_advice)
+      end
+    end
+  end
+end

data/lib/diecut/report-builders/exception-report.rb

@@ -0,0 +1,32 @@
+require 'diecut/report-builder'
+
+module Diecut
+  module ReportBuilders
+    class Exceptions < ReportBuilder
+      def report_name
+        "Exceptions raised during definition"
+      end
+
+      def report_fields
+        ["Exception class", "message", "source line"]
+      end
+
+      def collect
+      end
+
+      def add(*args)
+        report.add(*args)
+      end
+
+      def fail_summary
+        "Exceptions were raised during the kind definition process"
+      end
+
+      def other_advice
+        <<-EOA
+        Exceptions were raised while defining plugins for generation. Those need to be fixed.
+        EOA
+      end
+    end
+  end
+end

data/lib/diecut/report-builders/invalid-plugin.rb

@@ -0,0 +1,33 @@
+require 'diecut/report-builder'
+
+module Diecut
+  module ReportBuilders
+    class InvalidPlugin < ReportBuilder
+      def report_name
+        "General plugin health"
+      end
+
+      def report_fields
+        ["Plugin name", "Problem description"]
+      end
+
+      def collect
+      end
+
+      def add(*args)
+        report.add(*args)
+      end
+
+      def other_summary
+        "There were problems defining plugins"
+      end
+
+      def other_advice
+        <<-EOA
+        The plugins above had unrecoverable issues while being defined. They
+        should be fixed, or not included during generation.
+        EOA
+      end
+    end
+  end
+end

data/lib/diecut/report-builders/missing-context-field.rb

@@ -0,0 +1,48 @@
+require 'diecut/report-builder'
+
+module Diecut
+  module ReportBuilders
+    class MissingContextField < ReportBuilder
+      def report_name
+        "Unused options"
+      end
+
+      def report_fields
+        ["Output field name", "Option_name", "Plugin name"]
+      end
+
+      def report_status
+        report.empty? ? "OK" : "WARN"
+      end
+
+      def collect
+      end
+
+      def add(*args)
+        report.add(*args)
+      end
+
+      def other_summary
+        "Options provide values that aren't used by any template"
+      end
+
+      def other_advice
+        <<-EOA
+        Plugins defined options that go to fields that don't appear in templates.
+
+        It's possible that a plugin defined an option for its templates but they were
+        overridden, so the fields disappeared. Diecut doesn't yet check for
+        that case. In those cases, you can ignore this warning.
+
+        The other possiblity is that the default path has a typo. This is
+        especially likely if there's also a report about a missing output
+        field. The option might be used in a resolve somewhere, so even if it
+        doesn't directly set an output field, it might influence generation
+        that way.
+
+        Do be careful to check this option: the option
+        EOA
+      end
+    end
+  end
+end

data/lib/diecut/report-builders/option-collision.rb

@@ -0,0 +1,49 @@
+require 'diecut/report-builder'
+
+module Diecut
+  module ReportBuilders
+    class OptionCollisions < ReportBuilder
+      register
+
+      def report_name
+        "Option collisions"
+      end
+
+      def report_fields
+        ["Output target", "Option name", "Source plugin"]
+      end
+
+      def collect
+        option_targets = Hash.new{|h,k| h[k]=[]}
+        each_option do |option, plugin|
+          next unless option.has_context_path?
+          option_targets[option.context_path] << [plugin, option]
+        end
+        option_targets.each_value do |set|
+          if set.length > 1
+            set.each do |plugin, option|
+              report.add(option.context_path.join("."), option.name, plugin.name)
+            end
+          end
+        end
+      end
+
+      def fail_summary
+        "Multiple options assign the same values to be rendered"
+      end
+
+      def fail_advice
+        (<<-EOA)
+          This is problem because two options in the user interface both change
+          rendered values. If a user supplies both with different values, the
+          output isn't predictable (either one might take effect).
+
+          Most likely, this is a simple error: remove options from each group
+          that targets the same rendered value until only one remains. It may
+          also be that one option has a typo - that there's a rendering target
+          that's omitted.
+        EOA
+      end
+    end
+  end
+end

data/lib/diecut/report-builders/orphaned-field.rb

@@ -0,0 +1,63 @@
+module Diecut
+  module ReportBuilders
+    class OrphanedField < ReportBuilder
+      register
+
+      def report_name
+        "Template fields all have settings"
+      end
+
+      def report_fields
+        ["Output field", "Source file"]
+      end
+
+      def collect
+        context_class = mill.context_class
+
+        required_fields = {}
+
+        context_class.field_names.each do |field_name|
+          if context_class.field_metadata(field_name).is?(:required)
+            required_fields[field_name.to_s] = []
+          end
+        end
+
+        each_template do |name, template|
+          template.reduced.leaf_fields.each do |field|
+            field = field.join(".")
+            if required_fields.has_key?(field)
+              required_fields[field] << template.path
+            end
+          end
+        end
+
+        each_option do |option, plugin|
+          next unless option.has_context_path?
+          field = option.context_path.join(".")
+          required_fields.delete(field)
+        end
+
+        required_fields.each do |name, targets|
+          targets.each do |target|
+            report.add(name, target)
+          end
+        end
+      end
+
+      def report_status
+        report.empty? ? "OK" : "WARN"
+      end
+
+
+      def other_advice
+        <<-EOA
+        These fields might not receive a value during generation, which will
+        raise an error at use time.
+
+        It's possible these fields are set in a resolve block in one of the
+        plugins - Diecut can't check for that yet.
+        EOA
+      end
+    end
+  end
+end

data/lib/diecut/report-builders/overridden-context-defaults.rb

@@ -0,0 +1,62 @@
+require 'diecut/report-builder'
+
+module Diecut
+  module ReportBuilders
+    class OverriddenContextDefaults < ReportBuilder
+      register
+
+      def report_name
+        "Overridden context defaults"
+      end
+
+      def report_fields
+        ["Output field", "Default value", "Source plugin"]
+      end
+
+      def collect
+        default_values = Hash.new{|h,k| h[k]=[]}
+        each_default do |default, plugin|
+          next unless default.simple?
+
+          default_values[default.context_path] << [default, plugin]
+        end
+
+        default_values.each do |key, set|
+          default_values[key] = set.find_all do |plugin|
+            !set.any?{|child| strict_sequence?(plugin[1], child[1]) }
+          end
+        end
+
+        default_values.each_value do |set|
+          if set.length > 1
+            set.each do |default, plugin|
+
+              report.add(default.context_path.join("."), default.value, plugin.name)
+            end
+          end
+        end
+      end
+
+      def fail_summary
+        "Multiple plugins assign different values to be rendered by default"
+      end
+
+      def fail_advice
+        (<<-EOA)
+        This is a problem because each plugin may be assuming it's default
+        value, and since there's no guarantee in which order the plugins are
+        loaded, the actual default value is difficult to predict. In general,
+        this kind of override behavior can be difficult to reason about.
+
+        Either the collision is accidental, in which case the default value
+        should be removed from one plugin or the other. If the override is
+        intentional, then the overriding plugin's gem should depend on the
+        overridden one's - since you are overriding the value intentionally,
+        it makes sense to ensure that the value is there to override. Diecut
+        will load plugins such that the dependant plugins are loaded later,
+        which solves the predictability problem.
+        EOA
+      end
+    end
+  end
+end

data/lib/diecut/report-builders/template-list.rb

@@ -0,0 +1,38 @@
+require 'diecut/report-builder'
+
+module Diecut
+  class TemplateListBuilder < ReportBuilder
+    register
+
+    def report_name
+      "Templates included"
+    end
+
+    def report_fields
+      ["Template path"]
+    end
+
+    def collect
+      each_template do |name, template|
+        report.add(template.path)
+      end
+    end
+
+    def report_status
+      report.empty? ? 'FAIL' : 'OK'
+    end
+
+    def fail_summary
+      report.summary = "No templates will render"
+    end
+
+    def fail_advice
+      (<<-EOA)
+      No plugin provides any templates. This is probably simple misconfiguration a plugin, or an important plugin has been omitted.
+
+      Plugins: #{mill.mediator.activated_plugins.map(&:name)}
+      Plugin template paths: #{mill.valise.to_s}
+      EOA
+    end
+  end
+end

data/lib/diecut/report-builders/unused-default.rb

@@ -0,0 +1,44 @@
+require 'diecut/report-builder'
+
+module Diecut
+  module ReportBuilders
+    class UnusedDefault < ReportBuilder
+      def report_name
+        "Defaults are declared but unused"
+      end
+
+      def report_fields
+        ["Output field name", "Plugin name"]
+      end
+
+      def report_status
+        report.empty? ? "OK" : "WARN"
+      end
+
+      def collect
+      end
+
+      def add(*args)
+        report.add(*args)
+      end
+
+      def other_summary
+        "Defaults are defined for fields that don't exist in output templates"
+      end
+
+      def other_advice
+        <<-EOA
+        Plugins defined defaults for fields that don't appear in templates.
+
+        It's possible that a plugin defined a default but it's template was
+        overridden, so the fields disappeared. Diecut doesn't yet check for
+        that case. In those cases, you can ignore this warning.
+
+        The other possiblity is that the default path has a typo. This is
+        especially likely if there's also a report about a missing output
+        field.
+        EOA
+      end
+    end
+  end
+end

data/lib/diecut/report.rb

@@ -15,7 +15,7 @@ module Diecut
 
     def template
       (<<-EOT).gsub(/^      /, '')
-      {{#reports}}{{#status_color}}{{name}}: {{status}} {{#length}} {{length}}{{/length}}
+      {{#reports}}{{#status_color}}{{name}}   {{status}} {{#length}} {{length}}{{/length}}
       {{/status_color}}
       {{#summary}}{{summary}}
       {{/summary}}{{^empty  }}{{#headers}}{{it}}    {{/headers}}
@@ -24,6 +24,7 @@ module Diecut
       {{advice}}
       {{/advice}}
       {{/reports}}
+
       {{#status_color}}Total QA report items: {{total_items}}
       Total QA failing reports: {{total_fails}}
       {{/status_color}}
@@ -45,6 +46,14 @@ module Diecut
       reports.inject(0){|sum, report| sum + (report.passed ? 0 : 1)}
     end
 
+    def report_name_width
+      @report_name_width ||= reports.map(&:name).map(&:size).max
+    end
+
+    def sized_name(name)
+      array.take(widths.length).zip(widths).map{|item, width| { it: item.to_s.ljust(width)}}
+    end
+
     def context(renderer)
       bad_color = proc{|text,render| Paint[renderer.render(text), :red]}
       good_color =  proc{|text,render| Paint[renderer.render(text), :green]}
@@ -58,6 +67,7 @@ module Diecut
         status_color: passed? ? good_color : bad_color
       }
       context[:reports].each do |report|
+        report[:name] = report[:name].rjust(report_name_width)
         report[:status_color] =
           case report[:status]
           when /ok/i

data/lib/diecut.rb

@@ -1,6 +1,7 @@
 require 'diecut/mediator'
 require 'diecut/plugin-description'
 require 'diecut/plugin-loader'
+require 'diecut/errors'
 
 module Diecut
   class << self
@@ -24,6 +25,11 @@ module Diecut
       plugin_loader.plugins
     end
 
+    def issue_handler
+      @issue_handler ||= ErrorHandling::AllWarn.new
+    end
+    attr_writer :issue_handler
+
     # Used in a `diecut_plugin.rb` file (either in the `lib/` of a gem, or at
     # the local `~/.config/diecut/diecut_plugin.rb` to register a new plugin.
     #

data/spec/linter_spec.rb

@@ -83,7 +83,7 @@ describe Diecut::Mill do
     end
 
     it "should produce a report" do
-      expect(report).to match(/Option collisions: FAIL/)
+      expect(report).to match(/Option collisions\s*FAIL/)
       expect(report).to match(/Total QA failing reports:/)
       expect(report).to match(/there's/)
     end
@@ -96,7 +96,7 @@ describe Diecut::Mill do
     end
 
     it "should produce a report" do
-      expect(report).to match(/Template fields all have settings: WARN/)
+      expect(report).to match(/Template fields all have settings\s*WARN/)
       expect(report).to match(/Output field\s+Source file/)
       expect(report).to match(/thing\s+{{testing}}.txt/)
       expect(report).not_to match(/^\s*testing\b/)
@@ -112,7 +112,7 @@ describe Diecut::Mill do
     end
 
     it "should produce a report" do
-      expect(report).to match(/Overridden context defaults: OK/)
+      expect(report).to match(/Overridden context defaults\s*OK/)
     end
   end
 
@@ -123,7 +123,7 @@ describe Diecut::Mill do
     end
 
     it "should produce a report" do
-      expect(report).to match(/Overridden context defaults: FAIL/)
+      expect(report).to match(/Overridden context defaults\s*FAIL/)
       expect(report).to match(/Output field\s+Default value\s+Source plugin/)
       expect(report).to match(/thing\s+15\s+dummy/)
       expect(report).to match(/Total QA failing reports:/)

data/spec/spec_helper.rb

@@ -9,4 +9,8 @@ RSpec.configure do |config|
     mock.verify_partial_doubles = true
     mock.verify_doubled_constant_names = true
   end
+
+  config.before(:suite) do
+    Diecut.issue_handler = Diecut::ErrorHandling::Silent.new
+  end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: diecut
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Judson Lester
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-01 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
@@ -83,7 +83,8 @@ dependencies:
 description: ''
 email:
 - nyarly@gmail.com
-executables: []
+executables:
+- diecut
 extensions: []
 extra_rdoc_files: []
 files:
@@ -94,6 +95,7 @@ files:
 - lib/diecut/cli.rb
 - lib/diecut/configurable.rb
 - lib/diecut/context-handler.rb
+- lib/diecut/error-report.rb
 - lib/diecut/errors.rb
 - lib/diecut/linter.rb
 - lib/diecut/mediator.rb
@@ -103,6 +105,15 @@ files:
 - lib/diecut/plugin-description/context-default.rb
 - lib/diecut/plugin-description/option.rb
 - lib/diecut/plugin-loader.rb
+- lib/diecut/report-builder.rb
+- lib/diecut/report-builders/exception-report.rb
+- lib/diecut/report-builders/invalid-plugin.rb
+- lib/diecut/report-builders/missing-context-field.rb
+- lib/diecut/report-builders/option-collision.rb
+- lib/diecut/report-builders/orphaned-field.rb
+- lib/diecut/report-builders/overridden-context-defaults.rb
+- lib/diecut/report-builders/template-list.rb
+- lib/diecut/report-builders/unused-default.rb
 - lib/diecut/report.rb
 - lib/diecut/template-reducer.rb
 - lib/diecut/template-set.rb
@@ -129,7 +140,7 @@ rdoc_options:
 - "--main"
 - doc/README
 - "--title"
-- diecut-0.0.2 Documentation
+- diecut-0.0.3 Documentation
 require_paths:
 - lib/
 required_ruby_version: !ruby/object:Gem::Requirement