kadmin 0.3.1 → 0.3.2

data/app/controllers/kadmin/dash_controller.rb

@@ -1,19 +1,19 @@
-module Kadmin
-  class DashController < Kadmin::ApplicationController
-    # @!group Endpoints
-
-    # GET /
-    def index
-    end
-
-    # @!endgroup
-
-    # @!group Helpers
-
-    def set_navbar_links
-      @layout_navbar_links = Kadmin.config.navbar_links
-    end
-
-    # @!endgroup
-  end
-end
+module Kadmin
+  class DashController < Kadmin::ApplicationController
+    # @!group Endpoints
+
+    # GET /
+    def index
+    end
+
+    # @!endgroup
+
+    # @!group Helpers
+
+    def set_navbar_links
+      @layout_navbar_links = Kadmin.config.navbar_links
+    end
+
+    # @!endgroup
+  end
+end

data/app/decorators/kadmin/finder_decorator.rb

@@ -1,50 +1,50 @@
-module Kadmin
-  class FinderDecorator
-    # @return [Kadmin::Finder] underlying finder model
-    attr_reader :finder
-
-    delegate :filters, :scope, :results, to: :finder
-
-    def initialize(finder)
-      @finder = finder
-    end
-
-    # @return [Boolean] true if no results, false otherwise
-    def empty?
-      return finder.results.count.zero?
-    end
-
-    # @return [String] how many resources are being displayed (along with indices)
-    def currently_showing
-      resource = resource_name.downcase
-      displayed = empty? ? 0 : pager.displayed_items
-
-      currently_showing_phrase = "#{displayed} #{resource}"
-      currently_showing_phrase = "#{currently_showing_phrase} (#{pager.page_start} - #{pager.page_end})" if finder.results.count > 1
-
-      return currently_showing_phrase
-    end
-
-    # @return [String] human readable, singular/plural form of the finder's model
-    def resource_name
-      return @finder.scope.model_name.human(count: pager.displayed_items)
-    end
-
-    # @return [String] a description of the current applied filters
-    def applied_filters
-      applied_filters = ''
-      filters = @finder.filters.reduce([]) do |acc, (name, filter)|
-        next(acc) if filter.value.blank?
-        acc << %(<strong>#{filter.value}</strong> on <em>#{name}</em>)
-      end
-      applied_filters = "(filtering: #{filters.join('; ')})" unless filters.empty?
-
-      return applied_filters.html_safe
-    end
-
-    # @return [Kadmin::PagerDecorator] decorated pager of the underlying finder
-    def pager
-      return @pager ||= Kadmin::PagerDecorator.new(@finder.pager)
-    end
-  end
-end
+module Kadmin
+  class FinderDecorator
+    # @return [Kadmin::Finder] underlying finder model
+    attr_reader :finder
+
+    delegate :filters, :scope, :results, to: :finder
+
+    def initialize(finder)
+      @finder = finder
+    end
+
+    # @return [Boolean] true if no results, false otherwise
+    def empty?
+      return finder.results.count.zero?
+    end
+
+    # @return [String] how many resources are being displayed (along with indices)
+    def currently_showing
+      resource = resource_name.downcase
+      displayed = empty? ? 0 : pager.displayed_items
+
+      currently_showing_phrase = "#{displayed} #{resource}"
+      currently_showing_phrase = "#{currently_showing_phrase} (#{pager.page_start} - #{pager.page_end})" if finder.results.count > 1
+
+      return currently_showing_phrase
+    end
+
+    # @return [String] human readable, singular/plural form of the finder's model
+    def resource_name
+      return @finder.scope.model_name.human(count: pager.displayed_items)
+    end
+
+    # @return [String] a description of the current applied filters
+    def applied_filters
+      applied_filters = ''
+      filters = @finder.filters.reduce([]) do |acc, (name, filter)|
+        next(acc) if filter.value.blank?
+        acc << %(<strong>#{filter.value}</strong> on <em>#{name}</em>)
+      end
+      applied_filters = "(filtering: #{filters.join('; ')})" unless filters.empty?
+
+      return applied_filters.html_safe
+    end
+
+    # @return [Kadmin::PagerDecorator] decorated pager of the underlying finder
+    def pager
+      return @pager ||= Kadmin::PagerDecorator.new(@finder.pager)
+    end
+  end
+end

data/app/decorators/kadmin/pager_decorator.rb

@@ -1,33 +1,33 @@
-module Kadmin
-  class PagerDecorator
-    # @return [Kadmin::Pager] underlying pager model
-    attr_reader :pager
-
-    delegate :total, :size, :offset, :pages, :current_page, :contains?, :next_page?,
-      :previous_page?, :offset_at, :current_page?,
-      to: :pager
-
-    def initialize(pager)
-      @pager = pager
-    end
-
-    # @return [Integer] the current number of items displayed for this page
-    def displayed_items
-      return page_end - offset
-    end
-
-    # @return [Integer] the index number of the last item for this page
-    def page_end
-      return [next_page_offset, total].min
-    end
-
-    # @return [Integer] the index number of the start item for this page
-    def page_start
-      return offset + 1
-    end
-
-    def next_page_offset
-      return @pager.offset_at(current_page + 1)
-    end
-  end
-end
+module Kadmin
+  class PagerDecorator
+    # @return [Kadmin::Pager] underlying pager model
+    attr_reader :pager
+
+    delegate :total, :size, :offset, :pages, :current_page, :contains?, :next_page?,
+      :previous_page?, :offset_at, :current_page?,
+      to: :pager
+
+    def initialize(pager)
+      @pager = pager
+    end
+
+    # @return [Integer] the current number of items displayed for this page
+    def displayed_items
+      return page_end - offset
+    end
+
+    # @return [Integer] the index number of the last item for this page
+    def page_end
+      return [next_page_offset, total].min
+    end
+
+    # @return [Integer] the index number of the start item for this page
+    def page_start
+      return offset + 1
+    end
+
+    def next_page_offset
+      return @pager.offset_at(current_page + 1)
+    end
+  end
+end

data/app/helpers/kadmin/alert_helper.rb

@@ -1,59 +1,59 @@
-# frozen_string_literal: true
-module Kadmin
-  # Provide helpers for displaying alerts, as well as matching those alerts to
-  # different flash keys.
-  module AlertHelper
-    # Generates HTML for a bootstrap alert message, optionally closable.
-    # @param [String] type the type of the alert: danger, success, info, warning, or any alert-<TYPE> defined in your CSS
-    # @param [Hash] options options to customize the alert
-    # @option options [String] content ('') text to show if you're not going to pass a block
-    # @option options [Boolean] dismissible (true) if true, adds a close button to the alert. Requires JS enabled
-    # @param [Proc] block optional block to pass if you want add more complex HTML inside
-    def alert(type, options = {}, &block)
-      dismissible = options.fetch(:dismissible, true)
-      text_content = options.fetch(:content, '')
-
-      css_classes = %W(alert alert-#{type})
-      css_classes << 'alert-dismissible' if options.fetch(:dismissible, true)
-      block_content = capture(&block) if block_given?
-
-      return content_tag(:div, '', class: css_classes.join(' '), role: 'alert') do
-        content = text_content.html_safe
-
-        if dismissible
-          button = button_tag(type: 'button', class: 'close', 'data-dismiss': 'alert') do
-            content_tag(:span, '&times', {}, false)
-          end
-          content.concat(button)
-        end
-
-        content.concat(block_content.html_safe) unless block_content.blank?
-        content
-      end
-    end
-
-    Type = Struct.new(:flash_keys, :css_class, :glyphicon)
-    TYPES = [
-      Type.new(['danger', 'alert'], 'danger', 'exclamation-sign'),
-      Type.new(['success'], 'success', 'ok-sign'),
-      Type.new(['notice', 'info'], 'info', 'info-sign'),
-      Type.new(['warn', 'warning'], 'warning', 'question-sign')
-    ].freeze
-    def render_flash_alerts
-      alerts = AlertHelper::TYPES.map do |type|
-        next unless type.flash_keys.any? { |key| flash[key].present? }
-        render_flash_alert(type)
-      end.compact
-
-      return safe_join(alerts)
-    end
-
-    def render_flash_alert(type, &block)
-      messages = type.flash_keys.map { |key| Array.wrap(flash[key]).compact }.flatten
-      return '' if messages.blank?
-
-      wrapped = messages.map { |message| content_tag(:p, glyphicon(type.glyphicon) + " #{message}") }.join('')
-      return alert(type.css_class, content: wrapped)
-    end
-  end
-end
+# frozen_string_literal: true
+module Kadmin
+  # Provide helpers for displaying alerts, as well as matching those alerts to
+  # different flash keys.
+  module AlertHelper
+    # Generates HTML for a bootstrap alert message, optionally closable.
+    # @param [String] type the type of the alert: danger, success, info, warning, or any alert-<TYPE> defined in your CSS
+    # @param [Hash] options options to customize the alert
+    # @option options [String] content ('') text to show if you're not going to pass a block
+    # @option options [Boolean] dismissible (true) if true, adds a close button to the alert. Requires JS enabled
+    # @param [Proc] block optional block to pass if you want add more complex HTML inside
+    def alert(type, options = {}, &block)
+      dismissible = options.fetch(:dismissible, true)
+      text_content = options.fetch(:content, '')
+
+      css_classes = %W(alert alert-#{type})
+      css_classes << 'alert-dismissible' if options.fetch(:dismissible, true)
+      block_content = capture(&block) if block_given?
+
+      return content_tag(:div, '', class: css_classes.join(' '), role: 'alert') do
+        content = text_content.html_safe
+
+        if dismissible
+          button = button_tag(type: 'button', class: 'close', 'data-dismiss': 'alert') do
+            content_tag(:span, '&times', {}, false)
+          end
+          content.concat(button)
+        end
+
+        content.concat(block_content.html_safe) unless block_content.blank?
+        content
+      end
+    end
+
+    Type = Struct.new(:flash_keys, :css_class, :glyphicon)
+    TYPES = [
+      Type.new(['danger', 'alert'], 'danger', 'exclamation-sign'),
+      Type.new(['success'], 'success', 'ok-sign'),
+      Type.new(['notice', 'info'], 'info', 'info-sign'),
+      Type.new(['warn', 'warning'], 'warning', 'question-sign')
+    ].freeze
+    def render_flash_alerts
+      alerts = AlertHelper::TYPES.map do |type|
+        next unless type.flash_keys.any? { |key| flash[key].present? }
+        render_flash_alert(type)
+      end.compact
+
+      return safe_join(alerts)
+    end
+
+    def render_flash_alert(type, &block)
+      messages = type.flash_keys.map { |key| Array.wrap(flash[key]).compact }.flatten
+      return '' if messages.blank?
+
+      wrapped = messages.map { |message| content_tag(:p, glyphicon(type.glyphicon) + " #{message}") }.join('')
+      return alert(type.css_class, content: wrapped)
+    end
+  end
+end

data/app/helpers/kadmin/application_helper.rb

@@ -1,4 +1,4 @@
-module Kadmin
-  module ApplicationHelper
-  end
-end
+module Kadmin
+  module ApplicationHelper
+  end
+end

data/app/helpers/kadmin/bootstrap_helper.rb

@@ -1,23 +1,23 @@
-module Kadmin
-  # Collection of Bootstrap helpers
-  module BootstrapHelper
-    # @see http://getbootstrap.com/components/#glyphicons-glyphs
-    # @param [String] icon the part after glyphicon-
-    def glyphicon(icon)
-      return content_tag(:span, ' ', class: "glyphicon glyphicon-#{icon}", 'aria-hidden': 'true')
-    end
-
-    # @param [Boolean] condition condition of evaluate
-    # @param [String] icon_true the glyphicon to use if true
-    # @param [String] icon_false the glyphicon to use if false
-    def glyphicon_if_else(condition, icon_true, icon_false)
-      return condition ? glyphicon(icon_true) : glyphicon(icon_false)
-    end
-
-    # @param [Hash, String] url_options anything accepted by link_to and image_tag
-    # @param [Integer] max_height maximum height of the thumbnail
-    def thumbnail_link(url_options, max_height)
-      return link_to(image_tag(url_options), url_options, class: 'thumbnail', style: "max-height: #{max_height}px", target: 'new')
-    end
-  end
-end
+module Kadmin
+  # Collection of Bootstrap helpers
+  module BootstrapHelper
+    # @see http://getbootstrap.com/components/#glyphicons-glyphs
+    # @param [String] icon the part after glyphicon-
+    def glyphicon(icon)
+      return content_tag(:span, ' ', class: "glyphicon glyphicon-#{icon}", 'aria-hidden': 'true')
+    end
+
+    # @param [Boolean] condition condition of evaluate
+    # @param [String] icon_true the glyphicon to use if true
+    # @param [String] icon_false the glyphicon to use if false
+    def glyphicon_if_else(condition, icon_true, icon_false)
+      return condition ? glyphicon(icon_true) : glyphicon(icon_false)
+    end
+
+    # @param [Hash, String] url_options anything accepted by link_to and image_tag
+    # @param [Integer] max_height maximum height of the thumbnail
+    def thumbnail_link(url_options, max_height)
+      return link_to(image_tag(url_options), url_options, class: 'thumbnail', style: "max-height: #{max_height}px", target: 'new')
+    end
+  end
+end

data/app/helpers/kadmin/form_builder.rb

@@ -1,9 +1,9 @@
-module Kadmin
-  class FormBuilder < ActionView::Helpers::FormBuilder
-    # Creates a checkbox where the value is 0 when checked, 1 when unchecked.
-    # @see Kadmin::Forms::InvertedCheckBox
-    def inverted_check_box(method, options = {})
-      Kadmin::Forms::InvertedCheckBox.new(@object_name, method, @template, '0', '1', objectify_options(options)).render
-    end
-  end
-end
+module Kadmin
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    # Creates a checkbox where the value is 0 when checked, 1 when unchecked.
+    # @see Kadmin::Forms::InvertedCheckBox
+    def inverted_check_box(method, options = {})
+      Kadmin::Forms::InvertedCheckBox.new(@object_name, method, @template, '0', '1', objectify_options(options)).render
+    end
+  end
+end

data/app/helpers/kadmin/forms/inverted_check_box.rb

@@ -1,10 +1,10 @@
-module Kadmin
-  module Forms
-    class InvertedCheckBox < ActionView::Helpers::Tags::CheckBox
-      # Overload how it gets the value and return the invert
-      def value(*args)
-        return !super
-      end
-    end
-  end
-end
+module Kadmin
+  module Forms
+    class InvertedCheckBox < ActionView::Helpers::Tags::CheckBox
+      # Overload how it gets the value and return the invert
+      def value(*args)
+        return !super
+      end
+    end
+  end
+end

data/app/helpers/kadmin/navigation_helper.rb

@@ -1,28 +1,28 @@
-module Kadmin
-  module NavigationHelper
-    # Generates HTML for a bootstrap navigation link
-    # @param [String] title the navigation text
-    # @param [Hash, String] path the path for the link
-    # @param [Proc] block optional block to include content within the link
-    def nav_link_to(title, path, &block)
-      css_classes = []
-      css_classes << 'active' if request.path.starts_with?(path)
-      return content_tag(:li, link_to(title, path, &block), class: css_classes.join(' '))
-    end
-
-    # Generates a navigation drop down for bootstrap
-    # @param [String] prompt dropdown prompt
-    # @param [Array<Hash,String>] links list of links to add within the dropdown
-    def dropdown(prompt, links = [])
-      button_content = content_tag(:span, '', class: 'caret').prepend(prompt)
-      button = button_tag(button_content, type: 'button', data: { toggle: 'dropdown' }, class: 'btn btn-default')
-      list = content_tag(:ul, '', class: 'dropdown-menu') do
-        links.reduce(ActiveSupport::SafeBuffer.new) do |buffer, link|
-          buffer + content_tag(:li, link)
-        end
-      end
-
-      return content_tag(:div, button + list, class: 'dropdown', style: 'display: inline-block;')
-    end
-  end
-end
+module Kadmin
+  module NavigationHelper
+    # Generates HTML for a bootstrap navigation link
+    # @param [String] title the navigation text
+    # @param [Hash, String] path the path for the link
+    # @param [Proc] block optional block to include content within the link
+    def nav_link_to(title, path, &block)
+      css_classes = []
+      css_classes << 'active' if request.path.starts_with?(path)
+      return content_tag(:li, link_to(title, path, &block), class: css_classes.join(' '))
+    end
+
+    # Generates a navigation drop down for bootstrap
+    # @param [String] prompt dropdown prompt
+    # @param [Array<Hash,String>] links list of links to add within the dropdown
+    def dropdown(prompt, links = [])
+      button_content = content_tag(:span, '', class: 'caret').prepend(prompt)
+      button = button_tag(button_content, type: 'button', data: { toggle: 'dropdown' }, class: 'btn btn-sm')
+      list = content_tag(:ul, '', class: 'dropdown-menu') do
+        links.reduce(ActiveSupport::SafeBuffer.new) do |buffer, link|
+          buffer + content_tag(:li, link)
+        end
+      end
+
+      return content_tag(:div, button + list, class: 'dropdown', style: 'display: inline-block;')
+    end
+  end
+end