rails-add_ons 2.1.1 → 2.2.0

data/app/concerns/resources_controller/rest_actions.rb

@@ -1,91 +1,95 @@
-module ResourcesController::RestActions
-  extend ActiveSupport::Concern
-
-  included do
-    include ActionController::MimeResponds
-
-    respond_to :html
-    responders :flash
-
-    if respond_to?(:before_action)
-      before_action :load_collection, only: [:index]
-      before_action :load_resource, only: [:show, :edit, :destroy, :update]
-      before_action :initialize_resource, only: [:new]
-      before_action :initialize_resource_for_create, only: [:create]
-    else
-      before_filter :load_collection, only: [:index]
-      before_filter :load_resource, only: [:show, :edit, :destroy, :update]
-      before_filter :initialize_resource, only: [:new]
-      before_filter :initialize_resource_for_create, only: [:create]
-    end
-  end
+module ResourcesController
+  module RestActions
+    extend ActiveSupport::Concern
 
-  def index; end
-  def new; end
-  def show; end
-  def edit; end
+    included do
+      include ActionController::MimeResponds
 
-  def update
-    if Rails::VERSION::MAJOR < 4
-      @resource.update_attributes(permitted_params)
-    else
-      @resource.update(permitted_params)
+      respond_to :html
+      responders :flash
+
+      if respond_to?(:before_action)
+        before_action :load_collection, only: [:index]
+        before_action :load_resource, only: [:show, :edit, :destroy, :update]
+        before_action :initialize_resource, only: [:new]
+        before_action :initialize_resource_for_create, only: [:create]
+      else
+        before_filter :load_collection, only: [:index]
+        before_filter :load_resource, only: [:show, :edit, :destroy, :update]
+        before_filter :initialize_resource, only: [:new]
+        before_filter :initialize_resource_for_create, only: [:create]
+      end
     end
-    if respond_to?(:after_update_location, true)
-      respond_with(respond_with_namespace, @resource, location: after_update_location)
-    else
-      respond_with(respond_with_namespace, @resource)
+
+    def index; end
+    def new; end
+    def show; end
+    def edit; end
+
+    def update
+      if Rails::VERSION::MAJOR < 4
+        @resource.update_attributes(permitted_params)
+      else
+        @resource.update(permitted_params)
+      end
+
+      if respond_to?(:after_update_location, true)
+        respond_with(respond_with_namespace, @resource, location: after_update_location)
+      else
+        respond_with(respond_with_namespace, @resource)
+      end
     end
-  end
 
-  def destroy
-    @resource.destroy
-    if respond_to?(:after_destroy_location, true)
-      respond_with(respond_with_namespace, @resource, location: after_destroy_location)
-    else
-      respond_with(respond_with_namespace, @resource)
+    def destroy
+      @resource.destroy
+      if respond_to?(:after_destroy_location, true)
+        respond_with(respond_with_namespace, @resource, location: after_destroy_location)
+      else
+        respond_with(respond_with_namespace, @resource)
+      end
     end
-  end
 
-  def create
-    @resource.save
-    if respond_to?(:after_create_location, true)
-      respond_with(respond_with_namespace, @resource, location: after_create_location)
-    else
-      respond_with(respond_with_namespace, @resource)
+    def create
+      @resource.save
+      if respond_to?(:after_create_location, true)
+        respond_with(respond_with_namespace, @resource, location: after_create_location)
+      else
+        respond_with(respond_with_namespace, @resource)
+      end
     end
-  end
 
-  private
+    private
 
-  def respond_with_namespace
-    nil
-  end
+    def respond_with_namespace
+      nil
+    end
 
-  def load_collection_scope
-    resource_class
-  end
+    def load_collection_scope
+      resource_class
+    end
 
-  def load_collection
-    @collection = load_collection_scope.all
-  end
+    def load_collection
+      @collection = load_collection_scope.all
+    end
 
-  def load_resource_scope
-    resource_class
-  end
-  def load_resource
-    @resource = load_resource_scope.find(params[:id])
-  end
+    def load_resource_scope
+      resource_class
+    end
 
-  def initialize_resource
-    @resource = resource_class.new
-  end
+    def load_resource
+      @resource = load_resource_scope.find(params[:id])
+    end
 
-  def initialize_resource_for_create
-    @resource = resource_class.new(permitted_params)
-  end
+    def initialize_resource
+      @resource = resource_class.new
+    end
 
-  def permitted_params
-    raise "not implemented"
+    def initialize_resource_for_create
+      @resource = resource_class.new(permitted_params)
+    end
+
+    def permitted_params
+      raise "not implemented"
+    end
   end
 end

data/app/concerns/resources_controller/rest_resource_urls.rb

@@ -1,32 +1,34 @@
-module ResourcesController::RestResourceUrls
-  extend ActiveSupport::Concern
+module ResourcesController
+  module RestResourceUrls
+    extend ActiveSupport::Concern
 
-  included do
-    helper_method :new_resource_path
-    helper_method :collection_path
-    helper_method :resource_path
-    helper_method :edit_resource_path
-  end
+    included do
+      helper_method :new_resource_path
+      helper_method :collection_path
+      helper_method :resource_path
+      helper_method :edit_resource_path
+    end
 
-  private
+    private
 
-  def new_resource_path
-    resource_router.send(:url_for, { action: :new, only_path: true })
-  end
+    def new_resource_path
+      resource_router.send(:url_for, { action: :new, only_path: true })
+    end
 
-  def collection_path
-    resource_router.send(:url_for, { action: :index, only_path: true })
-  end
+    def collection_path
+      resource_router.send(:url_for, { action: :index, only_path: true })
+    end
 
-  def resource_path(resource)
-    resource_router.send(:url_for, { action: :show, id: resource, only_path: true })
-  end
+    def resource_path(resource)
+      resource_router.send(:url_for, { action: :show, id: resource, only_path: true })
+    end
 
-  def edit_resource_path(resource)
-    resource_router.send(:url_for, { action: :edit, id: resource, only_path: true })
-  end
+    def edit_resource_path(resource)
+      resource_router.send(:url_for, { action: :edit, id: resource, only_path: true })
+    end
 
-  def resource_router
-    self
+    def resource_router
+      self
+    end
   end
 end

data/app/concerns/resources_controller/sorting.rb

@@ -1,20 +1,28 @@
-module ResourcesController::Sorting
-  private
+module ResourcesController
+  module Sorting
+    private
 
-  def load_collection_scope
-    add_order_scope(super)
-  end
+    def load_collection_scope
+      add_order_scope(super)
+    end
 
-  def add_order_scope(base_scope)
-    if params[:sort_by].present?
-      if params[:sort_by].include?(' ') || params[:sort_direction].include?(' ')
-        raise "Possible SQL Injection attempt while trying to sort by #{params[:sort_by]} #{params[:sort_direction]}"
-      end
+    def add_order_scope(base_scope)
+      if params[:sort_by].present?
+        if params[:sort_by].include?(' ') || params[:sort_direction].include?(' ')
+          raise "Possible SQL Injection attempt while trying to sort by #{params[:sort_by]} #{params[:sort_direction]}"
+        end
 
-      sort_direction = (params[:sort_direction] || :asc)
-      base_scope.reorder("#{params[:sort_by]} #{sort_direction}")
-    else
-      base_scope
+        sort_by        = params[:sort_by]
+        sort_direction = (params[:sort_direction] || :asc)
+
+        if sort_by.include?('.')
+          base_scope.reorder("#{sort_by} #{sort_direction}")
+        else
+          base_scope.reorder(sort_by => sort_direction)
+        end
+      else
+        base_scope
+      end
     end
   end
 end

data/app/concerns/resources_controller/will_paginate.rb

@@ -1,17 +1,19 @@
-module ResourcesController::WillPaginate
-  extend ActiveSupport::Concern
+module ResourcesController
+  module WillPaginate
+    extend ActiveSupport::Concern
 
-  included do
-    helper_method :paginate?
-  end
+    included do
+      helper_method :paginate?
+    end
 
-  def paginate?
-    true
-  end
+    def paginate?
+      true
+    end
 
-  private
+    private
 
-  def load_collection
-    @collection = load_collection_scope.paginate(page: params[:page])
+    def load_collection
+      @collection = load_collection_scope.paginate(page: params[:page])
+    end
   end
-end
+end

data/app/concerns/service_controller/rest_actions.rb

@@ -62,6 +62,21 @@ module ServiceController::RestActions
     @service = service_class.new({}, service_options)
   end
 
+  # Override this method in your child class to manipulate your service before
+  # it performs.
+  #
+  # Example:
+  #     # app/controller/import_services_controller.rb
+  #     class ImportServices < ApplicationServicesController
+  #       #...
+  #       private
+  #
+  #       def initialize_service_for_create
+  #         super
+  #         @service.current_user_id = session['current_user_id']
+  #       end
+  #     end
+  #
   def initialize_service_for_create
     @service = service_class.new(hashified_params, service_options)
   end

data/app/helpers/rails/add_ons/table_helper.rb

@@ -1,5 +1,15 @@
 module Rails
   module AddOns
+    # Provides helpers to render tables for collections and single resources.
+    # To use it you have to add it to your controller:
+    #
+    # Example:
+    #
+    #     class PostsController < ApplicationController
+    #       #...
+    #       helper Rails::AddOns::TableHelper
+    #     end
+    #
     module TableHelper
       def collection_table(options = {}, &block)
         Component::CollectionTable.new(self, options, &block).perform

data/app/views/component/_collection_table.haml

@@ -1,17 +1,18 @@
 %table{ class: table_css_classes }
-  %thead
-    %tr
-      - columns.each do |name, options|
-        - title = options.delete(:title)
-        - if title.nil?
-          - if resource_class.respond_to?(:human_attribute_name)
-            - title = resource_class.human_attribute_name(name)
+  - if show_header
+    %thead
+      %tr
+        - columns.each do |name, options|
+          - title = options.delete(:title)
+          - if title.nil?
+            - if resource_class.respond_to?(:human_attribute_name)
+              - title = resource_class.human_attribute_name(name)
+            - else
+              - title = name
+          - if options.has_key?(:sort)
+            %td= sort_link(name, title, options[:sort])
           - else
-            - title = name
-        - if options.has_key?(:sort)
-          %td= sort_link(name, title, options[:sort])
-        - else
-          %td= title
+            %td= title
   %tbody
     - collection.each do |resource|
       - tr_options = { class: resource_class.name.underscore.gsub('/', '-') }

data/app/views/component/table/body_cells/_acts_as_list.haml

@@ -0,0 +1,11 @@
+:ruby
+  scope = options.delete(:scope)
+  data_attributes = {
+    'acts-as-list-item':                true,
+    'acts-as-list-item-uid':            resource.to_param,
+    'acts-as-list-item-on-drop-target': url_for([:reposition, resource])
+  }
+  data_attributes['acts-as-list-item-scope'] = "#{scope}-#{resource.send(scope)}" if scope.present?
+
+%span.btn.btn-xs.btn-default.acts-as-list-item{ data: data_attributes }
+  %span.glyphicon.glyphicon-sort.fas.fa-sort

data/app/views/component/table/body_cells/_acts_as_published.haml

@@ -0,0 +1,9 @@
+- link_path = controller.url_for(action: :toggle_published, id: resource.to_param)
+- if resource.published?
+  = button_to(link_path, class: 'btn btn-xs btn-danger btn-responsive', method: :post) do
+    %span.glyphicon.glyphicon-eye-close
+    %span.btn-text= t('.unpublish', default: t('acts_as_published.actions.unpublish'))
+- else
+  = button_to(link_path, class: 'btn btn-xs btn-success btn-responsive', method: :post) do
+    %span.glyphicon.glyphicon-eye-open
+    %span.btn-text= t('.publish', default: t('acts_as_published.actions.publish'))

data/app/views/component/table/body_cells/_association.haml

@@ -1,5 +1,9 @@
 - label = if options[:label_method].present?
-  - resource.send(name).try(options[:label_method])
+  - case options[:label_method]
+    - when Proc
+      - options[:label_method].call(resource.send(name))
+    - else
+      - resource.send(name).try(options[:label_method])
 - else
   - resource.send(name)
 - link_to = options[:link_to]

data/app/views/component/table/body_cells/_batch_actions.haml

@@ -0,0 +1 @@
+= check_box_tag "ids[]", resource.id, false, class: 'batch-action-checkbox'

data/app/views/component/table/body_cells/_boolean.haml

@@ -0,0 +1,4 @@
+- if resource.send(name)
+  = t('.true')
+- else
+  = t('.false')

data/app/views/component/table/header_cells/_batch_actions.haml

@@ -0,0 +1,42 @@
+:css
+  #batch-action-dropdown {
+    display: none;
+  }
+
+%form{ method: 'post', id: 'batch-action-form' }
+  = hidden_field_tag :authenticity_token, form_authenticity_token
+.dropdown.batch-action-dropdown
+  %button.btn.btn-default.dropdown-toggle{"aria-expanded" => "true", "aria-haspopup" => "true", "data-toggle" => "dropdown", :type => "button", id: 'batch-action-dropdown' }
+    = t('.batch_actions')
+    %span.caret
+  %ul.dropdown-menu{"aria-labelledby" => 'batch-action-dropdown' }
+    - options[:actions].each do |action, target|
+      %li
+        %a{ href: target, class: 'batch-action-form-submit-link' }= t(".#{action}")
+
+:javascript
+  $(document).ready(function() {
+    $('.batch-action-checkbox').click(function() {
+      var check_count = $('.batch-action-checkbox:checked').size();
+      if( check_count > 0 ) {
+        $("#batch-action-dropdown").show();
+      } else {
+        $("#batch-action-dropdown").hide();
+      }
+    });
+
+    $('#batch-action-form').submit(function() {
+      $('#batch-action-form input:checked').remove();
+      var selected_items = $('.batch-action-checkbox:checked').clone();
+      selected_items.css('display', 'none');
+      $('#batch-action-form').append(selected_items);
+      return true;
+    });
+
+    $('.batch-action-form-submit-link').click(function(e) {
+        e.preventDefault();
+        var target = $(this).attr('href');
+        $("#batch-action-form").attr("action", target);
+        $('#batch-action-form').submit();
+    });
+  });

data/config/locales/de.yml

@@ -4,10 +4,20 @@ de:
   component:
     collection_table:
       column_titles:
-        awesome_nested_set: Sortieren
+        acts_as_list: Sortierung
+        acts_as_published: Veröffentlichung
+        awesome_nested_set: Sortierung
       delete: Löschen
       edit: Bearbeiten
       show: Anzeigen
+    table:
+      body_cells:
+        boolean:
+          'true': Ja
+          'false': Nein
+      header_cells:
+        batch_actions:
+          destroy: Löschen
   flash:
     actions:
       create:
@@ -20,6 +30,25 @@ de:
       perform:
         notice: "%{resource_name} wurde ausgeführt."
         alert: "%{resource_name} konnte nicht ausgeführt werden. Es traten folgende Fehler auf: %{errors}"
+  acts_as_list:
+    flash:
+      actions:
+        reposition:
+          inserted_after: "%{inserted_resource} nach %{target_resource} eingefügt"
+          inserted_before: "%{inserted_resource} vor %{target_resource} eingefügt"
+  acts_as_published:
+    flash:
+      actions:
+        toggle_published:
+          published:
+            notice: "%{resource_name} veröffentlicht."
+          unpublished:
+            notice: "%{resource_name} zurückgezogen."
+  awesome_nested_set:
+    flash:
+      actions:
+        reposition:
+          notice: "%{inserted_resource} nach %{target_resource} eingefügt"
   i18n:
     locales:
       en: English

data/config/locales/en.yml

@@ -3,7 +3,10 @@ en:
     i18n: Language
   component:
     collection_table:
-      delete: Delete
+      column_titles:
+        acts_as_published: Publishing
+        awesome_nested_set: Sorting
+      destroy: Delete
       edit: Edit
       show: Show
   flash:

data/lib/generators/rails/add_ons/install_generator.rb

@@ -0,0 +1,15 @@
+module Rails
+  module AddOns
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        desc 'Generates the initializer'
+
+        source_root File.expand_path('../templates', __FILE__)
+
+        def generate_initializer
+          template 'initializer.rb', 'config/initializers/rails-add_ons.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/rails/add_ons/resources_controller_spec_generator.rb

@@ -0,0 +1,53 @@
+module Rails
+  module AddOns
+    # This will generate specs for create, read, update, delete and list.
+    # 
+    # Example:
+    # 
+    #     rails g rails:add_ons:resources_controller_spec --uri /de/backend/uploads
+    #       create  spec/features/de/backend/uploads_feature_spec.rb
+    #
+    # If your resource class does not match the last part of your url (i.e.
+    # /de/posts would guess the resource class to Post) you can specify the resource
+    # name like this:
+    #
+    #     RESOURCE_CLASS=Blog::Post rails g rails:add_ons:resources_controller_spec --uri /de/posts
+    #       create  spec/features/de/posts_feature_spec.rb
+    #
+    class ResourcesControllerSpecGenerator < Rails::Generators::Base
+      desc 'Generates CRUDL specs for REST resources'
+
+      source_root File.expand_path('../templates', __FILE__)
+ 
+      class_option :uri, type: :string, required: true
+
+      def uri
+        @uri ||= options['uri']
+      end
+
+      def edit_form_dom_selector
+        ".edit_#{resource_class.demodulize.underscore}"
+      end
+
+      def new_form_dom_selector
+        "#new_#{resource_class.demodulize.underscore}"
+      end
+
+      def resource_class
+        @resource_class ||= ENV.fetch('RESOURCE_CLASS') { @uri.split('/').last.camelize.singularize }
+      end
+
+      def factory_name
+        underscored_resource_class
+      end
+
+      def underscored_resource_class
+        @undescored_resource_class ||= resource_class.underscore.gsub('/', '_')
+      end
+
+      def generate_spec
+        template 'spec.rb', "spec/features#{uri}_feature_spec.rb"
+      end
+    end
+  end
+end

data/lib/generators/rails/add_ons/templates/initializer.rb

@@ -0,0 +1,7 @@
+Rails::AddOns.configure do |config|
+  # Set the default format for timestamps in tables.
+  #
+  # Default: config.table_default_timestamp_format = nil
+  #
+  config.table_default_timestamp_format = nil
+end

data/lib/generators/rails/add_ons/templates/spec.rb

@@ -0,0 +1,53 @@
+require 'rails_helper'
+
+RSpec.describe '<%= uri %>', type: :feature do
+  let(:resource_class) { <%= resource_class %> }
+  let(:resource) { create(:<%= factory_name %>) }
+  let(:resources) { create_list(:<%= factory_name %>, 3) }
+
+  # List
+  it { resources; expect(subject).to implement_index_action(self) }
+
+  # Create
+  it { 
+    expect(subject).to implement_create_action(self)
+      .for(resource_class)
+      .within_form('<%= new_form_dom_selector %>') {
+        # fill the needed form inputs via capybara here
+        #
+        # Example:
+        #
+        #     select 'de', from: 'slider[locale]'
+        #     fill_in 'slider[name]', with: 'My first slider'
+        #     check 'slider[auto_start]'
+        #     fill_in 'slider[interval]', with: '3'
+      }
+      .increasing{ <%= resource_class %>.count }.by(1)
+  }
+  
+  # Read
+  it { expect(subject).to implement_show_action(self).for(resource) }
+
+  # Update
+  it {
+    expect(subject).to implement_update_action(self)
+      .for(resource)
+      .within_form('<%= edit_form_dom_selector %>') {
+        # fill the needed form inputs via capybara here
+        # 
+        # Example:
+        # 
+        #     fill_in 'slider[name]', with: 'New name'
+      }
+      .updating
+      .from(resource.attributes)
+      .to({ }) # Example: .to({ 'name' => 'New name' })
+  }
+
+  # Delete
+  it {
+    expect(subject).to implement_delete_action(self)
+      .for(resource)
+      .reducing{ resource_class.count }.by(1)
+  }
+end

data/lib/rails/add_ons/configuration.rb

@@ -0,0 +1,11 @@
+module Rails
+  module AddOns
+    module Configuration
+      def configure
+        yield self
+      end
+
+      mattr_accessor(:table_default_timestamp_format) { :short }
+    end
+  end
+end