dry_crud 2.0.0 → 2.1.0

data/app/helpers/dry_crud/table/builder.rb

@@ -0,0 +1,115 @@
+# encoding: UTF-8
+
+module DryCrud::Table
+  # A simple helper to easily define tables listing several rows of the same
+  # data type.
+  #
+  # Example Usage:
+  #   DryCrud::Table::Builder.table(entries, template) do |t|
+  #     t.col('My Header', class: 'css') {|e| link_to 'Show', e }
+  #     t.attrs :name, :city
+  #   end
+  class Builder
+
+    include Sorting
+    include Actions
+
+    attr_reader :entries, :cols, :options, :template
+
+    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, html_options = {}, &block)
+      header ||= attr_header(a)
+      block ||= ->(e) { format_attr(e, a) }
+      add_css_class(html_options, align_class(a))
+      col(header, html_options, &block)
+    end
+
+    # Renders the table as HTML.
+    def to_html
+      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.present? ? entry_class.new : nil
+      case column_type(entry, attr)
+      when :integer, :float, :decimal
+        'right' unless association(entry, attr, :belongs_to)
+      when :boolean
+        'center'
+      end
+    end
+
+    # Creates a header string for the given attr.
+    def attr_header(attr)
+      captionize(attr, entry_class)
+    end
+
+    private
+
+    # Renders the header row of the table.
+    def html_header
+      content_tag_nested(:tr, cols) { |c| c.html_header }
+    end
+
+    # Renders a table row for the given entry.
+    def html_row(entry)
+      attrs = {}
+      attrs[:id] = dom_id(entry) if entry.respond_to?(:to_key)
+      content_tag_nested(:tr, cols, attrs) { |c| c.html_cell(entry) }
+    end
+
+    # Determines the class of the table entries.
+    # All entries should be of the same type.
+    def entry_class
+      if entries.respond_to?(:klass)
+        entries.klass
+      else
+        entries.first.class
+      end
+    end
+
+  end
+end

data/app/helpers/dry_crud/table/col.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+
+module DryCrud::Table
+  # Helper class to store column information.
+  class Col < Struct.new(:header, :html_options, :template, :block) #:nodoc:
+
+    delegate :content_tag, :capture, to: :template
+
+    # Runs the Col block for the given entry.
+    def content(entry)
+      entry.nil? ? '' : capture(entry, &block)
+    end
+
+    # Renders the header cell of the Col.
+    def html_header
+      content_tag(:th, header, html_options)
+    end
+
+    # Renders a table cell for the given entry.
+    def html_cell(entry)
+      content_tag(:td, content(entry), html_options)
+    end
+
+  end
+end

data/app/helpers/dry_crud/table/sorting.rb

@@ -0,0 +1,61 @@
+# encoding: UTF-8
+
+module DryCrud::Table
+  # 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 { |a| sortable_attr(a) }
+    end
+
+    # Renders a sort link header, otherwise similar to :attr.
+    def sortable_attr(a, header = nil, &block)
+      if template.sortable?(a)
+        attr(a, sort_header(a, header), &block)
+      else
+        attr(a, header, &block)
+      end
+    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' ? ' ↑' : ' ↓').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
+end

data/{lib/generators/dry_crud/templates/app → app}/helpers/form_helper.rb

@@ -13,7 +13,8 @@ module FormHelper
   def plain_form(object, options = {}, &block)
     options[:html] ||= {}
     add_css_class(options[:html], 'form-horizontal')
-    options[:builder] ||= Crud::FormBuilder
+    options[:html][:role] ||= 'form'
+    options[:builder] ||= DryCrud::Form::Builder
     options[:cancel_url] ||= polymorphic_path(object, returning: true)
 
     form_for(object, options, &block)
@@ -49,4 +50,4 @@ module FormHelper
     standard_form(path_args(entry), *attrs, &block)
   end
 
-end
+end

data/{lib/generators/dry_crud/templates/app → app}/helpers/format_helper.rb

@@ -112,7 +112,7 @@ module FormatHelper
   # special types that have no own object class.
   def format_type(obj, attr)
     val = obj.send(attr)
-    return UtilityHelper::EMPTY_STRING if val.blank?
+    return UtilityHelper::EMPTY_STRING if val.blank? && val != false
 
     case column_type(obj, attr)
     when :time    then l(val, format: :time)
@@ -152,13 +152,13 @@ module FormatHelper
 
   # 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)
+    link_to_if(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.singular_route_key}_path".to_sym)
+  def assoc_link?(assoc, val)
+    respond_to?("#{val.class.model_name.singular_route_key}_path".to_sym)
   end
 
-end
+end

data/{lib/generators/dry_crud/templates/app → app}/helpers/i18n_helper.rb

@@ -31,7 +31,7 @@ module I18nHelper
   #  - activerecord.associations.{association_model_name}.{key}
   #  - global.associations.{key}
   def translate_association(key, assoc = nil, variables = {})
-    if assoc
+    if assoc && assoc.options[:polymorphic].nil?
       variables[:default] ||= [association_klass_key(assoc, key).to_sym,
                                :"global.associations.#{key}"]
       t(association_owner_key(assoc, key), variables)
@@ -82,4 +82,4 @@ module I18nHelper
     defaults << :"#{folder}.global.#{key}"
   end
 
-end
+end

data/{lib/generators/dry_crud/templates/app → app}/helpers/table_helper.rb

@@ -17,8 +17,9 @@ module TableHelper
   # An options hash may be given as the last argument.
   def plain_table(entries, *attrs, &block)
     options = attrs.extract_options!
-    add_css_class(options, 'table')
-    Crud::TableBuilder.table(entries, self, options) do |t|
+    add_css_class(options, 'table table-striped table-hover')
+    builder = options.delete(:builder) || DryCrud::Table::Builder
+    builder.table(entries, self, options) do |t|
       t.attrs(*attrs)
       yield t if block_given?
     end
@@ -57,10 +58,10 @@ module TableHelper
     attrs, options = explode_attrs_with_options(attrs, &block)
     first = attrs.shift
     plain_table_or_message(entries, options) do |t|
-       t.attr_with_show_link(first) if first
-       t.sortable_attrs(*attrs)
-       yield t if block_given?
-       standard_table_actions(t)
+      t.attr_with_show_link(first) if first
+      t.sortable_attrs(*attrs)
+      yield t if block_given?
+      standard_table_actions(t)
     end
   end
 
@@ -80,4 +81,4 @@ module TableHelper
     [attrs, options]
   end
 
-end
+end

data/{lib/generators/dry_crud/templates/app → app}/helpers/utility_helper.rb

@@ -14,7 +14,7 @@ module UtilityHelper
   # Overridden method that takes a block that is executed for each item in
   # array before appending the results.
   def safe_join(array, sep = $OUTPUT_FIELD_SEPARATOR, &block)
-    super(block_given? ? array.map(&block) : array, sep)
+    super(block_given? ? array.map(&block).compact : array, sep)
   end
 
   # Returns the css class for the given flash level.

data/{lib/generators/dry_crud/templates/app → app}/views/layouts/_nav.html.erb

@@ -1,5 +1,5 @@
-<%= link_to 'MyApp', root_path, class: 'brand' %>
-<ul class="nav">
+<%= link_to 'MyApp', root_path, class: 'navbar-brand' %>
+<ul class="nav navbar-nav">
   <li><%= link_to "Link1", "/path1"  %></li>
   <li><%= link_to "Link2", "/path2"  %></li>
   <li><%= link_to "Link3", "/path3"  %></li>

data/{lib/generators/dry_crud/templates/app → app}/views/layouts/_nav.html.haml

@@ -1,5 +1,5 @@
-= link_to 'MyApp', root_path, class: 'brand'
-%ul.nav
+= link_to 'MyApp', root_path, class: 'navbar-brand'
+%ul.nav.navbar-nav
   %li= link_to "Link1", "/path1"
   %li= link_to "Link2", "/path2"
   %li= link_to "Link3", "/path3"

data/{lib/generators/dry_crud/templates/app/views/layouts/crud.html.erb → app/views/layouts/application.html.erb}

@@ -4,17 +4,19 @@
 <head>
   <meta charset="utf-8" />
   <title><%= strip_tags(@title) %> - MyApp</title>
-  <%= csrf_meta_tag %>
 
-  <!-- HTML5 shim, for IE6-8 support of HTML elements -->
-  <!--[if lt IE 9]>
-    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
-  <![endif]-->
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <%= csrf_meta_tag %>
 
   <%= stylesheet_link_tag 'application', media: 'all', 'data-turbolinks-track' => true %>
   <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
 
-  <!-- fav and touch icons -->
+  <!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
+  <!--[if lt IE 9]>
+    <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
+    <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
+  <![endif]-->
+
   <%= favicon_link_tag %>
   <%= favicon_link_tag '/apple-touch-icon.png',
                        rel: 'apple-touch-icon',
@@ -32,25 +34,29 @@
 </head>
 <body>
 
+<nav class="navbar navbar-default" role="navigation">
+  <%= render 'layouts/nav' %>
+</nav>
 
 <div class="container">
-  <div class="navbar">
-    <%= render 'layouts/nav' %>
-  </div>
 
   <h1><%= @title %></h1>
 
-  <%= render partial: 'layouts/flash', collection: [:notice, :alert], as: :level %>
-
-  <div class="actions btn-toolbar">
-    <div class="pull-right">
-      <%= yield :actions %>
+  <div class="row actions">
+    <div class="col-md-5">
+        <%= yield :tools %>
     </div>
-    <div class="pull-left">
-      <%= yield :tools %>
+    <div class="col-md-7">
+      <div class="btn-toolbar pull-right">
+        <%= yield :actions %>
+      </div>
     </div>
   </div>
 
+  <div id="flash">
+    <%= render partial: 'layouts/flash', collection: [:notice, :alert], as: :level %>
+  </div>
+
   <div id="content">
     <%= yield %>
   </div>

data/{lib/generators/dry_crud/templates/app/views/layouts/crud.html.haml → app/views/layouts/application.html.haml}

@@ -6,16 +6,18 @@
     %title
       = strip_tags(@title)
       \- MyApp
-    = csrf_meta_tag
 
-    <!-- HTML5 shim, for IE6-8 support of HTML elements -->
-    <!--[if lt IE 9]>
-    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
-    <![endif]-->
+    %meta{name: 'viewport', content: 'width=device-width, initial-scale=1.0'}
+    = csrf_meta_tag
 
     = stylesheet_link_tag 'application', :media => 'all', 'data-turbolinks-track' => true
     = javascript_include_tag 'application', 'data-turbolinks-track' => true
 
+    / HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries
+    /[if lt IE 9]
+      %script{src: 'https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js'}
+      %script{src: 'https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js'}
+
     = favicon_link_tag
     = favicon_link_tag '/apple-touch-icon.png',
                        rel: 'apple-touch-icon',
@@ -32,16 +34,20 @@
     = yield :head
 
   %body
+    %nav.navbar.navbar-default{role: 'navigation'}
+      = render 'layouts/nav'
+      
     .container
-      .navbar= render 'layouts/nav'
-
       %h1= @title
 
-      = render partial: 'layouts/flash', collection: [:notice, :alert], as: :level
+      .row.actions
+        .col-md-5
+          = yield :tools
+        .col-md-7
+          .btn-toolbar.pull-right
+            = yield :actions
 
-      .actions.btn-toolbar
-        .pull-right= yield :actions
-        .pull-left= yield :tools
+      #flash= render partial: 'layouts/flash', collection: [:notice, :alert], as: :level
 
       #content= yield
 

data/app/views/list/_search.html.erb

@@ -0,0 +1,10 @@
+<%= form_tag(nil, method: :get, role: 'search', class: 'form-inline') do %>
+  <%= hidden_field_tag :returning, true %>
+  <%= hidden_field_tag :page, 1 %>
+  <div class="input-group">
+	<%= search_field_tag :q, params[:q], class: 'form-control' %>
+    <span class="input-group-btn">
+	  <%= submit_tag ti(:"button.search"), class: 'btn btn-default' %>
+	</span>
+  </div>
+<% end %>

data/app/views/list/_search.html.haml

@@ -0,0 +1,7 @@
+= form_tag(nil, { method: :get, class: 'form-inline', role: 'search' }) do
+  = hidden_field_tag :returning, true
+  = hidden_field_tag :page, 1
+  .input-group
+    = search_field_tag :q, params[:q], class: 'form-control'
+    %span.input-group-btn
+      = submit_tag ti(:"button.search"), class: 'btn btn-default'

data/{lib/generators/dry_crud/templates/app → app}/views/shared/_error_messages.html.erb

@@ -1,5 +1,5 @@
 <% if errors.any? %>
-  <div id='error_explanation' class='alert alert-error'>
+  <div id='error_explanation' class='alert alert-danger'>
       <h2>
       <%= ti(:"errors.header", count: errors.count, model: object.to_s) %>
       </h2>

data/{lib/generators/dry_crud/templates/app → app}/views/shared/_error_messages.html.haml

@@ -1,5 +1,5 @@
 - if errors.any?
-  #error_explanation.alert.alert-error
+  #error_explanation.alert.alert-danger
     %h2= ti(:"errors.header", count: errors.count, model: object.to_s)
     %ul
       - errors.full_messages.each do |msg|

data/lib/dry_crud/engine.rb

@@ -0,0 +1,18 @@
+module DryCrud
+  class Engine < Rails::Engine
+    
+    
+    initializer "dry_crud.field_error_proc" do |app|
+      # Fields with errors are directly styled in DryCrud::FormBuilder.
+      # Rails should just output the plain html tag.
+      ActionView::Base.field_error_proc = proc { |html_tag, instance| html_tag }
+      
+      # Load dry_crud engine helpers first so that the application may override them.
+      paths = ApplicationController.helpers_path
+      if dry_crud_helpers = paths.detect {|p| p =~ /dry_crud(-\d+\.\d+\.\d+)?#{File::SEPARATOR}app#{File::SEPARATOR}helpers\z/ }
+        paths.delete(dry_crud_helpers)
+        paths.prepend(dry_crud_helpers)
+      end
+    end
+  end
+end

data/lib/dry_crud.rb

@@ -0,0 +1,5 @@
+require 'dry_crud/engine'
+
+module DryCrud
+
+end

data/lib/generators/dry_crud/dry_crud_generator.rb

@@ -1,23 +1,24 @@
 # encoding: UTF-8
 
-require 'rails/generators'
+begin
+  require 'generators/dry_crud/dry_crud_generator_base'
+rescue LoadError => e
+  # ok, we are in the rake task
+end
 
 # Copies all dry_crud files to the rails application.
-class DryCrudGenerator < Rails::Generators::Base
+class DryCrudGenerator < DryCrudGeneratorBase
+
+  desc 'Copy all dry_crud files to the application.'
 
   class_options %w(templates -t) => 'erb'
   class_options %w(tests) => 'testunit'
 
-  def self.source_root
-     File.join(File.dirname(__FILE__), 'templates')
-  end
-
- # copy everything in template subfolders
+  # copy everything to application
   def install_dry_crud
-    Dir.chdir(self.class.source_root) do
-      Dir.glob(File.join('**', '**')).sort.each do |file_source|
-        copy_file_source(file_source) if should_copy?(file_source)
-      end
+    copy_files(all_template_files)
+
+    Dir.chdir(self.class.template_root) do
       copy_crud_test_model
     end
 
@@ -27,20 +28,11 @@ class DryCrudGenerator < Rails::Generators::Base
   private
 
   def should_copy?(file_source)
-    !File.directory?(file_source) &&
     !file_source.end_with?(exclude_template) &&
     !file_source.start_with?(exclude_test_dir) &&
     file_source != 'INSTALL'
   end
 
-  def copy_file_source(file_source)
-    if file_source.end_with?('.erb')
-      copy_file(file_source)
-    else
-      template(file_source)
-    end
-  end
-
   def copy_crud_test_model
     unless exclude_test_dir == 'spec'
       template(File.join('test', 'support', 'crud_test_model.rb'),