fae-railsz 2.1.0

data/lib/generators/fae/controller_generator.rb

@@ -0,0 +1,13 @@
+require_relative 'base_generator'
+module Fae
+  class ControllerGenerator < Fae::BaseGenerator
+    source_root ::File.expand_path('../templates', __FILE__)
+
+    def go
+      generate_controller_file
+      generate_view_files
+      add_route
+    end
+
+  end
+end

data/lib/generators/fae/install_generator.rb

@@ -0,0 +1,61 @@
+module Fae
+  class InstallGenerator < Rails::Generators::Base
+    source_root ::File.expand_path('../templates', __FILE__)
+    class_option :namespace, type: :string, default: 'admin', desc: 'Sets the namespace of the generator'
+    class_option :fine, type: :boolean, default: false, desc: 'Sets FINE\'s defaults'
+
+    def install
+      run 'bundle install'
+      add_route
+      # copy templates and generators
+      copy_file ::File.expand_path(::File.join(__FILE__, "../templates/tasks/fae_tasks.rake")), "lib/tasks/fae_tasks.rake"
+      add_fae_assets
+      add_navigation_concern
+      add_authorization_concern
+      build_initializer
+      build_judge_initializer
+      rake 'fae:install:migrations'
+      rake 'db:migrate'
+      rake 'fae:seed_db'
+    end
+
+  private
+
+    def add_route
+      inject_into_file "config/routes.rb", after: "routes.draw do\n" do <<-RUBY
+\n  namespace :#{options.namespace} do
+  end
+  # mount Fae below your admin namespec
+  mount Fae::Engine => '/#{options.namespace}'\n
+RUBY
+      end
+    end
+
+    def add_fae_assets
+      copy_file ::File.expand_path(::File.join(__FILE__, '../templates/assets/fae.scss')), 'app/assets/stylesheets/fae.scss'
+      copy_file ::File.expand_path(::File.join(__FILE__, '../templates/assets/fae.js')), 'app/assets/javascripts/fae.js'
+    end
+
+    def add_navigation_concern
+      copy_file ::File.expand_path(::File.join(__FILE__, '../templates/models/concerns/navigation_concern.rb')), 'app/models/concerns/fae/navigation_concern.rb'
+    end
+
+    def add_authorization_concern
+      copy_file ::File.expand_path(::File.join(__FILE__, '../templates/models/concerns/authorization_concern.rb')), 'app/models/concerns/fae/authorization_concern.rb'
+    end
+
+    def build_initializer
+      init_source = options.fine ? "../templates/initializers/fae_fine.rb" : "../templates/initializers/fae.rb"
+      copy_file ::File.expand_path(::File.join(__FILE__, init_source)), "config/initializers/fae.rb"
+      inject_into_file "config/initializers/fae.rb", after: "Fae.setup do |config|\n" do <<-RUBY
+\n  config.devise_secret_key = '#{SecureRandom.hex(64)}'\n
+RUBY
+      end
+    end
+
+    def build_judge_initializer
+      copy_file ::File.expand_path(::File.join(__FILE__, "../templates/initializers/judge.rb")), "config/initializers/judge.rb"
+    end
+
+  end
+end

data/lib/generators/fae/model_generator.rb

@@ -0,0 +1,11 @@
+require_relative 'base_generator'
+module Fae
+  class ModelGenerator < Fae::BaseGenerator
+    source_root ::File.expand_path('../templates', __FILE__)
+
+    def go
+      generate_model
+    end
+
+  end
+end

data/lib/generators/fae/nested_index_scaffold_generator.rb

@@ -0,0 +1,36 @@
+require_relative 'base_generator'
+module Fae
+  class NestedIndexScaffoldGenerator < Fae::BaseGenerator
+    source_root ::File.expand_path('../templates', __FILE__)
+
+    def go
+      generate_model
+      generate_nested_index_controller_file
+      generate_view_files
+      add_route
+      inject_nav_item
+    end
+
+
+    private
+
+      def generate_nested_index_controller_file
+        @attachments = @@attachments
+        template "controllers/nested_index_scaffold_controller.rb", "app/controllers/#{options.namespace}/#{file_name.pluralize}_controller.rb"
+      end
+
+      def generate_view_files
+        @toggle_attrs = set_toggle_attrs
+        @form_attrs = set_form_attrs
+        @association_names = @@association_names
+        @attachments = @@attachments
+        @has_position = @@has_position
+        @display_field = @@display_field
+        template "views/index_nested.html.#{options.template}", "app/views/#{options.namespace}/#{plural_file_name}/index.html.#{options.template}"
+        template "views/_form_index_nested.html.#{options.template}", "app/views/#{options.namespace}/#{plural_file_name}/_form.html.#{options.template}"
+        template "views/new_nested.html.#{options.template}", "app/views/#{options.namespace}/#{plural_file_name}/new.html.#{options.template}"
+        template "views/edit_nested.html.#{options.template}", "app/views/#{options.namespace}/#{plural_file_name}/edit.html.#{options.template}"
+      end
+
+  end
+end

data/lib/generators/fae/nested_scaffold_generator.rb

@@ -0,0 +1,51 @@
+require_relative 'base_generator'
+module Fae
+  class NestedScaffoldGenerator < Fae::BaseGenerator
+    source_root ::File.expand_path('../templates', __FILE__)
+    class_option :parent_model, type: :string, desc: 'Sets the parent model this scaffold belongs_to.'
+
+    def go
+      generate_nested_model_file
+      generate_nested_controller_file
+      generate_view_files
+      add_route
+    end
+
+    private
+
+      def generate_nested_model_file
+        generate "model #{file_name} #{@@attributes_flat}"
+        inject_concern
+        inject_display_field_to_model
+        inject_model_attachments
+        inject_position_scope
+        inject_parent_info if options.parent_model.present?
+      end
+
+      def generate_nested_controller_file
+        @attachments = @@attachments
+        template "controllers/nested_scaffold_controller.rb", "app/controllers/#{options.namespace}/#{file_name.pluralize}_controller.rb"
+      end
+
+      def generate_view_files
+        @form_attrs = set_form_attrs
+        @attachments = @@attachments
+        template "views/table_nested.html.#{options.template}", "app/views/#{options.namespace}/#{plural_file_name}/table.html.#{options.template}"
+        template "views/_form_nested.html.#{options.template}", "app/views/#{options.namespace}/#{plural_file_name}/_form.html.#{options.template}"
+        template "views/new_nested.html.#{options.template}", "app/views/#{options.namespace}/#{plural_file_name}/new.html.#{options.template}"
+        template "views/edit_nested.html.#{options.template}", "app/views/#{options.namespace}/#{plural_file_name}/edit.html.#{options.template}"
+      end
+
+      def inject_parent_info
+        inject_into_file "app/models/#{file_name}.rb", after: "BaseModelConcern\n" do <<-RUBY
+\n  belongs_to :#{options.parent_model.underscore}, touch: true
+
+  def fae_nested_parent
+    :#{options.parent_model.underscore}
+  end
+RUBY
+        end
+      end
+
+  end
+end

data/lib/generators/fae/page_generator.rb

@@ -0,0 +1,65 @@
+require_relative 'base_generator'
+
+module Fae
+  class PageGenerator < Fae::BaseGenerator
+    desc 'Creates model with dependancies for Fae Static Pages'
+    source_root ::File.expand_path('../templates', __FILE__)
+
+    @@attributes = {}
+
+    def set_globals
+      if attributes.present?
+        attributes.each do |attr|
+          @@attributes[attr.name.to_sym] = convert_attr_type(attr.type)
+        end
+      end
+    end
+
+    def go
+      generate_static_page_controller
+      generate_static_page_model
+      generate_static_page_view
+    end
+
+    private
+
+    def generate_static_page_controller
+      file = "app/controllers/#{options.namespace}/content_blocks_controller.rb"
+      if ::File.exists?(Rails.root.join(file).to_s)
+        inject_into_file "app/controllers/#{options.namespace}/content_blocks_controller.rb", ", #{class_name}Page", before: ']'
+      else
+        template 'controllers/static_pages_controller.rb', file
+      end
+    end
+
+    def generate_static_page_model
+      @attributes = @@attributes
+      template "models/pages_model.rb", "app/models/#{file_name}_page.rb"
+    end
+
+    def generate_static_page_view
+      @attributes = @@attributes
+      template "views/static_page_form.html.#{options.template}", "app/views/#{options.namespace}/content_blocks/#{file_name}.html.#{options.template}"
+    end
+
+    def connect_object object
+      object.constantize.connection
+      object
+    end
+
+    def convert_attr_type(type)
+      case type.to_s
+      when "string"
+        connect_object "Fae::TextField"
+      when "text"
+        connect_object "Fae::TextArea"
+      when "image"
+        connect_object "Fae::Image"
+      when "file"
+        connect_object "Fae::File"
+      else
+        type
+      end
+    end
+  end
+end

data/lib/generators/fae/scaffold_generator.rb

@@ -0,0 +1,15 @@
+require_relative 'base_generator'
+module Fae
+  class ScaffoldGenerator < Fae::BaseGenerator
+    source_root ::File.expand_path('../templates', __FILE__)
+
+    def go
+      generate_model
+      generate_controller_file
+      generate_view_files
+      add_route
+      inject_nav_item
+    end
+
+  end
+end

data/lib/generators/fae/templates/assets/fae.js

@@ -0,0 +1,6 @@
+// This file is compiled into fae/application.js
+// use this as another manifest file if you have a lot of javascript to add
+// or just add your javascript directly to this file
+
+// Uncomment the following line if you want to use Trumbowyg HTML Editor
+// //= require fae/vendor/trumbowyg

data/lib/generators/fae/templates/assets/fae.scss

@@ -0,0 +1,2 @@
+// Do Not Delete this page! FAE depends on it in order to set its highlight color.
+// $c-custom-highlight: #9aa142;

data/lib/generators/fae/templates/controllers/nested_index_scaffold_controller.rb

@@ -0,0 +1,81 @@
+module <%= options.namespace.capitalize %>
+  class <%= class_name.pluralize %>Controller < Fae::ApplicationController
+    before_action :set_class_variables
+    before_action :set_item, only: [:show, :edit, :update, :destroy]
+
+    layout false, except: :index
+    helper Fae::ApplicationHelper
+
+    def new
+      @item = <%= class_name %>.new
+    end
+
+    def index
+      @items = <%= class_name %>.for_fae_index
+    end
+
+    def edit
+    end
+
+    def create
+      @item = <%= class_name %>.new(permitted_params)
+
+      if @item.save
+        @items = <%= class_name %>.for_fae_index
+        flash[:notice] = 'Item successfully created.'
+        render template: '<%= options.namespace %>/<%= plural_file_name %>/index'
+      else
+        render action: 'new'
+      end
+    end
+
+    def update
+      if @item.update(permitted_params)
+        @items = <%= class_name %>.for_fae_index
+        flash[:notice] = 'Item successfully updated.'
+        render template: '<%= options.namespace %>/<%= plural_file_name %>/index'
+      else
+        render action: 'edit'
+      end
+    end
+
+    def destroy
+      if @item.destroy
+        flash[:notice] = 'Item successfully removed.'
+      else
+        flash[:alert] = 'There was a problem removing your item.'
+      end
+      @items = <%= class_name %>.for_fae_index
+      render template: '<%= options.namespace %>/<%= plural_file_name %>/index'
+    end
+
+    private
+
+    def set_class_variables(class_name = nil)
+      klass_base = params[:controller].split('/').last
+      @klass_name = class_name || klass_base              # used in form views
+      @klass = klass_base.classify.constantize            # used as class reference in this controller
+      @klass_singular = klass_base.singularize            # used in index views
+      @klass_humanized = @klass_name.singularize.humanize # used in index views
+      @index_path = '/' + params[:controller]             # used in form_header partial
+      @new_path = @index_path + '/new'                    # used in index_header partial
+    end
+
+    def set_item
+      @item = <%= class_name %>.find(params[:id])
+    end
+
+    def permitted_params
+      params.require(:<%= singular_table_name %>).permit!
+    end
+
+<% if @attachments.present? -%>
+    def build_assets
+<% @attachments.each do |attachment| -%>
+      @item.build_<%= attachment.name %> if @item.<%= attachment.name %>.blank?
+<% end -%>
+    end
+<% end -%>
+
+  end
+end

data/lib/generators/fae/templates/controllers/nested_scaffold_controller.rb

@@ -0,0 +1,13 @@
+module <%= options.namespace.capitalize %>
+  class <%= class_name.pluralize %>Controller < Fae::NestedBaseController
+<% if @attachments.present? %>
+    private
+
+    def build_assets
+<% @attachments.each do |attachment| -%>
+      @item.build_<%= attachment.name %> if @item.<%= attachment.name %>.blank?
+<% end -%>
+    end
+<% end %>
+  end
+end

data/lib/generators/fae/templates/controllers/scaffold_controller.rb

@@ -0,0 +1,13 @@
+module <%= options.namespace.capitalize %>
+  class <%= class_name.pluralize %>Controller < Fae::BaseController
+<% if @attachments.present? %>
+    private
+
+    def build_assets
+<% @attachments.each do |attachment| -%>
+      @item.build_<%= attachment.name %> if @item.<%= attachment.name %>.blank?
+<% end -%>
+    end
+<% end %>
+  end
+end

data/lib/generators/fae/templates/controllers/static_pages_controller.rb

@@ -0,0 +1,10 @@
+module <%= options.namespace.capitalize %>
+  class ContentBlocksController < Fae::StaticPagesController
+
+    private
+
+    def fae_pages
+      [<%= "#{class_name}Page" %>]
+    end
+  end
+end

data/lib/generators/fae/templates/initializers/fae.rb

@@ -0,0 +1,63 @@
+Fae.setup do |config|
+
+  ## devise_mailer_sender
+  # This email address will get passed to Devise and
+  # used as the from address in the password reset emails.
+  # config.devise_mailer_sender = 'change-me@example.com'
+
+  ## dashboard_exclusions
+  # The dashboard will show all objects with recent activity.
+  # To exclude any objects, add them to this array.
+  # config.dashboard_exclusions = %w( Gallery )
+
+  ## max_image_upload_size
+  # This will set a file size limit on image uploads in MBs.
+  # The default is 2 MB.
+  # config.max_image_upload_size = 2
+
+  ## max_file_upload_size
+  # This will set a file size limit on file uploads in MBs.
+  # The default is 5 MB.
+  # config.max_file_upload_size = 5
+
+  ## languages
+  # This hash sets the supported languages for the multiple
+  # language toggle feature.
+  # config.languages = {
+  #   en: 'English',
+  #   zh: 'Chinese'
+  # }
+
+  ## recreate_versions
+  # Triggers `Fae::Image` to recreate Carrierwave versions after save.
+  # Defaults to false
+  # config.recreate_versions = false
+
+  ## track_changes
+  # This is the global toggle for the change tracker.
+  # Defaults to true
+  # config.track_changes = true
+
+  ## tracker_history_length
+  # This defines how many changes per object are kept in the DB
+  # via the change tracker.
+  # Defaults to 15
+  # config.tracker_history_length = 15
+
+  ## disabled_environments
+  # This option will disable Fae complete when the app is running
+  # on one of the defined environments
+  # config.disabled_environments = [ :preview, :staging ]
+
+  ## per_page
+  # Sets the default number of items shown in paginated lists
+  # Defaults to 25
+  # config.per_page = 25
+
+  ## use_cache
+  # Determines whether or not Fae will utilize cache internally.
+  # Note: you still need to enable `perform_caching` and set a `cache_store`
+  # on the parent app
+  # Defaults to false
+  # config.use_cache = true
+end