rails_module_unification 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 242883465990fa99744ab5d34a36edbb481b404a
-  data.tar.gz: 77eeaecbb970da8cd11b089791cadc7bd8d1cf51
+  metadata.gz: 369fdde3d87f5a85780905994dbdf681cd649355
+  data.tar.gz: 81611173e795da1a64bd7427984dd3cfecd822af
 SHA512:
-  metadata.gz: 96c5446792bc5a2f236c06ef57e991e686894a0d8258961bafc3d177b06161172e7cab5cf2c263725bf4aff58d9243b04f2fa83b453851adfac1de3f2c339711
-  data.tar.gz: 3d2d4e0b01b3f04038ac2876b4a4d05e6d6b06b4014a81f27ed2f06091194f93884fd2aa5758da01b1b40f50df5c088df9aebbecdba308ea02c2a5f75469243b
+  metadata.gz: d9ee53bbd5e68def83faa2787ad9618869ed49537d6cbf57938a27d96aee4e7de442ba426faf98e5de97d1ae364e1bc9a9f7d7d9bd8080e3ef254517d2644579
+  data.tar.gz: 477a3e292c488bda8a1a458f2328bac4f754e85ed51a56f370527b906cc56f758d2cd44409bfad5e378f36fb00c6c1736c986ae079283be19332fc36e5c476e3

data/README.md

@@ -14,6 +14,10 @@ With large rails application, the default architecture can result in a resource'
 
 This gem provides a way to re-structure your app so that like-objects are grouped together.
 
+All this gem does is add some new autoloading / path resolution logic. This gem does not provide any service/operation/policy/etc functionality.
+
+**All of this is optional, and can be slowly migrated to over time. Adding this gem does not force you to change your app.**
+
 ### The new structure
 
 ```
@@ -42,8 +46,37 @@ app/
 
 ```
 
+Does this new structure mean you have to change the class names of all your classes? Nope. In the above example file structure, `app/resources/posts/controller.rb` _still_ defines `class PostsController < ApplicationController`
+
 [Checkout the sample rails app in the tests directory.](https://github.com/NullVoxPopuli/rails_module_unification/tree/master/spec/support/rails_app/app)
 
+### The Convention
+
+Say, for example, you have _any_ class/module defined as:
+
+```ruby
+module Api                    # {namespace
+  module V3                   #  namespace}
+    module UserServices       # {resource_name}{resource_type}
+      module Authentication   # {class_path
+        class OAuth2          #  class_path/file_name}
+        end
+      end
+    end
+  end
+ end
+```
+
+As long as some part of the fully qualified class name (in this example: `Api::V3::UserServices::Authentication::OAuth2`) contains any of the [defined keywords](https://github.com/NullVoxPopuli/rails_module_unification/blob/master/lib/rails_module_unification/active_support/dependency_extensions.rb#L4), the file will be found at `app/resources/api/v3/users/services/authentication/oauth2.rb`.
+
+The pattern for this is: `app/resources/:namespace/:resource_name/:resource_type/:class_path` where:
+ - `:namespace` is the namespace/parents of the `UserService`
+ - `:resource_type` is a suffix that may be inferred by checking of the inclusion of the defined keywords (linked above)
+ - `:resource_name` is the same module/class as what the `resource_type` is derived from, sans the `resource_type`
+ - `:class_path` is the remaining namespaces and eventually the class that the target file defines.
+
+So... what if you have a set of classes that don't fit the pattern exactly? You can leave those files where they are currently, or move them to `app/resources`, if it makes sense to do so. Feel free to open an issue / PR if you feel the list of resource types needs updating.
+
 ## Usage
 
 ```ruby

data/lib/rails_module_unification/action_view/resource_resolver.rb

@@ -13,32 +13,5 @@ module RailsModuleUnification
       super(path)
       @path = path
     end
-
-    # def find_templates(name, prefix, partial, details)
-    #   binding.pry
-    #   super(name, prefix, partial, details)
-    # end
-    #
-    # def build_query(path, details)
-    #
-    #   query = @pattern.dup
-    #
-    #   binding.pry
-    #   prefix = path.prefix.empty? ? '' : "#{escape_entry(path.prefix)}\\1"
-    #   query.gsub!(/:prefix(\/)?/, prefix)
-    #
-    #   partial = escape_entry(path.partial? ? "_#{path.name}" : path.name)
-    #   query.gsub!(/:action/, partial)
-    #
-    #   details.each do |ext, candidates|
-    #     if ext == :variants && candidates == :any
-    #       query.gsub!(/:#{ext}/, "*")
-    #     else
-    #       query.gsub!(/:#{ext}/, "{#{candidates.compact.uniq.join(',')}}")
-    #     end
-    #   end
-    #   puts File.expand_path(query, @path)
-    #   File.expand_path(query, @path)
-    # end
   end
 end

data/lib/rails_module_unification/active_support/dependency_extensions.rb

@@ -8,6 +8,7 @@ module RailsModuleUnification
       Presenters
       Policy
       Policies
+      Services
     ).freeze
 
     # Join all the suffix names together with an "OR" operator

data/lib/rails_module_unification/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module RailsModuleUnification
-  VERSION = '0.7.0'
+  VERSION = '0.7.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_module_unification
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - L. Preston Sego III
@@ -189,5 +189,5 @@ rubyforge_project:
 rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
-summary: RailsModuleUnification-0.7.0
+summary: RailsModuleUnification-0.7.1
 test_files: []