booties 0.1.0 → 0.2.0

data/app/helpers/booties/panel_helper.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Booties
-  module PanelHelper
+  module PanelHelper # :nodoc:
     ##
     # Renders a panel. The defult panel context is +:default+ but can be
     # specified through +options+. The contents of the panel should be passed

data/app/helpers/booties/popover_helper.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Booties
-  module PopoverHelper
+  module PopoverHelper # :nodoc:
     include Utils
 
     ##
@@ -27,7 +29,7 @@ module Booties
     # snippet on the page:
     #
     #   $(function() {
-    #     $('[data-toggler="popover"]').popover();
+    #     $('[data-toggle="popover"]').popover();
     #   }
     #
     # Examples:
@@ -39,25 +41,32 @@ module Booties
     #     Link text
     #   <% end %>
     #   <button class="btn btn-default" type="button" data-toggle="popover" data-content="Lorem ipsum dolor sit amet." data-placement="top" data-container="body" data-trigger="focus" title="Lorem ipsum">Link text</button>
-    def popover(text = nil, tag: :a, content:, title: nil, placement: nil, trigger: nil, **html_options, &block)
-      data = { toggle: 'popover', content: content, }
-
-      if placement
-        validate_placement! placement
-        data[:placement] = placement
-      end
-
-      if trigger
-        data[:container] = 'body'
-        data[:trigger]   = 'focus'
-      end
 
-      role_or_type = tag == :button ? :type : :role
-      html_options[role_or_type] ||= 'button'
-      html_options[:data] ||= {}
-      html_options[:data].update data
+    # rubocop:disable Metrics/MethodLength, Metrics/ParameterLists
+    def popover(text = nil,
+                tag: :a,
+                container: nil,
+                content:,
+                title: nil,
+                placement: nil,
+                trigger: nil,
+                **options,
+                &block)
+      data = {
+        toggle: 'popover',
+        content: content,
+        container: container,
+        placement: placement,
+        trigger: trigger,
+      }
+      options[tag == :button ? :type : :role] ||= 'button'
+      options[:title] = title
+      options[:tabindex] ||= 10 if trigger
+      options[:data] ||= {}
+      options[:data].update data
 
-      content_tag tag, text, **html_options, title: title, &block
+      content_tag tag, text, options, &block
     end
+    # rubocop:enable Metrics/MethodLength, Metrics/ParameterLists
   end
 end

data/app/helpers/booties/tooltip_helper.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Booties
-  module TooltipHelper
+  module TooltipHelper # :nodoc:
     include Utils
 
     ##
@@ -40,15 +42,17 @@ module Booties
     #     This has a tooltip.
     #   <% end %>
     #   <span data-toggle="tooltip" title="This is a tooltip" class="tooltip">This has a tooltip.</span>
-    def tooltip(title:, placement: nil, wrapper_tag: :span, **options, &block)
-      data = { toggle: 'tooltip', }
+    def tooltip(content = nil,
+                title:,
+                placement: nil,
+                wrapper_tag: :span,
+                **options,
+                &block)
 
-      if placement
-        validate_placement! placement
-        data[:placement] = placement
-      end
+      data = { toggle: 'tooltip', placement: placement }
+      options = { data: data, title: title, **options }
 
-      content_tag wrapper_tag, data: data, title: title, **options, &block
+      content_tag wrapper_tag, content, options, &block
     end
   end
 end

data/config/routes.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 Booties::Engine.routes.draw do
 end

data/lib/booties.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'booties/engine'
 require 'booties/utils'
 require 'booties/modal'
 require 'booties/panel'
 
-module Booties
+module Booties # :nodoc:
 end

data/lib/booties/engine.rb

@@ -1,5 +1,11 @@
+# frozen_string_literal: true
+
 module Booties
-  class Engine < ::Rails::Engine
+  class Engine < ::Rails::Engine # :nodoc:
     isolate_namespace Booties
+
+    initializer 'booties.view_helpers' do
+      ActionView::Base.send :include, helpers
+    end
   end
 end

data/lib/booties/modal.rb

@@ -1,28 +1,29 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Booties
-  class Modal
+  class Modal # :nodoc:
     include Utils
     extend Forwardable
 
-    DEFAULT_DISMISSAL = '×'.freeze
+    DEFAULT_DISMISSAL = '×'.html_safe
     MODAL_SIZE        = { small: 'modal-sm', large: 'modal-lg' }.freeze
 
     ##
     # Instantiates a new Modal. Several helper methods like #content_tag will
-    # be delegated to +view_context+. The required keyword +id+ will be used as
+    # be delegated to +template+. The required keyword +id+ will be used as
     # the DOM ID of the modal element. By default, the modal will exhibit
     # fading behavior, but this can be disabled by setting +fade+ to a falsey
     # value.
-    def initialize(view_context, id:, fade: true, size: nil)
-      @view_context = view_context
-      @id           = id
-      @fade         = fade ? 'fade' : nil
-      @size         = MODAL_SIZE[size]
+    def initialize(template, id:, fade: true, size: nil)
+      @template = template
+      @id = id
+      @fade = fade ? 'fade' : nil
+      @size = MODAL_SIZE[size]
     end
 
-    def_delegators :@view_context, :button_tag, :capture, :content_tag,
-      :raw, :t, :translate
+    delegate %i[button_tag capture content_tag t] => :@template
 
     ##
     # Renders the top-level div for the modal dialog. +block+ is passed to
@@ -70,8 +71,8 @@ module Booties
       content_tag :div, class: 'modal-header' do
         if close
           dismissal = t :'booties.modal.dismiss_html',
-            default: [:'booties.modal.dismiss', raw(DEFAULT_DISMISSAL)]
-          dismiss(dismissal) << title(&block)
+                        default: [:'booties.modal.dismiss', DEFAULT_DISMISSAL]
+          dismiss(dismissal) + title(&block)
         else
           title(&block)
         end

data/lib/booties/panel.rb

@@ -1,20 +1,22 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Booties
-  class Panel
+  class Panel # :nodoc:
     include Utils
     extend Forwardable
 
     CSS_CLASSES = {
-      heading: 'panel-heading'.freeze,
-      title:   'panel-title'.freeze,
-      body:    'panel-body'.freeze,
-      footer:  'panel-footer'.freeze,
-    }
+      heading: 'panel-heading',
+      title: 'panel-title',
+      body: 'panel-body',
+      footer: 'panel-footer',
+    }.freeze
 
     ##
     # Instantiates a new Panel. Several helper methods like #content_tag will
-    # be delegated to +view_context+.
+    # be delegated to +template+.
     #
     # The optional +context+ argument can be passed in to specify the panel
     # context; otherwise, the context +:default+ is used.
@@ -26,15 +28,15 @@ module Booties
     #
     # Any additional options will be included as attributes on the top-level
     # panel container.
-    def initialize(view_context, context: :default, wrapper_tag: 'div', **options)
-      @view_context = view_context
-      @wrapper_tag  = wrapper_tag
-      @context      = context
+    def initialize(template, context: :default, wrapper_tag: 'div', **options)
+      @template    = template
+      @wrapper_tag = wrapper_tag
+      @context     = context
       # TODO: pass options to #render instead of constructor
-      @options      = options
+      @options     = options
     end
 
-    def_delegators :@view_context, :capture, :content_tag
+    delegate %i[capture content_tag] => :@template
 
     ##
     # Renders the top-level div for the panel. +@context+ is used to specify
@@ -42,7 +44,8 @@ module Booties
     # object will be passed as a parameter to +block+.
     def render(&block)
       options = @options.dup
-      classes = merge_classes %W[panel panel-#@context], options.delete(:class)
+      classes = merge_classes %W[panel panel-#{@context}],
+                              options.delete(:class)
       content_tag @wrapper_tag, class: classes, **options do
         capture self, &block
       end
@@ -56,7 +59,7 @@ module Booties
     def heading(content = nil, class: nil, **options, &block)
       content ||= capture(&block)
       classes   = merge_classes CSS_CLASSES[:heading],
-        binding.local_variable_get(:class)
+                                binding.local_variable_get(:class)
       content_tag :div, content, class: classes, **options
     end
 
@@ -68,7 +71,7 @@ module Booties
     def title(content = nil, class: nil, **options, &block)
       content ||= capture(&block)
       classes   = merge_classes CSS_CLASSES[:title],
-        binding.local_variable_get(:class)
+                                binding.local_variable_get(:class)
       content_tag :h3, content, class: classes, **options
     end
 
@@ -80,7 +83,7 @@ module Booties
     def body(content = nil, class: nil, **options, &block)
       content ||= capture(&block)
       classes   = merge_classes CSS_CLASSES[:body],
-        binding.local_variable_get(:class)
+                                binding.local_variable_get(:class)
       content_tag :div, content, class: classes, **options
     end
 
@@ -92,7 +95,7 @@ module Booties
     def footer(content = nil, class: nil, **options, &block)
       content ||= capture(&block)
       classes   = merge_classes CSS_CLASSES[:footer],
-        binding.local_variable_get(:class)
+                                binding.local_variable_get(:class)
       content_tag :div, content, class: classes, **options
     end
   end

data/lib/booties/utils.rb

@@ -1,15 +1,13 @@
-module Booties
-  module Utils
-    PLACEMENTS = [:left, :right, :top, :bottom, ]
+# frozen_string_literal: true
 
-    def validate_placement!(position)
-      PLACEMENTS.include? position or raise ArgumentError,
-        "invalid placement: #{position.inspect}, " \
-        'valid placements are :left, :right, :top, :bottom'
-    end
+module Booties
+  module Utils # :nodoc:
+    def merge_classes(*sets)
+      return nil if sets.all?(&:nil?)
 
-    def merge_classes(a, b)
-      Array(a).compact.flat_map(&:split) | Array(b).compact.flat_map(&:split)
+      sets.reduce([]) do |superset, subset|
+        superset | Array(subset).compact.flat_map(&:split)
+      end
     end
 
     module_function :merge_classes

data/lib/booties/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Booties
-  VERSION = "0.1.0"
+  VERSION = '0.2.0'
 end

data/lib/tasks/booties_tasks.rake

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

data/test/dummy/Rakefile

@@ -1,6 +1,6 @@
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 
-require File.expand_path('../config/application', __FILE__)
+require_relative 'config/application'
 
 Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -1,13 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/test/dummy/app/channels/application_cable/channel.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Channel < ActionCable::Channel::Base
+  end
+end

data/test/dummy/app/channels/application_cable/connection.rb

@@ -0,0 +1,4 @@
+module ApplicationCable
+  class Connection < ActionCable::Connection::Base
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -1,7 +1,3 @@
 class ApplicationController < ActionController::Base
-  # Prevent CSRF attacks by raising an exception.
-  # For APIs, you may want to use :null_session instead.
   protect_from_forgery with: :exception
-
-  helper Booties::Engine.helpers
 end

data/test/dummy/app/controllers/samples_controller.rb

@@ -0,0 +1,28 @@
+class SamplesController < ApplicationController
+  def badges
+  end
+
+  def breadcrumbs
+  end
+
+  def buttons
+  end
+
+  def dropdowns
+  end
+
+  def flags
+  end
+
+  def modals
+  end
+
+  def panels
+  end
+
+  def popovers
+  end
+
+  def tooltips
+  end
+end

data/test/dummy/app/jobs/application_job.rb

@@ -0,0 +1,2 @@
+class ApplicationJob < ActiveJob::Base
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -1,16 +1,14 @@
 <!DOCTYPE html>
 <html>
-<head>
-  <title>Dummy</title>
-  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
-  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
 
-  <%= yield :breadcrumbs %>
+    <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+    <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+  </head>
 
-  <%= yield %>
-
-</body>
+  <body>
+    <%= yield %>
+  </body>
 </html>