chart_bibz 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6df699587ec922c251c5c46d1a9b07dfec59e7af8f555df7b9e89543bd5f62ae
-  data.tar.gz: 1aec799a23b9c11c098a4e0b0cbd2f7fd3eec856828bce253a8b276ed0a715e4
+  metadata.gz: 8340301db148379344f907087206294a3f9936ab872e7ba093224fba40623d5a
+  data.tar.gz: 9bec2b998ced586af65237ccd0667da5658cafdb8a25c205debe670fdc0601e0
 SHA512:
-  metadata.gz: c4e53911af3059f3afbcb0d57212a8526734872b50025d05cc30b9522882f6414f6c60907b9e69bc318dc3d770fa7c5e67efc22e814948c2bc8fec4a6a6ee7d7
-  data.tar.gz: 97078b7ebe824c85587fcc9ef96b0392be653b09fe0a79b19107186afc1c1b109d03195d820bd8e4d517e8253849a82daed55da1b87133c5b85592eabd99a576
+  metadata.gz: bfe263f9fe1f7ae798630a32c82af6b8b3e95b058bad2b93afbb6bfa8f9d89e41376bbda4d411af4cc908c47bdc1b923c8f35a515b24c611773003405f2259b1
+  data.tar.gz: 996431bc8d191d857c75554de16c1f458d19c37cf4e60239432f56b917c30cf5c0ee3d9d6d89ff5bb702e937216f685584a464586d481b7fa1f4156310ca3452

data/lib/chart_bibz.rb

@@ -2,6 +2,7 @@
 
 require 'chart_bibz/railtie'
 
+# The Main module for ChartBibz
 module ChartBibz
   extend ActiveSupport::Autoload
 

data/lib/chart_bibz/helpers/chart_helper.rb

@@ -1,8 +1,24 @@
 # frozen_string_literal: true
 
+# The Main module
 module ChartBibz
+  # Add the Helpers module to Chart Bibz
   module Helpers
-    module ChartHelper # rubocop:disable Style/Documentation
+    # Helper for chart bibz
+    module ChartHelper
+      # Generate the html of the canvas
+      #
+      # @example Generate the canvas
+      #   chart {datasets: {data: [1,2,3]}}, {type: :bar}, {class: "My-chart"}
+      #
+      # @see ChartBibz::ViewComponents::ChartViewComponent#initialize
+      #
+      # @param [Hash] data
+      # @param [Hash] options
+      # @param [Hash] html_options
+      # @return [String] HTML
+      #
+      # @api public
       def chart(data = {}, options = {}, html_options = {})
         ChartBibz::ViewComponents::ChartViewComponent.new(data, options, html_options).render
       end

data/lib/chart_bibz/version.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# The Main Module
 module ChartBibz
-  VERSION = '0.1.0'
+  # The current version of Chart Bibz
+  VERSION = '0.1.1'
 end

data/lib/chart_bibz/view_components/application_view_component.rb

@@ -1,16 +1,37 @@
 # frozen_string_literal: true
 
 module ChartBibz
+  # A batch of view components
   module ViewComponents
-    class ApplicationViewComponent # rubocop:disable Style/Documentation
+    # The view components base
+    class ApplicationViewComponent
       include ActionView::Helpers::TagHelper
       include ActionView::Helpers::CaptureHelper
       include ActionView::Helpers::TextHelper
       include ActionView::Helpers::TranslationHelper
+
+      # ActionView::Helpers::TagHelper need of this
+      #
+      # @example
+      #   tag.div "content"
+      #
+      # @param [Object] output_buffer
+      # @return [Object] the output_buffer
+      #
+      # @api public
       attr_accessor :output_buffer
 
       protected
 
+      # Create a list of classes in a string
+      #
+      # @example Generate the canves
+      #   join_classes(["test1", "test2"], :test3, "test4")
+      #
+      # @param [String, Symbol, Hash] classes The class names
+      # @return [String] The list of the classes
+      #
+      # @api semipublic
       def join_classes(*classes)
         klasses = Array(classes).flatten.map(&:to_s).compact.uniq.reject(&:blank?)
         klasses.empty? ? nil : klasses

data/lib/chart_bibz/view_components/canvas_view_component.rb

@@ -5,33 +5,64 @@ module ChartBibz
     # Generate the canvas view through the render method
     class CanvasViewComponent < ApplicationViewComponent
       # Constants
-      WIDTH = 400
-      HEIGHT = 400
 
-      # @param args [Hash] The html options
+      WIDTH = 400 # Default width for the html canvas
+      HEIGHT = 400 # Default height for the html canvas
+
+      # Only html_options can be passed
+      #
+      # @example
+      #   ChartBibz::ViewComponents::CanvasViewComponent.new(class: 'test')
+      #
+      # @param [Hash] args The html options
       # @return [void]
+      #
+      # @api public
       def initialize(args = {})
         @args = args
       end
 
       # Generate the html canvas
+      #
+      # @example
+      #   ChartBibz::ViewComponents::CanvasViewComponent.new(class:
+      #   'test').render
+      #
       # @return [String] The html canvas
+      #
+      # @api public
       def render
         tag.canvas(**html_options)
       end
 
+      # Get the id
+      #
+      # @example
+      #   ChartBibz::ViewComponents::CanvasViewComponent.new(class: 'test').id
+      #
       # @return [String] The canvas html id
+      #
+      # @api public
       def id
         html_options[:id]
       end
 
       private
 
+      # Get all html options
+      #
       # @return [String] The canvas html attributes
+      #
+      # @api private
       def html_options
         @html_options ||= base_html_options.merge(@args).merge(class: join_classes('chart-bibz', @args[:class]))
       end
 
+      # Get the html options base
+      #
+      # @return [String] The canvas html attributes
+      #
+      # @api private
       def base_html_options
         { id: "chart-#{Random.uuid}", width: WIDTH, height: HEIGHT, role: 'img' }
       end

data/lib/chart_bibz/view_components/chart_view_component.rb

@@ -7,6 +7,11 @@ module ChartBibz
       # @see CanvasViewComponent#id
       delegate :id, to: :canvas
 
+      # Need of CanvasViewComponent to work
+      #
+      # @example
+      #   ChartBibz::ViewComponents::ChartViewComponent.new(data, options, html_options)
+      #
       # @param data [Hash] the chartjs data
       # @param options [Hash] the chartjs options
       # @option options [Symbol] :type The chart type [:bar, :line, ...]
@@ -16,24 +21,45 @@ module ChartBibz
       # @option html_options [String] :class The class of the canvas
       #
       # @return [void]
+      #
+      # @api public
       def initialize(data = {}, options = {}, html_options = {})
         @data = data
         @options = options
         @html_options = html_options
       end
 
+      # Generate the html canvas
+      #
+      # @example
+      #   ChartBibz::ViewComponents::ChartViewComponent.new(data, options, html_options).render
+      #
+      # @see ChartBibz::ViewComponents::CanvasViewComponent#canvas
       # @return [String] The canvas html
+      #
+      # @api public
       delegate :render, to: :canvas
 
+      # Get the Canvas with new html_options
+      #
+      # @example
+      #   ChartBibz::ViewComponents::ChartViewComponent.new(data, options, html_options).canvas
+      #
       # @see CanvasViewComponent
       # @return [Object] The canvas object
+      #
+      # @api public
       def canvas
         @canvas ||= CanvasViewComponent.new(new_html_options)
       end
 
       private
 
+      # Update html_options
+      #
       # @return [Hash] The new html options with the data attributes
+      #
+      # @api private
       def new_html_options
         @html_options['data-cb-data'] = @data.to_json
         @html_options['data-cb-type'] = @options.delete(:type) || :bar
@@ -42,6 +68,11 @@ module ChartBibz
         @html_options
       end
 
+      # Create an aria lable
+      #
+      # @return [String]
+      #
+      # @api private
       def aria_label
         @options[:title].nil? ? 'Chart' : "Chart of #{@options[:title]}"
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chart_bibz
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Thomas HUMMEL
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-11 00:00:00.000000000 Z
+date: 2021-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: overcommit
@@ -142,6 +142,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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