dynamic_scaffold 0.1.0

data/lib/dynamic_scaffold/controller_utilities.rb

@@ -0,0 +1,115 @@
+module DynamicScaffold
+  module ControllerUtilities
+    private
+
+      # Get the hash of the key and value specified for the scope.
+      def scope_params
+        return {} if dynamic_scaffold.scope.nil?
+        dynamic_scaffold.scope.each_with_object({}) {|attr, res| res[attr] = params[attr] }
+      end
+
+      # Get the primary key hash from the update parameters.
+      def extract_pkeys(values)
+        [*dynamic_scaffold.model.primary_key].each_with_object({}) {|col, res| res[col] = values[col] }
+      end
+
+      # Convert pkey_string value to hash.
+      def pkey_string_to_hash(pkey)
+        # https://github.com/gomo/dynamic_scaffold/pull/9/commits/ff5de0e38b3544347e82539c45ffd2efaf3410da
+        # Stop support multiple pkey, on this commit.
+        # Convert "key:1,code:foo" to {key: "1", code: "foo"}
+        pkey.split(',').map {|v| v.split(':') }.each_with_object({}) {|v, res| res[v.first] = v.last }
+      end
+
+      # Get parameters for edit action. `key[column] => value`
+      def edit_params
+        params.permit(*dynamic_scaffold.model.primary_key)
+      end
+
+      # Get paramters for sort action. `pkeys[][column] => value`
+      def sort_params
+        params
+          .require('pkeys')
+          .map {|p| p.permit(*dynamic_scaffold.model.primary_key) }
+      end
+
+      # Get paramters for update record.
+      def update_values
+        values = params
+                   .require(dynamic_scaffold.model.name.underscore)
+                   .permit(*dynamic_scaffold.form.items.map(&:strong_parameter))
+
+        if dynamic_scaffold.scope && !valid_for_scope?(values)
+          raise DynamicScaffold::Error::Controller, "You can update only to #{scope_params} on this scope"
+        end
+
+        values
+      end
+
+      # Check if there are inconsistent scopes in update parameters
+      def valid_for_scope?(update_params)
+        result = true
+        scope_params.each do |key, value|
+          if update_params.key?(key) && update_params[key] != value
+            result = false
+            break
+          end
+        end
+        result
+      end
+
+      def reset_sequence(record_count)
+        if dynamic_scaffold.list.sorter_direction == :asc
+          @sequence = 0
+        elsif dynamic_scaffold.list.sorter_direction == :desc
+          @sequence = record_count - 1
+        end
+      end
+
+      def next_sequence!
+        val = @sequence
+        if dynamic_scaffold.list.sorter_direction == :asc
+          @sequence += 1
+        elsif dynamic_scaffold.list.sorter_direction == :desc
+          @sequence -= 1
+        end
+        val
+      end
+
+      def find_record(params)
+        rec = dynamic_scaffold.model.find_by(params.merge(scope_params))
+        raise ::ActiveRecord::RecordNotFound if rec.nil?
+        rec
+      end
+
+      def dynamic_scaffold_path(action, options = {})
+        route = Rails.application.routes.routes.find do |r|
+          route_params = r.required_defaults
+          route_params[:controller] == params[:controller] && (route_params[:action] == action.to_s && r.name)
+        end
+
+        if route.nil?
+          raise DynamicScaffold::Error::RouteNotFound,
+            "Missing controller#action #{params[:controller]}##{action}"
+        end
+
+        options.merge!(scope_params)
+
+        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)
+        record[attr] = value ? value + 1 : 0
+      end
+  end
+end

data/lib/dynamic_scaffold/engine.rb

@@ -0,0 +1,18 @@
+require 'classnames-rails-view'
+module DynamicScaffold
+  class Engine < ::Rails::Engine
+    config.dynamic_scaffold = ActiveSupport::OrderedOptions.new
+    config.dynamic_scaffold.icon_set = :fontawesome
+
+    config.autoload_paths += Dir["#{config.root}/lib/**/"]
+    config.assets.precompile += %w[dynamic_scaffold/*]
+
+    require 'dynamic_scaffold/routes'
+
+    config.after_initialize do |_app|
+      if Rails.application.config.dynamic_scaffold.icons.nil?
+        require "dynamic_scaffold/icons/#{config.dynamic_scaffold.icon_set}"
+      end
+    end
+  end
+end

data/lib/dynamic_scaffold/error/base.rb

@@ -0,0 +1,6 @@
+module DynamicScaffold
+  module Error
+    class Base < StandardError
+    end
+  end
+end

data/lib/dynamic_scaffold/error/controller.rb

@@ -0,0 +1,6 @@
+module DynamicScaffold
+  module Error
+    class Controller < Base
+    end
+  end
+end

data/lib/dynamic_scaffold/error/invalid_icon.rb

@@ -0,0 +1,6 @@
+module DynamicScaffold
+  module Error
+    class InvalidIcon < Base
+    end
+  end
+end

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

@@ -0,0 +1,106 @@
+module DynamicScaffold
+  module Form
+    module Item
+      class Base
+        attr_reader :name
+        def initialize(config, type, name, html_attributes = {})
+          @config = config
+          @name = name
+          @type = type
+          @html_attributes = html_attributes
+          classnames = @html_attributes.delete(:class)
+          @classnames_list = []
+          @classnames_list.push(classnames) if classnames
+          @notes = []
+          @multiple = type == :collection_check_boxes || html_attributes[:multiple]
+        end
+
+        def notes?
+          !@notes.empty?
+        end
+
+        def note(&block)
+          @notes << block if block_given?
+          self
+        end
+
+        def render_notes(record, view)
+          htmls = @notes.map do |note|
+            view.instance_exec(record, &note)
+          end
+          view.safe_join(htmls)
+        end
+
+        def type?(type)
+          @type == type
+        end
+
+        def label?
+          !@label.nil?
+        end
+
+        def label(label = nil, &block)
+          if block_given?
+            raise Error::InvalidParameter, 'Only the block type accepts block.' unless type? :block
+            @block = block
+          end
+          if label
+            @label = label
+            self
+          else
+            return @label if @label
+            @config.model.human_attribute_name @name
+          end
+        end
+
+        def strong_parameter
+          return { @name => [] } if @multiple
+          @name
+        end
+
+        def if(&block)
+          @if_block = block
+          self
+        end
+
+        def unless(&block)
+          @unless_block = block
+          self
+        end
+
+        def needs_rendering?(view)
+          return true unless @if_block || @unless_block
+          return view.instance_exec(view.controller.params, &@if_block) if @if_block
+          return !view.instance_exec(view.controller.params, &@unless_block) if @unless_block
+        end
+
+        def proxy(attribute_name)
+          @proxy = attribute_name
+          self
+        end
+
+        def proxy_field
+          return self unless @proxy
+          proxy_target = @config.form.items.select {|f| f.name == @proxy }
+          raise DynamicScaffold::Error::InvalidParameter, "Missing proxy target element: #{@proxy}" if proxy_target.empty?
+          proxy_target.first
+        end
+
+        def default(value = nil)
+          return @default if value.nil?
+          @default = value
+        end
+
+        protected
+
+          def build_html_attributes(classnames)
+            classnames_list = @classnames_list
+            classnames_list = [*classnames_list, classnames] if classnames
+            options = @html_attributes.dup
+            options[:class] = classnames_list.join(' ') unless classnames_list.empty?
+            options
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module DynamicScaffold
+  module Form
+    module Item
+      class Block < Base
+        def initialize(config, type, name, block)
+          super(config, type, name, {})
+          @block = block
+        end
+
+        def render(view, form, classnames = nil)
+          view.instance_exec(form, self, classnames, &@block)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module DynamicScaffold
+  module Form
+    module Item
+      class SingleOption < Base
+        def initialize(config, type, *args)
+          name = args.shift
+          html_attributes = args.extract_options!
+          @args = args
+          super(config, type, name, html_attributes)
+        end
+
+        def render(_view, form, classnames = nil)
+          html_attributes = build_html_attributes(classnames)
+          # Retain the value of the password field on error.
+          html_attributes[:value] = form.object.public_send(@name) if @type == :password_field
+          form.public_send(@type, @name, *@args, html_attributes)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+module DynamicScaffold
+  module Form
+    module Item
+      class TwoOptions < Base
+        def initialize(config, type, *args)
+          name = args.shift
+          # rubocop:disable Style/IdenticalConditionalBranches
+          if args[args.length - 2].is_a?(Hash)
+            html_attributes = args.extract_options!
+            @options = args.extract_options!
+          else
+            html_attributes = {}
+            @options = args.extract_options!
+          end
+          # rubocop:enable Style/IdenticalConditionalBranches
+
+          @args = args
+          super(config, type, name, html_attributes)
+        end
+
+        def render(_view, form, classnames = nil)
+          html_attributes = build_html_attributes(classnames)
+          form.public_send(@type, @name, *@args, @options, html_attributes)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module DynamicScaffold
+  module Form
+    module Item
+      class TwoOptionsWithBlock < TwoOptions
+        def render(_view, form, classnames = nil)
+          form.public_send(
+            @type,
+            @name,
+            *@args,
+            @options,
+            build_html_attributes(classnames)
+          ) do |builder|
+            yield builder
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dynamic_scaffold/icons/fontawesome.rb

@@ -0,0 +1,47 @@
+module DynamicScaffold
+  module Fontawesome
+    def self.inline_svg(path)
+      Rails.cache.fetch "dynamic_scaffold/fontawesome/icons/#{path}" do
+        full_path = DynamicScaffold::Engine.root.join('app', 'assets', 'images', 'dynamic_scaffold', 'fontawesome', path)
+        file = File.open(full_path)
+        file.read.gsub!('<svg ', '<svg class="dynamicScaffold-svg-icon" ').html_safe # rubocop:disable Rails/OutputSafety, Metrics/LineLength
+      end
+    end
+  end
+end
+Rails.application.config.dynamic_scaffold.icons = proc do |name|
+  # This function is called in view scope.
+  # https://github.com/gomo/dynamic_scaffold/blob/b4066bbd40cd6e7307ce283d5a9bd526ae124e00/lib/dynamic_scaffold/controller_utilities.rb#L104-L106
+  case name
+  when :up then
+    DynamicScaffold::Fontawesome.inline_svg('chevron-up.svg')
+  when :down then
+    DynamicScaffold::Fontawesome.inline_svg('chevron-down.svg')
+  when :delete then
+    DynamicScaffold::Fontawesome.inline_svg('times.svg')
+  when :edit then
+    DynamicScaffold::Fontawesome.inline_svg('pencil-alt.svg')
+  when :add then
+    DynamicScaffold::Fontawesome.inline_svg('plus.svg')
+  when :save then
+    DynamicScaffold::Fontawesome.inline_svg('hdd.svg')
+  when :back then
+    DynamicScaffold::Fontawesome.inline_svg('chevron-left.svg')
+  when :error then
+    DynamicScaffold::Fontawesome.inline_svg('exclamation-circle.svg')
+  when :first then
+    DynamicScaffold::Fontawesome.inline_svg('step-backward.svg')
+  when :last then
+    DynamicScaffold::Fontawesome.inline_svg('step-forward.svg')
+  when :next then
+    DynamicScaffold::Fontawesome.inline_svg('chevron-right.svg')
+  when :prev then
+    DynamicScaffold::Fontawesome.inline_svg('chevron-left.svg')
+  when :top then
+    DynamicScaffold::Fontawesome.inline_svg('angle-double-up.svg')
+  when :bottom then
+    DynamicScaffold::Fontawesome.inline_svg('angle-double-down.svg')
+  else
+    raise DynamicScaffold::Error::InvalidIcon, "Unknown icon type #{name} specified."
+  end
+end

data/lib/dynamic_scaffold/list/item.rb

@@ -0,0 +1,35 @@
+module DynamicScaffold
+  module List
+    class Item
+      attr_reader :classnames, :html_attributes
+
+      def initialize(config, *args, block)
+        @config = config
+        @html_attributes = args.extract_options!
+        @classnames = @html_attributes.delete(:class)
+        @attribute_name = args[0]
+        @block = block
+      end
+
+      def value(view, record)
+        if @block
+          view.instance_exec(record, @attribute_name, &@block)
+        else
+          record.public_send(@attribute_name)
+        end
+      end
+
+      def label(label = nil, &block)
+        @block = block if block
+        if label
+          @label = label
+          self
+        elsif @label
+          @label
+        elsif @attribute_name
+          @config.model.human_attribute_name @attribute_name
+        end
+      end
+    end
+  end
+end

data/lib/dynamic_scaffold/routes.rb

@@ -0,0 +1,23 @@
+module DynamicScaffold
+  module Routes
+    extend ActiveSupport::Concern
+
+    included do
+      include DynamicScaffold::Routes::LocalInstanceMethods
+    end
+
+    module LocalInstanceMethods
+      def dynamic_scaffold_for(*resources)
+        options = resources.extract_options!.dup
+        path = resources[0]
+        resources path, options.merge(except: %i[show]) do
+          collection do
+            patch :sort, controller: options[:controller]
+          end
+        end
+      end
+    end
+  end
+end
+
+::ActionDispatch::Routing::Mapper.send :include, DynamicScaffold::Routes

data/lib/dynamic_scaffold/version.rb

@@ -0,0 +1,3 @@
+module DynamicScaffold
+  VERSION = '0.1.0'.freeze
+end

data/lib/dynamic_scaffold.rb

@@ -0,0 +1,12 @@
+require 'dynamic_scaffold/version'
+require 'dynamic_scaffold/engine'
+require 'dynamic_scaffold/controller_utilities'
+require 'dynamic_scaffold/controller'
+require 'dynamic_scaffold/config'
+
+require 'dynamic_scaffold/error/base'
+require 'dynamic_scaffold/error/invalid_icon'
+require 'dynamic_scaffold/error/controller'
+
+module DynamicScaffold
+end

data/lib/generators/dynamic_scaffold/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Generate DynamicScaffold's controller and views by specifying a path.
+
+Example:
+    rails generate dynamic_scaffold shops
+
+    This will create for Shop model:
+        app/controllers/shops_controller.rb
+        app/views/shops/edit.html.erb
+        app/views/shops/index.html.erb
+        app/views/shops/new.html.erb
+
+    rails generate dynamic_scaffold controls/county Country
+
+    This will create for Country model:
+        app/controllers/country_controller.rb
+        app/views/country/edit.html.erb
+        app/views/country/index.html.erb
+        app/views/country/new.html.erb

data/lib/generators/dynamic_scaffold/dynamic_scaffold_generator.rb

@@ -0,0 +1,25 @@
+class DynamicScaffoldGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  argument :path, type: 'string', required: true
+  argument :model, type: 'string', required: false
+
+  def init
+    @namespases = path.split('/')
+    @plural_model_name = @namespases.pop.camelize
+    @class_scope = @namespases.map(&:camelize).join('::')
+    @model_name = model ? model : @plural_model_name.singularize
+    @model_name = @model_name.camelize
+    @model = @model_name.constantize
+  end
+
+  def create_controllers
+    template 'controller.erb', "app/controllers/#{path}_controller.rb"
+  end
+
+  def create_views
+    %i[edit index new].each do |file|
+      template "views/#{file}.erb", "app/views/#{path}/#{file}.html.erb"
+    end
+  end
+end

data/lib/generators/dynamic_scaffold/templates/controller.erb

@@ -0,0 +1,100 @@
+class <%= @class_scope.present? ? "#{@class_scope}::" : '' %><%= @plural_model_name %>Controller < ApplicationController
+  include DynamicScaffold::Controller
+  dynamic_scaffold <%= @model_name %> do |config|
+    # If you want to use all views common variables, please call `vars`.
+    # Please see https://github.com/gomo/dynamic_scaffold#view-helper for details.
+    # In your view:
+    # <%%= dynamic_scaffold.vars.scope_target.name %>
+    # here:
+    # config.vars :scope_target do
+    #   SomeRecord.find(params['some_record_id'])
+    # end
+
+    # You can get the current page title like `Country List`, `Edit Country` in your view.
+    # <%%= dynamic_scaffold.title.current.full %>
+    # If you want change from the model name, set config.title.name.
+    # Please see https://github.com/gomo/dynamic_scaffold#view-helper for details.
+    # config.title.name = 'Model'
+
+    # When you want a simple sort on the column of record, please call order.
+    # config.list.order created_at: :desc
+
+    # To enable sorting, call sorter method specifying the column name and direction.
+    # config.list.sorter sequence: :desc
+
+    # To enable pagination, call pagination. All args is not require, defauls is below
+    # config.list.pagination(
+    #   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.
+    # )
+
+    # To enable scoping, call scope with parameter names you want.
+    # Please see https://github.com/gomo/dynamic_scaffold#scoping for details.
+    # config.scope([role])
+
+    # You can change the items displayed in the list through the `config.list.item`.
+    # Please see https://github.com/gomo/dynamic_scaffold#customize-list for details.
+
+    # You can set each title in the list through title method.
+    # Pass the attribute name,
+    # config.list.title(:name)
+    # or
+    # config.list.title do |record|
+    #   record.name
+    # end
+
+  <%- @model.column_names.each do |column| -%>
+    config.list.item(:<%= column %>, style: 'width: 120px;')
+  <%- end -%>
+
+    # You can customize the form fields through `config.form`.
+    # Please see https://github.com/gomo/dynamic_scaffold#customize-form for details.
+  <%- @model.column_names.each do |column| -%>
+    config.form.item(:text_field, :<%= column %>)
+  <%- end -%>
+  end
+  
+  # def index
+  #   super do |query|
+  #     # If you want append database queries, Write here.
+  #     # Do not forget to return query.
+  #   end
+  # end
+
+  # def new
+  #   super
+  # end
+
+  # def edit
+  #   super
+  # end
+
+  # def create
+  #   super do |record, prev_attribute|
+  #      # If you want to modify the attributes of the record before saving, Write here.
+  #   end
+  # end
+
+  # def update
+  #   super do |record, prev_attribute|
+  #      # If you want to modify the attributes of the record before saving, Write here.
+  #   end
+  # end
+
+  # def destroy
+  #   super
+  # end
+
+  # def sort
+  #   super
+  # end
+end

data/lib/generators/dynamic_scaffold/templates/views/edit.erb

@@ -0,0 +1 @@
+<%%= render 'dynamic_scaffold/bootstrap/edit' %>

data/lib/generators/dynamic_scaffold/templates/views/index.erb

@@ -0,0 +1 @@
+<%%= render 'dynamic_scaffold/bootstrap/list' %>

data/lib/generators/dynamic_scaffold/templates/views/new.erb

@@ -0,0 +1 @@
+<%%= render 'dynamic_scaffold/bootstrap/new' %>

data/lib/tasks/dynamic_scaffold_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :dynamic_scaffold do
+#   # Task goes here
+# end