rails_module_unification 0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d534fbc4e2d179f5c74b7a474a39e3bdf44af115
+  data.tar.gz: 1582f310105cd5e2e412522252d94a275480b579
+SHA512:
+  metadata.gz: 7862c364eb26de506fc4be7216960636310a81c5b66e9d4d1686f05d506531d1b68e597bd6d9599c07ba1111c42252426e1c35198f9203353ea7a55ee232aff0
+  data.tar.gz: 0309ad0ddffd8e1db286713b538f5db999eac112d4530816a790ba1ebe84ddb8d22f4c93e8f6ac240519ce6391c1d541deb6c4c62e773685dfc3778b5e6e89fd

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 L. Preston Sego III
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# rails_module_unification
+Ember's module unification brought to Rails.
+
+## 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.
+
+This gem provides a way to re-structure your app so that like-objects are grouped together.
+
+### The new structure
+
+
+```
+app/
+├── channels/
+├── data/
+│   └── models/
+│       ├── post.rb
+│       ├── comment.rb
+├── jobs/
+├── mailers/
+│   └── notification_mailer.rb
+└── resources/
+    ├── posts/
+    │   ├── controller.rb
+    │   ├── operation.rb
+    │   ├── policy.rb
+    │   └── serializer.rb
+    └── comments/
+        ├── controller.rb
+        └── serializer.rb
+
+```
+
+## Usage
+
+```ruby
+gem 'rails_module_unification'
+```
+
+Including the gem in your gemfile enables the new structure.
+
+## Configuration
+
+```ruby
+RailsModuleUnification.directory = 'pods'
+```
+
+Sets the folder for the new structure to be in the `app/pods` directory so that you can gradually migrate to the new structure over time.
+
+## Contributing
+
+Feel free to open an issue, or fork and make a pull request.
+
+All discussion is welcome :-)

data/lib/rails_module_unification.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'rails_module_unification/active_support_extensions'
+
+module RailsModuleUnification
+  extend ActiveSupport::Autoload
+
+  require 'rails_module_unification/railtie'
+  ActiveSupport::Dependencies.extend ActiveSupportExtensions
+end

data/lib/rails_module_unification/active_support_extensions.rb

@@ -0,0 +1,104 @@
+module RailsModuleUnification
+  module ActiveSupportExtensions
+    def load_from_path(file_path, qualified_name, from_mod, const_name)
+      expanded = File.expand_path(file_path)
+      expanded.sub!(/\.rb\z/, ''.freeze)
+
+      if loading.include?(expanded)
+        raise "Circular dependency detected while autoloading constant #{qualified_name}"
+      else
+        require_or_load(expanded, qualified_name)
+        raise LoadError, "Unable to autoload constant #{qualified_name}, expected #{file_path} to define it" unless from_mod.const_defined?(const_name, false)
+        return from_mod.const_get(const_name)
+      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/
+
+      # examples
+      # - Api::PostsController
+      # - PostsController
+      qualified_name = qualified_name_for from_mod, const_name
+
+      # examples
+      # - api/posts_controller
+      # - posts_controller
+      file_name = qualified_name.underscore.split('/').last
+
+      # examples
+      # - controller
+      # - serializer
+      type_name = file_name.split('_').last
+
+      # folder/named_type.rb
+      # examples:
+      # - api/posts
+      # - posts
+      folder_name = qualified_name.split(suffixes).first.underscore.pluralize
+
+      # examples:
+      # - posts/posts_controller
+      folder_named_type = folder_name + '/' + file_name
+
+      # folder/type.rb
+      folder_type_name = folder_name + '/' + type_name
+
+
+      # without a folder / namespace?
+      # TODO: could this have undesired consequences?
+      file_path = search_for_file(file_name)
+      # the resource_name/controller.rb naming scheme
+      file_path ||= search_for_file(folder_type_name)
+      # the resource_name/resource_names_controller.rb naming scheme
+      file_path ||= search_for_file(folder_named_type)
+
+      return load_from_path(file_path, qualified_name, from_mod, const_name) if file_path
+
+
+      if mod = autoload_module!(from_mod, const_name, qualified_name, file_name)
+        return mod
+      elsif (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
+
+      name_error = NameError.new("uninitialized constant #{qualified_name}", const_name)
+      name_error.set_backtrace(caller.reject {|l| l.starts_with? __FILE__ })
+      raise name_error
+    end
+  end
+end

data/lib/rails_module_unification/railtie.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'rails/railtie'
+
+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"
+
+      # Data
+      data_paths = Dir["#{mu_dir}/data/**/"]
+      ap data_paths
+      app.config.autoload_paths += data_paths
+
+      # Resources
+      resource_paths = Dir["#{mu_dir}/resources/"]
+      ap resource_paths
+      app.config.autoload_paths += resource_paths
+    end
+  end
+end

data/lib/rails_module_unification/version.rb

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

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: rails_module_unification
+version: !ruby/object:Gem::Version
+  version: '0.5'
+platform: ruby
+authors:
+- L. Preston Sego III
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-17 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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: rspec
+  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: 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
+    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: pry-byebug
+  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: bundler
+  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: rails
+  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: factory_girl
+  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: factory_girl_rails
+  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: rspec-rails
+  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: sqlite3
+  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'
+description: Ember's Module Unification brought to Rails
+email: LPSego3+dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/rails_module_unification.rb
+- lib/rails_module_unification/active_support_extensions.rb
+- lib/rails_module_unification/railtie.rb
+- lib/rails_module_unification/version.rb
+homepage: https://github.com/NullVoxPopuli/rails_module_unification
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: RailsModuleUnification-0.5
+test_files: []