ruby_reportable 0.1.3.1 → 0.2.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby_reportable (0.1.2)
+    ruby_reportable (0.1.3)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -42,6 +42,11 @@ Install as a gem or use as part of your Gemfile
 
     $ [sudo] gem install ruby_reportable
 
+## Configuration
 
+### Version 0.2.X
 
+There is a change in what is returned when a report is validated (object.report.valid?). In 0.1.X true/false is returned but in 0.2.X a hash is returned containing whether the report is valid (status) and an array of errors if any (errors).
+
+	{:status => true/false, :errors => array }
 

data/examples/object_space_report.rb

@@ -1,8 +1,19 @@
 class ObjectSpaceReport
   include RubyReportable
 
-  name 'Object Space By Class'
+  #
+  # Name the report
+  #
+  report 'Object Space By Class'
 
+  #
+  # Give the report a category for organization
+  #
+  category 'Object Reports'
+
+  #
+  # Define the data source
+  #
   source do
     as :object
 
@@ -11,6 +22,38 @@ class ObjectSpaceReport
     end
   end
 
+  #
+  # Perform a final manipulation to the returned records like making sure all are unique
+  #
+  finalize
+    source.all.uniq
+  end
+
+  #
+  # Define output fields
+  #
   output('Class') { object.first.to_s }
   output('Total') { object.last.size }
+
+  #
+  # Define a filter to help select which records to find
+  #
+  filter('Just These Objects') do
+    priority 0
+    key :just_these_objects
+    require # Require an input for this filter
+
+    input(:value) {}
+
+    valid? do
+      # Check to see if an input is present
+      validity = !input.blank?
+      !! validity
+    end
+
+    logic do
+      # Perform some logic using the input
+      source.where(["object = #{input}"])
+    end
+  end
 end

data/lib/ruby_reportable/report.rb

@@ -170,6 +170,7 @@ module RubyReportable
 
     def valid?(options = {})
       options = {:input => {}}.merge(options)
+      errors = []
 
       # initial sandbox
       sandbox = _source(options)
@@ -178,6 +179,7 @@ module RubyReportable
       sandbox[:inputs] = options[:input]
 
       validity = @filters.map do |filter_name, filter|
+
         # find input for given filter
         sandbox[:input] = options[:input][filter[:key]] if options[:input].is_a?(Hash)
 
@@ -185,17 +187,42 @@ module RubyReportable
 
         if filter_validity == false
           # Ignore an empty filter unless it's required
-          if !sandbox[:input].blank?
+          if !sandbox[:input].to_s.blank?
+            errors << "#{filter_name} is invalid."
+            false
+          else
+            if sandbox[:input].to_s.blank? && !filter[:require].blank?
+              errors << "#{filter_name} is required."
+              false
+            else
+              true
+            end
+          end
+        elsif filter_validity == true
+          if sandbox[:input].to_s.blank? && !filter[:require].blank?
+            errors << "#{filter_name} is required."
             false
           else
             true
           end
-        else
-          true
+        elsif !filter_validity.nil? && !filter_validity[:status].nil? && filter_validity[:status] == false
+          # Ignore an empty filter unless it's required
+          if !sandbox[:input].to_s.blank?
+            errors << filter_validity[:errors]
+            false
+          else
+            if sandbox[:input].to_s.blank? && !filter[:require].blank?
+              errors << "#{filter_name} is required."
+              false
+            else
+              true
+            end
+          end
         end
       end
 
-      !validity.include?(false)
+      return {:status => !validity.include?(false), :errors => errors}
+
     end # end def valid?
   end
 end

data/lib/ruby_reportable/version.rb

@@ -1,3 +1,3 @@
 module RubyReportable
-  VERSION = "0.1.3.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_reportable
 version: !ruby/object:Gem::Version
-  version: 0.1.3.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-02 00:00:00.000000000 Z
+date: 2013-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ruby_reportable
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby Reporting