rbplotly 0.1.1 → 0.1.2

data/examples/heatmaps.ipynb

@@ -3,6 +3,67 @@
   {
    "cell_type": "code",
    "execution_count": 1,
+   "metadata": {
+    "collapsed": false,
+    "scrolled": true
+   },
+   "outputs": [
+    {
+     "data": {
+      "text/html": [
+       "\n",
+       "  <script>\n",
+       "  requirejs.config({paths: { 'plotly': ['https://cdn.plot.ly/plotly-latest.min'] }})\n",
+       "  </script>\n",
+       "\n",
+       "\n",
+       "<div id=\"538b8031-8157-4473-aaab-221d4569c87b\" style=\"height: 100%; width: 100%;\"></div>\n",
+       "\n",
+       "<script>\n",
+       " require(['plotly'], function(Plotly) { \n",
+       "Plotly.newPlot(\n",
+       "  '538b8031-8157-4473-aaab-221d4569c87b',\n",
+       "  [{\"z\":[[1,20,30],[20,1,60],[30,60,1]],\"type\":\"heatmap\"}],\n",
+       "  {},\n",
+       "  {\"linkText\":\"Export to plot.ly\",\"showLink\":true}\n",
+       ")\n",
+       "\n",
+       "window.addEventListener('resize', function() {\n",
+       "  Plotly.Plots.resize(document.getElementById('538b8031-8157-4473-aaab-221d4569c87b'))\n",
+       "})\n",
+       " }) \n",
+       "</script>"
+      ],
+      "text/plain": [
+       "#<Plotly::Offline::HTML:0x007ff4ac144a30 @id=\"538b8031-8157-4473-aaab-221d4569c87b\", @data=[{:z=>[[1, 20, 30], [20, 1, 60], [30, 60, 1]], :type=>:heatmap}], @layout={}, @config={:linkText=>\"Export to plot.ly\", :showLink=>true}, @embedded=true>"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "# Basic Heatmap\n",
+    "require 'rbplotly'\n",
+    "\n",
+    "z = [\n",
+    "  [1, 20, 30],\n",
+    "  [20, 1, 60],\n",
+    "  [30, 60, 1]\n",
+    "]\n",
+    "\n",
+    "data = [{\n",
+    "  z: z,\n",
+    "  type: :heatmap\n",
+    "}]\n",
+    "\n",
+    "plot = Plotly::Plot.new(data: data)\n",
+    "plot.show"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 2,
    "metadata": {
     "collapsed": false
    },
@@ -16,25 +77,25 @@
        "  </script>\n",
        "\n",
        "\n",
-       "<div id=\"c757ae6c-042e-4bf2-8533-60cc50ac2490\" style=\"height: 100%; width: 100%;\"></div>\n",
+       "<div id=\"30fe907e-b3ae-4b61-ae76-e40bd75080c4\" style=\"height: 100%; width: 100%;\"></div>\n",
        "\n",
        "<script>\n",
        " require(['plotly'], function(Plotly) { \n",
        "Plotly.newPlot(\n",
-       "  'c757ae6c-042e-4bf2-8533-60cc50ac2490',\n",
-       "  [{\"x\":[\"x1\",\"x2\",\"x3\",\"x4\",\"x5\",\"x6\",\"x7\",\"x8\",\"x9\",\"x10\"],\"y\":[\"y1\",\"y2\",\"y3\",\"y4\",\"y5\",\"y6\",\"y7\",\"y8\",\"y9\",\"y10\"],\"z\":[[9,0,0,7,0,8,0,0,4,0],[7,7,0,9,2,3,1,2,4,8],[5,7,9,0,5,0,4,3,0,0],[3,9,1,5,0,3,1,0,2,7],[8,4,6,4,6,9,3,5,8,4],[3,8,0,2,9,4,6,5,8,5],[5,9,1,5,8,6,5,4,0,5],[3,7,4,2,5,6,1,1,3,7],[2,4,4,4,3,3,5,3,2,9],[3,6,5,0,0,5,1,1,4,0]],\"type\":\"heatmap\"}],\n",
+       "  '30fe907e-b3ae-4b61-ae76-e40bd75080c4',\n",
+       "  [{\"z\":[[0,6,5,5,3,9,6,6,9,7],[6,3,2,5,9,1,4,6,7,4],[7,6,8,2,1,0,0,1,3,7],[6,8,8,4,3,1,0,8,5,3],[1,2,4,0,2,6,4,2,7,6],[3,2,9,6,2,7,5,6,1,5],[2,0,3,4,4,8,6,9,2,9],[3,5,0,6,7,0,8,6,6,0],[0,8,3,9,7,6,5,0,9,9],[6,4,3,5,2,8,2,8,6,8]],\"type\":\"heatmap\",\"x\":[\"x1\",\"x2\",\"x3\",\"x4\",\"x5\",\"x6\",\"x7\",\"x8\",\"x9\",\"x10\"],\"y\":[\"y1\",\"y2\",\"y3\",\"y4\",\"y5\",\"y6\",\"y7\",\"y8\",\"y9\",\"y10\"]}],\n",
        "  {\"width\":500,\"height\":500},\n",
        "  {\"linkText\":\"Export to plot.ly\",\"showLink\":true}\n",
        ")\n",
        "\n",
        "window.addEventListener('resize', function() {\n",
-       "  Plotly.Plots.resize(document.getElementById('c757ae6c-042e-4bf2-8533-60cc50ac2490'))\n",
+       "  Plotly.Plots.resize(document.getElementById('30fe907e-b3ae-4b61-ae76-e40bd75080c4'))\n",
        "})\n",
        " }) \n",
        "</script>"
       ],
       "text/plain": [
-       "#<Plotly::Offline::HTML:0x007fe22b083530 @id=\"c757ae6c-042e-4bf2-8533-60cc50ac2490\", @data=[{:x=>[\"x1\", \"x2\", \"x3\", \"x4\", \"x5\", \"x6\", \"x7\", \"x8\", \"x9\", \"x10\"], :y=>[\"y1\", \"y2\", \"y3\", \"y4\", \"y5\", \"y6\", \"y7\", \"y8\", \"y9\", \"y10\"], :z=>[[9, 0, 0, 7, 0, 8, 0, 0, 4, 0], [7, 7, 0, 9, 2, 3, 1, 2, 4, 8], [5, 7, 9, 0, 5, 0, 4, 3, 0, 0], [3, 9, 1, 5, 0, 3, 1, 0, 2, 7], [8, 4, 6, 4, 6, 9, 3, 5, 8, 4], [3, 8, 0, 2, 9, 4, 6, 5, 8, 5], [5, 9, 1, 5, 8, 6, 5, 4, 0, 5], [3, 7, 4, 2, 5, 6, 1, 1, 3, 7], [2, 4, 4, 4, 3, 3, 5, 3, 2, 9], [3, 6, 5, 0, 0, 5, 1, 1, 4, 0]], :type=>:heatmap}], @layout={:width=>500, :height=>500}, @config={:linkText=>\"Export to plot.ly\", :showLink=>true}, @embedded=true>"
+       "#<Plotly::Offline::HTML:0x007ff4ac82e0d0 @id=\"30fe907e-b3ae-4b61-ae76-e40bd75080c4\", @data=[{:z=>[[0, 6, 5, 5, 3, 9, 6, 6, 9, 7], [6, 3, 2, 5, 9, 1, 4, 6, 7, 4], [7, 6, 8, 2, 1, 0, 0, 1, 3, 7], [6, 8, 8, 4, 3, 1, 0, 8, 5, 3], [1, 2, 4, 0, 2, 6, 4, 2, 7, 6], [3, 2, 9, 6, 2, 7, 5, 6, 1, 5], [2, 0, 3, 4, 4, 8, 6, 9, 2, 9], [3, 5, 0, 6, 7, 0, 8, 6, 6, 0], [0, 8, 3, 9, 7, 6, 5, 0, 9, 9], [6, 4, 3, 5, 2, 8, 2, 8, 6, 8]], :type=>:heatmap, :x=>[\"x1\", \"x2\", \"x3\", \"x4\", \"x5\", \"x6\", \"x7\", \"x8\", \"x9\", \"x10\"], :y=>[\"y1\", \"y2\", \"y3\", \"y4\", \"y5\", \"y6\", \"y7\", \"y8\", \"y9\", \"y10\"]}], @layout={:width=>500, :height=>500}, @config={:linkText=>\"Export to plot.ly\", :showLink=>true}, @embedded=true>"
       ]
      },
      "metadata": {},

data/lib/plotly/axis.rb

@@ -4,9 +4,12 @@ module Plotly
   class Axis
     include Castable
 
-    ATTRS = %i(title range).freeze
+    ATTRS = %i(title range zeroline).freeze
     attr_accessor(*ATTRS)
 
+    # @option opts [String] title
+    # @option opts [Array] range
+    # @option opts [Boolean] zeroline
     def initialize(opts)
       return unless opts.is_a?(Hash)
       opts.each { |k, v| instance_variable_set("@#{k}", v) }

data/lib/plotly/client.rb

@@ -3,14 +3,6 @@ require 'base64'
 require 'json'
 
 module Plotly
-  class << self
-    attr_reader :client
-
-    def auth(username, api_key)
-      @client = Client.new(username, api_key)
-    end
-  end
-
   class Client
     attr_reader :conn
 
@@ -37,4 +29,17 @@ module Plotly
       }
     end
   end
+
+  class << self
+    # Set the default client which is automatically used when any clients aren't assigned.
+    def auth(username, api_key)
+      @client = Client.new(username, api_key)
+    end
+
+    # @return [Plotly::Client]
+    # @raise [RuntimeError]
+    def client
+      @client ? @client : raise('Authentication required')
+    end
+  end
 end

data/lib/plotly/data.rb

@@ -1,10 +1,11 @@
 require 'plotly/castable'
+require 'plotly/marker'
 
 module Plotly
   class Data
     include Castable
 
-    attr_accessor :x, :y, :z, :values, :labels, :mode, :type, :name, :colorscale
+    attr_accessor :x, :y, :z, :values, :labels, :mode, :type, :name, :text, :colorscale, :marker
 
     # @option opts [Array] x
     # @option opts [Array] y
@@ -14,9 +15,19 @@ module Plotly
     # @option opts [String] mode
     # @option opts [String] type
     # @option opts [String] name
+    # @option opts [Array] text array of strings
     # @option opts [Array] colorscale
+    # @option opts [Hash or Plotly::Marker] marker
     def initialize(opts = {})
-      opts.each { |k, v| instance_variable_set("@#{k}", v) }
+      opts.each do |k, v|
+        v.convert_to(Plotly::Marker) if k == marker
+        instance_variable_set("@#{k}", v)
+      end
+    end
+
+    def marker=(marker)
+      marker.convert_to(Plotly::Marker)
+      @marker = marker
     end
   end
 end

data/lib/plotly/layout.rb

@@ -1,5 +1,5 @@
-require 'plotly/axis'
 require 'plotly/castable'
+require 'plotly/axis'
 
 module Plotly
   class Layout

data/lib/plotly/line.rb

@@ -0,0 +1,17 @@
+require 'plotly/castable'
+
+module Plotly
+  class Line
+    include Castable
+
+    ATTRS = %i(width color).freeze
+    attr_accessor(*ATTRS)
+
+    # @option opts [Fixnum] width
+    # @option opts [String] color 'rgba(0, 0, 200, .5)'
+    def initialize(opts)
+      return unless opts.is_a?(Hash)
+      opts.each { |k, v| instance_variable_set("@#{k}", v) }
+    end
+  end
+end

data/lib/plotly/marker.rb

@@ -0,0 +1,23 @@
+require 'plotly/castable'
+require 'plotly/line'
+
+module Plotly
+  class Marker
+    include Castable
+
+    ATTRS = %i(size color opacity line).freeze
+    attr_accessor(*ATTRS)
+
+    # @option opts [Fixnum] size
+    # @option opts [String] color e.g.'rgba(0, 0, 200, .5)'
+    # @option opts [Hash or Plotly::Line] line
+    def initialize(opts)
+      return unless opts.is_a?(Hash)
+
+      opts.each do |k, v|
+        v.convert_to(Plotly::Line) if k.to_sym == :line
+        instance_variable_set("@#{k}", v)
+      end
+    end
+  end
+end

data/lib/plotly/offline/exportable.rb

@@ -20,6 +20,11 @@ module Plotly
         Launchy.open(File.absolute_path(path)) if open
       end
 
+      def to_html
+        html = create_html(@data, layout: @layout, embedded: true)
+        html.render
+      end
+
       private
 
       def create_html(data, layout: {}, embedded: false)

data/lib/plotly/plot.rb

@@ -21,18 +21,6 @@ module Plotly
       @layout = layout.convert_to(Plotly::Layout)
     end
 
-    # @param data [Plotly::Data or Hash]
-    def add_data(data = Data.new)
-      @data.push begin
-        case data
-        when Data then data
-        when Hash then Data.new(data)
-        end
-      end
-    end
-
-    # @todo add remove_data method
-
     # @param data [Array] list of Hash or Plotly::Data objects
     def data=(data)
       raise unless data.is_a?(Array)

data/lib/plotly/version.rb

@@ -1,3 +1,3 @@
 module Plotly
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/rbplotly.gemspec

@@ -6,10 +6,12 @@ require 'plotly/version'
 Gem::Specification.new do |spec|
   spec.name          = 'rbplotly'
   spec.version       = Plotly::VERSION
-  spec.authors       = ['y4ashida']
+  spec.authors       = ['ash1day']
   spec.email         = ['y4ashida@gmail.com']
 
-  spec.summary       = 'Plot.ly API client and Interface to plotly.js.'
+  spec.summary       = 'a Ruby visualization library'
+  spec.description   = 'Rbplotly, a Ruby visualization library, ' \
+                       'allows you to create interactive plots.'
   spec.homepage      = 'https://github.com/y4ashida/rbplotly'
   spec.license       = 'MIT'
 
@@ -18,14 +20,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'faraday',            '~> 0.9'
-  spec.add_dependency 'uuidtools',          '~> 2.1'
-  spec.add_dependency 'launchy',            '~> 2.4'
+  spec.add_dependency 'faraday',   '~> 0.9'
+  spec.add_dependency 'uuidtools', '~> 2.1'
+  spec.add_dependency 'launchy',   '~> 2.4'
 
   spec.add_development_dependency 'bundler',       '~> 1.12'
-  spec.add_development_dependency 'rake',          '~> 10.0'
-  spec.add_development_dependency 'rspec',         '~> 3.5'
   spec.add_development_dependency 'guard-rspec',   '~> 4.7'
   spec.add_development_dependency 'guard-rubocop', '~> 1.2'
+  spec.add_development_dependency 'rake',          '~> 11.2'
+  spec.add_development_dependency 'rspec',         '~> 3.5'
   spec.add_development_dependency 'yard',          '~> 0.9'
+
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbplotly
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- y4ashida
+- ash1day
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-28 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -67,61 +67,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.12'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
-  name: guard-rubocop
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +136,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: 
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: Rbplotly, a Ruby visualization library, allows you to create interactive
+  plots.
 email:
 - y4ashida@gmail.com
 executables: []
@@ -156,19 +171,21 @@ files:
 - bin/console
 - bin/setup
 - docs/images/line_chart.png
-- examples/basic_bar_chart.ipynb
-- examples/basic_histogram.ipynb
-- examples/basic_pie_chart.ipynb
-- examples/grouped_bar_chart.ipynb
+- examples/Bar  Charts.ipynb
+- examples/Basic Usage.ipynb
+- examples/Histograms.ipynb
+- examples/Line charts.ipynb
+- examples/Pie Charts.ipynb
+- examples/Scatter Plots.ipynb
 - examples/heatmaps.ipynb
-- examples/line_and_scatter_plots.ipynb
-- examples/stacked_bar_chart.ipynb
 - lib/plotly/axis.rb
 - lib/plotly/castable.rb
 - lib/plotly/client.rb
 - lib/plotly/data.rb
 - lib/plotly/exportable.rb
 - lib/plotly/layout.rb
+- lib/plotly/line.rb
+- lib/plotly/marker.rb
 - lib/plotly/offline/exportable.rb
 - lib/plotly/offline/html.rb
 - lib/plotly/offline/plotly.min.js
@@ -199,8 +216,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: Plot.ly API client and Interface to plotly.js.
+summary: a Ruby visualization library
 test_files: []