adminos 1.0.0.pre.rc.1

data/lib/generators/adminos/adminos_generator.rb

@@ -0,0 +1,164 @@
+require 'rails/generators/active_record'
+
+module Adminos::Generators
+  class AdminosGenerator < ActiveRecord::Generators::Base
+    desc 'Creates defined model, migration and adds adminos-structured files'
+
+    source_root File.expand_path '../../templates/adminos', __FILE__
+
+    argument :attributes, type: :array, default: []
+    hook_for :orm, required: true, as: :model
+
+    class_option :type, type: :string, enum: Dir["#{source_root}/types/*"].map(&File.method(:basename)), default: 'default', desc: 'Model type'
+    class_option :locale, type: :boolean
+    class_option :search, type: :string
+    class_option :seo, type: :boolean, default: true, desc: 'Include SEO fields in generated model'
+
+    def extend_model
+      model = "app/models/#{file_name}.rb"
+      if File.exist?(model)
+        inject_into_file model, file_content('model_includes.rb', true), after: /ApplicationRecord\n/
+        inject_into_file model, erb_file_content('model.rb', true), before: /^\Snd\n/
+      end
+    end
+
+    def extend_migration
+      file = Dir.glob('db/migrate/*.rb').grep(/\d+_create_#{table_name}.rb$/).first
+
+      return unless file
+      inject_into_file file, file_content('migration.rb', true), after: /create_table.*\n/
+
+      if drag_type?
+        inject_into_file file, "\n\n    add_index :#{table_name}, :parent_id\n    add_index :#{table_name}, :rgt", after: /    end/
+      end
+
+      unless options.seo?
+        gsub_file(file, /^.+(:meta_description|:meta_title)$/, '')
+      end
+    end
+
+    def extend_routes
+      inject_into_file 'config/routes.rb', route_content, after: 'namespace :admin do'
+    end
+
+    def extend_navbar
+      inject_into_file 'app/views/shared/admin/_sidebar.slim', erb_file_content('sidebar.slim'), after: /.*nav__group-content--other\n/
+    end
+
+    def extend_locale
+      locale_path = File.exist?('config/locales/adminos.ru.yml') ? 'config/locales/adminos.ru.yml' : 'config/locales/ru.yml'
+      inject_into_file locale_path, erb_file_content('adminos.ru.yml'), before: /.*helps:\n/
+    end
+
+    def create_controller
+      template "types/#{options.type}/controller.rb.erb", "app/controllers/admin/#{table_name}_controller.rb"
+    end
+
+    def copy_views
+      template 'fields.slim', "app/views/admin/#{table_name}/_fields.slim"
+      directory "types/#{options.type}/views", "app/views/admin/#{table_name}"
+    end
+
+    def locale_specific_actions
+      return unless options.locale? || attributes.map(&:locale).any?
+
+      template 'locales/locale_fields.slim', "app/views/admin/#{table_name}/_locale_fields.slim"
+      template 'locales/general_fields.slim', "app/views/admin/#{table_name}/_general_fields.slim" #unless attributes.map(&:locale).delete_if{|e| e == true}.blank?
+      remove_file "app/views/admin/#{table_name}/_fields.slim"
+
+      if File.exist?("app/models/#{file_name}.rb")
+        inject_into_file "app/models/#{file_name}.rb", erb_file_content('locales/model.rb.erb'), before: /^\Snd\n/
+      end
+      comment_lines "app/models/#{file_name}.rb", /validates :name/
+
+      if File.exist?("app/controllers/admin/#{table_name}_controller.rb")
+        inject_into_file "app/controllers/admin/#{table_name}_controller.rb", "            filter_by_locale: true,\n", before: /.*find_by_slug.*\n/
+      end
+
+      migration_template 'locales/migration.rb.erb', "db/migrate/add_translation_table_to_#{file_name}.rb"
+
+      unless options.seo?
+        file = Dir.glob('db/migrate/*.rb').grep(/\d+_add_translation_table_to_#{file_name}.rb$/).first
+        gsub_file(file, /.+(meta_description|meta_title).+/, '')
+      end
+    end
+
+    def sort_specific_actions
+      return unless attributes.map(&:sort).any? || table_type?
+      inject_into_file "app/views/admin/#{table_name}/index.slim", erb_file_content('sorts/headers.slim'), before: /.*\%th\.icon.*\n/
+      inject_into_file "app/views/admin/#{table_name}/index.slim", erb_file_content('sorts/body.slim'), before: /.*\%td= object_link_edit\(object\).*\n/
+    end
+
+    def search_specific_actions
+      return unless options.search?
+
+      inject_into_file "app/models/#{file_name}.rb", "\n  scoped_search on: #{options.search.split(',').map { |s| s.strip.to_sym }}\n", before: /^\Snd\n/
+      inject_into_file "app/views/admin/#{table_name}/index.slim", "\n= render 'shared/admin/search_form'\n", after: /= collection_header\n/
+      inject_into_file "app/controllers/admin/#{table_name}_controller.rb", '.search_for(params[:query])', after: /.*\|\|\= collection_orig/
+    end
+
+    protected
+
+    def file_content(file, type = nil)
+      prefix = type ? 'types/' + target_type + '/' : ''
+      IO.read find_in_source_paths prefix + file
+    end
+
+    def erb_file_content(file, type = nil)
+      ERB.new(file_content(file, type), nil, '-').result(instance_eval('binding'))
+    end
+
+    def target_type
+      table_type? ? 'default' : options.type
+    end
+
+    def table_type?
+      options.type == 'table'
+    end
+
+    def drag_type?
+      %w[section sortable].include? options.type
+    end
+
+    def route_content
+      spaces = (options.locale? || attributes.map(&:locale).any? ? '      ' : '    ')
+
+      if drag_type?
+        <<-eos
+
+#{spaces}resources :#{table_name}, except: :show do
+#{spaces}  collection { post :batch_action }
+#{spaces}  member { put :drop }
+#{spaces}  member { post :duplication }
+#{spaces}end
+eos
+      else
+        <<-eos
+
+#{spaces}resources :#{table_name}, except: :show do
+#{spaces}  collection { post :batch_action }
+#{spaces}  member { post :duplication }
+#{spaces}end
+eos
+      end
+    end
+  end
+end
+
+# Extend rails to add locale instance variable to attribute
+module Rails::Generators
+  module ExtraAttribute
+    attr_accessor :locale, :sort
+
+    def initialize(name, type = nil, index_type = false, attr_options = {})
+      @locale = true if index_type == 'locale'
+      @sort   = true if index_type == 'sort'
+
+      super
+    end
+  end
+
+  class GeneratedAttribute
+    prepend ExtraAttribute
+  end
+end

data/lib/generators/adminos/ci_generator.rb

@@ -0,0 +1,124 @@
+require 'adminos/generators/utilities'
+require 'rails/generators/base'
+
+module Adminos::Generators
+  class CiGenerator < Rails::Generators::Base
+    include Utilities
+
+    desc 'Set up CI'
+
+    source_root File.expand_path '../../templates/ci', __FILE__
+
+    # ActiveRecord::Generators::Base requires a NAME parameter.
+    argument :name, type: :string, default: 'random_name'
+
+    # options
+    class_option :gitlab, type: :boolean, default: true, desc: 'Set up Gitlab CI'
+
+    TEST_STEPS = {
+      audit: {
+        desc: 'Audit dependencies using bundler-audit',
+        gemfile: true,
+        binstubs: %w[bundler-audit],
+        rakelib: true,
+        ci_job: <<~YAML
+          script: bin/rake bundle:audit
+        YAML
+      },
+      spec: {
+        desc: 'Specify application with RSpec',
+        gemfile: true,
+        binstubs: %w[rspec-core],
+        ci_job: <<~YAML
+          script: bin/rake spec
+          artifacts:
+            paths:
+              - coverage/
+              - spec/examples.txt
+        YAML
+      },
+      lint: {
+        desc: 'Lint dependencies with RuboCop',
+        gemfile: true,
+        rakelib: true,
+        binstubs: %w[rubocop],
+        ci_job: <<~YAML
+          script: bin/rubocop
+          allow_failure: true
+        YAML
+      }
+    }
+
+    TEST_STEPS.each do |name, default: true, desc:, **|
+      class_option name, type: :boolean, default: default, desc: desc
+    end
+
+    def bundle_dependencies
+      gems = []
+      TEST_STEPS.each do |name, gemfile: false, binstubs: [], **|
+        next unless options[name]
+
+        merge_gemfile_with("#{name}/Gemfile") if gemfile
+        gems += binstubs
+      end
+      install_dependencies
+      binstubs(*gems)
+    end
+
+    def setup_rakelib
+      TEST_STEPS.each do |name, rakelib: false, **|
+        next unless options[name] && rakelib
+
+        copy_file "rakelib/#{name}.rake"
+      end
+    end
+
+    def setup_gitlab
+      return unless options.gitlab?
+
+      template '.gitlab-ci.yml'
+      TEST_STEPS.each do |name, ci_job: true, **|
+        next unless options[name] && ci_job
+
+        ci_job name, ci_job
+      end
+    end
+
+    def setup_rspec
+      return unless options.spec?
+
+      # Generate standard RSpec configuration
+      generate 'rspec:install'
+
+      # Uncomment good defaults
+      gsub_file 'spec/spec_helper.rb', /\n=begin\n/, "\n"
+      gsub_file 'spec/spec_helper.rb', /\n=end\n/, "\n"
+
+      # Inject Adminos helpers
+      inject_into_file 'spec/rails_helper.rb', after: "RSpec.configure do |config|\n" do
+        indent_code(<<~RUBY) << "\n"
+          config.include FactoryBot::Syntax::Methods
+          config.include ActionDispatch::TestProcess
+
+          config.before :suite do
+            DatabaseCleaner.strategy = :truncation
+          end
+        RUBY
+      end
+    end
+
+    def setup_rubocop
+      return unless options.lint?
+
+      template 'lint/rubocop.yml', '.rubocop.yml'
+      run_in_root 'bin/rubocop --auto-gen-config &>/dev/null'
+    end
+
+    private
+
+    def ci_job(name, contents)
+      job = "#{name}:\n#{contents.gsub(/^/, '  ')}"
+      append_file '.gitlab-ci.yml', job
+    end
+  end
+end

data/lib/generators/adminos/field_generator.rb

@@ -0,0 +1,105 @@
+require 'rails/generators/active_record'
+
+module Adminos::Generators
+  class FieldGenerator < ActiveRecord::Generators::Base
+    desc 'Creates defined model, migration and adds adminos-structured files'
+
+    source_root File.expand_path '../../templates/field', __FILE__
+
+    argument :attributes, type: :array, default: []
+
+    def generated_locale_migration
+      return unless attributes.any?(&:locale)
+      attrs = attributes.select(&:locale).map(&:name).join('_')
+      raise "You should add support for globalize: table: #{table_name} and fields: #{attrs}" if !model_tranlated?
+
+      migration_template 'locales/migration.rb.erb', "db/migrate/add_translation_fields_#{attrs}_to_#{file_name}.rb"
+    end
+
+    def generated_migration
+      return if attributes.all?(&:locale)
+
+      attrs = attributes.reject(&:locale).map(&:name).join('_')
+      attrs_with_type = attributes.reject(&:locale).map { |a| "#{a.name}:#{a.type}" }.join(' ')
+
+      system %( rails generate migration add_#{attrs}_to_#{file_name} #{attrs_with_type} )
+    end
+
+    def extend_model
+      return unless attributes.any?(&:locale)
+
+      attrs = attributes.select(&:locale).map { |a| ":#{a.name}" }.join(', ')
+
+      if model_tranlated?
+        inject_into_file "app/models/#{file_name}.rb", attrs, after: /translates /
+      else
+        inject_into_file "app/models/#{file_name}.rb", erb_file_content('locales/model.rb.erb'), before: /^\Snd\n/
+        comment_lines "app/models/#{file_name}.rb", /validates :name/
+      end
+    end
+
+    def extend_locale_view
+      return unless attributes.any?(&:locale)
+
+      attrs = attributes.select(&:locale).map { |a| "  = f.input :#{a.name}\n" }.compact.join
+
+      locale_fields_path = "app/views/admin/#{table_name}/_locale_fields.slim"
+
+      if File.exist?(locale_fields_path)
+        append_file "app/views/admin/#{table_name}/_locale_fields.slim", attrs
+      else
+        template 'locales/locale_fields.slim', "app/views/admin/#{table_name}/_locale_fields.slim"
+      end
+    end
+
+    def extend_view
+      return if attributes.all?(&:locale)
+
+      attrs = attributes.reject(&:locale).map { |a| "  = f.input :#{a.name}\n" }.compact.join
+      append_file "app/views/admin/#{table_name}/_fields.slim", attrs
+    end
+
+    def extend_locale_file
+      locale_path = File.exist?('config/locales/adminos.ru.yml') ? 'config/locales/adminos.ru.yml' : 'config/locales/ru.yml'
+      locale = YAML.load(File.read(locale_path))
+
+      attributes.map(&:name).each do |a|
+        if locale['ru']['activerecord']['attributes'][table_name.singularize]
+          locale['ru']['activerecord']['attributes'][table_name.singularize][a] = a
+        else
+          locale['ru']['activerecord']['attributes'].merge!("#{table_name.singularize}" => { a => a })
+        end
+      end
+
+      File.open(locale_path, 'w') { |f| f.write(YAML.dump(locale)) }
+    end
+
+    private
+
+    def file_content(file, type = nil)
+      prefix = type ? 'types/' + target_type + '/' : ''
+      IO.read find_in_source_paths prefix + file
+    end
+
+    def erb_file_content(file, type = nil)
+      ERB.new(file_content(file, type), nil, '-').result(instance_eval('binding'))
+    end
+
+    def model_tranlated?
+      table_name.singularize.classify.constantize.translates?
+    end
+  end
+end
+
+# Extend rails to add locale instance variable to attribute
+module Rails::Generators
+  class GeneratedAttribute
+    attr_accessor :locale
+
+    def initialize_with_attributes(name, type = nil, index_type = false, attr_options = {})
+      @locale = true if index_type == 'locale'
+      initialize_without_attributes name, type, index_type, attr_options
+    end
+    alias_method_chain :initialize, :attributes
+  end
+end

data/lib/generators/adminos/i18n_generator.rb

@@ -0,0 +1,76 @@
+require "adminos/generators/utilities"
+require "rails/generators/actions"
+require "rails/generators/active_record/migration"
+require "rails/generators/base"
+
+module Adminos::Generators
+  class I18nGenerator < Rails::Generators::Base
+    include ActiveRecord::Generators::Migration
+    include Utilities
+
+    desc 'Set up I18n'
+    source_root File.expand_path '../../templates/i18n', __FILE__
+
+    class_option :devise, type: :boolean, desc: 'Add Devise views (login page, etc...) and locales?', default: false
+    class_option :russian, type: :boolean, default: true
+    class_option :locales, type: :array, default: %w[ru en]
+    class_option :pages, type: :boolean, default: false
+
+    def bundle_dependencies
+      merge_gemfile_with('Gemfile')
+      install_dependencies
+    end
+
+    def configure_application
+      inject_into_file 'config/application.rb', "    config.i18n.available_locales = #{available_locales}\n", after: /Rails::Application\n/
+    end
+
+    def localize_russian
+      return unless options.russian?
+
+      inject_into_file 'config/application.rb', "    config.time_zone = 'Moscow'\n", after: /Rails::Application\n/
+      inject_into_file 'config/application.rb', "    config.i18n.default_locale = :ru\n", after: /Rails::Application\n/
+    end
+
+    def localize_devise
+      return unless options.devise?
+
+      directory 'devise/views', 'app/views/devise', mode: :preserve
+      copy_file 'devise/devise.ru.yml', 'config/locales/devise.ru.yml'
+    end
+
+    def inject_routes
+      inject_into_file 'config/routes.rb', '  ', before: /  .*/, force: true
+      inject_into_file 'config/routes.rb', "\n  scope '(:locale)', locale: /\#{I18n.available_locales.join('|')}/ do \n", before: /namespace/
+      inject_into_file 'config/routes.rb', '  ', before: /namespace/, force: true
+      inject_into_file 'config/routes.rb', "\n  end", after: /.*root to: 'index#index'/
+
+      inject_into_file 'app/controllers/application_controller.rb', ', :set_locale', after: /.*before_action :reload_routes/
+      inject_into_file 'app/controllers/application_controller.rb', file_content('controller.rb'), after: /.*protected\n/
+
+      inject_into_file 'app/views/shared/admin/_footer.slim', file_content('locales.slim'), after: /.*wrapper\n/
+    end
+
+    def localize_pages
+      return unless options.pages?
+
+      migration_template 'add_translation_table_to_page.rb', 'db/migrate/add_translation_table_to_page.rb'
+      inject_into_file 'app/models/page.rb', file_content('page.rb'), before: /.*BEHAVIORS = .*/
+      comment_lines 'app/models/page.rb', /validates :name/
+      inject_into_file 'app/models/page.rb', ', :translations_attributes', after: /.*:parent_id, :published/
+      inject_into_file 'app/controllers/admin/pages_controller.rb', "            filter_by_locale: true,\n", after: /.*[:sorted],\n/
+      inject_into_file 'app/controllers/application_controller.rb', "  before_action :check_page_name_locale, unless: -> { controller_path.split('/').first == 'admin' }", after: /.*before_action.*\n/
+      remove_file 'app/views/admin/pages/_fields.slim'
+    end
+
+    def inject_files
+      directory 'auto', '.'
+    end
+
+    private
+
+    def available_locales
+      options.locales.reject(&:blank?).map { |s| s.strip.to_sym }.unshift(:ru).uniq
+    end
+  end
+end