chartism 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 536c7f984b360c963808c663c10ea669984bed85
-  data.tar.gz: cd3c6c3d271c11f66404bbb073b5673f70d314b3
+  metadata.gz: a60a2d7e2d316b903c4772e40a7b37c790917483
+  data.tar.gz: 441edfba105c7a98fff5e1a923dc618782074abe
 SHA512:
-  metadata.gz: afe5a49db3b51643a4e2b4329dc843f1218792c5c08e81d24a0400f958f3bae40801d5e21368fc178103ff653f29a703696f30fccb6c4fc0fa3bfab2a1d32b62
-  data.tar.gz: 3ef2573abacd27712b0fd1e3479784963f1369e57f6a4d8c808b4828af9d25f93960c66e5281a933f9a55efdec3e0afe55e11a62d669d5e0eee7002735af53be
+  metadata.gz: 3fa06be843119b912fc97f95f80870378349bb45b0d5dc583194989fbe75e28816dc90d8e483658baa3317fbdea6d05f30193fbd7919dbee5e90f9b6a487db5e
+  data.tar.gz: 5e2bec67d895d6a102a4f63e7b13a011bc219581064b79913ef62edaa5fcdfaa98d5748285eaa1de98abacfa76d993305d11a4d128933b32afd90f8790647bbd

data/README.md

@@ -1,8 +1,11 @@
 # Chartism
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chartism`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Dependency Status](https://gemnasium.com/Darksecond/chartism.svg)](https://gemnasium.com/Darksecond/chartism)
+[![Gem Version](https://badge.fury.io/rb/chartism.svg)](http://badge.fury.io/rb/chartism)
+[![Code Climate](https://codeclimate.com/github/Darksecond/chartism/badges/gpa.svg)](https://codeclimate.com/github/Darksecond/chartism)
 
-TODO: Delete this and the text above, and describe your gem
+This library is designed for making charts with ease. It provides a clean DSL to describe charts.
+It is base on the great chartist.js library.
 
 ## Installation
 
@@ -34,7 +37,46 @@ And add to your `application.css`
 
 ## Usage
 
-TODO: Write usage instructions here
+An example Linechart Model
+
+```ruby
+class ExampleLineChart
+  include Chartism::Line
+
+  def initialize
+    @area = true
+  end
+
+  options do
+    points false
+    smooth false
+
+    area do
+      @area
+    end
+  end
+
+  labels do
+    %w(Mon Tue Wed Thu Fri)
+  end
+
+  series do
+    [5, 2, 4, 2, 0]
+  end
+
+  series do
+    [6, 3, 1, 2, 4]
+  end
+end
+```
+
+Then use the following in a view:
+
+```erb
+<%= chart ExampleLineChart.new, class: ['ct-perfect-fourth'] %>
+```
+
+`ExampleLineChart.new` should preferbly be in a controller or other model.
 
 ## Development
 
@@ -44,7 +86,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/chartism/fork )
+1. Fork it ( https://github.com/darksecond/chartism/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/chartism.rb

@@ -1,6 +1,11 @@
 require "chartism/version"
 require "chartism/engine" if defined?(Rails)
+require 'chartism/options'
+require 'chartism/line/options'
+require 'chartism/pie/options'
+require 'chartism/chart'
 require 'chartism/line'
+require 'chartism/pie'
 
 module Chartism
 end

data/lib/chartism/chart.rb

@@ -0,0 +1,55 @@
+module Chartism
+  module Chart
+    def define_option method_name
+      define_method method_name do
+        value = self.class.send(method_name)
+        if value.is_a?(Proc)
+          instance_eval &value
+        else
+          value
+        end
+      end
+    end
+
+    def define_array_option method_name
+      define_method method_name do
+        values = Array(self.class.send(method_name))
+        values.map do |value|
+          if value.is_a?(Proc)
+            instance_eval &value
+          else
+            value
+          end
+        end
+      end
+    end
+
+    module ClassMethods
+      def define_option method_name
+        define_method method_name do |value=nil, &block|
+          instance_variable_set "@#{method_name}", value unless value.nil?
+          instance_variable_set "@#{method_name}", block if block
+          instance_variable_get "@#{method_name}"
+        end
+      end
+
+      def define_block_option method_name, default=nil
+        define_method method_name do |&block|
+          instance_variable_set "@#{method_name}", block if block
+          instance_variable_get("@#{method_name}") || default
+        end
+      end
+
+      def define_array_option method_name
+        define_method method_name do |value=nil, &block|
+          array = instance_variable_get "@#{method_name}"
+          array = instance_variable_set("@#{method_name}", []) unless array
+
+          array << value unless value.nil?
+          array << block if block
+          array
+        end
+      end
+    end
+  end
+end

data/lib/chartism/helper.rb

@@ -3,11 +3,12 @@ require 'securerandom'
 module Chartism
   module Helper
     # Options include:
+    #   - id
     #   - class
     def chart chartism, options={}
       data_json = chartism.data.to_json
       options_json = chartism.options.to_json
-      id = "chartism-line-#{SecureRandom.hex(6)}"
+      id = options.fetch :id, "chartism-#{SecureRandom.hex(6)}"
       classes = ( ['ct-chart'] + Array(options[:class]) ).join(' ')
 
       %Q[
@@ -16,10 +17,18 @@ module Chartism
       (function() {
         var data = #{data_json};
         var options = #{options_json};
-        new Chartist.Line("##{id}", data, options);
+        new Chartist.#{chart_type(chartism)}("##{id}", data, options);
       })();
       </script>
       ].html_safe
     end
+
+    private
+
+    def chart_type chartism
+      return 'Line' if chartism.class.include? Chartism::Line
+      return 'Pie' if chartism.class.include? Chartism::Pie
+      fail 'unknown Chartism'
+    end
   end
 end

data/lib/chartism/line.rb

@@ -1,58 +1,23 @@
 require 'docile'
-require 'chartism/line/options'
 
 module Chartism
   module Line
-    def self.included(base)
-      base.extend(ClassMethods)
+    extend Chart
+
+    def self.included base
+      base.extend ClassMethods
     end
 
     module ClassMethods
-      def labels value=nil, &block
-        if block_given?
-          @labels = block
-        elsif value
-          @labels = value
-        end
-
-        @labels
-      end
-
-      def series value=nil, &block
-        @series ||= []
-
-        if block_given?
-          @series << block
-        elsif value
-          @series << value
-        end
+      extend Chart::ClassMethods
 
-        @series
-      end
-
-      def options &block
-        @options = block if block_given?
-        @options
-      end
-    end
-
-    def labels
-      if self.class.labels.is_a?(Proc)
-        instance_eval(&self.class.labels)
-      else
-        self.class.labels
-      end
+      define_option :labels
+      define_array_option :series
+      define_block_option :options, ->{}
     end
 
-    def series
-      Array(self.class.series).map do |serie|
-        if serie.is_a?(Proc)
-          instance_eval(&serie)
-        else
-          serie
-        end
-      end
-    end
+    define_option :labels
+    define_array_option :series
 
     def data
       {
@@ -62,7 +27,7 @@ module Chartism
     end
 
     def options
-      Docile.dsl_eval(Options.new, &(self.class.options || ->{}) ).options
+      Docile.dsl_eval(Line::Options.new, &self.class.options).options
     end
   end
 end

data/lib/chartism/line/options.rb

@@ -1,32 +1,13 @@
 module Chartism
   module Line
     class Options
-      def initialize
-        @options = {
-          showPoint: true,
-          lineSmooth: true,
-          showArea: false
-        }
-      end
+      extend Chartism::Options
 
-      def points value=nil, &block
-        @options[:showPoint] = value
-        @options[:showPoint] = instance_eval(&block) if block_given?
-      end
-
-      def smooth value=nil, &block
-        @options[:lineSmooth] = value unless value.nil?
-        @options[:lineSmooth] = instance_eval(&block) if block_given?
-      end
-
-      def area value=nil, &block
-        @options[:showArea] = value unless value.nil?
-        @options[:showArea] = instance_eval(&block) if block_given?
-      end
-
-      def options
-        @options
-      end
+      define_option :points, :showPoint
+      define_option :smooth, :lineSmooth
+      define_option :area, :showArea
+      define_option :line, :showLine
+      define_option :full_width, :fullWidth
     end
   end
 end

data/lib/chartism/options.rb

@@ -0,0 +1,19 @@
+module Chartism
+  module Options
+    def self.extended base
+      base.include InstanceMethods
+    end
+
+    module InstanceMethods
+      attr_reader :options
+    end
+
+    def define_option method_name, option_name
+      define_method method_name do |value=nil, &block|
+        @options ||= {}
+        @options[option_name] = value unless value.nil?
+        @options[option_name] = instance_eval(&block) if block
+      end
+    end
+  end
+end

data/lib/chartism/pie.rb

@@ -0,0 +1,33 @@
+require 'docile'
+
+module Chartism
+  module Pie
+    extend Chart
+
+    def self.included base
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      extend Chart::ClassMethods
+
+      define_option :labels
+      define_option :series
+      define_block_option :options, ->{}
+    end
+
+    define_option :labels
+    define_option :series
+
+    def data
+      {
+        labels: labels,
+        series: series
+      }
+    end
+
+    def options
+      Docile.dsl_eval(Pie::Options.new, &self.class.options).options
+    end
+  end
+end

data/lib/chartism/pie/options.rb

@@ -0,0 +1,11 @@
+module Chartism
+  module Pie
+    class Options
+      extend Chartism::Options
+
+      define_option :donut, :donut
+      define_option :width, :donutWidth
+      define_option :labels, :showLabel
+    end
+  end
+end

data/lib/chartism/version.rb

@@ -1,3 +1,3 @@
 module Chartism
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chartism
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Peters
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-20 00:00:00.000000000 Z
+date: 2015-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docile
@@ -70,10 +70,14 @@ files:
 - bin/setup
 - chartism.gemspec
 - lib/chartism.rb
+- lib/chartism/chart.rb
 - lib/chartism/engine.rb
 - lib/chartism/helper.rb
 - lib/chartism/line.rb
 - lib/chartism/line/options.rb
+- lib/chartism/options.rb
+- lib/chartism/pie.rb
+- lib/chartism/pie/options.rb
 - lib/chartism/version.rb
 - vendor/assets/javascripts/chartist.js
 - vendor/assets/stylesheets/chartist.min.css