Generate struct (with RubyFileGenerator, add RubyFileWriter) #199

cllns · 2024-07-13T06:38:04Z

This adds a 'struct' generator, and some abstractions, a Hanami::CLI::Commands::App::Generate::Command, which handles the creation of a generator object, as well as calling the generator.

We also add a RubyFileWriter class (I don't love the name but it seems OK). This determines what gets passed to RubyFileGenerator, deciding on name of the class, the body, the modules it's nested in, the parent, etc. It's got 8 initializer kwarg params which is a bit much. It can be refactored later but for now it's an implementation detail so I think it's OK. We could break out some of them (relative_parent_class, extranamespace, body) into args on call but then we have to pass them around more, too. Happy to do that if we prefer, though.

Note that this PR is against the branch for #186.

timriley

Looking great, let's get this in!

A couple of tidy-up notes, feel free to take care of those before merging, no further review necessary 👍🏼

timriley · 2024-07-14T01:05:38Z

lib/hanami/cli/commands/app/generate/command.rb

+            def generator_class
+              # Must be implemented by subclasses, with class that takes:
+              # fs:, inflector:, out:
+            end


Ahhhh, you did an equivalent to what I suggested in #186, so we're deinfitely on the same page here 😄

timriley · 2024-07-14T01:06:59Z

lib/hanami/cli/commands/app/generate/struct.rb

+require "dry/inflector"
+require "dry/files"
+require "shellwords"
+require_relative "../../../naming"
+require_relative "../../../errors"


Suggested change

require "dry/inflector"

require "dry/files"

require "shellwords"

require_relative "../../../naming"

require_relative "../../../errors"

require "dry/inflector"

require "dry/files"

require "shellwords"

require_relative "../../../naming"

require_relative "../../../errors"

I don't think we need any of these requires here anymore! Feel free to take them out of this as well as the Generate::Operation command before merging 😄

Oh right, great! Gone

timriley · 2024-07-14T01:11:08Z

lib/hanami/cli/generators/app/ruby_file_writer.rb

+            fs:,
+            inflector:,
+            app_namespace:,
+            key:,
+            slice:,
+            relative_parent_class:,
+            extra_namespace: nil,
+            body: []


Like you mentioned in the description, this is an internal class only so we can tolerate some slightly less ergonomic API design, but I think a refactor to allow a FileWriter instance to be initialised once and then used to write multiple files might be nice.

So this would probably pull the fs: and inflector: params out into #initialize, with the rest going into some method that writes an actual file.

I think this'd be worth playing with sometime, but it's not blocking and I'm definitely keen to get our full range of CLI commands ready for beta1 on Tuesday. So happy if this comes in a follow-up change of some kind :)

Made a note for myself to explore this later

timriley · 2024-07-14T01:12:01Z

spec/unit/hanami/cli/commands/app/generate/struct_spec.rb

+  def output
+    out.rewind && out.read.chomp
+  end


Suggested change

def output

out.rewind && out.read.chomp

end

def output

out.string.chomp

end

I realised there's a way nicer way to do this that avoids mutating the IO object itself.

Sweet. Did this for struct and operation, and made a note to self to fix these for the other generators when I switch them over to using this RubyFileGenerator/Writer

timriley · 2024-07-14T01:13:53Z

spec/unit/hanami/cli/commands/app/generate/struct_spec.rb

+  end
+
+  context "generating for a slice" do
+    it "generates a struct in a top-level namespace, with recommendation" do


Suggested change

it "generates a struct in a top-level namespace, with recommendation" do

it "generates a struct in a top-level namespace" do

I think "with recommendation" might just be a hangover from the operation generator tests?

Busted! Fixed this

timriley · 2024-07-14T01:14:24Z

lib/hanami/cli/generators/app/struct.rb

+      module App
+        # @since 2.2.0
+        # @api private
+        class Struct


These new generators are so tidy 😍

…ad of ERB (#186) * Add dry-operation to default Gemfile * Add base Operation class, based on dry-operation * Fix view spec * Add Operation generators * Add empty `call` method definition * Remove ostruct * Allow slash separator for generator * Allow slash separator for generator * Rename module to admin * Remove newlines in generated files By adding new templates for un-nested operations * Remove input as default args * Remove Operations namespace, generate in app/ or slices/SLICE_NAME/ * Prevent generating operation without namespace * Revert "Prevent generating operation without namespace" This reverts commit a5bd2f3. * Add recommendation to add namespace to operations * Change examples * Switch to outputting directly, remove Files#recommend * Add Hanami::CLI::RubyFileGenerator * x.x.x => 2.2.0 * x.x.x => 2.2.0 * Include Dry::Monads[:result] in base Action * Add .module tests * Convert top-level app operation to use RubyFileGenerator * Convert nested app operation to use RubyFileGenerator * Support slash separators * Convert top-level slice operation to use RubyFileGenerator * Remove OperationContext * Remove namespaces instance variable * Refactor to variables * Remove last temporary instance variable * Refactor * More refactoring, for clarity * Rename variable for clarity * Rename helper method * Simplify RubyFileGenerator, support older versions * Convert Operation generator to use simplified RubyFileGenerator * Remove un-used errors * Refactor * Older kwargs forwarding style * Refactor * Rename variable * Add explanatory comment Add dry-monads include for slice base action * Fix base slice action * Remove un-used ERB templates * Remove OperationContext * Ternary over and/or * Fix missing 'end' from bad merge * Fix namespace recommendation * Extract App::Generate::Command * Specify full name, to use App::Command * Use constants file * Move class methods above initialize * Use constants file * Add yard comments * Revert "Use constants file" This reverts commit 303f502. Would need to namespace it and we may want to this to standalone so keeping it here. It's just two little spaces anyway * Fix indent to be two spaces

* Add dry-operation to default Gemfile * Add base Operation class, based on dry-operation * Fix view spec * Add Operation generators * Add empty `call` method definition * Remove ostruct * Allow slash separator for generator * Allow slash separator for generator * Rename module to admin * Remove newlines in generated files By adding new templates for un-nested operations * Remove input as default args * Remove Operations namespace, generate in app/ or slices/SLICE_NAME/ * Prevent generating operation without namespace * Revert "Prevent generating operation without namespace" This reverts commit a5bd2f3. * Add recommendation to add namespace to operations * Change examples * Switch to outputting directly, remove Files#recommend * Add Hanami::CLI::RubyFileGenerator * x.x.x => 2.2.0 * x.x.x => 2.2.0 * Include Dry::Monads[:result] in base Action * Add .module tests * Convert top-level app operation to use RubyFileGenerator * Convert nested app operation to use RubyFileGenerator * Support slash separators * Convert top-level slice operation to use RubyFileGenerator * Remove OperationContext * Remove namespaces instance variable * Refactor to variables * Remove last temporary instance variable * Refactor * More refactoring, for clarity * Rename variable for clarity * Rename helper method * Simplify RubyFileGenerator, support older versions * Convert Operation generator to use simplified RubyFileGenerator * Remove un-used errors * Refactor * Older kwargs forwarding style * Refactor * Rename variable * Add explanatory comment Add dry-monads include for slice base action * Fix base slice action * Remove un-used ERB templates * Remove OperationContext * Ternary over and/or * Fix missing 'end' from bad merge * Fix namespace recommendation * Extract App::Generate::Command * Specify full name, to use App::Command * Use constants file * Move class methods above initialize * Use constants file * Add yard comments * Revert "Use constants file" This reverts commit 303f502. Would need to namespace it and we may want to this to standalone so keeping it here. It's just two little spaces anyway * Fix indent to be two spaces * Generate struct (with RubyFileGenerator, add RubyFileWriter) (#199) * Add struct generator * Extract App::Generate::Command * Specify full name, to use App::Command * Use App::Generate::Command for Struct * Use KEY_SEPARATOR from constants file * Provide generator class to command * Extract Helper, use for Struct generator * Fix specs with Helper * kwargs * Rename helper to RubyFileWriter * Fix examples * Remove optional kwarg * Reorder args * Rename to relative_parent_class * Remove duplicate implementation * Add api doc comments * Reorder methods * Refactor initialize * Refactor to use method instead of arg * Refactor to move logic into generator * Reorder assignments * Add Hanami::CLI::RubyFileGenerator, convert Operation to use it instead of ERB (#186) * Add dry-operation to default Gemfile * Add base Operation class, based on dry-operation * Fix view spec * Add Operation generators * Add empty `call` method definition * Remove ostruct * Allow slash separator for generator * Allow slash separator for generator * Rename module to admin * Remove newlines in generated files By adding new templates for un-nested operations * Remove input as default args * Remove Operations namespace, generate in app/ or slices/SLICE_NAME/ * Prevent generating operation without namespace * Revert "Prevent generating operation without namespace" This reverts commit a5bd2f3. * Add recommendation to add namespace to operations * Change examples * Switch to outputting directly, remove Files#recommend * Add Hanami::CLI::RubyFileGenerator * x.x.x => 2.2.0 * x.x.x => 2.2.0 * Include Dry::Monads[:result] in base Action * Add .module tests * Convert top-level app operation to use RubyFileGenerator * Convert nested app operation to use RubyFileGenerator * Support slash separators * Convert top-level slice operation to use RubyFileGenerator * Remove OperationContext * Remove namespaces instance variable * Refactor to variables * Remove last temporary instance variable * Refactor * More refactoring, for clarity * Rename variable for clarity * Rename helper method * Simplify RubyFileGenerator, support older versions * Convert Operation generator to use simplified RubyFileGenerator * Remove un-used errors * Refactor * Older kwargs forwarding style * Refactor * Rename variable * Add explanatory comment Add dry-monads include for slice base action * Fix base slice action * Remove un-used ERB templates * Remove OperationContext * Ternary over and/or * Fix missing 'end' from bad merge * Fix namespace recommendation * Extract App::Generate::Command * Specify full name, to use App::Command * Use constants file * Move class methods above initialize * Use constants file * Add yard comments * Revert "Use constants file" This reverts commit 303f502. Would need to namespace it and we may want to this to standalone so keeping it here. It's just two little spaces anyway * Fix indent to be two spaces * Remove extraneous requires * Use out.string.chomp * Fix name of expectation

cllns added 23 commits July 11, 2024 11:15

Add struct generator

1e76baf

Extract App::Generate::Command

5af9174

Specify full name, to use App::Command

56b4efd

Use App::Generate::Command for Struct

0c3c82e

Use KEY_SEPARATOR from constants file

a96824b

Merge remote-tracking branch 'origin' into generate-struct

a50bf69

Provide generator class to command

58ea3a2

Extract Helper, use for Struct generator

2074f29

Fix specs with Helper

4c7d32e

kwargs

8ae3759

Rename helper to RubyFileWriter

a72563c

Fix examples

c1c18f2

Remove optional kwarg

b267599

Reorder args

fb5db92

Rename to relative_parent_class

4a18674

Remove duplicate implementation

777926e

Add api doc comments

eb13588

Reorder methods

77d5105

Merge branch 'add-file-generator' into generate-struct

a8ab35f

Refactor initialize

06edf05

Refactor to use method instead of arg

9f43646

Refactor to move logic into generator

9b0c5b2

Reorder assignments

bc4d117

This was referenced Jul 13, 2024

Generate repo #200

Merged

Add Hanami::CLI::RubyFileGenerator, convert Operation to use it instead of ERB #186

Merged

timriley approved these changes Jul 14, 2024

View reviewed changes

cllns and others added 2 commits July 13, 2024 19:42

Merge remote-tracking branch 'origin/main' into generate-struct

5fac400

cllns force-pushed the generate-struct branch from 8ba77d3 to 5fac400 Compare July 14, 2024 01:55

Remove extraneous requires

3137709

cllns added 2 commits July 13, 2024 19:59

Use out.string.chomp

b862270

Fix name of expectation

a5953e4

cllns merged commit cb06023 into add-file-generator Jul 14, 2024
3 checks passed

This was referenced Jul 14, 2024

Use slice.source_path in RubyFileWriter #202

Closed

Generate struct #203

Merged

timriley deleted the generate-struct branch July 14, 2024 11:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate struct (with RubyFileGenerator, add RubyFileWriter) #199

Generate struct (with RubyFileGenerator, add RubyFileWriter) #199

cllns commented Jul 13, 2024

timriley left a comment •

edited

Loading

timriley Jul 14, 2024

timriley Jul 14, 2024

cllns Jul 14, 2024

timriley Jul 14, 2024

cllns Jul 14, 2024

timriley Jul 14, 2024

cllns Jul 14, 2024

timriley Jul 14, 2024

cllns Jul 14, 2024

timriley Jul 14, 2024

	it "generates a struct in a top-level namespace, with recommendation" do
	it "generates a struct in a top-level namespace" do

Generate struct (with RubyFileGenerator, add RubyFileWriter) #199

Generate struct (with RubyFileGenerator, add RubyFileWriter) #199

Conversation

cllns commented Jul 13, 2024

timriley left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

timriley left a comment •

edited

Loading