feature_pack 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bdafad74607b3a61e1783639b1a516875eeb6744e2e6c24a334ad04930036dcb
+  data.tar.gz: f63ce1ad345185c69e009e507663f082f47c4799d1c286178b9a22ec69e2db06
+SHA512:
+  metadata.gz: 445dbeb6ea88aeab0136cba9c4425c8aefb78126eca729fee511b2503016289e6b65d0c99490017aa971adc411ba0c5ef8473dca944b110c2975c290e5281caf
+  data.tar.gz: 14598e24f1198f63291fe5cc339ecf659aa51510dc6a34b8f61e9858a398f85a5acbe44030a76335c2b1192a40777fe3a8cfb57f1b06f5c64d7dcaa9611dfb82

data/README.md

@@ -0,0 +1,2 @@
+# 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.

data/lib/feature_pack/api/controller.rb

@@ -0,0 +1,3 @@
+class FeaturePack::API::Controller < ActionController::API
+
+end

data/lib/feature_pack/controller.rb

@@ -0,0 +1,44 @@
+class FeaturePack::Controller < ApplicationController
+  before_action :set_feature
+  before_action :set_view_lookup_context_prefix
+  before_action :set_layout_paths
+
+  def home; end
+
+  private
+
+  def set_feature
+    @feature = FeaturePack.feature *params['controller'].delete_prefix('feature_pack/').split('/').map(&:to_sym)
+  end
+
+  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
+
+  def set_layout_paths
+=begin
+    Header/Footer Lookup order
+
+    - Feature dir/_partials, if not exists
+      - Fallback to Group, if not exists
+        - Fallback to Application's default header/footer
+=end
+
+    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)
+      @header_layout_path = @feature.group.view('partials/header')
+    end
+
+    if template_exists?('footer', feature_partials_path, true)
+      @footer_layout_path = @feature.view('partials/footer')
+    elsif template_exists?('footer', group_partials_path, true)
+      @footer_layout_path = @feature.group.view('partials/footer')
+    end
+  end
+end

data/lib/feature_pack/feature_pack_routes.rb

@@ -0,0 +1,22 @@
+FeaturePack.groups.each do |group|
+  unless group.manifest[:namespace_only]
+    # Default "home" route every group has to have.
+    get group.manifest[:url],
+      to: "#{group.name.name}#home",
+      as: group.name.name
+
+    unless group.routes_file.nil?
+      scope group.manifest[:url] do
+        draw(group.routes_file)
+      end
+    end
+  end
+
+  namespace group.name, path: group.manifest[:url] do
+    group.features.each do |feature|
+      scope feature.manifest[:url], as: feature.name.name do
+        draw(feature.routes_file)
+      end
+    end
+  end
+end

data/lib/feature_pack/group_controller.rb

@@ -0,0 +1,33 @@
+class FeaturePack::GroupController < ApplicationController
+  before_action :set_group
+  before_action :set_view_lookup_context_prefix
+  before_action :set_layout_paths
+
+  def home
+  end
+
+  private 
+
+  def set_group
+    group_name = params[:controller].split('/')[1].to_sym
+    @group = FeaturePack.group(group_name) 
+  end
+
+  def set_view_lookup_context_prefix
+    unless lookup_context.prefixes.include?(@group.views_path)
+      lookup_context.prefixes.prepend(@group.views_path)
+    end
+  end
+
+  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

data/lib/feature_pack.rb

@@ -0,0 +1,115 @@
+require 'active_support/all'
+
+module FeaturePack
+  GROUP_ID_PATTERN = /^group_.*?_/.freeze
+  FEATURE_ID_PATTERN = /^feature_.*?_/.freeze
+  RELATIVE_ROOT_PATH = 'app/feature_packs'.freeze
+  GROUP_METADATA_DIRECTORY = '_group_metadata'.freeze
+  MANIFEST_FILE_NAME = 'manifest.yml'.freeze
+  CONTROLLER_FILE_NAME = 'controller.rb'.freeze
+
+  ATTR_READERS = %i[core_path absolute_root_path relative_root_path
+    groups ignored_paths custom_layouts_paths javascript_files_paths
+    group_controllers_paths controllers_paths].freeze
+
+  def self.setup
+    raise 'FeaturePack already setup!' if defined?(@@relative_root_path)
+    
+    @@core_path = Pathname.new(__dir__)
+
+    @@group_controllers_paths = []
+    @@controllers_paths = []
+    @@relative_root_path = Pathname.new(RELATIVE_ROOT_PATH)
+    @@absolute_root_path = Rails.root.join(RELATIVE_ROOT_PATH)
+    @@ignored_paths = Dir.glob("#{RELATIVE_ROOT_PATH}/[!]*/")
+    @@javascript_files_paths = Dir.glob("#{@@relative_root_path}/[!_]*/**/*.js")
+      .map { |js_path| js_path.sub(/^#{Regexp.escape(@@relative_root_path.to_s)}\//, '') }.to_a
+
+    @@custom_layouts_paths = Dir.glob("#{@@relative_root_path}/[!_]*/**/views/layouts")
+      .map { |layout_path| layout_path.delete_suffix '/layouts' }
+
+    ATTR_READERS.each { |attr| define_singleton_method(attr) { class_variable_get("@@#{attr}") } }
+    
+    # load @@core_path.join('feature_pack/error.rb')
+    @@ignored_paths << @@core_path.join('feature_pack/feature_pack_routes.rb')
+
+    @@groups = Dir.glob("#{RELATIVE_ROOT_PATH}/[!_]*/").map do |group_path|
+      relative_path = Pathname.new(group_path)
+      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
+
+      @@group_controllers_paths << File.join(group_path, GROUP_METADATA_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: Rails.root.join(group_path, GROUP_METADATA_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
+      )
+
+      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}"
+
+      group
+    end
+
+    @@groups.each do |group|
+      Dir.glob("#{group.relative_path}[!_]*/").each do |feature_path|
+        absolute_path = Rails.root.join(feature_path)
+        relative_path = Pathname.new(feature_path)
+        base_path = File.basename(feature_path, File::SEPARATOR)
+        
+        feature_name = base_path.gsub(FEATURE_ID_PATTERN, '').to_sym
+        feature_class_name = "#{group.name.name.camelize}::#{feature_name.name.camelize}"
+        # FIX-ME
+        # params_class_name = "#{feature_pack_class_name}::Params"
+        
+        routes_file_path = relative_path.join('routes.rb')
+
+        # The custom routes file loads before the Rails default routes, leading to errors like NoMethodError for 'scope'. Ignoring them is required to prevent these issues.
+        @@ignored_paths << routes_file_path
+        
+        # Due to Zeiwerk rules, Controllers have special load process
+        @@controllers_paths << relative_path.join(CONTROLLER_FILE_NAME)
+        @@ignored_paths << relative_path.join(CONTROLLER_FILE_NAME)
+
+        raise "Resource '#{relative_path}' does not have a valid ID" if base_path.scan(FEATURE_ID_PATTERN).empty?
+        feature_sub_path = relative_path.sub(/^#{Regexp.escape(@@relative_root_path.to_s)}\//, '')
+        feature = OpenStruct.new(
+          id: base_path.scan(FEATURE_ID_PATTERN).first.delete_suffix('_'),
+          name: feature_name,
+          group: group,
+          absolute_path: absolute_path,
+          relative_path: relative_path,
+          sub_path: feature_sub_path,
+          routes_file_path: routes_file_path,
+          routes_file: feature_sub_path.join('routes'),
+          # controller_path: relative_path.join('controller'),
+          views_absolute_path: absolute_path.join('views'),
+          views_relative_path: relative_path.sub(/^#{Regexp.escape(@@relative_root_path.to_s)}\//, '').join('views'),
+          class_name: feature_class_name,
+          # FIX-ME
+          #params_class_name: params_class_name,
+          manifest: YAML.load_file(File.join(feature_path, MANIFEST_FILE_NAME)).deep_symbolize_keys
+        )
+
+        # FIX-ME
+        # def feature.params_class = params_class_name.constantize
+        def feature.view(view_name) = "#{views_relative_path}/#{view_name}"
+
+        group.features << feature
+      end
+    end
+  end
+
+  def self.group(group_name) = @@groups.find { |g| g.name.eql?(group_name) }
+  def self.feature(group_name, feature_name) = group(group_name).feature(feature_name)
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: feature_pack
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Gedean Dias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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
+  each other.
+email: gedean.dias@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/feature_pack.rb
+- lib/feature_pack/api/controller.rb
+- lib/feature_pack/controller.rb
+- lib/feature_pack/feature_pack_routes.rb
+- lib/feature_pack/group_controller.rb
+homepage: https://github.com/gedean/feature_pack
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key: 
+specification_version: 4
+summary: New way to organize app features in Rails.
+test_files: []