wobapphelpers 3.1.0

data/lib/generators/wobapphelpers/install_generator.rb

@@ -0,0 +1,24 @@
+module Wobapphelpers
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      
+      desc "Copy locale files to your application"
+
+      def copy_locale
+        ['en', 'de'].each do |lang|
+          copy_file "../../../config/locales/#{lang}.yml", 
+                    "config/locales/wobapphelpers.#{lang}.yml"
+        end
+      end
+
+      def copy_layout
+        copy_file "layouts/application.html.erb", "app/views/layouts/application.html.erb"
+      end
+
+      def copy_initializer
+        copy_file "initializers/wobapphelpers.rb", "config/initializers/wobapphelpers.rb"
+      end
+    end
+  end
+end

data/lib/generators/wobapphelpers/scaffold_templates_generator.rb

@@ -0,0 +1,20 @@
+module Wobapphelpers
+  module Generators
+    class ScaffoldTemplatesGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      
+      desc "Copy simple_form templates to your application"
+
+      def copy_view_templates
+        ["show.html.erb", "edit.html.erb", "new.html.erb", "index.html.erb", "_form.html.erb"].each do |file|
+          copy_file "erb/scaffold/#{file}", "lib/templates/erb/scaffold/#{file}"
+        end
+      end
+
+      def copy_controlle_template
+          copy_file "rails/scaffold_controller/controller.rb", 
+                    "lib/templates/rails/scaffold_controller/controller.rb"
+      end
+    end
+  end
+end

data/lib/tasks/wobapphelpers_tasks.rake

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

data/lib/wobapphelpers.rb

@@ -0,0 +1,37 @@
+module Wobapphelpers
+  autoload :Helpers, 'wobapphelpers/helpers'
+  autoload :Responders, 'wobapphelpers/responders'
+  autoload :Breadcrumbs, 'wobapphelpers/breadcrumbs'
+
+  def self.setup
+    yield self
+  end
+
+  # exclude controllers from breadcrumbs
+  #
+  mattr_accessor :breadcrumb_controller_blacklist
+  @@breadcrumb_controller_blacklist = []
+
+  # Use cancan abilities to decide if action links should be presented. 
+  # Defaults to :none
+  #
+  mattr_reader :cancan 
+  @@cancan = :none
+
+  # Which variant of cancan should be used? possible values are:
+  #   * +:none+: no usage of Cancan or Cancancan
+  #   * +:cancan1+: cancan '~> 1.6.0' or cancancan '~> 1.7.0'
+  #   * +:cancan2+: cancan '~> 2.0.0'
+  #
+  def self.cancan=(variant)
+    if [:none, :cancan1, :cancan2].include?(variant)
+      @@cancan = variant
+    else
+      raise "Cancan variant #{variant} not implemented!"
+    end
+  end
+end
+
+if defined?(::Rails)
+  require 'wobapphelpers/rails'
+end

data/lib/wobapphelpers/breadcrumbs.rb

@@ -0,0 +1,16 @@
+require 'active_support/concern'
+
+module Wobapphelpers
+  module Breadcrumbs
+    extend ActiveSupport::Concern
+
+    autoload :ActionController, 'wobapphelpers/breadcrumbs/action_controller.rb'
+    autoload :BreadcrumbsHelper, 'wobapphelpers/breadcrumbs/breadcrumbs_helper.rb'
+    
+    included do
+      include Wobapphelpers::Breadcrumbs::ActionController
+    end
+  end
+end
+
+ActionView::Base.send :include, Wobapphelpers::Breadcrumbs::BreadcrumbsHelper

data/lib/wobapphelpers/breadcrumbs/action_controller.rb

@@ -0,0 +1,57 @@
+module Wobapphelpers
+  module Breadcrumbs
+    module ActionController
+      def add_breadcrumb(name, url)
+        breadcrumbs ||= (session[:breadcrumbs] || [] )
+        if params[:bci]
+          # this a back link of an existing breadcrumb entry,
+          # shorten the list
+          breadcrumbs = breadcrumbs.first(params[:bci].to_i)
+        end
+        if breadcrumbs.size == 0 || url != breadcrumbs.last[1]
+          breadcrumbs << [name, url]
+        end
+        session[:breadcrumbs] = breadcrumbs.last(6)
+      end
+
+      def last_breadcrumb
+	session[:breadcrumbs].last || [nil, :back]
+      end
+
+      def last_breadcrumb_url
+	last_breadcrumb[1]
+      end
+
+      def add_breadcrumb_index
+	return if request.format == :json
+	text = t("controller.#{controller_path}")
+	url  = request.fullpath
+	add_breadcrumb(text, url)
+      end
+
+      def add_breadcrumb_show
+        resource = controller_name.singularize
+        if instance_variable_defined?("@#{resource}")
+          add_breadcrumb_for instance_variable_get("@#{resource}")
+        else
+          flash[:alert] = "add_breadcrumb_show: instance variable @#{resource} not set; see documentation for Wobapphelpers::Breadcrumbs"
+        end
+      end
+
+      def add_breadcrumb_for(poly)
+	if poly.is_a? Array
+	  (parent, child) = poly
+	  name  = "#{t('activerecord.models.'+parent.class.name.underscore)}(#{parent.id})/"
+	  if child.is_a? Symbol
+	    name += "#{t('attributes.'+child.to_s)}"
+	  else
+	    name += "#{t('activerecord.models.'+child.class.name.underscore)}(#{child.id})"
+	  end
+	else
+	  name = "#{t('activerecord.models.' + poly.class.name.underscore)}(#{poly.id})"
+	end
+	add_breadcrumb name, polymorphic_path(poly)
+      end
+    end
+  end
+end

data/lib/wobapphelpers/breadcrumbs/breadcrumbs_helper.rb

@@ -0,0 +1,26 @@
+module Wobapphelpers
+  module Breadcrumbs
+    module BreadcrumbsHelper
+      def render_breadcrumbs
+	return if Wobapphelpers.breadcrumb_controller_blacklist.include?(controller.controller_path)
+	return if session[:breadcrumbs].nil? || session[:breadcrumbs].size == 0
+	track = ""
+	session[:breadcrumbs].each_with_index do |b, idx|
+	  track += "> #{breadcrumb_idx(b[0], b[1], idx)} "
+	end
+	%Q[<div id="breadcrumbs" class="visible-desktop">#{track}</div>].html_safe
+      end
+
+      def breadcrumb_idx(name, url, idx, html_class=nil)
+        uri = URI.parse(url)
+        query = uri.query || ""
+        if query =~ /bci=(\d+)/
+          uri.query.gsub!(/bci=(\d+)/, "bci=#{idx}")
+        else
+          uri.query = query + "&bci=#{idx}"
+        end
+        link_to name, uri.to_s.gsub('?&','?'), :class => html_class
+      end
+    end
+  end
+end

data/lib/wobapphelpers/helpers.rb

@@ -0,0 +1,12 @@
+module Wobapphelpers
+  module Helpers
+    autoload :IconHelper, 'wobapphelpers/helpers/icon_helper.rb'
+    autoload :ActionViewHelper, 'wobapphelpers/helpers/action_view_helper.rb'
+
+    # one module to rule all
+    module All
+      include IconHelper
+      include ActionViewHelper
+    end
+  end
+end

data/lib/wobapphelpers/helpers/action_view_helper.rb

@@ -0,0 +1,170 @@
+module Wobapphelpers
+  module Helpers
+
+    # implement model independent links for new, edit, show, delete
+    module ActionViewHelper
+      include Wobapphelpers::Breadcrumbs::BreadcrumbsHelper
+
+      def form_legend
+        raw(
+         %Q[<div class="row">] +
+         %Q[<div class="col-sm-9 offset-sm-3 col-md-10 offset-md-2">] +
+         %Q[<legend>#{controlleraction}</legend>] +
+         %Q[</div>] +
+         %Q[</div>]
+        )
+      end
+
+      def new_link(poly, options = {})
+        mypoly, obj = get_parts(poly)
+        if _can?(:create, obj)
+          options.symbolize_keys!
+          link_to obj.model_name.human + " erstellen",
+            new_polymorphic_path(mypoly),
+            remote: options.fetch(:remote, false),
+            title: options.fetch(:title, title(obj) + " hinzufügen"),
+            class: options.fetch(:class, 'btn btn-secondary')
+        end
+      end
+
+      def show_link(poly, options = {})
+        mypoly, obj = get_parts(poly)
+        if _can?(:read, obj)
+          options.symbolize_keys!
+          link_to icon_show, polymorphic_path(mypoly),
+            remote: options.fetch(:remote, false),
+            title:  options.fetch(:title, title(obj) + " anzeigen"),
+            class:  options.fetch(:class, 'btn btn-secondary')
+        end
+      end
+
+      def edit_link(poly, options = {})
+        mypoly, obj = get_parts(poly)
+        if _can?(:edit, obj)
+          options.symbolize_keys!
+          link_to icon_edit, edit_polymorphic_path(mypoly),
+            remote: options.fetch(:remote, false),
+            title:  options.fetch(:title, title(obj) + " bearbeiten"),
+            class:  options.fetch(:class, 'btn btn-secondary')
+        end
+      end
+
+      def delete_link(poly, options = {})
+        mypoly, obj = get_parts(poly)
+        if _can?(:destroy, obj)
+          options.symbolize_keys!
+          verify = options.has_key?(:verify) ? { verify: options.fetch(:verify) } : {}
+          link_to icon_delete, mypoly,
+            remote: options.fetch(:remote, false),
+            data: {
+              confirm: options.fetch(:confirm, "Sie wollen das Objekt löschen.\nSind Sie sicher?")
+            }.merge(verify),
+            method: :delete,
+            title:  options.fetch(:title, title(obj) + " löschen"),
+            class:  options.fetch(:class, 'btn btn-danger')
+        end
+      end
+
+      def back_link(options = {})
+        options.symbolize_keys!
+	unless options[:path].nil?
+	  goto = options[:path]
+	else
+          label = icon_left + " " + t('wobapphelpers.helpers.back')
+	  if session[:breadcrumbs] && session[:breadcrumbs].size > 1
+	    bc = session[:breadcrumbs][-2]
+	    idx   =  session[:breadcrumbs].size - 2
+	    title = bc[0]
+	    goto  = bc[1]
+	    breadcrumb_idx(label, goto, idx, 'btn btn-secondary')
+	  else
+	    link_to label, url_for(:back), :class => 'btn btn-secondary'
+	  end
+        end
+      end
+
+      def cancel_button
+        link_to icon_cancel + " " + t('wobapphelpers.helpers.cancel'),
+          url_for(:back), :class => 'btn btn-secondary'
+      end
+
+      def show_flash
+        # "- #{flash[:success]} - #{flash[:notice]} - #{flash[:alert]} -"
+	msg = ""
+	[:alert, :error, :notice, :success, :info].each do |severity|
+	  next unless flash[severity]
+	  case severity
+	  when :error, :alert
+	    my_class = "alert alert-danger"
+	  when :notice, :info
+	    my_class = "alert alert-info"
+	  when :success
+	    my_class = "alert alert-success"
+	  else
+	    my_class = severity.to_s
+	  end
+	  msg += %Q[<div id="#{severity.to_s}" class="#{my_class} alert-dismissable fade show noprint" role="alert">]
+	  msg += %Q[<button type="button" class="close" data-dismiss="alert" aria-label="Clse">]
+          msg += %Q[<span aria-hidden="true">&times;</span>]
+	  msg += %Q[</button>]
+	  msg += flash[severity]
+	  msg += %Q[</div>]
+	end
+	msg.html_safe
+      end
+
+      def active_class(myclass)
+        if controller.controller_name == myclass
+          "active"
+        end
+      end
+
+      private
+
+      #
+      # returns poly, object
+      # mypoly: poly.compact! if is_a? Array
+      #
+      def get_parts(poly)
+	if poly.kind_of? Array
+          mypoly = poly.compact
+	  [mypoly, mypoly[-1]]
+        else
+          [poly, poly]
+        end
+      end
+
+      def title(obj)
+        if obj.kind_of? Class
+          model = obj
+        else
+          model = obj.class
+        end
+        t('activerecord.models.' + model.model_name.i18n_key.to_s)
+      end
+
+      def controlleraction
+        action        = controller.action_name
+        namespace     = controller.controller_path
+        resource_name = t("activerecord.models.#{namespace.singularize}")
+        search_for    = [namespace, action].join(".").to_sym
+        t(search_for, scope: "wobapphelpers.controller".to_sym,
+          default: action.to_sym, name: resource_name)
+      end
+
+      def _can?(action, obj)
+        return true if Wobapphelpers.cancan == :none
+        obj = _normalize(obj) if obj.kind_of? Class
+        can? action, obj
+      end
+
+      def _normalize(model)
+        if Wobapphelpers.cancan == :cancan2
+          model.model_name.downcase.pluralize.to_sym
+        else
+          model
+        end
+      end
+    end
+  end
+end

data/lib/wobapphelpers/helpers/icon_helper.rb

@@ -0,0 +1,39 @@
+module Wobapphelpers
+  module Helpers
+    module IconHelper
+      PREDEFINED_ICONS = {
+        attachment: 'file',
+        back:       'arrow-left',
+        calendar:   'calendar',
+        cancel:     'trash',
+        closed:     'lock',
+        copy:       'clone',
+        delete:     'trash',
+        document:   'file',
+        download:   'download',
+        edit:       'pencil',
+        help:       'question',
+        info:       'info',
+        left:       'arrow-left',
+        new:        'plus',
+        ok:         'check',
+        open:       'folder-open',
+        print:      'print',
+        right:      'arrow-right',
+        show:       'eye',
+        star:       'star',
+        up:         'arrow-up',
+      }
+      
+      def icon(what)
+        raw(%Q[<i class="fa fa-#{what} fa-fw" aria-hidden="true"></i>])
+      end
+
+      PREDEFINED_ICONS.each do |key,value| 
+        define_method :"icon_#{key}" do
+          icon(value)
+        end
+      end
+    end
+  end
+end

data/lib/wobapphelpers/rails.rb

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

data/lib/wobapphelpers/responders.rb

@@ -0,0 +1,13 @@
+require 'action_controller'
+require 'responders'
+
+module Wobapphelpers
+  class Responders < ActionController::Responder
+    include ::Responders::FlashResponder
+  end
+end
+
+# -- use own translations
+require "active_support/i18n"
+I18n.load_path += Dir[File.expand_path("../responders/locales/*.yml", __FILE__)]
+

data/lib/wobapphelpers/responders/locales/de.yml

@@ -0,0 +1,12 @@
+de:
+  flash:
+    actions:
+      create:
+        notice: "%{resource_name} erfolgreich erstellt."
+        alert: "%{resource_name} konnte nicht angelegt werden!"
+      update:
+        notice: "%{resource_name} erfolgreich aktualisiert."
+        alert: "%{resource_name} konnte nicht aktualisiert werden!"
+      destroy:
+        notice: "%{resource_name} erfolgreich gelöscht."
+        alert: "%{resource_name} konnte nicht gelöscht werden!"