Define your Rails routes along side all your other Domain Driven stuff. https://code.wellware.dev/leemachin/marauders_map
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Lee Machin f7adb5d6c0 Loosen ActiveSupport dependency 3 months ago
bin Add code + set up test apps 3 months ago
lib Loosen ActiveSupport dependency 3 months ago
test Remove broken test 3 months ago
.gitignore Initial gem commit 3 months ago
.travis.yml Initial gem commit 3 months ago
Gemfile Add code + set up test apps 3 months ago
Gemfile.lock Loosen ActiveSupport dependency 3 months ago
LICENSE.txt Initial gem commit 3 months ago
README.md Bump 3 months ago
Rakefile Add code + set up test apps 3 months ago
marauders_map.gemspec Loosen ActiveSupport dependency 3 months ago

README.md

Marauder’s Map

Define your Rails routes along side all your other Domain Driven stuff.

Build Status

Installation

Add this line to your application’s Gemfile:

gem 'marauders_map'

And then execute:

$ bundle

Or install it yourself as:

$ gem install marauders_map

Usage

Update config/routes.rb to include this:

MaraudersMap.reveal_routes!

Put this after any routes that haven’t been relocated. Preferably at the end of the file.

Define your routes in the same place you manage your domains. For example, in app/domains/sorting_hat/routes.rb:

MaraudersMap.draw(:sorting_hat) do
  resource :house do
    get :gryffindor, on: :member
    get :hufflepuff, on: :member
    get :slytherin, on: :member
    get :ravenclaw, on: :meber
  end
end

The routing DSL is exactly the same as the one you use in your traditional routes files. The only difference is you wrap them in a MaraudersMap.draw(:domain) block.

TODO:

  • Investigate potential issue when routes are autoloaded (as opposed to eager loaded)

  • Easily examine generated routes (filter by domain)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome at https://code.wellware.dev/leemachin/marauders_map.

License

The gem is available as open source under the terms of the MIT License.