bulmacomp 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b5fe720844eeb9706a76791f3ded3fc1c010fa7442ea375ad69d071bf598bb6
-  data.tar.gz: 666b242522a9ee87094bf1b4f47e294e41403910b845b72d4594de7fe7bde296
+  metadata.gz: cca92c1cfc4fc572cea80c7ee338c832a08aa6f0c7d04440a8ac97a4195c646a
+  data.tar.gz: 27ec3921e02f138e0b15899c0f2b692df1ab04acc404af28625bbb50a07d0c5a
 SHA512:
-  metadata.gz: 8892fb3dbcce0a46f8ad1238b927e96d6bb0830875ba686600ac557f3446da9cccc64d34c90430f81fc438f0263c8acd0d7c02102410f3081d43813010db7334
-  data.tar.gz: ec3f10a435462824fd2f67e743daf9a0f978595c1a47fe3004821032d7c13a6951a605127b9ec12ea468bf64467b0e69367b1a366f110bcc9cfd87c6dbf13007
+  metadata.gz: 0eb90226ba08d590548c98f9ea4cfac9a4394e1b5520a9c12ef0a96d093187dafa7483fcd187e378f8900c2dee14fc1019c55f585ab975ad8a82894f94cb628a
+  data.tar.gz: 2a18563aeab3591580bcc40bd05bcdb2017e98b79581d04fa7444e9aff22733b73dd572811f78912ffd76bf66e7d0c44c4f3a0f296db4b34e9779175934a2563

data/README.md

@@ -1,8 +1,10 @@
 # Bulmacomp
-[https://viewcomponent.org/](ViewComponent) collection for [https://bulma.io/](bulma) css framework
+[![Maintainability](https://api.codeclimate.com/v1/badges/b44e91b4f303eb7962b3/maintainability)](https://codeclimate.com/github/isprambiente/bulmacomp/maintainability)
+[![Rails Test](https://github.com/isprambiente/bulmacomp/actions/workflows/rubyonrails.yml/badge.svg)](https://github.com/isprambiente/bulmacomp/actions/workflows/rubyonrails.yml)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](https://www.rubydoc.info/github/isprambiente/bulmacomp)
 
-## Usage
-How to use my plugin.
+
+[https://viewcomponent.org/](ViewComponent) collection for [https://bulma.io/](bulma) css framework
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,6 +23,9 @@ Or install it yourself as:
 $ gem install bulmacomp
 ```
 
+## Usage
+How to use my plugin.
+
 ## Contributing
 Contribution directions go here.
 

data/app/components/bulmacomp/breadcrumb_component.rb

@@ -11,9 +11,9 @@ module Bulmacomp
   #     </ul>
   #   </nav>
   #
-  # @example Breadcrumb with list element:
-  #   entries = link_to('one','#'), link_to('two','#')
-  #   render Bulmacomp::BreadcrumbComponent.new(entries)
+  # @example Breadcrumb with elements:
+  #   elements = [link_to('one','#'), link_to('two','#')]
+  #   render Bulmacomp::BreadcrumbComponent.new(elements: elements)
   #   <nav class="breadcrumb" aria-label="breadcrumbs">
   #     <ul>
   #       <li><a href="#">one</a></li>
@@ -32,16 +32,16 @@ module Bulmacomp
   #    </ul>
   #   </nav>
   class BreadcrumbComponent < ViewComponent::Base
-    # @param [Array<String>] list
-    #   Any number of Objects to push into this collection
     # @param [Hash] opts
     #   options to generate content
+    # @param [Array<String>] elements
+    #   array of elements to push into this breadcrumbs collection
     # @option opts [String] :*
     #   each other key going as tag option, default is class: 'breadcrumb', aria_label: 'breadcrumbs'
-    # @yield [optional] card content
-    def initialize(list = [], **opts)
+    # @yield [optional] breadcrumb content
+    def initialize(elements: [], **opts)
       super
-      @list = list
+      @elements = elements
       @opts = { class: 'breadcrumb', aria: { label: 'breadcrumbs' } }.merge(opts)
     end
 
@@ -50,9 +50,9 @@ module Bulmacomp
       tag.nav tag.ul(ul_content), **@opts
     end
 
-    # @return [Text], safe join of list arguments and proc content
+    # @return [Text], safe join of elements arguments and proc content
     def ul_content
-      safe_join(@list.map { |e| tag.li(e) }.<<(content))
+      safe_join(@elements.map { |e| tag.li(e) }.<<(content))
     end
   end
 end

data/app/components/bulmacomp/menu_component.rb

@@ -8,10 +8,10 @@ module Bulmacomp
   #
   #   <aside class='menu'></aside>
   #
-  # @example menu with title and entries
+  # @example menu with title and elements
   #   title = 'Menu title'
-  #   menu  = [link_to('first entry', '#'), link_to('second entry', '#')
-  #   render Bulmacomp::MenuComponent.new(menu, title: title)
+  #   elements  = [link_to('first entry', '#'), link_to('second entry', '#')
+  #   render Bulmacomp::MenuComponent.new(elements: elements, title: title)
   #
   #   <aside class='menu'>
   #     <p class='menu-label'>Menu title</p>
@@ -21,9 +21,9 @@ module Bulmacomp
   #     </ul>
   #   </aside>
   #
-  # @example menu with title and annidate entries
-  #   entries = ['Uno',['Due',['Tre','Quattro']]]
-  #   = render Bulmacomp::MenuComponent.new(entries)
+  # @example menu with title and annidate elements
+  #   elements = ['Uno',['Due',['Tre','Quattro']]]
+  #   = render Bulmacomp::MenuComponent.new(elements: elements)
   #
   #   <aside class='menu'>
   #     <p class='menu-label'>Uno</p>
@@ -47,8 +47,8 @@ module Bulmacomp
   #   </aside>
   #
   # @example with mixed conetent (arguments before)
-  #   entries = ['argument content',['argoument menu']]
-  #   = render Bulmacomp::MenuComponent.new(entries) do
+  #   elements = ['argument content',['argoument menu']]
+  #   = render Bulmacomp::MenuComponent.new(elements: elements) do
   #     %p yield content
   #
   #   <aside class='menu'>
@@ -60,22 +60,22 @@ module Bulmacomp
   #   </aside>
   #
   class MenuComponent < ViewComponent::Base
-    # @param [Array<String,Array>] list
-    #   each entry is used to generate menu entries throug {first_level} method
     # @param [Hash] opts
     #   options to generate content
+    # @option opts [Array<String>] elements
+    #   each entry is used to generate menu elements throug {first_level} method
     # @option opts [String] :*
     #   each key going as tag option, default is class: 'menu'
-    def initialize(list = [], **opts)
+    def initialize(elements: [], **opts)
       super
-      @list = list
+      @elements = elements
       @opts = { class: 'menu' }.merge(opts)
     end
 
     # Generate an html safe string with full bulma menu.
     # @return [String] html string menu
     def call
-      tag.aside first_level(@list) + content, **@opts
+      tag.aside first_level(@elements) + content, **@opts
     end
 
     # Generate a string with all bulma menu element from `values` param.
@@ -84,7 +84,7 @@ module Bulmacomp
     # * as `p.menu-title` tag if is not an Array
     # * as {map_menu} if is an Array
     # @return [String]
-    # @param [Array] values menu entries
+    # @param [Array] values menu elements
     # @example
     #   Bulmacomp::MenuComponent.new().first_level(['Uno',['Due','Tre']])
     #
@@ -95,14 +95,14 @@ module Bulmacomp
       )
     end
 
-    # Generate a string with the "real" menu entries (no title)
-    # from 'values' param. The menu entries are incapsulated in a ul tag
+    # Generate a string with the "real" menu elements (no title)
+    # from 'values' param. The menu elements are incapsulated in a ul tag
     #
     # Each element in 'values' is mapped:
     # * as li tag if is not an Array
     # * as {sub_menu} if is an Array
     # @return [String]
-    # @param [Array] values menu entries
+    # @param [Array] values menu elements
     # @example
     #   Bulmacomp::MenuComponent.new().map_menu(['Uno',['Due','Tre']])
     #
@@ -115,7 +115,7 @@ module Bulmacomp
     # The first array element is used as ancescor, other element
     # are used to make the sub menu with {map_menu} method.
     # @return [String]
-    # @param [Array] values sub-menu entries
+    # @param [Array] values sub-menu elements
     # @example
     #   Bulmacomp::MenuComponent.new().sub_menu(['Uno',['Due','Tre']])
     #

data/app/components/bulmacomp/panel_component.rb

@@ -29,14 +29,13 @@ module Bulmacomp
     # @option opts [String] :title
     #   panel title
     # @option opts [String] :*
-    #   each other key going as tag option, default is class: 'breadcrumb', aria_label: 'breadcrumbs'
+    #   each other key going as tag option, default is class: 'panel'
     # @yield [optional]
     #   panel content
     def initialize(title: nil, **opts)
       super
       @title = title
-      @opts = opts
-      @opts[:class] = 'panel' unless @opts[:class]
+      @opts = { class: 'panel' }.merge(opts)
     end
 
     # return [String] html_safe generated bulma panel

data/app/components/bulmacomp/tabs_component.rb

@@ -3,16 +3,16 @@
 module Bulmacomp
   # Make an HTML strucrure for a bulma tabs
   #
-  # @example Empty tabs
+  # @example
   #   render Bulmacomp::TabsComponent.new()
   #
   #   <div class="tabs">
   #     <ul></ul>
   #   </div>
   #
-  # @example Tabs with elements
-  #   entries = [link_to('one','#'), link_to('two','#')]
-  #   render Bulmacomp::TabsComponent.new(entries: entries)
+  # @example tabs with elements
+  #   elements = [link_to('one','#'), link_to('two','#')]
+  #   render Bulmacomp::TabsComponent.new(elements: elements)
   #
   #   <div class="tabs">
   #     <ul>
@@ -21,62 +21,50 @@ module Bulmacomp
   #     </ul>
   #   </div>
   #
-  # @example yield
+  # @example tabs with yield content
   #   = render Bulmacomp::TabsComponent.new() do
-  #     <li class="active"><a href='#'>one</a></li>
+  #     %li some text
   #
   #   <div class="tabs">
   #     <ul>
-  #       <li class="active"><a href='#'>one</a></li>
+  #       <li>some text</li>
   #     </ul>
   #   </div>
   #
-  # @example Full tabs
-  #   entries = [link_to('one','#'), link_to('two','#')]
-  #   = render Bulmacomp::TabsComponent.new(entries: entries, id: 'ok') do
-  #     <li class="active"><a href='#'>three</a></li>
+  # @example tabs with full options
+  #   elements = [link_to('one','#'), link_to('two','#')]
+  #   = render Bulmacomp::TabsComponent.new(elements: elements, id: 'ok') do
+  #     %li some text
   #
   #   <div class="tabs" id="ok">
   #     <ul>
   #       <li><a href='#'>one</li>
   #       <li><a href='#'>two</li>
-  #       <li class="active"><a href='#'>three</a></li>
+  #       <li>some text</li>
   #     </ul>
   #   </div>
   class TabsComponent < ViewComponent::Base
     # @param [Hash] opts
     #   options to generate content
-    # @option opts [Array<String>] element
-    #   elements list for build tabs
+    # @param [Array<String>] elements
+    #   array of elements for tabs collection
     # @option opts [String] :*
-    #   each key going as tag option, default is class: 'tabs'
-    # @yield [optional] modal content
+    #   each other key going as tag option, default is class: 'tabs'
+    # @yield [optional] tabs content
     def initialize(elements: [], **opts)
       super
       @elements = elements
-      @opts = { class: 'tabs' }.merge opts
+      @opts = { class: 'tabs' }.merge(opts)
     end
 
-    # Generate safe string with full bulma tabs
-    # @return [String] html_safe generated bulma tabs
+    # @return [String] html_safe tabs
     def call
-      tag.div ulify, **@opts
+      tag.div tag.ul(ul_content), **@opts
     end
 
-    # generate a ul tag with map_elements and content
-    # @return [String]
-    def ulify
-      tag.ul safe_join([map_elements, content])
-    end
-
-    # Map elements in a li tag
-    # @return [String]
-    # @example
-    #   Bulmacomp::TabsComponent.new(elements).map_elements
-    #
-    #   <li>1</li><li>2</li><li>3</li>
-    def map_elements
-      safe_join(@elements.map { |e| tag.li e })
+    # @return [Text], safe join of elements arguments and proc content
+    def ul_content
+      safe_join([@elements.map { |e| tag.li(e) }, content])
     end
   end
 end

data/lib/bulmacomp/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
 module Bulmacomp
-  # Costant of bulmacomp version
-  VERSION = '0.1.1'
+  VERSION = '0.1.2' # Costant of bulmacomp version
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bulmacomp
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - MDreW
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-22 00:00:00.000000000 Z
+date: 2023-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.4.2
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.4.2
+        version: '7.0'
 description: Collection of view components for bulma css framework
 email:
 - andrea.ranaldi@gmail.com