feature_pack 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4d4c06a3ac9cc919e20a0616c0ec7b0d1da2553f43a4c5b140ef7a8bc29147a
-  data.tar.gz: 21ae0804c870c884ee4270168327fa81eade33b261bb4adb915f87f49764ca41
+  metadata.gz: dd18a6901bd123d6449e6570022136ecbd36e473b0cf572f27f6c91f80bd702d
+  data.tar.gz: 322a89e29a1e357dd6680f31b30adda1f53fcaf4139a8357bbf855e3a27287ae
 SHA512:
-  metadata.gz: a66fab958817fe7391449fe39d04043b9729e3bfc4a40b18e8ad6458e4a2f2c6a7ff863dfb0c8acf5841024bfdb34bb48e79c631c58949d655d1d0ca809fb8ec
-  data.tar.gz: bcc1750715d4f4a88587b557bd75e5ed0e3c698fec80a1691942b5ff895ecd3b6041636dd4b325de811d3008551a1244aa10635b5a28e7180a41642a86420b54
+  metadata.gz: 2efc9f88f00cfdad138a79cab42c1cbda2e10a9147ecf37bbf5991bd024a5eb1cdc7e23f297ed442d2f9f20c5a488d11da714aec7e026f8fdf13a49c74463120
+  data.tar.gz: df6e3f3a8635ca73b43caef82c78f6cb1d13c8bc90a249d72ee2c74ddf09e554b9ab68c52ef643658f8cdd1aafea30101ee72cf737285400f4237b7bef877fcb

data/README.md

@@ -51,7 +51,7 @@ FeaturePack.groups.each do |group|
   group_module = FeaturePack.const_set(group.name.name.camelize, Module.new)
 
   %w[Lib AI Jobs].each do |submodule_name|
-    submodule_path = File.join(group.relative_path, '_group_metadata', submodule_name.downcase)
+    submodule_path = File.join(group.relative_path, '_group_space', submodule_name.downcase)
     if Dir.exist?(submodule_path)
       submodule = group_module.const_set(submodule_name, Module.new)
       Rails.autoloaders.main.push_dir(submodule_path, namespace: submodule)

data/doc/feature_pack.md

@@ -0,0 +1,122 @@
+# FeaturePack Library Documentation
+
+## Overview
+
+The `FeaturePack` library is a Ruby module designed to manage and organize feature groups and individual features within a Rails application. It provides a structured way to handle feature-specific routes, controllers, views, and JavaScript files.
+
+## Key Components
+
+### Constants
+
+- `GROUP_ID_PATTERN`: Regex pattern for group IDs
+- `FEATURE_ID_PATTERN`: Regex pattern for feature IDs
+- `GROUP_METADATA_DIRECTORY`: Name of the directory containing group metadata
+- `MANIFEST_FILE_NAME`: Name of the manifest file for groups and features
+- `CONTROLLER_FILE_NAME`: Name of the controller file
+
+### Attributes
+
+The module defines several read-only attributes:
+
+- `path`: Path to the FeaturePack library
+- `features_path`: Path to the features directory
+- `ignored_paths`: Paths to be ignored
+- `groups`: Array of group objects
+- `groups_controllers_paths`: Paths to group controllers
+- `features_controllers_paths`: Paths to feature controllers
+- `javascript_files_paths`: Paths to JavaScript files
+
+## Setup
+
+The `setup` method initializes the FeaturePack library:
+
+1. Validates the provided `features_path`
+2. Sets up ignored paths
+3. Discovers and initializes groups and features
+4. Sets up routes and controllers for groups and features
+
+### Usage
+
+```ruby
+FeaturePack.setup(features_path: '/path/to/features')
+```
+
+## Groups
+
+Groups are represented as `OpenStruct` objects with the following properties:
+
+- `id`: Unique identifier for the group
+- `name`: Human-readable name of the group
+- `metadata_path`: Path to the group's metadata directory
+- `relative_path`: Relative path to the group directory
+- `base_dir`: Base directory name
+- `routes_file`: Path to the group's routes file (if exists)
+- `features`: Array of feature objects belonging to this group
+- `manifest`: Parsed content of the group's manifest file
+
+Groups also have methods for accessing views and JavaScript modules.
+
+## Features
+
+Features are represented as `OpenStruct` objects with the following properties:
+
+- `id`: Unique identifier for the feature
+- `name`: Human-readable name of the feature
+- `group`: Reference to the parent group object
+- `absolute_path`: Absolute path to the feature directory
+- `relative_path`: Relative path to the feature directory
+- `sub_path`: Sub-path of the feature directory
+- `routes_file_path`: Path to the feature's routes file
+- `routes_file`: Route name for the feature
+- `views_absolute_path`: Absolute path to the feature's views
+- `views_relative_path`: Relative path to the feature's views
+- `javascript_relative_path`: Relative path to the feature's JavaScript files
+- `manifest`: Parsed content of the feature's manifest file
+
+Features also have methods for accessing their class name, namespace, views, and JavaScript modules.
+
+## Utility Methods
+
+- `FeaturePack.group(group_name)`: Finds a group by name
+- `FeaturePack.feature(group_name, feature_name)`: Finds a feature within a group
+
+## File Structure
+
+The library expects the following file structure:
+
+```
+features_path/
+├── group_name_1/
+│   ├── _group_space/
+│   │   ├── manifest.yaml
+│   │   ├── controller.rb
+│   │   └── routes.rb (optional)
+│   ├── feature_name_1/
+│   │   ├── manifest.yaml
+│   │   ├── controller.rb
+│   │   └── routes.rb
+│   └── feature_name_2/
+│       └── ...
+└── group_name_2/
+    └── ...
+```
+
+## Manifest Files
+
+Both groups and features use manifest files (`manifest.yaml`) to store metadata. These files can include `const_aliases` for defining method aliases to constants.
+
+## JavaScript Integration
+
+The library automatically discovers and tracks JavaScript files within feature directories, making them accessible through the `javascript_files_paths` attribute.
+
+## Error Handling
+
+The library includes basic error handling for invalid or non-existent paths and missing group/feature IDs.
+
+## Limitations and Notes
+
+- The library assumes a specific directory structure and naming conventions.
+- It relies on Rails' autoloading capabilities for controllers.
+- Custom routes files for features are ignored to prevent conflicts with Rails' default routing.
+
+This documentation provides an overview of the `FeaturePack` library's structure and functionality. For specific implementation details, refer to the inline comments and method definitions in the source code.

data/lib/feature_pack/controller.rb

@@ -16,7 +16,7 @@ class FeaturePack::Controller < ApplicationController
   def set_view_lookup_context_prefix
     unless lookup_context.prefixes.include?(@feature.views_relative_path)
       lookup_context.prefixes.prepend(@feature.views_relative_path)
-    end    
+    end
   end
 
   def set_layout_paths
@@ -30,7 +30,7 @@ class FeaturePack::Controller < ApplicationController
 
     feature_partials_path = @feature.views_relative_path.join('partials')
     group_partials_path = @feature.group.views_path.concat('/partials')
-    
+
     if template_exists?('header', feature_partials_path, true)
       @header_layout_path = @feature.view('partials/header')
     elsif template_exists?('header', group_partials_path, true)

data/lib/feature_pack/error.rb

@@ -3,4 +3,4 @@ module FeaturePack::Error
 	end
   class NoGroup < StandardError
 	end
-end
+end

data/lib/feature_pack/group_controller.rb

@@ -5,7 +5,7 @@ class FeaturePack::GroupController < ApplicationController
 
   def index; end
 
-  private 
+  private
 
   def set_group
     group_name = params[:controller].split('/')[1].to_sym
@@ -20,13 +20,13 @@ class FeaturePack::GroupController < ApplicationController
 
   def set_layout_paths
     patials_path = @group.views_path.concat('/partials')
-    
+
     if template_exists?('header', patials_path, true)
       @header_layout_path = @group.view('partials/header')
     end
 
     if template_exists?('footer', patials_path, true)
       @footer_layout_path = @group.view('partials/footer')
-    end    
+    end
   end
 end

data/lib/feature_pack.rb

@@ -3,7 +3,7 @@ require 'active_support/all'
 module FeaturePack
   GROUP_ID_PATTERN = /^group_.*?_/.freeze
   FEATURE_ID_PATTERN = /^feature_.*?_/.freeze
-  GROUP_METADATA_DIRECTORY = '_group_metadata'.freeze
+  GROUP_SPACE_DIRECTORY = '_group_space'.freeze
   MANIFEST_FILE_NAME = 'manifest.yaml'.freeze
   CONTROLLER_FILE_NAME = 'controller.rb'.freeze
 
@@ -46,20 +46,20 @@ module FeaturePack
       base_path = File.basename(group_path, File::SEPARATOR)
 
       # On route draw call, the extension is ignored
-      routes_file = File.exist?(File.join(group_path, GROUP_METADATA_DIRECTORY, 'routes.rb')) ? File.join(base_path, GROUP_METADATA_DIRECTORY, 'routes') : nil
+      routes_file = File.exist?(File.join(group_path, GROUP_SPACE_DIRECTORY, 'routes.rb')) ? File.join(base_path, GROUP_SPACE_DIRECTORY, 'routes') : nil
 
-      @@groups_controllers_paths << File.join(group_path, GROUP_METADATA_DIRECTORY, CONTROLLER_FILE_NAME)
+      @@groups_controllers_paths << File.join(group_path, GROUP_SPACE_DIRECTORY, CONTROLLER_FILE_NAME)
 
       raise "Group '#{base_path}' does not have a valid ID" if base_path.scan(GROUP_ID_PATTERN).empty?
       group = OpenStruct.new(
         id: base_path.scan(GROUP_ID_PATTERN).first.delete_suffix('_'),
         name: base_path.gsub(GROUP_ID_PATTERN, '').to_sym,
-        metadata_path: @@features_path.join(group_path, GROUP_METADATA_DIRECTORY),
+        metadata_path: @@features_path.join(group_path, GROUP_SPACE_DIRECTORY),
         relative_path: relative_path,
         base_dir: File.basename(relative_path, File::SEPARATOR),
         routes_file: routes_file,
         features: [],
-        manifest: YAML.load_file(File.join(group_path, GROUP_METADATA_DIRECTORY, MANIFEST_FILE_NAME)).deep_symbolize_keys
+        manifest: YAML.load_file(File.join(group_path, GROUP_SPACE_DIRECTORY, MANIFEST_FILE_NAME)).deep_symbolize_keys
       )
 
       group.manifest.fetch(:const_aliases, []).each do |alias_data|
@@ -68,9 +68,9 @@ module FeaturePack
       end
 
       def group.feature(feature_name) = features.find { |p| p.name.eql?(feature_name) }
-      def group.views_path = "#{base_dir}/#{GROUP_METADATA_DIRECTORY}/views"
-      def group.view(view_name) = "#{base_dir}/#{GROUP_METADATA_DIRECTORY}/views/#{view_name}"
-      def group.javascript_module(javascript_file_name) = "#{base_dir}/#{GROUP_METADATA_DIRECTORY}/javascript/#{javascript_file_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}"
 
       group
     end
@@ -121,7 +121,7 @@ module FeaturePack
           feature.define_singleton_method(alias_method_name) { "#{class_name}::#{alias_const_name}".constantize }
         end
 
-        def feature.view(view_name) = "#{views_relative_path}/#{view_name}"       
+        def feature.view(view_name) = "#{views_relative_path}/#{view_name}"
         def feature.javascript_module(javascript_file_name) = "#{javascript_relative_path}/#{javascript_file_name}"
 
         group.features << feature

data/lib/generators/feature_pack/add_group/add_group_generator.rb

@@ -18,11 +18,11 @@ class FeaturePack::AddGroupGenerator < Rails::Generators::NamedBase
     group_id = name.gsub('_', '-') + '-' + '999'
     group_dir = FeaturePack.features_path.join("group_#{group_id}_#{name}")
 
-    template './_group_metadata/controller.rb.tt', group_dir.join('_group_metadata', 'controller.rb')
-    template './_group_metadata/manifest.yaml.tt', group_dir.join('_group_metadata', 'manifest.yaml')
-    template './_group_metadata/routes.rb.disabled.tt', group_dir.join('_group_metadata', 'routes.rb.disabled')
-    template './_group_metadata/views/index.html.slim.tt', group_dir.join('_group_metadata', 'views/index.html.slim')
-    template './_group_metadata/views/partials/_header.html.slim.tt', group_dir.join('_group_metadata', 'views/partials/_header.html.slim')
-    template './_group_metadata/views/partials/_footer.html.slim.tt', group_dir.join('_group_metadata', 'views/partials/_footer.html.slim')
+    template './_group_space/controller.rb.tt', group_dir.join('_group_space', 'controller.rb')
+    template './_group_space/manifest.yaml.tt', group_dir.join('_group_space', 'manifest.yaml')
+    template './_group_space/routes.rb.disabled.tt', group_dir.join('_group_space', 'routes.rb.disabled')
+    template './_group_space/views/index.html.slim.tt', group_dir.join('_group_space', 'views/index.html.slim')
+    template './_group_space/views/partials/_header.html.slim.tt', group_dir.join('_group_space', 'views/partials/_header.html.slim')
+    template './_group_space/views/partials/_footer.html.slim.tt', group_dir.join('_group_space', 'views/partials/_footer.html.slim')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feature_pack
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gedean Dias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '7.2'
 description: Organizes and sets up the architecture of micro-applications within a
   Rails application, enabling the segregation of code, management, and isolation of
   functionalities, which can be developed, tested, and maintained independently of
@@ -34,6 +34,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- doc/feature_pack.md
 - lib/feature_pack.rb
 - lib/feature_pack/api/controller.rb
 - lib/feature_pack/controller.rb
@@ -46,7 +47,7 @@ files:
 - lib/generators/feature_pack/add_feature/templates/doc/readme.md.tt
 - lib/generators/feature_pack/add_feature/templates/manifest.yaml.tt
 - lib/generators/feature_pack/add_feature/templates/routes.rb.tt
-- lib/generators/feature_pack/add_feature/templates/views/home.html.slim.tt
+- lib/generators/feature_pack/add_feature/templates/views/index.html.slim.tt
 - lib/generators/feature_pack/add_feature/templates/views/partials/_footer.html.slim.tt
 - lib/generators/feature_pack/add_feature/templates/views/partials/_header.html.slim.tt
 - lib/generators/feature_pack/add_group/USAGE
@@ -76,7 +77,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: New way to organize app features in Rails.