diagnostics 0.0.2 → 0.0.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    diagnostics (0.0.1)
+    diagnostics (0.0.2)
 
 GEM
   remote: http://rubygems.org/

data/features/diagnostic_checks.feature

@@ -12,12 +12,16 @@ Feature: Diagnostic checks
       $:.unshift(File.dirname(__FILE__) + '/../../lib')
       require 'diagnostics'
 
-      check = diagnostic_check :system do |c|
-        c.passed  { true }
-        c.warning { false }
-        c.failed  { false }
+      class StatusMethods
+        include DiagnosticsCheck
+
+        def passed; true end
+        def warning; false end
+        def failed; false end
       end
 
+      check = diagnostic_check(:StatusMethods)
+
       puts check.passed?
       puts check.warning?
       puts check.failed?
@@ -39,13 +43,19 @@ Feature: Diagnostic checks
       $:.unshift(File.dirname(__FILE__) + '/../../lib')
       require 'diagnostics'
 
-      check = diagnostic_check :system do |c|
-        c.data do |d|
-          d['Master'] = 'Up'
-          d['Slave']  = 'Down'
+      class AttributesOnCheck
+        include DiagnosticsCheck
+
+        def data
+          lambda do |d|
+            d['Master'] = 'Up'
+            d['Slave']  = 'Down'
+          end
         end
       end
 
+      check = diagnostic_check(:AttributesOnCheck)
+
       puts check.data.attributes(:plain)
       puts
       puts check.data.attributes(:html)
@@ -74,13 +84,19 @@ Feature: Diagnostic checks
       $:.unshift(File.dirname(__FILE__) + '/../../lib')
       require 'diagnostics'
 
-      check = diagnostic_check :system do |c|
-        c.data do |d|
-          d << ['a', 'b', 'c']
-          d << [1, 2, 3]
+      class ListsOnCheck
+        include DiagnosticsCheck
+
+        def data
+          lambda do |d|
+            d << ['a', 'b', 'c']
+            d << [1, 2, 3]
+          end
         end
       end
 
+      check = diagnostic_check(:ListsOnCheck)
+
       puts check.data.lists(:plain)
       puts
       puts check.data.lists(:html)
@@ -106,13 +122,19 @@ Feature: Diagnostic checks
       $:.unshift(File.dirname(__FILE__) + '/../../lib')
       require 'diagnostics'
 
-      check = diagnostic_check :system do |c|
-        c.data do |d|
-          d << 'a'
-          d << 'b'
+      class TextsOnCheck
+        include DiagnosticsCheck
+
+        def data
+          lambda do |d|
+            d << 'a'
+            d << 'b'
+          end
         end
       end
 
+      check = diagnostic_check(:TextsOnCheck)
+
       puts check.data.texts(:plain)
       puts
       puts check.data.texts(:html)
@@ -134,13 +156,19 @@ Feature: Diagnostic checks
       $:.unshift(File.dirname(__FILE__) + '/../../lib')
       require 'diagnostics'
 
-      check = diagnostic_check :system do |c|
-        c.data do |d|
-          d << { 'heading1' => [1,2,3],
-                 'heading2' => [4,5,6] }
+      class TablesOnCheck
+        include DiagnosticsCheck
+
+        def data
+          lambda do |d|
+            d << { 'heading1' => [1,2,3],
+                   'heading2' => [4,5,6] }
+          end
         end
       end
 
+      check = diagnostic_check(:TablesOnCheck)
+
       print check.data.tables(:html)
       """
     When I run "ruby tables.rb"

data/lib/diagnostics/check.rb

@@ -1,44 +1,33 @@
 module Diagnostics
-  class Check
+  class Check < Struct.new(:cls)
 
-    def self.add(name, &block)
-      Diagnostics.checks << check = new(name, &block)
+    def self.add(cls)
+      Diagnostics.checks << check = new(cls)
       check
     end
 
     def self.find(name)
-      Diagnostics.checks.select {|c| c.name == name }[0]
+      Diagnostics.checks.select {|c| c.name == name.to_s }[0]
     end
 
-    attr_reader :name
-
-    def initialize(name, &block)
-      @name = name
-      instance_eval(&block) if block
-    end
-
-    def passed(&block)
-      @passed_block = block
-    end
-
-    def warning(&block)
-      @warning_block = block
+    def name
+      cls.name
     end
 
-    def failed(&block)
-      @failed_block = block
+    def instance
+      @instance ||= cls.new
     end
 
     def passed?
-      @passed_block_result ||= call_block(@passed_block)
+      @passed_method_result ||= call_method(:passed)
     end
 
     def warning?
-      @warning_block_result ||= call_block(@warning_block)
+      @warning_method_result ||= call_method(:warning)
     end
 
     def failed?
-      @failed_block_result ||= call_block(@failed_block)
+      @failed_method_result ||= call_method(:failed)
     end
 
     def status
@@ -49,7 +38,11 @@ module Diagnostics
     end
 
     def data
-      block_given? ? yield(data_group) : data_group
+      @data_method_result ||= if instance.respond_to?(:data)
+        instance.data.call(data_group) && data_group
+      else
+        data_group
+      end
     end
 
   private
@@ -58,8 +51,8 @@ module Diagnostics
       @data_group ||= DataGroup.new
     end
 
-    def call_block(block)
-      block ? block.call : false
+    def call_method(meth)
+      instance.respond_to?(meth) && instance.send(meth)
     end
 
   end

data/lib/diagnostics/methods.rb

@@ -12,8 +12,8 @@ module Diagnostics
       Diagnostics.checks
     end
 
-    def diagnostic_check(name, &block)
-      block ? Check.add(name, &block) : Check.find(name)
+    def diagnostic_check(name)
+      Check.find(name)
     end
 
     def diagnostic_message

data/lib/diagnostics/version.rb

@@ -1,3 +1,3 @@
 module Diagnostics
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/diagnostics.rb

@@ -15,4 +15,12 @@ module Diagnostics
   @@checks = []
   def self.checks; @@checks end
 
+end
+
+module DiagnosticsCheck
+
+  def self.included(cls)
+    Diagnostics::Check.add(cls)
+  end
+
 end

data/spec/diagnostics/check_spec.rb

@@ -3,27 +3,43 @@ require 'spec_helper'
 module Diagnostics
   describe Check do
 
+    before { class MyClass; end }
+
     describe '.add' do
       it 'adds a check' do
-        described_class.add :foo
+        described_class.add MyClass
         Diagnostics.should have(1).checks
       end
     end
 
     describe '.find' do
-      let!(:check) { described_class.add :foo }
+      let!(:check) { described_class.add MyClass }
 
       it 'finds the check by name' do
-        described_class.find(:foo).should eq(check)
+        described_class.find('Diagnostics::MyClass').should eq(check)
+      end
+    end
+
+    describe '#name' do
+      it 'returns the diagnostic class name' do
+        described_class.new(MyClass).name.should eq('Diagnostics::MyClass')
+      end
+    end
+
+    describe '#instance' do
+      it 'returns an instance of the diagnostic class' do
+        described_class.new(MyClass).instance.should be_an_instance_of(MyClass)
       end
     end
 
     describe 'status predicate methods' do
-      let(:check) do
-        described_class.new(:foo) do |c|
-          c.passed { true }
-          c.warning { false }
-          c.failed { false }
+      let(:check) { described_class.new(MyClass) }
+
+      before do
+        check.cls.class_eval do
+          def passed; true end
+          def warning; false end
+          def failed; false end
         end
       end
 
@@ -45,32 +61,23 @@ module Diagnostics
         context "with #{status}" do
           let(:check) { create_check(status) }
           specify { check.status.should eq(status) }
+          after { check.cls.send(:remove_method, status) }
         end
       end
 
-      def create_check(status = nil)
-        described_class.new(:foo) do |c|
-          c.passed  { status == :passed }
-          c.warning { status == :warning }
-          c.failed  { status == :failed }
+      def create_check(status)
+        described_class.new(MyClass).tap do |check|
+          check.cls.class_eval do
+            define_method(status) { true }
+          end
         end
       end
     end
 
     describe '#data' do
-      context 'given a block' do
-        it 'yields a DataGroup instance' do
-          described_class.new(:foo).data do |d|
-            d.should be_an_instance_of(Diagnostics::DataGroup)
-          end
-        end
-      end
-
-      context 'given no block' do
-        it 'returns a DataGroup instance' do
-          data = described_class.new(:foo).data
-          data.should be_an_instance_of(Diagnostics::DataGroup)
-        end
+      it 'returns a DataGroup instance' do
+        data = described_class.new(MyClass).data
+        data.should be_an_instance_of(Diagnostics::DataGroup)
       end
     end
 

data/spec/diagnostics/methods_spec.rb

@@ -8,19 +8,9 @@ end
 
 describe '#diagnostic_check' do
 
-  context 'with block given' do
-    it 'adds a check' do
-      diagnostic_check(:foo) { }
-      diagnostic_checks.should have(1).check
-      diagnostic_checks.first.name.should eq(:foo)
-    end
-  end
-
-  context 'without block given' do
-    it 'finds the check' do
-      check = diagnostic_check(:foo) { }
-      diagnostic_check(:foo).should eq(check)
-    end
+  it 'finds the check' do
+    class MyClass; include(DiagnosticsCheck) end
+    diagnostic_check(:MyClass).cls.should eq(MyClass)
   end
 
 end
@@ -73,11 +63,13 @@ describe '#diagnostic_status' do
 
   context 'with all checks passing' do
     before do
-      diagnostic_check(:foo) do |c|
-        c.passed { true }
+      class MyPassingClass
+        include DiagnosticsCheck
+        def passed; true end
       end
-      diagnostic_check(:bar) do |c|
-        c.passed { true }
+      class MySecondPassingClass
+        include DiagnosticsCheck
+        def passed; true end
       end
     end
 
@@ -88,14 +80,17 @@ describe '#diagnostic_status' do
 
   context 'with a check that failed' do
     before do
-      diagnostic_check(:foo) do |c|
-        c.passed { true }
+      class MyPassingClass
+        include DiagnosticsCheck
+        def passed; true end
       end
-      diagnostic_check(:zoo) do |c|
-        c.warning { true }
+      class MyWarningClass
+        include DiagnosticsCheck
+        def warning; true end
       end
-      diagnostic_check(:bar) do |c|
-        c.failed { true }
+      class MyFailedClass
+        include DiagnosticsCheck
+        def failed; true end
       end
     end
 
@@ -106,11 +101,13 @@ describe '#diagnostic_status' do
 
   context 'with a warning check' do
     before do
-      diagnostic_check(:foo) do |c|
-        c.passed { true }
+      class MyPassingClass
+        include DiagnosticsCheck
+        def passed; true end
       end
-      diagnostic_check(:bar) do |c|
-        c.warning { true }
+      class MyWarningClass
+        include DiagnosticsCheck
+        def warning; true end
       end
     end
 

data/spec/diagnostics_spec.rb

@@ -8,4 +8,17 @@ describe Diagnostics do
     end
   end
 
+end
+
+describe DiagnosticsCheck do
+
+  describe '.included' do
+    before { diagnostic_checks.should be_empty }
+
+    it 'adds the class to checks' do
+      class MyCheck; include DiagnosticsCheck end
+      diagnostic_checks.should have(1).check
+    end
+  end
+
 end

data/spec_rails/rails2/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    diagnostics (0.0.1)
+    diagnostics (0.0.2)
 
 GEM
   remote: http://rubygems.org/

data/spec_rails/rails2/features/diagnostics_page.feature

@@ -8,26 +8,26 @@ Feature: Diagnostics page
     Then I should be on the diagnostics page
 
   Scenario: A passing diagnostic check with data attributes
-    Given a diagnostic check named "mysql" with the following statuses:
+    Given a diagnostic check named "MySQLCheck" with the following statuses:
       | passed | warning | failed |
       | true   | false   | false  |
-    And diagnostic check "mysql" has the following data attributes:
+    And diagnostic check "MySQLCheck" has the following data attributes:
       | a | b | c |
       | 1 | 2 | 3 |
     When I go to the diagnostics page
-    Then I should see a passed diagnostic check named "mysql"
+    Then I should see a passed diagnostic check named "MySQLCheck"
     And should see "a: 1" within diagnostic data
     And should see "b: 2" within diagnostic data
     And should see "c: 3" within diagnostic data
     And should see "All Systems Operational" as the title
 
   Scenario: A failed diagnostic check with a data list
-    Given a diagnostic check named "mysql" with the following statuses:
+    Given a diagnostic check named "MySQLCheck" with the following statuses:
       | passed | warning | failed |
       | false  | false   | true   |
-    And diagnostic check "mysql" has a data list: "a,b,c"
+    And diagnostic check "MySQLCheck" has a data list: "a,b,c"
     When I go to the diagnostics page
-    Then I should see a failed diagnostic check named "mysql"
+    Then I should see a failed diagnostic check named "MySQLCheck"
     And should see "a" within diagnostic data
     And should see "b" within diagnostic data
     And should see "c" within diagnostic data

data/spec_rails/rails2/features/status_page.feature

@@ -11,33 +11,33 @@ Feature: Status page
     Then I should be on the status page
 
   Scenario: A simple passing diagnostic check
-    Given a diagnostic check named "mysql" with the following statuses:
+    Given a diagnostic check named "MySQLCheck" with the following statuses:
       | passed | warning | failed |
       | true   | false   | false  |
     When I go to the status page
-    Then I should see a passed diagnostic check named "mysql"
+    Then I should see a passed diagnostic check named "MySQLCheck"
     And should see "All Systems Operational" as the title
 
   Scenario: Diagnostic checks that contain one warning check
-    Given a diagnostic check named "mysql" with the following statuses:
+    Given a diagnostic check named "MySQLCheck" with the following statuses:
       | passed | warning | failed |
       | true   | false   | false  |
-    Given a diagnostic check named "postgresql" with the following statuses:
+    Given a diagnostic check named "PostgreSQLCheck" with the following statuses:
       | passed | warning | failed |
       | false  | true    | false  |
     When I go to the status page
-    Then I should see a passed diagnostic check named "mysql"
-    And should see a warning diagnostic check named "postgresql"
+    Then I should see a passed diagnostic check named "MySQLCheck"
+    And should see a warning diagnostic check named "PostgreSQLCheck"
     And should see "Experiencing Issues" as the title
 
   Scenario: Diagnostic checks that contain one failing check
-    Given a diagnostic check named "mysql" with the following statuses:
+    Given a diagnostic check named "MySQLCheck" with the following statuses:
       | passed | warning | failed |
       | true   | false   | false  |
-    Given a diagnostic check named "postgresql" with the following statuses:
+    Given a diagnostic check named "PostgreSQLCheck" with the following statuses:
       | passed | warning | failed |
       | false  | false   | true   |
     When I go to the status page
-    Then I should see a passed diagnostic check named "mysql"
-    And should see a failed diagnostic check named "postgresql"
+    Then I should see a passed diagnostic check named "MySQLCheck"
+    And should see a failed diagnostic check named "PostgreSQLCheck"
     And should see "System Failure" as the title

data/spec_rails/rails2/features/step_definitions/diagnostic_steps.rb

@@ -1,11 +1,15 @@
 Given /^a diagnostic check named "([^"]*)" with the following statuses:$/ do |name, table|
   statuses = table.hashes[0]
 
-  diagnostic_check name do |c|
-    c.passed  { eval(statuses[:passed]) }
-    c.warning { eval(statuses[:warning]) }
-    c.failed  { eval(statuses[:failed]) }
+  body = Class.new do
+    include DiagnosticsCheck
+    define_method(:passed)  { eval(statuses[:passed]) }
+    define_method(:warning) { eval(statuses[:warning]) }
+    define_method(:failed)  { eval(statuses[:failed]) }
   end
+
+  Object.send(:remove_const, name) if Object.const_defined?(name)
+  Object.const_set(name, body)
 end
 
 Given /^diagnostic check "([^"]*)" has the following data attributes:$/ do |name, table|

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: diagnostics
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Justin Ko
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-13 00:00:00 -07:00
+date: 2011-01-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -216,7 +216,7 @@ rubyforge_project: diagnostics
 rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: diagnostics-0.0.2
+summary: diagnostics-0.0.3
 test_files: 
 - features/diagnostic_checks.feature
 - features/step_definitions/aruba.rb