metrics-graphics-rails 2.6.0 → 2.6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 414e349e7a3ee325ee22b0a9fef9ae49117caa81
-  data.tar.gz: 525efe1e105d0c1eedaea8420e4bef11e945a3fe
+  metadata.gz: a83deabed39bb80b745da7fb1f8300d01f557e08
+  data.tar.gz: 945b01a3e9af84501713a184aa7f04b4a2d8e061
 SHA512:
-  metadata.gz: 9112160a45f0c0a3f6fded6c50de609c8d910802a7b561bae0c90075700a92abb39c402db364a8196c90fdaa03f8ae3c075740f2919c68f170893cb4edb9bea8
-  data.tar.gz: 3919603f2e851a988a6bfbf014cb5f3cf51598a40ccb28a9d59b3bf372b5ea4c046dddd5ee0da56c51845d830f919dbf45dc778aaa4ea3cd09930d041fb90a29
+  metadata.gz: 5e49f65f6b0707d3ad6b387f947b2e0d7c0095b5c87e6b7d03facd84b94ee1e139cf276c13de96f06d6e257b5e4b2eaee43cf7d624114cb2d9e625b72f988a04
+  data.tar.gz: 00d5b5bade199a922bc8cb7d47c11b3962bbd1eefafdaf86b05a895731a072738bcb7f9560033a4d811536e10fbc2acc4661f8c07a15fe0458f0d139ff6eb2d2

data/README.md

@@ -3,7 +3,7 @@ metrics-graphics-rails
 
 [metrics-graphics](https://github.com/mozilla/metrics-graphics) is a library optimized for concise, principled data graphics and layouts. See more in [metricsgraphicsjs.org](http://metricsgraphicsjs.org)
 
-The **metrics-graphics-rails** provides metrics-graphics for Rails and the assets pipeline.
+The **metrics-graphics-rails** provides metrics-graphics v2.6.0 for Rails and the assets pipeline.
 
 ## Usage
 
@@ -45,7 +45,7 @@ From the [metrics-graphics example](http://metricsgraphicsjs.org/):
 
 This graph can be rendered in a Rails view template with this helper:
 
-    = metrics_graphic_for data, title: "Downloads", description: "This graphic shows a time-series of downloads.", width: 600, height: 250, target: '#downloads', x_accessor: 'date', y_accessor: 'value', time_format: '%Y-%m-%d'
+    = metrics_graphic_for data, target: '#downloads', title: "Downloads", description: "This graphic shows a time-series of downloads.", width: 600, height: 250, x_accessor: 'date', y_accessor: 'value', time_format: '%Y-%m-%d'
 
 where ``data`` is an Array of Hashes of points with a ``date`` and a ``value`` keys and values. Ex: ``[{date: '2014-11-01', value: 12}, {date: '2014-11-02', value: 18}]``
 
@@ -55,6 +55,20 @@ where ``data`` is an Array of Hashes of points with a ``date`` and a ``value`` k
 
 `metrics_graphic_for` helper supports multiple-lined graphs generation. Just pass data as an Array of Arrays in the same format as for single-lined graphs and it should work as a charm.
 
+### Markers
+
+`metrics_graphic_for` helper supports markers. Just pass marker data as an Array with the `markers` option like this:
+
+    = metrics_graphic_for data, target: '#downloads', markers: markers
+
+where ``markers`` is an Array of Hashes of markers with ``date`` and a ``label`` keys and values. Ex: ``[{date: '2014-11-01', label: 'look here!'}, {date: '2014-11-02', label: 'look there!'}]``
+
+### Other options
+
+Do you want to use any *metrics-graphics* option not included in `metrics_graphic_for` view helper? Just pass them as a Hash in the `:extra_options` attribute like this:
+
+    = metrics_graphic_for data, target: '#downloads', extra_options: { min_y: 100, max_y: 200 }
+
 ## Versioning
 
 metrics-graphics-rails 2.6.0 == metrics-graphics 2.6.0

data/lib/metrics-graphics-rails/version.rb

@@ -1,3 +1,3 @@
 module MetricsGraphicsRails
-  VERSION = '2.6.0'
+  VERSION = '2.6.0.1'
 end

data/lib/metrics-graphics-rails/view_helpers.rb

@@ -2,25 +2,28 @@ require 'json'
 
 module MetricsGraphicsRails
   module ViewHelpers
-    # TODO: generalize for extra options
     def metrics_graphic_for(data, options = {})
-      json_data   = data.to_json
-      target      = options.fetch(:target)
-      x_accessor  = options.fetch(:x_accessor)  { :date }
-      y_accessor  = options.fetch(:y_accessor)  { :value }
-      title       = options.fetch(:title)
-      description = options.fetch(:description) { '' }
-      width       = options.fetch(:width)       { 600 }
-      height      = options.fetch(:height)      { 250 }
-      time_format = options.fetch(:time_format) { '%Y-%m-%d' }
-      is_multiple = data.first.is_a?(Array)
-      extra_options = options[:extra_options] || {}
-      extra_options_to_options = extra_options.map{ |k,v| "#{k}: #{v}," }.join('')
+      @data              = data
+      json_data          = data.to_json
+      @target            = options.fetch(:target)
+      @x_accessor        = options.fetch(:x_accessor)  { :date }
+      @y_accessor        = options.fetch(:y_accessor)  { :value }
+      title              = options.fetch(:title)
+      description        = options.fetch(:description) { '' }
+      width              = options.fetch(:width)       { 600 }
+      height             = options.fetch(:height)      { 250 }
+      @time_format       = options.fetch(:time_format) { '%Y-%m-%d' }
+      # Markers is an array of hashes with 'date' and 'label' keys
+      @markers           = options.fetch(:markers)     { [] }
+      @is_multiple       = data.first.is_a?(Array)
+      @extra_options     = options[:extra_options] || {}
 
       javascript_tag <<-SCRIPT
         var data = #{json_data};
 
-        #{convert_data_js(data, x_accessor, time_format, is_multiple)}
+        #{convert_data_js}
+        
+        #{markers}
 
         MG.data_graphic({
           title: "#{title}",
@@ -28,25 +31,46 @@ module MetricsGraphicsRails
           data: data,
           width: #{width},
           height: #{height},
-          target: '#{target}',
+          target: '#{@target}',
           #{extra_options_to_options}
-          x_accessor: '#{x_accessor}',
-          y_accessor: '#{y_accessor}'
+          #{markers_option}
+          x_accessor: '#{@x_accessor}',
+          y_accessor: '#{@y_accessor}'
         });
       SCRIPT
     end
 
     private
 
-    def convert_data_js(data, x_accessor, time_format, is_multiple)
-      if is_multiple
+    def extra_options_to_options
+      @extra_options.map{ |k,v| "#{k}: #{v}," }.join("\n          ")
+    end
+
+    def convert_data_js
+      if @is_multiple
         <<-CONVERT
           for (var i = 0; i < data.length; i++) {
-            data[i] = MG.convert.date(data[i], '#{x_accessor}', '#{time_format}');
+            data[i] = MG.convert.date(data[i], '#{@x_accessor}', '#{@time_format}');
           }
         CONVERT
       else
-        "MG.convert.date(data, '#{x_accessor}', '#{time_format}');"
+        "MG.convert.date(data, '#{@x_accessor}', '#{@time_format}');"
+      end
+    end
+
+    def markers
+      if @markers.present?
+        markers_json = @markers.to_json
+
+        "var markers = #{markers_json};\n\n
+        MG.convert.date(markers, 'date', '%Y-%m-%dT%H:%M:%S.%LZ');"
+
+      end
+    end
+
+    def markers_option
+      if @markers.present?
+        "markers: markers,"
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metrics-graphics-rails
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.6.0.1
 platform: ruby
 authors:
 - David Gil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-23 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties