spell_craft 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '092e3be07d884e6207f4f0c0cf93157609fddd1e62218514f927cccd58275dfe'
-  data.tar.gz: c641a6d3b418b14b03da93af53489c6f0a235cc96373968c33d618b3c1efbfc6
+  metadata.gz: cfb94192846d3309c224e6512046f4031c66198d903f3745adce62ded95aeeb9
+  data.tar.gz: 27820fe9ab3ecf5d985c4232e7d780584fc001a71ad9290f7d839e09d1a36e6a
 SHA512:
-  metadata.gz: cea8a072a79286eb5bd74b6555c491a6578ac5545a78f191b6689824e0d1261f850a5a34ecfdb721a68cc71c16589496b4eaa7f5f537c60a088ebbf5636cbeb5
-  data.tar.gz: 59472374d88a467c8827e2ccb6617f861f76a7093a324adaf8972687a4ba6b3ef974e803e88e998e06b5e367f652724627d679e28a5f6c1ac4d270f2e1084652
+  metadata.gz: 7b6d6a5bd7bc8a8e42fd8da1e9fadeb38ae579197ca63c8489aef379c62d57ff1c591037d0c01cbca42093211e45462ab5afb038f2b2b415b5bd441d003cd5f6
+  data.tar.gz: 0e03842cfb8946170a0fef437eb78edab24c4ebc7d1e2e3e3fbff4eb70a28159a2b704ff89f6db10de42c12d3c02fb7c796e91e49c2642cb20580e46d199c693

data/README.md

@@ -11,6 +11,11 @@ In the future, this project should enable configuration of [dry-rb](https://dry-
 ## Commands
 
 - [ ] `add`: A branch to add configurations
-    - [ ] `repl`: This command should prompt to choose from IRB or pry and add correct configuration to `bin/console`, for pry it should install common extensions like pry reload and pry rescue.
-    - [ ] `autoload`: This command should add the configuration necessary to use zeitwerk on the current project.
+    - [ ] `repl`: This command should prompt to choose from IRB or pry and add correct configuration to `bin/console`, for pry it should install common extensions like pry reload and pry rescue. `(PS: This should support rails)`
+    - [x] `autoload`: This command should add the configuration necessary to use zeitwerk on the current project.
+    - [ ] `type_checking`: This command should add the configuration necessary to use sorbet on the current project. `(PS: This should support rails)`
 - [ ] `remove`: A branch to remove configurations
+
+## Future plans
+
+- Add support for third party generators to be plugged in?

data/lib/cmd/add/autoload.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+# typed: true
+
+require 'async'
+
+module Cmd
+  module Add
+    class Autoload < Dry::CLI::Command
+      extend T::Sig
+
+      desc 'Allow adding configuration for Autoloading and autorequiring on the current application, being either plain zeitwerk or dry-system + zeitwerk'
+
+      option :dry_system, type: :boolean, default: false,
+                          desc: 'Enable the code generator to assume dry-system + zeitwerk configuration'
+
+      ZEITWERK_TEMPLATE = <<~CONTENT
+        # frozen_string_literal: true
+
+        require 'zeitwerk'
+        require 'pathname'
+
+        root = Pathname('.')
+
+        loader = Zeitwerk::Loader.new
+
+        loader.push_dir(root.join('lib').realpath)
+        loader.push_dir(root.join('config').realpath)
+
+        loader.setup
+      CONTENT
+
+      DRY_SYSTEM_TEMPLATE = <<~CONTENT
+        # frozen_string_literal: true
+
+        require 'dry/system'
+
+        # Application configure all the paths to be autoloaded and auto injectable.
+        class Application < Dry::System::Container
+          configure do |config|
+            config.root = Pathname('.')
+
+            config.component_dirs.loader = Dry::System::Loader::Autoloading
+
+            config.component_dirs.add 'lib'
+            config.component_dirs.add 'config'
+          end
+        end
+
+        loader = Zeitwerk::Loader.new
+        loader.push_dir(Application.config.root.join('lib').realpath)
+        loader.push_dir(Application.config.root.join('config').realpath)
+        loader.setup
+      CONTENT
+
+      class DepsType < T::Enum
+        enums do
+          DRY_SYSTEM = new
+          ZEITWERK = new
+        end
+      end
+
+      sig { params(dry_system: T::Boolean).void }
+      def call(dry_system:)
+        return puts 'Could not locate Gemfile' unless Utils::Gem.gemfile_exist?
+
+        Utils::FileSystem.create_directory_if_not_exist('config')
+
+        if dry_system
+          File.write('config/application.rb', DRY_SYSTEM_TEMPLATE)
+
+          install_deps(DepsType::DRY_SYSTEM)
+        end
+
+        return if dry_system
+
+        File.write('config/application.rb', ZEITWERK_TEMPLATE)
+
+        install_deps(DepsType::ZEITWERK)
+      end
+
+      private
+
+      sig { params(type: DepsType).void }
+      def install_deps(type)
+        if Utils::Gem.exists?('dry-system') || Utils::Gem.exists?('zeitwerk') || Utils::Gem.exists?('dry-auto_inject')
+          return
+        end
+
+        pkgs = T.let(['zeitwerk'], T::Array[String])
+
+        pkgs.push('dry-system', 'dry-auto_inject') if type == DepsType::DRY_SYSTEM
+
+        Async do
+          pkgs.each do |pkg|
+            system("bundle add #{pkg}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cmd/add/repl.rb

@@ -41,6 +41,7 @@ module Cmd
         end
       end
 
+      sig { params(irb: T::Boolean, pry: T::Boolean).void }
       def call(irb:, pry:)
         if pry
           response = install_deps
@@ -76,8 +77,10 @@ module Cmd
 
       sig { returns(T.any(Result::Success, Result::Failure)) }
       def install_deps
-        unless File.exist?('Gemfile') || Utils::Shell.binary_exists?('bundle')
-          return Result::Failure.new({ message: 'Gemfile don\'t exist or the bundle gem is not available' })
+        return Result::Failure.new({ message: 'Could not locate Gemfile' }) unless Utils::Gem.gemfile_exist?
+
+        unless Utils::Shell.binary_exists?('bundle')
+          return Result::Failure.new({ message: 'Could not locate bundle gem' })
         end
 
         return Result::Success.new(true) if Utils::Gem.exists?('pry') || Utils::Gem.exists?('pry-reload')

data/lib/cmd/cli.rb

@@ -8,6 +8,7 @@ module Cmd
     register 'version', Version, aliases: ['v', '-v', '--version']
     register 'add', aliases: ['a'] do |prefix|
       prefix.register 'repl', Add::Repl
+      prefix.register 'autoload', Add::Autoload
     end
   end
 end

data/lib/cmd/version.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 # typed: true
 
+require 'rubygems'
+
 module Cmd
   class Version < Dry::CLI::Command
     desc 'Print version'
 
     def call
-      puts '0.0.1'
+      puts Gem::Specification.load('spell_craft.gemspec').version
     end
   end
 end

data/lib/utils/gem.rb

@@ -12,5 +12,10 @@ module Utils
       pattern = /gem\s+['"]#{name}['"]/
       !gemfile_content.scan(pattern).empty?
     end
+
+    sig { returns(T::Boolean) }
+    def self.gemfile_exist?
+      File.exist?('Gemfile')
+    end
   end
 end

data/lib/utils/shell.rb

@@ -8,6 +8,11 @@ module Utils
     sig { params(binary: String).returns(T::Boolean) }
     def self.binary_exists?(binary)
       File.executable?(File.join(ENV.fetch('PATH', '').split(':'), binary))
+      path_dirs = ENV.fetch('PATH', '').split(File::PATH_SEPARATOR)
+
+      !path_dirs.find do |dir|
+        File.exist?(File.join(dir, binary)) && !File.directory?(File.join(dir, binary))
+      end.nil?
     end
   end
 end

data/spell_craft.gemspec

@@ -8,7 +8,7 @@ $LOAD_PATH.unshift(config) unless $LOAD_PATH.include?(config)
 
 Gem::Specification.new do |spec|
   spec.name        = 'spell_craft'
-  spec.version     = '0.1.2'
+  spec.version     = '0.1.3'
   spec.summary     = 'Yet another code generator to make you type less stuff'
   spec.description = 'Yet another code generator to make you type less stuff'
   spec.authors     = ['Cherry Ramatis']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spell_craft
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Cherry Ramatis
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-21 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -49,6 +49,7 @@ files:
 - README.md
 - bin/spell_craft
 - config/application.rb
+- lib/cmd/add/autoload.rb
 - lib/cmd/add/repl.rb
 - lib/cmd/cli.rb
 - lib/cmd/version.rb