ui_bibz 0.9.0

data/lib/ui_bibz/ui/panel.rb

@@ -0,0 +1,101 @@
+module UiBibz::Ui
+
+  # Create a panel
+  #
+  # This element is an extend of UiBibz::Ui::Component.
+  # You can use tap method to add header, body or footer element.
+  #
+  # ==== Attributes
+  #
+  # * +content+ - Content of element
+  # * +options+ - Options of element
+  # * +html_options+ - Html Options of element
+  #
+  # ==== Options
+  #
+  # You can add HTML attributes using the +html_options+.
+  # You can pass arguments in options attribute:
+  # * +state+ - State of élement with symbol value:
+  #   (+:default+, +:primary+, +:info+, +:warning+, +:danger+)
+  #
+  # ==== Signatures
+  #
+  #   UiBibz::Ui::Panel.new(content, options = nil, html_options = nil)
+  #
+  #   UiBibz::Ui::Panel.new(options = nil, html_options = nil) do
+  #     content
+  #   end
+  #
+  #   UiBibz::Ui::Panel.new(options = nil, html_options = nil).tap do |p|
+  #     p.header content = nil, options = nil, html_options = nil, &block
+  #     p.body content = nil, options = nil, html_options = nil, &block
+  #     p.footer content = nil, options = nil, html_options = nil, &block
+  #   end
+  #
+  # ==== Examples
+  #
+  #   UiBibz::Ui::Panel('test').render
+  #
+  #   UiBibz::Ui::Panel(state: :primary) do |d|
+  #     'test'
+  #   end.render
+  #
+  #   UiBibz::Ui::Panel.new().tap do |p|
+  #     p.header 'header', glyph: 'eye', class: 'header-test'
+  #     p.body do
+  #       'body'
+  #     end
+  #     p.footer 'footer'
+  #   end.render
+  #
+  class Panel < Component
+
+    def initialize content = nil, options = nil, html_options = nil, &block
+      super
+    end
+
+    # Header is a component element
+    def header content = nil, options = nil, html_options = nil, &block
+      @header = Component.new content, options, html_options, &block
+    end
+
+    # Body is a component element
+    def body content = nil, options = nil, html_options = nil, &block
+      @body = Component.new content, options, html_options, &block
+    end
+
+    # Footer is a component element
+    def footer content = nil, options = nil, html_options = nil, &block
+      @footer = Component.new content, options, html_options, &block
+    end
+
+    def render
+      content_tag :div, class_and_html_options("panel") do
+        concat(header_html) unless @header.nil?
+        concat(body_html)   if !@body.nil? || !@content.nil?
+        concat(footer_html) unless @footer.nil?
+      end
+    end
+
+    def state
+      sym = @options[:state] || :default
+      "panel-#{ states[sym] }"
+    end
+
+  protected
+
+    def header_html
+      content_tag :div, @header.render, @header.class_and_html_options("panel-heading")
+    end
+
+    def body_html
+      @body = Component.new @content unless @content.nil?
+      content_tag :div, @body.render, @body.class_and_html_options("panel-body")
+    end
+
+    def footer_html
+      content_tag :div, @footer.render, @footer.class_and_html_options("panel-footer")
+    end
+
+  end
+end

data/lib/ui_bibz/ui/table/components/actions.rb

@@ -0,0 +1,44 @@
+require "ui_bibz/ui/table/components/table_action"
+module UiBibz::Ui
+  class Actions
+
+    def initialize store
+      @store   = store
+      @actions = []
+    end
+
+    def action content = nil, options = nil, html_options = nil, &block
+      @actions << TableAction.new(content, options, html_options, &block).render
+    end
+
+    def list
+      @actions.empty? ? defaults_actions : @actions
+    end
+
+  private
+
+    def defaults_actions
+      [
+        TableAction.new(show_name, url: { controller: @store.controller, action: 'show', id: :id }, glyph: 'eye').render,
+        TableAction.new(edit_name, url:{ controller: @store.controller, action: 'edit', id: :id }, glyph: 'pencil').render,
+        TableAction.new(delete_name, url: { controller: @store.controller, id: :id }, method: :delete, glyph: 'trash', data: { confirm: 'Are you sure?' }).render,
+      ]
+    end
+
+    def show_name
+      defaults = ['ui_bibz.table.actions.defaults.show', 'Show']
+      UiBibz::Utils::Internationalization.new("ui_bibz.table.actions.#{ @store.model.to_s.underscore }.show", default: defaults).translate
+    end
+
+    def edit_name
+      defaults = ['ui_bibz.table.actions.defaults.edit', 'Edit']
+      UiBibz::Utils::Internationalization.new("ui_bibz.table.actions.#{ @store.model.to_s.underscore }.edit", default: defaults).translate
+    end
+
+    def delete_name
+      defaults = ['ui_bibz.table.actions.defaults.delete', 'Delete']
+      UiBibz::Utils::Internationalization.new("ui_bibz.table.actions.#{ @store.model.to_s.underscore }.delete", default: defaults).translate
+    end
+
+  end
+end

data/lib/ui_bibz/ui/table/components/column.rb

@@ -0,0 +1,34 @@
+module UiBibz::Ui
+  class Column
+
+    attr_accessor :hidden, :link, :name, :data_index, :date_format, :sort, :format, :date_format, :count, :custom_sort, :parent
+
+    def initialize args
+      @args        = args
+      @link        = args[:link] # show or edit
+      @name        = args[:name]
+      @order       = args[:order]
+      @data_index  = args[:data_index]
+      @date_format = args[:date_format]
+      @sort        = args[:sort]
+      @custom_sort = args[:custom_sort]
+      @parent      = args[:parent]
+      @count       = args[:count]
+      @format      = args[:format]
+      @hidden      = args[:hidden]
+    end
+
+    def linkable?
+      !@link.nil?
+    end
+
+    def order
+      @order || 0
+    end
+
+    def hidden?
+      @hidden == true
+    end
+
+  end
+end

data/lib/ui_bibz/ui/table/components/columns.rb

@@ -0,0 +1,16 @@
+module UiBibz::Ui
+  class Columns
+
+    def initialize columns = nil
+      @columns = columns || []
+    end
+
+    def column hash
+      @columns << Column.new(hash)
+    end
+
+    def list
+      @columns
+    end
+  end
+end

data/lib/ui_bibz/ui/table/components/store.rb

@@ -0,0 +1,67 @@
+require 'ui_bibz/ui/table/components/columns'
+require 'ui_bibz/ui/table/components/column'
+module UiBibz::Ui
+  class Store
+
+    attr_accessor :records
+
+    def initialize store
+      @records = store.records
+      @store   = store
+      @model   = store.model
+    end
+
+    def total_pages
+      @records.total_pages
+    end
+
+    def per_page
+      @records.per_page
+    end
+
+    def total_entries
+      @records.total_entries
+    end
+
+    def sort
+      @store.sort
+    end
+
+    def direction
+      @store.direction
+    end
+
+    def searchable_attributes
+      @store.searchable_attributes
+    end
+
+    def current_page
+      @records.current_page
+    end
+
+    def limit_value
+      @records.limit_value
+    end
+
+    def columns
+      @columns ||= Columns.new model.new.attributes.keys.map{ |record| Column.new({ data_index: record, name: record.humanize }) }
+    end
+
+    def model
+      @model
+    end
+
+    def search
+      @store.search
+    end
+
+    def controller
+      @store.controller
+    end
+
+    def action
+      @store.action
+    end
+
+  end
+end

data/lib/ui_bibz/ui/table/components/table_action.rb

@@ -0,0 +1,21 @@
+module UiBibz::Ui
+  class TableAction < Component
+
+    DIVIDER = '---'
+
+    def initialize content = nil, options = nil, html_options = nil, &block
+      super
+    end
+
+    def render
+      @content == DIVIDER ? DIVIDER : link_html
+    end
+
+  private
+
+    def link_html
+      link_to glyph_and_content_html, @options[:url], class_and_html_options
+    end
+
+  end
+end

data/lib/ui_bibz/ui/table/table.rb

@@ -0,0 +1,146 @@
+require "ui_bibz/ui/table/components/store"
+require "ui_bibz/ui/table/components/columns"
+require "ui_bibz/ui/table/components/column"
+require "ui_bibz/ui/table/components/actions"
+require "ui_bibz/ui/table/ux/paginable"
+require "ui_bibz/ui/table/ux/paginable"
+require "ui_bibz/ui/table/ux/searchable"
+require "ui_bibz/ui/table/ux/sortable"
+require "ui_bibz/ui/table/ux/actionable"
+module UiBibz::Ui
+
+  # Create a Table
+  #
+  # This element is an extend of UiBibz::Ui::Component.
+  #
+  # ==== Attributes
+  #
+  # * +content+ - Content of element
+  # * +options+ - Options of element
+  # * +html_options+ - Html Options of element
+  #
+  # ==== Options
+  #
+  # You can add HTML attributes using the +html_options+.
+  # You can pass arguments in options attribute:
+  # * +store+ - Store generate by '+table_search_pagination+' method
+  # * +url+ - String
+  # * tap - Boolean
+  # * columns - Add column
+  # * actions - Add action by row
+  #
+  # ==== Signatures
+  #
+  #   UiBibz::Ui::Table.new(store: @store)
+  #
+  #   UiBibz::Ui::Table.new(store: @store, tap: true) do |t|
+  #     t.columns do |c|
+  #       c.column name: '#', data_index: '#'
+  #     end
+  #     t.action do |a|
+  #       a.action '', url: url, glyph: ''
+  #     end
+  #   end
+  #
+  # ==== Examples
+  #
+  #   UiBibz::Ui::Table.new(store: @users).render
+  #
+  #   UiBibz::Ui::Table.new(store: @users).tap do |t|
+  #     t.columns do |c|
+  #       c.column name: '#', data_index: 'id'
+  #       c.column name: 'Name fr', data_index: 'name_fr', link: edit_user_path(:id), order: 2
+  #       c.column name: 'Name en', data_index: 'name_en', order: 1
+  #       c.column name: 'Name en', data_index: 'name_en', format: lambda{ |records, record| "name #{ record.id}"}
+  #     end
+  #     t.action do |a|
+  #       a.action 'toto', url: users_path(:id), glyph: 'eye'
+  #       a.action '---'
+  #       a.action 'momo', url: users_path(:id), glyph: 'home'
+  #     end
+  #   end.render
+  #
+  class Table < Component
+
+    attr_accessor :columns
+
+    def initialize content = nil, options = nil, html_options = nil, &block
+      super
+      @columns = Columns.new
+      @actions = Actions.new store
+    end
+
+    def columns &block
+      @columns.tap(&block)
+    end
+
+    def actions &block
+      @actions.tap(&block)
+    end
+
+    def render
+      table_html
+    end
+
+    def store
+      @store ||= if @options[:store].nil?
+        raise 'Store is nil!'
+      elsif @options[:store].try(:records).nil?
+        raise 'Store can be created only with "table_search_pagination" method!'
+      else
+        Store.new @options.delete :store
+      end
+    end
+
+  protected
+
+    def sort
+      @sort ||= Sortable.new store, @options
+    end
+
+    def action
+      @action ||= Actionable.new store, @options, @actions
+    end
+
+    def cols
+      @columns.list.empty? ? store.columns.list : @columns.list
+    end
+
+    def type
+      "table-#{ @options[:type] }"
+    end
+
+    def table_html
+      content_tag(:table, class_and_html_options(["table", type])) do
+
+        ths = cols.collect do |col|
+          content_tag(:th, sort.header(col)) unless col.hidden?
+        end
+
+        ths = action.header ths
+        concat content_tag(:tr, ths.join.html_safe)
+
+        store.records.each do |record|
+          tds = cols.collect do |col|
+            content_tag(:td, td_content(record, col)) unless col.hidden?
+          end
+
+          tds = action.body record, tds
+          concat content_tag :tr, tds.join.html_safe
+        end
+      end
+    end
+
+    # Maybe create a class for td_content
+    def td_content record, col
+      content = col.count ? record.send(col.data_index).count : record.send(col.data_index)
+      unless content.nil?
+        content = content.strftime(col.date_format)                    unless col.date_format.nil?
+        content = link_to content, action.inject_url(col.link, record) unless col.link.nil?
+        content = col.format.call(@store.records, record)              unless col.format.nil?
+        content
+      end
+    end
+
+  end
+end

data/lib/ui_bibz/ui/table/table_pagination.rb

@@ -0,0 +1,29 @@
+require 'will_paginate'
+require "will_paginate-bootstrap"
+require "ui_bibz/ui/table/components/store"
+module UiBibz::Ui
+  class TablePagination < Ui
+    include WillPaginate::ActionView
+
+    def initialize options = nil, html_options = nil
+      @pagination = Component.new nil, options, html_options
+    end
+
+    def render
+      will_paginate(store.records, params: { controller: store.controller },  renderer: BootstrapPagination::Rails)
+    end
+
+  private
+
+    def store
+      @store ||= if @pagination.options[:store].nil?
+        raise 'Store is nil!'
+      elsif @pagination.options[:store].try(:records).nil?
+        raise 'Store can be created only with "table_search_pagination" method!'
+      else
+        Store.new @pagination.options.delete :store
+      end
+    end
+
+  end
+end

data/lib/ui_bibz/ui/table/table_pagination_per_page.rb

@@ -0,0 +1,53 @@
+require "ui_bibz/ui/table/components/store"
+module UiBibz::Ui
+  class TablePaginationPerPage < Ui
+    include WillPaginate::ActionView
+
+    def initialize options = nil, html_options = nil
+      @per_page_field = Component.new nil, options, html_options
+    end
+
+    def render
+      if @per_page_field.options[:wrap_form] != false
+        form_tag(url_for(controller: store.controller, action: store.action), method: :get) do
+          per_page_html
+        end
+      else
+        per_page_html
+      end
+    end
+
+  private
+
+    def store
+      @store ||= if @per_page_field.options[:store].nil?
+        raise 'Store is nil!'
+      elsif @per_page_field.options[:store].try(:records).nil?
+        raise 'Store can be created only with "table_search_pagination" method!'
+      else
+        Store.new @per_page_field.options.delete :store
+      end
+    end
+
+    def per_page_html
+      content_tag :div, class: 'table-pagination-per-page' do
+        concat results_count_html
+        concat UiBibz::Utils::Internationalization.new("ui_bibz.table.pagination.per_page", default: "Per page: ").translate
+        concat select_tag('per_page', options_for_select([25, 50, 100], store.per_page), class: 'form-control')
+      end
+    end
+
+    def results_count_html
+      "#{ page_entries_info store.records } | ".html_safe
+    end
+
+    def from_current_results
+      store.limit_value * store.current_page - store.limit_value + 1
+    end
+
+    def to_current_results
+      store.limit_value * store.current_page
+    end
+
+  end
+end

data/lib/ui_bibz/ui/table/table_panel.rb

@@ -0,0 +1,66 @@
+module UiBibz::Ui
+  class TablePanel < Panel
+
+    attr_accessor :columns
+
+    def initialize content = nil, options = nil, html_options = nil, &block
+      super
+      @store        = @options.delete(:store) if @options[:store]
+      table_options = (@options[:table_options] || {}).merge({ store: @store })
+      @table        = UiBibz::Ui::Table.new(table_options, @options[:table_html_options])
+    end
+
+    def render
+      initialize_header
+      initialize_footer
+
+      content_tag :div, class_and_html_options(panel_classes) do |f|
+        form_tag(url_for(controller: @store.controller, action: @store.action), method: :get) do
+          concat(header_html)   unless @header.nil?
+          concat(body_html)     unless @body.nil?
+          concat(table_html)    unless @store.nil?
+          concat(footer_html)   unless @footer.nil?
+        end
+      end
+    end
+
+    def columns &block
+      @table.columns &block
+    end
+
+    def actions &block
+      @table.actions &block
+    end
+
+  private
+
+    def table_html
+      content_tag :div, @table.render, class: 'panel-table'
+    end
+
+    def panel_classes
+      %w(panel panel-default table-panel)
+    end
+
+    def search
+      @search ||= Searchable.new @store, @options
+    end
+
+    def pagination
+      @pagination ||= Paginable.new @store, @options
+    end
+
+    def initialize_footer
+      @footer = @table.pagination
+    end
+
+    def initialize_header
+      @header = Component.new search.render
+    end
+
+    def initialize_footer
+      @footer = Component.new(pagination.render) if pagination.paginable?
+    end
+
+  end
+end

data/lib/ui_bibz/ui/table/table_search_field.rb

@@ -0,0 +1,62 @@
+require "ui_bibz/ui/table/components/store"
+module UiBibz::Ui
+  class TableSearchField < Ui
+
+    def initialize options = nil, html_options = nil
+      @search_field = Component.new nil, options, html_options
+    end
+
+    def render
+      if @search_field.options[:wrap_form] != false
+        form_tag(url_for(controller: store.controller, action: store.action), method: :get) do
+          search_field_html
+        end
+      else
+        search_field_html
+      end
+    end
+
+  private
+
+    def store
+      @store ||= if @search_field.options[:store].nil?
+        raise 'Store is nil!'
+      elsif @search_field.options[:store].try(:records).nil?
+        raise 'Store can be created only with "table_search_pagination" method!'
+      else
+        Store.new @search_field.options.delete :store
+      end
+    end
+
+    def search_field_html
+      content_tag :div, @search_field.class_and_html_options(div_class) do
+        concat content_tag(:span, Glyph.new('search').render, class: 'input-group-addon')
+        concat tag(:input, type: 'search', value: store.search, name: 'search', class: 'form-control', placeholder: search_placeholder_field)
+        concat content_tag(:span, Glyph.new('times-circle').render, class: 'clear-search-btn input-group-addon')
+      end
+    end
+
+    def div_class
+      %w(input-group input-group-sm table-search-field)
+    end
+
+    def search_placeholder_field
+      UiBibz::Utils::Internationalization.new('ui_bibz.grid.searchable.field.placeholder', searchable_attributes: searchable_attributes_sentence).translate
+    end
+
+    def searchable_attributes_sentence
+      store.searchable_attributes.map do |i|
+        UiBibz::Utils::Internationalization.new("ui_bibz.grid.searchable.field.searchable_attributes.#{ model_name }.#{ i }", default: [translate_searchable_attributes_by_active_record(i), i.to_s]).translate
+      end.to_sentence(locale: I18n.locale)
+    end
+
+    def model_name
+      store.model.to_s.underscore
+    end
+
+    def translate_searchable_attributes_by_active_record attr
+      store.model.human_attribute_name(attr)
+    end
+
+  end
+end

data/lib/ui_bibz/ui/table/ux/actionable.rb

@@ -0,0 +1,59 @@
+module UiBibz::Ui
+  class Actionable < Ui
+
+    def initialize store, options, actions = nil
+      @store   = store
+      @options = options
+      @actions = actions
+    end
+
+    def actionable?
+      @options[:actionable].nil? ? true : @options[:actionable]
+    end
+
+    def header ths
+      ths << content_tag(:th, '', class: 'action') if actionable?
+      ths
+    end
+
+    def body record, tds
+      tds << td_action(record) if actionable?
+      tds
+    end
+
+    # Add "id" in url to match with current record
+    def inject_url url, record
+      url.gsub(/(\/id\/?)/, "/#{ record.id }/")
+    end
+
+  private
+
+    def dropdown_action record
+      UiBibz::Ui::Dropdown.new(dropdown_action_name, { position: :right, glyph: actions_glyph }, class: 'btn-group-xs').tap do |d|
+        unless @actions.nil?
+          actions_links(record).each do |l|
+            d.list l.html_safe
+          end
+        end
+      end.render
+    end
+
+    def actions_glyph
+      { name: 'ellipsis-v', type: 'fw' }
+    end
+
+    def dropdown_action_name
+      defaults = ["ui_bibz.table.actions.defaults.title", 'Actions']
+      UiBibz::Utils::Internationalization.new("ui_bibz.table.actions.#{ @store.model.to_s.underscore }.title", default: defaults).translate
+    end
+
+    def actions_links record
+      @actions.list.compact.map{ |l| inject_url(l, record) }
+    end
+
+    def td_action record
+      content_tag :td, dropdown_action(record)
+    end
+
+  end
+end