superuser 0.2.2 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca5f9b99d69ab6be91c64b8b59d81a8c3e6c4b09d6a339371e3fa8c30db8175c
-  data.tar.gz: c006c02556167bf7271cf35419f9715fdcc26c75ac94860678cc3e3ec50870e9
+  metadata.gz: 9a1c31d05b650f4b02d719b16ac734f688688cd851a6385c501f6f690808f7ec
+  data.tar.gz: e6d0c6a36beb2545af0aade3a658dd547477a5a579ce909d6d33aaf231fb02af
 SHA512:
-  metadata.gz: b5af5cc4a9b5bfcf1e162fd6e3d52f1fa2b50b873c20d306dabae5e11d7758d788e7fc745f0741ff7995b968ac88141e2b2713c186fb18f422d09240facde2f9
-  data.tar.gz: a766b2a731841dad2bbbffc95e779543322f88fa0172e5c1c79f5a213f7d816f398ed589cf44dad5286d0f3703a42ad3f6e2b4ddd3ac96878cdc70dc1fb2b296
+  metadata.gz: '08455a1986f43b3ce7223ca6d65922ba577ae9a89ac4d734c6841833522ee8cf4cbab8d88b34fe2ba1ef759a94cb019733eb5b78baf8105c71abcd79946aea48'
+  data.tar.gz: a146ab5ac8596eedea709007a93b59e584f394ba22e32c244b6dcef84369cd021efc6107f319d083dc522de08380522078a0e3ffcd6c55bc435e519ab028c8a6

data/lib/generators/superuser/USAGE

@@ -1,8 +1,21 @@
 Description:
-    Explain the generator
+  Generate scaffolding for you rails admin area using the command "rails g superuser name_of_your_resource"
 
 Example:
-    rails generate superuser Thing
+  rails generate superuser users
 
-    This will create:
-        what/will/it/create
+  This will create:
+    controllers/superuser/users_controller.rb
+    views/superuser/index.html.erb
+    views/superuser/new.html.erb
+    views/superuser/show.html.erb
+    views/superuser/edit.html.erb
+    views/superuser/_form.html.erb
+
+  + will create some base/shared files if they don't exists:
+    assets/javascripts/superuser/application.js
+    assets/stylesheets/superuser/application.scss
+    controllers/superuser/base_controller.rb
+    controllers/superuser/dashboard_controller.rb
+    views/layouts/superuser/application.html.erb
+    views/shared/_search.html.erb

data/lib/generators/superuser/init_generator.rb

@@ -0,0 +1,123 @@
+class Superuser::InitGenerator < Rails::Generators::Base
+
+  source_root File.expand_path('../templates', __FILE__)
+  argument :frontend, type: :string, default: 'webpacker'
+
+  def generate_css_file
+    superuser_css_file = "#{stylesheets_folder()}/superuser.scss"
+    if !File.exist?(superuser_css_file)
+      copy_file "superuser_base.scss", superuser_css_file
+    end
+  end
+
+  def generate_js_file
+    superuser_js_file = "#{javascripts_folder()}/superuser.js"
+    if !File.exist?(superuser_js_file)
+    	copy_file "superuser_base.js", superuser_js_file
+    end
+  end
+
+  def generate_layout
+    superuser_layout_file = "app/views/layouts/superuser/application.html.erb"
+    if !File.exist?(superuser_layout_file)
+      template "views/layouts/application.html.erb", superuser_layout_file
+    end
+  end
+
+  def generate_base_controller
+    superuser_base_controller = "app/controllers/superuser/base_controller.rb"
+    if !File.exist?(superuser_base_controller)
+      copy_file "base_controller.rb", superuser_base_controller
+    end
+  end
+
+  def generate_dashboard_controller
+    superuser_dashboard_controller = "app/controllers/superuser/dashboard_controller.rb"
+    if !File.exist?(superuser_dashboard_controller)
+      copy_file "dashboard_controller.rb", superuser_dashboard_controller
+
+      copy_file "views/dashboard_index.html.erb", "app/views/superuser/dashboard/index.html.erb"
+
+      add_layout_links 'app/views/layouts/superuser/application.html.erb', search = '<div class="sidebar_dashboard_link">', "<%= link_to 'dashboard', [:superuser, :root] %>"
+    end
+  end
+
+  def add_base_route
+    path = File.join(destination_root, 'config/routes.rb')
+    file_content = File.read(path)
+    # if namespace for :superuser don't exists then create it
+    unless file_content.include? 'namespace :superuser do'
+      route "\tnamespace :superuser do\n\t\troot to: 'dashboard#index'\n\tend\n"
+    end
+  end
+
+  def generate_search_form
+    template "views/_search.html.erb", "app/views/shared/superuser/_search.html.erb"
+  end
+
+  # in case of user is using webpack_native gem then add an entry pointing to superuser "application" javascript file
+  def add_entry_to_webpack_native_config
+    if for_webpack_native
+
+      webpack_config_file = "#{Rails.root}/app/webpack_native/webpack.config.js"
+
+      entry_line = "\n\t\t\tsuperuser: './src/javascripts/superuser/application.js',"
+
+      path = File.join(destination_root, 'app/webpack_native/webpack.config.js')
+      file_content = File.read(path)
+
+      if file_content.include? 'entry: {'
+        inject_into_file webpack_config_file, entry_line, :after => 'entry: {'
+        puts separator_line
+        note = "Restart rails server (in case it's running) for updates to take place in webpack.config.js"
+        puts "\e[33m#{note}\e[0m"
+        puts separator_line
+      else
+        puts separator_line
+        puts "You need to add the following entry to your webpack.config.js, i.e:\n\n"
+        entry = "entry: { \n  superuser: './src/javascripts/superuser/application.js',\n  // ...\n}"
+        puts "\e[32m#{entry}\e[0m"
+        note = "\nNote: do not forget to restart your server after that!"
+        puts "\e[33m#{note}\e[0m"
+        puts separator_line
+      end
+    end
+  end
+
+  private
+
+    def separator_line
+      "\n"+ ("~" * 60) +"\n\n"
+    end
+
+    def for_webpack_native
+      frontend.include?('webpack_native') || frontend.include?('webpackNative')
+    end
+
+    def stylesheets_folder
+      if for_webpack_native
+        'app/webpack_native/src/stylesheets'
+      else
+        'app/assets/stylesheets'
+      end
+    end
+
+    def javascripts_folder
+      if for_webpack_native
+        'app/webpack_native/src/javascripts'
+      else
+        'app/javascript/packs'
+      end
+    end
+
+    def add_layout_links(relative_file, search_text, replace_text)
+      path = File.join(destination_root, relative_file)
+      file_content = File.read(path)
+
+      unless file_content.include? replace_text
+        content = file_content.sub(/(#{Regexp.escape(search_text)})/mi, "#{search_text}\n\t\t\t\t#{replace_text}")
+        File.open(path, 'wb') { |file| file.write(content) }
+      end
+    end
+
+end

data/lib/generators/superuser/superuser_generator.rb

@@ -1,205 +1,136 @@
 class SuperuserGenerator < Rails::Generators::Base
 
-    source_root File.expand_path('../templates', __FILE__)
-    argument :resources_name, type: :string
-    attr_accessor :attributes
-
-    # NOTE: the order of the following methods is important!
-    
-    def generate_css_file
-
-        if !File.exist?("app/assets/stylesheets/superuser/application.scss")
-            copy_file "superuser_base.scss", "app/assets/stylesheets/superuser/application.scss"
-          end
-
-    end
-
-    def generate_js_file
-
-        if !File.exist?("app/assets/javascripts/superuser/application.js")
-        	copy_file "superuser_base.js", "app/assets/javascripts/superuser/application.js"
-        	end
-
-    end
-
-    def generate_layout
-
-        if !File.exist?("app/views/layouts/superuser/application.html.erb")
-            template "views/layouts/application.html.erb", "app/views/layouts/superuser/application.html.erb"
-        end
-
-    end
-
-    def generate_controller
-
-        if !File.exist?("app/controllers/superuser/base_controller.rb")
-            copy_file "base_controller.rb", "app/controllers/superuser/base_controller.rb"
-        end
-        if !File.exist?("app/controllers/superuser/dashboard_controller.rb")
-            copy_file "dashboard_controller.rb", "app/controllers/superuser/dashboard_controller.rb"
-            copy_file "views/dashboard_index.html.erb", "app/views/superuser/dashboard/index.html.erb"
-            route "\tnamespace :superuser do\n\t\troot to: 'dashboard#index'\n\tend"
-            add_layout_links 'app/views/layouts/superuser/application.html.erb', search = '<div class="sidebar_dashboard_link">', "<%= link_to 'dashboard', [:superuser, :root] %>"
-        end
-        template "controller_template.rb", "app/controllers/superuser/#{naming(:resources)}_controller.rb"
-
-    end
-
-    def generate_route_and_link
-
-        # add resources to route if not exists
-        route_replacement = "resources :#{resources}"
-        r = add_resources_route 'config/routes.rb', search = 'namespace :superuser do', route_replacement
-
-        # add link to resources in the layout if not exists
-        link = "<%= link_to '#{resources}', [:superuser, :#{resources}] %>"
-        add_layout_links 'app/views/layouts/superuser/application.html.erb', search = '<div class="sidebar_item">', link
-
-    end
-
-    def generate_views
-
-        template "views/_form.html.erb", "app/views/superuser/#{naming(:resources)}/_form.html.erb"
-        template "views/index.html.erb", "app/views/superuser/#{naming(:resources)}/index.html.erb"
-        template "views/show.html.erb", "app/views/superuser/#{naming(:resources)}/show.html.erb"
-        template "views/new.html.erb", "app/views/superuser/#{naming(:resources)}/new.html.erb"
-        template "views/edit.html.erb", "app/views/superuser/#{naming(:resources)}/edit.html.erb"
-
-    end
-
-    def generate_search_form
-
-        template "views/_search.html.erb", "app/views/shared/_search.html.erb"
-
-    end
+  source_root File.expand_path('../templates', __FILE__)
+  argument :resources_name, type: :string
+  attr_accessor :attributes
+
+  # NOTE: the order of the following methods is important!
+
+  def generate_controller
+    template "controller_template.rb", "app/controllers/superuser/#{naming(:resources)}_controller.rb"
+  end
+
+  def generate_route_and_link
+    # add resources to route if not exists
+    route_replacement = "resources :#{resources}"
+    r = add_resources_route 'config/routes.rb', search = 'namespace :superuser do', route_replacement
+
+    # add link to resources in the layout if not exists
+    link = "<%= link_to '#{resources}', [:superuser, :#{resources}] %>"
+    add_layout_links 'app/views/layouts/superuser/application.html.erb', search = '<div class="sidebar_item">', link
+  end
+
+  def generate_views
+    template "views/_form.html.erb", "app/views/superuser/#{naming(:resources)}/_form.html.erb"
+    template "views/index.html.erb", "app/views/superuser/#{naming(:resources)}/index.html.erb"
+    template "views/show.html.erb", "app/views/superuser/#{naming(:resources)}/show.html.erb"
+    template "views/new.html.erb", "app/views/superuser/#{naming(:resources)}/new.html.erb"
+    template "views/edit.html.erb", "app/views/superuser/#{naming(:resources)}/edit.html.erb"
+  end
 
   private
 
     def replace(file_path)
-
-        gsub_file file_path, 'resources', "#{naming(:resources)}"
-        gsub_file file_path, 'resource', "#{naming(:resource)}"
-        gsub_file file_path, 'ControllerName', "#{naming(:controller_name)}"
-        gsub_file file_path, 'ModelName', "#{naming(:model_name)}"
-
+      gsub_file file_path, 'resources', "#{naming(:resources)}"
+      gsub_file file_path, 'resource', "#{naming(:resource)}"
+      gsub_file file_path, 'ControllerName', "#{naming(:controller_name)}"
+      gsub_file file_path, 'ModelName', "#{naming(:model_name)}"
     end
 
     def resources
-
-        resources_name.underscore
-
+      resources_name.underscore
     end
 
     def resource
-
-        resources_name.singularize.underscore
-
+      resources_name.singularize.underscore
     end
 
     def get_controller_name
-
-        resources_name.camelize
-
+      resources_name.camelize
     end
 
     def naming(key)
-
-        map = {
-          resources: resources_name.underscore,
-          resource: resources_name.singularize.underscore,
-          controller_name: resources_name.camelize,
-          model_name: resources_name.classify
-        }
-        return map[key]
-
+      map = {
+        resources: resources_name.underscore,
+        resource: resources_name.singularize.underscore,
+        controller_name: resources_name.camelize,
+        model_name: resources_name.classify
+      }
+      return map[key]
     end
 
     def model_columns_for_attributes
-
-        resources_name.classify.constantize.columns.reject do |column|
-          column.name.to_s =~ /^(id|user_id|created_at|updated_at)$/
-        end
-
+      resources_name.classify.constantize.columns.reject do |column|
+        column.name.to_s =~ /^(id|user_id|created_at|updated_at)$/
+      end
     end
 
     def editable_attributes
-
-        attributes ||= model_columns_for_attributes.map do |column|
-          {name: column.name.to_s, type: column.type.to_s}
-        end
-
+      attributes ||= model_columns_for_attributes.map do |column|
+        {name: column.name.to_s, type: column.type.to_s}
+      end
     end
 
     def get_model
-
-        resources_name.classify.constantize
-
+      resources_name.classify.constantize
     end
 
     def get_resource_attributes
-
-        editable_attributes.map { |a| a.name.prepend(':') }.join(', ')
-
+      editable_attributes.map {
+        |a| a.name.prepend(':')
+      }.join(', ')
     end
 
     def field_type(db_type)
-
-        matching_type = {
-                          decimal: "text_field",
-                          float: "text_field",
-                          datetime: "text_field",
-                          string: "text_field",
-                          integer: "text_field",
-                          text: "text_area",
-                          json: "text_area",
-                          jsonb: "text_area"
-                      }
-        matching_type[db_type.to_sym] || "text_field"
-
+      matching_type = {
+        decimal: "text_field",
+        float: "text_field",
+        datetime: "text_field",
+        string: "text_field",
+        integer: "text_field",
+        text: "text_area",
+        json: "text_area",
+        jsonb: "text_area"
+      }
+      matching_type[db_type.to_sym] || "text_field"
     end
 
     def destination_path(path)
-
-        File.join(destination_root, path)
-
+      File.join(destination_root, path)
     end
 
     # sub_file modified
     def add_resources_route(relative_file, search_text, replace_text)
+      path = destination_path(relative_file)
+      file_content = File.read(path)
 
-        path = destination_path(relative_file)
-        file_content = File.read(path)
-
-        # if namespace for :superuser don't exists then create it
-        unless file_content.include? 'namespace :superuser do'
-            route "\tnamespace :superuser do\n\t\tresources :#{resources}\n\tend"
-            return
-        end
+      # if namespace for :superuser don't exists then create it
+      unless file_content.include? 'namespace :superuser do'
+        route "\tnamespace :superuser do\n\t\tresources :#{resources}\n\tend"
+        return
+      end
 
-        # the regular expression string should be between single quotes not double quotes
-        # the regular expression string should not include delimiters
-        # the matching will stop when find the first occurence of 'end'
-        regex_string = 'namespace \:superuser do[^end]*' + replace_text
-        regex = Regexp.new(regex_string)
-
-        #unless file_content.include? replace_text
-        unless regex.match file_content
-            content = file_content.sub(/(#{Regexp.escape(search_text)})/mi, "#{search_text}\n\t\t#{replace_text}")
-            File.open(path, 'wb') { |file| file.write(content) }
-        end
+      # the regular expression string should be between single quotes not double quotes
+      # the regular expression string should not include delimiters
+      # the matching will stop when find the first occurence of 'end'
+      regex_string = 'namespace \:superuser do[^end]*' + replace_text
+      regex = Regexp.new(regex_string)
 
+      #unless file_content.include? replace_text
+      unless regex.match file_content
+        content = file_content.sub(/(#{Regexp.escape(search_text)})/mi, "#{search_text}\n\t\t#{replace_text}")
+        File.open(path, 'wb') { |file| file.write(content) }
+      end
     end
 
     def add_layout_links(relative_file, search_text, replace_text)
+      path = destination_path(relative_file)
+      file_content = File.read(path)
 
-        path = destination_path(relative_file)
-        file_content = File.read(path)
-
-        unless file_content.include? replace_text
-          content = file_content.sub(/(#{Regexp.escape(search_text)})/mi, "#{search_text}\n\t\t\t\t#{replace_text}")
-          File.open(path, 'wb') { |file| file.write(content) }
-        end
-
+      unless file_content.include? replace_text
+        content = file_content.sub(/(#{Regexp.escape(search_text)})/mi, "#{search_text}\n\t\t\t\t#{replace_text}")
+        File.open(path, 'wb') { |file| file.write(content) }
+      end
     end
 
 end