carload 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8cd7d8e37f5576e78d936449c1e5037208db1789
-  data.tar.gz: feed52ae809a23d8cdc1f591e8ea76760e387945
+  metadata.gz: 9dc8244c3cd30b96538af399c5d325a32c7b46f2
+  data.tar.gz: 038e2a71da51255577b35a15fc21a8b6b66fb7b8
 SHA512:
-  metadata.gz: cbc8dcf229e5789e2f7517b8b8c7e1b717abfc63372fd76bc537571969072a0f260d8cd5b90b56aba35ea5d5780f20a6b3a2cb7222552eb1828548ba528100d2
-  data.tar.gz: 4faa773c891477b8f1b72c9b54e33ecebdd55d8c9e333ced189a8acec895c24309d54bf4ae4ca14fd4133ef4075c5d74e92cf4d1aa78b52ce68ead454f862df8
+  metadata.gz: 7a24677546621e1a187042e2e27ea5b603495590543b624133ab06151ddb423e2d7ad07695241277f52f3b9efc212bee433b87583140749be9e91a9693818d23
+  data.tar.gz: 99b19227d0f62ad5ae1081e5fa1deb04becb1373ec97f88f40514d9493e265b3e4bc84907d829afa908bad798287e7c62da828f22c9798fa3f60d18ccf42e770

data/README.md

@@ -26,9 +26,24 @@ You can edit the initializer `config/initializers/carload.rb` for example:
 
 ```ruby
 Carload.setup do |config|
+  # Set the title that will be displayed on the browser tab area.
+  config.page.title = nil
+
+  # Set the footer text that will be displayed on each page.
+  config.page.footer = nil
+
+  # Set the colors of page elements.
+  config.page.main_color = nil
+  config.page.text_color = 'black'
+  config.page.button_color = nil
+  config.page.button_text_color = nil
+
   # Specify which authentication solution is used. Currently, we only support Devise.
   config.auth_solution = :devise
 
+  # Set which file upload solution is used. Currently, we only support Carrierwave.
+  config.upload_solution = :carrierwave
+
   # Set the actions used to discern user's permission to access dashboard.
   #
   #   config.dashboard.permits_user.<method> = '...'
@@ -87,6 +102,8 @@ class Dashboard < Carload::Dashboard
 end
 ```
 
+- You can run another generator `rails g carload:dash <model_name>` to generate the above content automatically (it may ask you some question).
+
 - Make sure you have the necessary I18n translation files, for example:
 
 ```yaml

data/app/assets/stylesheets/carload/_select2.scss

@@ -15,3 +15,18 @@
 .select2-container {
   min-width: 174px;
 }
+
+.select2-search__field {
+  line-height: 22px;
+}
+.select2-search__field:focus {
+  box-shadow: none !important;
+}
+.select2-selection__choice {
+  line-height: 22px;
+  background-color: $main-color !important;
+  color: white;
+}
+.select2-selection__choice__remove {
+  color: white !important;
+}

data/app/assets/stylesheets/carload/colors.scss.erb

@@ -0,0 +1,5 @@
+$main-color: <%= Carload.page.main_color || '#8C7DA6' %>;
+$text-color: <%= Carload.page.text_color || '#3F3F44' %>;
+$button-color-1: <%= Carload.page.button_color_1 || Carload.page.button_color || '#60b044' %>;
+$button-color-2: <%= Carload.page.button_color_2 || Carload.page.button_color || '#8add6d' %>;
+$button-text-color: <%= Carload.page.button_text_color || 'white' %>;

data/app/assets/stylesheets/carload/common.scss

@@ -51,19 +51,21 @@ th {
 }
 
 .btn-primary {
-  color: #fff;
+  color: $button-text-color;
   text-shadow: 0 -1px 0 rgba(0,0,0,0.15);
-  background-color: #60b044;
-  background-image: -webkit-linear-gradient(#8add6d, #60b044);
-  background-image: linear-gradient(#8add6d, #60b044);
-  border-color: #5ca941;
+  background-color: $button-color-1;
+  background-image: -webkit-linear-gradient($button-color-2, $button-color-1);
+  background-image: linear-gradient($button-color-2, $button-color-1);
+  border: none;
+  height: 34px;
 }
 .btn-primary:hover {
-  color: #fff;
-  background-color: #569e3d;
-  background-image: -webkit-linear-gradient(#79d858, #569e3d);
-  background-image: linear-gradient(#79d858, #569e3d);
-  border-color: #4a993e;
+  color: lighten($button-text-color, 20%);
+  background-color: lighten($button-color-1, 20%);
+  background-image: -webkit-linear-gradient(lighten($button-color-2, 20%), lighten($button-color-1, 20%));
+  background-image: linear-gradient(lighten($button-color-2, 20%), lighten($button-color-1, 20%));
+  border: none;
+  height: 34px;
 }
 
 .form-control:hover {
@@ -75,3 +77,7 @@ th {
   border-color: $main-color !important;
   box-shadow: inset 0 1px 1px rgba(0, 0, 0, 0.075), 0 0 8px $main-color !important;
 }
+
+.label-primary {
+  background-color: $main-color;
+}

data/app/assets/stylesheets/carload/dashboard.scss

@@ -25,11 +25,13 @@ $half-spacing: 8px;
     border-top-right-radius: 0;
   }
   a {
+    color: $text-color;
     border-color: $main-color;
   }
   a:hover {
     background-color: lighten($main-color, 20%);
     border-color: lighten($main-color, 20%);
+    color: white;
   }
   a.active {
     background-color: $main-color;
@@ -64,6 +66,9 @@ $half-spacing: 8px;
     td {
       overflow: scroll;
     }
+    th:first-child, td:first-child {
+      padding-left: $spacing;
+    }
     th:last-child {
       width: 50px;
     }
@@ -78,22 +83,19 @@ $half-spacing: 8px;
 #dashboard-index-buttons {
   display: inline-block;
   margin-right: $spacing;
-}
-#new_q {
-  display: inline-block;
+  line-height: 34px;
 }
 
-.search-fields {
-  display: inline-flex;
-  .form-group {
-    display: inline-flex;
-    margin-right: 5px;
-    margin-bottom: 0;
+#search-input {
+  position: relative;
+  .icon {
+    position: absolute;
+    bottom: 8px;
+    left: 8px;
+    color: #ccc;
   }
-  .form-group:last-child {
-    margin-right: 0;
+  input {
+    width: 100%;
+    padding-left: 30px;
   }
 }
-.search-buttons {
-  display: inline-flex;
-}

data/app/controllers/carload/dashboard_controller.rb

@@ -8,14 +8,20 @@ module Carload
 
     before_action :set_model
     before_action :set_object, only: [:edit, :update, :destroy]
+    before_action :transform_polymorphic_params, only: [:create, :update]
+
     include Croppable
+    include ApplicationHelper
 
     def index
       authorize :carload_dashboard, :index? unless Carload.auth_solution == :none
-      @search = @model_class.search(params[:q])
-      @objects = @search.result.page(params[:page])
+      if params[:search].present?
+        @query = params[:search][:query]
+        @objects = @model_class.search(params[:search][:query]).page(params[:page])
+      else
+        @objects = @model_class.page(params[:page])
+      end
       @show_attributes = Dashboard.model(@model_name).index_page[:shows][:attributes] + [:created_at, :updated_at]
-      @search_attributes = Dashboard.model(@model_name).index_page[:searches][:attributes]
       render "dashboard/#{@model_names}/index.html.erb"
     end
 
@@ -82,5 +88,15 @@ module Carload
     def rescue_unmanaged_model_error exception
       redirect_to dashboard_error_path(message: exception.message)
     end
+
+    def transform_polymorphic_params
+      polymorphic_params = {}
+      params[@model_name].each do |key, value|
+        if polymorphic? key
+          polymorphic_params["#{key}_id"], polymorphic_params["#{key}_type"] = value.split(',')
+        end
+      end
+      params[@model_name].merge! polymorphic_params
+    end
   end
 end

data/app/helpers/carload/application_helper.rb

@@ -8,8 +8,24 @@ module Carload
       end
     end
 
+    def polymorphic? attribute_name
+      Dashboard.model(@model_name).associated_models.each_value do |associated_model|
+        return associated_model[:name] if attribute_name =~ /#{associated_model[:name]}/ and associated_model[:polymorphic]
+      end
+      false
+    end
+
     def image? attribute_name
       attribute_name.to_s =~ /image|logo|img/
     end
+
+    def id_or_ids associated_model
+      case associated_model[:association_type]
+      when :has_many
+        "#{associated_model[:name]}_ids"
+      else
+        "#{associated_model[:name]}_id"
+      end
+    end
   end
 end

data/app/helpers/carload/dashboard_helper.rb

@@ -1,59 +1,45 @@
 module Carload
   module DashboardHelper
-    def generate_input form, model_name, attribute_name, column
-      if Dashboard::ModelSpec.foreign_key? attribute_name
+    def generate_input form, model_name, attribute_name, options = {}
+      if options[:polymorphic]
+        form.input attribute_name,
+          collection: @model_class.send(attribute_name.to_s.pluralize),
+          selected: options[:value],
+          input_html: { class: 'use-select2' }
+      elsif attribute_name =~ /_id$/
         associated_model = attribute_name.gsub(/_id$/, '').to_sym
-        options = Dashboard.model(model_name).associated_models[associated_model]
-        label_attribute = options[:choose_by]
-        if options[:polymorphic]
-          forms = ''
-          options[:available_models].each_with_index do |real_model, i|
-            forms << form.input(attribute_name,
-              label: t("activerecord.attributes.#{model_name}.#{real_model}.#{label_attribute}"),
-              collection: real_model.camelize.constantize.all,
-              label_method: label_attribute,
-              value_method: :id,
-              input_html: {
-                class: 'use-select2',
-                data: {
-                  placeholder: t('carload.placeholder.select', thing: t("activerecord.attributes.#{real_model}.#{label_attribute}"))
-                }
-              },
-              wrapper_html: {
-                id: "#{real_model.camelize}-#{label_attribute}"
-              }
-            )
-          end
-          # Add JavaScript to select which real model to work on.
-          forms << <<-EOT
-            <script>
-              $('.#{model_name}_#{associated_model}_id').hide()
-              if ($('##{model_name}_#{associated_model}_type').val() != '') {
-                $('#' + $('##{model_name}_#{associated_model}_type').val() + '-#{label_attribute}').show()
-              }
-              $('##{model_name}_#{associated_model}_type').change(function() {
-                $('.#{model_name}_#{associated_model}_id').hide()
-                $('#' + $(this).val() + '-#{label_attribute}').show()
-                $('.package_packagable_id > .select2-container').css('width', '100%')
-              })
-            </script>
-          EOT
-          raw forms.html_safe
-        else
-          form.association associated_model,
-            label_method: label_attribute,
-            label: t("activerecord.models.#{associated_model}"),
-            input_html: {
-              class: 'use-select2',
-              data: {
-                placeholder: t('carload.placeholder.select', thing: t("activerecord.attributes.#{associated_model}.#{label_attribute}"))
-              }
+        association_specs = Dashboard.model(model_name).associated_models[associated_model]
+        label_attribute = association_specs[:choose_by]
+        form.association associated_model,
+          label_method: label_attribute,
+          label: t("activerecord.models.#{associated_model}"),
+          input_html: {
+            class: 'use-select2',
+            data: {
+              placeholder: t('carload.placeholder.select', thing: t("activerecord.attributes.#{associated_model}.#{label_attribute}"))
             }
-        end
+          }
+      elsif attribute_name =~ /_ids$/
+        # Mandle many-to-many association.
+        associated_model = attribute_name.gsub(/_ids$/, '').to_sym
+        association_specs = Dashboard.model(model_name).associated_models[associated_model]
+        label_attribute = association_specs[:choose_by]
+        form.input attribute_name,
+          label: t("activerecord.attributes.#{associated_model}.#{label_attribute}") + " (#{t("activerecord.models.#{associated_model}")})",
+          collection: associated_model.to_s.camelize.constantize.all,
+          label_method: label_attribute,
+          value_method: :id,
+          input_html: {
+            class: 'use-select2',
+            multiple: true,
+            data: {
+              placeholder: t('carload.placeholder.select', thing: t("activerecord.attributes.#{associated_model}.#{label_attribute}"))
+            }
+          }
       elsif attribute_name =~ /_type$/
         associated_model = attribute_name.gsub(/_type$/, '').to_sym
-        options = Dashboard.model(model_name).associated_models[associated_model]
-        form.input attribute_name, collection: options[:available_models].map(&:camelize),
+        association_specs = Dashboard.model(model_name).associated_models[associated_model]
+        form.input attribute_name, collection: association_specs[:instance_models].map{ |x| x.to_s.camelize },
           input_html: {
             class: 'use-select2',
             data: {
@@ -67,20 +53,29 @@ module Carload
       end
     end
 
-    def generate_search_input form, model_name, attribute
-      if attribute[:options]
-        form.input "#{attribute[:name].to_s.gsub('.', '_')}_#{attribute[:term]}",
-          required: false, label: false, collection: attribute[:options],
-          input_html: {
-            class: 'use-select2',
-            data: {
-              placeholder: t('carload.placeholder.select', thing: t("activerecord.attributes.#{model_name}.#{attribute[:name]}"))
-            }
-          }
-      else
-        form.input "#{attribute[:name].to_s.gsub('.', '_')}_#{attribute[:term]}",
-          placeholder: t("activerecord.attributes.#{@model_name}.#{attribute[:name]}"),
-          required: false, label: false
+    def generate_show_title attribute
+      case attribute
+      when Symbol
+        begin
+          t("activerecord.attributes.#{@model_name}.#{attribute}", raise: true)
+        rescue
+          t("carload.activerecord.#{attribute}", raise: true)
+        end
+      when String
+        begin
+          t("activerecord.attributes.#{@model_name}.#{attribute}", raise: true)
+        rescue
+          "#{t("activerecord.attributes.#{attribute}", raise: true)} (#{t("activerecord.models.#{attribute.split('.').first.to_s.singularize}", raise: true)})"
+        end
+      when Array
+        if attribute.first == :pluck
+          raise UnsupportedError.new("attribute #{attribute}") if attribute.size != 3
+          model_name = attribute[1].to_s.singularize
+          attribute_name = attribute[2]
+          "#{t("activerecord.attributes.#{model_name}.#{attribute_name}", raise: true)} (#{t("activerecord.models.#{model_name}", raise: true)})"
+        else
+          "#{t("activerecord.attributes.#{attribute.join('.')}", raise: true)} (#{t("activerecord.models.#{attribute[0].to_s.singularize}", raise: true)})"
+        end
       end
     end
 
@@ -89,7 +84,20 @@ module Carload
       when Symbol
         object.send attribute
       when String
-        eval "object.#{attribute.gsub('.', '&.')}"
+        res = eval "object.#{attribute.gsub('.', '&.')}"
+        case res
+        when String
+          res
+        when Array
+          raw res.map { |x| "<span class='label label-primary'>#{x}</span>" }.join(' ')
+        end
+      when Array
+        if attribute.first == :pluck
+          raise UnsupportedError.new("attribute #{attribute}") if attribute.size != 3
+          generate_show object, "#{attribute[1].to_s.pluralize}.pluck(:#{attribute[2]})"
+        else
+          generate_show object, attribute.join('.')
+        end
       end
     end
   end

data/app/views/carload/dashboard/_form.html.erb

@@ -1,7 +1,19 @@
 <%= simple_form_for @object, url: "/carload/dashboard/#{@model_names}/#{@object.id}" do |f| %>
+  <!-- Normal attributes -->
   <% @model_class.columns_hash.each do |name, column| %>
-    <% next if Dashboard::ModelSpec::SkippedAttributes.include? name %>
-    <%= generate_input(f, @model_name, name, column) rescue nil %>
+    <% next if Carload::ModelSpec::SkippedAttributes.include? name or polymorphic? name %>
+    <%= generate_input f, @model_name, name %>
+  <% end %>
+  <!-- Polymorphics -->
+  <% Dashboard.model(@model_name).associated_models.each_value do |associated_model| %>
+    <% next if associated_model[:polymorphic] != true %>
+    <%= generate_input f, @model_name, associated_model[:name], polymorphic: true,
+      value: "#{@object.send("#{associated_model[:name]}_id")},#{@object.send("#{associated_model[:name]}_type")}" %>
+  <% end %>
+  <!-- Join tables -->
+  <% Dashboard.model(@model_name).associated_models.each_value do |associated_model| %>
+    <% next if not associated_model[:join_table] %>
+    <%= generate_input f, @model_name, id_or_ids(associated_model) %>
   <% end %>
   <%= f.button :submit, t('carload.action.submit'), class: 'btn btn-primary' %>
 <% end %>

data/app/views/carload/dashboard/index.html.erb

@@ -9,13 +9,7 @@
         <tr>
           <th width='20'>ID</th>
           <% @show_attributes.each do |attribute| %>
-            <th width='100'>
-              <% begin %>
-                <%= t("activerecord.attributes.#{@model_name}.#{attribute}", raise: true) %>
-              <% rescue %>
-                <%= t("carload.activerecord.#{attribute}") %>
-              <% end %>
-            </th>
+            <th width='100'><%= generate_show_title attribute rescue attribute %></th>
           <% end %>
           <th width='20'><%= t('carload.actions') %></th>
         </tr>

data/app/views/carload/dashboard/shared/_search_fields.html.erb

@@ -1,10 +1,6 @@
-<%= simple_form_for @search, url: dashboard_search_path(@model_names), method: :post do |f| %>
-  <div class='search-fields'>
-    <% @search_attributes.each do |attribute| %>
-      <%= generate_search_input f, @model_name, attribute %>
-    <% end %>
-  </div>
-  <div class='search-buttons'>
-    <%= f.submit t('carload.action.search'), class: 'btn btn-primary' %>
-  </div>
-<% end %>
+<div id='search-input'>
+  <%= form_for :search, url: dashboard_search_path(@model_names), method: :get do |f| %>
+    <span class='icon'><%= fa_icon('search') %></span>
+    <%= f.text_field :query, class: 'form-control', placeholder: 'Search ...', value: @query %>
+  <% end %>
+</div>

data/app/views/layouts/carload/dashboard.html.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Carload</title>
+  <title><%= Carload.page.title || 'Carload' %></title>
   <meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0'/>
   <%= stylesheet_link_tag    'carload/dashboard', media: 'all' %>
   <%= javascript_include_tag 'carload/dashboard' %>
@@ -25,7 +25,7 @@
     </div>
 
     <footer class='center'>
-      <%= raw t('carload.footer.message') %>
+      <%= raw Carload.page.footer || t('carload.footer.message') %>
     </footer>
   </div>
 

data/db/migrate/20161030074822_carload_enable_zhparser_extension.rb

@@ -0,0 +1,7 @@
+class CarloadEnableZhparserExtension < ActiveRecord::Migration[5.0]
+  def change
+    enable_extension :zhparser
+    execute 'create text search configuration zhparser (parser = zhparser);'
+    execute 'alter text search configuration zhparser add mapping for n,v,a,i,e,l with simple;'
+  end
+end

data/lib/carload/association_pipelines.rb

@@ -0,0 +1,52 @@
+module Carload
+  module AssociationPipelines
+    def association_pipelines
+      [ :pipeline_1, :pipeline_2, :pipeline_3 ]
+    end
+
+    # Find polymorphic instance models.
+    def pipeline_1 association
+      return unless association.options[:polymorphic]
+      associated_model = @associated_models[association.name]
+      ActiveRecord::Base.descendants.each do |model|
+        next if model.name == 'ApplicationRecord' or model.name.underscore == @name.to_s
+        model.reflect_on_all_associations.each do |model_association|
+          next unless model_association.options[:as] == association.name
+          associated_model[:instance_models] ||= []
+          associated_model[:instance_models] << model.name.underscore.to_sym
+          if not associated_model[:attributes]
+            associated_model[:attributes] = model.column_names - ModelSpec::SkippedAttributes
+          else
+            associated_model[:attributes] = associated_model[:attributes] & model.column_names
+          end
+        end
+      end
+    end
+
+    # Add possible attributes to let user choose.
+    def pipeline_2 association
+      return unless associated_model = @associated_models[association.name.to_s.singularize.to_sym]
+      model = association.name.to_s.singularize.camelize.constantize rescue return
+      associated_model[:attributes] ||= []
+      associated_model[:attributes] = model.column_names - ModelSpec::SkippedAttributes
+      associated_model[:attributes] = associated_model[:attributes] - [
+        "#{@name}_id",
+        "#{associated_model[:polymorphic]}_id",
+        "#{associated_model[:polymorphic]}_type"
+      ]
+    end
+
+    # Add has-many permitted attribute.
+    def pipeline_3 association
+      _association = (association.delegate_reflection rescue nil) || association
+      return unless _association.class == ActiveRecord::Reflection::HasManyReflection
+      # Exclude join table.
+      return unless @klass.reflect_on_all_associations.select { |x| x.options[:through] == _association.name }.empty?
+      @attributes[:permitted].each do |permitted|
+        next unless permitted.class == Hash
+        return if permitted.keys.first == :"#{_association.class_name.underscore}_ids"
+      end
+      @attributes[:permitted] << { :"#{_association.class_name.underscore}_ids" => [] }
+    end
+  end
+end

data/lib/carload/dashboard.rb

@@ -1,112 +1,12 @@
 module Carload
   class Dashboard
-    class ModelSpec
-      attr_accessor :default, :attributes, :index_page, :associated_models
-
-      SkippedAttributes = [
-        'id', 'created_at', 'updated_at',
-        'encrypted_password', 'reset_password_token',
-        'reset_password_sent_at', 'remember_created_at',
-        'sign_in_count', 'current_sign_in_at',
-        'last_sign_in_at', 'current_sign_in_ip',
-        'last_sign_in_ip'
-      ].freeze
-
-      def self.foreign_key? attribute
-        attribute =~ /_id$/
-      end
-
-      def foreign_key? attribute
-        ModelSpec.foreign_key? attribute
-      end
-
-      def self.polymorphic? model_class, attribute
-        return false unless foreign_key? attribute
-        model_class.column_names.include? "#{attribute.to_s.gsub('_id', '')}_type"
-      end
-
-      def polymorphic? model_class, attribute
-        ModelSpec.polymorphic? model_class, attribute
-      end
-
-      def initialize model_class = nil
-        @default = false
-        @attributes = ExtendedHash.new
-        @index_page = ExtendedHash.new
-        @index_page[:shows] = ExtendedHash.new
-        @index_page[:searches] = ExtendedHash.new
-        @associated_models = {}
-        if model_class
-          @attributes[:permitted] = model_class.column_names - SkippedAttributes
-          @attributes[:permitted].each do |attribute|
-            @index_page[:shows][:attributes] ||= []
-            @index_page[:searches][:attributes] ||= []
-            if foreign_key? attribute
-              associated_model = attribute.gsub('_id', '')
-              @associated_models[associated_model] = {
-                choose_by: nil, # Wait for setting.
-                polymorphic: polymorphic?(model_class, attribute),
-                model: model_class.name.underscore.to_sym
-              }
-            else
-              @index_page[:shows][:attributes] << attribute
-              @index_page[:searches][:attributes] << { name: attribute.to_sym, term: :cont }
-            end
-          end
-        end
-      end
-
-      def changed? spec
-        not @attributes[:permitted] == spec.attributes[:permitted] or
-        not @index_page[:searches][:attributes] == spec.index_page[:searches][:attributes]
-      end
-
-      def revise_stage_1!
-        # Handle polymorphic associated models if necessary.
-        @associated_models.each do |associated_model, options|
-          next if not options or not options[:polymorphic]
-          ActiveRecord::Base.descendants.each do |model|
-            next if model.name == 'ApplicationRecord'
-            if not model.reflect_on_all_associations.map(&:name).select { |x| x.to_s =~ /\b(#{options[:model]}|#{options[:model].to_s.pluralize})\b/ }.empty?
-              options[:available_models] ||= []
-              options[:available_models] << model.name.underscore
-              if not options[:common_attributes]
-                options[:common_attributes] = model.column_names - SkippedAttributes
-              else
-                options[:common_attributes] = options[:common_attributes] & model.column_names
-              end
-            end
-          end
-        end
-      end
-
-      def revise_stage_2!
-        # Handle associated models if necessary.
-        @associated_models.each do |associated_model, options|
-          next if not options
-          if options[:polymorphic]
-            # There should be a <associated_model>_type already.
-            @index_page[:shows][:attributes] << "#{associated_model}.#{options[:choose_by]}"
-            @index_page[:searches][:attributes].each do |attribute|
-              next unless attribute[:name] == :"#{associated_model}_type"
-              attribute[:options] = options[:available_models]
-            end
-          else
-            @index_page[:searches][:attributes] << {
-              name: "#{associated_model}.#{options[:choose_by]}",
-              term: :cont
-            }
-          end
-        end
-      end
-    end
-
     class << self
       def model name, &block
         name = name.to_sym
         if block_given?
           @@models ||= {}
           spec = @@models[name] || ModelSpec.new
+          spec.name = name
           yield spec
           @@models[name] = spec
         else
@@ -118,12 +18,9 @@ module Carload
         model_a = options.keys.first
         model_b = options.values.first
         options.shift
+        options[:name] = model_b
         @@models[model_a] ||= ModelSpec.new
         @@models[model_a].associated_models[model_b] = options
-        unless options[:polymorphic]
-          @@models[model_b] ||= ModelSpec.new
-          @@models[model_b].associated_models[model_a] = nil
-        end
       end
 
       def models
@@ -153,10 +50,10 @@ module Carload
           RUBY
           default = false
           next if spec.associated_models.empty?
-          spec.associated_models.each do |associated_model, options|
-            next if not options.class == Hash or not options[:choose_by]
+          spec.associated_models.each_value do |associated_model|
+            next unless associated_model[:choose_by]
             content << <<-RUBY
-  associate(#{{ name.to_sym => associated_model.to_sym }.merge options})
+  associate(#{{ name.to_sym => associated_model[:name], choose_by: associated_model[:choose_by].to_sym }})
             RUBY
           end
         end

data/lib/carload/engine.rb

@@ -8,5 +8,54 @@ module Carload
         require_dependency file
       end
     end
+
+    config.after_initialize do
+      # Fill up associations of models.
+      Dashboard.models.each do |name, spec|
+        spec.klass = name.to_s.camelize.constantize
+        spec.klass.reflect_on_all_associations.each do |association|
+          spec.handle_association association, rescue: true
+        end
+      end
+      # Reopen model classes to add pg text search.
+      Dictionaries = {
+        en: 'english',
+        :'zh-CN' => 'zhparser'
+      }.freeze
+      Dashboard.models.each do |name, spec|
+        # NOTE: Only direct columns are included.
+        attributes = spec.index_page.searches.attributes.select { |x| x[:name].class == Symbol }.map { |x| x[:name] }
+        spec.klass.class_eval do
+          include PgSearch
+          pg_search_scope :search,
+            against: attributes,
+            using: {
+              tsearch: {
+                prefix: true,
+                negation: true,
+                dictionary: Dictionaries[I18n.locale]
+              }
+            }
+        end
+      end
+      # Reopen model classes to handle polymorphic association.
+      Dashboard.models.each do |name, spec|
+        spec.associated_models.values.select { |x| x[:polymorphic] == true }.each do |associated_model|
+          polymorphic_objects = []
+          associated_model[:instance_models].each do |instance_model|
+            Dashboard.model(instance_model).klass.all.each do |object|
+              polymorphic_objects << ["#{object.class} - #{object.send(associated_model[:choose_by])}", "#{object.id},#{object.class}"]
+            end
+          end
+          spec.klass.class_eval do
+            class_eval <<-RUBY
+              def self.#{associated_model[:name].to_s.pluralize}
+                #{polymorphic_objects}
+              end
+            RUBY
+          end
+        end
+      end
+    end
   end
 end

data/lib/carload/model_spec.rb

@@ -0,0 +1,98 @@
+module Carload
+  class ModelSpec
+    include AssociationPipelines
+
+    attr_accessor :name, :klass, :default, :attributes, :index_page, :associated_models
+
+    SkippedAttributes = [
+      'id', 'created_at', 'updated_at',
+      'encrypted_password', 'reset_password_token',
+      'reset_password_sent_at', 'remember_created_at',
+      'sign_in_count', 'current_sign_in_at',
+      'last_sign_in_at', 'current_sign_in_ip',
+      'last_sign_in_ip'
+    ].freeze
+
+    AssociationTypes = {
+      ActiveRecord::Reflection::BelongsToReflection => :belongs_to,
+      ActiveRecord::Reflection::HasOneReflection => :has_one,
+      ActiveRecord::Reflection::HasManyReflection => :has_many,
+      ActiveRecord::Reflection::ThroughReflection => :through
+    }
+
+    def initialize model_class = nil
+      @default = false
+      @attributes = ExtendedHash.new
+      @index_page = ExtendedHash.new
+      @index_page[:shows] = ExtendedHash.new
+      @index_page[:shows][:attributes] ||= []
+      @index_page[:searches] = ExtendedHash.new
+      @index_page[:searches][:attributes] ||= []
+      @associated_models = {}
+      if model_class
+        @name = model_class.name.underscore
+        @klass = model_class
+        @attributes[:permitted] = (model_class.column_names - SkippedAttributes).map(&:to_sym)
+        # Handle model associations.
+        model_class.reflect_on_all_associations.each do |association|
+          handle_association association
+        end
+        @attributes[:permitted].each do |attribute|
+          next if attribute.class == Hash
+          @index_page[:shows][:attributes] << attribute
+          @index_page[:searches][:attributes] << { name: attribute.to_sym, term: :cont }
+        end
+      end
+    end
+
+    def changed? spec
+      not @default == spec.default or
+      not @attributes[:permitted] == spec.attributes[:permitted] or
+      not @index_page[:shows][:attributes] == spec.index_page[:shows][:attributes] or
+      not @index_page[:searches][:attributes] == spec.index_page[:searches][:attributes]
+    end
+
+    def revise!
+      # Handle associated models if necessary.
+      @associated_models.each_value do |associated_model|
+        next unless associated_model[:choose_by]
+        if associated_model[:association_type] == :has_many
+          show_name = [:pluck, associated_model[:name].to_s.pluralize.to_sym, associated_model[:choose_by]]
+        else
+          show_name = "#{associated_model[:name]}.#{associated_model[:choose_by]}"
+        end
+        @index_page[:shows][:attributes].delete_if { |x| x == :"#{associated_model[:name]}_id" }
+        @index_page[:shows][:attributes] << show_name
+      end
+    end
+
+    def handle_association association, options = {}
+      begin
+        _association = (association.delegate_reflection rescue nil) || association
+        name = (_association.klass.name.underscore.to_sym rescue nil) || _association.name
+        association_type = AssociationTypes[_association.class]
+        polymorphic = association.options[:polymorphic] || association.options[:as]
+        foreign_key =  @klass.column_names.include?("#{(_association.klass.name.underscore rescue nil) || _association.name}_id")
+        join_table = association.options[:through].to_s.singularize.to_sym if association.options[:through]
+        @associated_models[name] = {
+          name: name,
+          association_type: association_type,
+          polymorphic: polymorphic,
+          foreign_key: foreign_key,
+          join_table: join_table,
+          choose_by: nil
+        }.merge @associated_models[name] || {}
+        association_pipelines.each { |pipeline| send pipeline, association }
+        # Delete join-table model!
+        if association.options[:through]
+          @associated_models.delete association.options[:through]
+          @associated_models.delete association.options[:through].to_s.singularize.to_sym
+        end
+      rescue => e
+        raise e unless options[:rescue]
+        raise e if not e&.original_exception&.class == PG::UndefinedTable and
+                   not e.class == ActiveRecord::NoDatabaseError
+      end
+    end
+  end
+end

data/lib/carload/version.rb

@@ -1,3 +1,3 @@
 module Carload
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/carload.rb

@@ -4,13 +4,17 @@ Gem.loaded_specs['carload'].dependencies.each do |dependency|
 end
 
 require 'carload/extended_hash'
+require 'carload/association_pipelines'
+require 'carload/model_spec'
 require 'carload/dashboard'
 require 'carload/engine'
 require 'carload/exceptions'
 
 module Carload
   def self.setup &block
+    # Read in configuration.
     @@config = ExtendedHash.new
+    @@config[:page] = ExtendedHash.new
     @@config[:dashboard] = ExtendedHash.new
     @@config[:dashboard][:permits_user] = ExtendedHash.new
     yield @@config
@@ -20,7 +24,7 @@ module Carload
     if not [:carrierwave].include? @@config[:upload_solution]
       raise UnsupportedError.new("upload solution #{@@config[:upload_solution]}")
     end
-
+    # Define configuation helpers.
     @@config.each do |key, value|
       define_singleton_method key do
         value

data/lib/generators/carload/dash_generator.rb

@@ -8,34 +8,35 @@ module Carload
       model_specs = {}
       Rails.application.eager_load! # It is necessary to load models manually.
       ActiveRecord::Base.descendants.each do |model| # Rails 5 can use ApplicationRecord.
-        next if model.name == 'ApplicationRecord'
+        next if model.name == 'ApplicationRecord' or model.name == 'PgSearch::Document'
         name = model.name.underscore
-        model_specs[name] = Dashboard::ModelSpec.new model
+        model_specs[name] = ModelSpec.new model
       end
       spec = model_specs[model]
       if not spec.associated_models.empty?
-        spec.revise_stage_1!
         cli = HighLine.new
-        cli.say "\nModel #{model} has associated with other models."
-        spec.associated_models.each do |associated_model, options|
-          spec.associated_models[associated_model][:choose_by] = cli.choose do |menu|
-            menu.prompt = "Choose the attribute of model #{associated_model} for choosing in #{model}? "
-            attributes = options[:polymorphic] ? options[:common_attributes] : model_specs[associated_model].attributes.permitted
-            attributes.each do |attribute|
-              next if attribute =~ /_id$/
-              menu.choice attribute.to_sym
+        spec.associated_models.each_value do |associated_model|
+          next if associated_model[:attributes].empty?
+          if associated_model[:polymorphic]
+            attributes = associated_model[:attributes]
+          else
+            attributes = model_specs[associated_model[:name].to_s].attributes.permitted.select { |x| x.class != Hash }
+          end
+          if attributes.size == 1
+            associated_model[:choose_by] = attributes.first
+          else
+            associated_model[:choose_by] = cli.choose do |menu|
+              menu.prompt = "Choose the attribute of model #{associated_model[:name]} for choosing in #{model}? "
+              attributes.each do |attribute|
+                next if attribute.to_s =~ /_id$/
+                menu.choice attribute
+              end
             end
           end
         end
-        spec.revise_stage_2!
+        spec.revise!
       end
       # Check if model exists in dashboard file, but it may be changed.
-      begin
-        load 'app/carload/dashboard.rb'
-      rescue LoadError
-        Dashboard.models[model.to_sym] = spec
-        Dashboard.write 'app/carload/dashboard.rb'
-      end
       if not Dashboard.models.keys.include? model.to_sym or Dashboard.model(model).changed? spec
         Dashboard.models[model.to_sym] = spec
         Dashboard.write 'app/carload/dashboard.rb'

data/lib/generators/carload/install_generator.rb

@@ -26,5 +26,15 @@ require 'carload'
     def copy_dashboard_file
       copy_file 'dashboard.rb', 'app/carload/dashboard.rb'
     end
+
+    def copy_migration_files
+      # Copy migrations if necessary.
+      case I18n.locale
+      when :'zh-CN'
+        ['20161030074822_carload_enable_zhparser_extension.rb'].each do |file|
+          copy_file "#{Carload::Engine.root}/db/migrate/#{file}", "db/migrate/#{file}"
+        end
+      end
+    end
   end
 end

data/lib/generators/carload/templates/carload.rb

@@ -1,8 +1,20 @@
 Carload.setup do |config|
-  # Specify which authentication solution is used. Currently, we only support Devise.
+  # Set the title that will be displayed on the browser tab area.
+  config.page.title = nil
+
+  # Set the footer text that will be displayed on each page.
+  config.page.footer = nil
+
+  # Set the colors of page elements.
+  config.page.main_color = nil
+  config.page.text_color = 'black'
+  config.page.button_color = nil
+  config.page.button_text_color = nil
+
+  # Set which authentication solution is used. Currently, we only support Devise.
   config.auth_solution = :devise
 
-  # Specify which file upload solution is used. Currently, we only support Carrierwave.
+  # Set which file upload solution is used. Currently, we only support Carrierwave.
   config.upload_solution = :carrierwave
 
   # Set the actions used to discern user's permission to access dashboard.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carload
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Li Dong
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-05 00:00:00.000000000 Z
+date: 2016-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -129,19 +129,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
-  name: ransack
+  name: pg_search
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: kaminari
   requirement: !ruby/object:Gem::Requirement
@@ -227,7 +227,7 @@ files:
 - app/assets/javascripts/carload/dashboard.js
 - app/assets/stylesheets/carload/_select2.scss
 - app/assets/stylesheets/carload/application.scss
-- app/assets/stylesheets/carload/colors.scss
+- app/assets/stylesheets/carload/colors.scss.erb
 - app/assets/stylesheets/carload/common.scss
 - app/assets/stylesheets/carload/dashboard.scss
 - app/assets/stylesheets/carload/error.scss
@@ -264,11 +264,14 @@ files:
 - config/locales/simple_form.en.yml
 - config/locales/zh-CN.yml
 - config/routes.rb
+- db/migrate/20161030074822_carload_enable_zhparser_extension.rb
 - lib/carload.rb
+- lib/carload/association_pipelines.rb
 - lib/carload/dashboard.rb
 - lib/carload/engine.rb
 - lib/carload/exceptions.rb
 - lib/carload/extended_hash.rb
+- lib/carload/model_spec.rb
 - lib/carload/version.rb
 - lib/generators/carload/USAGE
 - lib/generators/carload/dash_generator.rb

data/app/assets/stylesheets/carload/colors.scss

@@ -1,2 +0,0 @@
-$main-color: #8C7DA6;
-$text-color: #3F3F44;