Ayende @ Rahien

Ohad Aston commented on I understand that naming matters, so...

Wed, 25 Jun 2008 07:33:57 GMT

The class that implement this interface should RECOGNIZE IF A FILE SHOULD BE IGNORED why calling it IFileFilter? Call it IDoSomething and you solve the problem

Daniel Kolman commented on I understand that naming matters, so...

Tue, 24 Jun 2008 13:09:48 GMT

+1 for the IFileFilter by jonnii But IMHO this discussion is great example of a fact that solving any problem without context is waste of time.

Kirill Osenkov commented on I understand that naming matters, so...

Sun, 22 Jun 2008 00:48:52 GMT

I agree with Julian, a delegate can be nicer than an interface here. Just think of all the benefits you can get with lambdas. If you don't like that Predicate is too generic (sic!), you can define your own: public delegate bool FileFilter(string fileName); Also, let us know what was your final decision. I'd be curious :)

Ray commented on I understand that naming matters, so...

Thu, 19 Jun 2008 20:25:09 GMT

IIgnorantFile :-) Back on a serious note, I think IFileIgnore is best suggested name. Altho, I prefer Exclude instead of Ignore.

Steve Campbell commented on I understand that naming matters, so...

Thu, 19 Jun 2008 13:55:07 GMT

An interface with a single method is generally part of a strategy pattern. Given that, I would choose option 1, because it is indicative of what the strategy is for (recognizing files that need to be ignored). I can use the name of the option 1 interface in a conversation and its purpose will be clear. Option 2 has a more concrete (implementation) feel to it (FileSpecification). It also uses "Ignore" as a verb, which in my interpretation is not what it does (it does not actually do the ignoring, only the recognition).

Benny Thomas commented on I understand that naming matters, so...

Thu, 19 Jun 2008 13:46:41 GMT

IFileIgnoranceRule

Steve Freeman commented on I understand that naming matters, so...

Wed, 18 Jun 2008 18:24:36 GMT

Surely it depends on the context in which the interface is to be used? - using the 'I' wart to refer to the object just seems wrong to me. We should do everything we can to ignore this unnecessary noise. - since it's a string, that's a "filename" or "pathname", not a "file".

Marc Wrobel commented on I understand that naming matters, so...

Wed, 18 Jun 2008 06:07:20 GMT

The first one, since IIgnoreFileSpecification doesn't talk to me very much.

Mats Helander commented on I understand that naming matters, so...

Wed, 18 Jun 2008 05:02:11 GMT

IFilesThatNeedToBeIgnoredRecognizer? /Mats

Jeff Tucker commented on I understand that naming matters, so...

Tue, 17 Jun 2008 18:35:58 GMT

So should the chicken class implement ILayable or ICanLayEggs then?

Alessandro Riolo commented on I understand that naming matters, so...

Tue, 17 Jun 2008 14:05:16 GMT

I agree with Ken about the name of the interface. That said, in English "should" doesn't convey the meaning of absolute necessity. In example, as per RFT 2119, "SHOULD .. mean that there may exist valid reasons in particular circumstances to ignore a particular item, but the full implications must be understood and carefully weighed before choosing a different course.", while "MUST .. " ( or "REQUIRED" or "SHALL") ".. mean that the definition is an absolute requirement of the specification.", thus I would advice care also on the naming of the method. In layman's terms, is really ShouldBeIgnored or should be MustBeIgnored?.

Patrik commented on I understand that naming matters, so...

Tue, 17 Jun 2008 13:18:06 GMT

Depending on where this is used there's a good chance that I'd go with something like this: public delegate bool FileFilter(string fileName); If not that I'd go with the IFileFilter-interface.

Sidar Ok commented on I understand that naming matters, so...

Tue, 17 Jun 2008 09:00:02 GMT

ICanIgnoreFiles :)

Ken Egozi commented on I understand that naming matters, so...

Tue, 17 Jun 2008 06:17:14 GMT

Started my comment here, moved it to my blog: http://www.kenegozi.com/Blog/2008/06/17/naming-interfaces.aspx In short - be specific. Either of Ayende's offers are good, IFileFilter is not my preference.

firefly commented on I understand that naming matters, so...

Tue, 17 Jun 2008 01:21:49 GMT

IAmWhateverYouAndYourTeam can understand and agree on is good enough. I wouldn't stress over some name. Some XML documentation wouldn't hurt either.

John Rayner commented on I understand that naming matters, so...

Mon, 16 Jun 2008 22:37:59 GMT

I prefer method names to be verbs in the present tense. So I'd be similar to jonnii: public interface IFileFilter { bool ShouldIgnore( string filename ); }

Kenneth LeFebvre commented on I understand that naming matters, so...

Mon, 16 Jun 2008 20:45:56 GMT

For what it's worth, I like your idea of using the "I" as a first-person pronoun! I tend to not use an "I" at all on my interfaces, rather ending my interface names with "Interface" or "Contract". But, I am also a big fan of active voice in my names (actually, in all of my writing, really) so if I used the Hungarian Eye naming convention for interfaces, I would probably go with your first proposal...

Alex Simkin commented on I understand that naming matters, so...

Mon, 16 Jun 2008 20:15:44 GMT

One more: IPicky with method Refuse

Avish commented on I understand that naming matters, so...

Mon, 16 Jun 2008 20:00:15 GMT

If that interfaces is only used to recognize the SCM's meta-files (or whatever you call the .svnbridge folders), call it by that name and use it in that way: IMetaFileLocator.IsMetaFile(string filename) If it's supposed to be used to identify all files that should be ignored (during what? that's a key question), then I think the notion of an "excluder" -- that is, something that excludes files from general filespecs -- will work better: IFileExcluder.ShouldExclude(string filename) This suits the scenario where it makes sense to combine several of these, for example the default one that excludes meta-files, another one that excludes files based on svn:ignore properties, etc. If there's no need to combine exclusions, then jonnii's FileFilter suggestion -- making the interface say which files should be processed, rather than which files should not be processed -- is slightly more intuitive IMO.

Alex Simkin commented on I understand that naming matters, so...

Mon, 16 Jun 2008 19:56:47 GMT

IDisregarding or IDisregardable or IPayingNoAttentionTo

Raja Nadar commented on I understand that naming matters, so...

Mon, 16 Jun 2008 18:25:19 GMT

how about IIgnoreFiles? [IVerbNoun since IAdjective (IIgnorable) doesn't sound good]

Tobin Harris commented on I understand that naming matters, so...

Mon, 16 Jun 2008 17:23:07 GMT

public interface Ignorant { bool Ignores(string test); } :-)

Shawn Neal commented on I understand that naming matters, so...

Mon, 16 Jun 2008 16:59:26 GMT

Why do we love to talk about naming conventions/names so much?

David Buksbaum commented on I understand that naming matters, so...

Mon, 16 Jun 2008 16:55:43 GMT

+1 for the IFileFilter by jonnii I think this makes it specific enough for the meaning to be understood, and general enough to promote reuse beyond the current context. One other thing, is to possibly make this work in a chain, such that a series of IFileFilter's could be applied to jointly decide if the file should be ignored. David

Keith Elder commented on I understand that naming matters, so...

Mon, 16 Jun 2008 16:01:36 GMT

This reminds me of ICanLayEggs and IEggable! :) http://deepfriedbytes.com/podcast/episode-2-interview-war-stories/

Shaun commented on I understand that naming matters, so...

Mon, 16 Jun 2008 15:39:32 GMT

I like IFileFilter

Mike commented on I understand that naming matters, so...

Mon, 16 Jun 2008 15:33:36 GMT

I like prefer ending with 'Specification' for naming standard purposes...It helps too if I need to do a resharper Ctl+N with "*Specification" . I would actually use IDisregardFilesSpecification or IIneligibleFilesSpecification naming.

Steve commented on I understand that naming matters, so...

Mon, 16 Jun 2008 15:29:26 GMT

I like descriptive names, even if longer.

Josh commented on I understand that naming matters, so...

Mon, 16 Jun 2008 15:15:47 GMT

+1 for jonnii

Julian Birch commented on I understand that naming matters, so...

Mon, 16 Jun 2008 15:13:56 GMT

Well, you still get to name the variable... Predicate ignoreFilesSpecification = new OldSvnBridgeFilesSpecification().ShouldBeIgnored; For instance. But it really depends on how you're using the class, which I guess has always been the point.