daru-view 0.1.0

data/lib/daru/view/adapters/nyaplot.rb

@@ -0,0 +1,62 @@
+
+require_relative 'nyaplot/iruby_notebook'
+require 'daru'
+require 'nyaplot'
+
+module Daru
+  module View
+    module Adapter
+      module NyaplotAdapter
+        extend self # rubocop:disable Style/ModuleFunction
+        def init(data, options)
+          data_new = guess_data(data)
+          data_new.plot(options)
+        end
+
+        def export_html_file(plot, path)
+          plot.export_html path
+        end
+
+        def show_in_iruby(plot)
+          plot.show
+        end
+
+        def init_script
+          Nyaplot.init_script
+        end
+
+        def generate_body(plot)
+          plot.to_iruby[1]
+        end
+
+        def init_iruby
+          Nyaplot.init_iruby
+        end
+
+        private
+
+        def multi_dimension_check(arr)
+          arr.all? { |a| a.class==Array }
+        end
+
+        def guess_data(data_set)
+          case
+          when [Daru::DataFrame, Daru::Vector].include?(data_set.class)
+            data_set
+          when data_set.is_a?(Array)
+            if data_set.empty?
+              Daru::Vector.new([])
+            else
+              multi_dimension_check(data_set)? Daru::DataFrame.new(data_set) : Daru::Vector.new(data_set)
+            end
+          else
+            raise ArgumentError, "For Nyaplot Library, data must be in
+            Daru::Vector or Daru::DataFrame.\n You can change the plotting
+            library using the code : \n
+            ` Daru::View.plotting_library = :highcharts` or other library."
+          end
+        end # def guess_data end
+      end
+    end # Adapter end
+  end
+end

data/lib/daru/view/adapters/nyaplot/display.rb

@@ -0,0 +1,9 @@
+module Nyaplot
+  # dependent JS to include in head tag of the web application
+  def self.init_script
+    init = Nyaplot.generate_init_code
+    path = File.expand_path('../../../templates/nyaplot/init_script.erb', __FILE__)
+    template = File.read(path)
+    ERB.new(template).result(binding)
+  end
+end

data/lib/daru/view/adapters/nyaplot/iruby_notebook.rb

@@ -0,0 +1,22 @@
+module Nyaplot
+  # generate initializing code
+  def self.generate_init_code_offline(dependent_js)
+    js_dir = File.expand_path('../../js/nyaplot_js', __FILE__)
+    path = File.expand_path('../../../templates/nyaplot/init.inline.js.erb', __FILE__)
+    template = File.read(path)
+    ERB.new(template).result(binding)
+  end
+
+  # generate initializing code
+  def self.generate_init_code_online
+    # TODO : better than present Nyaplot.generate_init_code
+  end
+
+  # Enable to show plots on IRuby notebook
+  def self.init_iruby(*)
+    #
+    # dependent_js=['d3.min.js', 'd3-downloadable.js', 'nyaplot.js']
+    js = generate_init_code
+    IRuby.display(IRuby.javascript(js))
+  end
+end

data/lib/daru/view/app/rails/helpers/view_helper.rb

@@ -0,0 +1,26 @@
+require 'daru/view/plot'
+require 'daru/view/table'
+
+module Daru
+  module View
+    module Rails
+      module ViewHelper
+        extend ActiveSupport::Concern
+
+        included do
+          if respond_to?(:helper_method)
+            helper_method 'daru_chart', 'daru_table'
+          end
+        end
+
+        def daru_chart(data=[], options={})
+          Daru::View::Plot.new(data, options).div.html_safe
+        end
+
+        def daru_table(data=[], options={})
+          Daru::View::Table.new(data, options).div.html_safe
+        end
+      end
+    end
+  end
+end

data/lib/daru/view/app/rails/railtie.rb

@@ -0,0 +1,15 @@
+require_relative 'helpers/view_helper'
+
+module Daru
+  module View
+    module Rails
+      class Railtie < ::Rails::Railtie
+        initializer 'daru/view' do
+          ActiveSupport.on_load(:action_controller) do
+            include Daru::View::Rails::ViewHelper
+          end
+        end
+      end
+    end
+  end
+end

data/lib/daru/view/plot.rb

@@ -0,0 +1,106 @@
+
+module Daru
+  module View
+    class Plot
+      attr_reader :chart, :data, :options
+      attr_accessor :adapter
+      class << self
+        # class method
+        #
+        # @example
+        #
+        # Daru::View::Plot.adapter = :googlecharts
+        #
+        # Plotting libraries are nyaplot, highcharts, googlecharts
+        def adapter=(adapter)
+          require "daru/view/adapters/#{adapter}"
+          # rubocop:disable Style/ClassVars
+          @@adapter = Daru::View::Adapter.const_get(
+            adapter.to_s.capitalize + 'Adapter'
+          )
+        end
+      end
+
+      # @example
+      #
+      # df = Daru::DataFrame.new({a:['A', 'B', 'C', 'D', 'E'], b:[10,20,30,40,50]})
+      # Daru::View::Plot.new df, type: :bar, x: :a, y: :b, adapter: :nyaplot
+      #
+      # Set the new adapter(plotting library) ,for example highcharts:
+      #
+      # Daru::View.plotting_library = :highcharts
+      #
+      # To use a particular apdater in certain plot object(s), then user
+      # must pass the adapter in `options` hash. e.g. `adapter: :highcharts`
+      #
+      def initialize(data=[], options={}, &block)
+        # TODO: &block is not used, right now.
+        @data = data
+        @options = options
+        self.adapter = options.delete(:adapter) unless options[:adapter].nil?
+        @chart = plot_data(data, options, &block)
+      end
+
+      # instance method
+      def adapter=(adapter)
+        require "daru/view/adapters/#{adapter}"
+        @adapter = Daru::View::Adapter.const_get(
+          adapter.to_s.capitalize + 'Adapter'
+        )
+      end
+
+      # display in IRuby notebook
+      def show_in_iruby
+        @adapter.show_in_iruby @chart
+      end
+
+      # dependent js file, to include in head tag using the plot object.
+      # @example:
+      # plot_obj.init_script
+      #
+      # Note :
+      # User can directly put the dependent script file into the head tag
+      # using `Daru::View.dependent_script(:highcharts), by default it loads
+      # Nyaplot JS files.
+      #
+      def init_script
+        @adapter.init_script
+      end
+
+      # generat html code, to include in body tag
+      def div
+        @adapter.generate_body(@chart)
+      end
+
+      # generat html file
+      def export_html_file(path='./plot.html')
+        @adapter.export_html_file(@chart, path)
+      end
+
+      # load the corresponding JS files in IRuby notebook.
+      # This is done automatically when plotting library is set using
+      # Daru::View.plotting_library = :new_library
+      def init_iruby
+        @adapter.init_iruby
+      end
+
+      def add_series(opts={})
+        case adapter
+        when Daru::View::Adapter::HighchartsAdapter
+          @chart = @adapter.add_series(@chart, opts)
+        else
+          raise("Method `add-series` is not valid for #{@adapter}.to_s.capitalize library.")
+        end
+      end
+
+      private
+
+      def plot_data(data, options)
+        # class variable @@aapter is used in instance variable @adapter.
+        # so in each object `adapter` variable can be accessed.
+        @adapter ||= @@adapter
+        @adapter.init(data, options)
+      end
+    end
+  end
+end

data/lib/daru/view/table.rb

@@ -0,0 +1,99 @@
+
+module Daru
+  module View
+    class Table
+      attr_reader :table, :data, :options
+      attr_accessor :adapter
+      class << self
+        # class method
+        #
+        # @example
+        #
+        # Daru::View::Table.adapter = :new_library
+        def adapter=(adapter)
+          # The library wrapper method for generating table is in the
+          # same folder as the plotting library. Since google chart can be
+          # used for plotting charts as well as table.
+          #
+          require "daru/view/adapters/#{adapter}"
+          # rubocop:disable Style/ClassVars
+          @@adapter = Daru::View::Adapter.const_get(
+            adapter.to_s.capitalize + 'Adapter'
+          )
+        end
+      end
+
+      # TODO: modify the examples
+      # @example
+      #
+      # df = Daru::DataFrame.new({a:['A', 'B', 'C', 'D', 'E'], b:[10,20,30,40,50]})
+      # Daru::View::Plot.new df, type: :bar, x: :a, y: :b
+      #
+      # Set the new adapter(plotting library) ,for example highcharts:
+      #
+      # Daru::View.plotting_library = :highcharts
+      #
+      # To use a particular apdater in certain plot object(s), then user
+      # must pass the adapter in `options` hash. e.g. `adapter: :highcharts`
+      #
+      def initialize(data=[], options={})
+        @data = data
+        @options = options
+        self.adapter = options.delete(:adapter) unless options[:adapter].nil?
+        @table = table_data(data, options)
+      end
+
+      # instance method
+      def adapter=(adapter)
+        require "daru/view/adapters/#{adapter}"
+        @adapter = Daru::View::Adapter.const_get(
+          adapter.to_s.capitalize + 'Adapter'
+        )
+      end
+
+      # display in IRuby notebook
+      def show_in_iruby
+        @adapter.show_in_iruby @table
+      end
+
+      # dependent js file, to include in head tag using the plot object.
+      # @example:
+      # plot_obj.init_script
+      #
+      # Note :
+      # User can directly put the dependent script file into the head tag
+      # using `Daru::View.dependent_script(:highcharts), by default it loads
+      # Nyaplot JS files.
+      #
+      def init_script
+        @adapter.init_script
+      end
+
+      # generate html code, to include in body tag
+      def div
+        @adapter.generate_body(@table)
+      end
+
+      # generat html file
+      def export_html_file(path='./plot.html')
+        @adapter.export_html_file(@table, path)
+      end
+
+      # load the corresponding JS files in IRuby notebook.
+      # This is done automatically when plotting library is set using
+      # Daru::View.plotting_library = :new_library
+      def init_iruby
+        @adapter.init_iruby
+      end
+
+      private
+
+      def table_data(data, options)
+        # class variable @@aapter is used in instance variable @adapter.
+        # so in each object `adapter` variable can be accessed.
+        @adapter ||= @@adapter
+        @adapter.init_table(data, options)
+      end
+    end
+  end
+end

data/lib/daru/view/templates/googlecharts/chart_div.erb

@@ -0,0 +1,4 @@
+<div id='<%= id %>'></div>
+<script>
+<%= chart_script %>
+</script>

data/lib/daru/view/templates/googlecharts/init.inline.js.erb

@@ -0,0 +1,16 @@
+<%
+
+dependent_js.each{ |dep_js|
+  contents = IO.read(File.join(js_dir,dep_js), mode: 'r:UTF-8')
+%>
+   /* BEGIN <%= dep_js %> */
+
+<%= contents %>
+  /* END <%= dep_js %>*/
+<% } %>
+
+var event = document.createEvent("HTMLEvents");
+event.initEvent("load_google_charts", false, false);
+window.dispatchEvent(event);
+console.log("Finish loading google charts js files");
+

data/lib/daru/view/templates/highcharts/init.inline.js.erb

@@ -0,0 +1,16 @@
+<%
+
+dependent_js.each{ |dep_js|
+  contents = IO.read(File.join(js_dir,dep_js), mode: 'r:UTF-8')
+%>
+   /* BEGIN <%= dep_js %> */
+
+<%= contents %>
+  /* END <%= dep_js %>*/
+<% } %>
+
+var event = document.createEvent("HTMLEvents");
+event.initEvent("load_highcharts", false, false);
+window.dispatchEvent(event);
+console.log("Finish loading highchartsjs");
+

data/lib/daru/view/templates/highcharts/static_html.erb

@@ -0,0 +1,7 @@
+<html lang='en'>
+<head>
+  <title>Chart</title>
+  <%= initial_script %>
+</head>
+<body><%= chart_div %></body>
+</html>

data/lib/daru/view/templates/nyaplot/init.inline.js.erb

@@ -0,0 +1,16 @@
+<%
+
+dependent_js.each{ |dep_js|
+  contents = IO.read(File.join(js_dir,dep_js), mode: 'r:UTF-8')
+%>
+   /* BEGIN <%= dep_js %> */
+
+<%= contents %>
+  /* END <%= dep_js %>*/
+<% } %>
+
+var event = document.createEvent("HTMLEvents");
+event.initEvent("load_nyaplot", false, false);
+window.dispatchEvent(event);
+console.log("Finish loading nyaplot.js");
+

data/lib/daru/view/templates/nyaplot/init_script.erb

@@ -0,0 +1,3 @@
+<!-- TODO : remove the link and use downloaded js -->
+<script src="http://cdnjs.cloudflare.com/ajax/libs/require.js/2.1.14/require.min.js"></script>
+<script><%= init %></script>

data/lib/daru/view/version.rb

@@ -0,0 +1,5 @@
+module Daru
+  module View
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/tasks/google_charts.rake

@@ -0,0 +1,25 @@
+def say(msg, &block)
+  print "#{msg}..."
+
+  if block_given?
+      yield
+    puts " Done."
+  end
+end
+
+namespace :googlecharts do
+  desc "Update google charts javascript dependent files, from latest Builds on google developers website"
+  task :update => [:jsapi, :loader]
+  task :jsapi do
+    say "Grabbing Core from google jsapi codebase..." do
+      sh "curl -# https://www.google.com/jsapi -L --compressed -o lib/daru/view/adapters/js/googlecharts_js/google_visualr.js"
+    end
+  end
+
+  task :loader do
+    say "Grabbing loader.js from the google website..." do
+      sh "curl -# https://www.gstatic.com/charts/loader.js -L --compressed -o lib/daru/view/adapters/js/googlecharts_js/loader.js"
+    end
+  end
+
+end