smart_listing 0.9.5 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b40428000bfc11c02baa6cc4bc4ffa833895374
-  data.tar.gz: 8216002025b1b94989383185e3a0e74ef6f3edd2
+  metadata.gz: daba6372bdd51039d67e7a1b1925bbc241b4bda8
+  data.tar.gz: ff6eef29b68cf482c8baf5bc7198a4f27b831e2d
 SHA512:
-  metadata.gz: fb27518994b2809cca48dc8c1b51fe6a5345eba4083d7f376f724924aa7f37ecfc86ef96f67f5245a9dd9a2880ad12ca0a24ebea54b8f4e5174844908fbcf0f6
-  data.tar.gz: c54bbcf9716bfc35e186ddaa0fcae0e4dcaa86c59e5facd0adb383adc36c016badcd210a1dda6139ba5124645f93c9b3365d7ead9d2f71bd82a66c133b32a113
+  metadata.gz: 51d818330f8d5c6333de737bf4b141e4c2a0b49e90e91bba2cc554ae4dda94d9bc67d4f2aad8e8fe6822a5e0e13ab69450ee73c1c4b1c9deee8b2c2e0df3f4ee
+  data.tar.gz: 5bc2d838c9800a5eb040037afcc5b70a1674944997cafbbc024d88eed3a4bdd3b1f04913b99a7807dbae3a7e508fac43bf1c4ae023567096e1f5a4cb94e6525e

data/README.md

@@ -1,8 +1,43 @@
-SmartListing
-==========
+# SmartListing
 
 SmartListing helps creating sortable lists of ActiveRecord collections with pagination, filtering and inline editing.
 
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem "smart_listing"
+```
+
+Then run:
+
+```sh
+$ bundle install
+```
+
+Optionally you can also install some configuration initializer:
+
+```sh
+$ rails generate smart_listing:install
+```
+
+and views in order to customize them:
+
+```sh
+$ rails generate smart_listing:views
+```
+
+## Usage
+
+Pending...
+
+### View
+
+## Credits
+
+SmartListing uses great pagination gem Kaminari https://github.com/amatsuda/kaminari
+
 Created by Sology http://www.sology.eu
 
 Initial development sponsored by Smart Language Apps Limited http://smartlanguageapps.com/

data/app/assets/javascripts/smart_listing/smart_listing.coffee.erb

@@ -273,13 +273,13 @@ $.fn.smart_listing.showPopover = (confirmation_elem, msg, confirm) ->
 
 $.fn.smart_listing.onLoading = (content, loader) ->
   content.stop(true).fadeTo(500, 0.2)
-  loading.show()
-  loading.stop(true).fadeTo(500, 1)
+  loader.show()
+  loader.stop(true).fadeTo(500, 1)
 
 $.fn.smart_listing.onLoaded = (content, loader) ->
   content.stop(true).fadeTo(500, 1)
-  loading.stop(true).fadeTo 500, 0, () =>
-    loading.hide()
+  loader.stop(true).fadeTo 500, 0, () =>
+    loader.hide()
 
 $.fn.smart_listing_controls = () ->
   $(this).each () ->

data/app/views/smart_listing/_action_delete.html.erb

@@ -7,4 +7,4 @@
     confirmation:       confrimation text
 -%>
 
-<%= link_to(url, :remote => true, :class => "destroy", :method => :delete, :title => t("smart_listing.actions.destroy"), :data => {:confirmation => confirmation || t("smart_listing.msgs.destroy_confirmation")} ) do %><%= content_tag(:i, "", :class => icon || "glyphicon glyphicon-trash") %><% end %>
+<%= link_to(url, :remote => true, :class => "destroy", :method => :delete, :title => t("smart_listing.actions.destroy"), :data => {:confirmation => confirmation || t("smart_listing.msgs.destroy_confirmation")} ) do %><%= content_tag(:i, "", :class => icon || SmartListing.config.classes(:icon_trash)) %><% end %>

data/app/views/smart_listing/_action_edit.html.erb

@@ -6,4 +6,4 @@
     icon
 -%>
 
-<%= link_to(url, :remote => true, :class => "edit", :title => t("smart_listing.actions.edit") ) do %><%= content_tag(:i, '', :class => icon || "glyphicon glyphicon-pencil") %><% end %>
+<%= link_to(url, :remote => true, :class => "edit", :title => t("smart_listing.actions.edit") ) do %><%= content_tag(:i, '', :class => icon || SmartListing.config.classes(:icon_edit)) %><% end %>

data/app/views/smart_listing/_action_inactive.html.erb

@@ -2,4 +2,4 @@
   Inactive action.
 -%>
 
-<%= content_tag(:i, '', :class => "glyphicon glyphicon-remove-circle") %>
+<%= content_tag(:i, '', :class => SmartListing.config.classes(:icon_inactive)) %>

data/app/views/smart_listing/_action_show.html.erb

@@ -6,4 +6,4 @@
     icon
 -%>
 
-<%= link_to(url, :class => "show", :title => t("smart_listing.actions.show") ) do %><%= content_tag(:i, '', :class => icon || "glyphicon glyphicon-share-alt") %><% end %>
+<%= link_to(url, :class => "show", :title => t("smart_listing.actions.show") ) do %><%= content_tag(:i, '', :class => icon || SmartListing.config.classes(:icon_show)) %><% end %>

data/app/views/smart_listing/_item_new.html.erb

@@ -15,11 +15,11 @@
 <%= content_tag(:tr, '', :class => placeholder_classes + %w{info}) %>
 <%= content_tag(:tr, :class => new_item_action_classes + %w{info}) do %>
   <%= content_tag(:td, :colspan => colspan) do %>
-    <%= content_tag(:h5, :class => no_items_classes + %w{pull-left}) do %>
+    <%= content_tag(:p, :class => no_items_classes + %w{pull-left}) do %>
       <%= no_items_text %>
     <% end %>
     <%= link_to(new_item_button_url, :remote => true, :class => new_item_button_classes + %w{btn pull-right}) do %>
-      <%= content_tag(:i, '', :class => "glyphicon glyphicon-plus") %>
+      <%= content_tag(:i, '', :class => SmartListing.config.classes(:icon_new)) %>
       <%= new_item_button_text %>
     <% end %>
   <% end %>

data/app/views/smart_listing/_sortable.html.erb

@@ -14,8 +14,8 @@
 <%= link_to url, :class => container_classes, :data => {:attr => attribute}, :remote => true do %>
   <%= title %>
   <% if ordered %>
-    <span class="<%= smart_listing.sort_order == "asc" ? "glyphicon glyphicon-chevron-up" : "glyphicon glyphicon-chevron-down" %>"></span>
+    <span class="<%= smart_listing.sort_order == "asc" ? SmartListing.config.classes(:icon_sort_up) : SmartListing.config.classes(:icon_sort_down) %>"></span>
   <% else %>
-    <span class="glyphicon glyphicon-resize-vertical"></span>
+    <span class="<%= SmartListing.config.classes(:icon_sort_none) %>"></span>
   <% end %>
 <% end %>

data/lib/generators/smart_listing/install_generator.rb

@@ -0,0 +1,20 @@
+module SmartListing
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def self.banner #:nodoc:
+        <<-BANNER.chomp
+rails g smart_listing:install 
+
+    Copies initializer file
+BANNER
+      end
+
+      desc ''
+      def copy_views
+        template 'initializer.rb', 'config/initializers/smart_listing.rb'
+      end
+		end
+	end
+end

data/lib/generators/smart_listing/templates/initializer.rb

@@ -0,0 +1,58 @@
+SmartListing.configure do |config|
+  config.constants :classes, {
+    #:main                  => "smart-listing",
+    #:editable              => "editable",
+    #:content               => "content",
+    #:loading               => "loading",
+    #:status                => "smart-listing-status",
+    #:item_actions          => "actions",
+    #:new_item_placeholder  => "new-item-placeholder",
+    #:new_item_action       => "new-item-action",
+    #:new_item_button       => "btn",
+    #:hidden                => "hidden",
+    #:autoselect            => "autoselect",
+    #:callback              => "callback",
+    #:pagination_per_page   => "pagination-per-page",
+    #:pagination_count      => "count",
+    #:inline_editing        => "info",
+    #:no_records            => "no-records",
+    #:limit                 => "limit",
+    #:limit_alert           => "limit-alert",
+    #:controls              => "smart-listing-controls",
+    #:controls_reset        => "reset",
+    #:filtering             => "filter",
+    #:filtering_search      => "glyphicon-search",
+    #:filtering_cancel      => "glyphicon-remove",
+    #:filtering_disabled    => "disabled",
+    #:sortable              => "sortable",
+    #:icon_new              => "glyphicon glyphicon-plus",
+    #:icon_edit             => "glyphicon glyphicon-pencil",
+    #:icon_trash            => "glyphicon glyphicon-trash",
+    #:icon_inactive         => "glyphicon glyphicon-circle",
+    #:icon_show             => "glyphicon glyphicon-share-alt",
+    #:icon_sort_none        => "glyphicon glyphicon-resize-vertical",
+    #:icon_sort_up          => "glyphicon glyphicon-chevron-up",
+    #:icon_sort_down        => "glyphicon glyphicon-chevron-down",
+  }
+
+  config.constants :data_attributes, {
+    #:main                  => "smart-listing",
+    #:confirmation          => "confirmation",
+    #:id                    => "id",
+    #:href                  => "href",
+    #:callback_href         => "callback-href",
+    #:max_count             => "max-count",
+    #:inline_edit_backup    => "smart-listing-edit-backup",
+    #:params                => "params",
+    #:observed              => "observed",
+    #:href                  => "href",
+  }
+
+  config.constants :selectors, {
+    #:item_action_destroy   => "a.destroy",
+    #:edit_cancel           => "button.cancel",
+    #:row                   => "tr",
+    #:head                  => "thead",
+    #:filtering_icon        => "i"
+  }
+end

data/lib/smart_listing/config.rb

@@ -36,6 +36,14 @@ module SmartListing
           :filtering_cancel => "glyphicon-remove",
           :filtering_disabled => "disabled",
           :sortable => "sortable",
+          :icon_new => "glyphicon glyphicon-plus",
+          :icon_edit => "glyphicon glyphicon-pencil",
+          :icon_trash => "glyphicon glyphicon-trash",
+          :icon_inactive => "glyphicon glyphicon-circle",
+          :icon_show => "glyphicon glyphicon-share-alt",
+          :icon_sort_none => "glyphicon glyphicon-resize-vertical",
+          :icon_sort_up => "glyphicon glyphicon-chevron-up",
+          :icon_sort_down => "glyphicon glyphicon-chevron-down",
         },
         :data_attributes => {
           :main => "smart-listing",

data/lib/smart_listing/version.rb

@@ -1,3 +1,3 @@
 module SmartListing
-  VERSION = "0.9.5"
+  VERSION = "0.9.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_listing
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 0.9.6
 platform: ruby
 authors:
 - Sology
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -77,7 +77,6 @@ files:
 - README.md
 - Rakefile
 - app/assets/javascripts/smart_listing/application.js
-- app/assets/javascripts/smart_listing/smart_listing.coffee
 - app/assets/javascripts/smart_listing/smart_listing.coffee.erb
 - app/assets/stylesheets/smart_listing/application.css
 - app/helpers/smart_listing/application_helper.rb
@@ -100,6 +99,8 @@ files:
 - app/views/smart_listing/item/_update.js.erb
 - config/locales/en.yml
 - config/routes.rb
+- lib/generators/smart_listing/install_generator.rb
+- lib/generators/smart_listing/templates/initializer.rb
 - lib/generators/smart_listing/views_generator.rb
 - lib/smart_listing.rb
 - lib/smart_listing/config.rb

data/app/assets/javascripts/smart_listing/smart_listing.coffee

@@ -1,333 +0,0 @@
-# Useful when smart list target url is different than current one
-$.rails.href = (element) ->
-  element.attr('href') || element.data('href')
-
-$.fn.observeField = (opts = {}) ->
-   field = $(this)
-   key_timeout = null
-   last_value = null
-   options =
-     onFilled: () ->
-     onEmpty: () ->
-     onChange: () ->
-   options = $.extend(options, opts)
- 
-   keyChange = () ->
-     if field.val().length > 0
-       options.onFilled()
-     else
-       options.onEmpty()
-
-     if field.val() == last_value && field.val().length != 0
-       return
-     lastValue = field.val()
- 
-     options.onChange()
- 
-   field.data('observed', true)
- 
-   field.bind 'keydown', (e) ->
-     if(key_timeout)
-       clearTimeout(key_timeout)
- 
-     key_timeout = setTimeout(->
-       keyChange()
-     , 400)
-
-class SmartListing
-  constructor: (e) ->
-    @container = e
-    @name = @container.attr('id')
-    @loading = @container.find('.loading')
-    @content = @container.find('.content')
-    @status = $(".smart_listing_status[data-smart-listing='#{@name}']")
-    @confirmed = null
-
-    createPopover = (confirmation_elem, msg) =>
-      deletion_popover = $('<div/>').addClass('confirmation_box')
-      deletion_popover.append($('<p/>').html(msg))
-      deletion_popover.append($('<p/>')
-        .append($('<button/>').html('Yes').addClass('btn btn-danger ').click (event) =>
-          # set @confirmed element and emulate click on icon
-          editable = $(event.currentTarget).closest('.editable')
-          @confirmed = confirmation_elem
-          $(confirmation_elem).click()
-          $(confirmation_elem).popover('destroy')
-        )
-        .append(" ")
-        .append($('<button/>').html('No').addClass('btn btn-small').click (event) =>
-          editable = $(event.currentTarget).closest('.editable')
-          $(confirmation_elem).popover('destroy')
-        )
-      )
-
-    @container.on 'ajax:before', (e) =>
-      @fadeLoading()
-
-    @container.on 'ajax:success', (e) =>
-      if $(e.target).is('.actions a.destroy')
-        # handle HEAD OK response for deletion request
-        editable = $(e.target).closest('.editable')
-        if @container.find(".editable").length == 1
-          @reload()
-          return false
-        else
-          editable.remove()
-
-        @changeItemCount(-1)
-        @refresh()
-
-        @fadeLoaded()
-        return false
-
-    @container.on 'click', 'button.cancel', (event) =>
-      editable = $(event.currentTarget).closest('.editable')
-      if(editable.length > 0)
-        # Cancel edit
-        @cancelEdit(editable)
-      else
-        # Cancel new record
-        @container.find('.new_item_placeholder').addClass('hidden')
-        @container.find('.new_item_action').removeClass('hidden')
-      false
-
-    @container.on 'click', '.actions a[data-confirmation]', (event) =>
-      # Check if we are confirming the right element
-      if(@confirmed != event.currentTarget)
-        # We need confirmation
-        @container.find('.actions a').popover('destroy')
-        $(event.currentTarget).popover(content: createPopover(event.currentTarget, $(event.currentTarget).data('confirmation')), html: true, trigger: 'manual', title: null)
-        $(event.currentTarget).popover('show')
-        false
-      else
-        # Confirmed, reset flag and go ahead with deletion
-        @confirmed = null
-        true
-
-    @container.on 'click', 'input[type=text].autoselect', (event) ->
-      $(this).select()
-
-    @container.on 'change', '.callback', (event) =>
-      checkbox = $(event.currentTarget)
-      id = checkbox.closest("tr").data("id")
-      data = {}
-      data[checkbox.val()] = checkbox.is(":checked")
-      $.ajax({
-        beforeSend: (xhr, settings) ->
-          xhr.setRequestHeader "accept", "*/*;q=0.5, " + settings.accepts.script
-        url: @container.data("callback-href"),
-        type: "POST",
-        data: data,
-      })
-
-  fadeLoading: =>
-    @content.stop(true).fadeTo(500, 0.2)
-    @loading.show()
-    @loading.stop(true).fadeTo(500, 1)
-
-  fadeLoaded: =>
-    @content.stop(true).fadeTo(500, 1)
-    @loading.stop(true).fadeTo 500, 0, () =>
-      @loading.hide()
-
-    @content.find('.play').each () ->
-      self.loadAudio($(this).data('key'), $(this).data('target'))
-  
-  itemCount: =>
-    parseInt(@container.find('.pagination_per_page .count').html())
-
-  maxCount: =>
-    parseInt(@container.data('max-count'))
-
-  changeItemCount: (value) =>
-    @container.find('.pagination_per_page .count').html(@itemCount() + value)
-
-  cancelEdit: (editable) =>
-    if editable.data('smart_listing_edit_backup')
-      editable.html(editable.data('smart_listing_edit_backup'))
-      editable.removeClass('info')
-      editable.removeData('smart_listing_edit_backup')
-  
-  # Callback called when record is added/deleted using ajax request
-  refresh: () =>
-    header = @content.find('thead')
-    footer = @content.find('.pagination_per_page')
-    no_records = @content.find('.no_records')
-
-    if @itemCount() == 0
-      header.hide()
-      footer.hide()
-      no_records.show()
-    else
-      header.show()
-      footer.show()
-      no_records.hide()
-
-    if @maxCount()
-      if @itemCount() >= @maxCount()
-        if @itemCount()
-          @container.find('.new_item_action').addClass('hidden')
-        @container.find('.new_item_action .btn').addClass('hidden')
-      else
-        @container.find('.new_item_action').removeClass('hidden')
-        @container.find('.new_item_action .btn').removeClass('hidden')
-
-    @status.each (index, status) =>
-      $(status).find('.smart_listing_limit').html(@maxCount() - @itemCount())
-      if @maxCount() - @itemCount() == 0
-        $(status).find('.smart_listing_limit_alert').show()
-      else
-        $(status).find('.smart_listing_limit_alert').hide()
-  
-  # Trigger AJAX request to reload the list
-  reload: () =>
-    $.rails.handleRemote(@container)
-  
-  params: () =>
-    @container.data('params')
-  
-  #################################################################################################
-  # Methods executed by rails UJS:
-
-  new_item: (content) =>
-    new_item_action = @container.find('.new_item_action')
-    new_item_placeholder = @container.find('.new_item_placeholder').addClass('hidden')
-
-    @container.find('.editable').each (i, v) =>
-      @cancelEdit($(v))
-
-    new_item_action.addClass('hidden')
-    new_item_placeholder.removeClass('hidden')
-    new_item_placeholder.html(content)
-    new_item_placeholder.addClass('info')
-
-    @fadeLoaded()
-
-  create: (id, success, content) =>
-    new_item_action = @container.find('.new_item_action')
-    new_item_placeholder = @container.find('.new_item_placeholder')
-
-    if success
-      new_item_placeholder.addClass('hidden')
-      new_item_action.removeClass('hidden')
-
-      new_item = $('<tr />').addClass('editable')
-      new_item.attr('data-id', id)
-      new_item.html(content)
-      new_item_placeholder.before(new_item)
-
-      @changeItemCount(1)
-      @refresh()
-    else
-      new_item_placeholder.html(content)
-
-    @fadeLoaded()
-
-  edit: (id, content) =>
-    @container.find('.editable').each (i, v) =>
-      @cancelEdit($(v))
-    @container.find('.new_item_placeholder').addClass('hidden')
-    @container.find('.new_item_action').removeClass('hidden')
-
-    editable = @container.find(".editable[data-id=#{id}]")
-    editable.data('smart_listing_edit_backup', editable.html())
-    editable.html(content)
-    editable.addClass('info')
-
-    @fadeLoaded()
-
-  update: (id, success, content) =>
-    editable = @container.find(".editable[data-id=#{id}]")
-    if success
-      editable.removeClass('info')
-      editable.removeData('smart_listing_edit_backup')
-      editable.html(content)
-
-      @refresh()
-    else
-      editable.html(content)
-
-    @fadeLoaded()
-  
-  destroy: (id, destroyed) =>
-    # No need to do anything here, already handled by ajax:success handler
-
-  remove: (id) =>
-    editable = @container.find(".editable[data-id=#{id}]").first()
-    editable.remove()
-  
-  update_list: (content, data) =>
-    $.each data, (key, value) =>
-      @container.data(key, value)
-
-    @content.html(content)
-
-    @refresh()
-    @fadeLoaded()
-
-$.fn.smart_listing = () ->
-  map = $(this).map () ->
-    if !$(this).data('smart-listing')
-      $(this).data('smart-listing', new SmartListing($(this)))
-    $(this).data('smart-listing')
-  if map.length == 1
-    map[0]
-  else
-    map
-
-$.fn.handleSmartListingControls = () ->
-  $(this).each () ->
-    controls = $(this)
-    smart_listing = $("##{controls.data('smart-listing')}")
-    reset = controls.find(".reset")
-
-    controls.submit ->
-      # Merges smart list params with the form action url before submitting.
-      # This preserves smart list settings (page, sorting etc.).
-
-      prms = $.extend({}, smart_listing.smart_listing().params())
-      if $(this).data('reset')
-        prms[$(this).data('reset')] = null
-
-      if $.rails.href(smart_listing)
-        # If smart list has different target url than current one
-        controls.attr('action', $.rails.href(smart_listing) + "?" + jQuery.param(prms))
-      else
-        controls.attr('action', "?" + jQuery.param(prms))
-
-      smart_listing.trigger('ajax:before')
-      true
-
-    controls.find('input, select').change () ->
-      unless $(this).data('observed') # do not submit controls form when changed field is observed (observing submits form by itself)
-        controls.submit()
-
-$.fn.handleSmartListingFilter = () ->
-  filter = $(this)
-  form = filter.closest('form')
-  button = filter.find('button')
-  icon = filter.find('i')
-  field = filter.find('input')
-
-  field.observeField(
-    onFilled: ->
-      icon.removeClass('glyphicon-search')
-      icon.addClass('glyphicon-remove')
-      button.removeClass('disabled')
-    onEmpty: ->
-      icon.addClass('glyphicon-search')
-      icon.removeClass('glyphicon-remove')
-      button.addClass('disabled')
-    onChange: ->
-      form.submit()
-  )
-
-  icon.click ->
-    if field.val().length > 0
-      field.val('')
-      field.trigger('keydown')
-
-$ ->
-  $('.smart_listing').smart_listing()
-  $('.smart_listing_controls').handleSmartListingControls()
-  $('.smart_listing_controls .filter').handleSmartListingFilter()