feature_pack 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4d4c06a3ac9cc919e20a0616c0ec7b0d1da2553f43a4c5b140ef7a8bc29147a
-  data.tar.gz: 21ae0804c870c884ee4270168327fa81eade33b261bb4adb915f87f49764ca41
+  metadata.gz: a358d066012fe6059153050e3887849afec64faf789a3668c696c8606347044c
+  data.tar.gz: 27141fe3653ff391a85301d9fcc5ea8676084403d0ad259b06528c22b6fab0ed
 SHA512:
-  metadata.gz: a66fab958817fe7391449fe39d04043b9729e3bfc4a40b18e8ad6458e4a2f2c6a7ff863dfb0c8acf5841024bfdb34bb48e79c631c58949d655d1d0ca809fb8ec
-  data.tar.gz: bcc1750715d4f4a88587b557bd75e5ed0e3c698fec80a1691942b5ff895ecd3b6041636dd4b325de811d3008551a1244aa10635b5a28e7180a41642a86420b54
+  metadata.gz: 22d7b9a11292d34b1fc5920741ac4e4033dbc1417cb59dd534ff4acd564b34ed46440b9f163aba77b077b70977852b6ad136f3c28363e927e394034b6a3b9f1a
+  data.tar.gz: c3b4d00e9a16dd5767a8ce1c79bfc689ddc3b07d2890c52c88d5046c7261a432c318a1d5950600d3bc5ffcc674175f3d54b5a3a919ebe94930777bc8ea53f308

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_metadata/
+│   │   ├── 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.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: feature_pack
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Gedean Dias
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-30 00:00:00.000000000 Z
+date: 2024-08-30 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