metrify 0.2.4 → 0.3.0

data/README.rdoc

@@ -17,7 +17,7 @@ To add the ability for a class to generate aggregated statistics over time, perf
 1. Create .yml file defining metrics, and optional metric grouping filters
 2. Include module functionality in class that will calculate metrics, and provide a method for each metric to be calulated.
 
-You can create multiple classes that use this module. By default, the YML file loaded for the class will be on /config/<classname>_metrify.yml. Otherwise, specify the filename as an argument when calling "acts_as_metrify" within the class (shown below). RAILS_ROOT will be prepended. 
+You can create multiple classes that use this module. By default, the YML file loaded for the class will be on /config/(classname)_metrify.yml. Otherwise, specify the filename as an argument when calling "acts_as_metrify" within the class (shown below). RAILS_ROOT will be prepended. 
 
 Example YML file:
 
@@ -36,6 +36,8 @@ Example YML file:
       element_dog_count:
           display_name: Dog Count
 
+  stat_order: [element_a_count, element_b_count, element_1_count,  element_dog_count, element_cat_count] 
+
   filters:
       type:
         numbers: 
@@ -97,7 +99,7 @@ This will grant the following functionality to the MetricsClass defined above:
   @metrics_class_instance.value_type('element_a_count')  # => currency - returns type of value (currently only currency). This is useful for knowing how to display
   @metrics_class_instance.show_variance('element_a_count')   # => true - whether or not this value's % +/- change over last time period should be displayed
   @metrics_class_instance.value_precision('element_a_count') # if specified in YML file, will round floats using provided precision
-  
+  @metrics_class_instance.sort_stat_names(['element_dog_count', 'element_cat_count', 'element_b_count']) # => ['element_b_count', 'element_dog_count', 'element_cat_count'] ordered as defined by stat_order in yml, alphabetical if not configured
 == Using with Highcharts for instant views
 
 Assuming your application is configured to use Highcharts, optional controller, view, and helper components are included to provide charts with filters. To use:

data/lib/metrify.rb

@@ -79,7 +79,6 @@ module Metrify
     end
     
     def sort_stat_names(stat_names)
-      puts "ERWKL:JHFDLKJHDFLKDSJ #{stat_names.to_yaml}"
       if preferred_stat_order
         final_list = []
         preferred_stat_order.each do |o_stat|

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: metrify
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 4
-  version: 0.2.4
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Stephen Abrams
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-12 00:00:00 -05:00
+date: 2010-11-15 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency