chart_bibz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6df699587ec922c251c5c46d1a9b07dfec59e7af8f555df7b9e89543bd5f62ae
+  data.tar.gz: 1aec799a23b9c11c098a4e0b0cbd2f7fd3eec856828bce253a8b276ed0a715e4
+SHA512:
+  metadata.gz: c4e53911af3059f3afbcb0d57212a8526734872b50025d05cc30b9522882f6414f6c60907b9e69bc318dc3d770fa7c5e67efc22e814948c2bc8fec4a6a6ee7d7
+  data.tar.gz: 97078b7ebe824c85587fcc9ef96b0392be653b09fe0a79b19107186afc1c1b109d03195d820bd8e4d517e8253849a82daed55da1b87133c5b85592eabd99a576

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Thomas HUMMEL
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+![Chart Bibz logo](https://raw.githubusercontent.com/thooams/chart_bibz/main/chart-bibz-logo.gif)
+
+# Chart Bibz
+Use Chartjs with ruby. Generate your chart in one ruby line.
+
+[![Gem Version](https://badge.fury.io/rb/chart_bibz.svg)](https://badge.fury.io/rb/chart_bibz)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7e8e319e9f7197593733/maintainability)](https://codeclimate.com/github/thooams/chart_bibz/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/7e8e319e9f7197593733/test_coverage)](https://codeclimate.com/github/thooams/chart_bibz/test_coverage)
+[![security](https://hakiri.io/github/thooams/chart_bibz/main.svg)](https://hakiri.io/github/thooams/chart_bibz/main)
+[![Ci](https://github.com/thooams/chart_bibz/workflows/CI/badge.svg)](https://github.com/thooams/chart_bibz/actions)
+[![Linter](https://github.com/thooams/chart_bibz/workflows/Linter/badge.svg)](https://github.com/thooams/chart_bibz/actions)
+[![Inline docs](http://inch-ci.org/github/thooams/chart_bibz.svg?branch=master)](http://inch-ci.org/github/thooams/chart_bibz)
+
+
+## Usage
+How to use the plugin.
+
+```ruby
+# @param data [Hash] Data
+# @param options [Hash] The chart type and the chartjs options
+# @param html_options [Hash] The canvas html options
+# @return [String] The Canvas Html
+chart data, options, html_options
+```
+
+## Example
+```ruby
+data = {
+  datasets: [{
+    barPercentage: 0.5,
+    barThickness: 6,
+    maxBarThickness: 8,
+    minBarLength: 2,
+    data: [10, 20, 30, 40, 50, 60, 70]
+  }]
+}
+options = { type: :bar, scales: { yAxes: [{ ticks: { beginAtZero: true } }] } }
+
+chart data
+# or
+chart data, options, { id: "my-chart", width: 100, height: 520 }
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chart_bibz'
+```
+
+And then execute:
+```bash
+$ bundle
+$ yarn add chart.js
+```
+
+Or install it yourself as:
+```bash
+$ gem install chart_bibz
+```
+
+Add this line in your js file, by example app/javascript/packs/application.js
+```js
+...
+document.querySelectorAll(".chart-bibz").forEach(function(canvasEl){
+  let type = canvasEl.getAttribute("data-cb-type")
+  let options = JSON.parse(canvasEl.getAttribute("data-cb-options"))
+  let data = JSON.parse(canvasEl.getAttribute("data-cb-data"))
+  let ctx  = canvasEl.getContext('2d')
+
+  new Chart(ctx, { type: type, data: data, options: options })
+})
+...
+```
+
+That's it !
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ChartBibz'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/chart_bibz.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'chart_bibz/railtie'
+
+module ChartBibz
+  extend ActiveSupport::Autoload
+
+  autoload :ViewComponents
+  autoload :Helpers
+end
+
+require 'chart_bibz/rails/engine'

data/lib/chart_bibz/helpers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ChartBibz
+  module Helpers
+    extend ActiveSupport::Autoload
+
+    autoload :ChartHelper
+  end
+end

data/lib/chart_bibz/helpers/chart_helper.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ChartBibz
+  module Helpers
+    module ChartHelper # rubocop:disable Style/Documentation
+      def chart(data = {}, options = {}, html_options = {})
+        ChartBibz::ViewComponents::ChartViewComponent.new(data, options, html_options).render
+      end
+    end
+  end
+end

data/lib/chart_bibz/rails/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ChartBibz
+  module Rails
+    class Engine < ::Rails::Engine  # rubocop:disable Style/Documentation
+      initializer 'chart_bibz.helpers' do
+        ActionView::Base.include ChartBibz::Helpers::ChartHelper
+      end
+    end
+  end
+end

data/lib/chart_bibz/railtie.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ChartBibz
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/chart_bibz/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ChartBibz
+  VERSION = '0.1.0'
+end

data/lib/chart_bibz/view_components.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ChartBibz
+  module ViewComponents
+    extend ActiveSupport::Autoload
+
+    autoload :ApplicationViewComponent
+    autoload :CanvasViewComponent
+    autoload :ChartViewComponent
+  end
+end

data/lib/chart_bibz/view_components/application_view_component.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ChartBibz
+  module ViewComponents
+    class ApplicationViewComponent # rubocop:disable Style/Documentation
+      include ActionView::Helpers::TagHelper
+      include ActionView::Helpers::CaptureHelper
+      include ActionView::Helpers::TextHelper
+      include ActionView::Helpers::TranslationHelper
+      attr_accessor :output_buffer
+
+      protected
+
+      def join_classes(*classes)
+        klasses = Array(classes).flatten.map(&:to_s).compact.uniq.reject(&:blank?)
+        klasses.empty? ? nil : klasses
+      end
+    end
+  end
+end

data/lib/chart_bibz/view_components/canvas_view_component.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ChartBibz
+  module ViewComponents
+    # Generate the canvas view through the render method
+    class CanvasViewComponent < ApplicationViewComponent
+      # Constants
+      WIDTH = 400
+      HEIGHT = 400
+
+      # @param args [Hash] The html options
+      # @return [void]
+      def initialize(args = {})
+        @args = args
+      end
+
+      # Generate the html canvas
+      # @return [String] The html canvas
+      def render
+        tag.canvas(**html_options)
+      end
+
+      # @return [String] The canvas html id
+      def id
+        html_options[:id]
+      end
+
+      private
+
+      # @return [String] The canvas html attributes
+      def html_options
+        @html_options ||= base_html_options.merge(@args).merge(class: join_classes('chart-bibz', @args[:class]))
+      end
+
+      def base_html_options
+        { id: "chart-#{Random.uuid}", width: WIDTH, height: HEIGHT, role: 'img' }
+      end
+    end
+  end
+end

data/lib/chart_bibz/view_components/chart_view_component.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module ChartBibz
+  module ViewComponents
+    # Generate the chart view through the render method
+    class ChartViewComponent < ApplicationViewComponent
+      # @see CanvasViewComponent#id
+      delegate :id, to: :canvas
+
+      # @param data [Hash] the chartjs data
+      # @param options [Hash] the chartjs options
+      # @option options [Symbol] :type The chart type [:bar, :line, ...]
+      #
+      # @param html_options [Hash] the html_options of the canvas
+      # @option html_options [String] :id The id of the canvas
+      # @option html_options [String] :class The class of the canvas
+      #
+      # @return [void]
+      def initialize(data = {}, options = {}, html_options = {})
+        @data = data
+        @options = options
+        @html_options = html_options
+      end
+
+      # @return [String] The canvas html
+      delegate :render, to: :canvas
+
+      # @see CanvasViewComponent
+      # @return [Object] The canvas object
+      def canvas
+        @canvas ||= CanvasViewComponent.new(new_html_options)
+      end
+
+      private
+
+      # @return [Hash] The new html options with the data attributes
+      def new_html_options
+        @html_options['data-cb-data'] = @data.to_json
+        @html_options['data-cb-type'] = @options.delete(:type) || :bar
+        @html_options['data-cb-options'] = @options.to_json
+        @html_options['aria-label'] = aria_label
+        @html_options
+      end
+
+      def aria_label
+        @options[:title].nil? ? 'Chart' : "Chart of #{@options[:title]}"
+      end
+    end
+  end
+end

data/lib/tasks/chart_bibz_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :chart_bibz do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: chart_bibz
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Thomas HUMMEL
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.3
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.3.4
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ChartJs with ruby.
+email:
+- thomas@hummel.link
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/chart_bibz.rb
+- lib/chart_bibz/helpers.rb
+- lib/chart_bibz/helpers/chart_helper.rb
+- lib/chart_bibz/rails/engine.rb
+- lib/chart_bibz/railtie.rb
+- lib/chart_bibz/version.rb
+- lib/chart_bibz/view_components.rb
+- lib/chart_bibz/view_components/application_view_component.rb
+- lib/chart_bibz/view_components/canvas_view_component.rb
+- lib/chart_bibz/view_components/chart_view_component.rb
+- lib/tasks/chart_bibz_tasks.rake
+homepage: https://github.com/thooams/chart_bibz
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: ChartJs with ruby.
+test_files: []