stimpack 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6ad8e03da3ba828985b82eccb3840f6f4122d5fe38bcbc7905734a566c7d4cc
-  data.tar.gz: cba30db4834bd3e056ea19c76067945d73378c799b603f1cc931d43ac409cf59
+  metadata.gz: a0fa94f149c0035eb12465252c3262c7bea9df7fad9ea00efb5014d6484b00d1
+  data.tar.gz: a20a5aad13953de01410054b99e3bd2932df56a9e879edc6a14bd3601baca0ba
 SHA512:
-  metadata.gz: d38f3c326b2fa6f327de5b0d2da6e77c1ea58e54c28df8e51887247743699ad3f8cc5e4dc5f769c50eaa80011a6ee8374fd21c4173e3c5c0b59a26ebb9609f82
-  data.tar.gz: 20bd2048490efd0eaa00380263c31c98e1eededa46458e61195c62b4f2c2f4102db1f080eb03efaf3f9496bd5d1777ec06f48109d1cf2dab52332900e41cde98
+  metadata.gz: a7634623fc5fb02369e979fd62f1d816dafc734eacd0d2bab2a47acdce9ec1eeb1b29eccbb88193263623feb3eb94ccf1929065e919bd8d787fce43300dcafbb
+  data.tar.gz: 700f5b8c757d98b6340fb55dee4812c86d449162e65aa1a4946eb5557981ef5b37b306b2f7327703e6f6ddfcd5024db0eb60112c7b087170204704b1ba71fa70

data/README.md

@@ -92,6 +92,35 @@ metadata:
   engine: true
 ```
 
+### RSpec Integration
+Simply add `--require stimpack/rspec` to your `.rspec`.
+Or, if you'd like, pass it as an argument to `rspec`:
+
+```
+$ rspec --require stimpack/rspec ...
+```
+
+Integration will allow you to run tests as such:
+```
+# Run all specs in your entire application (packs and all):
+rspec
+
+# Run just that one test:
+rspec spec/some/specific_spec.rb
+
+# Run all tests under the "foobar" pack and all the tests of its nested packs:
+rspec packs/foobar
+
+# Same as above but also adds the "binbaz" pack:
+rspec packs/foobar pack/binbaz
+
+# Run all test files inside the "packs/foobar/spec" directory:
+rspec packs/foobar/spec
+
+# Run all specs under the "packs/foobar/nested_pack" pack:
+rspec packs/foobar/nested_pack
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Gusto/stimpack.

data/lib/stimpack/integrations/factory_bot.rb

@@ -1,10 +1,10 @@
 module Stimpack
   module Integrations
     class FactoryBot
-      def self.install(app)
+      def initialize(app)
         return unless app.config.respond_to?(:factory_bot)
 
-        Packs.each do |pack|
+        Packs.all.each do |pack|
           app.config.factory_bot.definition_file_paths << pack.relative_path.join("spec/factories").to_s
         end
       end

data/lib/stimpack/integrations/rails.rb

@@ -1,17 +1,53 @@
 # frozen_string_literal: true
 
+require "active_support/inflections"
+
 module Stimpack
   module Integrations
     class Rails
-      def self.install(app)
+      def initialize(app)
+        @app = app
+
         Stimpack.config.paths.freeze
+        create_engines
+        inject_paths
+      end
+
+      def create_engines
+        Packs.all.each do |pack|
+          next unless pack.config.engine?
+
+          pack.engine = create_engine(pack)
+        end
+      end
 
-        Packs.each do |pack|
+      def inject_paths
+        Packs.all.each do |pack|
           Stimpack.config.paths.each do |path|
-            app.paths[path] << pack.path.join(path)
+            @app.paths[path] << pack.path.join(path)
           end
         end
       end
+
+      private
+
+      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.path.relative_path_from(Stimpack::Packs.root)
+        namespace = create_namespace(pack.name)
+        stim = Stim.new(pack, namespace)
+        namespace.const_set("Engine", Class.new(::Rails::Engine)).include(stim)
+      end
     end
   end
 end

data/lib/stimpack/integrations/rspec.rb

@@ -1,19 +1,46 @@
 module Stimpack
   module Integrations
     class RSpec
-      def self.install(app)
-        return unless defined?(::RSpec)
-        # Sometimes, the `rspec-rails` gem is installed in the development
-        # group. This means the ::RSpec module will be defined. However, this
-        # doesn't mean that we've loaded rspec-core, or even about to run tests.
-        # Let's make sure we are actually loading the test environment before
-        # installing our integration. An easy of doing this is seeing of the
-        # configuration method exists on RSpec.
-        return unless ::RSpec.respond_to?(:configuration)
+      def initialize
+        # This is the list of directories RSpec was told to run.
+        to_run = ::RSpec.configuration.instance_variable_get(:@files_or_directories_to_run)
+        default_path = ::RSpec.configuration.default_path
 
-        Packs.each do |pack|
-          ::RSpec.configuration.pattern.concat(",#{pack.relative_path.join("spec/**/*_spec.rb")}")
+        if to_run == [default_path]
+          # This is the default case when you run `rspec`. We want to add all the pack's spec paths
+          # to the collection of directories to run.
+
+          pack_paths = Packs.all.map do |pack|
+            spec_path = pack.relative_path.join(default_path)
+            spec_path.to_s if spec_path.exist?
+          end
+
+          to_run.concat(pack_paths)
+        else
+          # This is when `rspec` is run with a list of directories or files. We scan this list to see
+          # if any of them matches a pack's directory. If it does, we concat the `default_path` to the
+          # 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.all_by_path[path]
+              [
+                pack,
+                *Packs.all(pack)
+              ].map do |pack|
+                spec_path = pack.relative_path.join(default_path)
+                spec_path.to_s if spec_path.exist?
+              end
+            else
+              path
+            end
+          end
         end
+
+        ::RSpec.configuration.files_or_directories_to_run = to_run.flatten.compact.uniq
       end
     end
   end

data/lib/stimpack/pack.rb

@@ -1,53 +1,28 @@
 # frozen_string_literal: true
 
+require "pathname"
+
 module Stimpack
   class Pack
     PACKAGE_FILE = "package.yml"
 
     autoload :Configuration, "stimpack/pack/configuration"
 
-    attr_reader :name
     attr_reader :path
-    attr_reader :engine
-
-    def self.create(path)
-      new(path) if path.join(PACKAGE_FILE).exist?
-    end
+    attr_reader :name
+    attr_accessor :engine
 
     def initialize(path)
       @path = path
-      @name = path.relative_path_from(Packs.root)
-
-      if config.engine?
-        @engine = create_engine
-      end
+      @name = path.basename.to_s
     end
 
     def relative_path
-      @relative_path ||= path.relative_path_from(Rails.root)
+      @relative_path ||= path.relative_path_from(Stimpack.root)
     end
 
     def config
       @config ||= Configuration.new(path.join(PACKAGE_FILE))
     end
-
-    private
-
-    def create_engine
-      namespace = create_namespace(name)
-      stim = Stim.new(self, namespace)
-      namespace.const_set("Engine", Class.new(Rails::Engine)).include(stim)
-    end
-
-    def create_namespace(name)
-      namespace = ActiveSupport::Inflector.camelize(name)
-      namespace.split("::").reduce(Object) do |base, mod|
-        if base.const_defined?(mod)
-          base.const_get(mod)
-        else
-          base.const_set(mod, Module.new)
-        end
-      end
-    end
   end
 end

data/lib/stimpack/packs.rb

@@ -1,43 +1,47 @@
 # frozen_string_literal: true
 
 require "active_support"
-require "pathname"
-require "rails"
 
 module Stimpack
   module Packs
+    PACKAGE_GLOB_PATTERN = "*/#{Pack::PACKAGE_FILE}"
+
     class << self
       def root
-        @root ||= Rails.root.join(Stimpack.config.root)
+        @root ||= Stimpack.root.join(Stimpack.config.root)
       end
 
-      def resolve
-        # Gather all the parent packs and the children packs.
-        package_locations = root.glob('*/{package.yml,*/package.yml}').map(&:dirname)
-        package_locations.sort!.each do |path|
-          next unless pack = Pack.create(path)
-          @packs[pack.name] = pack
+      def find(path)
+        @find_pack_paths ||= all_by_path.keys.sort_by(&:length).reverse!.map { |path| "#{path}/" }
+        path = "#{path}/"
+        @find_pack_paths.find do |pack_path|
+          path.start_with?(pack_path)
         end
-        @packs.freeze
       end
 
-      def find(path)
-        path = "#{path}/"
+      def all(parent = nil)
+        @all ||= resolve(root).each_with_object({}) do |pack, map|
+          map[pack] = resolve(pack.path).freeze
+        end.freeze
 
-        @packs.values.find do |pack|
-          path.start_with?("#{pack.path}/")
+        if parent
+          @all[parent]
+        else
+          @all.keys + @all.values.flatten
         end
       end
 
-      def [](name)
-        @packs[name]
+      def all_by_path
+        @all_by_path ||= all.each_with_object({}) do |pack, map|
+          map[pack.relative_path.to_s] = pack
+        end
       end
 
-      def each(*args, &block)
-        @packs.each_value(*args, &block)
+      private
+
+      def resolve(directory)
+        directory.glob(PACKAGE_GLOB_PATTERN).map { |path| Pack.new(path.dirname) }
       end
     end
-
-    @packs = {}
   end
 end

data/lib/stimpack/railtie.rb

@@ -1,9 +1,11 @@
-require "rails"
+require "rails/railtie"
 
 module Stimpack
   class Railtie < Rails::Railtie
     config.before_configuration do |app|
-      Stimpack.load(app)
+      Integrations::Rails.new(app)
+      Integrations::FactoryBot.new(app)
+
       # This is not used within stimpack. Rather, this allows OTHER tools to
       # hook into Stimpack via ActiveSupport hooks.
       ActiveSupport.run_load_hooks(:stimpack, Packs)

data/lib/stimpack/rspec.rb

@@ -0,0 +1,3 @@
+require "stimpack"
+
+Stimpack::Integrations::RSpec.new

data/lib/stimpack/version.rb

@@ -1,3 +1,3 @@
 module Stimpack
-  VERSION = "0.6.0".freeze
+  VERSION = "0.7.0".freeze
 end

data/lib/stimpack.rb

@@ -1,4 +1,5 @@
 require "active_support"
+require "rails/application"
 
 module Stimpack
   extend ActiveSupport::Autoload
@@ -14,16 +15,8 @@ module Stimpack
   class << self
     attr_reader :config
 
-    def load(app)
-      Packs.resolve
-
-      Integrations::Rails.install(app)
-      Integrations::FactoryBot.install(app)
-      Integrations::RSpec.install(app)
-    end
-
-    def [](name)
-      Packs[name.to_s]
+    def root
+      @root ||= Rails::Application.find_root(Dir.pwd)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stimpack
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ngan Pham
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-12 00:00:00.000000000 Z
+date: 2022-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -115,6 +115,7 @@ files:
 - lib/stimpack/pack/configuration.rb
 - lib/stimpack/packs.rb
 - lib/stimpack/railtie.rb
+- lib/stimpack/rspec.rb
 - lib/stimpack/stim.rb
 - lib/stimpack/version.rb
 homepage: https://github.com/Gusto/stimpack