feature_pack 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 102101eb87f4153fd1db6cdd46f15bf1776912773498a1f585db49e7a6be707d
-  data.tar.gz: a3492ed0b1add63f95a171964c2e688f9d94d351d18112c2961aabcb1c80b845
+  metadata.gz: 7451b49f9dda65ec4aa60a6bb26a976f09258c292221ac884f6a1f2db7dd769b
+  data.tar.gz: eccbe2c439b2810c149a174225f9a20821a28f16b0af5876bf9bc32ef22d3f04
 SHA512:
-  metadata.gz: d959f7066efab1bb4371914ad61689384d4c6d9a25c4bbc57a0982f14c6cb694c7025aa5e81557790e52327e6112c6ef28cac5e36612abcfaf01f432d5fe01f1
-  data.tar.gz: f6e1c3c5bd1518732d146567446b4a36b4f4812605425c7ee476c0951685ab97f1ed4f4a87d91defbfb0b876b4428620a7fe28d3737a09b26142b2ad72671c9a
+  metadata.gz: eedb788af59f03e15dbc7d54d4da52c40491f9374e32160c40779f8318b084566961005802261b34b87c6c2cf9134b68c6fc21c9c7ed26671894bbd5744bfa44
+  data.tar.gz: 9ea9c70925ed3293e7bb1348e7eb3276d0db1ff2129bf17380b1b43769f043b7c1a98cd566605cd8cdad723d0c0efb87d98b2f6536725f07e4c004fd57b07ac5

data/doc/hooks.md

@@ -0,0 +1,108 @@
+# Sistema de Hooks do FeaturePack
+
+## Hook after_initialize
+
+O FeaturePack agora suporta hooks `after_initialize` que permitem executar código customizado após o carregamento de grupos e features.
+
+### Como funciona
+
+Durante o processo de setup do FeaturePack, após todos os grupos e features serem descobertos e configurados, o sistema procura e executa arquivos `after_initialize.rb` específicos.
+
+### Localização dos arquivos
+
+- **Para grupos**: `app/feature_packs/[nome_do_grupo]/_group_space/after_initialize.rb`
+- **Para features**: `app/feature_packs/[nome_do_grupo]/[nome_da_feature]/after_initialize.rb`
+
+### Contexto de execução
+
+Os arquivos `after_initialize.rb` são executados no contexto do objeto group ou feature, permitindo acesso direto a todas as suas propriedades através de `self`.
+
+### Exemplos de uso
+
+#### Hook para grupo
+
+```ruby
+# app/feature_packs/group_admin/_group_space/after_initialize.rb
+
+# Registrar o grupo em um sistema de auditoria
+Rails.logger.info "Grupo #{name} carregado com #{features.size} features"
+
+# Configurar permissões globais do grupo
+features.each do |feature|
+  Rails.logger.info "  - Feature #{feature.name} disponível em #{feature.manifest[:url]}"
+end
+
+# Carregar configurações específicas do grupo
+config_file = File.join(absolute_path, GROUP_SPACE_DIRECTORY, 'config.yml')
+if File.exist?(config_file)
+  @config = YAML.load_file(config_file)
+end
+```
+
+#### Hook para feature
+
+```ruby
+# app/feature_packs/group_admin/feature_users/after_initialize.rb
+
+# Registrar rotas dinâmicas
+Rails.logger.info "Feature #{name} inicializada no grupo #{group.name}"
+
+# Verificar dependências
+required_gems = %w[devise cancancan]
+required_gems.each do |gem_name|
+  unless Gem.loaded_specs.key?(gem_name)
+    Rails.logger.warn "Feature #{name} requer a gem #{gem_name}"
+  end
+end
+
+# Registrar a feature em um sistema de métricas
+StatsD.increment("features.#{group.name}.#{name}.loaded")
+
+# Configurar cache específico da feature
+Rails.cache.write("feature:#{group.name}:#{name}:loaded_at", Time.current)
+```
+
+### Propriedades disponíveis
+
+#### No contexto de grupo
+
+- `name` - Nome do grupo (symbol)
+- `absolute_path` - Caminho absoluto do grupo
+- `relative_path` - Caminho relativo do grupo
+- `features` - Array com todas as features do grupo
+- `manifest` - Hash com dados do manifest.yaml
+- `routes_file` - Caminho do arquivo de rotas
+
+#### No contexto de feature
+
+- `name` - Nome da feature (symbol)
+- `group` - Referência ao grupo pai
+- `absolute_path` - Caminho absoluto da feature
+- `relative_path` - Caminho relativo da feature
+- `namespace` - Módulo Ruby da feature
+- `manifest` - Hash com dados do manifest.yaml
+- `routes_file` - Caminho do arquivo de rotas
+
+### Casos de uso comuns
+
+1. **Logging e auditoria** - Registrar quando grupos/features são carregados
+2. **Validação de dependências** - Verificar se gems ou recursos necessários estão disponíveis
+3. **Configuração dinâmica** - Carregar configurações específicas
+4. **Registro em sistemas externos** - Integrar com sistemas de métricas ou monitoramento
+5. **Inicialização de recursos** - Preparar caches, conexões ou outros recursos
+6. **Verificação de segurança** - Validar permissões ou políticas de acesso
+
+### Boas práticas
+
+1. Mantenha os hooks leves e rápidos - eles são executados durante o boot da aplicação
+2. Use logging apropriado para facilitar debug
+3. Trate exceções adequadamente para não quebrar o processo de inicialização
+4. Evite operações síncronas pesadas (I/O, rede, etc)
+5. Use o hook apenas para configurações que realmente precisam acontecer após a carga completa
+
+### Ordem de execução
+
+1. Todos os grupos são descobertos e configurados
+2. Todas as features são descobertas e configuradas
+3. Hooks `after_initialize` dos grupos são executados
+4. Hooks `after_initialize` das features são executados (na ordem de descoberta)

data/lib/feature_pack.rb

@@ -11,6 +11,7 @@ module FeaturePack
   GROUP_SPACE_DIRECTORY = '_group_space'.freeze
   MANIFEST_FILE_NAME = 'manifest.yaml'.freeze
   CONTROLLER_FILE_NAME = 'controller.rb'.freeze
+  AFTER_INITIALIZE_FILE_NAME = '__after_initialize.rb'.freeze
 
   # Attribute readers that will be dynamically defined
   ATTR_READERS = %i[
@@ -39,9 +40,7 @@ module FeaturePack
     # Finds a group by name
     # @param group_name [Symbol] The name of the group
     # @return [OpenStruct, nil] The group object or nil if not found
-    def group(group_name)
-      @@groups.find { |g| g.name.eql?(group_name) }
-    end
+    def group(group_name) = @@groups.find { it.name.eql?(group_name) }
 
     # Finds a feature within a group
     # @param group_name [Symbol] The name of the group
@@ -68,9 +67,7 @@ module FeaturePack
       @@javascript_files_paths = discover_javascript_files
     end
 
-    def load_dependencies
-      load @@path.join('feature_pack/error.rb')
-    end
+    def load_dependencies = load @@path.join('feature_pack/error.rb')
 
     def validate_features_path!
       raise "Invalid features_path: '#{@@features_path}'" if @@features_path.nil?
@@ -86,14 +83,11 @@ module FeaturePack
     def finalize_setup
       ATTR_READERS.each { |attr| define_singleton_method(attr) { class_variable_get("@@#{attr}") } }
       @@ignored_paths << @@path.join('feature_pack/feature_pack_routes.rb')
+      execute_after_initialize_hooks
       @@setup_executed_flag = true
     end
 
-    def discover_groups
-      @@groups = Dir.glob("#{@@features_path}/[!_]*/").map do |group_path|
-        build_group(group_path)
-      end
-    end
+    def discover_groups = @@groups = Dir.glob("#{@@features_path}/[!_]*/").map { build_group(it) }
 
     def build_group(group_path)
       relative_path = Pathname.new(group_path)
@@ -148,8 +142,8 @@ module FeaturePack
     end
 
     def setup_group_aliases(group)
-      group.manifest.fetch(:const_aliases, []).each do |alias_data|
-        alias_method_name, alias_const_name = alias_data.first
+      group.manifest.fetch(:const_aliases, []).each do
+        alias_method_name, alias_const_name = it.first
         group.define_singleton_method(alias_method_name) do
           "FeaturePack::#{group.name.to_s.camelize}::#{alias_const_name}".constantize
         end
@@ -157,21 +151,10 @@ module FeaturePack
     end
 
     def define_group_methods(group)
-      def group.feature(feature_name)
-        features.find { |p| p.name.eql?(feature_name) }
-      end
-      
-      def group.views_path
-        "#{base_dir}/#{GROUP_SPACE_DIRECTORY}/views"
-      end
-      
-      def group.view(view_name)
-        "#{base_dir}/#{GROUP_SPACE_DIRECTORY}/views/#{view_name}"
-      end
-      
-      def group.javascript_module(javascript_file_name)
-        "#{base_dir}/#{GROUP_SPACE_DIRECTORY}/javascript/#{javascript_file_name}"
-      end
+      def group.feature(feature_name) = features.find { it.name.eql?(feature_name) }      
+      def group.views_path = "#{base_dir}/#{GROUP_SPACE_DIRECTORY}/views"
+      def group.view(view_name) = "#{base_dir}/#{GROUP_SPACE_DIRECTORY}/views/#{view_name}"     
+      def group.javascript_module(javascript_file_name) = "#{base_dir}/#{GROUP_SPACE_DIRECTORY}/javascript/#{javascript_file_name}"
     end
 
     def discover_features
@@ -205,6 +188,20 @@ module FeaturePack
       group.features << feature
     end
 
+    def execute_after_initialize_hooks
+      # Executar hooks dos grupos
+      @@groups.each do |group|
+        hook_file = File.join(group.metadata_path, AFTER_INITIALIZE_FILE_NAME)
+        group.instance_eval(File.read(hook_file), hook_file) if File.exist?(hook_file)
+
+        # Executar hooks das features
+        group.features.each do |feature|
+          hook_file = File.join(feature.absolute_path, AFTER_INITIALIZE_FILE_NAME)
+          feature.instance_eval(File.read(hook_file), hook_file) if File.exist?(hook_file)
+        end
+      end
+    end
+
     def validate_feature_id!(base_path, relative_path)
       if base_path.scan(FEATURE_ID_PATTERN).empty?
         raise "Feature '#{relative_path}' does not have a valid ID. Expected format: feature_<id>_<name>"
@@ -212,6 +209,9 @@ module FeaturePack
     end
 
     def setup_feature_paths(relative_path, routes_file_path)
+      # Handled after initialize hooks
+      @@ignored_paths << File.join(relative_path, AFTER_INITIALIZE_FILE_NAME)
+
       # Custom routes file loads before Rails default routes
       @@ignored_paths << routes_file_path
       
@@ -246,26 +246,15 @@ module FeaturePack
     end
 
     def define_feature_methods(feature)
-      def feature.class_name
-        "FeaturePack::#{group.name.to_s.camelize}::#{name.to_s.camelize}"
-      end
-      
-      def feature.namespace
-        class_name.constantize
-      end
-      
-      def feature.view(view_name)
-        "#{views_relative_path}/#{view_name}"
-      end
-      
-      def feature.javascript_module(javascript_file_name)
-        "#{javascript_relative_path}/#{javascript_file_name}"
-      end
+      def feature.class_name = "FeaturePack::#{group.name.to_s.camelize}::#{name.to_s.camelize}"
+      def feature.namespace = class_name.constantize
+      def feature.view(view_name) = "#{views_relative_path}/#{view_name}"     
+      def feature.javascript_module(javascript_file_name) = "#{javascript_relative_path}/#{javascript_file_name}"
     end
 
     def setup_feature_aliases(feature)
-      feature.manifest.fetch(:const_aliases, []).each do |alias_data|
-        alias_method_name, alias_const_name = alias_data.first
+      feature.manifest.fetch(:const_aliases, []).each do
+        alias_method_name, alias_const_name = it.first
         feature.define_singleton_method(alias_method_name) do
           "#{class_name}::#{alias_const_name}".constantize
         end

data/lib/generators/feature_pack/add_feature/templates/after_initialize.rb.tt

@@ -0,0 +1,11 @@
+# Hook executado após a inicialização da feature <%= @feature_class_name %>
+# Este arquivo é executado no contexto do objeto feature
+# Você tem acesso a todas as propriedades da feature através de 'self'
+#
+# Exemplo de uso:
+# puts "Feature #{name} foi inicializada!"
+# puts "Grupo da feature: #{group.name}"
+# puts "Caminho absoluto: #{absolute_path}"
+# puts "Namespace: #{namespace}"
+#
+# Adicione seu código customizado abaixo:

data/lib/generators/feature_pack/add_feature/templates/controller.rb.tt

@@ -1,5 +1,5 @@
 # Feature controller for <%= @feature_class_name %>
-class FeaturePack::<%= @group_class_name %>::<%= @feature_class_name %>Controller < FeaturePack::<%= @group_class_name %>Controller
+class FeaturePack::<%= @group_class_name %>::<%= @feature_class_name %>Controller < FeaturePack::Controller
   # The 'index' action is already defined in the parent controller
   # Add your feature-specific actions and logic here
   

data/lib/generators/feature_pack/add_group/templates/_group_space/after_initialize.rb.tt

@@ -0,0 +1,10 @@
+# Hook executado após a inicialização do grupo <%= @class_name %>
+# Este arquivo é executado no contexto do objeto group
+# Você tem acesso a todas as propriedades do grupo através de 'self'
+#
+# Exemplo de uso:
+# puts "Grupo #{name} foi inicializado!"
+# puts "Caminho do grupo: #{absolute_path}"
+# puts "Features do grupo: #{features.map(&:name).join(', ')}"
+#
+# Adicione seu código customizado abaixo:

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: feature_pack
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Gedean Dias
 bindir: bin
 cert_chain: []
-date: 2025-02-09 00:00:00.000000000 Z
+date: 2025-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -40,6 +40,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - doc/feature_pack.md
+- doc/hooks.md
 - lib/feature_pack.rb
 - lib/feature_pack/api/controller.rb
 - lib/feature_pack/controller.rb
@@ -48,6 +49,7 @@ files:
 - lib/feature_pack/group_controller.rb
 - lib/generators/feature_pack/add_feature/USAGE
 - lib/generators/feature_pack/add_feature/add_feature_generator.rb
+- lib/generators/feature_pack/add_feature/templates/after_initialize.rb.tt
 - lib/generators/feature_pack/add_feature/templates/controller.rb.tt
 - lib/generators/feature_pack/add_feature/templates/doc/readme.md.tt
 - lib/generators/feature_pack/add_feature/templates/manifest.yaml.tt
@@ -57,6 +59,7 @@ files:
 - lib/generators/feature_pack/add_feature/templates/views/partials/_header.html.slim.tt
 - lib/generators/feature_pack/add_group/USAGE
 - lib/generators/feature_pack/add_group/add_group_generator.rb
+- lib/generators/feature_pack/add_group/templates/_group_space/after_initialize.rb.tt
 - lib/generators/feature_pack/add_group/templates/_group_space/controller.rb.tt
 - lib/generators/feature_pack/add_group/templates/_group_space/manifest.yaml.tt
 - lib/generators/feature_pack/add_group/templates/_group_space/routes.rb.tt
@@ -85,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.1
 specification_version: 4
 summary: A different approach to organizing Rails app features.
 test_files: []