plotlyjs-ruby 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11eedef03cecfbf3bf36ace58ada3970b107617d5dd717fdda477775acfa8e37
-  data.tar.gz: bb3256dd8147a96913323821de39b4ce6a57e9c7451b9a1ec69193927c3fb451
+  metadata.gz: a197e55c26202f7b93aff2c9685fe4d6a08f2cdfdb2319354edee06d3b3ff205
+  data.tar.gz: bc4d718037ed01dbb71da967abc0d647f2ecfab73fd46d11dae1162619a2d3ca
 SHA512:
-  metadata.gz: 57aec7e1bbd4157074252372607272f5bcf458311c43e2484a9289dbee948d707fdc11caf558c7e5f4d617b404c02c93416b25ad7644a922a044850709e899ed
-  data.tar.gz: e0a1021c304196f097009cfbad65eb65d65c1a5650971bff7e2cd1485ea1aba783b3babcd2deb650b11f48c4925214cf386d5ac02c860b9bb9b35a090b632fbd
+  metadata.gz: c234c6549061049dd5b602b6d648389668b4e0bb80543b53d80b83077dbc1967dba0a936d6778da488e42e185de1628c47e0ce8e6df5fa1aa402968b5a592a4c
+  data.tar.gz: b35dd982e5653902152675b7fc3f5ef7287d62babfb33dce8bc27d59a73fa42ad42aa56b84c57e5dd8e64c6676637187920e30495321e90dc1ce2696ae0a4baf

data/README.md

@@ -1,35 +1,53 @@
-# Plotlyjs::Ruby
+# Plotlyjs Ruby
 
-TODO: Delete this and the text below, and describe your gem
-
-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/plotlyjs/ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+A lightweight and straightforward Ruby wrapper for Plotly.js, enabling developers to create interactive, high-quality data visualizations effortlessly.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+1. Add this line to your application's Gemfile:
 
-Install the gem and add to the application's Gemfile by executing:
+    ```ruby
+    gem "plotlyjs-ruby"
+    ```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+2. Run the following command to pin plotly.js-dist in the import map:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+    ```bash
+    bin/importmap pin plotly.js-dist
+    ```
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+3. Add the following code to `app/javascript/application.js`:
 
-## Usage
+    ```js
+    import Plotly from "plotly.js-dist"
 
-TODO: Write usage instructions here
+    window.Plotly = Plotly
+    ```
+
+## Usage
 
-## Development
+### Basic Usage
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To create a basic plot, use the following code in your view:
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```erb
+<%= Plotlyjs.new_plot(
+  [{ x: [1, 2, 3, 4, 5] }, { y: [1, 2, 4, 8, 16]}],
+  { width: 600, height: 250, margin: { t: 0 } }
+) %>
+```
 
-## Contributing
+### Global Configuration
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/plotlyjs-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/plotlyjs-ruby/blob/master/CODE_OF_CONDUCT.md).
+To set options for all of your charts, create an initializer file `config/initializers/plotlyjs-ruby.rb` with:
 
-## Code of Conduct
+```ruby
+Plotlyjs.configure do |config|
+  config.options = {
+    responsive: true,
+    displayModeBar: false
+  }
+end
+```
 
-Everyone interacting in the Plotlyjs::Ruby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/plotlyjs-ruby/blob/master/CODE_OF_CONDUCT.md).
+For more details, follow the [Plotly Getting Started Guide](https://plot.ly/javascript/getting-started/).

data/lib/plotlyjs/chart.rb

@@ -0,0 +1,40 @@
+module Plotlyjs
+  class Chart
+    attr_reader :data, :layout, :config
+
+    def initialize(data, layout, config)
+      @data = data
+      @layout = layout
+      @config = config
+    end
+
+    def to_html
+      element_id = "plotly-chart-#{self.object_id}"
+
+      js_vars = {
+        data: data.to_json,
+        layout: layout.to_json,
+        config: config.to_json
+      }
+
+      createjs = "Plotly.newPlot('#{element_id}', %{data}, %{layout}, %{config});" % js_vars
+
+      html = <<~HTML
+        <div id="#{element_id}"></div>
+        <script>
+          (function() {
+            var createChart = function() { #{createjs} };
+
+            if ("Plotly" in window) {
+              createChart();
+            } else {
+              window.addEventListener('load', createChart);
+            };
+          })();
+        </script>
+      HTML
+
+      html.respond_to?(:html_safe) ? html.html_safe : html
+    end
+  end
+end

data/lib/plotlyjs/config.rb

@@ -0,0 +1,9 @@
+module Plotlyjs
+  class Config
+    attr_accessor :options
+
+    def initialize
+      @options = {}
+    end
+  end
+end

data/lib/plotlyjs/utils.rb

@@ -0,0 +1,12 @@
+module Plotlyjs
+  module Utils
+    def self.deep_merge(hash_a, hash_b)
+      hash_a = hash_a.dup
+      hash_b.each_pair do |k, v|
+        tv = hash_a[k]
+        hash_a[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? deep_merge(tv, v) : v
+      end
+      hash_a
+    end
+  end
+end

data/lib/plotlyjs/version.rb

@@ -1,3 +1,3 @@
 module Plotlyjs
-  VERSION = "0.1.4"
+  VERSION = "0.2.0"
 end

data/lib/plotlyjs-ruby.rb

@@ -1,51 +1,25 @@
 require 'json'
 
+require_relative 'plotlyjs/chart'
+require_relative 'plotlyjs/config'
+require_relative 'plotlyjs/utils'
 require_relative 'plotlyjs/version'
 
 module Plotlyjs
   class << self
     def new_plot(data, layout = {}, config = {})
-      chart = Chart.new(data, layout, config)
+      merged_config = Plotlyjs::Utils.deep_merge(configuration.options, config)
+
+      chart = Chart.new(data, layout, merged_config)
       chart.to_html
     end
-  end
 
-  class Chart
-    attr_reader :data, :layout, :config
-
-    def initialize(data, layout, config)
-      @data = data
-      @layout = layout
-      @config = config
+    def configuration
+      @configuration ||= Config.new
     end
 
-    def to_html
-      element_id = "plotly-chart-#{self.object_id}"
-
-      js_vars = {
-        data: data.to_json,
-        layout: layout.to_json,
-        config: config.to_json
-      }
-
-      createjs = "Plotly.newPlot('#{element_id}', %{data}, %{layout}, %{config});" % js_vars
-
-      html = <<~HTML
-        <div id="#{element_id}"></div>
-        <script>
-          (function() {
-            var createChart = function() { #{createjs} };
-
-            if ("Plotly" in window) {
-              createChart();
-            } else {
-              window.addEventListener('load', createChart);
-            };
-          })();
-        </script>
-      HTML
-
-      html.respond_to?(:html_safe) ? html.html_safe : html
+    def configure
+      yield(configuration)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plotlyjs-ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - nightswinger
@@ -25,6 +25,9 @@ files:
 - README.md
 - Rakefile
 - lib/plotlyjs-ruby.rb
+- lib/plotlyjs/chart.rb
+- lib/plotlyjs/config.rb
+- lib/plotlyjs/utils.rb
 - lib/plotlyjs/version.rb
 - sig/plotlyjs/ruby.rbs
 homepage: https://github.com/nightswinger/plotlyjs-ruby