packs-rails 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4b16ad1fd38eabdd5c57a587cf893991dc3d67a84bc0111f04e647d67878b63
-  data.tar.gz: bfaaaee8ef07fd9dbf5f7056133c18f294095a3db369cc56d10ffa0f8c0edd0d
+  metadata.gz: d2e9f532a3a4f70f1b79b28f767749552e96090e125f0db9747f44d3af937eaa
+  data.tar.gz: ec421b9cba3a19abe3ba0ac684b954889905bd98718f36958a3436cae837b8a6
 SHA512:
-  metadata.gz: 424e39b8c152ee19afb8b85ac5a393145bef1315a7a88acf3fd55bf18033503d4a817313543d397c3b2210013de9aa765a1831f63ee4ffa8a6e5c45e95653e03
-  data.tar.gz: f99f87275c735db75b54dac68001fb3dedef117906b7cd20e6b392df96d200348961e69591fb8979784e855f39526a3cabe372f5626f73d95e5bc8b7b823d4cf
+  metadata.gz: 06fcc2e86606108d58294af5602d885b50824abf18fef2e370b755d8972a3392a2ff7405fcc18107e75f7f590749334c8d097203545ad49f0d987ab03456650a
+  data.tar.gz: 93b094f556c388de9f22dfdb6edada5124bc549789d3d3c16394fc7b49b202c48aa5914406b0e8166d051301720e63dcbd60ab1d097ba6bf1bc03808e8092be8

data/README.md

@@ -59,6 +59,21 @@ From there, you can create a `./packs` folder and structure it using the convent
 
 If you wish to use a different directory name, eg `components` instead of `packs`, you can customize this by configuring `packs.yml`. See [`packs`](https://github.com/rubyatscale/packs) for more information.
 
+If you want to have your packs code namespaced without adding a directory with the pack's name into the directory structure, you can use the [automatic namespaces gem](https://github.com/gap777/automatic_namespaces).
+
+## Modify spring to detect pack moves
+
+If you use spring, when you move a pack, you'll want spring to update its cache
+
+Add this to one of your initializers
+```ruby
+Packs::Specification::Configuration.fetch.pack_paths.each do |dir|
+  Dir["#{dir}/package.yml"].each do |package_yml|
+    Spring.watch(package_yml)
+  end
+end
+```
+
 ### Splitting routes
 `packs-rails` allows you to split your application routes for every pack. You just have to create a file describing your routes and then `draw` them in your root `config/routes.rb` file (NOTE: the `draw` function is only in Rails 6.1+).
 
@@ -72,28 +87,6 @@ Rails.application.routes.draw do
 end
 ```
 
-### Making your Package an Engine
-Add `engine: true` to your `package.yml` to make it an actual Rails engine ([read more about what this means here](https://guides.rubyonrails.org/engines.html)):
-```yml
-# packs/my_pack/package.yml
-enforce_dependencies: true
-enforce_privacy: true
-metadata:
-  engine: true
-```
-
-Add `engine_name: ` to your `package.yml` to use a specific, maybe namespaced, engine name instead of the last package folder name.
-```yml
-# packs/my_pack/package.yml
-enforce_dependencies: true
-enforce_privacy: true
-metadata:
-  engine: true
-  engine_name: namespaced/my_pack
-```
-
-The engine is created as `Namespaced::MyPack::Engine` instead of `MyPack::Engine`.
-
 ## Ecosystem and Integrations
 
 ### RSpec Integration
@@ -150,6 +143,23 @@ packs/
           my_private_namespaced_model_factory.rb
 ```
 
+#### rubocop-rails
+[rubocop-rails](https://github.com/rubocop/rubocop-rails) [targets paths](https://github.com/rubocop/rubocop-rails/blob/master/config/default.yml) starting with `app/`. You might need to override the `Include` globs to include your packs code.
+
+Examples:
+```yml
+Rails/EnumHash:
+  Include:
+    - '**/app/models/**/*.rb'
+Rails/InverseOf:
+  Include:
+    - '**/app/models/**/*.rb'
+Rails/LexicallyScopedActionFilter:
+  Include:
+    - '**/app/controllers/**/*.rb'
+    - '**/app/mailers/**/*.rb'
+```
+
 #### parallel_tests
 
 `parallel_tests` has it its own spec discovery mechanism, so packs-rails's RSpec integration doesn't do anything when you use them together.

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "packs-rails"
+require 'bundler/setup'
+require 'packs-rails'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "packs-rails"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/tapioca

@@ -8,11 +8,11 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
   Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path("../bundle", __FILE__)
+bundle_binstub = File.expand_path('bundle', __dir__)
 
 if File.file?(bundle_binstub)
   if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
@@ -23,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("tapioca", "tapioca")
+load Gem.bin_path('tapioca', 'tapioca')

data/lib/packs/rails/integrations/factory_bot.rb

@@ -8,8 +8,8 @@ module Packs
           return unless app.config.respond_to?(:factory_bot)
 
           Packs.all.reject(&:is_gem?).each do |pack|
-            app.config.factory_bot.definition_file_paths << pack.relative_path.join("spec/factories").to_s
-            app.config.factory_bot.definition_file_paths << pack.relative_path.join("test/factories").to_s
+            app.config.factory_bot.definition_file_paths << pack.relative_path.join('spec/factories').to_s
+            app.config.factory_bot.definition_file_paths << pack.relative_path.join('test/factories').to_s
           end
         end
       end

data/lib/packs/rails/integrations/rails.rb

@@ -1,67 +1,27 @@
 # frozen_string_literal: true
 # typed: true
 
-require "active_support/inflections"
+require 'active_support/inflections'
 
 module Packs
   module Rails
     module Integrations
       class Rails
-        CONFIG_ROUTES_PATH =  "config/routes".freeze
-
         def initialize(app)
           @app = app
 
           Packs::Rails.config.paths.freeze
 
-          create_engines
           inject_paths
         end
 
-        def create_engines
-          Packs.all.reject(&:is_gem?).each do |pack|
-            next unless pack.metadata['engine']
-
-            create_engine(pack)
-          end
-        end
-
         def inject_paths
           Packs.all.reject(&:is_gem?).each do |pack|
             Packs::Rails.config.paths.each do |path|
-              # Prior to Rails 6.1, the "config/routes" app path is nil and was not added until drawable routes feature was implemented
-              # https://github.com/rails/rails/pull/37892/files#diff-a785e41df3f87063a8fcffcac726856a25d8eae6d1f9bca2b36989fe88613f8eR62
-              next if pre_rails_6_1? && path == CONFIG_ROUTES_PATH
-
               @app.paths[path] << pack.relative_path.join(path)
             end
           end
         end
-
-        private
-
-        def pre_rails_6_1?
-          return @_pre_rails_6_1 if defined?(@_pre_rails_6_1)
-          @_pre_rails_6_1 = ::Rails.gem_version < Gem::Version.new("6.1")
-        end
-
-        def create_namespace(name)
-          namespace = ActiveSupport::Inflector.camelize(name)
-          namespace.split("::").reduce(Object) do |base, mod|
-            if base.const_defined?(mod, false)
-              base.const_get(mod, false)
-            else
-              base.const_set(mod, Module.new)
-            end
-          end
-        end
-
-        def create_engine(pack)
-          name = pack.metadata.fetch("engine_name", pack.last_name)
-          namespace = create_namespace(name)
-          stim = Stim.new(pack, namespace)
-          namespace.const_set("Engine", Class.new(::Rails::Engine)).include(stim)
-        end
       end
     end
   end

data/lib/packs/rails/integrations/rspec.rb

@@ -17,6 +17,7 @@ module Packs
 
             pack_paths = Packs.all.map do |pack|
               next if pack.is_gem?
+
               spec_path = pack.relative_path.join(default_path)
               spec_path.to_s if spec_path.exist?
             end
@@ -28,11 +29,11 @@ module Packs
             # end of it.
             #
             # packs/my_pack => packs/my_pack/spec
-            # 
+            #
             # If it doesn't match a pack path, we leave it alone.
 
             to_run.map! do |path|
-              if pack = Packs.find(path)
+              if (pack = Packs.find(path))
                 [
                   pack,
                   *nested_packs_for(pack)

data/lib/packs/rails/integrations.rb

@@ -1,11 +1,11 @@
-require "active_support"
+require 'active_support'
 
 module Packs
   module Rails
     module Integrations
-      autoload :FactoryBot, "packs/rails/integrations/factory_bot"
-      autoload :Rails, "packs/rails/integrations/rails"
-      autoload :RSpec, "packs/rails/integrations/rspec"
+      autoload :FactoryBot, 'packs/rails/integrations/factory_bot'
+      autoload :Rails, 'packs/rails/integrations/rails'
+      autoload :RSpec, 'packs/rails/integrations/rspec'
     end
   end
 end

data/lib/packs/rails/railtie.rb

@@ -1,4 +1,4 @@
-require "rails/railtie"
+require 'rails/railtie'
 
 module Packs
   module Rails
@@ -11,7 +11,6 @@ module Packs
         # hook into packs-rails via ActiveSupport hooks.
         ActiveSupport.run_load_hooks(:packs_rails, Packs)
       end
-      
     end
   end
 end

data/lib/packs/rails/rspec.rb

@@ -1,3 +1,3 @@
-require "packs-rails"
+require 'packs-rails'
 
 Packs::Rails::Integrations::RSpec.new

data/lib/packs/rails/version.rb

@@ -1,5 +1,5 @@
 module Packs
   module Rails
-    VERSION = "0.0.5".freeze
+    VERSION = '0.1.0'.freeze
   end
 end

data/lib/packs-rails.rb

@@ -1,6 +1,6 @@
 require 'packs'
-require "active_support"
-require "rails/application"
+require 'active_support'
+require 'rails/application'
 require 'sorbet-runtime'
 
 module Packs
@@ -9,7 +9,6 @@ module Packs
 
     autoload :Integrations
     autoload :Railtie
-    autoload :Stim
 
     class Error < StandardError; end
 
@@ -22,7 +21,7 @@ module Packs
     end
 
     @config = ActiveSupport::OrderedOptions.new
-    @config.paths = %w(
+    @config.paths = %w[
       app
       app/controllers
       app/channels
@@ -36,8 +35,8 @@ module Packs
       config/locales
       config/initializers
       config/routes
-    )
+    ]
   end
 
-  require "packs/rails/railtie"
+  require 'packs/rails/railtie'
 end

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: packs-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Ngan Pham
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +24,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: packs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,14 +38,28 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: packs
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7'
   type: :runtime
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +94,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: debug
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -155,7 +168,6 @@ files:
 - lib/packs/rails/integrations/rspec.rb
 - lib/packs/rails/railtie.rb
 - lib/packs/rails/rspec.rb
-- lib/packs/rails/stim.rb
 - lib/packs/rails/version.rb
 homepage: https://github.com/rubyatscale/packs-rails
 licenses:
@@ -164,7 +176,6 @@ metadata:
   homepage_uri: https://github.com/rubyatscale/packs-rails
   source_code_uri: https://github.com/rubyatscale/packs-rails
   changelog_uri: https://github.com/rubyatscale/packs-rails/releases
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -172,15 +183,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A Rails helper to package your code.
 test_files: []

data/lib/packs/rails/stim.rb

@@ -1,42 +0,0 @@
-# typed: true
-
-module Packs
-  module Rails
-    class Stim < Module
-      extend T::Sig
-
-      sig { params(pack: Packs::Pack, namespace: Module).void }
-      def initialize(pack, namespace)
-        @pack = pack
-        @namespace = namespace
-        super()
-      end
-
-      def included(engine)
-        engine.called_from = @pack.relative_path
-        engine.extend(ClassMethods)
-        engine.isolate_namespace(@namespace)
-
-        # Set all of these paths to nil because we want the Rails integration to take
-        # care of them. The purpose of this Engine is really just for the namespace
-        # isolation.
-        (Packs::Rails.config.paths +
-          # In addition to the paths we've delegated to the main app, we don't allow
-          # Engine Packs to have various capabilities.
-          %w(
-            config/environments
-            db/migrate
-          )
-        ).uniq.each do |path|
-          engine.paths[path] = nil
-        end
-      end
-
-      module ClassMethods
-        def find_root(_from)
-          T.unsafe(self).called_from
-        end
-      end
-    end
-  end
-end