dynamic_scaffold 0.8.5 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee8bcbe45496d6f41503b4e9ea97197176366b5c57c359be10f48972184df97d
-  data.tar.gz: 678ba1879ca352131a1c4320e1d9139e8463b8bd25d316222d8e507490d0ae0e
+  metadata.gz: 0b9f66a15ba06068661f6bfe62b02db517fbab32f368036939704b54b2ceec8e
+  data.tar.gz: f9263e830b2d891eef486565407e89106d0c4afec3d07e6781a6f0b7bf4bd63a
 SHA512:
-  metadata.gz: 76e6c4845be245930504f2322121cf03351a79a96b03a4a07526afa0164dd8c4531bd1b0aa3506b664a470c78f4e32d4b521186e1b91c0ff7e047cec12e6dd18
-  data.tar.gz: d93e3fff877d7facf41b1bfa9f835ba2ce85523d35963df34a537a90ad5f387ed40f113f675ba23e5ab7108ced59373b7ec0c74c3b6fc6f59f42d4062fdf97fb
+  metadata.gz: 942fcfb0203d16dc3f549d313eff8fd0e1c0b925155ea33ae1c021c2df16e9f302ada3630e8ba87c1a7a4e5e0b1631edeb812d66d3046f7405426ada1ace2c23
+  data.tar.gz: 808f74e475722ae05ae0515a7cdf3b53049adc520cd97cca8bf9f2a8be7eda2c4e63423d93d0b88f7ba5d227089e894d6126192f1afebfb383ad0ba8f808b91d

data/README.md

@@ -8,6 +8,7 @@ The Scaffold system which dynamically generates CRUD and sort functions.
 * Support sort and pagination.
 * Support image upload with preview.
 * Support image crop.
+* Support [globalize](https://github.com/globalize/globalize) form fields.
 * This has the views with the Twitter Bootstrap. Support bootstrap3/4.
 * Customizable and flexible.
 
@@ -235,19 +236,6 @@ class ShopController < ApplicationController
     config.form.item(:collection_check_boxes, :state_ids, State.all, :id, :name)
     config.form.item(:collection_radio_buttons, :status, Shop.statuses.map{|k, _v| [k, k.titleize]}, :first, :last)
 
-    # You can add an image uploader with preview to the form. The save and remove part to the model corresponds to [carrierwave](https://github.com/carrierwaveuploader/carrierwave).
-    # In the example below, you need to mount the carrierwave uploader on the thumb column of the model.
-    #
-    # class Shop < ApplicationRecord
-    #   mount_uploader :thumb, ShopThumbUploader
-    #
-    config.form.item(
-      :carrierwave_image,
-      :thumb,
-      preview_max_size: {width: '300px', height: '300px'},
-      removable: false #　If you want to require image, please set removable to false. the default is true.
-    )
-
     # If you want to display more free form field, use block.
     # The block is executed in the context of view, so you can call the method of view.
     config.form.item :block, :free do |form, field|
@@ -292,7 +280,54 @@ class ShopController < ApplicationController
 end
 ```
 
-`carrierwave_image` supports [cropper](https://github.com/fengyuanchen/cropperjs). For details, please read [Crop the image](https://github.com/gomo/dynamic_scaffold/wiki/Crop-the-image).
+##### carrierwave_image
+
+You can add an image uploader with preview to the form. It uses [carrierwave](https://github.com/carrierwaveuploader/carrierwave) to save images and associate with records.
+
+For example, you mount the carrierwave uploader on the `thumb` column of Shop model.
+
+```rb
+class Shop < ApplicationRecord
+  mount_uploader :thumb, ShopThumbUploader
+```
+
+The controller code is as follows.
+
+```rb
+class ShopController < ApplicationController
+  include DynamicScaffold::Controller
+  dynamic_scaffold Shop do |config|
+...
+    config.form.item(
+      :carrierwave_image,
+      :thumb,
+      preview_max_size: {width: '300px', height: '300px'},
+      removable: false #　If you want to require image, please set removable to false. the default is true.
+    )
+```
+
+The `carrierwave_image` supports [cropper](https://github.com/fengyuanchen/cropperjs) too. For details, please read [Crop the image](https://github.com/gomo/dynamic_scaffold/wiki/Crop-the-image).
+
+
+##### globalize_fields
+
+We support [globalize](https://github.com/globalize/globalize). Below is the controller code.
+
+```rb
+class ShopController < ApplicationController
+  include DynamicScaffold::Controller
+  dynamic_scaffold Shop do |config|
+...
+    c.form
+      # Each language input field specified in the second argument will generate.
+      .item(:globalize_fields, { en: 'English', ja: 'Japanese' }, style: 'width: 78px;')
+      # You can specify the type of element to generate to `for` method. it support `:text_field` or `:text_area` for type.
+      # Specify the attribute name in the second argument of the `for` method.
+      .for(:text_field, :keyword)
+```
+
+Setting the model for globalize_fields with validates is [here](https://github.com/gomo/dynamic_scaffold/wiki/Model-setting-for-globalize).
+
 
 ### Sorting
 
@@ -411,6 +446,17 @@ class UsersController < ApplicationController
     ...
 ```
 
+By default, the value can not update to a value other than the value specified in the scope( or parameter). This behavior can change with `changeable` option.
+
+```rb
+# app/controllers/users_controller.rb
+class UsersController < ApplicationController
+  include DynamicScaffold::Controller
+  dynamic_scaffold User do |c|
+    c.scope([:role], changeable: true)
+    ...
+```
+
 #### Limit count
 
 You can specify the maximum count of registrations.

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

@@ -132,4 +132,36 @@
 // Fixed a problem that font-awesome icon and text link do not match in height.
 .page-link{
   line-height: 1.6;
+}
+
+
+.ds-globalize-group{
+  margin-bottom: 7px;
+  display: flex;
+  .ds-globalize-lang{
+    display: flex;
+    font-size: 12px;
+    color: #495057;
+    text-align: center;
+    white-space: nowrap;
+    background-color: #e9ecef;
+    border: 1px solid #ced4da;
+    border-radius: .25rem;
+    border-top-right-radius: 0;
+    border-bottom-right-radius: 0;
+    border-right: none;
+    justify-content: center;
+    align-items: center;
+  }
+
+  &.has-error{
+    .ds-globalize-lang{
+      border-color: #a94442;
+    }
+  }
+
+  .form-control{
+    border-top-left-radius: 0;
+    border-bottom-left-radius: 0;
+  }
 }

data/app/helpers/dynamic_scaffold_helper.rb

@@ -0,0 +1,14 @@
+module DynamicScaffoldHelper
+  def render_form_errors(errors)
+    return '' if errors.blank?
+    tag.ul(class: 'list-unstyled ds-error-message') do
+      errors.each do |message|
+        concat tag.li("#{dynamic_scaffold_icon :error} #{message}".html_safe) # rubocop:disable Rails/OutputSafety
+      end
+    end
+  end
+
+  def dynamic_scaffold_icon(name)
+    instance_exec name, &::Rails.application.config.dynamic_scaffold.icons
+  end
+end

data/app/views/dynamic_scaffold/bootstrap/_form.html.erb

@@ -56,6 +56,19 @@
                 <%end%>
                 <%= form.hidden_field "#{elem.name}_cache" %>
               </div>
+            <% elsif elem.type? :globalize_fields %>
+              <% elem.locales.each do |locale, name| %>
+                <%- locale_errors = elem.locale_errors(locale, @record) -%>
+                <%= form.globalize_fields_for(locale) do |gform|%>
+                  <div class="<%= class_names('ds-globalize-group', 'has-error': locale_errors.present?) %>">
+                    <%= tag.span(elem.lang_attributes('ds-globalize-lang')) do%>
+                      <%= name %>
+                    <%end%>
+                    <%= elem.render(self, gform, class_names('form-control', {'is-invalid': locale_errors.present?})) %>
+                  </div>
+                  <%= render_form_errors(locale_errors) -%>
+                <%end%>
+              <% end %>
             <% else %>
               <%= elem.render(self, form, class_names('form-control', {'is-invalid': errors.present?})) %>
             <% end %>
@@ -63,13 +76,7 @@
               <%= self.instance_exec(@record, &block) %>
             <%-end-%>
           </div>
-          <%- if errors.present? -%>
-            <ul class="list-unstyled ds-error-message">
-              <% errors.each do |err|%>
-              <li><%= dynamic_scaffold_icon :error %> <%= err %></li>
-              <%end%>
-            </ul>
-          <%- end -%>
+          <%= render_form_errors(errors) -%>
           <%if elem.notes?%>
             <div class="form-text text-muted"><%= elem.render_notes(form.object, self) %></div>
           <%end%>

data/lib/dynamic_scaffold/config.rb

@@ -119,7 +119,16 @@ module DynamicScaffold
   end
 
   class Config
-    attr_reader :model, :form, :list, :title, :controller, :lock_before_count, :max_count_options
+    attr_reader(
+      :model,
+      :form,
+      :list,
+      :title,
+      :controller,
+      :lock_before_count,
+      :max_count_options,
+      :scope_options
+    )
     def initialize(model, controller)
       @model = model
       @controller = controller
@@ -139,8 +148,11 @@ module DynamicScaffold
       end
     end
 
-    def scope(scopes = nil)
-      @scope = scopes unless scopes.nil?
+    def scope(*args)
+      if args.present?
+        @scope_options = args.extract_options!
+        @scope = args[0]
+      end
       @scope
     end
 
@@ -274,40 +286,8 @@ module DynamicScaffold
       end
     end
 
-    def item(type, *args, &block) # rubocop:disable Metrics/MethodLength
-      case type
-      when
-        :check_box,
-        :radio_button,
-        :text_area,
-        :text_field,
-        :password_field,
-        :hidden_field,
-        :file_field,
-        :color_field,
-        :number_field,
-        :telephone_field then
-        item = Form::Item::SingleOption.new(@config, type, *args)
-      when
-        :time_select,
-        :date_select,
-        :datetime_select,
-        :collection_select,
-        :grouped_collection_select then
-        item = Form::Item::TwoOptions.new(@config, type, *args)
-      when
-        :collection_check_boxes,
-        :collection_radio_buttons then
-        item = Form::Item::TwoOptionsWithBlock.new(@config, type, *args)
-      when
-        :block then
-        item = Form::Item::Block.new(@config, type, *args, block)
-      when
-        :carrierwave_image then
-        item = Form::Item::CarrierWaveImage.new(@config, type, *args)
-      else
-        raise DynamicScaffold::Error::InvalidParameter, "Unknown form item type #{type}"
-      end
+    def item(type, *args, &block)
+      item = Form::Item::Base.create(@config, type, *args, &block)
       @items << item
       item
     end

data/lib/dynamic_scaffold/controller.rb

@@ -4,7 +4,8 @@ module DynamicScaffold
     include ControllerUtilities
 
     included do
-      helper_method :dynamic_scaffold_path, :dynamic_scaffold_icon, :dynamic_scaffold, :primary_key_value, :request_queries
+      helper_method :dynamic_scaffold_path, :dynamic_scaffold, :request_queries
+      helper DynamicScaffoldHelper
       attr_reader :dynamic_scaffold
       before_action lambda {
         @dynamic_scaffold = Config.new(self.class.dynamic_scaffold_model, self)

data/lib/dynamic_scaffold/controller_utilities.rb

@@ -42,10 +42,14 @@ module DynamicScaffold
       # Get paramters for update record.
       def update_values # rubocop:disable Metrics/AbcSize
         # set the parameters of carrierwave_image at the end for validates.
-        permitting = dynamic_scaffold.form.items.map {|f| f.strong_parameter unless f.type?(:carrierwave_image) }.compact
+        permitting = []
+        dynamic_scaffold.form.items.reject {|i| i.type?(:carrierwave_image) }.each do |item|
+          item.extract_parameters(permitting)
+        end
         permitting.concat(dynamic_scaffold.form.permit_params)
-        permitting.concat(dynamic_scaffold.form.items.map {|f| f.strong_parameter if f.type?(:carrierwave_image) }.compact)
-        permitting.flatten!
+        dynamic_scaffold.form.items.select {|i| i.type?(:carrierwave_image) }.each do |item|
+          item.extract_parameters(permitting)
+        end
 
         values = params
                    .require(dynamic_scaffold.model.name.underscore)
@@ -60,6 +64,7 @@ module DynamicScaffold
 
       # Check if there are inconsistent scopes in update parameters
       def valid_for_scope?(update_params)
+        return true if dynamic_scaffold.scope_options[:changeable]
         result = true
         scope_params.each do |key, value|
           if update_params.key?(key) && update_params[key] != value
@@ -110,14 +115,6 @@ module DynamicScaffold
         public_send("#{route.name}_path", options)
       end
 
-      def dynamic_scaffold_icon(name)
-        view_context.instance_exec name, &::Rails.application.config.dynamic_scaffold.icons
-      end
-
-      def primary_key_value(record)
-        [*record.class.primary_key].each_with_object({}) {|col, res| res[col] = record[col] }
-      end
-
       def bind_sorter_value(record)
         attr = dynamic_scaffold.list.sorter_attribute
         value = dynamic_scaffold.model.maximum(attr)

data/lib/dynamic_scaffold/form/item/base.rb

@@ -1,7 +1,52 @@
 module DynamicScaffold
   module Form
     module Item
-      class Base
+      class Base # rubocop:disable Metrics/ClassLength
+        ITEM_TYPES = {
+          check_box: Form::Item::SingleOption,
+          radio_button: Form::Item::SingleOption,
+          text_area: Form::Item::SingleOption,
+          text_field: Form::Item::SingleOption,
+          password_field: Form::Item::SingleOption,
+          hidden_field: Form::Item::SingleOption,
+          file_field: Form::Item::SingleOption,
+          color_field: Form::Item::SingleOption,
+          number_field: Form::Item::SingleOption,
+          telephone_field: Form::Item::SingleOption,
+
+          time_select: Form::Item::TwoOptions,
+          date_select: Form::Item::TwoOptions,
+          datetime_select: Form::Item::TwoOptions,
+          collection_select: Form::Item::TwoOptions,
+          grouped_collection_select: Form::Item::TwoOptions,
+
+          collection_check_boxes: Form::Item::TwoOptionsWithBlock,
+          collection_radio_buttons: Form::Item::TwoOptionsWithBlock,
+
+          block: Form::Item::Block,
+
+          carrierwave_image: Form::Item::CarrierWaveImage,
+
+          globalize_fields: Form::Item::GlobalizeFields
+        }.freeze
+
+        class << self
+          def create(config, type, *args, &block)
+            if ITEM_TYPES[type].nil?
+              raise(
+                DynamicScaffold::Error::InvalidParameter,
+                "Unknown form item type #{type}. supported: #{ITEM_TYPES.keys.join(', ')}"
+              )
+            end
+
+            if ITEM_TYPES[type] == Form::Item::Block
+              ITEM_TYPES[type].new(config, type, *args, block)
+            else
+              ITEM_TYPES[type].new(config, type, *args)
+            end
+          end
+        end
+
         attr_reader :name
         def initialize(config, type, name, html_attributes = {})
           @config = config
@@ -54,9 +99,12 @@ module DynamicScaffold
           end
         end
 
-        def strong_parameter
-          return { @name => [] } if @multiple
-          @name
+        def extract_parameters(permitting)
+          if @multiple
+            permitting << { @name => [] }
+          else
+            permitting << @name
+          end
         end
 
         def if(&block)

data/lib/dynamic_scaffold/form/item/carrier_wave_image.rb

@@ -30,13 +30,11 @@ module DynamicScaffold
           yield(html_attributes)
         end
 
-        def strong_parameter
-          params = []
+        def extract_parameters(permitting)
           # If you do not permit before the image body you can not use cropper value in uploader.
-          params << "cropper_#{@name}" unless cropper.nil?
-          params << "remove_#{@name}" if @options[:removable]
-          params.concat(["#{@name}_cache", @name])
-          params
+          permitting << "cropper_#{@name}" unless cropper.nil?
+          permitting << "remove_#{@name}" if @options[:removable]
+          permitting.concat(["#{@name}_cache", @name])
         end
       end
     end

data/lib/dynamic_scaffold/form/item/globalize_fields.rb

@@ -0,0 +1,40 @@
+module DynamicScaffold
+  module Form
+    module Item
+      class GlobalizeFields < Base
+        attr_reader :locales
+        delegate :proxy_field, :notes?, :render_notes, :render, to: :@item
+
+        def initialize(config, type, locales, options = {})
+          super(config, type, :translations_attributes, options)
+          @locales = locales
+        end
+
+        def for(type, *args, &block)
+          @item = Form::Item::Base.create(@config, type, *args, &block)
+        end
+
+        def strong_parameter
+          { translations_attributes: [:id, :locale, @item.name] }
+        end
+
+        def extract_parameters(permitting)
+          trans = permitting.find {|item| item.is_a?(Hash) && item.key?(:translations_attributes) }
+          if trans.nil?
+            permitting << { translations_attributes: [:id, :locale, @item.name] }
+          else
+            trans[:translations_attributes] << @item.name
+          end
+        end
+
+        def lang_attributes(classnames = nil)
+          build_html_attributes(classnames)
+        end
+
+        def locale_errors(locale, record)
+          record.errors.full_messages_for("#{@item.proxy_field.name}_#{locale}")
+        end
+      end
+    end
+  end
+end

data/lib/dynamic_scaffold/form_builder.rb

@@ -0,0 +1,64 @@
+module ActionView
+  module Helpers
+    class FormBuilder
+      #
+      # Helper that renders translations fields
+      # on a per-locale basis, so you can use them separately
+      # in the same form and still saving them all at once
+      # in the same request.
+      #
+      # Use it like this:
+      #
+      # <h1>Editing post</h1>
+      #
+      # <% form_for(@post) do |f| %>
+      #   <%= f.error_messages %>
+      #
+      #   <h2>English (default locale)</h2>
+      #   <p><%= f.text_field :title %></p>
+      #   <p><%= f.text_field :teaser %></p>
+      #   <p><%= f.text_field :body %></p>
+      #
+      #   <hr/>
+      #
+      #   <h2>Spanish translation</h2>
+      #   <% f.globalize_fields_for :es do |g| %>
+      #     <p><%= g.text_field :title %></p>
+      #     <p><%= g.text_field :teaser %></p>
+      #     <p><%= g.text_field :body %></p>
+      #   <% end %>
+      #
+      #   <hr/>
+      #
+      #   <h2>French translation</h2>
+      #   <% f.globalize_fields_for :fr do |g| %>
+      #     <p><%= g.text_field :title %></p>
+      #     <p><%= g.text_field :teaser %></p>
+      #     <p><%= g.text_field :body %></p>
+      #   <% end %>
+      #
+      # <% end %>
+      #
+      def globalize_fields_for(locale, *args, &proc)
+        raise ArgumentError, 'Missing block' unless block_given?
+        @locales ||= []
+
+        first = false
+        unless @locales.include?(locale)
+          @locales << locale
+          first = true
+        end
+        object_name = "#{@object_name}[translations_attributes][#{@locales.index(locale) + 1}]"
+        object = @object.translations.find_by locale: locale.to_s
+
+        # The following tags are added only once for the first time.
+        if first
+          @template.concat @template.hidden_field_tag("#{object_name}[id]", object ? object.id : '')
+          @template.concat @template.hidden_field_tag("#{object_name}[locale]", locale)
+        end
+
+        @template.fields_for(object_name, object, *args, &proc)
+      end
+    end
+  end
+end

data/lib/dynamic_scaffold/version.rb

@@ -1,3 +1,3 @@
 module DynamicScaffold
-  VERSION = '0.8.5'.freeze
+  VERSION = '0.9.0'.freeze
 end

data/lib/dynamic_scaffold.rb

@@ -4,6 +4,7 @@ require 'dynamic_scaffold/routes'
 require 'dynamic_scaffold/controller_utilities'
 require 'dynamic_scaffold/controller'
 require 'dynamic_scaffold/config'
+require 'dynamic_scaffold/form_builder'
 
 module DynamicScaffold
   module Error
@@ -25,6 +26,7 @@ module DynamicScaffold
       autoload :SingleOption,         'dynamic_scaffold/form/item/single_option'
       autoload :TwoOptionsWithBlock,  'dynamic_scaffold/form/item/two_options_with_block'
       autoload :TwoOptions,           'dynamic_scaffold/form/item/two_options'
+      autoload :GlobalizeFields, 'dynamic_scaffold/form/item/globalize_fields'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamic_scaffold
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.9.0
 platform: ruby
 authors:
 - Masamoto Miyata
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: classnames-rails-view
@@ -233,6 +233,7 @@ files:
 - app/assets/stylesheets/dynamic_scaffold/bootstrap4.scss
 - app/assets/stylesheets/dynamic_scaffold/common.scss
 - app/assets/stylesheets/dynamic_scaffold/resplist.scss
+- app/helpers/dynamic_scaffold_helper.rb
 - app/views/dynamic_scaffold/bootstrap/_edit.html.erb
 - app/views/dynamic_scaffold/bootstrap/_form.html.erb
 - app/views/dynamic_scaffold/bootstrap/_list.html.erb
@@ -261,9 +262,11 @@ files:
 - lib/dynamic_scaffold/form/item/base.rb
 - lib/dynamic_scaffold/form/item/block.rb
 - lib/dynamic_scaffold/form/item/carrier_wave_image.rb
+- lib/dynamic_scaffold/form/item/globalize_fields.rb
 - lib/dynamic_scaffold/form/item/single_option.rb
 - lib/dynamic_scaffold/form/item/two_options.rb
 - lib/dynamic_scaffold/form/item/two_options_with_block.rb
+- lib/dynamic_scaffold/form_builder.rb
 - lib/dynamic_scaffold/icons/fontawesome.rb
 - lib/dynamic_scaffold/list/item.rb
 - lib/dynamic_scaffold/routes.rb