Added Highstock feature #89

Prakriti-nith · 2018-05-14T11:09:58Z

Added highstock feature.
The value of chart_class will be provided by the user.
Here are the links to view examples: Highstock-Chart types, Highstock-General

Prakriti-nith · 2018-05-14T13:21:01Z

I have added some more examples here.

Shekharrajak

Please add all the examples in iruby . Also run the previously present examples (to check nothing is breaking) and commit the changes.

Good work!

Shekharrajak · 2018-05-15T11:06:40Z

lib/daru/view/adapters/highcharts/display.rb

@@ -48,7 +69,15 @@ def show_in_iruby(placeholder=random_canvas_id)
    def to_html_iruby(placeholder=random_canvas_id)
      # TODO : placeholder pass, in plot#div
      chart_hash_must_be_present
-      high_chart_iruby(placeholder, self)
+      chart_class = options.delete(:chart_class).to_s.downcase unless


Make it DRY. May be one method or instance variable.

Shekharrajak · 2018-05-15T11:08:09Z

lib/daru/view/adapters/highcharts/layout_helper_iruby.rb

    end

    def high_graph_iruby(placeholder, object, &block)
      build_html_output_iruby('Chart', placeholder, object, &block)
    end

+    def high_graph_stock_iruby(placeholder, object, &block)


high_graph_iruby also doing the same thing . We can add chart_class parameter, right?

Shekharrajak · 2018-05-15T11:08:43Z

lib/daru/view/adapters/highcharts/layout_helper_iruby.rb

@@ -29,18 +43,18 @@ def encapsulate_js_iruby(core_js)
          "#{js_start_iruby} #{core_js} #{js_end_iruby}"
        # Turbolinks.version < 5
        elsif defined?(Turbolinks) && request_is_referrer?
-          to_s(eventlistener_page_load)
+          eventlistener_page_load(core_js)


without passing core_js , it will work, right ?

No, it was not working as these methods (eventlistener_page_load, eventlistener_turbolinks_load, call_core_js) required core_js.

Shekharrajak · 2018-05-15T11:16:50Z

spec/adapters/highcharts/display_spec.rb

+    @placeholder = "placeholder"
+  end
+
+  describe "#to_html" do


Please write specs for all methods present in display.rb , iruby_notebook.rb, layout_helper_iruby.rb (or few specs such that it covers all the methods).

Shekharrajak · 2018-05-15T11:18:20Z

spec/adapters/highcharts/layout_helper_iruby_spec.rb

+
+  before { Daru::View.plotting_library = :highcharts }
+  before(:each) do
+    @placeholder = "placeholder"


Please use sample data, options which can generate the charts without error (don't just test for generated js).

Prakriti-nith · 2018-05-15T18:02:27Z

I have added almost all the examples of HighStock except those which require additional javascript (apart from options and data (series)) like this. I also tried all the examples but one example from nyaplot (in box plot example) was throwing some error. I am not sure if the error is related to this feature addition.

Shekharrajak

I am expecting spec for plot.to_html which will generate js code having all the set options like chart, rangeSelector, title, data, dataGrouping, etc.

Shekharrajak · 2018-05-16T06:41:51Z

lib/daru/view/adapters/highcharts/display.rb

+    end
+
+    def extract_chart_class
+      options.delete(:chart_class).to_s.downcase unless options[:chart_class].nil?


chart_class = options.delete(:chart_class).to_s.capitalize unless options[:chart_class].nil?
chart_class = 'StockChart' if chart_class == 'stock'

Shekharrajak · 2018-05-16T06:46:18Z

lib/daru/view/adapters/highcharts/layout_helper_iruby.rb

-
-    def high_graph_stock_iruby(placeholder, object, &block)
-      build_html_output_iruby('StockChart', placeholder, object, &block)
+      if chart_class == 'map'


build_html_output_iruby(chart_class , placeholder, object, &block).concat(content_tag('div', '', object.html_options))

Shekharrajak · 2018-05-16T06:55:00Z

spec/adapters/highcharts/display_spec.rb

+  before { Daru::View.plotting_library = :highcharts }
+  describe "#init_script" do
+    it "generates valid initial script" do
+      js = LazyHighCharts.init_script


This is not testing whether all the js files are loaded or not.

Isn't we check for "BEGIN highstock.js" and "END highstock.js" , ... ?

Shekharrajak · 2018-05-16T06:59:38Z

spec/adapters/highcharts/layout_helper_iruby_spec.rb

        	@placeholder,
        	@chart.chart)
        ).to match(/window.chart_placeholder\s=/)
      end
      it "should set Chart data" do
        expect(@chart.chart.high_chart_iruby(
+        	"",


must be "Chart"

Shekharrajak · 2018-05-16T07:14:51Z

I also tried all the examples but one example from nyaplot (in box plot example) was throwing some error. I am not sure if the error is related to this feature addition.

Commit the changes (when you run IRuby notebook examples , .ipynb files will get changed)

Shekharrajak · 2018-05-16T13:18:46Z

It seems you haven't done bundle install in spec/dummy_iruby .

Prakriti-nith · 2018-05-18T14:23:31Z

@Shekharrajak , please review it and let me know any changes I have to make.

Shekharrajak

Consider minor comments, then it will be merged.

Shekharrajak · 2018-05-20T09:31:17Z

lib/daru/view/adapters/highcharts/display.rb

+      elsif chart_class == 'StockChart'
+        high_stock(placeholder, self)
+      # No need to pass any value for HighChart
+      else


I think it must be specific 'Chart'. If user have entered some xyz chart_class then raise error 'Not implemented' or '3 chart_class chart, stock, map must be selected ' something like that.

Shekharrajak · 2018-05-20T09:33:34Z

spec/adapters/highcharts/layout_helper_iruby_spec.rb

+      {
+        name: 'AAPL Stock Price',
+        data: [
+								[1147651200000,67.79],


Proper indentation please.

Shekharrajak · 2018-05-20T11:16:05Z

lib/daru/view/adapters/highcharts/display.rb

+      elsif chart_class == 'Chart'
+        high_chart(placeholder, self)
+      else
+        raise 'chart_class must be selected as either chart, stock or map'


Isn't this raise must be in extract_chart_class method? Remember one method must do only one thing.

Shekharrajak · 2018-05-20T11:19:23Z

lib/daru/view/adapters/highcharts/display.rb

+    # @return [String] the class of the chart
+    def extract_chart_class
+      # Provided by user and can take two values ('stock' or 'map').
+      chart_class = options.delete(:chart_class).to_s.downcase unless


Instead of downcase , capitalize can reduce the number of line. Please read my comments.

Yes, but we need to check whether chart_class is assigned or not and user has entered the correct value for chart_class. For that, we still have to compare with all the 3 classes.

Shekharrajak · 2018-05-22T09:36:19Z

lib/daru/view/adapters/highcharts/display.rb

-        end
+      chart_class = 'StockChart' if chart_class == 'Stock'
+      chart_class = 'Chart' if chart_class.nil?
+      unless %w[Chart StockChart Map].include?(chart_class) || chart_class.nil?


|| chart_class.nil? is not required.

Shekharrajak · 2018-05-22T09:36:43Z

lib/daru/view/adapters/highcharts/display.rb

+      chart_class = 'StockChart' if chart_class == 'Stock'
+      chart_class = 'Chart' if chart_class.nil?
+      unless %w[Chart StockChart Map].include?(chart_class) || chart_class.nil?
+        raise 'chart_class must be selected as either chart, stock or map'


Testcase for this?

Shekharrajak · 2018-05-22T11:06:38Z

Thanks @Prakriti-nith ! Merging it.

Shekharrajak · 2018-07-14T07:34:03Z

Also fixes #8

Prakriti-nith added 2 commits May 14, 2018 16:35

Added Highstock feature

6a14dc5

Added more examples

c7fc3cd

Prakriti-nith force-pushed the highstock branch from d97390c to c7fc3cd Compare May 14, 2018 13:15

Shekharrajak reviewed May 15, 2018

View reviewed changes

Added more tests

e78810c

Shekharrajak reviewed May 16, 2018

View reviewed changes

Check all examples

c2abf44

NyaPlot error resolve

6516318

Prakriti-nith force-pushed the highstock branch from cd78b93 to 6516318 Compare May 16, 2018 13:47

Improved testcases

8fb8811

Added dynamic data example

0ec5032

Shekharrajak reviewed May 20, 2018

View reviewed changes

Proper indentation

4f89def

Shekharrajak reviewed May 20, 2018

View reviewed changes

Prakriti-nith added 2 commits May 20, 2018 16:51

Raise exception

1299573

Using capitalize instead of downcase

50332f6

Shekharrajak reviewed May 22, 2018

View reviewed changes

Added test for raising error

0bb016e

Shekharrajak merged commit 20acde5 into SciRuby:master May 22, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added Highstock feature #89

Added Highstock feature #89

Prakriti-nith commented May 14, 2018

Prakriti-nith commented May 14, 2018

Shekharrajak left a comment

Shekharrajak May 15, 2018

Shekharrajak May 15, 2018

Shekharrajak May 15, 2018

Prakriti-nith May 15, 2018

Shekharrajak May 15, 2018

Shekharrajak May 15, 2018

Prakriti-nith commented May 15, 2018

Shekharrajak left a comment

Shekharrajak May 16, 2018

Shekharrajak May 16, 2018

Shekharrajak May 16, 2018

Shekharrajak May 16, 2018

Shekharrajak commented May 16, 2018

Shekharrajak commented May 16, 2018

Prakriti-nith commented May 18, 2018

Shekharrajak left a comment

Shekharrajak May 20, 2018

Shekharrajak May 20, 2018

Shekharrajak May 20, 2018

Shekharrajak May 20, 2018

Prakriti-nith May 20, 2018

Shekharrajak May 22, 2018

Shekharrajak May 22, 2018

Shekharrajak commented May 22, 2018

Shekharrajak commented Jul 14, 2018

Added Highstock feature #89

Added Highstock feature #89

Conversation

Prakriti-nith commented May 14, 2018

Prakriti-nith commented May 14, 2018

Shekharrajak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Prakriti-nith commented May 15, 2018

Shekharrajak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Shekharrajak commented May 16, 2018

Shekharrajak commented May 16, 2018

Prakriti-nith commented May 18, 2018

Shekharrajak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Shekharrajak commented May 22, 2018

Shekharrajak commented Jul 14, 2018