hanami_id-generators 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aff23030c604ab832dbe7647994f4176b974f9b6385a436677b918f4db22c301
+  data.tar.gz: e9378b3562c2db3b8eb94e27d937b8ae66e90d052e0a8180622bdffc7dc500c0
+SHA512:
+  metadata.gz: f4b4b4c06d5d855465c617948997f6db268ff04dc8e2753edb66c446cd39fcf08e1e0d99f33e3da562c818908f7593270d15b032bc10268450210a214bc3294d
+  data.tar.gz: 95ffefb906ae18061dce01ec12695898782195361a414af5162e6620b4284f31d774dbcfb5d46860726335e4669e8f71adc85a0465255986df7bd6ce1ce96d1d

data/README.md

@@ -0,0 +1,5 @@
+# HanamiId::Generators
+
+Generators for HanamiId - Authentication solution for [Hanami](https://github.com/hanami/hanami) framework.
+
+Generates authentication app with all controller actions, views and templates.

data/lib/hanami_id-generators.rb

@@ -0,0 +1,25 @@
+# rubocop:disable Naming/FileName
+
+# frozen_string_literal: true
+
+require "hanami_id"
+# TODO: remove pry
+# require "pry-byebug"
+
+module HanamiId
+  module Generators
+    class << self
+      attr_accessor :root
+      attr_accessor :templates
+    end
+
+    @root = Pathname.new File.expand_path(File.dirname(__dir__))
+    @templates = @root.join "lib", "hanami_id-generators", "templates"
+  end
+end
+
+require "hanami_id-generators/version"
+require "hanami_id-generators/destroy/auth"
+require "hanami_id-generators/generate/auth"
+
+# rubocop:enable Naming/FileName

data/lib/hanami_id-generators/destroy/auth.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "hanami/cli/commands"
+
+module HanamiId
+  module Destroy
+    extend Hanami::CLI::Registry
+
+    class Auth < Hanami::CLI::Commands::Command
+      desc "Destroy an app with hanami_id"
+
+      option :app, default: "auth", desc: "Application name"
+      option :model, default: "user", desc: "User model name"
+      option :modules, type: :array, values: HanamiId::MODULES,
+        default: HanamiId.default_modules, desc: "List of modules"
+      option :mode, values: HanamiId::MODES, default: "standalone",
+        desc: "Level of itegration in project apps (callbacks, helpers etc.)"
+
+      example [
+        ""
+      ]
+
+      def call(app:, model:, mode:, **_options)
+        HanamiId.logger.info "Destroying #{app} app!"
+        HanamiId.model_name = model
+        Hanami::CLI::Commands::Destroy::App.new(
+          command_name: "destroy app"
+        ).call(app: app)
+
+        remove_lib_app_directory(app)
+        remove_default_migration
+        return unless mode == "project"
+
+        # remove_config
+        remove_initializer
+      end
+
+      private
+
+      def remove_lib_app_directory(app)
+        destination = project.root.join("lib", app)
+        return unless files.exist?(destination)
+
+        files.delete_directory destination
+        say(:remove, destination)
+      end
+
+      def remove_default_migration
+        migration_name = Hanami::Utils::Inflector.pluralize HanamiId.model_name
+        destination = Dir.glob(
+          project.root.join("db", "migrations", "*create_#{migration_name}.rb")
+        ).first
+        return unless files.exist?(destination)
+
+        files.delete(destination)
+        say(:remove, destination)
+      end
+
+      def remove_config
+        # TODO: remove project-wide integration
+        raise "Not implemented"
+      end
+
+      def remove_initializer
+        destination = File.join project.initializers, "hanami_id.rb"
+        return unless files.exist?(destination)
+
+        files.delete destination
+        say(:remove, destination)
+      end
+    end
+  end
+end
+
+Hanami::CLI::Commands.register "destroy auth", HanamiId::Destroy::Auth

data/lib/hanami_id-generators/generate/auth.rb

@@ -0,0 +1,208 @@
+# rubocop:disable Metrics/ClassLength
+
+# frozen_string_literal: true
+
+require "hanami/cli/commands"
+
+module HanamiId
+  module Generate
+    extend Hanami::CLI::Registry
+
+    class Auth < Hanami::CLI::Commands::Command
+      CONTROLLER_ACTIONS = {
+        "sessions"      => {
+          "new"    => "GET",
+          "create" => "POST",
+          "delete" => "DELETE"
+        },
+        "registrations" => {
+          "index"  => "GET",
+          "new"    => "GET",
+          "create" => "POST",
+          "edit"   => "GET",
+          "show"   => "GET",
+          "update" => "PUT",
+          "delete" => "DELETE"
+        }
+      }.freeze
+
+      desc "Generate app with hanami_id integration"
+
+      option :app, default: "auth", desc: "Application name"
+      option :model, default: "user", desc: "User model name"
+      option :modules, type: :array, values: HanamiId::MODULES,
+        default: HanamiId.default_modules, desc: "List of modules"
+      option :id_type, default: "integer", desc: "User model name"
+      option :login_column, default: "email", desc: "Login column in the DB"
+      option :password_column, default: "password_hash",
+        desc: "Password column in the DB"
+      option :mode, values: HanamiId::MODES, default: "standalone",
+        desc: "Level of itegration in project apps (callbacks, helpers etc.)"
+
+      example [
+        "--app auth --model account --modules registrations"
+      ]
+
+      attr_accessor :auth_templates
+      attr_accessor :context
+
+      def initialize(*args)
+        super
+        @auth_templates = HanamiId::Generators.templates
+      end
+
+      # rubocop:disable Metrics/AbcSize
+      def call(
+        app:, model:, modules:, login_column:, password_column:, id_type:,
+        mode:, **options
+      )
+        HanamiId.logger.info "Generating #{app} app!"
+        HanamiId.model_name = model
+        @context = Hanami::CLI::Commands::Context.new(
+          app: app,
+          model: HanamiId.model_name,
+          repository: HanamiId.repository_name,
+          modules: modules,
+          id_type: id_type,
+          login_column: login_column,
+          password_column: password_column,
+          options: options.merge(project: app)
+        )
+
+        generate_default_app
+        generate_default_entity
+        generate_default_repository
+        generate_default_migration
+        generate_default_actions(modules)
+        generate_default_routes
+        add_initializer(mode)
+        add_config if mode == "project"
+        inject_authentication_require
+        inject_warden_helper
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      private
+
+      def generate_default_app
+        Hanami::CLI::Commands::Generate::App.new(
+          command_name: "generate app"
+        ).call(app: context.app)
+      end
+
+      def generate_default_routes
+        source = auth_templates.join("routes.erb").to_s
+        destination = project.app_routes(context)
+
+        generate_file(source, destination, context)
+        say(:create, destination)
+      end
+
+      def generate_default_entity
+        source = auth_templates.join("entity.erb").to_s
+        destination = project.entity(context)
+
+        generate_file(source, destination, context)
+        say(:create, destination)
+      end
+
+      def generate_default_repository
+        source = auth_templates.join("repository.erb").to_s
+        destination = project.repository(context)
+
+        generate_file(source, destination, context)
+        say(:create, destination)
+      end
+
+      def generate_default_migration
+        source = auth_templates.join("migration.erb").to_s
+        migration_name = Hanami::Utils::Inflector.pluralize HanamiId.model_name
+        destination = project.migration(
+          context.with(migration: "create_#{migration_name}")
+        )
+
+        generate_file(source, destination, context)
+        say(:create, destination)
+      end
+
+      def generate_default_actions(modules)
+        CONTROLLER_ACTIONS.each do |controller_name, actions|
+          actions.each do |action, verb|
+            next unless modules.include? controller_name
+
+            generate_action(controller_name, action, verb)
+          end
+        end
+      end
+
+      def generate_action(controller_name, action, verb)
+        HanamiId.logger.info(
+          "Generating #{verb} #{controller_name}##{action}"
+        )
+        Hanami::CLI::Commands::Generate::Action.new(
+          command_name: "generate action"
+        ).call(
+          app: context.app,
+          action: "#{controller_name}##{action}",
+          method: verb
+        )
+        # binding.pry
+        # action_code = generate_code(controller_name, action)
+        action_code = generate_code("registrations", "create")
+        destination = project.action(
+          context.with(
+            controller: controller_name,
+            action: action
+          )
+        )
+        files.inject_line_after(destination, /def call/, action_code)
+        say(:insert, destination)
+      end
+
+      def add_initializer(mode)
+        source = auth_templates.join("config.erb").to_s
+        destination = if mode == "project"
+          File.join project.initializers, "hanami_id.rb"
+        else
+          project.root.join(
+            "apps", context.app, "config", "hanami_id.rb"
+          )
+        end
+        generate_file(source, destination, context)
+        say(:create, destination)
+      end
+
+      def add_config
+        # TODO: add project-wide integration
+        raise "Not implemented"
+      end
+
+      def inject_authentication_require
+        content = "require \"hanami_id/authentication\""
+        destination = project.app_application(context)
+
+        files.inject_line_before(destination, "", content)
+        say(:insert, destination)
+      end
+
+      def inject_warden_helper
+        content = "      include HanamiId::Warden::AppHelper"
+        destination = project.app_application(context)
+
+        files.inject_line_after_last(destination, /Application </, content)
+        say(:insert, destination)
+      end
+
+      def generate_code(controller_name, action)
+        template = auth_templates.join(
+          "controllers", controller_name, "#{action}.erb"
+        )
+        render(template.to_s, context)
+      end
+    end
+  end
+end
+
+Hanami::CLI::Commands.register "generate auth", HanamiId::Generate::Auth
+
+# rubocop:enable Metrics/ClassLength

data/lib/hanami_id-generators/templates/config.erb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+HanamiId.configure do |config|
+  config.app_name = '<%= HanamiId.classify app %>'
+  config.model_name = '<%= model %>'
+  config.login_column = '<%= login_column %>'
+  config.password_column = '<%= password_column %>'
+end
+
+<%= HanamiId.app_name %>::Action.include HanamiId::Authentication

data/lib/hanami_id-generators/templates/controllers/registrations/create.erb

@@ -0,0 +1,20 @@
+        def initialize(operation: Interactors::Registrations::Create.new)
+          @operation = operation
+        end
+
+        params do
+          required(:<%= HanamiId.model_name %>).schema do
+            required(:email) { filled? & str? & format?(URI::MailTo::EMAIL_REGEXP) }
+            required(:password) { filled? & str? & size?(6..64) }
+          end
+        end
+
+        def call()
+          if params.valid?
+            <%= HanamiId.model_name %> = @operation.call(params[:<%= HanamiId.model_name %>])
+            params.env["warden"].set_user(<%= HanamiId.model_name %>)
+            redirect_to routes.root_path
+          else
+            self.status = 422
+          end
+        end

data/lib/hanami_id-generators/templates/entity.erb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class <%= HanamiId.classify model %> < Hanami::Entity
+end

data/lib/hanami_id-generators/templates/interactors/registrations/create.erb

@@ -0,0 +1,18 @@
+require 'hanami/interactor'
+
+module Interactors
+  module Registrations
+    class Create
+      include Hanami::Interactor
+
+      def initialize
+        # set up the object
+      end
+
+      def call(book_attributes)
+        <%= model %> = <%= HanamiId.classify model %>.new(params[:login], params[:password])
+        <%= HanamiId.classify repository %>.create(<%= model %>)
+      end
+    end
+  end
+end

data/lib/hanami_id-generators/templates/migration.erb

@@ -0,0 +1,29 @@
+Hanami::Model.migration do
+  up do
+    <%- if id_type == 'uuid' -%>
+    execute 'CREATE EXTENSION IF NOT EXISTS "uuid-ossp"'
+
+    <%- end -%>
+    create_table :<%= Hanami::Utils::Inflector.pluralize model %> do
+      <%- if id_type == 'uuid' -%>
+      primary_key :id, <%= id_type %>, null: false,
+        default: Hanami::Model::Sql.function(:uuid_generate_v4)
+      <%- else -%>
+      primary_key :id, null: false
+      <%- end -%>
+
+      column :<%= login_column %>,  String, null: false
+      column :<%= password_column %>, String, null: false
+
+      column :created_at, DateTime, null: false
+      column :updated_at, DateTime, null: false
+    end
+  end
+
+  down do
+    drop_table :<%= Hanami::Utils::Inflector.pluralize model %>
+    <%- if id_type == 'uuid' -%>
+    execute 'DROP EXTENSION IF EXISTS "uuid-ossp"'
+    <%- end -%>
+  end
+end

data/lib/hanami_id-generators/templates/repository.erb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class <%= HanamiId.classify repository %> < Hanami::Repository
+  def authenticate(login, password)
+
+  end
+end

data/lib/hanami_id-generators/templates/routes.erb

@@ -0,0 +1,6 @@
+<% if modules.include? 'sessions' -%>
+resources :sessions, only: [:new, :create, :delete]
+<% end -%>
+<% if modules.include? 'registrations' -%>
+resources :registrations
+<% end -%>

data/lib/hanami_id-generators/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module HanamiId
+  module Generators
+    VERSION = "0.1.1"
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: hanami_id-generators
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Viacheslav Ptsarev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hanami
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  Generates authentication app with all controller actions, views and
+  templates.
+email:
+- leemour@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/hanami_id-generators.rb
+- lib/hanami_id-generators/destroy/auth.rb
+- lib/hanami_id-generators/generate/auth.rb
+- lib/hanami_id-generators/templates/config.erb
+- lib/hanami_id-generators/templates/controllers/registrations/create.erb
+- lib/hanami_id-generators/templates/entity.erb
+- lib/hanami_id-generators/templates/interactors/registrations/create.erb
+- lib/hanami_id-generators/templates/migration.erb
+- lib/hanami_id-generators/templates/repository.erb
+- lib/hanami_id-generators/templates/routes.erb
+- lib/hanami_id-generators/version.rb
+homepage: https://github.com/leemour/hanami_id/gems/hanami_id-generators
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/leemour/hanami_id/gems/hanami_id-generators
+  source_code_uri: https://github.com/leemour/hanami_id/gems/hanami_id-generators
+  bug_tracker_uri: https://github.com/leemour/hanami_id/gems/hanami_id-generators/issues
+  changelog_uri: https://github.com/leemour/hanami_id/gems/hanami_id-generators/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Generators for HanamiId
+test_files: []