upgrow 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee034f6fa4ddd317a01b6f80d4762259f205a6763cd06fdfa637cdac186f0063
-  data.tar.gz: 82b9fa66aab3ca2b3bec78ef2c04415d5aa199c0eb9734216010ae0806bb5476
+  metadata.gz: 5b23ff76f5c5a26695d3b695084c7196938b758c924c433a9abf17f1918aa7c3
+  data.tar.gz: 6799c1a519cddbfa59f16817d4589a6b935c6a581fd7a9b34a58a1ded5399c92
 SHA512:
-  metadata.gz: 720d3134774aac67239a7681e2e61dcc525fbd8e38852ebb07f2ec82b8be8cc61ac0b71bcaea13fd375e2fc027bd5092aae11fdd70269da1d1fb299325afbd42
-  data.tar.gz: 0f16e74a9a07c2e186f10ec14806fc8c59890149204252f25ff2fbc083d8284625f1967a9a74db5e5d1dfb377f315aec864c739a39c8542071a622991bcf8bfb
+  metadata.gz: 5c239023970e3d67967420c64bcf836b6c7ae6e56034e04a676148aafb78e99f364a3ab821f11bcc1392e59ce7627f0d5c4c183e734a3631be74d6f5e0f46a8b
+  data.tar.gz: 75eb566265b8904dfffd8edb2069ebe4cc676a4e9150d7b0cc507a7c607d6049e4becd66c285a50ad8786336acbe3d7f05d386e9363dade2893a13c40ef6d544

data/lib/generators/test_unit/input/input_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'generators/upgrow'
+
+module TestUnit
+  module Generators
+    class InputGenerator < Rails::Generators::NamedBase
+      include Upgrow::Generators::Helper
+
+      def create_test_file
+        template('input_test.rb',
+          File.join('test/inputs', class_path, "#{file_name}_input_test.rb"))
+      end
+
+      private
+
+      def file_name
+        super.delete_suffix('_input')
+      end
+    end
+  end
+end

data/lib/generators/test_unit/input/templates/input_test.rb.tt

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+<% module_namespacing do -%>
+class <%= class_name %>InputTest < ActiveSupport::TestCase
+end
+<% end -%>

data/lib/generators/test_unit/install/install_generator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'generators/upgrow'
+
+module TestUnit
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Upgrow::Generators::Helper
+
+      def move_existing_models
+        pattern = File.expand_path('test/models/**/*_test.rb', destination_root)
+        files = Dir.glob(pattern)
+
+        return if files.empty?
+
+        unless yes?('Would you like to convert existing model tests into '\
+          'Record tests?', :blue)
+          say(
+            'Please convert your model tests into Record tests manually by '\
+            'moving them to the test/records directory and adding the '\
+            'RecordTest suffix to their class names.',
+            :yellow
+          )
+          return
+        end
+
+        files.each do |original|
+          target = relative_to_original_destination_root(original)
+            .sub(%r{\Atest/models/}, 'test/records/')
+            .sub(/^(.+(?<!_record))_test\.rb\z/, '\1_record_test.rb')
+
+          move_file(original, target)
+
+          inject_into_file(
+            target, 'Record',
+            before: /(?<!Record)Test < /,
+            force: true,
+            verbose: false
+          )
+        end
+      end
+
+      def create_test_directories
+        directory('test')
+      end
+    end
+  end
+end

data/lib/generators/test_unit/record/record_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'generators/upgrow'
+
+module TestUnit
+  module Generators
+    class RecordGenerator < Rails::Generators::NamedBase
+      include Upgrow::Generators::Helper
+
+      def create_test_file
+        template('record_test.rb',
+          File.join('test/records', class_path, "#{file_name}_record_test.rb"))
+      end
+
+      private
+
+      def file_name
+        super.delete_suffix('_record')
+      end
+    end
+  end
+end

data/lib/generators/test_unit/record/templates/record_test.rb.tt

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+<% module_namespacing do -%>
+class <%= class_name %>RecordTest < ActiveSupport::TestCase
+end
+<% end -%>

data/lib/generators/test_unit/repository/repository_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'generators/upgrow'
+
+module TestUnit
+  module Generators
+    class RepositoryGenerator < Rails::Generators::NamedBase
+      include Upgrow::Generators::Helper
+
+      def create_test_file
+        template('repository_test.rb',
+          File.join('test/repositories', class_path,
+            "#{file_name}_repository_test.rb"))
+      end
+
+      private
+
+      def file_name
+        super.delete_suffix('_repository')
+      end
+    end
+  end
+end

data/lib/generators/test_unit/repository/templates/repository_test.rb.tt

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+<% module_namespacing do -%>
+class <%= class_name %>RepositoryTest < ActiveSupport::TestCase
+end
+<% end -%>

data/lib/generators/upgrow.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Upgrow
+  module Generators
+    module Helper
+      module ClassMethods
+        def base_root
+          __dir__
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      def move_file(origin, destination)
+        origin = File.expand_path(origin, destination_root)
+        destination = File.expand_path(destination, destination_root)
+
+        say_status(
+          :move,
+          "#{relative_to_original_destination_root(origin)} -> " +
+            relative_to_original_destination_root(destination)
+        )
+
+        FileUtils.mkdir_p(File.dirname(destination))
+        FileUtils.mv(origin, destination)
+      end
+
+      def class_name
+        file_name.camelize
+      end
+
+      def module_namespacing(&block)
+        super do
+          content = capture(&block)
+          concat(namespace_content(class_path, content))
+        end
+      end
+
+      def namespace_content(namespaces, content)
+        namespace = namespaces.shift
+
+        content = namespace_content(namespaces, content) if namespaces.any?
+
+        if namespace
+          "module #{namespace.camelize}\n#{indent(content).chomp}\nend\n"
+        else
+          content
+        end
+      end
+    end
+  end
+end

data/lib/generators/upgrow/action/USAGE

@@ -0,0 +1,13 @@
+Description:
+
+    Creates a new Action class with the given name under `app/actions`.
+
+    Since Actions are not expected to be unit tested, this generator does not
+    invoke the test framework generator. Action behaviour is supposed to be
+    tested with integration or system tests.
+
+Example:
+
+    `bin/rails g upgrow:action articles/create`
+
+    create  app/actions/articles/create_action.rb

data/lib/generators/upgrow/action/action_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'generators/upgrow'
+
+module Upgrow
+  module Generators
+    class ActionGenerator < Rails::Generators::NamedBase
+      include Helper
+
+      def create_action_file
+        template(
+          'action.rb',
+          File.join('app/actions', class_path, "#{file_name}_action.rb")
+        )
+      end
+
+      private
+
+      def file_name
+        super.delete_suffix('_action')
+      end
+    end
+  end
+end

data/lib/generators/upgrow/action/templates/action.rb.tt

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= class_name %>Action < ApplicationAction
+  def perform(*args)
+    # Do something here.
+  end
+end
+<% end -%>

data/lib/generators/upgrow/input/USAGE

@@ -0,0 +1,10 @@
+Description:
+
+    Creates a new Input class with the given name under `app/inputs`.
+
+Example:
+
+    `bin/rails g upgrow:input article`
+
+    create  app/inputs/article_input.rb
+    invoke  test_unit

data/lib/generators/upgrow/input/input_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'generators/upgrow'
+
+module Upgrow
+  module Generators
+    class InputGenerator < Rails::Generators::NamedBase
+      include Helper
+
+      def create_input_file
+        template(
+          'input.rb',
+          File.join('app/inputs', class_path, "#{file_name}_input.rb")
+        )
+      end
+
+      hook_for :test_framework
+
+      private
+
+      def file_name
+        super.delete_suffix('_input')
+      end
+    end
+  end
+end

data/lib/generators/upgrow/input/templates/input.rb.tt

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+<% module_namespacing do -%>
+class <%= class_name %>Input < ApplicationInput
+end
+<% end -%>

data/lib/generators/upgrow/install/USAGE

@@ -0,0 +1,25 @@
+Description:
+
+    Creates the additional directories and files for development using the
+    Upgrow architecture. This generator will create the base classes for your
+    Actions, Inputs, Repositories, and Models. It will also ask if you would
+    like to convert your existing Ruby files under `app/models` into Upgrow
+    Records automatically. If you say yes, it will move those files to
+    `app/records` and change their class names to include the `Record` suffix.
+    In case an `ApplicationRecord` exists, the generator will assume this to be
+    the base class for all Records, and it will include the `Upgrow::Record`
+    module in it.
+
+Example:
+
+    `bin/rails generate upgrow:install`
+
+    Would you like to convert all models into Records? yes
+        move  app/models/application_record.rb -> app/records/application_record.rb
+        move  app/models/article.rb -> app/records/article_record.rb
+       exist  app
+      create  app/actions/application_action.rb
+      create  app/inputs/application_input.rb
+      create  app/models/application_model.rb
+      create  app/repositories/application_repository.rb
+      invoke  test_unit

data/lib/generators/upgrow/install/install_generator.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'generators/upgrow'
+
+module Upgrow
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Helper
+
+      def move_existing_models
+        pattern = File.expand_path('app/models/**/*.rb', destination_root)
+        files = Dir.glob(pattern)
+
+        return if files.empty?
+
+        unless yes?('Would you like to convert all models into Records?', :blue)
+          say(
+            'Please convert your existing models into Records manually. You '\
+            'may move them to the app/records folder, add the Record suffix '\
+            'to their class names, and include Upgrow::Record.',
+            :yellow
+          )
+          return
+        end
+
+        files.each do |original|
+          target = relative_to_original_destination_root(original)
+            .sub(%r{\Aapp/models/}, 'app/records/')
+            .sub(/^(.+(?<!_record))\.rb\z/, '\1_record.rb')
+
+          move_file(original, target)
+
+          inject_into_file(
+            target, 'Record',
+            after: /class (?!\w+Record\s)\w+/,
+            force: true,
+            verbose: false
+          )
+
+          inject_into_class(
+            target,
+            'ApplicationRecord',
+            "  include Upgrow::Record\n",
+            verbose: false
+          )
+        end
+      end
+
+      def create_app_files
+        directory('app')
+      end
+
+      hook_for :test_framework
+    end
+  end
+end

data/lib/generators/upgrow/install/templates/app/actions/application_action.rb.tt

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationAction < Upgrow::Action
+end

data/lib/generators/upgrow/install/templates/app/inputs/application_input.rb.tt

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationInput < Upgrow::Input
+end

data/lib/generators/upgrow/install/templates/app/models/application_model.rb.tt

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationModel < Upgrow::Model
+end

data/lib/generators/upgrow/install/templates/app/repositories/application_repository.rb.tt

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ApplicationRepository < Upgrow::Repository
+end

data/lib/generators/upgrow/model/USAGE

@@ -0,0 +1,10 @@
+Description:
+
+    Creates a new Model class with the given name under `app/models`.
+
+Example:
+
+    `bin/rails g upgrow:model article`
+
+    create  app/models/article.rb
+    invoke  test_unit

data/lib/generators/upgrow/model/model_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'generators/upgrow'
+
+module Upgrow
+  module Generators
+    class ModelGenerator < Rails::Generators::NamedBase
+      include Helper
+
+      def create_model_file
+        template(
+          'model.rb',
+          File.join('app/models', class_path, "#{file_name}.rb")
+        )
+      end
+
+      hook_for :repository, default: :upgrow, as: :repository
+
+      hook_for :record, default: :upgrow, as: :record
+
+      hook_for :test_framework
+    end
+  end
+end