smarter_listing 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db91ff26a056d22121a2ef300d8c9d2efbd3fc2c
+  data.tar.gz: 0a28a1db18c045428979eec8c134ace962a99893
+SHA512:
+  metadata.gz: bfee046a907d192110fa45c9f9f6538b5394ba09119c287594f2a271b463fe80acf7d9dfd340bac8b432ea768d70cffffcd79e6d1ada354bd4606b01ee205908
+  data.tar.gz: 03fca7d00ecf4a9fd57b5046fe737aee26e22a9be37a0ebe5f31d78acff9c26f8ffd208d831e9c03bffe46a1218a92661af5d3e5fbde0f4a271ad26855ae7c60

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+[![Build Status](https://travis-ci.org/MichaelSp/smarter_listing.svg?branch=master)](https://travis-ci.org/MichaelSp/smarter_listing)
+
+SmarterListing
+================
+
+The [smart listing](http://showcase.sology.eu/smart_listing) from the guys at Sology is a real productivity boost.
+But it's too verbose to include it into your rails app. This gem makes smart listing even smarter. It drys your controller out.
+
+Usage
+-----
+
+* Gemfile
+  ```ruby
+  gem 'smarter_listing'
+  ```
+then `bundle install`
+
+* app/controllers/posts_controller.rb
+  ```ruby
+  class PostController < ApplicationController
+    smarter_listing
+    
+    # Look ma, no controller actions needs to be defined
+    
+    private
+      def resource_params
+          params.require(:post).permit(:title, :body) if params[:post]
+      end
+  end
+  ```
+
+* app/views/posts/_form.html.haml
+  ```ruby
+  = bootstrap_form_for @post # this requires the fine gem 'bootstrap_form'. Check it out! 
+    = f.text_field :title
+    = f.text_area :body
+    .pull-right
+      = f.primary
+      = link_to 'Cancel'. posts_path, class: 'btn btn-default'
+  ```
+
+* app/views/posts/_post.html.haml
+  ```ruby
+  %td= object.title.truncate(30)
+  %td= object.body.truncate(80)
+  %td.actions= smart_listing_item_actions [action_copy(object,copy_post_path(object)),action_edit(object,edit_post_path(object)),action_destroy(object,post_path(object))]
+  ```
+
+* app/views/posts/_table_header.html.haml
+  ```ruby
+  %table.table.table-striped
+    %tr
+      %th= smart_listing.sortable t("Created"), :created_at
+      %th= smart_listing.sortable t("Title"), :title
+      %th= smart_listing.sortable t("Body"), :body
+      %th
+    - smart_listing.collection.each do |post|
+      %tr.editable{data: {id: post.id}}
+        = smart_listing.render partial: 'posts/post', locals: {object: post}
+  
+    = smart_listing.item_new colspan: 11, link: new_post_path
+  
+  = smart_listing.paginate
+  = smart_listing.pagination_per_page_links
+  ```
+
+* app/views/posts/index.html.haml
+  ```ruby
+  = smart_listing_controls_for(:posts, {class: "form-inline text-right"}) do
+    .form-group.filter.input-append
+      = text_field_tag :filter, '', class: "search form-control", placeholder: t("Search..."), autocomplete: :off
+  
+    %button.btn.btn-primary.disabled{type: :submit}
+      =fa_icon 'search' # this requires gem 'font-awesome-rails'
+  =smart_listing_render(:posts)
+  
+  ```

data/Rakefile

@@ -0,0 +1,32 @@
+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    = 'SmarterListing'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  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/app/views/smart_listing/_action_copy.html.erb

@@ -0,0 +1,3 @@
+<%=link_to action[:custom_url], {class: action[:name], title: action[:custom_title], remote: true, method: :put}, action[:html_options] do %>
+  <i class="<%= action[:custom_icon] %>"></i>
+<% end %>

data/app/views/smarter_listing/_form_logic.js

@@ -0,0 +1 @@
+$('.select2').select2().removeClass('form-control');

data/app/views/smarter_listing/copy.js.erb

@@ -0,0 +1,2 @@
+<%= smart_listing_item collection_sym, :copy, resource, "#{current_engine}/#{collection_sym}/form" %>
+<%== render 'application/form_logic' %>

data/app/views/smarter_listing/create.js.erb

@@ -0,0 +1 @@
+<%= smart_listing_item collection_sym, :create, resource, resource.valid? ? "#{current_engine}/#{collection_sym}/#{collection_action}" : "#{current_engine}/#{collection_sym}/form" %>

data/app/views/smarter_listing/destroy.js.erb

@@ -0,0 +1,2 @@
+<%= smart_listing_item collection_sym, :destroy, resource %>
+

data/app/views/smarter_listing/edit.js.erb

@@ -0,0 +1,2 @@
+<%= smart_listing_item collection_sym, :edit, resource, "#{current_engine}/#{collection_sym}/form" %>
+<%== render 'smarter_listing/form_logic' %>

data/app/views/smarter_listing/index.js.erb

@@ -0,0 +1 @@
+<%= smart_listing_update(collection_sym) %>

data/app/views/smarter_listing/new.js.erb

@@ -0,0 +1,2 @@
+<%= smart_listing_item collection_sym, :new, resource, "#{current_engine}/#{collection_sym}/form" %>
+<%== render 'smarter_listing/form_logic' %>

data/app/views/smarter_listing/update.js.erb

@@ -0,0 +1 @@
+<%= smart_listing_item collection_sym, :update, resource, resource.valid? ? "#{current_engine}/#{collection_sym}/#{collection_action}" : "#{current_engine}/#{collection_sym}/form" %>

data/lib/smarter_listing.rb

@@ -0,0 +1,7 @@
+require 'smarter_listing/engine'
+require 'smarter_listing/loader'
+
+module SmarterListing
+  autoload :Helper, 'smarter_listing/helper'
+  autoload :ControllerExtension, 'smarter_listing/controller_extension'
+end

data/lib/smarter_listing/controller_extension.rb

@@ -0,0 +1,77 @@
+module SmarterListing::ControllerExtension
+
+  def self.included base
+    base.helper_method :collection, :resource
+    base.include SmarterListing::Helper
+    base.class_eval do
+      # Actions
+      define_method :index do
+        collection
+        respond_to do |format|
+          format.html
+          format.js { render action: 'index.js.erb' }
+        end
+      end
+
+      define_method :new do
+        instance_variable_get(resource_ivar) || instance_variable_set(resource_ivar, model.new(resource_params))
+        render 'smarter_listing/new'
+      end
+
+      define_method :create do
+        instance_variable_get(resource_ivar) || instance_variable_set(resource_ivar, model.create(resource_params))
+        render 'smarter_listing/create'
+      end
+
+      define_method :copy do
+        instance_variable_set resource_ivar, resource.dup
+        render 'smarter_listing/copy'
+      end
+
+      define_method :show do
+        resource
+        render resource, object: resource
+      end
+
+      define_method :edit do
+        resource
+        render 'smarter_listing/edit'
+      end
+
+      define_method :update do
+        resource.update resource_params
+        render 'smarter_listing/update'
+      end
+
+      define_method :destroy do
+        resource.destroy
+        render 'smarter_listing/destroy'
+      end
+    end
+  end
+
+  def filter_parameter
+    self.class.instance_variable_get :@filter_parameter
+  end
+
+  def filtered(model)
+    (!params[filter_parameter].blank?) ? model.search { fulltext "#{params[filter_parameter]}" }.results : model.all
+  end
+
+  def load_collection
+    instance_variable_set collection_ivar, smart_listing_create(collection_sym, filtered(model), partial: "#{current_engine}/#{collection_sym}/table_header")
+  end
+
+  def load_resource
+    instance_variable_set resource_ivar, (model.find(params[:id]) rescue (action_name == 'new' ? model.new(resource_params) : nil))
+  end
+
+  def resource
+    instance_variable_get(resource_ivar) || load_resource
+  end
+
+  def collection
+    instance_variable_get(collection_ivar) || load_collection
+  end
+
+end

data/lib/smarter_listing/engine.rb

@@ -0,0 +1,4 @@
+module SmarterListing
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/smarter_listing/helper.rb

@@ -0,0 +1,92 @@
+module SmarterListing
+  module Helper
+
+    # def self.included base
+    #   base.helper_method :collection_sym, :collection_action, :collection_ivar, :resource_sym, :resource_ivar, :model
+    #   base.helper_method :action_copy, :action_edit, :action_destroy, :current_engine
+    # end
+
+    def collection_sym
+      @collection_sym = nil
+      @collection_sym ||= model.to_s.underscore.downcase.pluralize.to_sym
+    end
+
+    def collection_action
+      @collection_action = nil
+      @collection_action ||= model.to_s.underscore.downcase.singularize.to_sym
+    end
+
+    def collection_ivar
+      "@#{collection_sym}"
+    end
+
+    def resource_sym
+      @resource_sym ||= model.to_s.underscore.downcase.to_sym
+    end
+
+    def resource_ivar
+      "@#{resource_sym}"
+    end
+
+    def current_engine
+      self.class.parent == Object ? '' : self.class.parent.to_s.downcase
+    end
+
+    def model
+      @model = nil
+      @model ||= begin
+                   # First priority is the namespaced model, e.g. User::Group
+        resource_class ||= begin
+          namespaced_class = self.name.sub(/Controller/, '').singularize
+          namespaced_class.constantize
+        rescue NameError
+          nil
+        end
+
+        # Second priority is the top namespace model, e.g. EngineName::Article for EngineName::Admin::ArticlesController
+        resource_class ||= begin
+          namespaced_classes = self.name.sub(/Controller/, '').split('::')
+          namespaced_class = [namespaced_classes.first, namespaced_classes.last].join('::').singularize
+          namespaced_class.constantize
+        rescue NameError
+          nil
+        end
+
+        # Third priority the camelcased c, i.e. UserGroup
+        resource_class ||= begin
+          camelcased_class = self.name.sub(/Controller/, '').gsub('::', '').singularize
+          camelcased_class.constantize
+        rescue NameError
+          nil
+        end
+
+        # Otherwise use the Group class, or fail
+        resource_class ||= begin
+          class_name = self.controller_name.classify
+          class_name.constantize
+        rescue NameError => e
+          raise unless e.message.include?(class_name)
+          nil
+        end
+        resource_class
+      end
+    end
+
+    def action_copy(object, path)
+      {
+          name: :copy,
+          custom_url: path,
+          custom_icon: SmartListing.config.classes(:icon_copy),
+          custom_title: 'Copy'
+      }
+    end
+
+    def action_edit(object, path)
+      {name: :edit, url: path}
+    end
+
+    def action_destroy(object, path)
+      {name: :destroy, url: path}
+    end
+  end
+end

data/lib/smarter_listing/loader.rb

@@ -0,0 +1,25 @@
+require 'smart_listing'
+require 'kaminari'
+
+module SmarterListing
+  module Loader
+    def initialize
+
+    end
+
+    def self.extended base
+      def smarter_listing(filter_parameter = :filter)
+        helper SmartListing::Helper
+        include SmartListing::Helper::ControllerExtensions
+
+        helper SmarterListing::Helper
+        include SmarterListing::ControllerExtension
+
+        instance_variable_set :@filter_parameter, filter_parameter
+        prepend Loader
+      end
+    end
+  end
+end
+
+ActionController::Base.extend SmarterListing::Loader

data/lib/smarter_listing/version.rb

@@ -0,0 +1,3 @@
+module SmarterListing
+  VERSION = '0.1.0'
+end

data/lib/tasks/smarter_listing_tasks.rake

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

data/test/controllers/listings_controller_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+require 'smarter_listing'
+
+class ListingsControllerTest < ActionController::TestCase
+  setup do
+    @listing = listings(:one)
+    ListingsController.smarter_listing
+  end
+
+  test 'should have the methods from all helpers' do
+    assert_includes @controller.methods, :create
+    assert_includes @controller.methods, :show
+    assert_includes @controller.methods, :update
+    assert_includes @controller.methods, :destroy
+    assert_includes @controller.methods, :new
+  end
+
+  test "should get index" do
+    get :index
+    assert_response :success
+    assert_not_nil assigns(:listings)
+  end
+
+  test "should get new" do
+    xhr :get, :new, format: :js
+    assert_response :success
+  end
+
+  test "should create listing" do
+    assert_difference('Listing.count') do
+      resource_params = {content: @listing.content, deleted_at: @listing.deleted_at, name: 'newName'}
+      xhr :post, :create, listing: resource_params, format: :js
+      assert_empty @listing.errors
+    end
+    assert_response :success
+  end
+
+  test "should get edit" do
+    xhr :get, :edit, id: @listing, format: :js
+    assert_response :success
+  end
+
+  test "should update listing" do
+    resource_params = {content: @listing.content, deleted_at: @listing.deleted_at, name: 'newName'}
+    xhr :patch, :update, id: @listing, listing: resource_params, format: :js
+    assert_empty @listing.errors
+    assert_response :success
+  end
+
+  test "should destroy listing" do
+    assert_difference('Listing.count', -1) do
+      xhr :delete, :destroy, id: @listing, format: :js
+    end
+    assert_response :success
+  end
+end