rails_module_unification 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 71501a9317c80c5f091da00abee3b55755542e8f
-  data.tar.gz: 1e2cfebbba3b4671ee89580093392eb92eb12efb
+  metadata.gz: 4fc7b8b01f6fb330a6e84c81c3ceed48335bc1c5
+  data.tar.gz: 38a60cb1df143dc03726f967c4eb0e718fb9b42a
 SHA512:
-  metadata.gz: b40c277e2ba4676f2b1a77d74f9aeb75de6f4bf95a3bfd5627d12fad840aea2b6a9def255d7bb75ba56765d0b19f62a6fc604a79f7ab5deb347f7ebe65402994
-  data.tar.gz: 3eda030e1c103c2d27c3b4cf0398f98b09a87243a6556e3e33a5980ccef1a9be3f0e3508830ceeac93384328b08e417b49be803a1767a801b639b75de37588d7
+  metadata.gz: 81974c0aca20c76a00f39624220c518c77cfdea57c17689bcd2eff0f490782dd699e588a5bafee99c9cd75520372f544f0a7873911d8e28e97fe5f8d0c3b82f4
+  data.tar.gz: 6532e3639b354387b8827c2998554cdcab19475c43737af3ab6c4352f48252e61b30330a39a495ccdd634dd7651c03ae6ef45bd5395ca51938f0e29a967867f1

data/README.md

@@ -1,6 +1,12 @@
 # rails_module_unification
 Ember's module unification brought to Rails.
 
+[![Build Status](https://travis-ci.org/NullVoxPopuli/rails_module_unification.svg?branch=master)](https://travis-ci.org/NullVoxPopuli/rails_module_unification)
+[![Code Climate](https://codeclimate.com/repos/57dddb2c50dac40e6900197c/badges/73a0a0761e417c655b68/gpa.svg)](https://codeclimate.com/repos/57dddb2c50dac40e6900197c/feed)
+[![Test Coverage](https://codeclimate.com/repos/57dddb2c50dac40e6900197c/badges/73a0a0761e417c655b68/coverage.svg)](https://codeclimate.com/repos/57dddb2c50dac40e6900197c/coverage)
+[![Dependency Status](https://gemnasium.com/badges/github.com/NullVoxPopuli/rails_module_unification.svg)](https://gemnasium.com/github.com/NullVoxPopuli/rails_module_unification)
+
+
 ## What is this about?
 
 With large rails application, the default architecture can result in a resource's related files being very spread out through the overall project structure. For example, lets say you have 50 controllers, serializers, policies, and operations. That's _four_ different top level folders that spread out all the related objects. It makes sense do it this way, as it makes rails' autoloading programmatically easy.

data/lib/rails_module_unification/active_support_extensions.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 module RailsModuleUnification
   module ActiveSupportExtensions
+    RESOURCE_SUFFIXES = /(Controller|Serializer|Operation|Policy)/
+
     def load_from_path(file_path, qualified_name, from_mod, const_name)
       expanded = File.expand_path(file_path)
       expanded.sub!(/\.rb\z/, '')
@@ -14,20 +16,43 @@ module RailsModuleUnification
       end
     end
 
-    # Load the constant named +const_name+ which is missing from +from_mod+. If
-    # it is not possible to load the constant into from_mod, try its parent
-    # module using +const_missing+.
-    def load_missing_constant(from_mod, const_name)
-      # always default to the actual implementation
-      super
-    rescue LoadError, NameError
-      suffixes = /(Controller|Serializer)\z/
+    def load_from_parent(from_mod, const_name)
+      # If our parents do not have a constant named +const_name+ then we are free
+      # to attempt to load upwards. If they do have such a constant, then this
+      # const_missing must be due to from_mod::const_name, which should not
+      # return constants from from_mod's parents.
+      parent = from_mod.parent
+      present_in_ancestry = (
+        parent &&
+        parent != from_mod &&
+        !from_mod.parents.any? { |p| p.const_defined?(const_name, false) }
+      )
 
-      # examples
-      # - Api::PostsController
-      # - PostsController
-      qualified_name = qualified_name_for from_mod, const_name
+      # Since Ruby does not pass the nesting at the point the unknown
+      # constant triggered the callback we cannot fully emulate constant
+      # name lookup and need to make a trade-off: we are going to assume
+      # that the nesting in the body of Foo::Bar is [Foo::Bar, Foo] even
+      # though it might not be. Counterexamples are
+      #
+      #   class Foo::Bar
+      #     Module.nesting # => [Foo::Bar]
+      #   end
+      #
+      # or
+      #
+      #   module M::N
+      #     module S::T
+      #       Module.nesting # => [S::T, M::N]
+      #     end
+      #   end
+      #
+      # for example.
+      return parent.const_missing(const_name) if present_in_ancestry
+    rescue NameError => e
+      raise unless e.missing_name? qualified_name_for(parent, const_name)
+    end
 
+    def resource_path_from_const_name(qualified_name)
       # examples
       # - api/posts_controller
       # - posts_controller
@@ -42,7 +67,7 @@ module RailsModuleUnification
       # examples:
       # - api/posts
       # - posts
-      folder_name = qualified_name.split(suffixes).first.underscore.pluralize
+      folder_name = qualified_name.split(RESOURCE_SUFFIXES).first.underscore.pluralize
 
       # examples:
       # - posts/posts_controller
@@ -59,43 +84,32 @@ module RailsModuleUnification
       # the resource_name/resource_names_controller.rb naming scheme
       file_path ||= search_for_file(folder_named_type)
 
+      file_path
+    end
+
+    # Load the constant named +const_name+ which is missing from +from_mod+. If
+    # it is not possible to load the constant into from_mod, try its parent
+    # module using +const_missing+.
+    def load_missing_constant(from_mod, const_name)
+      # always default to the actual implementation
+      super
+    rescue LoadError, NameError
+
+      # examples
+      # - Api::PostsController
+      # - PostsController
+      qualified_name = qualified_name_for from_mod, const_name
+
+      file_path = resource_path_from_qualified_name(qualified_name)
+
       return load_from_path(file_path, qualified_name, from_mod, const_name) if file_path
 
       # TODO: what is the situation in which this is needed?
       mod = autoload_module!(from_mod, const_name, qualified_name, file_name)
       return mod if mod
 
-      if (parent = from_mod.parent) && parent != from_mod &&
-          !from_mod.parents.any? { |p| p.const_defined?(const_name, false) }
-        # If our parents do not have a constant named +const_name+ then we are free
-        # to attempt to load upwards. If they do have such a constant, then this
-        # const_missing must be due to from_mod::const_name, which should not
-        # return constants from from_mod's parents.
-        begin
-          # Since Ruby does not pass the nesting at the point the unknown
-          # constant triggered the callback we cannot fully emulate constant
-          # name lookup and need to make a trade-off: we are going to assume
-          # that the nesting in the body of Foo::Bar is [Foo::Bar, Foo] even
-          # though it might not be. Counterexamples are
-          #
-          #   class Foo::Bar
-          #     Module.nesting # => [Foo::Bar]
-          #   end
-          #
-          # or
-          #
-          #   module M::N
-          #     module S::T
-          #       Module.nesting # => [S::T, M::N]
-          #     end
-          #   end
-          #
-          # for example.
-          return parent.const_missing(const_name)
-        rescue NameError => e
-          raise unless e.missing_name? qualified_name_for(parent, const_name)
-        end
-      end
+      from_parent = load_from_parent(from_mod, const_name)
+      return from_parent if from_parent
 
       name_error = NameError.new("uninitialized constant #{qualified_name}", const_name)
       name_error.set_backtrace(caller.reject { |l| l.starts_with? __FILE__ })

data/lib/rails_module_unification/railtie.rb

@@ -5,7 +5,7 @@ module RailsModuleUnification
   class Railtie < Rails::Railtie
     initializer 'activeservice.autoload', before: :set_autoload_paths do |app|
       # TODO: make the module unification root directory configurable
-      mu_dir = "#{Rails.root}/app/mu"
+      mu_dir = "#{Rails.root}/app/#{RailsModuleUnification.directory}"
 
       # Data
       data_paths = Dir["#{mu_dir}/data/**/"]

data/lib/rails_module_unification/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module RailsModuleUnification
-  VERSION = '0.5.1'.freeze
+  VERSION = '0.5.2'.freeze
 end

data/lib/rails_module_unification.rb

@@ -6,6 +6,16 @@ require 'rails_module_unification/active_support_extensions'
 module RailsModuleUnification
   extend ActiveSupport::Autoload
 
+  module_function
+
+  def directory=(dir)
+    @directory = dir
+  end
+
+  def directory
+    @directory || ''
+  end
+
   require 'rails_module_unification/railtie'
-  ActiveSupport::Dependencies.extend ActiveSupportExtensions
+  ActiveSupport::Dependencies.extend RailsModuleUnification::ActiveSupportExtensions
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_module_unification
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - L. Preston Sego III
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -199,5 +185,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: RailsModuleUnification-0.5.1
+summary: RailsModuleUnification-0.5.2
 test_files: []