bullet_train-routes 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e8d9eed745b71e644f5250ac838c9b7b90bc406517d519e88d756000817d8091
+  data.tar.gz: a02b34b728eead3aa580902870f2f043e83478ce76e1d270352d555ce6ffdcb1
+SHA512:
+  metadata.gz: 4f10d82cb88ab53614610db11fa0c661ff71961cca0f50733af2c19296e1d7b2d3f86b776644eafed73a41d60303536e158e40f0c74b033dd698fafe4e4ca800
+  data.tar.gz: 74c433463a89fe78543ca3ba7497f1004e3039aace672c0d7bfc2f1b8a23beaa984b9963741df0c0adaef90ded23b36a04cc85ebcadbb2a94f8fb76b92a24983

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Andrew Culver
+
+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,28 @@
+# BulletTrain::Routes
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "bullet_train-routes"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install bullet_train-routes
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"

data/lib/bullet_train/routes/mapper_extensions.rb

@@ -0,0 +1,109 @@
+module BulletTrain
+  module Routes
+    module MapperExtensions
+      def current_namespaces
+        @current_namespaces ||= []
+      end
+    
+      def current_models
+        @current_models ||= []
+      end
+    
+      def namespaces(namespaces, &block)
+        if namespaces.any?
+          current_namespaces << {namespace_name: namespaces.shift, pending_blocks: []}
+          namespace current_namespaces.last[:namespace_name], &block
+          current_namespaces.pop[:pending_blocks].each do |block|
+            block.call
+          end
+        else
+          yield block
+        end
+      end
+    
+      def deduplicate_namespaces(namespace_names)
+        still_needed = []
+    
+        while namespace_names.any?
+          if current_namespaces.last(namespace_names.count).map { |namespace| namespace[:namespace_name] } == namespace_names
+            return still_needed
+          else
+            still_needed.unshift namespace_names.pop
+          end
+        end
+    
+        still_needed
+      end
+    
+      def namespaces_to_eject(namespace_names)
+        return [] unless current_models[-2]
+    
+        # E.g. `Common::Projects::Deliverable` and `Common::Objective` should be 1.
+        # E.g. `Common::Projects::Deliverable` and `Common::Other::Objective` should be 1.
+        working_namespace_names = namespace_names.dup
+        parent_namespace_names = current_models[-2][:model_name][0..-2]
+    
+        while parent_namespace_names.any? && working_namespace_names.first == parent_namespace_names.first
+          working_namespace_names.shift
+          parent_namespace_names.shift
+        end
+    
+        parent_namespace_names
+      end
+    
+      def model(*parameters, &block)
+        namespace_names = parameters[0].underscore.split("/")
+        current_models << {model_name: namespace_names.dup, pending_blocks: []}
+        model_name = namespace_names.pop
+    
+        original_namespace_names = namespace_names.dup
+        namespace_names = deduplicate_namespaces(namespace_names)
+    
+        # E.g. `Project` vs. `Projects::Deliverable`.
+        if current_models[-2] && namespace_names.first == current_models[-2][:model_name].last.pluralize
+          current_namespaces << {namespace_name: namespace_names.shift, pending_blocks: []}
+    
+          scope module: current_namespaces.last[:namespace_name] do
+            namespaces namespace_names do
+              # TODO We need people to be able to specify more than just [:index, :new, :create] for collection actions.
+              resources model_name.pluralize.to_sym, (parameters[1] || {}).merge(only: [:index, :new, :create]), &block
+            end
+          end
+    
+          current_namespaces_last = current_namespaces.last[:namespace_name]
+    
+          current_models.last[:pending_blocks] << proc do
+            # This needs to be registered to run _after_ we leave the `resources` block of the parent.
+            namespace current_namespaces_last.to_sym do
+              resources model_name.pluralize.to_sym, (parameters[1] || {}).merge(except: [:index, :new, :create]), &block
+            end
+          end
+    
+          current_namespaces.pop[:pending_blocks].each do |block|
+            block.call
+          end
+        # E.g. `Projects::Deliverable` and `Objective`
+        elsif (ejection_count = namespaces_to_eject(original_namespace_names).count) > 0
+          resource_symbol = current_models[-2][:model_name][((ejection_count + 1) * -1)..-1].join("_").to_sym
+          resource_path = current_models[-2][:model_name][((ejection_count + 1) * -1)..-1].join("/")
+    
+          current_namespaces[ejection_count * -1][:pending_blocks] << proc do
+            resources resource_symbol, path: resource_path do
+              namespaces namespace_names do
+                resources model_name.pluralize.to_sym, parameters[1] || {}, &block
+              end
+            end
+          end
+        else
+          namespaces namespace_names do
+            resources model_name.pluralize.to_sym, parameters[1] || {}, &block
+          end
+        end
+    
+        current_models.pop[:pending_blocks].each do |block|
+          block.call
+        end
+      end
+    end
+  end
+end

data/lib/bullet_train/routes/railtie.rb

@@ -0,0 +1,6 @@
+module BulletTrain
+  module Routes
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/bullet_train/routes/version.rb

@@ -0,0 +1,5 @@
+module BulletTrain
+  module Routes
+    VERSION = "1.0.0"
+  end
+end

data/lib/bullet_train/routes.rb

@@ -0,0 +1,12 @@
+require "bullet_train/routes/version"
+require "bullet_train/routes/railtie"
+require "bullet_train/routes/mapper_extensions"
+
+module BulletTrain
+  module Routes
+  end
+end
+
+ActiveSupport.on_load(:action_controller) do 
+  ActionDispatch::Routing::Mapper.include(BulletTrain::Routes::MapperExtensions)
+end

data/lib/tasks/bullet_train/routes_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bullet_train_routes do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: bullet_train-routes
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Culver
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+description: Black magic for defining model-driven routes.
+email:
+- andrew.culver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/bullet_train/routes.rb
+- lib/bullet_train/routes/mapper_extensions.rb
+- lib/bullet_train/routes/railtie.rb
+- lib/bullet_train/routes/version.rb
+- lib/tasks/bullet_train/routes_tasks.rake
+homepage: https://github.com/bullet-train-co/bullet_train-routes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bullet-train-co/bullet_train-routes
+  source_code_uri: https://github.com/bullet-train-co/bullet_train-routes
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Bullet Train Routes
+test_files: []