itsf_backend 1.0.1

data/lib/generators/itsf/backend/home_controller/templates/home_controller.rb

@@ -0,0 +1,6 @@
+module <%= controller_namespace %>
+  class HomeController < Itsf::Backend::HomeController
+    def index
+    end
+  end
+end

data/lib/generators/itsf/backend/home_controller/templates/routes.source

@@ -0,0 +1,2 @@
+
+  root to: 'home#index'

data/lib/generators/itsf/backend/install/install_generator.rb

@@ -0,0 +1,23 @@
+module Itsf
+  module Backend
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        desc 'Generates the intializer'
+
+        source_root File.expand_path('../templates', __FILE__)
+
+        def generate_intializer
+          copy_file 'initializer.rb', 'config/initializers/001_itsf_backend.rb'
+        end
+
+        def generate_routes
+          route File.read(File.join(File.expand_path('../templates', __FILE__), 'routes.source'))
+        end
+
+        def generate_controller
+          copy_file 'backend_controller.rb', 'app/controllers/backend_controller.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/itsf/backend/install/templates/backend_controller.rb

@@ -0,0 +1,2 @@
+class BackendController < ApplicationController
+end

data/lib/generators/itsf/backend/install/templates/initializer.rb

@@ -0,0 +1,95 @@
+Itsf::Backend.configure do |config|
+  # Manually disable features
+  # 
+  # Default: config.disabled_features: []
+  # 
+  config.disabled_features = []
+  
+  # Set the base controller the backend dashboards
+  #
+  # Default: config.dashboard_base_controller = 'BackendController'
+  #
+  config.dashboard_base_controller = 'BackendController'
+
+  # Set the base controller for module home controllers
+  #
+  # Default: config.home_base_controller = 'BackendController'
+  #
+  config.home_base_controller = 'BackendController'
+
+  # Set the base controller for resouce controllers
+  #
+  # Default: config.resource_base_controller = 'BackendController'
+  #
+  config.resource_base_controller = 'BackendController'
+
+  # Register backend engines here. They will be  added to the backend menu
+  #
+  # Example: config.backend_engines = %w( MyEngine::Engine ).map(&:constantize)
+  #
+  # Default: config.backend_engines = %w().map(&:constantize)
+  #
+  config.backend_engines = %w(
+  ).map(&:constantize)
+
+  # Proc that will be used to build the backend title link. The first and only 
+  # argument is the view.
+  # 
+  # Default: config.title_link = Proc.new do |view|
+  #            view.link_to(
+  #              view.t('.title', application_name: Rails.application.class.parent_name.underscore.titleize),
+  #              view.main_app.itsf_backend_path,
+  #              class: 'navbar-brand'
+  #            )
+  #          end
+  config.title_link = Proc.new do |view|
+    view.link_to(
+      view.t('.title', application_name: Rails.application.class.parent_name.underscore.titleize),
+      view.main_app.itsf_backend_path,
+      class: 'navbar-brand'
+    )
+  end
+
+  # Proc that will be used to mount engines.
+  # 
+  # Default:
+  # 
+  # config.engine_mount_point = Proc.new { |router, engine|
+  #   router.mount(
+  #     engine => I18n.t(
+  #       "routes.mount.#{engine.engine_name}",
+  #       default: "/#{engine.name.deconstantize.underscore}"
+  #     )
+  #   )
+  # }
+  config.engine_mount_point = Proc.new { |router, engine|
+    router.mount(
+      engine => I18n.t(
+        "routes.mount.#{engine.engine_name}",
+        default: "/#{engine.name.deconstantize.underscore}"
+      )
+    )
+  }
+
+  # Methods, that will be tried on a resource to generate a nice title
+  # 
+  # Default: config.resource_title_methods = [:human, :name, :email, :to_s]
+  # 
+  config.resource_title_methods = [:human, :name, :email, :to_s]
+
+  # This attributes will be hidden by default in index, show, edit and update views.
+  # 
+  # Default: config.hidden_attributes = [:id, :friendly_id, :lft, :rgt, :depth]
+  # 
+  config.hidden_attributes_for = {
+    edit:  [:id, :slug, :lft, :rgt, :depth, :created_at, :updated_at],
+    index: [:id, :slug, :lft, :rgt, :depth],
+    show:  [:id, :slug, :lft, :rgt, :depth]
+  }
+
+  # Sets the default pagination size 
+  # 
+  # Default config.default_pagination_size = 15
+  # 
+  config.default_pagination_size = 15
+end

data/lib/generators/itsf/backend/install/templates/routes.source

@@ -0,0 +1,9 @@
+
+  localized do
+    Itsf::Backend::Configuration.engine_mount_point.call(self, Itsf::Backend::Engine)
+    # mount Itsf::Backend::Engine => '/backend'
+
+    Itsf::Backend::Configuration.backend_engines.each do |engine|
+      Itsf::Backend::Configuration.engine_mount_point.call(self, engine)
+    end
+  end

data/lib/generators/itsf/backend/resource/resource_generator.rb

@@ -0,0 +1,96 @@
+require 'erb'
+
+module Itsf
+  module Backend
+    module Generators
+      class ResourceGenerator < Rails::Generators::NamedBase
+        desc 'Generates an admin resource'
+
+        source_root File.expand_path('../templates', __FILE__)
+
+        def test
+          p class_name
+          p class_path
+          p file_path
+          p human_name
+          p i18n_scope
+          # p indent
+          p index_helper
+          # p inside_template
+          p inside_template?
+          # p module_namespacing
+          p mountable_engine?
+          p namespace
+          p namespaced?
+          # p namespaced_class_path
+          # p namespaced_file_path
+          # p namespaced_path
+          p plural_file_name
+          p plural_name
+          p plural_table_name
+          p pluralize_table_names?
+          p regular_class_path
+          p route_url
+          p singular_name
+          p singular_table_name
+          p table_name
+          # p template
+          p uncountable?
+          # p wrap_with_namespace
+
+          p admin_controller_file_path
+          p admin_controller_file_name
+          p controller_base_path
+          p controller_name
+          p params_key
+        end
+
+        def generate_controller
+          template 'controller.rb', File.join(admin_controller_file_path, admin_controller_file_name)
+        end
+
+        def generate_routes
+          route ERB.new(routes_source).result(binding)
+        end
+
+        private
+
+        def admin_controller_file_path
+          File.join controller_base_path, *class_path, 'backend'
+        end
+
+        def admin_controller_file_name
+          "#{plural_name}_controller.rb"
+        end
+
+        def controller_base_path
+          %w(app controllers)
+        end
+
+        def controller_name
+          "#{module_namespace}::Backend::#{demodulized_class_name.pluralize}Controller"
+        end
+
+        def demodulized_class_name
+          class_name.demodulize
+        end
+
+        def module_namespace
+          class_path.join('/').camelize
+        end
+
+        def params_key
+          class_name.demodulize.underscore
+        end
+
+        def route_resource_name
+          plural_name
+        end
+
+        def routes_source
+          File.read(File.join(File.expand_path('../templates', __FILE__), 'routes.source'))
+        end
+      end
+    end
+  end
+end

data/lib/generators/itsf/backend/resource/templates/controller.rb

@@ -0,0 +1,34 @@
+class <%= controller_name %> < Itsf::Backend::BaseController
+  def self.resource_class
+    # Set the resource class here.
+    #
+    # Default: <%= class_name %>
+    #
+    <%= class_name %>
+  end
+
+  private
+
+  def collection_scope
+    # Customize the collection scope here for collection retrival (i.e. for the
+    # index action).
+    #
+    # Example: current_user.posts.includes(:comments)
+    #
+    # Default: super
+    #
+    super
+  end
+
+  def permitted_params
+    # Set the allowed params, for your create and update methods.
+    # 
+    # Example: params
+    #            .require(:<%= params_key %>)
+    #              .permit(:title, :body)
+    # 
+    params
+      .require(:<%= params_key %>)
+        .permit()
+  end
+end

data/lib/generators/itsf/backend/resource/templates/routes.source

@@ -0,0 +1,2 @@
+
+  resources :<%= route_resource_name %>

data/lib/itsf/backend.rb

@@ -0,0 +1,11 @@
+require 'itsf/backend/configuration'
+require 'itsf/backend/features'
+require 'itsf/backend/policies'
+
+module Itsf
+  module Backend
+    extend Configuration
+    extend Features
+    extend Policies
+  end
+end

data/lib/itsf/backend/configuration.rb

@@ -0,0 +1,38 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/module/attribute_accessors'
+
+module Itsf
+  module Backend
+    module Configuration
+      def configure
+        yield self
+      end
+
+      mattr_accessor(:backend_engines) { [] }
+      mattr_accessor(:resource_base_controller) { '::ApplicationController' }
+      mattr_accessor(:service_base_controller) { '::ApplicationController' }
+      mattr_accessor(:dashboard_base_controller) { '::ApplicationController' }
+      mattr_accessor(:home_base_controller) { '::ApplicationController' }
+      mattr_accessor :engine_mount_point
+      mattr_accessor :title_link
+      mattr_accessor :resource_title_methods
+      mattr_accessor(:disabled_features) { [] }
+      mattr_accessor(:hidden_attributes_for) do
+        { index: [], show: [], edit: [] }
+      end
+      mattr_accessor(:default_pagination_size) { 15 }
+
+      def registered_controllers
+        backend_engines.call.collect do |engine|
+          "#{engine.parent}::Configuration".constantize.registered_controllers.call
+        end.flatten
+      end
+
+      def registered_resources
+        registered_controllers.call.collect do |controller|
+          controller.resource_class if controller.respond_to?(:resource_class)
+        end.compact
+      end
+    end
+  end
+end

data/lib/itsf/backend/engine.rb

@@ -0,0 +1,16 @@
+module Itsf
+  module Backend
+    class Engine < ::Rails::Engine
+      isolate_namespace Itsf::Backend
+
+      config.generators do |g|
+        g.test_framework :rspec, fixture: false
+        g.fixture_replacement :factory_girl, dir: 'spec/factories'
+        g.assets false
+        g.helper false
+      end
+
+      config.paths.add root.join(*%w(app extensions concerns)).to_s, eager_load: true
+    end
+  end
+end

data/lib/itsf/backend/features.rb

@@ -0,0 +1,13 @@
+module Itsf
+  module Backend
+    module Features
+      def gem_available?(name)
+        Gem::Specification.find_all_by_name(name.to_s).any?
+      end
+
+      def features?(name)
+        Gem::Specification.find_all_by_name(name.to_s).any? && !Itsf::Backend::Configuration.disabled_features.include?(name)
+      end
+    end
+  end
+end

data/lib/itsf/backend/policies.rb

@@ -0,0 +1,13 @@
+module Itsf
+  module Backend
+    module Policies
+      def policies
+        Itsf::Backend::BasePolicy.subclasses
+      end
+
+      def policy_permissions
+        policies.collect { |klass| klass.instance_methods(false) + klass.superclass.instance_methods(false).collect { |method_name| "#{klass.to_s.underscore}/#{method_name}" } }.flatten.delete_if { |method_name| method_name.to_s !~ /\?$/ }.collect { |permission| permission.chomp('?') }
+      end
+    end
+  end
+end

data/lib/itsf/backend/spec_helpers.rb

@@ -0,0 +1,47 @@
+module Itsf
+  module Backend
+    module SpecHelpers
+      def ensure_backend_engine_homepage(engine_class)
+        expect(current_path).to eq(engine_path(engine_class))
+      end
+
+      def backend_path
+        "#{itsf_backend_path}/"
+      end
+
+      def engine_path(engine_class)
+        send("#{engine_class.engine_name}_path")
+      end
+
+      def link_to_controller_action(controller_class, action_name, instance = nil)
+        if instance
+          "link-to-#{controller_class.name.underscore.gsub('_controller', '').gsub(/[\/_]/, '-')}-#{instance.to_param}-#{action_name}"
+        else
+          "link-to-#{controller_class.name.underscore.gsub('_controller', '').gsub(/[\/_]/, '-')}-#{action_name}"
+        end
+      end
+
+      def create_resource_instance_for_controller(controller_class)
+        create(controller_class.resource_class.name.underscore.tr('/', '_'))
+      end
+
+      def ensure_current_action(_engine_class, controller_class, action_name, instance = nil)
+        case action_name
+        when :index
+          expect(page).to have_content(controller_class.resource_class.model_name.human(count: :other))
+        when :new
+          expect(page).to have_content(I18n.t('itsf.backend.base.new.title', resource_name: controller_class.resource_class.model_name.human))
+        when :show
+          expect(page).to have_content(instance.try_all(*Itsf::Backend::Configuration.resource_title_methods))
+        when :edit
+          expect(page).to have_content(I18n.t('itsf.backend.base.edit.title', resource_name: instance.class.model_name.human))
+        when :destroy
+          expect(page).to have_content(instance.class.model_name.human(count: :other))
+        end
+
+        # Can't use this because of bug: undefined method `segment_keys' for nil:NilClass
+        # expect(current_path).to eq(engine_class.routes.url_for(controller: controller_class.controller_name, action: action_name))
+      end
+    end
+  end
+end

data/lib/itsf/backend/version.rb

@@ -0,0 +1,5 @@
+module Itsf
+  module Backend
+    VERSION = '1.0.1'
+  end
+end

data/lib/itsf_backend.rb

@@ -0,0 +1,21 @@
+require 'ace-rails-ap'
+require 'coffee-rails'
+require 'cocoon'
+require 'kaminari'
+require 'kaminari-i18n'
+require 'bootstrap-kaminari-views'
+require 'jquery-rails'
+require 'jquery-ui-rails'
+require 'haml-rails'
+require 'pundit'
+require 'rails-i18n'
+require 'less-rails'
+require 'resource_renderer'
+require 'responders'
+require 'route_translator'
+require 'simple_display'
+require 'simple_form'
+require 'twitter-bootstrap-rails'
+
+require 'itsf/backend'
+require 'itsf/backend/engine'