dry_crud 1.7.0 → 2.0.0

data/lib/generators/dry_crud/templates/app/helpers/standard_helper.rb

@@ -1,304 +0,0 @@
-# A view helper to standartize often used functions like formatting,
-# tables, forms or action links. This helper is ideally defined in the
-# ApplicationController.
-module StandardHelper
-
-  EMPTY_STRING = " ".html_safe   # non-breaking space asserts better css styling.
-
-  ################  FORMATTING HELPERS  ##################################
-
-  # Formats a single value
-  def f(value)
-    case value
-      when Fixnum then number_with_delimiter(value)
-      when Float, BigDecimal then number_with_precision(value, :precision => t('number.format.precision'), 
-                                                               :delimiter => t('number.format.delimiter'))
-      when Date   then l(value)
-      when Time   then l(value, :format => :time)
-      when true   then t(:"global.yes")
-      when false  then t(:"global.no")
-      when nil    then EMPTY_STRING
-      else value.to_s
-    end
-  end
-
-  # Formats an arbitrary attribute of the given ActiveRecord object.
-  # If no specific format_{type}_{attr} or format_{attr} method is found,
-  # formats the value as follows:
-  # If the value is an associated model, renders the label of this object.
-  # Otherwise, calls format_type.
-  def format_attr(obj, attr)
-    format_type_attr_method = obj.class.respond_to?(:model_name) ? :"format_#{obj.class.model_name.underscore}_#{attr.to_s}" : :"format_#{obj.class.name.underscore}_#{attr.to_s}"
-    format_attr_method = :"format_#{attr.to_s}"
-    if respond_to?(format_type_attr_method)
-      send(format_type_attr_method, obj)
-    elsif respond_to?(format_attr_method)
-      send(format_attr_method, obj)
-    elsif assoc = association(obj, attr, :belongs_to)
-      format_assoc(obj, assoc)
-    elsif assoc = association(obj, attr, :has_many, :has_and_belongs_to_many)
-      format_many_assoc(obj, assoc)
-    else
-      format_type(obj, attr)
-    end
-  end
-
-
-  ##############  STANDARD HTML SECTIONS  ############################
-
-
-  # Renders an arbitrary content with the given label. Used for uniform presentation.
-  def labeled(label, content = nil, &block)
-    content = capture(&block) if block_given?
-    render 'shared/labeled', :label => label, :content => content
-  end
-
-  # Transform the given text into a form as used by labels or table headers.
-  def captionize(text, clazz = nil)
-    text = text.to_s
-    if clazz.respond_to?(:human_attribute_name)
-      clazz.human_attribute_name(text.end_with?('_ids') ? text[0..-5].pluralize : text)
-    else
-      text.humanize.titleize
-    end
-  end
-
-  # Renders a list of attributes with label and value for a given object.
-  # Optionally surrounded with a div.
-  def render_attrs(obj, *attrs)
-    safe_join(attrs) { |a| labeled_attr(obj, a) }
-  end
-
-  # Renders the formatted content of the given attribute with a label.
-  def labeled_attr(obj, attr)
-    labeled(captionize(attr, obj.class), format_attr(obj, attr))
-  end
-
-  # Renders a table for the given entries. One column is rendered for each attribute passed.
-  # If a block is given, the columns defined therein are appended to the attribute columns.
-  # If entries is empty, an appropriate message is rendered.
-  # An options hash may be given as the last argument.
-  def table(entries, *attrs, &block)
-    entries.inspect # force evaluation of relations
-    if entries.present?
-      StandardTableBuilder.table(entries, self, attrs.extract_options!) do |t|
-        t.attrs(*attrs)
-        yield t if block_given?
-      end
-    else
-      content_tag(:div, ti(:no_list_entries), :class => 'table')
-    end
-  end
-
-  # Renders a standard form using StandardFormBuilder.
-  # Before the input fields, the error messages are rendered, if present.
-  def standard_form(object, options = {}, &block)
-    options[:builder] ||= StandardFormBuilder
-    options[:html] ||= {}
-    add_css_class options[:html], 'form-horizontal'
-
-    form_for(object, options) do |form|
-      content = form.error_messages
-      content << capture(form, &block)
-    end
-  end
-
-  # Renders a simple unordered list, which will
-  # simply render all passed items or yield them
-  # to your block.
-  def simple_list(items,ul_options={},&blk)
-    content_tag_nested(:ul, items, ul_options) do |item|
-      content_tag(:li, block_given? ? yield(item) : f(item))
-    end
-  end
-
-  # render a content tag with the collected contents rendered
-  # by &block for each item in collection.
-  def content_tag_nested(tag, collection, options = {}, &block)
-    content_tag(tag, safe_join(collection, &block), options)
-  end
-
-  # Overridden method that takes a block that is executed for each item in array
-  # before appending the results.
-  def safe_join(array, sep = $,, &block)
-    super(block_given? ? array.collect(&block) : array, sep)
-  end
-
-  ######## ACTION LINKS ###################################################### :nodoc:
-
-  # A generic helper method to create action links.
-  # These link could be styled to look like buttons, for example.
-  def link_action(label, icon = nil, url = {}, html_options = {})
-    add_css_class html_options, 'action btn'
-    link_to(icon ? action_icon(icon, label) : label,
-            url, html_options)
-  end
-
-  # Outputs an icon for an action with an optional label.
-  def action_icon(icon, label = nil)
-    html = content_tag(:i, "", :class => "icon-#{icon}")
-    html << ' ' << label if label
-    html
-  end
-
-  # Translates the passed key by looking it up over the controller hierarchy.
-  # The key is searched in the following order:
-  #  - {controller}.{current_partial}.{key}
-  #  - {controller}.{current_action}.{key}
-  #  - {controller}.global.{key}
-  #  - {parent_controller}.{current_partial}.{key}
-  #  - {parent_controller}.{current_action}.{key}
-  #  - {parent_controller}.global.{key}
-  #  - ...
-  #  - global.{key}
-  def translate_inheritable(key, variables = {})
-    defaults = []
-    partial = @virtual_path ? @virtual_path.gsub(%r{.*/_?}, "") : nil
-    current = controller.class
-    while current < ActionController::Base
-      folder = current.controller_path
-      if folder.present?
-        defaults << :"#{folder}.#{partial}.#{key}" if partial
-        defaults << :"#{folder}.#{action_name}.#{key}"
-        defaults << :"#{folder}.global.#{key}"
-      end
-      current = current.superclass
-    end
-    defaults << :"global.#{key}"
-
-    variables[:default] ||= defaults
-    t(defaults.shift, variables)
-  end
-
-  alias_method :ti, :translate_inheritable
-
-  # Translates the passed key for an active record association. This helper is used
-  # for rendering association dependent keys in forms like :no_entry, :none_available or
-  # :please_select.
-  # The key is looked up in the following order:
-  #  - activerecord.associations.models.{model_name}.{association_name}.{key}
-  #  - activerecord.associations.{association_model_name}.{key}
-  #  - global.associations.{key}
-  def translate_association(key, assoc = nil, variables = {})
-    primary = if assoc
-      variables[:default] ||= [:"activerecord.associations.#{assoc.klass.model_name.underscore}.#{key}",
-                               :"global.associations.#{key}"]
-      :"activerecord.associations.models.#{assoc.active_record.model_name.underscore}.#{assoc.name}.#{key}"
-    else
-      :"global.associations.#{key}"
-    end
-    t(primary, variables)
-  end
-
-  alias_method :ta, :translate_association
-
-
-  # Returns the css class for the given flash level.
-  def flash_class(level)
-    case level
-    when :notice then 'success'
-    when :alert then 'error'
-    else level.to_s
-    end
-  end
-
-  # Adds a class to the given options, even if there are already classes.
-  def add_css_class(options, classes)
-    if options[:class]
-      options[:class] += ' ' + classes
-    else
-      options[:class] = classes
-    end
-  end
-
-  private
-
-  # Helper methods that are not directly called from templates.
-
-  # Formats an arbitrary attribute of the given object depending on its data type.
-  # For ActiveRecords, take the defined data type into account for special types
-  # that have no own object class.
-  def format_type(obj, attr)
-    val = obj.send(attr)
-    return EMPTY_STRING if val.nil?
-    case column_type(obj, attr)
-      when :time    then f(val.to_time)
-      when :date    then f(val.to_date)
-      when :datetime, :timestamp then "#{f(val.to_date)} #{f(val.time)}"
-      when :text    then val.present? ? simple_format(h(val)) : EMPTY_STRING
-      when :decimal then f(val.to_s.to_f)
-      else f(val)
-    end
-  end
-
-  # Returns the ActiveRecord column type or nil.
-  def column_type(obj, attr)
-    column_property(obj, attr, :type)
-  end
-
-  # Returns an ActiveRecord column property for the passed attr or nil
-  def column_property(obj, attr, property)
-    if obj.respond_to?(:column_for_attribute)
-      column = obj.column_for_attribute(attr)
-      column.try(property)
-    end
-  end
-
-  # Formats an active record belongs_to association
-  def format_assoc(obj, assoc)
-    if val = obj.send(assoc.name)
-      assoc_link(assoc, val)
-    else
-      ta(:no_entry, assoc)
-    end
-  end
-
-  # Formats an active record has_and_belongs_to_many or
-  # has_many association.
-  def format_many_assoc(obj, assoc)
-    values = obj.send(assoc.name)
-    if values.size == 1
-      assoc_link(assoc, values.first)
-    elsif values.present?
-      simple_list(values) { |val| assoc_link(assoc, val) }
-    else
-      ta(:no_entry, assoc)
-    end
-  end
-
-  # Renders a link to the given association entry.
-  def assoc_link(assoc, val)
-    link_to_unless(no_assoc_link?(assoc, val), val.to_s, val)
-  end
-
-  # Returns true if no link should be created when formatting the given association.
-  def no_assoc_link?(assoc, val)
-    !respond_to?("#{val.class.model_name.underscore}_path".to_sym)
-  end
-
-  # Returns the association proxy for the given attribute. The attr parameter
-  # may be the _id column or the association name. If a macro (e.g. :belongs_to)
-  # is given, the association must be of this type, otherwise, any association
-  # is returned. Returns nil if no association (or not of the given macro) was
-  # found.
-  def association(obj, attr, *macros)
-    if obj.class.respond_to?(:reflect_on_association)
-      name = assoc_and_id_attr(attr).first.to_sym
-      assoc = obj.class.reflect_on_association(name)
-      assoc if assoc && (macros.blank? || macros.include?(assoc.macro))
-    end
-  end
-
-  # Returns the name of the attr and it's corresponding field
-  def assoc_and_id_attr(attr)
-    attr = attr.to_s
-    attr, attr_id = if attr.end_with?('_id')
-      [attr[0..-4], attr]
-    elsif attr.end_with?('_ids')
-      [attr[0..-5].pluralize, attr]
-    else
-      [attr, "#{attr}_id"]
-    end
-  end
-
-end

data/lib/generators/dry_crud/templates/app/helpers/standard_table_builder.rb

@@ -1,178 +0,0 @@
-# A simple helper to easily define tables listing several rows of the same data type.
-#
-# Example Usage:
-#   StandardTableBuilder.table(entries, template) do |t|
-#     t.col('My Header', :class => 'css') {|e| link_to 'Show', e }
-#     t.attrs :name, :city
-#   end
-class StandardTableBuilder
-  attr_reader :entries, :cols, :options, :template
-
-  # Delegate called methods to template.
-  # including StandardHelper would lead to problems with indirectly called methods.
-  delegate :content_tag, :format_attr, :column_type, :association, :dom_id,
-           :captionize, :add_css_class, :content_tag_nested, :to => :template
-
-  def initialize(entries, template, options = {})
-    @entries = entries
-    @template = template
-    @options = options
-    @cols = []
-  end
-
-  # Convenience method to directly generate a table. Renders a row for each entry in entries.
-  # Takes a block that gets the table object as parameter for configuration.
-  # Returns the generated html for the table.
-  def self.table(entries, template, options = {})
-    t = new(entries, template, options)
-    yield t
-    t.to_html
-  end
-
-  # Define a column for the table with the given header, the html_options used for
-  # each td and a block rendering the contents of a cell for the current entry.
-  # The columns appear in the order they are defined.
-  def col(header = '', html_options = {}, &block)
-    @cols << Col.new(header, html_options, @template, block)
-  end
-
-  # Convenience method to add one or more attribute columns.
-  # The attribute name will become the header, the cells will contain
-  # the formatted attribute value for the current entry.
-  def attrs(*attrs)
-    attrs.each do |a|
-      attr(a)
-    end
-  end
-
-  # Define a column for the given attribute and an optional header.
-  # If no header is given, the attribute name is used. The cell will
-  # contain the formatted attribute value for the current entry.
-  def attr(a, header = nil, &block)
-    header ||= attr_header(a)
-    block ||= lambda { |e| format_attr(e, a) }
-    col(header, :class => align_class(a), &block)
-  end
-
-  # Renders the table as HTML.
-  def to_html
-    add_css_class options, 'table'
-    content_tag :table, options do
-      content_tag(:thead, html_header) +
-      content_tag_nested(:tbody, entries) { |e| html_row(e) }
-    end
-  end
-
-  # Returns css classes used for alignment of the cell data.
-  # Based on the column type of the attribute.
-  def align_class(attr)
-    entry = entries.first
-    case column_type(entry, attr)
-      when :integer, :float, :decimal
-        'right' unless association(entry, attr, :belongs_to)
-      when :boolean
-        'center'
-    end
-  end
-
-  def attr_header(attr)
-    captionize(attr, entry_class)
-  end
-
-  private
-
-  def html_header
-    content_tag_nested(:tr, cols) { |c| c.html_header }
-  end
-
-  def html_row(entry)
-    attrs = {}
-    attrs[:id] = dom_id(entry) if entry.respond_to?(:dom_id)
-    content_tag_nested(:tr, cols, attrs) { |c| c.html_cell(entry) }
-  end
-
-  def entry_class
-    if entries.respond_to?(:klass)
-      entries.klass
-    else 
-      entries.first.class
-    end
-  end
-
-  # Helper class to store column information.
-  class Col < Struct.new(:header, :html_options, :template, :block) #:nodoc:
-
-    delegate :content_tag, :to => :template
-
-    def content(entry)
-      entry.nil? ? '' : template.capture(entry, &block)
-    end
-
-    def html_header
-      content_tag :th, header
-    end
-
-    def html_cell(entry)
-      content_tag :td, content(entry), html_options
-    end
-
-  end
-
-  # Provides headers with sort links. Expects a method :sortable?(attr)
-  # in the template/controller to tell if an attribute is sortable or not.
-  # Extracted into an own module for convenience.
-  module Sorting
-    # Create a header with sort links and a mark for the current sort direction.
-    def sort_header(attr, label = nil)
-      label ||= attr_header(attr)
-      template.link_to(label, sort_params(attr)) + current_mark(attr)
-    end
-
-    # Same as :attrs, except that it renders a sort link in the header
-    # if an attr is sortable.
-    def sortable_attrs(*attrs)
-      attrs.each do |a|
-        template.sortable?(a) ? sortable_attr(a) : attr(a)
-      end
-    end
-
-    # Renders a sort link header, otherwise similar to :attr.
-    def sortable_attr(a, header = nil)
-      attr(a, sort_header(a, header))
-    end
-
-    private
-
-    # Request params for the sort link.
-    def sort_params(attr)
-      params.merge({:sort => attr, :sort_dir => sort_dir(attr)})
-    end
-
-    # The sort mark, if any, for the given attribute.
-    def current_mark(attr)
-      if current_sort?(attr)
-        (sort_dir(attr) == 'asc' ? ' &uarr;' : ' &darr;').html_safe
-      else
-        ''
-      end
-    end
-
-    # Returns true if the given attribute is the current sort column.
-    def current_sort?(attr)
-      params[:sort] == attr.to_s
-    end
-
-    # The sort direction to use in the sort link for the given attribute.
-    def sort_dir(attr)
-      current_sort?(attr) && params[:sort_dir] == 'asc' ? 'desc' : 'asc'
-    end
-
-    # Delegate to template.
-    def params
-      template.params
-    end
-  end
-
-  include Sorting
-
-end