feature_pack 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3320e77e931453c8b0aa6557b56f71752dc31bf74894bbd6e3d43219338ce0b2
-  data.tar.gz: 66a8cffdcb05e69903bded94b3a634fa1bfab66a37e5192ce9f3627704cd1a5f
+  metadata.gz: bd71ce9bce49e1aeb7eab0f90082368e855a4c008f2e16428e5471c2a42db9f4
+  data.tar.gz: ddd54c8b5bc72def245c0d580d72914121aca811cda1debb56e81d43f6af1ad6
 SHA512:
-  metadata.gz: 0aae33cb5796721c39ee8ed02951592ff754581f0d40f481835f8fc1d98fa7bcc8296478b9dce8107335ecd4653d9d1ead0d19ad6805f024fcd659056f8686ef
-  data.tar.gz: 07002ee9863ed1db06875d1ff79916367c291dc61419c6bd6605f7b6bcebe6865dc8f2c96c91a5925fc9bbc4d0f214daddfee613b573c5eb6688a5a9ac248e18
+  metadata.gz: f9772f47ad2adf747b7086203a9d8fa4e3d817c80eba21d8a22e978faa11fa1861a5134dceb11364f2748a1ca2f2654d4a3d5d6063d73bbf93f463ba8182a5a3
+  data.tar.gz: 1957dc76a52fc033ba7b8793d2d466fb4465da07c57b066c4ca441d3b5b5b4b3512f8f29272df378ab0b54bc5e7a6bb25a21f72773724552b81c4f0e365ec158

data/README.md

@@ -1,94 +1,91 @@
-# Feature Pack
-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 each other.
+# Feature Pack Gem
+Organizes and sets up the architecture of micro-applications within a Ruby On Rails application, enabling the segregation of code, management, and isolation of functionalities, which can be developed, tested, and maintained independently of each other.
 
+## Code and Folder Structure
 
-## Javascript
-`Javascript` must be on the FeaturePack root dir, not inside views dir.
+### Group
+A group is a collection of related features. Groups are represented as directories in the `app/feature_packs` folder. Each group contains a `_group_space` directory that holds group-level views and JavaScript files. Group directories follow this naming pattern:
 
-## Installation
-Meanwhile installer isn't done, follow the steps below to install FeaturePack GEM:
+#### Naming Convention
+Sample: `group_departments-100100_human_resources`
 
-```ruby
-# Add feature_pack to Gemfile
-gem 'feature_pack'
-```
+`group_` prefix is followed by the group identification (required)
+`departments-100100` between `group_` and class name, exists only for organization purposes. The bounds are `group_` and next underscore `_`
+`human_resources` class name of the group (required)
 
-```bash
-bundle install
-```
+#### Note worthy
+Group name is the same as the class name. Its used internally in the backend code.
+The 'Name' within the manifest file (Group.manifest[:name]) is the name to be shown in the user interface.
 
-Setup loading 
-```ruby
-# config/application.rb
+The `_group_space` directory contains:
 
-  feature_packs_path = Rails.root.join('app/feature_packs')
-  FeaturePack.setup(features_path: feature_packs_path)
+- `views/` - Views of the group
+#### Common Files in _group_space/views
 
-  FeaturePack.ignored_paths.each { |path| Rails.autoloaders.main.ignore(Rails.root.join(path)) }
+The `_group_space/views` directory typically contains these common files:
 
-  config.eager_load_paths << FeaturePack.features_path
-  config.paths['app/views'] << FeaturePack.features_path
+```
+_group_space/views/
+├── index.html.slim    # Default view for the group
+└── partials/
+    └── _header.html.slim # Base header template for the group
+    └── _footer.html.slim # Base footer template for the group
+```
+Can have more views and partials, depending on the defined on `controller.rb` but these are the most common ones.
 
-  config.paths['config/routes'] << (FeaturePack.path.to_s << '/feature_pack')
-  config.paths['config/routes'] << FeaturePack.features_path
-  config.assets.paths << FeaturePack.features_path.to_s
+- `javascript/` - Group-level JavaScript modules shared across features
+- `controller.rb` - Base controller class for the group's features
+- `routes.rb` - The routes files come with the default `index` action/view.
 
-  Zeitwerk::Loader.eager_load_all
+#### How implement a new Group
+```
+rails generate feature_pack:add_gruop <group_name>
+```
 
-  config.after_initialize do
-    load FeaturePack.path.join('feature_pack/group_controller.rb')
-    load FeaturePack.path.join('feature_pack/controller.rb')
+### Feature
+A feature is a single feature that can be added to a group. Feature naming patter is the same of group, but without the `group_` prefix.
 
-    FeaturePack.groups_controllers_paths.each { |group_controller_path| load group_controller_path }
-    FeaturePack.features_controllers_paths.each { |controller_path| load controller_path }
-  end
-```
+#### Feature Routes
+Every feature has a default route, which is the `index` action/view. If the feature has more than the default `index` action/view, the routes are defined in the `routes.rb` file.
 
-```ruby
-# initializers/feature_pack.rb
-
-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_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)
-    end
-  end
-
-  group.features.each do |feature|
-    feature_module = group_module.const_set(feature.name.name.camelize, Module.new)
-    Rails.autoloaders.main.push_dir(feature.relative_path, namespace: feature_module)
-  end
-end
+#### How implement a new feature
 ```
+rails generate feature_pack:add_feature <group_name>/<feature_name>
+```
+
+#### Helpers
 
 ```ruby
-# app/helpers/application_helper.rb
-  def feature_pack_group_path(group, *params) = send("feature_pack_#{group.name}_path".to_sym, *params)
-  def feature_pack_path(group, feature, *params) = send("feature_pack_#{group.name}_#{feature.name}_path".to_sym, *params)
+# Application Helper
+def feature_pack_group_path(group_name, *params) = send("feature_pack_#{group_name}_path".to_sym, *params)
+def feature_pack_path(group_name, feature_name, *params) = send("feature_pack_#{group_name}_#{feature_name}_path".to_sym, *params)
 ```
 
-```ruby
-# config/initializers/assets.rb
+## Helpers
 
-Rails.application.config.assets.precompile += FeaturePack.javascript_files_paths
-```
+### Using the `feature_pack_group_path` and `feature_pack_path` Helpers
 
-```ruby
-# config/importmap.rb
+The `feature_pack_group_path` and `feature_pack_path` helpers are used to generate URLs for specific groups and features within the feature package system.
 
-FeaturePack.javascript_files_paths.each do |js_file_path|
-  extensionless_js_file_path = js_file_path.delete_suffix('.js')
-  pin extensionless_js_file_path, to: extensionless_js_file_path, preload: false
-end
-```
+- `feature_pack_group_path(group, *params)`: Generates the path for a specific group. The `group` parameter should be an object representing the desired group. Additional parameters can be passed to specify more details in the URL.
+  
+  **Usage example:**
+  ```ruby
+  # Assuming `group` is a valid group name in symbol
+  group_url = feature_pack_group_path(:group_name)
+  ```
 
-```ruby
-# config/routes.rb
-namespace :feature_pack, path: nil do
-  draw :feature_pack_routes
-end
-```
+- `feature_pack_path(group, feature, *params)`: Generates the path for a specific feature within a group. The `group` and `feature` parameters should be symbols of group and feature name, respectively. Additional parameters can be passed to specify more details in the URL.
+  
+  **Usage example:**
+  ```ruby
+  # Assuming `group` and `feature` are valid objects
+  feature_url = feature_pack_path(:my_group, :my_feature)
+  ```
+
+These helpers are useful for maintaining consistency and clarity when generating URLs within the application, ensuring that routes are correctly constructed based on the provided group and feature names.
+
+## Variables
+Current group and feature are available in the controller (so as in the views too) as `@group` and `@feature` variables.
+@feature variable is not available in the group controller.
+@group variable is available in the group controller and in the its features controllers.

data/lib/feature_pack/feature_pack_routes.rb

@@ -1,20 +1,15 @@
 FeaturePack.groups.each do |group|
-  unless group.manifest[:namespace_only]
-    # Default 'index' route every group has to have.
-    get group.manifest[:url],
-        to: "#{group.name.name}#index",
-        as: group.name.name
+  scope group.manifest[:url], as: group.name do
+    raise "Group '#{group.name}' routes file not found in #{group.metadata_path}" if group.routes_file.nil?
 
-    unless group.routes_file.nil?
-      scope group.manifest[:url] do
-        draw(group.routes_file)
-      end
-    end
+    draw(group.routes_file)
   end
 
   namespace group.name, path: group.manifest[:url] do
     group.features.each do |feature|
-      scope feature.manifest[:url], as: feature.name.name.pluralize do
+      scope feature.manifest[:url], as: feature.name do
+        raise "Feature '#{feature.name}' routes file not found in #{feature.routes_file}" if feature.routes_file.nil?
+
         draw(feature.routes_file)
       end
     end

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

@@ -2,7 +2,6 @@ require 'rails/generators/base'
 require 'rails/generators/named_base'
 
 class FeaturePack::AddGroupGenerator < Rails::Generators::NamedBase
-
   desc 'Adds a new Feature Group'
   source_root File.expand_path('templates', __dir__)
 
@@ -20,9 +19,11 @@ class FeaturePack::AddGroupGenerator < Rails::Generators::NamedBase
 
     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/routes.rb.tt', group_dir.join('_group_space', 'routes.rb')
     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')
+    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

data/lib/generators/feature_pack/add_group/templates/_group_space/manifest.yaml.tt

@@ -1,3 +1,2 @@
 name: Group Friendly Name Here
 url: <%= name.gsub('_', '-') %>
-namespace_only: false

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

@@ -0,0 +1 @@
+get '/', to: '<%= name %>#index'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: feature_pack
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Gedean Dias
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-06 00:00:00.000000000 Z
+date: 2025-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -60,7 +59,7 @@ files:
 - lib/generators/feature_pack/add_group/add_group_generator.rb
 - 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.disabled.tt
+- lib/generators/feature_pack/add_group/templates/_group_space/routes.rb.tt
 - lib/generators/feature_pack/add_group/templates/_group_space/views/index.html.slim.tt
 - lib/generators/feature_pack/add_group/templates/_group_space/views/partials/_footer.html.slim.tt
 - lib/generators/feature_pack/add_group/templates/_group_space/views/partials/_header.html.slim.tt
@@ -83,8 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.23
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: A different way to organize app features in Rails.
 test_files: []

data/lib/generators/feature_pack/add_group/templates/_group_space/routes.rb.disabled.tt

@@ -1,3 +0,0 @@
-# You don't need enable this file if the only action is 'index'
-
-get '/action-name-url', to: '<%= name %>#action_name'