packs 0.0.44 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3409cd21dc5284518fa90923038c0dee964186909b2934445ae0872d97b2c101
-  data.tar.gz: 9bac9fc2170f7aeaa52e4b141dd37cfcf19fb7c3577a80e29d49cfb07dfd229b
+  metadata.gz: cedac59e21e3cfabcc0e70369a37f099d917c6092c75a9415e4935a9bec705af
+  data.tar.gz: 36307b5c6d741d2145e73b827ea66ace06cffa0123101443f4b0d2b30e09a5e9
 SHA512:
-  metadata.gz: 40891c45799b1d861ac76794f3645250c213d217c3b92178af89bb07f519b4fe13ee1650efb693c9a1d859742860dc32ee1ceca7bdedeffb593bd951b25ec5de
-  data.tar.gz: 3a212158f68da47f7a38ca60b16193ba72cdceb319c302aca547eae49f4a351d379cbe8d334703a4caf6d9c6fea4752a8959c76f18552fee9fda162069d635f9
+  metadata.gz: 9478f4344cdb4dc234abb52da988b9e63033234a78289d9bdcbdacb738f911c6fb98050b0c699d19157f100df7a0139ff0a4be453776bdefc0aafd140a71d9e8
+  data.tar.gz: 718c24457bc7b6f5d0b471f2954dbff83ebbbbb0602a32295fb8ffc6d0e9cfea44a8e49c3a9d26c938b78e34d1d67d774502b8db1b659e5a3f88cd3f7071802d

data/README.md

@@ -15,6 +15,11 @@ pack_paths:
   - gems/* # gems can be packs too!
 ```
 
+To customize the README template, include a `README_TEMPLATE.md` file in the root of your project. If you want to use a custom path for your README template, you can specify it in the `packs.yml` file in the root of your project:
+```yml
+readme_template_path: my_folder/README_STUFF.md
+```
+
 # Ecosystem
 The rest of the [rubyatscale](https://github.com/rubyatscale) ecosystem is intended to help make using packs and improving the boundaries between them more clear.
 

data/lib/packs/configuration.rb

@@ -7,6 +7,9 @@ module Packs
   class Configuration
     extend T::Sig
 
+    CONFIGURATION_PATHNAME = T.let(Pathname.new('packs.yml'), Pathname)
+    DEFAULT_README_TEMPLATE_PATHNAME = T.let(Pathname.new('README_TEMPLATE.md'), Pathname)
+
     sig { params(enforce_dependencies: T::Boolean).void }
     attr_writer :enforce_dependencies
 
@@ -45,6 +48,18 @@ module Packs
     def default_enforce_dependencies
       true
     end
+
+    sig { returns(Pathname) }
+    def readme_template_pathname
+      config_hash = CONFIGURATION_PATHNAME.exist? ? YAML.load_file(CONFIGURATION_PATHNAME) : {}
+
+      specified_readme_template_path = config_hash['readme_template_path']
+      if specified_readme_template_path.nil?
+        DEFAULT_README_TEMPLATE_PATHNAME
+      else
+        Pathname.new(specified_readme_template_path)
+      end
+    end
   end
 
   class << self

data/lib/packs/private/file_move_operation.rb

@@ -53,15 +53,20 @@ module Packs
 
       sig { returns(FileMoveOperation) }
       def spec_file_move_operation
+        path_parts = filepath_without_pack_name.split('/')
+        folder = T.must(path_parts[0])
+        file_extension = T.must(filepath_without_pack_name.split('.').last)
+
         # This could probably be implemented by some "strategy pattern" where different extension types are handled by different helpers
         # Such a thing could also include, for example, when moving a controller, moving its ERB view too.
-        if origin_pathname.extname == '.rake'
-          new_origin_pathname = origin_pathname.sub('/lib/', '/spec/lib/').sub(%r{^lib/}, 'spec/lib/').sub('.rake', '_spec.rb')
-          new_destination_pathname = destination_pathname.sub('/lib/', '/spec/lib/').sub(%r{^lib/}, 'spec/lib/').sub('.rake', '_spec.rb')
+        if folder == 'app'
+          new_origin_pathname = spec_pathname_for_app(origin_pathname, file_extension)
+          new_destination_pathname = spec_pathname_for_app(destination_pathname, file_extension)
         else
-          new_origin_pathname = origin_pathname.sub('/app/', '/spec/').sub(%r{^app/}, 'spec/').sub('.rb', '_spec.rb')
-          new_destination_pathname = destination_pathname.sub('/app/', '/spec/').sub(%r{^app/}, 'spec/').sub('.rb', '_spec.rb')
+          new_origin_pathname = spec_pathname_for_non_app(origin_pathname, file_extension, folder)
+          new_destination_pathname = spec_pathname_for_non_app(destination_pathname, file_extension, folder)
         end
+
         FileMoveOperation.new(
           origin_pathname: new_origin_pathname,
           destination_pathname: new_destination_pathname,
@@ -69,8 +74,38 @@ module Packs
         )
       end
 
+      sig { params(filepath: Pathname, pack: T.nilable(Packs::Pack)).returns(String) }
+      def self.get_filepath_without_pack_name(filepath, pack)
+        if pack
+          filepath.to_s.gsub("#{pack.name}/", '')
+        else
+          filepath.to_s
+        end
+      end
+
       private
 
+      sig { returns(String) }
+      def filepath_without_pack_name
+        self.class.get_filepath_without_pack_name(origin_pathname, origin_pack)
+      end
+
+      sig { params(pathname: Pathname, file_extension: String).returns(Pathname) }
+      def spec_pathname_for_app(pathname, file_extension)
+        pathname
+          .sub('/app/', '/spec/')
+          .sub(%r{^app/}, 'spec/')
+          .sub(".#{file_extension}", '_spec.rb')
+      end
+
+      sig { params(pathname: Pathname, file_extension: String, folder: String).returns(Pathname) }
+      def spec_pathname_for_non_app(pathname, file_extension, folder)
+        pathname
+          .sub("/#{folder}/", "/spec/#{folder}/")
+          .sub(%r{^#{folder}/}, "spec/#{folder}/")
+          .sub(".#{file_extension}", '_spec.rb')
+      end
+
       sig { params(path: Pathname).returns(FileMoveOperation) }
       def relative_to(path)
         FileMoveOperation.new(

data/lib/packs/user_event_logger.rb

@@ -148,6 +148,11 @@ module Packs
 
     sig { params(pack_name: String).returns(String) }
     def on_create_readme_todo(pack_name)
+      readme_template_pathname = Packs.config.readme_template_pathname
+      readme_template = readme_template_pathname.read if readme_template_pathname.exist?
+
+      return readme_template unless readme_template.nil?
+
       <<~MSG
         Welcome to `#{pack_name}`!
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: packs
 version: !ruby/object:Gem::Version
-  version: 0.0.44
+  version: 0.1.0
 platform: ruby
 authors:
 - Gusto Engineers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-12 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -344,7 +344,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Provides CLI tools for working with ruby packs.