bulmacomp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aba376c1b9ab6ef2532c7c313e28621f910c5959bf0285ce268e2936983ae0c1
+  data.tar.gz: 5462a699bc0b4fd5985674230ce986a3db9ed7cec16bcd2e098ab234e0793a72
+SHA512:
+  metadata.gz: 9b4c29854e9bbb3dd9283b698633578d5b8b1c9b0b4868fa919ff392aa1690faa1f59c7cb4e031212d93ddbbde8a3ed966d624b1511dc84d4b83843d82e9d13f
+  data.tar.gz: 62b1d229680c06b33f75ae136c60999f4942e9f768d01f5ca33d56b1c53c327b33d6f74a6633e58a3835516b5ec16e96854324c4912ba22877f8e51162ec8826

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 MDreW
+
+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,28 @@
+# Bulmacomp
+[https://viewcomponent.org/](ViewComponent) collection for [https://bulma.io/](bulma) css framework
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "bulmacomp"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install bulmacomp
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,7 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'

data/app/components/bulmacomp/breadcrumb_component.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Bulmacomp
+  # Make an html structure for a bulma breadcrumb
+  #
+  # @example Empty breadcrumb:
+  #   render Bulmacomp::BreadcrumbComponent.new()
+  #
+  #   <nav class="breadcrumb" aria-label="breadcrumbs">
+  #     <ul>
+  #     </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','#'))
+  #   <nav class="breadcrumb" aria-label="breadcrumbs">
+  #     <ul>
+  #       <li><a href="#">one</a></li>
+  #       <li><a href="#">two</a></li>
+  #     </ul>
+  #   </nav>
+  #
+  # @example Breadcrump with yield:
+  #   render Bulmacomp::BreadcrumbComponent.new() do
+  #      <li><a href="#">Bulma</a></li>
+  #   end
+  #
+  #   <nav class="breadcrumb" aria-label="breadcrumbs">
+  #     <ul>
+  #       <li><a href="#">Bulma</a></li>
+  #    </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
+    # @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)
+      super
+      @list = list
+      @opts = { class: 'breadcrumb', aria: { label: 'breadcrumbs' } }.merge(opts)
+    end
+
+    # @return [String] html_safe breadcrumb
+    def call
+      tag.nav tag.ul(ul_content), **@opts
+    end
+
+    # @return [Text], safe join of list arguments and proc content
+    def ul_content
+      safe_join(@list.map { |e| tag.li(e) }.<<(content))
+    end
+  end
+end

data/app/components/bulmacomp/card_component.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Bulmacomp
+  # Make an html structure for a bulma card
+  #
+  # @example empty card
+  #   render Bulmacomp::BreadcrumbComponent.new()
+  #
+  #   <div class="card"></div>
+  # @example cart with title and yeld content
+  #   render Bulmacomp::BreadcrumbComponent.new(title: 'test') do
+  #     <p>test content</p>
+  #   end
+  #
+  #   <div class="card">
+  #     <div class="card-header">
+  #       <div class="cart-header-title">test</div>
+  #     </div>
+  #     <div class="card-content">
+  #       <div class="content"><p>test content</p>
+  #     </div>
+  #   </div>
+  class CardComponent < ViewComponent::Base
+    def initialize(title: nil, image: nil, footer: nil, **opts)
+      super
+      @title = title
+      @image = image
+      @footer = footer
+      @opts = { class: 'card' }.merge(opts)
+    end
+
+    # @return [String] html_safe card
+    def call
+      tag.div safe_join([card_title, card_image, card_content, card_footer]), **@opts
+    end
+
+    # @return [String] title section if :title is set
+    # @example
+    #   Bulmacomp::BreadcrumbComponent.new(title: 'test').title
+    #
+    #   <div class='card-header'><div class='card-header-title'>test</div></div>
+    def card_title
+      tag.div(tag.div(@title, class: 'card-header-title'), class: 'card-header') if @title
+    end
+
+    # return [String] image section if :image is set
+    # @example
+    #   Bulmacomp::BreadcrumbComponent.new(title: 'test', image: 'test.jpg').image
+    #
+    #   <div class='card-image'><img src='test.jpg' alt='test'></div>
+    def card_image
+      tag.div(tag.figure(image_tag(@image, alt: @title), class: 'image'), class: 'card-image') if @image
+    end
+
+    # return [String] content section if yield is present
+    # @example
+    #   Bulmacomp::BreadcrumbComponent.new().title do
+    #     test content
+    #   end
+    #
+    #   <div class="card-content"><div class="content"><p>test content</p></div>
+    def card_content
+      tag.div(tag.div(content, class: 'content'), class: 'card-content') if content
+    end
+
+    # return [String] footer section if a footer is present
+    # @example
+    #   Bulmacomp::BreadcrumbComponent.new(footer: 'test').footer
+    #
+    #   <div class='card-footer'>test</div>
+    def card_footer
+      tag.div @footer, class: 'card-footer' if @footer
+    end
+  end
+end

data/app/components/bulmacomp/menu_component.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Bulmacomp
+  # Make the html strucrure for a bulma menu
+  #
+  # @example Empty menu
+  #   = render Bulmacomp::MenuComponent.new
+  #
+  #   <aside class='menu'></aside>
+  #
+  # @example menu with title and entries
+  #   title = 'Menu title'
+  #   menu  = [link_to('first entry', '#'), link_to('second entry', '#')
+  #   render Bulmacomp::MenuComponent.new(title,menu)
+  #
+  #   <aside class='menu'>
+  #     <p class='menu-label'>Menu title</p>
+  #     <ul>
+  #       <li><a href='#'>first entry</li>
+  #       <li><a href='#'>second entry<li>
+  #     </ul>
+  #   </aside>
+  #
+  # @example menu with title and annidate entries
+  #   = render Bulmacomp::MenuComponent.new('Uno',['Due',['Tre','Quattro']])
+  #
+  #   <aside class='menu'>
+  #     <p class='menu-label'>Uno</p>
+  #     <ul>
+  #       <li>Due</li>
+  #       <li>
+  #         Tre
+  #         <ul>
+  #           <li>Quattro</li>
+  #         </ul>
+  #       <li>
+  #     </ul>
+  #   </aside>
+  #
+  # @example with conetent
+  #   = render Bulmacomp::MenuComponent.new do
+  #     %p some content
+  #
+  #   <aside class='menu'>
+  #     <p>some content</p>
+  #   </aside>
+  #
+  # @example with mixed conetent (arguments before)
+  #   = render Bulmacomp::MenuComponent.new('argument content',['argoument menu']) do
+  #     %p yield content
+  #
+  #   <aside class='menu'>
+  #     <p class='menu-label'>argoument content</p>
+  #     <ul>
+  #       <li>argoument menu</li>
+  #     </ul>
+  #     <p>yield content</p>
+  #   </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 [String] :*
+    #   each key going as tag option, default is class: 'menu'
+    def initialize(*list, **opts)
+      super
+      @list = list
+      @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
+    end
+
+    # Generate a string with all bulma menu element from `values` param.
+    #
+    # Each element in `values` is mapped:
+    # * as `p.menu-title` tag if is not an Array
+    # * as {map_menu} if is an Array
+    # @return [String]
+    # @param [Array] values menu entries
+    # @example
+    #   Bulmacomp::MenuComponent.new().first_level(['Uno',['Due','Tre']])
+    #
+    #   <p class='menu-label'>Uno</p><ul><li>Due</li><li>Tre<li></ul>
+    def first_level(values = [])
+      safe_join(
+        values.map { |e| e.is_a?(Array) ? map_menu(e) : tag.p(e, class: 'menu-label') }
+      )
+    end
+
+    # Generate a string with the "real" menu entries (no title)
+    # from 'values' param. The menu entries 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
+    # @example
+    #   Bulmacomp::MenuComponent.new().map_menu(['Uno',['Due','Tre']])
+    #
+    #   <ul><li>Uno</li><li>Due<ul><li>Tre</li></ul></li></ul>
+    def map_menu(values = [])
+      tag.ul safe_join(values.map { |e| e.is_a?(Array) ? sub_menu(e) : tag.li(e) })
+    end
+
+    # Generate a string with sub-menu content from values params.
+    # 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
+    # @example
+    #   Bulmacomp::MenuComponent.new().sub_menu(['Uno',['Due','Tre']])
+    #
+    #   <li>Uno<ul><li>Due</li><li>Tre</li></ul></li>
+    def sub_menu(values = [])
+      tag.li safe_join([values.shift, map_menu(values)])
+    end
+  end
+end

data/app/components/bulmacomp/modal_component.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Bulmacomp
+  # Make an html structure for a bulma breadcrumb
+  #
+  # @example Empty modal:
+  #   = render Bulmacomp::PanelComponent.new()
+  #
+  #   <div class="modal">
+  #     <div class="modal-background"></div>
+  #     <div class="modal-content"></div>
+  #     <button class="modal-close is-large" aria-label="close"></button>
+  #   </div>
+  #
+  # @example Modal with content:
+  #   = render Bulmacomp::PanelComponent.new() do
+  #     %p some content
+  #
+  #   <div class="modal">
+  #     <div class="modal-background"></div>
+  #     <div class="modal-content"><p>Some content</p></div>
+  #     <button class="modal-close is-large" aria-label="close"></button>
+  #   </div>
+  class ModalComponent < ViewComponent::Base
+    # @param [Hash] opts options to generate content
+    # @option opts [String] :* each key going as tag option, default is class: 'modal'
+    # @yield [optional] modal content
+    def initialize(**opts)
+      super
+      @opts = { class: 'modal' }.merge opts
+    end
+
+    # return [String] html_safe generated bulma modal
+    def call
+      content_tag :div, safe_join([
+                                    tag.div(class: 'modal-background'),
+                                    tag.div(content, class: 'modal-content'),
+                                    tag.button(class: 'modal-close is-large', aria_label: 'close')
+                                  ]), **@opts
+    end
+  end
+end

data/app/components/bulmacomp/navbar_component.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Bulmacomp
+  # Make an html structure for a bulma navbar
+  # @example Empty navbar:
+  #   = render Bulmacomp::NavbarComponent.new()
+  #
+  #   <nav class="navbar" role="navigation" aria-label="main navigation">
+  #     <div class="navbar-brand">
+  #       <a class="navbar-item" href="/"></a>
+  #
+  #       <a role="button" class="navbar-burger" aria-label="menu"
+  #         aria-expanded="false" data-target="navbarBasicExample" data_action="page#toggleMenu">
+  #         <span aria-hidden="true"></span>
+  #         <span aria-hidden="true"></span>
+  #         <span aria-hidden="true"></span>
+  #       </a>
+  #     </div>
+  #     <div class="navbar-menu"></div>
+  #   </nav>
+  # @example full navbar:
+  #   = render Bulmacomp::NavbarComponent.new(brand: 'Title') do
+  #     <div class="navbar-start"><a href="/" class="navbar-item">Home</a>
+  #
+  #   <nav class="navbar" role="navigation" aria-label="main navigation">
+  #     <div class="navbar-brand">
+  #       <a class="navbar-item" href="/">Title</a>
+  #
+  #       <a role="button" class="navbar-burger" aria-label="menu"
+  #       aria-expanded="false" data-target="navbarBasicExample" data_action="page#toggleMenu">
+  #         <span aria-hidden="true"></span>
+  #         <span aria-hidden="true"></span>
+  #         <span aria-hidden="true"></span>
+  #       </a>
+  #     </div>
+  #     <div class="navbar-menu"><div class="navbar-start"><a href="/" class="navbar-item">Home</a></div>
+  #   </nav>
+  class NavbarComponent < ViewComponent::Base
+    # @param [Hash] opts
+    #   to generate content
+    # @option opts [String] :brand
+    #   navbar brand content
+    # @option opts [String] :*
+    #   each other key going as tag option, default is
+    #   class: 'navbar', aria_label: 'main navigation', aria_role: 'navigation'
+    # @yield [optional] navbar content
+    def initialize(brand: nil, **opts)
+      super
+      @brand = brand
+      @opts = { class: 'navbar', aria: { role: 'navigation', label: 'main navigation' } }.merge(opts)
+    end
+
+    # @return [String] html_safe navbar
+    def call
+      tag.nav safe_join([navbar_brand, navbar_menu]), @opts
+    end
+
+    # @return [String] html_safe navbar-brand tag
+    def navbar_brand
+      tag.div safe_join([link_to(@brand, root_path, data_turbo_frame: 'yield', class: 'navbar-item'), navbar_burger]),
+              class: 'navbar-brand'
+    end
+
+    # @return [String] html_safe navbar-menu tag
+    def navbar_menu
+      tag.div(content, class: 'navbar-menu')
+    end
+
+    # return [String] html_safe navbar-burger link
+    def navbar_burger
+      tag.a tag.span(aria_hidden: true) * 3, class: 'navbar-burger', aria_label: 'menu', aria_expanded: 'false',
+                                             data_action: 'page#toggleMenu'
+    end
+  end
+end

data/app/components/bulmacomp/panel_component.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Bulmacomp
+  # Make an html structure for a bulma breadcrumb
+  #
+  # @example Empty panel:
+  #   render Bulmacomp::PanelComponent.new()
+  #
+  #   <nav class="panel">
+  #   </nav>
+  #
+  # @example panel with option:
+  #   = render Bulmacomp::PanelComponent.new(title: 'test title') do
+  #     <a class="panel-block is-active">
+  #       <span class="panel-icon"><i class="fas fa-book" aria-hidden="true"></i></span>
+  #       bulma
+  #     </a>
+  #
+  #   <nav class="panel">
+  #     <p class="panel-heading">test title</p>
+  #     <a class="panel-block is-active">
+  #       <span class="panel-icon"><i class="fas fa-book" aria-hidden="true"></i></span>
+  #       bulma
+  #     </a>
+  #   </nav>
+  class PanelComponent < ViewComponent::Base
+    # @param [Hash] opts
+    #   options to generate content
+    # @option opts [String] :title
+    #   panel title
+    # @option opts [String] :*
+    #   each other key going as tag option, default is class: 'breadcrumb', aria_label: 'breadcrumbs'
+    # @yield [optional]
+    #   panel content
+    def initialize(title: nil, **opts)
+      super
+      @title = title
+      @opts = opts
+      @opts[:class] = 'panel' unless @opts[:class]
+    end
+
+    # return [String] html_safe generated bulma panel
+    def call
+      content_tag :nav, safe_join([title, content]), **@opts
+    end
+
+    # return [String] html_safe generated panel title
+    def title
+      tag.p @title, class: 'panel-heading' if @title
+    end
+  end
+end

data/lib/bulmacomp/engine.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Bulmacomp
+  # Bulmacomp Engine, load the isolate namespace Bulmacomp
+  class Engine < ::Rails::Engine
+    isolate_namespace Bulmacomp
+  end
+end

data/lib/bulmacomp/version.rb

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

data/lib/bulmacomp.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'bulmacomp/version'
+require 'bulmacomp/engine'
+require 'view_component'
+
+# Bulmacomp module, contain all gem components
+module Bulmacomp
+  # Your code goes here...
+end

data/lib/tasks/bulmacomp_tasks.rake

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

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: bulmacomp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- MDreW
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.2
+description: Collection of view components for bulma css framework
+email:
+- andrea.ranaldi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/components/bulmacomp/breadcrumb_component.rb
+- app/components/bulmacomp/card_component.rb
+- app/components/bulmacomp/menu_component.rb
+- app/components/bulmacomp/modal_component.rb
+- app/components/bulmacomp/navbar_component.rb
+- app/components/bulmacomp/panel_component.rb
+- lib/bulmacomp.rb
+- lib/bulmacomp/engine.rb
+- lib/bulmacomp/version.rb
+- lib/tasks/bulmacomp_tasks.rake
+homepage: https://github.com/isprambiente/bulmacomp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/isprambiente/bulmacomp
+  source_code_uri: https://github.com/MdreW/bulmacomp
+  changelog_uri: https://github.com/MdreW/bulmacomp
+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.4.8
+signing_key:
+specification_version: 4
+summary: Rails 'View Components' for Bulma
+test_files: []