a_la_chart 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,8 @@
+=== 0.1.0 2010-1-13
+
+* 1 major enhancement:
+  * global themes can now be created and configured
+
 === 0.0.11 2010-1-11
 
 * 1 major enhancement:

data/README.rdoc

@@ -113,7 +113,7 @@ The corresponding index.html.haml (or index.html.erb, or whatever) will look som
 
 Except for chart_tag, it's pretty normal. In the first chart we pass in the minimum required fields for chart_tag: the chart implementation (:google, :fusion, :raphael are the first to be supported, more to come), and the chart type (dependent on the implementation, see a_la_chart/configs/*/config.yml for the lists). The second pie chart is populated with the :gender pie data. ":case" is how we can support several styles of data for a single type of chart.
 
-== Multiple Chart Support
+=== Multiple Chart Support
 
 What if we want to display the city data as a :bar chart? There are two options. The first option, we can move the city data to a separate chart block. You can have as many chart blocks in a single controller as supported types. While we're at it, let's rename the query select names to be 'label' and 'value', to avoid the extra typing of remapping the data.
 
@@ -160,6 +160,67 @@ The above example shows the minimum configs required. However, certain configs a
 
 More to come...
 
+== CONFIGURATION
+
+=== Overriding Config
+
+Internal configs can be overridden in rails environment configs (eg. environment.rb). For example, to use a custom :inline ERB template (paths are based on RAILS_ROOT):
+
+  ALaChart::Config[:fusion][:v3_1][:pie][:data] = 'app/views/a_la_charts/custom_inline.html.erb'
+
+Then just copy the original template from the gem config dir, and make the desired changes.
+
+NOTE: Creating custom templates can be complex and tie your project closely to a particular version of ALC. In short, caveat emptor, pal.
+
+=== Custom Templates
+
+Creating custom configs is done just like overriding configs - be sure you do not over write any existing chart configs.
+
+For example, suppose you want the Fusion Stacked Column chart to contain an HTML legend table to of your own design, but you do not want to overwrite the existing Stacked Column chart. You can create a new chart like this (similar to the YAML stacked_column config):
+
+  ALaChart::Config[:fusion][:v3_1][:legend_stacked_column] = {
+    :chart_type => 'StackedColumn2D',
+    :inline => 'app/views/a_la_charts/legend_stacked_column.html.erb'
+  }
+
+Next, copy the inline template from the a la chart config directory, place it in the path denoted by your :inline configuration, and paste your custom legend table at the end (or whatever changes you want), for example:
+
+  <table class="legend">
+    <tr>
+      <th colspan="2">Category</th>
+      <th>Total</th>
+    </tr>
+    <% color_palette_clear(:fusion, :stacked_column) %>
+    <% @totals.each do |total| %>
+      <tr>
+        <td style="background-color:#<%= color_palette_next(:fusion, :stacked_column) %>">&nbsp;</td>
+        <td><%= total[:category] %></td>
+        <td><%= total[:quantity] %></td>
+      </tr>
+    <% end %>
+  </table>
+
+'color_palette_clear' and 'color_palette_next' are a built-in functions to reset and pop color values from the color_palette stack. They are two of several built in helpers. View them all in a_la_chart_helper.rb. But note, since they are still considered internal, they are subject to change from version to version. Again, caveat emptor.
+
+== THEMING
+
+By default a la chart comes with no themes, and allows each framework to declare its own defaults. However, you probably want your charts to have a certain global look. The problem being that different frameworks have different configurations. For now, ALC does not attempt to replace the theming with any sort of universal mechanism (if you want a red pie chart for Fusion and Google, you must create two themes). This may change in subsequent versions.
+
+For example, Fusion Charts have rich customizability, which must be configured with the chart data. Fusion can be given a custom color palette (the ordered list of colors to be 'popped' for each data segment), and a set of default chart options (values that will appear in the xml data 'chart' tag).
+
+  ALaChart::Config[:fusion][:theme] = :my_theme
+  ALaChart::Config[:fusion][:themes][:my_theme] = {
+    :color_palette => [ '7BB465', 'B2B4B6', 'FEC35A', '65A4B5', '9E65B5', 'B57765', 'F7DF65' ],
+    :default_options => {
+      :useRoundEdges => '0',
+      :alpha => '100',
+      :bgColor => 'ffffff'
+    }
+  }
+
+
+More to come...
+
 == LICENSE:
 
 Copyright (c) 2009 Mobi, released under the MIT license

data/lib/a_la_chart/a_la_chart.rb

@@ -100,8 +100,8 @@ module ALaChart
       
       self.before_filter(:provide_chart_data, :only => [:index, :show])
       
-      # Namespace this stuff??
-      [:data, :fields, :meta, :value, :set_chart].each do |method|
+      # TODO: Namespace this stuff??
+      [:before, :data, :fields, :meta, :value, :set_chart].each do |method|
         master_helper_module.module_eval <<-end_eval
           def #{method}(*args, &block)                    # def current_user(*args, &block)
             controller.send(%(#{method}), *args, &block)  #   controller.send(%(current_user), *args, &block)
@@ -140,6 +140,7 @@ module ALaChart
       
       if cases.blank?
         define_method("get_data") do
+          do_before_data if defined?(do_before_data)
           # note: instance_eval binds scope variables, call does not
           instance_eval(&block) || []
           # block.call(binding)
@@ -152,6 +153,11 @@ module ALaChart
       else
         cases.each { |caze|
           define_method("get_data_#{caze}") do
+            if respond_to?("do_before_data_#{caze}")
+              return [] unless send("do_before_data_#{caze}")
+            elsif defined?(do_before_data)
+              return [] unless do_before_data
+            end
             # note: instance_eval binds scope variables, call does not
             instance_eval(&block) || []
             # block.call(binding)
@@ -162,7 +168,25 @@ module ALaChart
         }
       end
     end
-  
+    
+    def before(*cases, &block)
+      if cases.blank?
+        define_method("do_before_data") do
+          # note: instance_eval binds scope variables, call does not
+          instance_eval(&block)
+          # block.call(binding)
+        end
+      else
+        cases.each { |caze|
+          define_method("do_before_data_#{caze}") do
+            # note: instance_eval binds scope variables, call does not
+            instance_eval(&block)
+            # block.call(binding)
+          end
+        }
+      end
+    end
+    
     def meta(*attrs)
       if attrs.size == 1
         attrs = attrs[0]

data/lib/a_la_chart.rb

@@ -1,5 +1,5 @@
 module ALaChart
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end
 
 require File.join(File.dirname(__FILE__), 'a_la_chart', 'config')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: a_la_chart
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Eric Redmond