feature_pack 0.0.7 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40810174db4e0624612e8dfa7979635a371faaa60996b99094ca634fca170dda
-  data.tar.gz: 3239738c0fc17863242bc29ead5159a43dd04b57ffc2930c158877cee71725f6
+  metadata.gz: 55973cae577c2295ae4baffaef95d5416d969c8ab76afa261cdf5c38897d977c
+  data.tar.gz: b77ab0ea523c05867e533eae860bc7227166329438c2bd96eba98f77aa08d93b
 SHA512:
-  metadata.gz: 7ddd0d2fdf111a39fa11685d752fae9d9aceb607fab96369ea86ae72e9d846df682ba9da58cedca847969afd60bd499094294dec72a3017b3553c0dac2dffdf8
-  data.tar.gz: 83ff3aa09bb1cc710a78935554af7b9e5a2daa0e83cc06a42706a386a8f950e41f5f525087b5592e8e7427fa4fc4b3d9715b612af70932199fe25f49f5402c50
+  metadata.gz: be2356f348450d5eadbb8e554253904d1ef6388744eee2c1055c07c3cbfea0bbe6ffa1d59566a64b30f9c4b71bc45d657765446f0c6e8cf7aad5d4d68e84439c
+  data.tar.gz: a0af2ec40af2851ebc0e88366525440096257a8027570621c353682d3000fd777555d243d805e29c6b2f11e1bfcd52657fe5d61ba03288dd0b1d1c855a65de24

data/README.md

@@ -1,2 +1,68 @@
 # 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.
+
+## Installation
+Meanwhile installer isn't done, follow the steps below to install FeaturePack GEM:
+
+```ruby
+# Add feature_pack to Gemfile
+gem 'feature_pack'
+```
+
+```bash
+bundle install
+```
+
+Setup loading 
+```ruby
+# config/application.rb
+
+  feature_packs_path = Rails.root.join('app/feature_packs')
+  FeaturePack.setup(features_path: feature_packs_path)
+
+  FeaturePack.ignored_paths.each { |path| Rails.autoloaders.main.ignore(Rails.root.join(path)) }
+
+  config.eager_load_paths << FeaturePack.features_path
+  config.paths['app/views'] << FeaturePack.features_path
+
+  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
+
+  Zeitwerk::Loader.eager_load_all
+
+  config.after_initialize do
+    load FeaturePack.path.join('feature_pack/group_controller.rb')
+    load FeaturePack.path.join('feature_pack/controller.rb')
+
+    FeaturePack.groups_controllers_paths.each { |group_controller_path| load group_controller_path }
+    FeaturePack.features_controllers_paths.each { |controller_path| load controller_path }
+  end
+```
+
+```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_metadata', 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
+```
+
+```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)
+```

data/lib/feature_pack.rb

@@ -35,9 +35,6 @@ module FeaturePack
     @@javascript_files_paths = Dir.glob("#{@@features_path}/[!_]*/**/*.js")
       .map { |js_path| js_path.sub(/^#{Regexp.escape(@@features_path.to_s)}\//, '') }.to_a
 
-    # @@layouts_paths = Dir.glob("#{@@features_path}/[!_]*/**/views/layouts")
-      # .map { |layout_path| layout_path.delete_suffix '/layouts' }
-
     ATTR_READERS.each { |attr| define_singleton_method(attr) { class_variable_get("@@#{attr}") } }
     
     @@ignored_paths << @@path.join('feature_pack/feature_pack_routes.rb')
@@ -80,7 +77,8 @@ module FeaturePack
         
         feature_name = base_path.gsub(FEATURE_ID_PATTERN, '').to_sym
         feature_class_name = "#{group.name.name.camelize}::#{feature_name.name.camelize}"
-        # FIX-ME
+        
+        # FIX-ME (decouple Params class)
         # params_class_name = "#{feature_pack_class_name}::Params"
         
         routes_file_path = relative_path.join('routes.rb')
@@ -110,12 +108,12 @@ module FeaturePack
           views_absolute_path: absolute_path.join('views'),
           views_relative_path: relative_path.sub(/^#{Regexp.escape(@@features_path.to_s)}\//, '').join('views'),
           class_name: feature_class_name,
-          # FIX-ME
+          # FIX-ME (decouple Params class)
           #params_class_name: params_class_name,
           manifest: YAML.load_file(File.join(feature_path, MANIFEST_FILE_NAME)).deep_symbolize_keys
         )
 
-        # FIX-ME
+        # FIX-ME (decouple Params class)
         # def feature.params_class = params_class_name.constantize
         def feature.view(view_name) = "#{views_relative_path}/#{view_name}"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feature_pack
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.9
 platform: ruby
 authors:
 - Gedean Dias