dynamic_scaffold 0.1.0

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

@@ -0,0 +1,53 @@
+<%= form_with method: method, model: @record, url: url, local: true do |form| %>
+  <%dynamic_scaffold.form.items.each do |elem|%>
+    <% if elem.needs_rendering?(self)%>
+      <% if !elem.label? && elem.type?(:hidden_field) %>
+        <%= elem.render(self, form) %>
+      <% else %>
+        <div class="<%= classNames('form-group', {'has-error': @record.errors[elem.proxy_field.name].any?}) %>">
+          <label><%= elem.proxy_field.label %></label>
+          <div class="clearfix">
+            <% if elem.type? :collection_check_boxes %>
+              <%= elem.render(self, form) do |cb|%>
+                <div class="form-check checkbox">
+                  <%= cb.label class: 'form-check-label' do%>
+                    <%= cb.check_box class: 'form-check-input' %> <%= cb.text %> 
+                  <%end%>
+                </div>
+              <%end%>
+            <% elsif elem.type? :collection_radio_buttons %>
+              <%= elem.render(self, form) do |cb|%>
+                <div class="form-check radio">
+                  <%= cb.label class: 'form-check-label' do%>
+                    <%= cb.radio_button class: 'form-check-input' %> <%= cb.text %> 
+                  <%end%>
+                </div>
+              <%end%>
+            <% else %>
+              <%= elem.render(self, form, classNames('form-control', {'is-invalid': @record.errors[elem.proxy_field.name].any?})) %>
+            <% end %>
+          </div>
+          <%if @record.errors[elem.proxy_field.name].any?%>
+            <ul class="dynamicScaffold-error-message">
+              <%@record.errors.full_messages_for(elem.proxy_field.name).each do |err|%>
+              <li><%= dynamic_scaffold_icon :error %> <%= err %></li>
+              <%end%>
+            </ul>
+          <%end%>
+          <%if elem.notes?%>
+            <div class="form-text text-muted"><%= elem.render_notes(form.object, self) %></div>
+          <%end%>
+        </div>
+      <% end %>
+    <% end %>
+  <% end %>
+  <div>
+    <% path_options = dynamic_scaffold.list.pagination ? {dynamic_scaffold.list.pagination.param_name => params[:page]} : {}%>
+    <%= link_to dynamic_scaffold_path(:index, path_options), class: 'btn btn-outline-secondary btn-default' do%>
+      <%= dynamic_scaffold_icon :back %> <%= t('dynamic_scaffold.button.back') %>
+    <%end%>
+    <button type="submit" class="btn btn-outline-warning btn-warning">
+      <%= dynamic_scaffold_icon :save %> <%= t('dynamic_scaffold.button.save') %>
+    </a>
+  </div>
+<% end %>

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

@@ -0,0 +1,88 @@
+<%unless flash[:dynamic_scaffold_danger].nil? -%>
+  <div class="alert alert-danger" role="alert">
+    <%= flash[:dynamic_scaffold_danger] %>
+  </div>
+<%end%>
+<input type="hidden" class="authenticity_param_name" value="<%= request_forgery_protection_token %>">
+<%= form_with method: :patch, url: dynamic_scaffold_path(:sort) do%>
+<div class="dynamicScaffold-row">
+  <%= link_to dynamic_scaffold_path(:new), class: 'btn btn-outline-primary btn-primary btn-sm' do%>
+    <%= dynamic_scaffold_icon(:add) %> <%= t('dynamic_scaffold.button.add') %>
+  <%end%>
+</div>
+<%= render 'dynamic_scaffold/bootstrap/pagination' %>
+<div class="dynamicScaffold-row">
+  <%= render 'dynamic_scaffold/bootstrap/save_order'%>
+</div>
+<div class="dynamicScaffold-row">
+  <% if @records.empty? %>
+    <p class="lead"><%= t('dynamic_scaffold.message.no_records', model: dynamic_scaffold.title.name) %></p>
+  <% else %>
+    <ul
+      class="resplist resplist-striped dynamicScaffoldJs-item-wrapper"
+      data-confirm-ok="<%= t('dynamic_scaffold.message.confirm_ok') %>"
+      data-confirm-ok-class="btn btn-danger btn-sm"
+      data-confirm-cancel="<%= t('dynamic_scaffold.message.confirm_cancel') %>"
+      data-confirm-cancel-class="btn btn-outline-secondary btn-default btn-sm"
+    >
+      <%@records.each do |record|%>
+        <li class="resplist-row dynamicScaffoldJs-item-row">
+          <% if dynamic_scaffold.list.title? %>
+            <div class="resplist-heading"><%= dynamic_scaffold.list.title(record) %></div>
+          <% end %>
+          <div class="resplist-items">
+          <%dynamic_scaffold.list.items.each do |disp|%>
+            <%= content_tag :div, class: classNames('resplist-item', disp.classnames), **disp.html_attributes do%>
+              <div class="resplist-label"><%= disp.label %></div>
+              <div class="resplist-value"><%= disp.value self, record %></div>
+            <%end%>
+          <%end%>
+          </div>
+          <div class="resplist-footer clearfix">
+            <div class="float-right pull-right">
+              <div class="btn-group">
+                <% page_param_name = dynamic_scaffold.list.pagination ? dynamic_scaffold.list.pagination.param_name : nil %>
+                <%= link_to dynamic_scaffold_path(:edit, id: record[record.class.primary_key], page: params[page_param_name]), class: 'btn btn-primary btn-outline-primary btn-sm' do %>
+                  <%= dynamic_scaffold_icon(:edit) %> <%= t('dynamic_scaffold.button.edit') %>
+                <%end%>
+              </div>
+              <% if dynamic_scaffold.list.sorter %>
+              <%[*dynamic_scaffold.model.primary_key].each do |pkey|%>
+                <input type="hidden" name="pkeys[][<%=pkey%>]" value="<%= record[pkey] %>">
+              <%end%>
+              <div class="btn-group">
+                <button class="btn btn-outline-secondary btn-default btn-sm dynamicScaffoldJs-sorter-top">
+                  <%= dynamic_scaffold_icon(:top) %>
+                </button>
+                <button class="btn btn-outline-secondary btn-default btn-sm dynamicScaffoldJs-sorter-up">
+                  <%= dynamic_scaffold_icon(:up) %>
+                </button>
+                <button class="btn btn-outline-secondary btn-default btn-sm dynamicScaffoldJs-sorter-down">
+                  <%= dynamic_scaffold_icon(:down) %>
+                </button>
+                <button class="btn btn-outline-secondary btn-default btn-sm dynamicScaffoldJs-sorter-bottom">
+                  <%= dynamic_scaffold_icon(:bottom) %>
+                </button>
+              </div>
+              <% end %>
+              <div class="btn-group">
+                <button
+                  data-action="<%= dynamic_scaffold_path(:update, id: record[record.class.primary_key]) %>"
+                  data-confirm-message="<%= t('dynamic_scaffold.message.destroy_confirm') %>"
+                  class="btn btn-danger btn-sm dynamicScaffoldJs-destory"
+                >
+                  <%= dynamic_scaffold_icon(:delete) %>
+                </button>
+              </div>
+            </div>
+          </div>
+        </li>
+      <%end%>
+    </ul>
+  <% end %>
+</div>
+<div class="dynamicScaffold-row">
+  <%= render 'dynamic_scaffold/bootstrap/save_order'%>
+</div>
+<%= render 'dynamic_scaffold/bootstrap/pagination' %>
+<% end %>

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

@@ -0,0 +1 @@
+<%= render 'dynamic_scaffold/bootstrap/form', method: :post, url: dynamic_scaffold_path(:index) %>

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

@@ -0,0 +1,5 @@
+<%if dynamic_scaffold.list.pagination %>
+  <div class="dynamicScaffold-row">
+    <%= paginate @records, {views_prefix: 'dynamic_scaffold/bootstrap'}.merge(dynamic_scaffold.list.pagination.kaminari_options) %>
+  </div>
+<%end%>

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

@@ -0,0 +1,7 @@
+<% if dynamic_scaffold.list.sorter %>
+<div class="text-right">
+  <button type="submit" name="submit_sort" class="btn btn-outline-warning btn-warning btn-sm">
+    <%= dynamic_scaffold_icon :save %> <%= t('dynamic_scaffold.button.save_order') %>
+  </button>
+</div>
+<% end %>

data/app/views/dynamic_scaffold/bootstrap/kaminari/_first_page.html.erb

@@ -0,0 +1,7 @@
+<li class="<%= classNames 'page-item first', disabled: current_page.first? %>">
+  <%if current_page.first?%>
+    <span class="page-link"><%= dynamic_scaffold_icon(:first) %></span>
+  <%else%>
+    <%= link_to dynamic_scaffold_icon(:first), url, remote: remote, class: 'page-link' %>
+  <%end%>
+</li>

data/app/views/dynamic_scaffold/bootstrap/kaminari/_gap.html.erb

@@ -0,0 +1,3 @@
+<li class='page-item disabled gap dynamicScaffoldJs-page-item'>
+  <%= link_to raw(t 'views.pagination.truncate'), '#', class: 'page-link' %>
+</li>

data/app/views/dynamic_scaffold/bootstrap/kaminari/_last_page.html.erb

@@ -0,0 +1,7 @@
+<li class="<%= classNames 'page-item last', disabled: current_page.last? %>">
+  <%if current_page.last?%>
+    <span class="page-link"><%= dynamic_scaffold_icon(:last) %></span>
+  <%else%>
+    <%= link_to dynamic_scaffold_icon(:last), url, remote: remote, class: 'page-link' %>
+  <%end%>
+</li>

data/app/views/dynamic_scaffold/bootstrap/kaminari/_next_page.html.erb

@@ -0,0 +1,7 @@
+<li class="<%= classNames 'page-item next', disabled: current_page.last? %>">
+  <%if current_page.last?%>
+    <span class="page-link"><%= dynamic_scaffold_icon(:next) %></span>
+  <%else%>
+    <%= link_to dynamic_scaffold_icon(:next), url, remote: remote, class: 'page-link' %>
+  <%end%>
+</li>

data/app/views/dynamic_scaffold/bootstrap/kaminari/_page.html.erb

@@ -0,0 +1,9 @@
+<% if page.current? %>
+  <li class="<%= classNames 'page-item current dynamicScaffoldJs-page-item', {'active': dynamic_scaffold.list.pagination.highlight_current} %>">
+    <%= content_tag :a, dynamic_scaffold.list.pagination.page_number(page, @records), remote: remote, rel: (page.next? ? 'next' : (page.prev? ? 'prev' : nil)), class: 'page-link' %>
+  </li>
+<% else %>
+  <li class="<%= classNames('page-item dynamicScaffoldJs-page-item', dynamic_scaffold.list.pagination.page_class(page, @records)) %>">
+    <%= link_to page, url, remote: remote, rel: (page.next? ? 'next' : (page.prev? ? 'prev' : nil)), class: 'page-link' %>
+  </li>
+<% end %>

data/app/views/dynamic_scaffold/bootstrap/kaminari/_paginator.html.erb

@@ -0,0 +1,17 @@
+<%= paginator.render do %>
+  <nav class="text-center text-xs-center">
+    <ul class="pagination justify-content-center dynamicScaffoldJs-pagination">
+      <%= first_page_tag if dynamic_scaffold.list.pagination.end_buttons %>
+      <%= prev_page_tag if dynamic_scaffold.list.pagination.neighbor_buttons %>
+      <% each_page do |page| %>
+        <% if page.left_outer? || page.right_outer? || page.inside_window? %>
+          <%= page_tag page %>
+        <% elsif !page.was_truncated? -%>
+          <%= gap_tag if dynamic_scaffold.list.pagination.gap_buttons %>
+        <% end %>
+      <% end %>
+      <%= next_page_tag if dynamic_scaffold.list.pagination.neighbor_buttons %>
+      <%= last_page_tag if dynamic_scaffold.list.pagination.end_buttons %>
+    </ul>
+  </nav>
+<% end %>

data/app/views/dynamic_scaffold/bootstrap/kaminari/_prev_page.html.erb

@@ -0,0 +1,7 @@
+<li class="<%= classNames 'page-item prev', disabled: current_page.first? %>">
+  <%if current_page.first?%>
+    <span class="page-link"><%= dynamic_scaffold_icon(:prev) %></span>
+  <%else%>
+    <%= link_to dynamic_scaffold_icon(:prev), url, remote: remote, class: 'page-link' %>
+  <%end%>
+</li>

data/config/locales/en.yml

@@ -0,0 +1,19 @@
+en:
+  dynamic_scaffold:
+    title:
+      full:
+        index: '%{name} List'
+        edit: 'Edit %{name}'
+        new: 'Create %{name}'
+      action:
+        index: 'List'
+        edit: 'Edit'
+        new: 'Create'
+    message:
+      no_records: '%{model} was not found.'
+      destroy_confirm: 'Are you sure you want to delete this?'
+      confirm_cancel: 'Cancel'
+      confirm_ok: 'OK'
+    alert:
+      destroy:
+        invalid_foreign_key: 'That item can not be deleted because it has associated record(s).'

data/config/locales/ja.yml

@@ -0,0 +1,28 @@
+ja:
+  dynamic_scaffold:
+    title:
+      full:
+        index: '%{name}一覧'
+        edit: '%{name}編集'
+        new: '新規%{name}'
+      action:
+        index: '一覧'
+        edit: '編集'
+        new: '新規'
+    button:
+      add: '追加'
+      edit: '編集'
+      save_order: '並び順を保存'
+      save: '保存'
+      back: '戻る'
+    message:
+      no_records: '%{model}は見つかりませんでした。'
+      destroy_confirm: '削除します。よろしいですか？'
+      confirm_cancel: 'キャンセル'
+      confirm_ok: 'OK'
+    alert:
+      destroy:
+        invalid_foreign_key: '関連づいたレコードがあるので削除できません。'
+  views:
+    pagination:
+      truncate: '…'

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/dynamic_scaffold/config.rb

@@ -0,0 +1,263 @@
+module DynamicScaffold
+  class Pagination
+    attr_reader(
+      :kaminari_options,
+      :per_page,
+      :total_count,
+      :end_buttons,
+      :neighbor_buttons,
+      :gap_buttons,
+      :highlight_current,
+      :param_name
+    )
+    def initialize(options)
+      options = {
+        per_page: 25,
+        window: 0,                # kaminari options
+        outer_window: 0,          # kaminari options
+        left: 0,                  # kaminari options
+        right: 0,                 # kaminari options
+        param_name: :page,        # kaminari options
+        total_count: true,        # Whether to display total count on active page like `2 / 102`
+        end_buttons: true,        # Whether to display buttons to the first and last page.
+        neighbor_buttons: true,   # Whether to display buttons to the next and prev page.
+        gap_buttons: false,       # Whether to display gap buttons.
+        highlight_current: false, # Whether to highlight the current page.
+      }.merge(options)
+      @kaminari_options = options.extract!(:window, :outer_window, :left, :right, :param_name)
+      @param_name = @kaminari_options[:param_name]
+      options.each {|name, value| instance_variable_set("@#{name}", value) }
+    end
+
+    def page_number(page, records)
+      return page unless total_count
+      "#{page} / #{records.total_pages}"
+    end
+
+    def page_class(page, _records)
+      if page.inside_window?
+        'inner'
+      elsif page.left_outer?
+        'left-outer'
+      elsif page.right_outer?
+        'right-outer'
+      end
+    end
+  end
+
+  class Title
+    attr_writer :name
+
+    def initialize(config)
+      @config = config
+      @titles_cache = {}
+      @name = @config.model.model_name.human
+    end
+
+    def name(&block)
+      if block_given?
+        @block = block
+      elsif !@block.nil?
+        @config.controller.view_context.instance_exec(&@block)
+      else
+        @name
+      end
+    end
+
+    def current
+      public_send(@config.controller.params[:action])
+    end
+
+    def index
+      titles(:index)
+    end
+
+    def edit
+      titles(:edit)
+    end
+
+    def new
+      titles(:new)
+    end
+
+    # def update
+    #   edit
+    # end
+
+    # def create
+    #   create
+    # end
+
+    private
+
+      def titles(action)
+        unless @titles_cache[action]
+          titles = OpenStruct.new
+          titles.name = name
+          titles.full = I18n.t("dynamic_scaffold.title.full.#{action}", name: titles.name)
+          titles.action = I18n.t("dynamic_scaffold.title.action.#{action}")
+          titles.freeze
+          @titles_cache[action] = titles
+        end
+
+        @titles_cache[action]
+      end
+  end
+
+  class Vars
+    def initialize(config)
+      @config = config
+      @values = {}
+    end
+
+    def _register(name, block)
+      define_singleton_method(name) do
+        @values[name] ||= @config.controller.instance_exec(&block)
+        @values[name]
+      end
+    end
+  end
+
+  class Config
+    attr_reader :model, :form, :list, :title, :controller
+    def initialize(model, controller)
+      @model = model
+      @controller = controller
+      @form = FormBuilder.new(self)
+      @list = ListBuilder.new(self)
+      @title = Title.new(self)
+      @vars = Vars.new(self)
+    end
+
+    def vars(name = nil, &block)
+      if block_given?
+        raise ArgumentError, 'Missing var name.' if name.nil?
+        @vars._register(name, block)
+      else
+        @vars
+      end
+    end
+
+    def scope(parameter_names = nil)
+      @scope = parameter_names unless parameter_names.nil?
+      @scope
+    end
+  end
+
+  class ListBuilder
+    def initialize(config)
+      @config = config
+      @items = []
+      @sorter = nil
+      @order = []
+      @title = nil
+    end
+
+    def pagination(options = nil)
+      @pagination = Pagination.new(options) unless options.nil?
+
+      @pagination
+    end
+
+    def sorter(params = nil)
+      @sorter = params if params
+      @sorter
+    end
+
+    def item(*args, &block)
+      item = List::Item.new(@config, *args, block)
+      @items << item
+      item
+    end
+
+    def items
+      if @items.empty?
+        @config.model.column_names.each do |column|
+          @items << List::Item.new(@config, column, nil)
+        end
+      end
+      @items
+    end
+
+    def sorter_attribute
+      @sorter.keys.first
+    end
+
+    def sorter_direction
+      @sorter.values.first
+    end
+
+    def order(*args)
+      @order = args unless args.empty?
+      @order
+    end
+
+    def title(*args, &block)
+      if args[0].is_a?(Symbol) || args[0].is_a?(String) || block_given?
+        @title = {
+          column_name: args[0],
+          block: block
+        }
+      else
+        record = args[0]
+        return @config.controller.view_context.instance_exec(record, &@title[:block]) if @title[:block]
+        record.public_send(@title[:column_name])
+      end
+    end
+
+    def title?
+      @title.present?
+    end
+  end
+
+  class FormBuilder
+    def initialize(config)
+      @config = config
+      @items = []
+    end
+
+    def items
+      if @items.empty?
+        @config.model.column_names.each do |column|
+          type = :text_field
+          type = :hidden_field if @config.scope && @config.scope.include?(column.to_sym)
+          @items << Form::Item::SingleOption.new(@config, type, column)
+        end
+      end
+      @items
+    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 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)
+      else
+        raise DynamicScaffold::Error::InvalidParameter, "Unknown form item type #{type}"
+      end
+      @items << item
+      item
+    end
+  end
+end

data/lib/dynamic_scaffold/controller.rb

@@ -0,0 +1,116 @@
+module DynamicScaffold
+  module Controller
+    extend ActiveSupport::Concern
+    include ControllerUtilities
+
+    included do
+      helper_method :dynamic_scaffold_path, :dynamic_scaffold_icon, :dynamic_scaffold, :primary_key_value
+      attr_reader :dynamic_scaffold
+      before_action lambda {
+        @dynamic_scaffold = Config.new(self.class.dynamic_scaffold_model, self)
+        self.class.dynamic_scaffold_initializer.call(@dynamic_scaffold)
+      }
+    end
+
+    class_methods do
+      attr_accessor :dynamic_scaffold_model, :dynamic_scaffold_initializer
+
+      def dynamic_scaffold(model, &block)
+        self.dynamic_scaffold_model = model
+        self.dynamic_scaffold_initializer = block
+      end
+    end
+
+    # Actions
+
+    def index # rubocop:disable Metrics/AbcSize
+      @records = dynamic_scaffold.model.all
+      raise Error::Controller, 'You must return ActiveRecord::Relation' unless @records.is_a? ::ActiveRecord::Relation
+
+      if dynamic_scaffold.list.pagination
+        @records = @records
+                     .page(params[dynamic_scaffold.list.pagination.param_name])
+                     .per(dynamic_scaffold.list.pagination.per_page)
+      end
+
+      @records = @records.where scope_params
+      @records = @records.order dynamic_scaffold.list.sorter if dynamic_scaffold.list.sorter
+      @records = @records.order(*dynamic_scaffold.list.order) unless dynamic_scaffold.list.order.empty?
+
+      @records = yield(@records) if block_given?
+      raise Error::Controller, 'You must return ActiveRecord::Relation' if @records.nil?
+      @records
+    end
+
+    def new
+      @record = dynamic_scaffold.model.new
+
+      defaults = dynamic_scaffold.form.items.each_with_object({}) do |item, memo|
+        memo[item.name] = item.default if dynamic_scaffold.model.column_names.include?(item.name.to_s)
+      end
+
+      @record.attributes = defaults.merge(scope_params)
+    end
+
+    def edit
+      @record = find_record(edit_params)
+    end
+
+    def create
+      @record = dynamic_scaffold.model.new
+      prev_attribute = @record.attributes
+      @record.attributes = update_values
+      bind_sorter_value(@record) if dynamic_scaffold.list.sorter
+      dynamic_scaffold.model.transaction do
+        yield(@record, prev_attribute) if block_given?
+        if @record.save
+          redirect_to dynamic_scaffold_path(:index)
+        else
+          render "#{params[:controller]}/new"
+        end
+      end
+    end
+
+    def update
+      values = update_values
+      @record = find_record(extract_pkeys(values))
+      prev_attribute = @record.attributes
+      @record.attributes = values
+      dynamic_scaffold.model.transaction do
+        yield(@record, prev_attribute) if block_given?
+        if @record.save
+          redirect_to dynamic_scaffold_path(:index)
+        else
+          render "#{params[:controller]}/edit"
+        end
+      end
+    end
+
+    def destroy
+      # `Destroy` also does not support multiple primary keys too.
+      record = find_record(dynamic_scaffold.model.primary_key => params['id'])
+      begin
+        dynamic_scaffold.model.transaction do
+          record.destroy
+        end
+      rescue ::ActiveRecord::InvalidForeignKey => _error
+        flash[:dynamic_scaffold_danger] = I18n.t('dynamic_scaffold.alert.destroy.invalid_foreign_key')
+      end
+      redirect_to dynamic_scaffold_path(:index)
+    end
+
+    def sort
+      pkeys_list = sort_params
+      reset_sequence(pkeys_list.size)
+      dynamic_scaffold.model.transaction do
+        pkeys_list.each do |pkeys|
+          rec = find_record(pkeys.to_hash)
+          next_sec = next_sequence!
+          rec[dynamic_scaffold.list.sorter_attribute] = next_sec
+          rec.save
+        end
+      end
+      redirect_to dynamic_scaffold_path(:index)
+    end
+  end
+end