plutonium 0.5.0

data/lib/generators/pu/gem/pagy/templates/config/initializers/pagy.rb

@@ -0,0 +1,4 @@
+require "pagy/extras/bootstrap"
+require "pagy/extras/overflow"
+require "pagy/extras/trim"
+require "pagy/extras/headers"

data/lib/generators/pu/gem/rabl/rabl_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "plutonium_generators"
+
+module Pu
+  module Gem
+    class RablGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Install Rabl"
+
+      def start
+        Bundler.with_unbundled_env do
+          run "bundle add rabl"
+        end
+
+        directory "config"
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+    end
+  end
+end

data/lib/generators/pu/gem/rabl/templates/config/initializers/rabl.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# https://github.com/nesquena/rabl#configuration
+
+Rabl.configure do |config|
+  config.cache_sources = !Rails.env.development? # Defaults to false
+  config.raise_on_missing_attribute = !Rails.env.production? # Defaults to false
+
+  # config.cache_all_output = false
+  # config.cache_engine = Rabl::CacheEngine.new # Defaults to Rails cache
+  # config.perform_caching = false
+  # config.escape_all_output = false
+  # config.json_engine = nil # Class with #dump class method (defaults JSON)
+  # config.msgpack_engine = nil # Defaults to ::MessagePack
+  # config.bson_engine = nil # Defaults to ::BSON
+  # config.plist_engine = nil # Defaults to ::Plist::Emit
+  # config.include_json_root = true
+  # config.include_msgpack_root = true
+  # config.include_bson_root = true
+  # config.include_plist_root = true
+  # config.include_xml_root  = false
+  # config.include_child_root = true
+  # config.enable_json_callbacks = false
+  # config.xml_options = { :dasherize  => true, :skip_types => false }
+  # config.view_paths = []
+  # config.replace_nil_values_with_empty_strings = true # Defaults to false
+  # config.replace_empty_string_values_with_nil_values = true # Defaults to false
+  # config.exclude_nil_values = true # Defaults to false
+  # config.exclude_empty_values_in_collections = true # Defaults to false
+  # config.camelize_keys = :upper # Defaults to false
+end
+
+# Monkey Patch Rabl source lookup to make it compatible with Rails view lookup
+module Rabl
+  module Sources
+    private
+
+    # Returns the rabl template path for Rails
+    def fetch_rails_source(file, _options = {})
+      # use Rails template resolution mechanism if possible (find_template)
+      source_format = request_format if defined?(request_format)
+
+      lookup_proc = lambda do |partial|
+        context_scope.lookup_context.find(file, context_scope.lookup_context.prefixes, partial, [],
+          {formats: [source_format]})
+      end
+      template = begin
+        lookup_proc.call(false)
+      rescue
+        nil
+      end
+      template ||= begin
+        lookup_proc.call(true)
+      rescue
+        nil
+      end
+      template&.identifier
+    end
+  end
+end

data/lib/generators/pu/gem/simple_form/simple_form_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "plutonium_generators"
+
+module Pu
+  module Gem
+    class SimpleFormGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Install SimpleForm"
+
+      def start
+        Bundler.with_unbundled_env do
+          run "bundle add simple_form"
+        end
+
+        directory "config"
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+    end
+  end
+end

data/lib/generators/pu/gen/pug/pug_generator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+return if PlutoniumGenerators.rails?
+
+module Pu
+  module Gen
+    class PugGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Create a new pug"
+
+      argument :name
+      class_option :desc, type: :string, desc: "Description of your pug"
+
+      def start
+        template "pug.rb.tt", "lib/generators/pu/#{pug_path}/#{pug_class.underscore}.rb"
+        create_file "lib/generators/pu/#{pug_path}/templates/.keep"
+      end
+
+      def rubocop
+        run "standardrb --fix"
+      end
+
+      protected
+
+      def pug_name
+        name.split(":").map(&:camelize).join("::")
+      end
+
+      def pug_path
+        pug_name.underscore
+      end
+
+      def pug_module
+        pug_name.deconstantize
+      end
+
+      def pug_class
+        "#{pug_name.demodulize}Generator"
+      end
+    end
+  end
+end

data/lib/generators/pu/gen/pug/templates/pug.rb.tt

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require File.expand_path('../../../../plutonium_generators', __dir__)
+
+module Pu
+  module <%= pug_module %>
+    class <%= pug_class %> < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path('templates', __dir__)
+
+      desc '<%= options[:desc] || 'TODO: add description' %>'
+
+      argument :name
+
+      def start
+        raise NotImplementedError, "<%= pug_name %>"
+      rescue StandardError => e
+        exception "#{self.class} failed:", e
+      end
+    end
+  end
+end

data/lib/generators/pu/pkg/app/app_generator.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "plutonium_generators"
+
+module Pu
+  module Pkg
+    class AppGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Create a plutonium app package"
+
+      argument :name
+
+      def start
+        validate_package_name package_name
+
+        if defined?(RodauthApp) && (rodauths = RodauthApp.opts[:rodauths].keys).present?
+          rodauth_account = prompt.select("Select rodauth account to authenticate with:", rodauths + [:none])
+          @rodauth_account = rodauth_account unless rodauth_account == :none
+        elsif prompt.yes?("Do you want to grant public access?")
+          @public_access = true
+        else
+          @bring_your_own_auth = true
+        end
+
+        template "lib/engine.rb", "packages/#{package_namespace}/lib/engine.rb"
+        template "config/routes.rb", "packages/#{package_namespace}/config/routes.rb"
+
+        %w[controllers interactions policies presenters].each do |dir|
+          directory "app/#{dir}", "packages/#{package_namespace}/app/#{dir}/#{package_namespace}"
+        end
+        create_file "packages/#{package_namespace}/app/views/#{package_namespace}/.keep"
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      attr_reader :rodauth_account
+
+      def package_name
+        name.classify + "App"
+      end
+
+      def package_namespace
+        package_name.underscore
+      end
+
+      def package_type
+        "Packaging::App"
+      end
+
+      def public_access? = @public_access
+
+      def bring_your_own_auth? = @bring_your_own_auth
+    end
+  end
+end

data/lib/generators/pu/pkg/app/templates/app/controllers/resource_controller.rb.tt

@@ -0,0 +1,26 @@
+module <%= package_name %>
+  module ResourceController
+    extend ActiveSupport::Concern
+    include Plutonium::Core::AppController
+    <%- if rodauth_account.present? -%>
+    include Plutonium::Auth.rodauth(:<%= rodauth_account %>)
+    <%- elsif public_access? -%>
+    include Plutonium::Auth::PublicAccess
+    <%- end -%>
+    # add concerns above.
+
+    included do
+      boot <%= package_name %>
+      <%- if bring_your_own_auth? -%>
+
+      helper_method :current_user
+      <%- end -%>
+    end
+    <%- if bring_your_own_auth? -%>
+
+    def current_user
+      raise NotImplementedError, "#{self.class}#current_user must return a non nil value"
+    end
+    <%- end -%>
+  end
+end

data/lib/generators/pu/pkg/app/templates/app/interactions/resource_interaction.rb.tt

@@ -0,0 +1,4 @@
+module <%= package_name %>
+  module ResourceInteraction
+  end
+end

data/lib/generators/pu/pkg/app/templates/app/policies/resource_policy.rb.tt

@@ -0,0 +1,4 @@
+module <%= package_name %>
+  module ResourcePolicy
+  end
+end

data/lib/generators/pu/pkg/app/templates/app/presenters/resource_presenter.rb.tt

@@ -0,0 +1,4 @@
+module <%= package_name %>
+  module ResourcePresenter
+  end
+end

data/lib/generators/pu/pkg/app/templates/config/routes.rb.tt

@@ -0,0 +1,17 @@
+# <%= package_name %>::Engine.routes.draw do
+#   # add custom app routes here
+# end
+
+# draw routes for registered resources
+<%= package_name %>::Engine.draw_resource_routes
+
+# mount our app
+Rails.application.routes.draw do
+  <%- if rodauth_account.present? -%>
+  constraints Rodauth::Rails.authenticate(:<%= rodauth_account %>) do
+    mount <%= package_name %>::Engine, at: "/<%= name.underscore %>"
+  end
+  <%- else -%>
+  mount <%= package_name %>::Engine, at: "/<%= name.underscore %>"
+  <%- end -%>
+end

data/lib/generators/pu/pkg/app/templates/lib/engine.rb.tt

@@ -0,0 +1,14 @@
+module <%= package_name %>
+  class Engine < Rails::Engine
+    include Plutonium::<%= package_type %>
+    # add concerns above.
+
+    config.after_initialize do
+      initialize_register!
+
+      # add directives above.
+
+      # register resources above.
+    end
+  end
+end

data/lib/generators/pu/pkg/feature/feature_generator.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "plutonium_generators"
+
+module Pu
+  module Pkg
+    class FeatureGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Create a plutonium feature package"
+
+      argument :name
+
+      def start
+        validate_package_name package_name
+
+        template "lib/engine.rb", "packages/#{package_namespace}/lib/engine.rb"
+
+        %w[controllers interactions models policies presenters].each do |dir|
+          directory "app/#{dir}", "packages/#{package_namespace}/app/#{dir}/#{package_namespace}"
+        end
+        create_file "packages/#{package_namespace}/app/views/#{package_namespace}/.keep"
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      def package_name
+        name.classify
+      end
+
+      def package_namespace
+        package_name.underscore
+      end
+
+      def package_type
+        "Packaging::Feature"
+      end
+    end
+  end
+end

data/lib/generators/pu/pkg/feature/templates/app/controllers/resource_controller.rb.tt

@@ -0,0 +1,7 @@
+module <%= package_name %>
+  class ResourceController < ::ResourceController
+    # add concerns above.
+
+    boot <%= package_name %>
+  end
+end

data/lib/generators/pu/pkg/feature/templates/app/interactions/resource_interaction.rb.tt

@@ -0,0 +1,4 @@
+module <%= package_name %>
+  class ResourceInteraction < ::ResourceInteraction
+  end
+end

data/lib/generators/pu/pkg/feature/templates/app/models/resource_record.rb.tt

@@ -0,0 +1,5 @@
+module <%= package_name %>
+  class ResourceRecord < ::ResourceRecord
+    self.abstract_class = true
+  end
+end

data/lib/generators/pu/pkg/feature/templates/app/policies/resource_policy.rb.tt

@@ -0,0 +1,4 @@
+module <%= package_name %>
+  class ResourcePolicy < ::ResourcePolicy
+  end
+end

data/lib/generators/pu/pkg/feature/templates/app/presenters/resource_presenter.rb.tt

@@ -0,0 +1,4 @@
+module <%= package_name %>
+  class ResourcePresenter < ::ResourcePresenter
+  end
+end

data/lib/generators/pu/pkg/feature/templates/lib/engine.rb.tt

@@ -0,0 +1,8 @@
+module <%= package_name %>
+  class Engine < Rails::Engine
+    include Plutonium::<%= package_type %>
+    # add concerns above.
+
+    # add directives above
+  end
+end

data/lib/generators/pu/resource/conn/conn_generator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "plutonium_generators"
+
+module Pu
+  module Resource
+    class ConnGenerator < Rails::Generators::Base
+      include PlutoniumGenerators::Generator
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Create a connection between a resource and an app"
+
+      # argument :name
+
+      def start
+        source_feature = select_feature
+        source_module = (source_feature == "main_app") ? "ResourceRecord" : "#{source_feature.classify}::ResourceRecord"
+
+        Rails.application.eager_load!
+        available_resources = source_module.constantize.descendants.map(&:to_s)
+        selected_resources = prompt.multi_select("Select resources", available_resources)
+
+        @app_namespace = select_app.classify
+
+        selected_resources.each do |resource|
+          @resource_class = resource
+
+          template "app/controllers/resource_controller.rb", "packages/#{package_namespace}/app/controllers/#{package_namespace}/#{resource.pluralize.underscore}_controller.rb"
+          template "app/policies/resource_policy.rb", "packages/#{package_namespace}/app/policies/#{package_namespace}/#{resource.underscore}_policy.rb"
+          template "app/presenters/resource_presenter.rb", "packages/#{package_namespace}/app/presenters/#{package_namespace}/#{resource.underscore}_presenter.rb"
+
+          insert_into_file "packages/#{package_namespace}/lib/engine.rb",
+            indent("register_resource ::#{resource}\n", 6),
+            before: /.*# register resources above.*/
+        end
+      rescue => e
+        exception "#{self.class} failed:", e
+      end
+
+      private
+
+      attr_reader :app_namespace, :resource_class
+
+      def package_namespace
+        app_namespace.underscore
+      end
+
+      def resource_namespace
+        app_namespace.underscore
+      end
+    end
+  end
+end

data/lib/generators/pu/resource/conn/templates/app/controllers/resource_controller.rb.tt

@@ -0,0 +1,3 @@
+class <%= app_namespace %>::<%= resource_class.pluralize %>Controller < ::<%= resource_class.pluralize %>Controller
+  include <%= app_namespace %>::ResourceController
+end

data/lib/generators/pu/resource/conn/templates/app/policies/resource_policy.rb.tt

@@ -0,0 +1,3 @@
+class <%= app_namespace %>::<%= resource_class %>Policy < ::<%= resource_class %>Policy
+  include <%= app_namespace %>::ResourcePolicy
+end

data/lib/generators/pu/resource/conn/templates/app/presenters/resource_presenter.rb.tt

@@ -0,0 +1,3 @@
+class <%= app_namespace %>::<%= resource_class %>Presenter < ::<%= resource_class %>Presenter
+  include <%= app_namespace %>::ResourcePresenter
+end

data/lib/generators/pu/resource/model/USAGE

@@ -0,0 +1,113 @@
+Description:
+Generates a new model. Pass the model name, either CamelCased or
+under_scored, and an optional list of attribute pairs as arguments.
+
+    Attribute pairs are field:type arguments specifying the
+    model's attributes. Timestamps are added by default, so you don't have to
+    specify them by hand as 'created_at:datetime updated_at:datetime'.
+
+    As a special case, specifying 'password:digest' will generate a
+    password_digest field of string type, and configure your generated model and
+    tests for use with Active Model has_secure_password (assuming the default ORM
+    and test framework are being used).
+
+    You don't have to think up every attribute up front, but it helps to
+    sketch out a few so you can start working with the model immediately.
+
+    This generator invokes your configured ORM and test framework, which
+    defaults to Active Record and TestUnit.
+
+    Finally, if --parent option is given, it's used as superclass of the
+    created model. This allows you create Single Table Inheritance models.
+
+    If you pass a namespaced model name (e.g. admin/account or Admin::Account)
+    then the generator will create a module with a table_name_prefix method
+    to prefix the model's table name with the module name (e.g. admin_accounts)
+
+Available field types:
+
+    Just after the field name you can specify a type like text or boolean.
+    It will generate the column with the associated SQL type. For instance:
+
+        `bin/rails generate model post title:string body:text`
+
+    will generate a title column with a varchar type and a body column with a text
+    type. If no type is specified the string type will be used by default.
+    You can use the following types:
+
+        integer
+        primary_key
+        decimal
+        float
+        boolean
+        binary
+        string
+        text
+        date
+        time
+        datetime
+
+    You can also consider `references` as a kind of type. For instance, if you run:
+
+        `bin/rails generate model photo title:string album:references`
+
+    It will generate an `album_id` column. You should generate these kinds of fields when
+    you will use a `belongs_to` association, for instance. `references` also supports
+    polymorphism, you can enable polymorphism like this:
+
+        `bin/rails generate model product supplier:references{polymorphic}`
+
+    For integer, string, text and binary fields, an integer in curly braces will
+    be set as the limit:
+
+        `bin/rails generate model user pseudo:string{30}`
+
+    For decimal, two integers separated by a comma in curly braces will be used
+    for precision and scale:
+
+        `bin/rails generate model product 'price:decimal{10,2}'`
+
+    You can add a `:uniq` or `:index` suffix for unique or standard indexes
+    respectively:
+
+        `bin/rails generate model user pseudo:string:uniq`
+        `bin/rails generate model user pseudo:string:index`
+
+    You can combine any single curly brace option with the index options:
+
+        `bin/rails generate model user username:string{30}:uniq`
+        `bin/rails generate model product supplier:references{polymorphic}:index`
+
+    If you require a `password_digest` string column for use with
+    has_secure_password, you can specify `password:digest`:
+
+        `bin/rails generate model user password:digest`
+
+    If you require a `token` string column for use with
+    has_secure_token, you can specify `auth_token:token`:
+
+        `bin/rails generate model user auth_token:token`
+
+Examples:
+`bin/rails generate model account`
+
+        For Active Record and TestUnit it creates:
+
+            Model:      app/models/account.rb
+            Test:       test/models/account_test.rb
+            Fixtures:   test/fixtures/accounts.yml
+            Migration:  db/migrate/XXX_create_accounts.rb
+
+    `bin/rails generate model post title:string body:text published:boolean`
+
+        Creates a Post model with a string title, text body, and published flag.
+
+    `bin/rails generate model admin/account`
+
+        For Active Record and TestUnit it creates:
+
+            Module:     app/models/admin.rb
+            Model:      app/models/admin/account.rb
+            Test:       test/models/admin/account_test.rb
+            Fixtures:   test/fixtures/admin/accounts.yml
+            Migration:  db/migrate/XXX_create_admin_accounts.rb