keppler 2.1.17 → 2.1.18

data/testing-with-2.1.18/lib/generators/keppler_front/keppler_front_generator.rb

@@ -0,0 +1,139 @@
+require 'rails/generators/rails/resource/resource_generator'
+require 'rails/generators/resource_helpers'
+module Rails
+  module Generators
+    # KepplerScaffold
+    class KepplerFrontGenerator < ResourceGenerator
+      remove_hook_for :resource_controller
+      remove_class_option :actions
+
+      remove_class_option :resource_route, type: :boolean
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      check_class_collision suffix: 'Controller'
+
+      class_option(
+        :orm,
+        banner: 'NAME',
+        type: :string,
+        required: false,
+        desc: 'ORM to generate the controller for'
+      )
+
+      argument(
+        :attributes,
+        type: :array,
+        default: [],
+        banner: 'field:type field:type'
+      )
+
+      def add_route
+        attributes.each do |attribute|
+          insert_into_file(
+            'config/routes.rb',
+            "\n  #{indent(str_route(attribute))}",
+            after: 'localized do'
+          )
+        end
+      end
+
+      def create_route_locales
+        %w[es en].each do |locale|
+          attributes.each do |attribute|
+            insert_into_file(
+              "config/locales/routes.#{locale}.yml",
+              "\n    #{attribute.name}: #{attribute.name}",
+              after: 'routes:'
+            )
+          end
+        end
+      end
+
+      def create_controller_files
+        template(
+          'controllers/controller.rb',
+          File.join(
+            'app/controllers/app',
+            controller_class_path, "front_controller.rb"
+          )
+        )
+      end
+
+      def create_views_files
+        attributes.each do |attribute|
+          template_keppler_views("#{attribute.name}.html.haml")
+        end
+      end
+
+      hook_for :test_framework, as: :scaffold
+
+      # Invoke the helper using the controller name (pluralized)
+      hook_for :helper, as: :scaffold do |invoked|
+        invoke invoked, [controller_name]
+      end
+
+      private
+
+      def add_str_locales(locale, switch)
+        insert_into_file(
+          "config/locales/#{locale}.yml",
+          str_locales(switch),
+          after: "#{switch}:"
+        )
+      end
+
+      def str_route(attribute)
+        "get '/#{attribute.name}', to: 'app/front##{attribute.name}', as: :app_#{attribute.name}"
+      end
+
+      def str_menu
+        "  #{controller_file_name.singularize}:\n    name: #{controller_file_name.humanize.downcase}\n    url_path: /admin/#{controller_file_name}\n    icon: code\n    current: ['admin/#{controller_file_name}']\n    model: #{controller_file_name.singularize.camelize}\n"
+      end
+
+      def str_ability
+        "\n\n      # - #{controller_file_name.singularize.camelcase} authorize -\n      can :manage, #{controller_file_name.singularize.camelcase}"
+      end
+
+      def str_locales(switch)
+        case switch
+        when 'singularize'
+          "\n        #{controller_file_name.singularize}: #{controller_file_name.singularize.humanize.downcase}"
+        when 'pluralize'
+          "\n        #{controller_file_name}: #{controller_file_name.humanize.downcase}"
+        when 'modules'
+          "\n      admin/#{controller_file_name}: #{controller_file_name.humanize}"
+        when 'sidebar-menu'
+          "\n      #{controller_file_name}: #{controller_file_name.humanize}"
+        end
+      end
+
+      def template_keppler_views(name_file)
+        template(
+          "views/template.html.haml",
+          File.join("app/views/app/front",  name_file)
+        )
+      end
+
+      def arr_exist(path, search)
+        object = []
+        open(path).each do |line|
+          object << line if line.to_s.include? search
+        end
+        object
+      end
+
+      def destination_path(path)
+        File.join(destination_root, path)
+      end
+
+      def gsub_file(relative_destination, regexp, *args, &block)
+        path = destination_path(relative_destination)
+        content = File.read(path).gsub(regexp, *args, &block)
+        File.open(path, 'wb') do |file|
+          file.write(content)
+        end
+      end
+    end
+  end
+end

data/testing-with-2.1.18/lib/generators/keppler_front/templates/controllers/controller.rb

@@ -0,0 +1,17 @@
+<% if namespaced? -%>
+require_dependency "<%= namespaced_path %>/application_controller"
+<% end -%>
+<% module_namespacing do -%>
+module App
+  # <%= controller_class_name %>Controller
+  class FrontController < AppController
+    layout 'layouts/templates/application'
+
+    <%- attributes.each do |attribute| -%>
+    def <%= attribute.name %>
+    end
+
+    <%- end -%>
+  end
+end
+<% end -%>

data/testing-with-2.1.18/lib/generators/keppler_front/templates/views/template.html.haml

@@ -0,0 +1,225 @@
+!!!
+%html
+  %header
+    = render 'app/layouts/head'
+  %body
+    %header
+      = #render 'app/layouts/navigation'
+    %main#keppler{:role => "main"}
+      = #render 'app/layouts/messages'
+      .front
+        .front-logo
+          = image_tag "app/keppler-front.png", class: "img-responsive"
+
+        .front-social
+          %ul
+            %li
+              =  link_to "https://twitter.com/slicegroupxyz", target: '_blank' do
+                = icon 'fab', 'twitter'
+            %li
+              =  link_to "https://www.facebook.com/slicegroupxyz/", target: '_blank' do
+                = icon 'fab', 'facebook'
+            %li
+              =  link_to "https://www.instagram.com/slicegroupxyz/", target: '_blank' do
+                = icon 'fab', 'instagram'
+            %li
+              =  link_to "https://github.com/SliceDevelopers", target: '_blank' do
+                = icon 'fab', 'github'
+        .mouse-scroll
+          .mouse
+            .scroll
+        %footer.front-footer
+          = render 'app/layouts/footer'
+
+
+      %section#documentation
+        %h3 KEPPLER ADMIN
+
+        %p
+          KEPPLER ADMIN es un CMS con un entorno de desarrollo que cuenta con
+          una base de gemas ya integradas, de tal forma que acelerará el
+          desarrollo de aplicaciones de vanguardia bajo la plataforma de Ruby
+          on Rails.
+
+        %h3 Características
+
+        %ul
+          %li
+            Base de datos por defecto PostreSQL
+          %li
+            Integración para autenticación de usuarios con
+            = link_to 'Devise', 'https://github.com/plataformatec/devise', target: '_blank'
+          %li
+            Integración para roles de usuarios con
+            = link_to 'Rolify', 'https://github.com/RolifyCommunity/rolify', target: '_blank'
+          %li
+            Integración para autorizaciones con
+            = link_to 'Pundit', 'https://github.com/varvet/pundit', target: '_blank'
+          %li
+            Inegración para el manejo de de paginación con
+            = link_to 'Kaminari', 'https://github.com/amatsuda/kaminari', target: '_blank'
+          %li
+            Integración para helpers de formularios con
+            = link_to 'SimpleForm', 'https://github.com/RolifyCommunity/rolify', target: '_blank'
+          %li
+            Integración para búsquedas full-text con
+            = link_to 'Ransack', 'https://github.com/activerecord-hackery/ransack', target: '_blank'
+          %li
+            Integración con framework fronte-end para el administrativo con
+            = link_to 'AdminLTE', 'https://adminlte.io', target: '_blank'
+          %li
+            Integración con framework javascript
+            = link_to 'VueJS', 'https://vuejs.org/', target: '_blank'
+          %li
+            Integración sitemap dinamicos con
+            = link_to 'Sitemap Generator', 'https://github.com/kjvarga/sitemap_generator', target: '_blank'
+
+        %h3 Gema de Keppler
+
+        %h4 Instalación
+
+        %p Una de las novedades de Keppler Admin v2.0 es el lanzamiento de una gema que nos
+        permite el fácil y rápido manejo de las funcionalidades del CMS. Para instalarlo
+        necesitamos ejecutar el siguiente comando desde la consola:
+
+        %pre
+          %code.ruby
+            gem install keppler
+
+        %h4 Lista de comandos
+
+        %p Para verificar que está instalada la gema correctamente y ver una lista de los posibles comandos
+        que podemos utilizar, ejecutamos:
+
+        %pre
+          %code.ruby
+            keppler
+
+        %h4 Nuevo Proyecto
+
+        %p Para crear un nuevo proyecto en Ruby on Rails con Keppler Admin, podemos ejecutar:
+
+        %pre
+          %code.ruby
+            keppler new NuevoProyecto
+
+        %h4 Creación del archivo secrets.yml
+
+        %p Si detienes el proceso a la mitad o aún no tienes configurado un archivo secrets.yml con la configuración de
+        la base de datos y otros inicializadores, puedes crear la base de datos ejecutando:
+
+        %pre
+          %code.ruby
+            keppler db_conf
+
+        %h4 Instalación de las dependencias
+
+        %p Antes de poder iniciar con un proyecto nuevo, primero debemos instalar todas las gemas
+        instanciadas en el Gemfile, ubicado en la raíz del proyecto, con el comando:
+
+        %pre
+          %code.ruby
+            keppler dep
+
+        %h3 Keppler Scaffolds
+
+        %p Keppler ofrece la posibilidad de realizar tareas de scaffolds totalmente
+        configurados para adaptarse al administrativo. Para crear un nuevo
+        módulo sólo debes llamar al siguiente comando desde la consola:
+
+        %pre
+          %code.ruby
+            keppler add module ModuleName attribute:type
+
+        %p Por ejemplo, crearemos un scaffold de productos con diversos campos y tipos de datos:
+
+        %pre
+          %code.ruby
+            keppler add module Product title:string description:text quantity:integer price:float arrival_date:date arrival_time:time available:boolean user:references
+
+        %p Luego debemos migrar la tabla a la base de datos con:
+
+        %pre
+          %code.ruby
+            keppler migrate
+
+        %p Si luego deseamos borrar, crear, migrar y llenar la base de datos desde cero,
+        podemos realizarlo ejecutando el comando:
+
+        %pre
+          %code.ruby
+            keppler reset
+
+        %p Por último, si todo ha sido ejecutado debida y correctamente, podemos iniciar
+        el proyecto ejecutando en la consola:
+
+        %pre
+          %code.ruby
+            keppler server
+
+        %h3 SimpleForm con Bootstrap
+
+        %p
+          Se ofrece una integración por defecto entre SimpleForm y Bootstrap, usted tiene la posibilidad de cambiar su funcionalidad en
+          %pre
+            %code.ruby
+              config/initializers/simple_form_bootstrap.rb
+
+
+        %p Aquí algunos ejemplos para la creación de inputs:
+
+        %pre
+          %code.haml
+            :preserve
+               # Inputs de tipo string o textarea
+              = f.input :name
+
+               # Inputs de tipo CKEditor
+              = f.input :description, as: :ckeditor, input_html: { ckeditor: { toolbar: 'mini'} }
+
+               # Inputs de tipo boolean
+              = f.input :public, as: :keppler_boolean
+
+               # Inputs de tipo file
+              = f.input :image, as: :keppler_file
+
+               # Inputs de tipo select
+              = f.input :role_ids, collection: Role.all, label: false, include_blank: "Seleccione un rol"
+
+               # Inputs de tipo radio buttons
+              = f.collection_radio_buttons :option, [['vegan', 'vegan'] ,['vegetarian', 'vegetarian']], :first, :last
+
+               # Inputs de tipo check_boxes
+              = f.collection_check_boxes :options, [['vegan', 'vegan'] ,['vegetarian', 'vegetarian']], :first, :last
+
+               # Inputs de tipo date
+              = f.input :date, input_html: { class: 'datepicker' }
+
+        %strong
+          Nota:
+        %p
+          Puede revisar la documentación de
+          = link_to 'AdminLTE', 'https://adminlte.io'
+        para agregar nuevas integraciones para sus formularios a través de los
+        = link_to 'Wrappers', 'https://github.com/plataformatec/simple_form/wiki/Custom-Wrappers'
+        de simpleform.
+
+        -# %h3 Plugins (Módulos)
+        -#
+        -# %p
+        -#   La plataforma permite la adaptación de módulos con facil instalación,
+        -#   algunos de los módulos desarrollados son:
+        -#
+        -# %ul
+        -#   %li
+        -#     = link_to 'Keppler Google Analytics Dashboard', 'https://github.com/slicegroup/keppler_ga_dashboard'
+        -#     -
+        -#     %strong ya viene integrado
+        -#   %li
+        -#     = link_to 'Keppler Blog', 'https://github.com/slicegroup/keppler_blog'
+        -#   %li
+        -#     = link_to 'Keppler Catalogs', 'https://github.com/slicegroup/keppler_catalogs'
+        -#   %li
+        -#     = link_to 'Keppler Contact', 'https://github.com/slicegroup/keppler_contact_us'
+
+    %script{ src: '/assets/app/front.js' }

data/testing-with-2.1.18/lib/generators/keppler_relation/keppler_relation_generator.rb

@@ -0,0 +1,219 @@
+require 'rails/generators/rails/resource/resource_generator'
+require 'rails/generators/resource_helpers'
+module Rails
+  module Generators
+    # KepplerRelation
+    class KepplerRelationGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+      # Modify models (add has_many and belongs_to relation)
+      def modify_models
+        inject_into_file(
+          "app/models/#{name}.rb",
+          "\n  has_many :#{args[0].pluralize}, :dependent => :delete_all",
+          after: 'include CloneRecord'
+        )
+        inject_into_file(
+          "app/models/#{args[0]}.rb",
+          "\n  belongs_to :#{name}",
+          after: 'include CloneRecord'
+        )
+      end
+
+      # Delete the son module from the sidemenu
+      def add_submenu
+        gsub_file 'config/menu.yml', sub_menu_deleted(args[0]), "  ##{args[0].camelcase} deleted"
+      end
+
+      # Nest routes father_module/son_module and delete the routes generated by the keppler_scaffold command
+      def nest_routes
+        gsub_file 'config/routes.rb', commented_route(args[0]), '    #Route deleted'
+        inject_into_file(
+          "config/routes.rb",
+          str_route(args[0]),
+          after:"    resources :#{name.pluralize} do\n      get '(page/:page)', action: :index, on: :collection, as: ''\n      get '/clone', action: 'clone'\n      delete(\n        action: :destroy_multiple,\n        on: :collection,\n        as: :destroy_multiple\n      )\n"
+        )
+      end
+
+      # Modify the paths of the view of the son module
+      def modify_views_path
+        ["_listing", "index", "_form", "show"].each do |view|
+          singular_path(name,args[0],view)
+          if view == '_listing'
+            clone_path(name,args[0],view)
+            inject_listing(name, args[0], view)
+          end
+          inject_variable(name, args[0], view)
+        end
+      end
+
+
+
+      # Add the method in the son controller to find the father :id
+      def add_controller_flag
+        inject_into_file(
+          "app/controllers/admin/#{args[0].pluralize}_controller.rb",
+          str_ctrl_method(name,args[0]),
+          after: "    private"
+        )
+      end
+
+      # Add the callback in the son's controller
+      def add_callback
+        inject_into_file(
+          "app/controllers/admin/#{args[0].pluralize}_controller.rb",
+          str_callback_ctrl(name),
+          after: "    before_action :show_history, only: [:index]"
+        )
+      end
+
+      # Inject the variables in the simple_form_for of the form partial
+      def inject_var_form
+        inject_into_file(
+          "app/views/admin/#{args[0].pluralize}/_form.html.haml",
+          "@#{name}_#{args[0]}, ",
+          before: "@#{args[0]}]"
+        )
+      end
+
+      # Include the button in the father_module _listing
+      def nested_button
+        inject_into_file(
+          "app/views/admin/#{name.pluralize}/_listing.html.haml",
+          str_btn(name, args[0]),
+          # before: str_last_button(name)
+          after: '				.icons.right'
+        )
+      end
+
+      # Insert params in son's controller within new method
+      def new_params
+        inject_into_file(
+          "app/controllers/admin/#{args[0].pluralize}_controller.rb",
+          "(#{name.underscore}_id: params[:#{name.underscore}_id])",
+          after: "    def new\n      @#{args[0]} = #{args[0].camelcase}.new"
+        )
+
+      end
+
+      # Replace the paths in module_son controller
+      def controller_paths
+        gsub_file(
+          "app/controllers/admin/#{args[0].pluralize}_controller.rb",
+          "admin_#{args[0].pluralize}_path",
+          "admin_#{name.underscore}_#{args[0].pluralize}_path"
+        )
+        gsub_file(
+          "app/controllers/admin/#{args[0].pluralize}_controller.rb",
+          "redirect(@#{args[0].underscore}, params)",
+          redirect_path(name, args[0])
+        )
+      end
+
+      # Replace 'params[:q] to (@category_shop) and add .where to  filter the index of son_module'
+      def index_controller
+        gsub_file(
+          "app/controllers/admin/#{args[0].pluralize}_controller.rb",
+          'params[:q]',
+          "@#{name.underscore}_#{args[0].underscore}"
+        )
+        inject_into_file(
+          "app/controllers/admin/#{args[0].pluralize}_controller.rb",
+          ".where(#{name}_id: @#{name.underscore}_#{args[0].underscore})",
+          after: "#{args[0].pluralize} = @q.result(distinct: true)"
+        )
+      end
+
+      def return_btn
+        inject_into_file(
+          "app/views/admin/#{args[0].underscore.pluralize}/index.html.haml",
+          "\n\t= link_to admin_#{name.underscore.pluralize}_path, class: 'btn-floating btn-flat' do\n\t\t-# = material_icon.md_18.arrow_back.css_class('md-dark')",
+          after: '= entries(@total, @objects)'
+        )
+      end
+
+      private
+
+      # String to delete the menu.yml menu (son_module)
+      def sub_menu_deleted(son)
+        "  #{son}:\n    name: #{son.split('_').join(" ").pluralize}\n    url_path: /admin/#{son.pluralize}\n    icon: code\n    current: ['admin/#{son.pluralize}']\n    model: #{son.camelcase}"
+      end
+
+      #
+      def redirect_path(father,son)
+        "if params.key?('_add_other')\n          redirect_to new_admin_#{father.underscore}_#{son.underscore}_path, notice: actions_messages(@#{son})\n        else\n          redirect_to admin_#{father.underscore}_#{son.pluralize}_path\n        end"
+      end
+
+      def singular_path(father,son,file)
+        inject_into_file(
+          "app/views/admin/#{son.pluralize}/#{file}.html.haml",
+          "_#{father.underscore}",
+          before: "_#{son}"
+        )
+      end
+
+      def clone_path(father,son,file)
+        inject_into_file(
+          "app/views/admin/#{son.pluralize}/#{file}.html.haml",
+          "_#{father.underscore}",
+          before: "_#{son}_clone_path"
+        )
+      end
+
+      # String to know what route comment (son_module)
+      def commented_route(path)
+        "    resources :#{path.pluralize(2)} do\n      get '(page/:page)', action: :index, on: :collection, as: ''\n      get '/clone', action: 'clone'\n      delete(\n        action: :destroy_multiple,\n        on: :collection,\n        as: :destroy_multiple\n      )\n    end\n"
+      end
+
+      # String of new route to nest (son_module)
+      def str_route(path)
+        "      resources :#{path.pluralize(2)} do\n        get '(page/:page)', action: :index, on: :collection, as: ''\n        get '/clone', action: 'clone'\n        delete(\n          action: :destroy_multiple,\n          on: :collection,\n          as: :destroy_multiple\n        )\n      end\n"
+      end
+
+      # string of private method to add within the son_module controller
+      def str_ctrl_method(father, son)
+        "\n\n    def set_#{father}\n      @#{father}_#{son} = #{father.camelcase}.find(params[:#{father.underscore}_id])\n    end\n"
+      end
+
+      # String of the callback to add within the son_module controller
+      def str_callback_ctrl(father)
+        "\n    before_action :set_#{father.underscore}\n"
+      end
+
+      # Add variables to path of son_module views
+      def inject_variable(father, son, file)
+        if file.eql?("_form")
+          inject_into_file(
+            "app/views/admin/#{args[0].pluralize}/#{file}.html.haml",
+            "(@#{father.underscore}_#{son.underscore}, @#{son.underscore})",
+            after: "admin_#{father.underscore}_#{son.underscore}_path"
+          )
+        end
+        inject_into_file(
+          "app/views/admin/#{args[0].pluralize}/#{file}.html.haml",
+          "@#{father.underscore}_#{son.underscore}, ",
+          before: "@#{son.underscore})"
+        )
+      end
+
+      # Inject variable to _listing view of son_module
+      def inject_listing(father, son, file)
+        inject_into_file(
+          "app/views/admin/#{args[0].pluralize}/_listing.html.haml",
+          "@#{father.underscore}_#{son.underscore},",
+          after: "_path("
+        )
+      end
+
+
+      # References to add nest button in father_module's listing
+      def str_last_button(father)
+        " - if can?(#{father.camelcase}).show?"
+      end
+
+      #String of the button to add in father_module's listing
+      def str_btn(father, son)
+        "\n					%li.center\n						= link_to admin_#{father}_#{son.pluralize}_path(#{father}), class: 'btn-floating waves-effect btn-flat tooltipped', title: t('keppler.sidebar-menu.#{son.pluralize}') do\n							-# = material_icon.md_24.add_circle_outline.css_class('md-dark')\n"
+      end
+    end
+  end
+end