kingsman 0.0.0.beta → 0.1.0

data/lib/generators/active_record/kingsman_generator.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+require 'generators/kingsman/orm_helpers'
+
+module ActiveRecord
+  module Generators
+    class KingsmanGenerator < ActiveRecord::Generators::Base
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      class_option :primary_key_type, type: :string, desc: "The type for primary key"
+
+      include Kingsman::Generators::OrmHelpers
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_kingsman_migration
+        if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(table_name))
+          migration_template "migration_existing.rb", "#{migration_path}/add_kingsman_to_#{table_name}.rb", migration_version: migration_version
+        else
+          migration_template "migration.rb", "#{migration_path}/kingsman_create_#{table_name}.rb", migration_version: migration_version
+        end
+      end
+
+      def generate_model
+        invoke "active_record:model", [name], migration: false unless model_exists? && behavior == :invoke
+      end
+
+      def inject_kingsman_content
+        content = model_contents
+
+        class_path = if namespaced?
+          class_name.to_s.split("::")
+        else
+          [class_name]
+        end
+
+        indent_depth = class_path.size - 1
+        content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+
+        inject_into_class(model_path, class_path.last, content) if model_exists?
+      end
+
+      def migration_data
+<<RUBY
+      ## Database authenticatable
+      t.string :email,              null: false, default: ""
+      t.string :encrypted_password, null: false, default: ""
+
+      ## Recoverable
+      t.string   :reset_password_token
+      t.datetime :reset_password_sent_at
+
+      ## Rememberable
+      t.datetime :remember_created_at
+
+      ## Trackable
+      # t.integer  :sign_in_count, default: 0, null: false
+      # t.datetime :current_sign_in_at
+      # t.datetime :last_sign_in_at
+      # t.#{ip_column} :current_sign_in_ip
+      # t.#{ip_column} :last_sign_in_ip
+
+      ## Confirmable
+      # t.string   :confirmation_token
+      # t.datetime :confirmed_at
+      # t.datetime :confirmation_sent_at
+      # t.string   :unconfirmed_email # Only if using reconfirmable
+
+      ## Lockable
+      # t.integer  :failed_attempts, default: 0, null: false # Only if lock strategy is :failed_attempts
+      # t.string   :unlock_token # Only if unlock strategy is :email or :both
+      # t.datetime :locked_at
+RUBY
+      end
+
+      def ip_column
+        # Padded with spaces so it aligns nicely with the rest of the columns.
+        "%-8s" % (inet? ? "inet" : "string")
+      end
+
+      def inet?
+        postgresql?
+      end
+
+      def rails5_and_up?
+        require "rails/gem_version"
+        Rails::VERSION::MAJOR >= 5
+      end
+
+      def rails61_and_up?
+        require "rails/gem_version"
+        Rails::VERSION::MAJOR > 6 || (Rails::VERSION::MAJOR == 6 && Rails::VERSION::MINOR >= 1)
+      end
+
+      def postgresql?
+        ar_config && ar_config['adapter'] == 'postgresql'
+      end
+
+      def ar_config
+        if ActiveRecord::Base.configurations.respond_to?(:configs_for)
+          if rails61_and_up?
+            ActiveRecord::Base.configurations.configs_for(env_name: Jets.env, name: "primary").configuration_hash
+          else
+            ActiveRecord::Base.configurations.configs_for(env_name: Jets.env, spec_name: "primary").config
+          end
+        else
+          ActiveRecord::Base.configurations[Jets.env]
+        end
+      end
+
+     def migration_version
+       if rails5_and_up?
+         "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+       end
+     end
+
+     def primary_key_type
+       primary_key_string if rails5_and_up?
+     end
+
+     def primary_key_string
+       key_string = options[:primary_key_type]
+       ", id: :#{key_string}" if key_string
+     end
+    end
+  end
+end

data/lib/generators/active_record/templates/migration.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class KingsmanCreate<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :<%= table_name %><%= primary_key_type %> do |t|
+<%= migration_data -%>
+
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      t.timestamps null: false
+    end
+
+    add_index :<%= table_name %>, :email,                unique: true
+    add_index :<%= table_name %>, :reset_password_token, unique: true
+    # add_index :<%= table_name %>, :confirmation_token,   unique: true
+    # add_index :<%= table_name %>, :unlock_token,         unique: true
+  end
+end

data/lib/generators/active_record/templates/migration_existing.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class AddKingsmanTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    change_table :<%= table_name %> do |t|
+<%= migration_data -%>
+
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      # Uncomment below if timestamps were not included in your original model.
+      # t.timestamps null: false
+    end
+
+    add_index :<%= table_name %>, :email,                unique: true
+    add_index :<%= table_name %>, :reset_password_token, unique: true
+    # add_index :<%= table_name %>, :confirmation_token,   unique: true
+    # add_index :<%= table_name %>, :unlock_token,         unique: true
+  end
+
+  def self.down
+    # By default, we don't want to make any assumption about how to roll back a migration when your
+    # model already existed. Please edit below which fields you would like to remove in this migration.
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/generators/kingsman/controllers_generator.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Kingsman
+  module Generators
+    class ControllersGenerator < Rails::Generators::Base
+      CONTROLLERS = %w(confirmations passwords registrations sessions unlocks omniauth_callbacks).freeze
+
+      desc <<-DESC.strip_heredoc
+        Create inherited Kingsman controllers in your app/controllers folder.
+
+        Use -c to specify which controller you want to overwrite.
+        If you do no specify a controller, all controllers will be created.
+        For example:
+
+          jets generate kingsman:controllers users -c=sessions
+
+        This will create a controller class at app/controllers/users/sessions_controller.rb like this:
+
+          class Users::SessionsController < Kingsman::SessionsController
+            content...
+          end
+      DESC
+
+      source_root File.expand_path("../../templates/controllers", __FILE__)
+      argument :scope, required: true,
+        desc: "The scope to create controllers in, e.g. users, admins"
+      class_option :controllers, aliases: "-c", type: :array,
+        desc: "Select specific controllers to generate (#{CONTROLLERS.join(', ')})"
+
+      def create_controllers
+        @scope_prefix = scope.blank? ? '' : (scope.camelize + '::')
+        controllers = options[:controllers] || CONTROLLERS
+        controllers.each do |name|
+          template "#{name}_controller.rb",
+                   "app/controllers/#{scope}/#{name}_controller.rb"
+        end
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/kingsman/install_generator.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+require 'securerandom'
+
+module Kingsman
+  module Generators
+    MissingORMError = Class.new(Thor::Error)
+
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a Kingsman initializer and copy locale files to your application."
+      class_option :orm, required: true
+
+      def copy_initializer
+        unless options[:orm]
+          raise MissingORMError, <<-ERROR.strip_heredoc
+          An ORM must be set to install Kingsman in your application.
+
+          Be sure to have an ORM like Active Record or Mongoid loaded in your
+          app or configure your own at `config/application.rb`.
+
+            config.generators do |g|
+              g.orm :your_orm_gem
+            end
+          ERROR
+        end
+
+        template "kingsman.rb", "config/initializers/kingsman.rb"
+      end
+
+      def copy_locale
+        copy_file "../../../config/locales/en.yml", "config/locales/kingsman.en.yml"
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/kingsman/kingsman_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module Kingsman
+  module Generators
+    class KingsmanGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      namespace "kingsman"
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Generates a model with the given NAME (if one does not exist) with kingsman " \
+           "configuration plus a migration file and kingsman routes."
+
+      hook_for :orm, required: true
+
+      class_option :routes, desc: "Generate routes", type: :boolean, default: true
+
+      def add_kingsman_routes
+        kingsman_route  = "kingsman_for :#{plural_name}".dup
+        kingsman_route << %Q(, class_name: "#{class_name}") if class_name.include?("::")
+        kingsman_route << %Q(, skip: :all) unless options.routes?
+        route kingsman_route
+      end
+    end
+  end
+end

data/lib/generators/kingsman/orm_helpers.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Kingsman
+  module Generators
+    module OrmHelpers
+      def model_contents
+        buffer = <<-CONTENT
+  # Include default kingsman modules. Others available are:
+  # :confirmable, :lockable, :timeoutable, :trackable and :omniauthable
+  kingsman :database_authenticatable, :registerable,
+         :recoverable, :rememberable, :validatable
+
+CONTENT
+        buffer
+      end
+
+      private
+
+      def model_exists?
+        File.exist?(File.join(destination_root, model_path))
+      end
+
+      def migration_exists?(table_name)
+        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_add_kingsman_to_#{table_name}.rb$/).first
+      end
+
+      def migration_path
+        if Jets.version >= '5.0.3'
+          db_migrate_path
+        else
+          @migration_path ||= File.join("db", "migrate")
+        end
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+    end
+  end
+end

data/lib/generators/kingsman/views_generator.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Kingsman
+  module Generators
+    # Include this module in your generator to generate Kingsman views.
+    # `copy_views` is the main method and by default copies all views
+    # with forms.
+    module ViewPathTemplates #:nodoc:
+      extend ActiveSupport::Concern
+
+      included do
+        argument :scope, required: false, default: nil,
+                         desc: "The scope to copy views to"
+
+        # Le sigh, ensure Thor won't handle opts as args
+        # It should be fixed in future Jets releases
+        class_option :form_builder, aliases: "-b"
+        class_option :markerb
+        class_option :views, aliases: "-v", type: :array, desc: "Select specific view directories to generate (confirmations, passwords, registrations, sessions, unlocks, mailer)"
+
+        public_task :copy_views
+      end
+
+      def copy_views
+        if options[:views]
+          options[:views].each do |directory|
+            view_directory directory.to_sym
+          end
+        else
+          view_directory :confirmations
+          view_directory :passwords
+          view_directory :registrations
+          view_directory :sessions
+          view_directory :unlocks
+        end
+      end
+
+      protected
+
+      def view_directory(name, _target_path = nil)
+        directory name.to_s, _target_path || "#{target_path}/#{name}" do |content|
+          if scope
+            content.gsub("kingsman/shared", "#{plural_scope}/shared")
+          else
+            content
+          end
+        end
+      end
+
+      def target_path
+        @target_path ||= "app/views/#{plural_scope || :kingsman}"
+      end
+
+      def plural_scope
+        @plural_scope ||= scope.presence && scope.underscore.pluralize
+      end
+    end
+
+    class SharedViewsGenerator < Rails::Generators::Base #:nodoc:
+      include ViewPathTemplates
+      source_root File.expand_path("../../../../app/views/kingsman", __FILE__)
+      desc "Copies shared Kingsman views to your application."
+      hide!
+
+      # Override copy_views to just copy mailer and shared.
+      def copy_views
+        view_directory :shared
+      end
+    end
+
+    class FormForGenerator < Rails::Generators::Base #:nodoc:
+      include ViewPathTemplates
+      source_root File.expand_path("../../../../app/views/kingsman", __FILE__)
+      desc "Copies default Kingsman views to your application."
+      hide!
+    end
+
+    class SimpleFormForGenerator < Rails::Generators::Base #:nodoc:
+      include ViewPathTemplates
+      source_root File.expand_path("../../templates/simple_form_for", __FILE__)
+      desc "Copies simple form enabled views to your application."
+      hide!
+
+      def copy_views
+        if options[:views]
+          options[:views].delete('mailer')
+        end
+        super
+      end
+    end
+
+    class ErbGenerator < Rails::Generators::Base #:nodoc:
+      include ViewPathTemplates
+      source_root File.expand_path("../../../../app/views/kingsman", __FILE__)
+      desc "Copies Kingsman mail erb views to your application."
+      hide!
+
+      def copy_views
+        if !options[:views] || options[:views].include?('mailer')
+          view_directory :mailer
+        end
+      end
+    end
+
+    class MarkerbGenerator < Rails::Generators::Base #:nodoc:
+      include ViewPathTemplates
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Copies Kingsman mail markerb views to your application."
+      hide!
+
+      def copy_views
+        if !options[:views] || options[:views].include?('mailer')
+          view_directory :markerb, target_path
+        end
+      end
+
+      def target_path
+        "app/views/#{plural_scope || :kingsman}/mailer"
+      end
+    end
+
+    class ViewsGenerator < Rails::Generators::Base
+      desc "Copies Kingsman views to your application."
+
+      argument :scope, required: false, default: nil,
+                       desc: "The scope to copy views to"
+
+      invoke SharedViewsGenerator
+
+      hook_for :form_builder, aliases: "-b",
+                              desc: "Form builder to be used",
+                              default: defined?(SimpleForm) ? "simple_form_for" : "form_for"
+
+      hook_for :markerb,  desc: "Generate markerb instead of erb mail views",
+                          default: defined?(Markerb),
+                          type: :boolean
+
+      hook_for :erb,      desc: "Generate erb mail views",
+                          default: !defined?(Markerb),
+                          type: :boolean
+    end
+  end
+end

data/lib/generators/mongoid/kingsman_generator.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+require 'generators/kingsman/orm_helpers'
+
+module Mongoid
+  module Generators
+    class KingsmanGenerator < Rails::Generators::NamedBase
+      include Kingsman::Generators::OrmHelpers
+
+      def generate_model
+        invoke "mongoid:model", [name] unless model_exists? && behavior == :invoke
+      end
+
+      def inject_field_types
+        inject_into_file model_path, migration_data, after: "include Mongoid::Document\n" if model_exists?
+      end
+
+      def inject_kingsman_content
+        inject_into_file model_path, model_contents, after: "include Mongoid::Document\n" if model_exists?
+      end
+
+      def migration_data
+<<RUBY
+  ## Database authenticatable
+  field :email,              type: String, default: ""
+  field :encrypted_password, type: String, default: ""
+
+  ## Recoverable
+  field :reset_password_token,   type: String
+  field :reset_password_sent_at, type: Time
+
+  ## Rememberable
+  field :remember_created_at, type: Time
+
+  ## Trackable
+  # field :sign_in_count,      type: Integer, default: 0
+  # field :current_sign_in_at, type: Time
+  # field :last_sign_in_at,    type: Time
+  # field :current_sign_in_ip, type: String
+  # field :last_sign_in_ip,    type: String
+
+  ## Confirmable
+  # field :confirmation_token,   type: String
+  # field :confirmed_at,         type: Time
+  # field :confirmation_sent_at, type: Time
+  # field :unconfirmed_email,    type: String # Only if using reconfirmable
+
+  ## Lockable
+  # field :failed_attempts, type: Integer, default: 0 # Only if lock strategy is :failed_attempts
+  # field :unlock_token,    type: String # Only if unlock strategy is :email or :both
+  # field :locked_at,       type: Time
+RUBY
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1,36 @@
+===============================================================================
+
+Depending on your application's configuration some manual setup may be required:
+
+  1. Ensure you have defined default url options in your environments files. Here
+     is an example of default_url_options appropriate for a development environment
+     in config/environments/development.rb:
+
+       config.action_mailer.default_url_options = { host: 'localhost', port: 8888 }
+
+     In production, :host should be set to the actual host of your application.
+
+     * Required for all applications. *
+
+  2. Ensure you have defined root_url to *something* in your config/routes.rb.
+     For example:
+
+       root to: "home#index"
+
+     * Not required for API-only Applications *
+
+  3. Ensure you have flash messages in app/views/layouts/application.html.erb.
+     For example:
+
+       <p class="notice"><%= notice %></p>
+       <p class="alert"><%= alert %></p>
+
+     * Not required for API-only Applications *
+
+  4. You can copy Kingsman views (for customization) to your app by running:
+
+       jets generate kingsman:views
+
+     * Not required *
+
+===============================================================================

data/lib/generators/templates/controllers/README

@@ -0,0 +1,14 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  Ensure you have overridden routes for generated controllers in your routes.rb.
+  For example:
+
+    Jets.application.routes.draw do
+      kingsman_for :users, controllers: {
+        sessions: 'users/sessions'
+      }
+    end
+
+===============================================================================

data/lib/generators/templates/controllers/confirmations_controller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class <%= @scope_prefix %>ConfirmationsController < Kingsman::ConfirmationsController
+  # GET /resource/confirmation/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/confirmation
+  # def create
+  #   super
+  # end
+
+  # GET /resource/confirmation?confirmation_token=abcdef
+  # def show
+  #   super
+  # end
+
+  # protected
+
+  # The path used after resending confirmation instructions.
+  # def after_resending_confirmation_instructions_path_for(resource_name)
+  #   super(resource_name)
+  # end
+
+  # The path used after confirmation.
+  # def after_confirmation_path_for(resource_name, resource)
+  #   super(resource_name, resource)
+  # end
+end

data/lib/generators/templates/controllers/omniauth_callbacks_controller.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class <%= @scope_prefix %>OmniauthCallbacksController < Kingsman::OmniauthCallbacksController
+  # You should configure your model like this:
+  # kingsman :omniauthable, omniauth_providers: [:twitter]
+
+  # You should also create an action method in this controller like this:
+  # def twitter
+  # end
+
+  # More info at:
+  # https://github.com/heartcombo/kingsman#omniauth
+
+  # GET|POST /resource/auth/twitter
+  # def passthru
+  #   super
+  # end
+
+  # GET|POST /users/auth/twitter/callback
+  # def failure
+  #   super
+  # end
+
+  # protected
+
+  # The path used when OmniAuth fails
+  # def after_omniauth_failure_path_for(scope)
+  #   super(scope)
+  # end
+end

data/lib/generators/templates/controllers/passwords_controller.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+class <%= @scope_prefix %>PasswordsController < Kingsman::PasswordsController
+  # GET /resource/password/new
+  # def new
+  #   super
+  # end
+
+  # POST /resource/password
+  # def create
+  #   super
+  # end
+
+  # GET /resource/password/edit?reset_password_token=abcdef
+  # def edit
+  #   super
+  # end
+
+  # PUT /resource/password
+  # def update
+  #   super
+  # end
+
+  # protected
+
+  # def after_resetting_password_path_for(resource)
+  #   super(resource)
+  # end
+
+  # The path used after sending reset password instructions
+  # def after_sending_reset_password_instructions_path_for(resource_name)
+  #   super(resource_name)
+  # end
+end