hanami 1.0.0 → 1.1.0.beta1

data/lib/hanami/cli/commands/destroy/app.rb

@@ -0,0 +1,159 @@
+module Hanami
+  class CLI
+    module Commands
+      module Destroy
+        # @since 1.1.0
+        # @api private
+        class App < Command
+          desc "Destroy an app"
+
+          argument :app, required: true, desc: "The application name (eg. `web`)"
+
+          example [
+            "admin # Destroy `admin` app"
+          ]
+
+          # @since 1.1.0
+          # @api private
+          def call(app:, **options) # rubocop:disable Metrics/MethodLength
+            app     = Utils::String.underscore(app)
+            context = Context.new(app: app, options: options)
+
+            assert_valid_app!(context)
+            context = context.with(base_url: base_url(context))
+
+            remove_test_http_session_secret(context)
+            remove_development_http_session_secret(context)
+
+            remove_mount_app(context)
+            remove_require_app(context)
+
+            recursively_destroy_precompiled_assets(context)
+            destroy_assets_manifest(context)
+
+            recursively_destroy_specs(context)
+            recursively_destroy_app(context)
+          end
+
+          private
+
+          # @since 1.1.0
+          # @api private
+          def assert_valid_app!(context)
+            return if project.app?(context)
+
+            existing_apps = project.apps.map { |name| "`#{name}'" }.join(' ')
+            warn "`#{context.app}' is not a valid APP. Please specify one of: #{existing_apps}"
+            exit(1)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def remove_test_http_session_secret(context)
+            content     = "#{context.app.upcase}_SESSIONS_SECRET"
+            destination = project.env(context, "test")
+
+            files.remove_line(destination, content)
+            say(:subtract, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def remove_development_http_session_secret(context)
+            content     = "#{context.app.upcase}_SESSIONS_SECRET"
+            destination = project.env(context, "development")
+
+            files.remove_line(destination, content)
+            say(:subtract, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def remove_mount_app(context)
+            content     = "mount #{context.app.classify}::Application"
+            destination = project.environment(context)
+
+            files.remove_line(destination, content)
+            say(:subtract, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def remove_require_app(context)
+            content     = "require_relative '../apps/#{context.app}/application'"
+            destination = project.environment(context)
+
+            files.remove_line(destination, content)
+            say(:subtract, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def recursively_destroy_precompiled_assets(context)
+            destination = project.public_app_assets(context)
+            return unless files.directory?(destination)
+
+            files.delete_directory(destination)
+            say(:remove, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def destroy_assets_manifest(context)
+            destination = project.assets_manifest(context)
+            return unless files.exist?(destination)
+
+            files.delete(destination)
+            say(:remove, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def recursively_destroy_specs(context)
+            destination = project.app_spec(context)
+
+            files.delete_directory(destination)
+            say(:remove, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def recursively_destroy_app(context)
+            destination = project.app(context)
+
+            files.delete_directory(destination)
+            say(:remove, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def base_url(context)
+            content     = "mount #{context.app.classify}::Application"
+            destination = project.environment(context)
+
+            line  = read_matching_line(destination, content)
+            *, at = line.split(/at\:[[:space:]]*/)
+
+            at.strip.gsub(/["']*/, "")
+          end
+
+          # @since 1.1.0
+          # @api private
+          def read_matching_line(path, target)
+            content = ::File.readlines(path)
+            line    = content.find do |l|
+              case target
+              when String
+                l.include?(target)
+              when Regexp
+                l =~ target
+              end
+            end
+
+            line or raise ArgumentError.new("Cannot find `#{target}' inside `#{path}'.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/destroy/mailer.rb

@@ -0,0 +1,74 @@
+module Hanami
+  class CLI
+    module Commands
+      module Destroy
+        # @since 1.1.0
+        # @api private
+        class Mailer < Command
+          requires "environment"
+          desc "Destroy a mailer"
+
+          argument :mailer, required: true, desc: "The mailer name (eg. `welcome`)"
+
+          example [
+            "welcome # Destroy `WelcomeMailer` mailer"
+          ]
+
+          # @since 1.1.0
+          # @api private
+          def call(mailer:, **options)
+            mailer  = Utils::String.transform(mailer, :underscore, :singularize)
+            context = Context.new(mailer: mailer, options: options)
+
+            assert_valid_mailer!(context)
+
+            destroy_mailer_spec(context)
+            destroy_templates(context)
+            destroy_mailer(context)
+          end
+
+          private
+
+          # @since 1.1.0
+          # @api private
+          def assert_valid_mailer!(context)
+            destination = project.mailer(context)
+            return if files.exist?(destination)
+
+            destination = project.mailers(context)
+            warn "cannot find `#{context.mailer}' mailer. Please have a look at `#{destination}' directory to find an existing mailer."
+            exit(1)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def destroy_mailer_spec(context)
+            destination = project.mailer_spec(context)
+
+            files.delete(destination)
+            say(:remove, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def destroy_templates(context)
+            destinations = project.mailer_templates(context)
+            destinations.each do |destination|
+              files.delete(destination)
+              say(:remove, destination)
+            end
+          end
+
+          # @since 1.1.0
+          # @api private
+          def destroy_mailer(context)
+            destination = project.mailer(context)
+
+            files.delete(destination)
+            say(:remove, destination)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/destroy/migration.rb

@@ -0,0 +1,51 @@
+module Hanami
+  class CLI
+    module Commands
+      module Destroy
+        # @since 1.1.0
+        # @api private
+        class Migration < Command
+          desc "Destroy a migration"
+
+          argument :migration, required: true, desc: "The migration name (eg. `create_users`)"
+
+          example [
+            "create_users # Destroy `db/migrations/#{Project.migration_timestamp}_create_users.rb`"
+          ]
+
+          # @since 1.1.0
+          # @api private
+          def call(migration:, **options)
+            migration   = Utils::String.underscore(migration)
+            context     = Context.new(migration: migration, options: options)
+            context     = context.with(destination: project.find_migration(context))
+
+            assert_valid_migration!(context)
+
+            destroy_migration(context)
+            true
+          end
+
+          private
+
+          # @since 1.1.0
+          # @api private
+          def assert_valid_migration!(context)
+            return if !context.destination.nil? && files.exist?(context.destination)
+
+            destination = project.migrations(context)
+            warn "cannot find `#{context.migration}'. Please have a look at `#{destination}' directory to find an existing migration"
+            exit(1)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def destroy_migration(context)
+            files.delete(context.destination)
+            say(:remove, context.destination)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/destroy/model.rb

@@ -0,0 +1,84 @@
+module Hanami
+  class CLI
+    module Commands
+      module Destroy
+        # @since 1.1.0
+        # @api private
+        class Model < Command
+          requires "environment"
+
+          desc "Destroy a model"
+
+          argument :model, required: true, desc: "The model name (eg. `user`)"
+
+          example [
+            "user # Destroy `User` entity and `UserRepository` repository"
+          ]
+
+          # @since 1.1.0
+          # @api private
+          def call(model:, **options)
+            model   = Utils::String.transform(model, :underscore, :singularize)
+            context = Context.new(model: model, options: options)
+
+            assert_valid_model!(context)
+
+            destroy_repository_spec(context)
+            destroy_entity_spec(context)
+            destroy_repository(context)
+            destroy_entity(context)
+          end
+
+          private
+
+          # @since 1.1.0
+          # @api private
+          def assert_valid_model!(context)
+            destination = project.entity(context)
+            return if files.exist?(destination)
+
+            destination = project.entities(context)
+            warn "cannot find `#{context.model}' model. Please have a look at `#{destination}' directory to find an existing model."
+            exit(1)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def destroy_repository_spec(context)
+            destination = project.repository_spec(context)
+
+            files.delete(destination)
+            say(:remove, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def destroy_entity_spec(context)
+            destination = project.entity_spec(context)
+
+            files.delete(destination)
+            say(:remove, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def destroy_repository(context)
+            destination = project.repository(context)
+
+            files.delete(destination)
+            say(:remove, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def destroy_entity(context)
+            destination = project.entity(context)
+
+            files.delete(destination)
+            say(:remove, destination)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli/commands/generate.rb

@@ -0,0 +1,28 @@
+module Hanami
+  # Hanami CLI
+  #
+  # @since 1.1.0
+  class CLI
+    module Commands
+      # @since 1.1.0
+      # @api private
+      module Generate
+        require "hanami/cli/commands/generate/app"
+        require "hanami/cli/commands/generate/action"
+        require "hanami/cli/commands/generate/mailer"
+        require "hanami/cli/commands/generate/migration"
+        require "hanami/cli/commands/generate/model"
+        require "hanami/cli/commands/generate/secret"
+      end
+    end
+
+    register "generate", aliases: ["g"] do |prefix|
+      prefix.register "app",       Commands::Generate::App
+      prefix.register "action",    Commands::Generate::Action
+      prefix.register "mailer",    Commands::Generate::Mailer
+      prefix.register "migration", Commands::Generate::Migration
+      prefix.register "model",     Commands::Generate::Model
+      prefix.register "secret",    Commands::Generate::Secret
+    end
+  end
+end

data/lib/hanami/cli/commands/generate/action.rb

@@ -0,0 +1,224 @@
+module Hanami
+  class CLI
+    module Commands
+      module Generate
+        # @since 1.1.0
+        # @api private
+        class Action < Command
+          requires "environment"
+
+          desc "Generate an action for app"
+
+          example [
+            "web home#index                    # Basic usage",
+            "admin home#index                  # Generate for `admin` app",
+            "web home#index --url=/            # Specify URL",
+            "web sessions#destroy --method=GET # Specify HTTP method",
+            "web books#create --skip-view      # Skip view and template"
+          ]
+
+          argument :app,    required: true, desc: "The application name (eg. `web`)"
+          argument :action, required: true, desc: "The action name (eg. `home#index`)"
+
+          option :url, desc: "The action URL"
+          option :method, desc: "The action HTTP method"
+          option :skip_view, type: :boolean, default: false, desc: "Skip view and template"
+
+          # @since 1.1.0
+          # @api private
+          #
+          # rubocop:disable Metrics/AbcSize
+          # rubocop:disable Metrics/MethodLength
+          def call(app:, action:, **options)
+            controller, action = controller_and_action_name(action)
+            http_method        = route_http_method(action, options)
+            context            = Context.new(app: app, controller: controller, action: action, test: options.fetch(:test), http_method: http_method, options: options)
+            context            = context.with(template: project.template(context))
+
+            assert_valid_app!(context)
+            assert_valid_route_url!(context)
+            assert_valid_route_http_method!(context)
+
+            generate_action(context)
+            generate_view(context)
+            generate_template(context)
+            generate_action_spec(context)
+            generate_view_spec(context)
+            insert_route(context)
+          end
+          # rubocop:enable Metrics/MethodLength
+          # rubocop:enable Metrics/AbcSize
+
+          private
+
+          # @since 1.1.0
+          # @api private
+          def controller_and_action_name(name)
+            # FIXME: extract this regexp
+            name.split(/#|\//)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def assert_valid_app!(context)
+            return if project.app?(context)
+
+            existing_apps = project.apps.map { |name| "`#{name}'" }.join(' ')
+            warn "`#{context.app}' is not a valid APP. Please specify one of: #{existing_apps}"
+            exit(1)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def assert_valid_route_url!(context)
+            if context.options.key?(:url) && Utils::Blank.blank?(context.options[:url]) # rubocop:disable Style/GuardClause
+              warn "`#{context.options[:url]}' is not a valid URL"
+              exit(1)
+            end
+          end
+
+          # @since 1.1.0
+          # @api private
+          def assert_valid_route_http_method!(context)
+            unless Hanami::Routing::Route::VALID_HTTP_VERBS.include?(context.http_method.upcase) # rubocop:disable Style/GuardClause
+              warn "`#{context.http_method.upcase}' is not a valid HTTP method. Please use one of: #{Hanami::Routing::Route::VALID_HTTP_VERBS.map { |verb| "`#{verb}'" }.join(' ')}"
+              exit(1)
+            end
+          end
+
+          # @since 1.1.0
+          # @api private
+          def generate_action(context)
+            source      = if skip_view?(context)
+                            templates.find("action_without_view.erb")
+                          else
+                            templates.find("action.erb")
+                          end
+            destination = project.action(context)
+
+            generate_file(source, destination, context)
+            say(:create, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def generate_view(context)
+            return if skip_view?(context)
+
+            source      = templates.find("view.erb")
+            destination = project.view(context)
+
+            generate_file(source, destination, context)
+            say(:create, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def generate_template(context)
+            return if skip_view?(context)
+            destination = project.template(context)
+
+            files.touch(destination)
+            say(:create, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def generate_action_spec(context)
+            source      = templates.find("action_spec.#{context.test}.erb")
+            destination = project.action_spec(context)
+
+            generate_file(source, destination, context)
+            say(:create, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def generate_view_spec(context)
+            return if skip_view?(context)
+
+            source      = templates.find("view_spec.#{context.test}.erb")
+            destination = project.view_spec(context)
+
+            generate_file(source, destination, context)
+            say(:create, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def insert_route(context)
+            content     = "#{context.http_method} '#{route_url(context)}', to: '#{route_endpoint(context)}'".downcase
+            destination = project.app_routes(context)
+
+            files.append(destination, content)
+            say(:insert, destination)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def route_http_method(action, options)
+            options.fetch(:method) { route_resourceful_http_method(action) }
+          end
+
+          # @since 1.1.0
+          # @api private
+          def skip_view?(context)
+            context.options.fetch(:skip_view, false)
+          end
+
+          # @since 1.1.0
+          # @api private
+          DEFAULT_HTTP_METHOD = 'GET'.freeze
+
+          # @since 1.1.0
+          # @api private
+          RESOURCEFUL_HTTP_METHODS = {
+            'create'  => 'POST',
+            'update'  => 'PATCH',
+            'destroy' => 'DELETE'
+          }.freeze
+
+          # @since 1.1.0
+          # @api private
+          def route_resourceful_http_method(action)
+            RESOURCEFUL_HTTP_METHODS.fetch(action, DEFAULT_HTTP_METHOD)
+          end
+
+          # @since 1.1.0
+          # @api private
+          def route_url(context)
+            context.options.fetch(:url) { route_resourceful_url(context) }
+          end
+
+          # @since 1.1.0
+          # @api private
+          def route_resourceful_url(context)
+            "/#{context.controller}#{route_resourceful_url_suffix(context)}"
+          end
+
+          # @since 1.1.0
+          # @api private
+          RESOURCEFUL_ROUTE_URL_SUFFIXES = {
+            'show'    => '/:id',
+            'update'  => '/:id',
+            'destroy' => '/:id',
+            'new'     => '/new',
+            'edit'    => '/:id/edit'
+          }.freeze
+
+          # @since 1.1.0
+          # @api private
+          def route_resourceful_url_suffix(context)
+            RESOURCEFUL_ROUTE_URL_SUFFIXES.fetch(context.action) { "" }
+          end
+
+          # @since 1.1.0
+          # @api private
+          def route_endpoint(context)
+            "#{context.controller}##{context.action}"
+          end
+        end
+      end
+    end
+  end
+end