RubyGems - pi_charts - Versions diffs - 1.0.0 - Mend

pi_charts 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (38) hide show

checksums.yaml +7 -0
data/.gitignore +12 -0
data/.rspec +2 -0
data/.travis.yml +5 -0
data/CODE_OF_CONDUCT.md +74 -0
data/Gemfile +4 -0
data/LICENSE.txt +21 -0
data/README.md +40 -0
data/Rakefile +6 -0
data/bin/console +14 -0
data/bin/setup +8 -0
data/examples/bar_chart.rb +20 -0
data/examples/bar_chart_hidden_legend.rb +22 -0
data/examples/bar_chart_stacked.rb +23 -0
data/examples/debug.rb +5 -0
data/examples/doughnut_chart.rb +25 -0
data/examples/doughnut_chart_hidden_legened.rb +28 -0
data/examples/line_chart.rb +20 -0
data/examples/line_chart_border.rb +23 -0
data/examples/line_chart_hidden_legend.rb +23 -0
data/examples/line_chart_no_line.rb +24 -0
data/examples/line_chart_tension.rb +23 -0
data/examples/pie_chart.rb +22 -0
data/examples/pie_chart_hidden_legend.rb +19 -0
data/examples/readme_serve_pie.rb +35 -0
data/examples/sinatra.rb +55 -0
data/examples/sinatra_line_chart.rb +25 -0
data/lib/pi_charts.rb +19 -0
data/lib/pi_charts/bar_chart.rb +125 -0
data/lib/pi_charts/base.rb +98 -0
data/lib/pi_charts/config.rb +40 -0
data/lib/pi_charts/doughnut_chart.rb +27 -0
data/lib/pi_charts/line_chart.rb +187 -0
data/lib/pi_charts/pie_chart.rb +52 -0
data/lib/pi_charts/utils.rb +21 -0
data/lib/pi_charts/version.rb +3 -0
data/pi_charts.gemspec +28 -0
metadata +123 -0

data/examples/pie_chart.rb ADDED

@@ -0,0 +1,22 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "pi_charts"
+# create a new pie chart
+chart = PiCharts::Pie.new
+# add datasets
+chart.add_dataset(label: "cats", data: 80)
+chart.add_dataset(label: "dogs", data: 20)
+# make cats 90
+chart.add_dataset(label: "cats", data: 10, add: true)
+# make dogs 10, not adding
+chart.add_dataset(label: "dogs", data: 10)
+# neat 'lil configurations
+chart.hover
+chart.responsive
+# generate html / js for chart
+puts chart.html

data/examples/pie_chart_hidden_legend.rb ADDED

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "pi_charts"
+# create a new pie chart
+chart = PiCharts::Pie.new
+# add datasets
+chart.add_dataset(label: "cats", data: 80)
+chart.add_dataset(label: "dogs", data: 20)
+# hide legend
+chart.legend(hidden: true)
+# neat 'lil configurations
+chart.hover
+chart.responsive
+# generate html / js for chart
+puts chart.html

data/examples/readme_serve_pie.rb ADDED

@@ -0,0 +1,35 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'sinatra'
+require 'pi_charts'
+# whatever sinatra configurations you want
+set :bind, '0.0.0.0'
+set :port, 4567
+# create a new line chart
+chart = PiCharts::Line.new
+# add labels ( x values )
+chart.add_labels(["January", "February", "March", "April", "May"])
+# add datasets
+chart.add_dataset(label: "cats", data: [3, 1, 3, 3, 7])
+chart.add_dataset(label: "dogs", data: [7, 3, 3, 1, 3])
+# neat 'lil configurations
+chart.hover
+chart.responsive
+# generate html / js for chart
+# and serve it up, on the house ( localhost )
+def bake_pie
+  chart = PiCharts::Pie.new
+  chart.add_dataset(label: "cats", data: 80)
+  chart.add_dataset(label: "dogs", data: 50)
+  chart.hover
+  chart.responsive
+  "<head>" + chart.cdn + "</head>" + "<body>" +  chart.html(width: 100) + "</body>"
+end
+get('/serve_pie') { bake_pie }

data/examples/sinatra.rb ADDED

@@ -0,0 +1,55 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'pi_charts'
+require 'sinatra'
+# whatever sinatra configurations you want
+set :bind, '0.0.0.0'
+set :port, 4567
+utils = PiCharts::Utils.new
+get('/') { "try /line or /pie or /bar" }
+def line
+  chart = PiCharts::Line.new
+  chart.add_labels(["January", "February", "March", "April", "May"])
+  chart.add_dataset(label: "cats", data: [3, 1, 3, 3, 7])
+  chart.add_dataset(label: "dogs", data: [7, 3, 3, 1, 3])
+  chart.hover
+  chart.responsive
+  chart.html(width: 100)
+end
+get('/line') { "<head>" + utils.cdn + "</head>" + "<body>" + line + "</body>" }
+def bake_pie
+  chart = PiCharts::Pie.new
+  chart.add_dataset(label: "cats", data: 80)
+  chart.add_dataset(label: "dogs", data: 50)
+  chart.hover
+  chart.responsive
+  chart.html(width: 100)
+end
+get('/pie') { "<head>" + utils.cdn + "</head>" + "<body>" + bake_pie + "</body>" }
+def bar
+  chart = PiCharts::Bar.new
+  chart.add_labels(["January", "February", "March", "April", "May"])
+  chart.add_dataset(label: "cats", data: [ 2, 0, 4, 7, 3 ])
+  chart.add_dataset(label: "dogs", data: [ 4, 6, 3, 9, 2 ])
+  chart.stack
+  chart.hover
+  chart.responsive
+  chart.html(width: 100)
+end
+get('/bar') { "<head>" + utils.cdn + "</head>" + "<body>" + bar + "</body>" }
+def get_doughnuts
+  chart = PiCharts::Doughnut.new
+  chart.add_dataset(label: "cats", data:  7)
+  chart.add_dataset(label: "dogs", data: 13)
+  chart.hover
+  chart.responsive
+  chart.html(width: 100)
+end
+get('/doughnut') { "<head>" + utils.cdn + "</head>" + "<body>" + get_doughnuts + "</body>" }

data/examples/sinatra_line_chart.rb ADDED

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'pi_charts'
+require 'sinatra'
+# whatever sinatra configurations you want
+set :bind, '0.0.0.0'
+set :port, 4567
+# create a new line chart
+chart = PiCharts::Line.new
+# add labels ( x values )
+chart.add_labels(["January", "February", "March", "April", "May"])
+# add datasets
+chart.add_dataset(label: "cats", data: [3, 1, 3, 3, 7])
+chart.add_dataset(label: "dogs", data: [7, 3, 3, 1, 3])
+# neat 'lil configurations
+chart.hover
+chart.responsive
+# generate html / js for chart
+# and serve it up, on the house ( localhost )
+get('/') { "<head>" + chart.cdn + "</head>" + "<body>" + chart.html(width: 100) + "</body>" }

data/lib/pi_charts.rb ADDED

@@ -0,0 +1,19 @@
+# I guess I could do a loop, jah feel?
+# Or any other way I guess.
+require "pi_charts/version"
+require "pi_charts/base"
+require "pi_charts/utils"
+require "pi_charts/config"
+require "pi_charts/line_chart"
+require "pi_charts/pie_chart"
+require "pi_charts/bar_chart"
+require "pi_charts/doughnut_chart"
+# Lil' extra spice.
+require "securerandom"
+require "json"
+module PiCharts
+  # I'll put my code where I want to put my code, thank you very much.
+end

data/lib/pi_charts/bar_chart.rb ADDED

@@ -0,0 +1,125 @@
+module PiCharts
+  class Bar < Base
+    def add_labels(labels)
+      @config.data[:data][:labels] = labels
+    end
+    def title(args={})
+      if args.keys.empty? or ! args.keys.include? [:title]
+        raise "need to specify title with {title: 'name', display: true/false }"
+      end
+      @config.data[:data][:options][:title] = {}
+      @config.data[:data][:options][:title][:text] = args[:title] || ""
+      @config.data[:data][:options][:title][:display] = true unless args[:display] == false
+      true
+    end
+    def create(args={})
+      @config.data[:type] = 'bar'
+      @config.data[:data][:datasets] = []
+      @config.data[:data][:labels]   = []
+      true
+    end
+    def stack(args={})
+      @config.data[:options][:scales]         = {} unless @config.data[:options][:scales]
+      @config.data[:options][:scales][:xAxes] = [] unless @config.data[:options][:scales][:xAxes]
+      @config.data[:options][:scales][:yAxes] = [] unless @config.data[:options][:scales][:yAxes]
+      if args.keys.empty?
+        @config.data[:options][:scales][:xAxes] << { stacked: true }
+        @config.data[:options][:scales][:yAxes] << { stacked: true }
+      else
+        @config.data[:options][:scales][:xAxes] << { stacked: true } if args[:x]
+        @config.data[:options][:scales][:yAxes] << { stacked: true } if args[:y]
+      end
+    end
+    def add_dataset(args={})
+      if args.keys.empty?
+        raise "need to specify dataset"
+      end
+      label = args[:label]
+      data  = args[:data]
+      color = args[:color] || random_color
+      index = dataset_index(label)
+      if index
+        if data.kind_of?(Array)
+          data.each { |d| @config.data[:data][:datasets][index][:data] << d }
+        else
+          @config.data[:data][:datasets][index][:data] << data
+        end
+      else
+        dataset = {}
+        dataset[:label] = label
+        dataset[:borderColor] = color
+        dataset[:backgroundColor] = color
+        dataset[:data]  = []
+        if data.kind_of?(Array)
+          data.each { |d| dataset[:data] << d }
+        else
+          dataset[:data] << data
+        end
+        @config.data[:data][:datasets] << dataset
+      end
+      true
+    end
+    def border(args={})
+      if args.keys.empty?
+        false
+      else
+        if args[:dataset]
+          index = dataset_index(args[:dataset])
+          if index
+            @config.data[:data][:datasets][index][:borderColor]   = args[:color]   if args[:color]
+            @config.data[:data][:datasets][index][:borderWidth]   = args[:width]   if args[:width]
+            @config.data[:data][:datasets][index][:borderSkipped] = args[:skipped] if args[:skipped]
+            @config.data[:data][:datasets][index][:borderDash]    = args[:dash]    if args[:dash]
+          else
+            raise "dataset doesn't seem to exist"
+          end
+        else
+          raise "need to specify a dataset"
+        end
+      end
+    end
+    def hover(args={})
+      if args.keys.empty?
+        false
+      else
+        if args[:dataset]
+          index = dataset_index(args[:dataset])
+          if index
+            @config.data[:data][:datasets][index][:hoverBackgroundColor] = args[:color]  if args[:color]
+            @config.data[:data][:datasets][index][:hoverBorderColor]     = args[:border] if args[:border]
+            @config.data[:data][:datasets][index][:hoverBorderWidth]     = args[:width]  if args[:width]
+          else
+            raise "dataset doesn't seem to exist"
+          end
+        else
+          raise "need to specify a dataset"
+        end
+      end
+    end
+    private
+    def dataset_index(label=false)
+      if label
+        @config.data[:data][:datasets].each_with_index do |set, index|
+          if set[:label] == label
+            return index
+          end
+        end
+      end
+      false
+    end
+  end
+end

data/lib/pi_charts/base.rb ADDED

@@ -0,0 +1,98 @@
+module PiCharts
+  # The Base class is responsible for providing the boiler plate
+  # code for all of the different types of +PiCharts+ that someone
+  # can create with this gem. That's its job.
+  class Base
+    attr_accessor :config # Configuration base for all charts.
+    attr_accessor :cdn    # Content distribution network, for the lulz.
+    # Every class has a +config+ and, depending on the type
+    # the +create+ method will help with setting up the +config+
+    # for that specific type of chart.
+    def initialize(args = {})
+      @config = Config.new
+      create
+    end
+    # The responsive() method will make any chart responsive.
+    def responsive(responsive = true)
+      if responsive
+        config.data[:options][:responsive] = true
+      else
+        config.data[:options][:responsive] = false
+      end
+    end
+    # The cdn() method will generate a bit of html magic to create
+    # a cloudflare cdn link for the needed javascript.
+    def cdn(args = {})
+      version = args[:version] || '2.4.0'
+      min     = false          || args[:min]
+      if min
+        "<script src=\"https://cdnjs.cloudflare.com/ajax/libs/Chart.js/#{version}/Chart.min.js\"></script>"
+      else
+        "<script src=\"https://cdnjs.cloudflare.com/ajax/libs/Chart.js/#{version}/Chart.js\"></script>"
+      end
+    end
+    # The legend() provides an interface to set options for the legend for any chart.
+    def legend(args = {})
+      config.data[:options][:legend] = {} unless config.data[:options][:legend]
+      config.data[:options][:legend][:position]  = args[:position] if args [:position]
+      config.data[:options][:legend][:display]   = true  if args[:display]
+      config.data[:options][:legend][:display]   = false if args[:hidden]
+      config.data[:options][:legend][:fullWidth] = true  if args[:full]
+      config.data[:options][:legend][:reverse]   = true  if args[:reverse]
+      # legend labels
+      config.data[:options][:legend][:labels][:boxWidth]  = args[:width]   if args[:width]
+      config.data[:options][:legend][:labels][:fontSize]  = args[:size]    if args[:size]
+      config.data[:options][:legend][:labels][:fontStyle] = args[:style]   if args[:style]
+      config.data[:options][:legend][:labels][:padding]   = args[:padding] if args[:padding]
+    end
+    # The hover() method provides an interface +that is currently incomplete+ to the hover options for a chart.
+    def hover(args = {})
+      config.data[:options][:hover] = {}
+      if args.keys.empty?
+        config.data[:options][:hover][:mode] = 'nearest'
+        config.data[:options][:hover][:intersect] = true
+      else
+        config.data[:options][:hover][:mode] = 'nearest' if args[:nearest]
+        config.data[:options][:hover][:intersect] = true if args[:intersect]
+        config.data[:options][:hover][:animationDuration] = args[:animation] if args[:animation]
+      end
+      # TODO: add support for onHover configuration option
+      true
+    end
+    # Sometimes you just need a random color.
+    def random_color
+      "##{SecureRandom.hex(3)}"
+    end
+    # The create() method helps with the main boiler-plate
+    # buisness that goes behind the Base class.
+    def create
+      # helps with boilerplateness
+    end
+    # The html() method helps build the relevant html for the chart.
+    def html(args = {})
+      id     = SecureRandom.uuid
+      width  = args[:width]  || "50"
+      config = args[:config] || @config.json
+      type   = @config.type
+      "<div id=\"canvas-holder\" style=\"width:#{width}%\">
+        <canvas id=\"#{id}\" />
+      </div>
+      <script>
+        var config = #{config}
+        window.onload = function() {
+          var ctx = document.getElementById(\"#{id}\").getContext(\"2d\");
+          new Chart(ctx, config);
+        };
+      </script>"
+    end
+  end
+end

data/lib/pi_charts/config.rb ADDED

@@ -0,0 +1,40 @@
+module PiCharts
+  # The Config class provides the interface to the config
+  # for a chart. This is basically the skeleton of the
+  # infromation that drives the infromation for the chart
+  # that can be rendered into json. This information is
+  # constructed with its +data+ which actually provides
+  # the blueprints.
+  class Config
+    attr_accessor :data # The main brain and butter of what makes the co
+    # The initialize() method handles the creation of what defines
+    # the +data+ for a +config+, which sets up the relevant base.
+    def initialize(args={})
+      @data = {}
+      @data[:type] = ''
+      @data[:data] = {}
+      @data[:data][:datasets] = []
+      @data[:options] = {}
+    end
+    # type?() helps determine if a type has been set or not.
+    def type?
+      @data[:type].empty? ? false : true
+    end
+    # type() returns the the type set in the config, or false
+    # if a type has not yet been set.
+    def type
+      @data[:type].empty? ? false : @data[:type]
+    end
+    # json() returns the +json+ representation of the +config+ data
+    # in a javascript friendly form. Magic!
+    def json
+      @data.to_json
+    end
+  end
+end