bulmacomp 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aba376c1b9ab6ef2532c7c313e28621f910c5959bf0285ce268e2936983ae0c1
-  data.tar.gz: 5462a699bc0b4fd5985674230ce986a3db9ed7cec16bcd2e098ab234e0793a72
+  metadata.gz: cca92c1cfc4fc572cea80c7ee338c832a08aa6f0c7d04440a8ac97a4195c646a
+  data.tar.gz: 27ec3921e02f138e0b15899c0f2b692df1ab04acc404af28625bbb50a07d0c5a
 SHA512:
-  metadata.gz: 9b4c29854e9bbb3dd9283b698633578d5b8b1c9b0b4868fa919ff392aa1690faa1f59c7cb4e031212d93ddbbde8a3ed966d624b1511dc84d4b83843d82e9d13f
-  data.tar.gz: 62b1d229680c06b33f75ae136c60999f4942e9f768d01f5ca33d56b1c53c327b33d6f74a6633e58a3835516b5ec16e96854324c4912ba22877f8e51162ec8826
+  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,16 +11,9 @@ module Bulmacomp
   #     </ul>
   #   </nav>
   #
-  # @example Empty breadcrumb with option:
-  #   render Bulmacomp::BreadcrumbComponent.new(class: 'breadcrumb one', data: {entity: 'one'})
-  #
-  #   <nav class="breadcrumb one" aria-label="breadcrumbs" data-entity='one'>
-  #     <ul>
-  #     </ul>
-  #   </nav>
-  #
-  # @example Breadcrumb with list element:
-  #   render Bulmacomp::BreadcrumbComponent.new(link_to('one','#'), link_to('two','#'))
+  # @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>
@@ -39,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
 
@@ -57,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(title,menu)
+  #   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,8 +21,9 @@ module Bulmacomp
   #     </ul>
   #   </aside>
   #
-  # @example menu with title and annidate entries
-  #   = render Bulmacomp::MenuComponent.new('Uno',['Due',['Tre','Quattro']])
+  # @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>
@@ -46,7 +47,8 @@ module Bulmacomp
   #   </aside>
   #
   # @example with mixed conetent (arguments before)
-  #   = render Bulmacomp::MenuComponent.new('argument content',['argoument menu']) do
+  #   elements = ['argument content',['argoument menu']]
+  #   = render Bulmacomp::MenuComponent.new(elements: elements) do
   #     %p yield content
   #
   #   <aside class='menu'>
@@ -58,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.
@@ -82,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']])
     #
@@ -93,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']])
     #
@@ -113,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/message_component.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Bulmacomp
+  # Make an html structure for a bulma message
+  #
+  # @example Empty message
+  #   render Bulmacomp::MessageComponent.new()
+  #
+  #   <article class="message"></article>
+  #
+  # @example Message with title
+  #   render Bulmacomp::MessageComponent.new(title: 'test')
+  #
+  #   <article class="message">
+  #     <div class="message-header"><p>test</p></div>
+  #   </article>
+  #
+  # @example Message with close button and option
+  #   render Bulmacomp::MessageComponent.new(close: true, close_option: {id: 'close'})
+  #
+  #   <article class="message">
+  #     <div class="message-header"><button id="close" class="delete" aria-label="delete"></button></div>
+  #   </article>
+  #
+  # @example Message with yield content
+  #
+  #   <article class="message">
+  #     <div class="message-body">test</div>
+  #   </article>
+  class MessageComponent < ViewComponent::Base
+    # @param [Hash] opts
+    #   options to generate content
+    # @option opts [String] title
+    #   Title test, is added in 'article .message-header p' tag if present
+    # @option opts [Boolean] close
+    #   if TRUE add close button in title
+    # @option opts [Hash] close_option
+    #   parameters to close button tag
+    # @option opts [String] :*
+    #   each key going as article tag option, default is class: 'message'
+    # @yield [optional] message content
+    def initialize(title: nil, close: false, close_option: {}, **opts)
+      super
+      @title = title
+      @close = close
+      @close_option = close_option
+      @opts = { class: 'message' }.merge opts
+    end
+
+    # return [String] generated bulma message
+    def call
+      tag.article safe_join([header, tag.div(content, class: 'message-body')]), **@opts
+    end
+
+    # return [String] div.message-header if @title or @close is present
+    def header
+      ret = []
+      ret << tag.p(@title) if @title.present?
+      ret << tag.button(**{ class: 'delete', aria: { label: 'delete' } }.merge(@close_option)) if @close
+      tag.div safe_join(ret), class: 'message-header' if ret.present?
+    end
+  end
+end

data/app/components/bulmacomp/pagination_component.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Bulmacomp
+  # Make an HTML strucrure for a bulma pagination
+  #
+  # @example Empty pagination
+  #   render Bulmacomp::TabsComponent.new()
+  #
+  #  <nav class="pagination" role="navigation" aria-label="pagination"></nav>
+  #
+  # @example pagination with elements
+  #   elements = ['<a class="pagination-link" aria-label="Goto page 1">1</a>']
+  #   render Bulmacomp::TabsComponent.new(elements: elements)
+  #
+  #   <nav class="pagination" role="navigation" aria-label="pagination">
+  #     <ul class='pagination-list'>
+  #       <li><a class="pagination-link" aria-label="Goto page 1">1</a></li>
+  #     </ul>
+  #   </nav>
+  #
+  # @example with elements and pre
+  #   pre = [
+  #     link_to('Previus', '#', class: 'pagination-previous'),
+  #     link_to('Next', '#', class: 'pagination-next')
+  #     ]
+  #   elements = ['<a class="pagination-link" aria-label="Goto page 1">1</a>']
+  #   render Bulmacomp::TabsComponent.new(elements: elements, pre: pre)
+  #
+  #   <nav class="pagination" role="navigation" aria-label="pagination">
+  #    <a href="#" class="pagination-previous">Previous</a>
+  #    <a href="#" class="pagination-next">Next</a>
+  #     <ul class='pagination-list'>
+  #       <li><a class="pagination-link" aria-label="Goto page 1">1</a></li>
+  #     </ul>
+  #   </nav>
+  #
+  # @example with yield
+  #   = render Bulmacomp::TabsComponent.new() do
+  #     %li= link_to 'test', '#'
+  #
+  #   <nav class="pagination" role="navigation" aria-label="pagination">
+  #      <ul class='pagination-list'>
+  #        <li><a href='#'>test</a></li>
+  #      </ul>
+  #   </nav>
+  #
+  # @example full pagination
+  #   pre = [
+  #     link_to('Previus', '#', class: 'pagination-previous'),
+  #     link_to('Next', '#', class: 'pagination-next')
+  #     ]
+  #   elements = ['<a class="pagination-link" aria-label="Goto page 1">1</a>']
+  #
+  #   = render Bulmacomp::TabsComponent.new(elements: elements, pre: pre, id: 'ok') do
+  #     %li= link_to 'test', '#'
+  #
+  #   <nav class="pagination" role="navigation" aria-label="pagination" id="ok">
+  #    <a href="#" class="pagination-previous">Previous</a>
+  #    <a href="#" class="pagination-next">Next</a>
+  #     <ul class='pagination-list'>
+  #       <li><a class="pagination-link" aria-label="Goto page 1">1</a></li>
+  #       <li><a href='#'>test</a></li>
+  #     </ul>
+  #   </nav>
+  class PaginationComponent < ViewComponent::Base
+    # @param [Hash] opts
+    #   options to generate content
+    # @option opts [Array<String>] elements
+    #   elements list for build tabs
+    # @option opts [Array<String>] pre
+    #   element not in pagination list
+    # @option opts [String] :*
+    #   each key going as tag option, default:
+    #   * class: "pagination"
+    #   * role: "navigation"
+    #   * aria_label: "pagination"
+    # @yield [optional] modal content
+    def initialize(elements: [], pre: [], **opts)
+      super
+      @elements = elements
+      @pre = pre
+      @opts = { class: 'pagination', role: 'navigation', aria_label: 'pagination' }.merge opts
+    end
+
+    # Generate safe string with bulma pagination
+    # @return [String] html_safe generated bulma pagination
+    def call
+      tag.nav safe_join([@pre, ulify]), **@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: [1,2,3]).map_elements
+    #
+    #   <li>1</li><li>2</li><li>3</li>
+    def map_elements
+      safe_join(@elements.map { |e| tag.li e })
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Bulmacomp
+  # Make an HTML strucrure for a bulma tabs
+  #
+  # @example
+  #   render Bulmacomp::TabsComponent.new()
+  #
+  #   <div class="tabs">
+  #     <ul></ul>
+  #   </div>
+  #
+  # @example tabs with elements
+  #   elements = [link_to('one','#'), link_to('two','#')]
+  #   render Bulmacomp::TabsComponent.new(elements: elements)
+  #
+  #   <div class="tabs">
+  #     <ul>
+  #       <li><a href='#'>one</li>
+  #       <li><a href='#'>two</li>
+  #     </ul>
+  #   </div>
+  #
+  # @example tabs with yield content
+  #   = render Bulmacomp::TabsComponent.new() do
+  #     %li some text
+  #
+  #   <div class="tabs">
+  #     <ul>
+  #       <li>some text</li>
+  #     </ul>
+  #   </div>
+  #
+  # @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>some text</li>
+  #     </ul>
+  #   </div>
+  class TabsComponent < ViewComponent::Base
+    # @param [Hash] opts
+    #   options to generate content
+    # @param [Array<String>] elements
+    #   array of elements for tabs collection
+    # @option opts [String] :*
+    #   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)
+    end
+
+    # @return [String] html_safe tabs
+    def call
+      tag.div tag.ul(ul_content), **@opts
+    end
+
+    # @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,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bulmacomp
-  VERSION = '0.1.0'
+  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.0
+  version: 0.1.2
 platform: ruby
 authors:
 - MDreW
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-21 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
@@ -37,9 +37,12 @@ files:
 - app/components/bulmacomp/breadcrumb_component.rb
 - app/components/bulmacomp/card_component.rb
 - app/components/bulmacomp/menu_component.rb
+- app/components/bulmacomp/message_component.rb
 - app/components/bulmacomp/modal_component.rb
 - app/components/bulmacomp/navbar_component.rb
+- app/components/bulmacomp/pagination_component.rb
 - app/components/bulmacomp/panel_component.rb
+- app/components/bulmacomp/tabs_component.rb
 - lib/bulmacomp.rb
 - lib/bulmacomp/engine.rb
 - lib/bulmacomp/version.rb