Routing: Standard-behavior for components #5604

Closed
wants to merge 173 commits into
from

Conversation

Projects
None yet
@Hackwar
Member

Hackwar commented Jan 3, 2015

This PR implements a generic rule for standard behavior of components which routers extend from JComponentRouterAdvanced.

How to test

  • Apply this change

  • Change the router of com_content by replacing the code with the following:

    <?php
    class ContentRouter extends JComponentRouterAdvanced
    {
        public function __construct($app = null, $menu = null) {
    
            $this->registerView('categories', 'categories');
            $this->registerView('category', 'category', 'id', 'categories', '', true, array('default', 'blog'));
            $this->registerView('article', 'article', 'id', 'category', 'catid');
            $this->registerView('archive', 'archive');
            $this->registerView('featured', 'featured');
            $this->registerView('form', 'form');
            parent::__construct($app, $menu);
    
            $this->attachRule(new JComponentRouterRulesMenu($this));
            $this->attachRule(new JComponentRouterRulesNomenu($this));
            $this->attachRule(new JComponentRouterRulesStandard($this));
        }
    
        public function getArticleKey($segments, $vars)
        {
            return (int) $segments;
        }
    }
  • Comment line 69 and 123 from /components/com_content/helpers/route.php to disable the lookup of the Itemid there.

  • See that it creates sane URLs and that those URLs point to the right place.

Issues

This requires that #5446 and all depending requests are merged first. (You can still test this PR, since all changes from those PRs are included into this one.)

This was made possible through the generous donation of the people mentioned in the following link via an Indiegogo campaign: http://joomlager.de/crowdfunding/5-contributors

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar By having this method your are coupling the categories implementation to the routing API. Do we need to have a this method here ? Wouldn't this be something either for a more specialised router that understands categories, or for a specific implementation in a component router ?

@Hackwar By having this method your are coupling the categories implementation to the routing API. Do we need to have a this method here ? Wouldn't this be something either for a more specialised router that understands categories, or for a specific implementation in a component router ?

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

I'm indeed pondering if this method should be there or not. As I wrote in the description, I'm interested in having get methods to retrieve the necessary data and this would be one of those methods. Right now, most of our core frontend components need this method and a lot of third party extensions work with categories, too. So I could either have this here or implement another class between this one and the actual router to simply implement that class. Trying to strike a balance here between abstraction and over-engineering, I put it in this class. Also, I could quite frankly not come up with yet another class name for such an intermediate class. 😉

Now, I would leave it at that, you would move it into its own class, so I would call for a third party to cast a vote what to do. 😄

Owner

Hackwar replied Dec 17, 2014

I'm indeed pondering if this method should be there or not. As I wrote in the description, I'm interested in having get methods to retrieve the necessary data and this would be one of those methods. Right now, most of our core frontend components need this method and a lot of third party extensions work with categories, too. So I could either have this here or implement another class between this one and the actual router to simply implement that class. Trying to strike a balance here between abstraction and over-engineering, I put it in this class. Also, I could quite frankly not come up with yet another class name for such an intermediate class. 😉

Now, I would leave it at that, you would move it into its own class, so I would call for a third party to cast a vote what to do. 😄

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 25, 2014

Could these methods not be exposed by the rules JComponentRouterRulesCategory object. If they need to be accessible through the router you could use magic calls to get them making the rules object work like a mixin. That gives you flexibility without cluttering the initial router.

Could these methods not be exposed by the rules JComponentRouterRulesCategory object. If they need to be accessible through the router you could use magic calls to get them making the rules object work like a mixin. That gives you flexibility without cluttering the initial router.

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 25, 2014

Owner

No, the get"ViewName" methods need to be accessible from inside other rules and thus have to be implemented in the router. If you, as a dev that needs to modify an existing routers, need other methods (for example when you add your own view to a component) you can create your own router which extends from the component router and set it with JRouterSite::setComponentRouter() as a replacement for the original one.

I thought about using magic calls, but I have the feeling that this complicates the implementation again and makes it less intuitive. Joomla devs are not used to that...

Owner

Hackwar replied Dec 25, 2014

No, the get"ViewName" methods need to be accessible from inside other rules and thus have to be implemented in the router. If you, as a dev that needs to modify an existing routers, need other methods (for example when you add your own view to a component) you can create your own router which extends from the component router and set it with JRouterSite::setComponentRouter() as a replacement for the original one.

I thought about using magic calls, but I have the feeling that this complicates the implementation again and makes it less intuitive. Joomla devs are not used to that...

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar Would consider calling this method registerView() instead of register to better declare it's purpose. All other view related methods in the proposed API also have 'View' in their name which makes it easier to see the correlation between the methods.

@Hackwar Would consider calling this method registerView() instead of register to better declare it's purpose. All other view related methods in the proposed API also have 'View' in their name which makes it easier to see the correlation between the methods.

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

Will do.

Owner

Hackwar replied Dec 17, 2014

Will do.

This comment has been minimized.

Show comment
Hide comment

Great!

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar see my other comment about the getCategory() method. If you don't add it you also don't need to add the getName() method. Additionally you could ask yourself if this method has use outside of the implementation as proposed in getCategory(). If not it might be better to remove this and implement the logic in getCategory().

@Hackwar see my other comment about the getCategory() method. If you don't add it you also don't need to add the getName() method. Additionally you could ask yourself if this method has use outside of the implementation as proposed in getCategory(). If not it might be better to remove this and implement the logic in getCategory().

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

This method has a use outside of JCategories. It is also used to find the right menu items for the lookup and for other filter tasks that we have. Yes, it is named like our magic getters, but consider it one of the reserved words that can not be used as a name for a view.

Owner

Hackwar replied Dec 17, 2014

This method has a use outside of JCategories. It is also used to find the right menu items for the lookup and for other filter tasks that we have. Yes, it is named like our magic getters, but consider it one of the reserved words that can not be used as a name for a view.

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 25, 2014

In that case, maybe consider giving the method a protected scope and renaming it to getRouterName() to allow the router to have a getName() method if it needs to ? Otherwise this becomes a need to know that you cannot expose a 'name' property in your routes ?

In that case, maybe consider giving the method a protected scope and renaming it to getRouterName() to allow the router to have a getName() method if it needs to ? Otherwise this becomes a need to know that you cannot expose a 'name' property in your routes ?

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar By making the property public you are allowing it to be changed from the outside. Is that intentional ? Couldn't this result in unwanted side effects ?

@Hackwar By making the property public you are allowing it to be changed from the outside. Is that intentional ? Couldn't this result in unwanted side effects ?

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

That is indeed unintentional. How could that slip through? Thanks, will change.

Owner

Hackwar replied Dec 17, 2014

That is indeed unintentional. How could that slip through? Thanks, will change.

This comment has been minimized.

Show comment
Hide comment

Thanks!

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar Bit of a code smell here. You should try to check against and interface and not an implementation. This gives developers more flexibility, Eg would be better if it would be

public function __construct(JComponentRouterAdvancedInterface $router)

@Hackwar Bit of a code smell here. You should try to check against and interface and not an implementation. This gives developers more flexibility, Eg would be better if it would be

public function __construct(JComponentRouterAdvancedInterface $router)

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

I choose the concrete implementation, because the rules are pretty tightly coupled to this class. I also again tried to find a balance between abstraction and over-engineering. My heart is not attached to this, but I'd rather not add another folder to this one simply to stuff the interface in there for the autoloader...

As with the last cases, I'm happy to be overruled by similar opinions.

Owner

Hackwar replied Dec 17, 2014

I choose the concrete implementation, because the rules are pretty tightly coupled to this class. I also again tried to find a balance between abstraction and over-engineering. My heart is not attached to this, but I'd rather not add another folder to this one simply to stuff the interface in there for the autoloader...

As with the last cases, I'm happy to be overruled by similar opinions.

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 25, 2014

Typo, should have been public function __construct(JComponentRouterInterface $router)Additionally would consider adding this to the JComponentRouterRulesInterface to enforce the constructor.

Typo, should have been public function __construct(JComponentRouterInterface $router)Additionally would consider adding this to the JComponentRouterRulesInterface to enforce the constructor.

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 25, 2014

Owner

JComponentRouterInterface does not have the interface that is required by the rules. You definitely need an interface like JComponentRouterAdvanced. Remember that this advanced router is optional. If a component doesn't want it, we are not forcing it upon the devs. So JComponentRouterInterface does not have the features that are required for the advanced component router.

Owner

Hackwar replied Dec 25, 2014

JComponentRouterInterface does not have the interface that is required by the rules. You definitely need an interface like JComponentRouterAdvanced. Remember that this advanced router is optional. If a component doesn't want it, we are not forcing it upon the devs. So JComponentRouterInterface does not have the features that are required for the advanced component router.

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Jan 13, 2015

@Hackwar I understand, it would still be good to have an interface for this so we don't need to work against an implementation. Can we move the API as defined in the advanced router into an interface ?

@Hackwar I understand, it would still be good to have an interface for this so we don't need to work against an implementation. Can we move the API as defined in the advanced router into an interface ?

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar Do you want to allow this ? By letting any Itemid being passed in a developer can hijack a route. Connecting a component to any random Itemid. Shouldn't that be prevented ?

@Hackwar Do you want to allow this ? By letting any Itemid being passed in a developer can hijack a route. Connecting a component to any random Itemid. Shouldn't that be prevented ?

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

This is necessary for the menu system to work. The menu module hands in "index.php?Itemid=XX" and this is sent through preprocess. If we don't allow Itemids to be set from the outside, we will get an issue here. So I've allowed that.

Owner

Hackwar replied Dec 17, 2014

This is necessary for the menu system to work. The menu module hands in "index.php?Itemid=XX" and this is sent through preprocess. If we don't allow Itemids to be set from the outside, we will get an issue here. So I've allowed that.

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar As commented before. If the you need dummy methods here you can ask yourself if you really need those methods in the interface at all ?

@Hackwar As commented before. If the you need dummy methods here you can ask yourself if you really need those methods in the interface at all ?

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

My first implementation did not have an interface but instead you could simply hand in callbacks for rules. You also had to manually assign them to parse and build rules. That was before I introduced preprocess and before I expected the rule to be an instantiated object with the router handed in through the constructor. That said, I decided against the ultra-flexible solution, since I think it is more error-prone for third party developers and choose this interface. It requires less methods to register rules and less code to store and execute them and at the same time gives devs a construct to work from.

Owner

Hackwar replied Dec 17, 2014

My first implementation did not have an interface but instead you could simply hand in callbacks for rules. You also had to manually assign them to parse and build rules. That was before I introduced preprocess and before I expected the rule to be an instantiated object with the router handed in through the constructor. That said, I decided against the ultra-flexible solution, since I think it is more error-prone for third party developers and choose this interface. It requires less methods to register rules and less code to store and execute them and at the same time gives devs a construct to work from.

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 25, 2014

Not following you here. Does that mean you agree in getting it out of the interface or not ?

Not following you here. Does that mean you agree in getting it out of the interface or not ?

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 25, 2014

Owner

This means that I think the interface is good the way it is.

Owner

Hackwar replied Dec 25, 2014

This means that I think the interface is good the way it is.

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar As commented before. If the you need dummy methods here you can ask yourself if you really need those methods in the interface at all ?

@Hackwar As commented before. If the you need dummy methods here you can ask yourself if you really need those methods in the interface at all ?

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

See my previous comment. 😄

Owner

Hackwar replied Dec 17, 2014

See my previous comment. 😄

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar Since you are using the result of buildLookup() in this code block I would make buildLookup() return the lookup array. It can still cache it but it makes sense it returns it for use in the code block here.

@Hackwar Since you are using the result of buildLookup() in this code block I would make buildLookup() return the lookup array. It can still cache it but it makes sense it returns it for use in the code block here.

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

This might sound stupid, but I wanted to optimize away a function-call here. I also choose the direct access of the lookup property in the code further down in the hopes that it saves a bit of memory and time instead of copying a pointer each time into a new variable in the methods scope etc. Yes, it might be a bit over-optimized, but I would stick to it.

However I see a bug in there, that the $language is not correctly set if the lookup is already created and the query language parameter is set. Will have to split that into 2 ifs.

Owner

Hackwar replied Dec 17, 2014

This might sound stupid, but I wanted to optimize away a function-call here. I also choose the direct access of the lookup property in the code further down in the hopes that it saves a bit of memory and time instead of copying a pointer each time into a new variable in the methods scope etc. Yes, it might be a bit over-optimized, but I would stick to it.

However I see a bug in there, that the $language is not correctly set if the lookup is already created and the query language parameter is set. Will have to split that into 2 ifs.

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 25, 2014

I would choose code readability over the few microseconds you might be saving here. Especially since you are already caching.

I would choose code readability over the few microseconds you might be saving here. Especially since you are already caching.

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar Not sure about the proposed function name here. getMenuItemMap() might be a better name to reflect what this method is doing. I would also not make it return void but return the result instead. The result could be filtered by the language passed in through the method parameter.

@Hackwar Not sure about the proposed function name here. getMenuItemMap() might be a better name to reflect what this method is doing. I would also not make it return void but return the result instead. The result could be filtered by the language passed in through the method parameter.

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

Its the name that we used so far in the *HelperRoute classes for this. I simply choose it for the sake of familiarity with those methods.

Owner

Hackwar replied Dec 17, 2014

Its the name that we used so far in the *HelperRoute classes for this. I simply choose it for the sake of familiarity with those methods.

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 25, 2014

Since you are adding it new here and we are refactoring and removing the HelperRoute classes anyway, I would consider renaming it to benefit a clearer API.

Since you are adding it new here and we are refactoring and removing the HelperRoute classes anyway, I would consider renaming it to benefit a clearer API.

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar Getting the active menu item is a common operation in a router. Could consider adding a getActiveMenuItem() method to return this.

@Hackwar Getting the active menu item is a common operation in a router. Could consider adding a getActiveMenuItem() method to return this.

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

Sorry, but I would call that over-engineered code. The method would simply contain this one line and that is it and I don't see any benefit in that.

Owner

Hackwar replied Dec 17, 2014

Sorry, but I would call that over-engineered code. The method would simply contain this one line and that is it and I don't see any benefit in that.

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 25, 2014

I don't see why that would be over engineering. This is the L in SOLID, or the Liskov substitution principle and Design by Contract Those are well established programming principles.

By not exposing the getter you are relying on implementation instead of on an interface. Having a getActiveMenuItem() or getActiveMenu() as a getter creates a declarative API and make the code more easily extendable. It also better communicates the intention of the API by having the method as part of it.

I would still reconsider this and try to stick to SOLID as much as possible when creating new API's.

I don't see why that would be over engineering. This is the L in SOLID, or the Liskov substitution principle and Design by Contract Those are well established programming principles.

By not exposing the getter you are relying on implementation instead of on an interface. Having a getActiveMenuItem() or getActiveMenu() as a getter creates a declarative API and make the code more easily extendable. It also better communicates the intention of the API by having the method as part of it.

I would still reconsider this and try to stick to SOLID as much as possible when creating new API's.

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar Getting the default menu item is a common operation in a router. Could consider adding a getDefaultMenuItem() method to return this.

@Hackwar Getting the default menu item is a common operation in a router. Could consider adding a getDefaultMenuItem() method to return this.

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

See my above note.

Owner

Hackwar replied Dec 17, 2014

See my above note.

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 25, 2014

See my note. Please consider it.

See my note. Please consider it.

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 16, 2014

@Hackwar Does this need to be accessible from object scope ? If not might consider making it private to prevent developers for using it directly ?

@Hackwar Does this need to be accessible from object scope ? If not might consider making it private to prevent developers for using it directly ?

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 17, 2014

Owner

In general, rules should not be extended upon. They are self-contained pieces of code. But if someone really wants to, he/she should be able to mess around here. But since its not accessible from the component router, I would say that it is okay the way it is.

Owner

Hackwar replied Dec 17, 2014

In general, rules should not be extended upon. They are self-contained pieces of code. But if someone really wants to, he/she should be able to mess around here. But since its not accessible from the component router, I would say that it is okay the way it is.

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 25, 2014

Oki, you could still consider making it private for now. If someone needs to access this is could be made protected easily. Having it private gives you less to worry about in case the code needs to be refactored later.

Oki, you could still consider making it private for now. If someone needs to access this is could be made protected easily. Having it private gives you less to worry about in case the code needs to be refactored later.

@wilsonge

This comment has been minimized.

Show comment
Hide comment
@wilsonge

wilsonge Dec 24, 2014

Probably need to change the text there then :)

Probably need to change the text there then :)

@johanjanssens

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Dec 25, 2014

@Hackwar If the method to add a rule if called attachRule(), if would make sense that the method to remove it is called detachRule(), detach being the opposite of attach. Alternatively you could consider renaming attachRule to addRule().

@Hackwar If the method to add a rule if called attachRule(), if would make sense that the method to remove it is called detachRule(), detach being the opposite of attach. Alternatively you could consider renaming attachRule to addRule().

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Dec 25, 2014

Owner

What would you prefer? I can do either.

Owner

Hackwar replied Dec 25, 2014

What would you prefer? I can do either.

This comment has been minimized.

Show comment
Hide comment
@johanjanssens

johanjanssens Jan 12, 2015

Attach/Detach is mostly used in the context of an object. Since the rule is an object, attach/detach make most sense here. Does that help ?

Attach/Detach is mostly used in the context of an object. Since the rule is an object, attach/detach make most sense here. Does that help ?

wilsonge and others added some commits Jun 16, 2015

Merge pull request #7198 from mbabker/Throwable
Change PHP 7 Exception handling to catch Throwable
Merge pull request #7217 from mbabker/JVersionConst
Define JVersion class vars as constants
Merge branch 'staging' into 3.5-dev
Conflicts:
	administrator/language/en-GB/en-GB.mod_status.ini
Merge pull request #7524 from mbabker/3.5-Composer-Updates
Composer update for Joomla Framework packages and PHPUnit
Merge branch '3.5-dev' of https://github.com/joomla/joomla-cms into c…
…omponentrulesstandard

Conflicts:
	tests/unit/suites/libraries/cms/router/JRouterSiteTest.php
@Hackwar

This comment has been minimized.

Show comment
Hide comment
@Hackwar

Hackwar Aug 2, 2015

Member

I've combined the changes from this and all other routing related PRs into a new PR: #7615 Please review and comment in the new PR. I'm closing this one, so that we can focuse on the new PR.

Member

Hackwar commented Aug 2, 2015

I've combined the changes from this and all other routing related PRs into a new PR: #7615 Please review and comment in the new PR. I'm closing this one, so that we can focuse on the new PR.

@Hackwar Hackwar closed this Aug 2, 2015

@Hackwar Hackwar deleted the Hackwar:componentrulesstandard branch Jan 6, 2016

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment