ui_bibz 0.9.0

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'UiBibz'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/config/locales/en.yml

@@ -0,0 +1,14 @@
+en:
+  ui_bibz:
+    grid:
+      pagination:
+        per_page: 'Per page: '
+      searchable:
+        field:
+          placeholder: 'Search by %{searchable_attributes}...'
+      actions:
+        defaults:
+          title: 'Actions'
+          show: 'Show'
+          delete: 'Delete'
+          edit: 'Edit'

data/config/locales/fr.yml

@@ -0,0 +1,14 @@
+fr:
+  ui_bibz:
+    grid:
+      pagination:
+        per_page: 'Par page : '
+      searchable:
+        field:
+          placeholder: 'Recherche par %{searchable_attributes}...'
+      actions:
+        defaults:
+          title:  'Actions'
+          show:   'Voir'
+          delete: 'Supprimer'
+          edit:   'Editer'

data/lib/tasks/ui_bibz_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :ui_bibz do
+#   # Task goes here
+# end

data/lib/ui_bibz/concerns/models/searchable.rb

@@ -0,0 +1,93 @@
+module UiBibz::Concerns::Models::Searchable
+  extend ActiveSupport::Concern
+
+  included do
+    # Maybe create a class to put all methods of table_search_pagination
+    def self.table_search_pagination params, session, args = {}
+      @params     = params
+      @session    = session
+      @arguments  = args
+      OpenStruct.new(records: search_sort_paginate,
+                     model:      self,
+                     controller: params[:controller],
+                     direction:  params[:direction],
+                     search:     params[:search],
+                     sort:       params[:sort],
+                     searchable_attributes: @searchable_attributes,
+                     action:     params[:action])
+    end
+
+
+  private
+
+    def self.search
+      sql         = all
+      column_args = get_column_args
+
+      # Add joins
+      sql = joins(column_args[:joins]) if column_args[:joins]
+
+      # Append special argument for sort countable
+      sql = generate_select_count_sort_query sql, column_args if column_args[:count]
+
+      # Manage parent sort in the same model
+      sql = generate_parent_sort_query sql if @params[:parent]
+
+      # Main query with argument or not
+      sql = search_by_query sql unless @params[:search].blank?
+
+      # Select Count or Not
+      if column_args[:count]
+        sq = "SELECT * FROM (#{ sql.group(table_name + '.id').to_sql }) countable ORDER BY countable.count #{ @params[:direction] || asc }"
+        self.paginate_by_sql(sq, :page => @params[:page], per_page: @session[:per_page])
+      else
+        sql.order(order_sql).paginate(:page => @params[:page], per_page: @session[:per_page])
+      end
+
+    end
+
+    def self.generate_select_count_sort_query sql, column_args
+      sql.select("#{ table_name }.*, count(#{ column_args[:column] }.*)")
+    end
+
+    def self.generate_parent_sort_query sql
+      sql.select("#{ table_name }2.*, #{ @params[:sort] } AS parent_name").from("#{ table_name } #{ table_name }2").joins("LEFT OUTER JOIN #{ table_name } ON #{ table_name }2.parent_id = #{ table_name }.id")
+    end
+
+    def self.get_column_args
+      column_args = {}
+      if !@arguments[:sortable].nil? && @params[:custom_sort]
+        column_args = [@arguments[:sortable]].flatten.detect{|f| f[:column] = @params[:column_name] } || {}
+      end
+      column_args
+    end
+
+    def self.search_by_query sql
+      sql_query      = []
+      sql_attributes = {}
+
+      @searchable_attributes.each do |attribute|
+        sql_query << "lower(#{ self.to_s.downcase.pluralize }.#{ attribute }) LIKE :#{ attribute }"
+        sql_attributes = sql_attributes.merge(Hash[attribute, "%#{ @params[:search].downcase }%"])
+      end
+
+      sql.where([sql_query.join(' OR '), sql_attributes])
+    end
+
+    def self.order_sql
+      @params[:sort].nil? || @params[:direction].nil? ? "#{ self.table_name }.id asc" : "#{ @params[:sort]} #{ @params[:direction] }"
+    end
+
+    def self.search_sort_paginate
+      @session[:per_page] = @params[:per_page] unless @params[:per_page].nil?
+      self.search
+    end
+  end
+
+  module ClassMethods
+    def searchable_attributes *args
+      @searchable_attributes ||= args
+    end
+  end
+
+end

data/lib/ui_bibz/helpers/meta_helper.rb

@@ -0,0 +1,27 @@
+module UiBibz::Helpers::MetaHelper
+
+  # Returns html script tags to include boostrap 3.3.1 [js,css], jquery 2.1.1 [js],
+  # font-awesome 4.2.0 [css]
+  #
+  #   ui_bibz_meta_links
+  #   # => <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css" media="screen" rel="stylesheet" />
+  #   #    <link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" media="screen" rel="stylesheet" />
+  #   #    <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap-theme.min.css" media="screen" rel="stylesheet" />
+  #   #    <script src=="https://code.jquery.com/jquery-2.1.1.min.js"></script>
+  #   #    <script src=="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"></script>
+  def ui_bibz_meta_links
+    capture do
+      # Latest compiled and minified CSS
+      concat stylesheet_link_tag "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css"
+      # font awesome icons
+      concat stylesheet_link_tag "https://maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css"
+      # Optional theme
+      concat stylesheet_link_tag "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap-theme.min.css"
+      # Jquery is required for boostrap
+      concat javascript_include_tag 'https://code.jquery.com/jquery-2.1.1.min.js'
+      # Latest compiled and minified JavaScript
+      concat javascript_include_tag "https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/js/bootstrap.min.js"
+    end
+  end
+
+end

data/lib/ui_bibz/helpers/ui_helper.rb

@@ -0,0 +1,108 @@
+module UiBibz::Helpers::UiHelper
+
+  def panel content = nil, options = nil, html_options = nil, &block
+    is_tap = (content[:tap] if content.kind_of?(Hash)) || (options[:tap] unless options.nil?)
+    if is_tap
+      UiBibz::Ui::Panel.new(content, options, html_options).tap(&block).render
+    else
+      UiBibz::Ui::Panel.new(content, options, html_options, &block).render
+    end
+  end
+
+  # Use "notify" instead of "alert" : due to "actionview (4.2.0) lib/action_view/helpers/form_helper.rb" conflict
+  def notify content = nil, options = nil, html_options = nil, &block
+    UiBibz::Ui::Alert.new(content, options, html_options, &block).render
+  end
+
+  # Use "lab" instead of "label" : due to "actionview (4.2.0) lib/action_view/helpers/form_helper.rb" conflict
+  def lab content = nil, options = nil, html_options = nil, &block
+    UiBibz::Ui::Label.new(content, options, html_options, &block).render
+  end
+
+  def jumbotron content = nil, options = nil, html_options = nil, &block
+    UiBibz::Ui::Jumbotron.new(content, options, html_options, &block).render
+  end
+
+  def nav content = nil, options = nil, html_options = nil, &block
+    UiBibz::Ui::Nav.new(content, options, html_options).tap(&block).render
+  end
+
+  def list_group content = nil, options = nil, html_options = nil, &block
+    UiBibz::Ui::ListGroup.new(content, options, html_options).tap(&block).render
+  end
+
+  def grid options = nil, html_options = nil, &block
+    UiBibz::Ui::Grid.new(options, html_options).tap(&block).render
+  end
+
+  # Table section begin ------------------------------------------------------
+
+  def table content = nil, options = nil, html_options = nil, &block
+    is_tap = (content[:tap] if content.kind_of?(Hash)) || (options[:tap] unless options.nil?)
+    if is_tap
+      UiBibz::Ui::Table.new(content, options, html_options).tap(&block).render
+    else
+      UiBibz::Ui::Table.new(content, options, html_options, &block).render
+    end
+  end
+
+  def table_search_field options, html_options = nil
+    UiBibz::Ui::TableSearchField.new(options, html_options).render
+  end
+
+  def table_pagination_per_page options, html_options = nil
+    UiBibz::Ui::TablePaginationPerPage.new(options, html_options).render
+  end
+
+  def table_pagination options, html_options = nil
+    UiBibz::Ui::TablePagination.new(options, html_options).render
+  end
+
+  def table_panel content = nil, options = nil, html_options = nil, &block
+    is_tap = (content[:tap] if content.kind_of?(Hash)) || (options[:tap] unless options.nil?)
+    if is_tap
+      UiBibz::Ui::TablePanel.new(content, options, html_options).tap(&block).render
+    else
+      UiBibz::Ui::TablePanel.new(content, options, html_options, &block).render
+    end
+  end
+
+  # Table section end -------------------------------------------------------
+
+  # Button section begin ----------------------------------------------------
+
+  def button_link content = nil, options = nil, html_options = nil, &block
+    UiBibz::Ui::ButtonLink.new(content, options, html_options, &block).render
+  end
+
+  def button_group content = nil, options = nil, html_options = nil, &block
+    UiBibz::Ui::ButtonGroup.new(content, options, html_options, &block).render
+  end
+
+  def button content = nil, options = nil, html_options = nil, &block
+    UiBibz::Ui::Button.new(content, options, html_options, &block).render
+  end
+
+  def button_dropdown name, options = nil, html_options = nil, &block
+    UiBibz::Ui::ButtonDropdown.new(name, options, html_options).tap(&block).render
+  end
+
+  def button_split_dropdown name, options = nil, html_options = nil, &block
+    UiBibz::Ui::ButtonSplitDropdown.new(name, options, html_options).tap(&block).render
+  end
+
+  # Button section end ----------------------------------------------------
+
+  def breadcrumb content = nil, options = nil, html_options = nil, &block
+    UiBibz::Ui::Breadcrumb.new(content, options, html_options).tap(&block).render
+  end
+
+  def dropdown name, options = nil, html_options = nil, &block
+    UiBibz::Ui::Dropdown.new(name, options, html_options).tap(&block).render
+  end
+
+  def glyph content, options = nil, html_options = nil, &block
+    UiBibz::Ui::Glyph.new(content, options, html_options, &block).render
+  end
+
+end

data/lib/ui_bibz/helpers/utils_helper.rb

@@ -0,0 +1,9 @@
+module UiBibz::Helpers::UtilsHelper
+
+  # Same method like I18n.translate but accept
+  # strings in default argument
+  def translatize translation, options
+    UiBibz::Utils::Internationalization.new(translation, options).translate
+  end
+
+end

data/lib/ui_bibz/rails/engine.rb

@@ -0,0 +1,39 @@
+# to load pagination in rails app
+require 'will_paginate'
+
+module UiBibz
+  module Rails
+    class Engine < ::Rails::Engine
+
+      initializer "ui_bibz.helpers" do
+        ActionView::Base.send :include, UiBibz::Helpers::UiHelper
+        ActionView::Base.send :include, UiBibz::Helpers::UtilsHelper
+        ActionView::Base.send :include, UiBibz::Helpers::MetaHelper
+      end
+
+      #initializer 'ui_bibz.include_concerns' do
+      #  #ActiveRecord::Base.send :include, UiBibz::Concerns::Models
+      #  ActionDispatch::Reloader.to_prepare do
+      #    ActionDispatch::Base.send :include, UiBibz::Concerns::Models
+      #    #ActionDispatch::Base.send :include, UiBibz::Concerns::Models
+      #  end
+      #end
+
+      # Autoload from lib directory
+      #config.autoload_paths << File.expand_path('../../', __FILE__)
+
+      # # Maybe remove ?
+      # initializer "ui_bibz.load_app_instance_data" do |app|
+      #   UiBibz.setup do |config|
+      #     config.app_root = app.root
+      #   end
+      # end
+
+      # # Maybe remove ?
+      # initializer "ui_bibz.load_static_assets" do |app|
+      #   app.middleware.use ::ActionDispatch::Static, "#{root}/public"
+      # end
+
+    end
+  end
+end

data/lib/ui_bibz/ui/alert.rb

@@ -0,0 +1,67 @@
+module UiBibz::Ui
+
+  # Create an alert
+  #
+  # 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:
+  # * +state+ - State of élement with symbol value:
+  #   (+:default+, +:primary+, +:info+, +:warning+, +:danger+)
+  # * +glyph+ - Add glyph with name or hash options
+  #   * +name+ - String
+  #   * +size+ - Integer
+  #   * +type+ - Symbol
+  #
+  # ==== Signatures
+  #
+  #   UiBibz::Ui::Alert.new(content, options = nil, html_options = nil)
+  #
+  #   UiBibz::Ui::Alert.new(options = nil, html_options = nil) do
+  #     content
+  #   end
+  #
+  # ==== Examples
+  #
+  #   UiBibz::Ui::Alert.new(content, { type: :success, glyph: 'eye' },{ class: 'test' }).render
+  #   # or
+  #   UiBibz::Ui::Alert.new({glyph: { name: 'eye', size: 3}, { class: 'test' }) do
+  #     content
+  #   end.render
+  #
+  class Alert < Component
+
+    def initialize content = nil, options = nil, html_options = nil, &block
+      super
+    end
+
+    def render
+      content_tag :div, class_and_html_options('alert').merge({ role: 'alert'}) do
+        concat glyph_and_content_html
+        concat close_html if @options[:close]
+      end
+    end
+
+  private
+
+    def close_html
+      content_tag :button, type: 'button', class: 'close', "data-dismiss" => "alert", "aria-label" => "Close" do
+        content_tag :span, "x", "aria-hidden" => true
+      end
+    end
+
+    def state
+      sym = @options[:state] || :info
+      "alert-#{ states[sym] }"
+    end
+
+  end
+end

data/lib/ui_bibz/ui/breadcrumb/breadcrumb.rb

@@ -0,0 +1,54 @@
+require 'ui_bibz/ui/breadcrumb/components/breadcrumb_link'
+module UiBibz::Ui
+  class Breadcrumb < Component
+
+    # Create a breadcrumb
+    #
+    # This element is an extend of UiBibz::Ui::Component.
+    # You can use tap method to add link items.
+    #
+    # ==== Attributes
+    #
+    # * +content+ - Content of element
+    # * +options+ - Options of element
+    # * +html_options+ - Html Options of element
+    #
+    # ==== Signatures
+    #
+    #   UiBibz::Ui::Breadcrumb.new().tap do |b|
+    #     b.link content = nil, options = nil, html_options = nil, &block
+    #     b.link content = nil, options = nil, html_options = nil, &block
+    #     b.link content = nil, options = nil, html_options = nil, &block
+    #     ...
+    #   end
+    #
+    #   UiBibz::Ui::Alert.new(options = nil, html_options = nil) do
+    #     content
+    #   end
+    #
+    # ==== Examples
+    #
+    #   UiBibz::Ui::Breadcrumb.new().tap do |b|
+    #     b.link 'Home', url: '#home'
+    #     b.link url: '#level-1' do
+    #       'Level 1'
+    #     end
+    #     b.link 'Level 2', status: :active
+    #   end.render
+    #
+    def initialize content = nil, options = nil, html_options = nil, &block
+      super
+      @links = []
+    end
+
+    def render
+      content_tag :ol, @links.join.html_safe, class_and_html_options("breadcrumb")
+    end
+
+    # See UiBibz::Ui::BreadcrumbLink
+    def link content = nil, options = nil, html_options = nil, &block
+      @links << BreadcrumbLink.new(content, options, html_options, &block).render
+    end
+
+  end
+end

data/lib/ui_bibz/ui/breadcrumb/components/breadcrumb_link.rb

@@ -0,0 +1,62 @@
+module UiBibz::Ui
+
+  # Create a BreadcrumbLink
+  #
+  # 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:
+  # * +status+ - State of élement with symbol value:
+  #   (+:active+)
+  # * +url+ - String
+  # * +glyph+ - Add glyph with name or hash options
+  #   * +name+ - String
+  #   * +size+ - Integer
+  #   * +type+ - Symbol
+  #
+  # ==== Signatures
+  #
+  #   UiBibz::Ui::BreadcrumbLink.new(content, options = nil, html_options = nil)
+  #
+  #   UiBibz::Ui::BreadcrumbLink.new(options = nil, html_options = nil) do
+  #     content
+  #   end
+  #
+  # ==== Examples
+  #
+  #   UiBibz::Ui::BreadcrumbLink.new('Home', { glyph: 'home', status: :active },{ class: 'test' }).render
+  #
+  #   UiBibz::Ui::BreadcrumbLink.new({glyph: { name: 'eye', size: 3}, { class: 'test' }) do
+  #     'Home'
+  #   end.render
+  #
+  class BreadcrumbLink < Component
+
+    def initialize content = nil, options = nil, html_options = nil, &block
+      super
+    end
+
+    def render
+      content_tag :li, link_html, class_and_html_options
+    end
+
+  private
+
+    def link_html
+      if @options[:url]
+        link_to glyph_and_content_html, @options[:url], @options[:link_html_options]
+      else
+        glyph_and_content_html
+      end
+    end
+
+  end
+end

data/lib/ui_bibz/ui/button/button.rb

@@ -0,0 +1,65 @@
+module UiBibz::Ui
+
+  # Create a button
+  #
+  # 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:
+  # * +state+ - State of élement with symbol value:
+  #   (+:default+, +:primary+, +:info+, +:warning+, +:danger+)
+  # * +size+
+  #   (+:xs+, +:sm+, +:lg+)
+  # * +glyph+ - Add glyph with name or hash options
+  #   * +name+ - String
+  #   * +size+ - Integer
+  #   * +type+ - Symbol
+  #
+  # ==== Signatures
+  #
+  #   UiBibz::Ui::Button.new(content, options = nil, html_options = nil)
+  #
+  #   UiBibz::Ui::Button.new(options = nil, html_options = nil) do
+  #     content
+  #   end
+  #
+  # ==== Examples
+  #
+  #   UiBibz::Ui::Button.new('test', type: :primary, size: :xs).render
+  #
+  #   UiBibz::Ui::Button.new(type: :primary) do
+  #     test
+  #   end.render
+  #
+  class Button < Component
+
+    def initialize content = nil, options = nil, html_options = nil, &block
+      super
+    end
+
+    def render
+      content_tag :button, glyph_and_content_html, class_and_html_options(['btn', size])
+    end
+
+  private
+
+    def state
+      sym = @options[:state] || :default
+      "btn-#{  states[sym] }"
+    end
+
+    # :lg, :sm or :xs
+    def size
+      "btn-#{ @options[:size] }" if @options[:size]
+    end
+
+  end
+end