[squeak-dev] [ANN] SwaLint

Hello —,

Am 2008-05-30 um 17:26 schrieb stephane ducasse:

Hi nico

Thanks, finally some information...

I'm sorry, that I seemed to be unable to give any valuable information be-

fore.

What is a test configuration.

I'm afraid, "What" is no test configuration ;).

   Actually, with the need for metric based tests, the need for average thres-

holds came up. Thus, we provided the possibility to have some preferences 

for your tests permanently stored. 

  We sometimes refer to these preferences as "test configuration".

[…]

Maybe usability is the kind of "selling arg" even if it does not appeal to

everybody.

it appeals to me.

Glad to hear.

Have a nice week and

so long,

-Tobias

Hello Mariano,

Am 2009-01-27 um 04:27 schrieb Mariano Martinez Peck:

Hi!

http://swalint.netshed.de/  is down. I would like to see the documentation.

any suggestion ?

I'm afraid, the SwaLint Wiki is down for migration. I'd like to apologize for
the inconveniences. I hope to have it up and running again in the mid of
february.

Have a nice evening
       -Tobias

Hello, Mariano

Am 2009-01-28 um 02:00 schrieb Mariano Martinez Peck:

Ok. Thanks. Let me know when It is up.

I will do.

I would like to do a revision with SwaLint before the first stable release of SqueakDBX and I don't know how to install and use it.

here, a short synopsis.
You need
       - a Squeak Image >= 3.9
       - AST from SqueakMap
       - Refactoring Engine from SqueakMap (provides SmallLint, btw).
       - SwaLint form SqueakMap

Then, you should be able to find SwaLint in the open
Menu. (Or, do 'SwaLint open')

Usage as follows:
       - Select the categories to test in the leftmost pane
       (right-click gives you more advanced selection possibilities)
       - Select the classes to test in the right next pane
       (again, right-click gives you more advanced selection possibilities)
       - Select the test categories in the upper right pane
       - Select the actual tests to carry out in the lower right pane
       (again, right-click gives you more advanced selection possibilities)

       -Click "Configure" to set some preferences for the test
       (e.g., which SmallLint test shall show up)
       -Click "Run Tests" to run the tests

Then, a window should appear, presenting the test results.
- In the lower pane, right clicking will give you advanced sorting and selecting options
       You can browse the targets of the tests there, too
- Selecting in the upper panes selects, with tests/classes results will be shown


I hope this provides enough information to start using SwaLint.
Don't hesitate to ask further questions.

So long,
       -Tobias

Ok. Thanks a lot. I will then try it.

Cheers,

Mariano

On Wed, Jan 28, 2009 at 8:41 AM, Tobias Pape <[hidden email]> wrote:

Hello, Mariano

Am 2009-01-28 um 02:00 schrieb Mariano Martinez Peck:

Ok. Thanks. Let me know when It is up.

I will do.

I would like to do a revision with SwaLint before the first stable release of SqueakDBX and I don't know how to install and use it.

here, a short synopsis.
You need
       - a Squeak Image >= 3.9
       - AST from SqueakMap
       - Refactoring Engine from SqueakMap (provides SmallLint, btw).
       - SwaLint form SqueakMap

Then, you should be able to find SwaLint in the open
Menu. (Or, do 'SwaLint open')

Usage as follows:
       - Select the categories to test in the leftmost pane
       (right-click gives you more advanced selection possibilities)
       - Select the classes to test in the right next pane
       (again, right-click gives you more advanced selection possibilities)
       - Select the test categories in the upper right pane
       - Select the actual tests to carry out in the lower right pane
       (again, right-click gives you more advanced selection possibilities)

       -Click "Configure" to set some preferences for the test
       (e.g., which SmallLint test shall show up)
       -Click "Run Tests" to run the tests

Then, a window should appear, presenting the test results.
- In the lower pane, right clicking will give you advanced sorting and selecting options
       You can browse the targets of the tests there, too
- Selecting in the upper panes selects, with tests/classes results will be shown


I hope this provides enough information to start using SwaLint.
Don't hesitate to ask further questions.

So long,
       -Tobias

Ahh I have some questions:

1) I see there is one test that checks the "length" of a method. I like to document and put all the necessary comments in my tests. So, in many tests, I get "long method" but actually most of those methods are comments with "". So, the questions is, can be comments ignored in this test?

In fact, we included comments intentionally. Albeit,

I do not understand the "" command idea (please help me there).

Our reasoning was, commets normally serve the purpose of clarifying code, thus, if they were ommited, the code would not be easily understandable.
Therefore, we treat comments as code. IIRC, we assumed an "averagne" of 7 LOC per method in the beginning. 

2) I think when you have take care of the results and analyse them to fix them, the common way doing this is going test for test. So, It would be fantastic being able to browse a test. And when you do this, this browse, takes all the classes that has occurrences. Example: "long methods" , right button, "browse all". And this opens the browser with all the classes that has the long method occurrences.

Ok, this might be useful. Did I got this right there? You'd like to right click on the test group and browse all of them?

Currenetly, you can select multiple (or one, depending on your personal settings) "occurences" of test results and
right-click -> browse them all.

By the way, you can sort the results pane by class, too. Then you can have a look at what classes are most affected by
the tests selected.

3) What does "Data class" mean ? are all the test detailed deeply somewhere ? like a webpage, wiki, or just SwaLint browser ?

This notion has been taken from Michele Lanza's and Radu Marinescu's nice book "Object-Oriented Metrics in Practice".
If you like to see the underlying metrics used to "calculate" the Data class, just enable them in the Preferences. You will
notice, that they are named after the ones described in the book.
Our mechanism of reusing results allows for simple creation of new Test Plugins. Just play around with them.
There has been plans to cover all Metrics described in the book, however, time is short and I'll be able to Implement them not before summer, I presume.

As you mention the Wiki, I'm looking forward to bring it up aroung mid March, again, or late March, depending on how my new server is running.

4) What does "Dot after return consistency" mean ? I don't understand the % and when it is average, low or high.

Oh that's a nice one :)
This is a Style tests. It simply tests, how many returns are written

^ anObject aMessage

and how many are written

^ anObject aMessage.

Where 100% is "all with" and 0% "all without" dot after return.
Thus, 50% is the worst value you can get in this test, as it implies, that every second return statement
is written in the opposing style.

Thanks a lot.

You're welcome.

Have a nice day
       -Tobias

Hello Mariano,

sorry for the late reply, I have been busy  the last weeks.

Am 2009-03-03 um 23:08 schrieb Mariano Martinez Peck:

[…]

Sorry. What's what you don't understand ? I dont' understand what you didn't understand hahaaha. I give you an exampple (the firstone I found):

<code>
executeDDLScript: aDDLScript
"Its very common you need to execute a complete DDL script: create, drop or alter tables. In these cases, you don't have any interesting results from each query. In such a case, you should use this method. Remember SqueakDBX doesn't do any translation so your statement delimiter must be understood by the backend. In order to know which delimiter we use, you can see the message queryDelimiter of the current platform backend, for example DBXPostgresPlatform.
This message doesn't use the multistatements option of openDBX, it is all done by SqueakDBX so you don't have to care about it''"

   | ddlStatements |
   ddlStatements := aDDLScript findTokens: self platform queryDelimiter.
   ddlStatements
       do: [:ddlStatement | self execute: ddlStatement]
 </code>

So, now I get it. In fact, I understood your question the way, that you put empty comments
into your code, as in:

aMessage
       ""

       self anotherMessage; aThirdMessage: true.


Which would not make sense to me.
 Regarding your example method, in my humble opinion, this is a large methos even though
it is long only due its comment. I (or wie in that case) as SwaLint developers thought that
7 lines average in a class would fit smalltalk style and should cope with small getter/setters
and rather lagre initializer.
 Well, I presume this average wouldnt fit for you, so simply change it in the preferences. In
fact, it is merely a matter of taste and/or style, so don't hesitate to change if it don't fit for you.

[…]

> Ok, this might be useful. Did I got this right there? You'd like to right click on the test group and browse all of them?

EXACTLY. I don't know if was just me, but actually that was my way of resolving the issues. Go test after test, and browsing for each one all the classes. Perhaps, I am the only one, so, It just doesn't worth it.

I consider it a useful feature. Yet, currently my time to work on SwaLint is fairly limitied,
so please dont expect it before summer.

>> 4) What does "Dot after return consistency" mean ? I don't understand the % and when it is average, low or high.
>
> Oh that's a nice one :)
> This is a Style tests. It simply tests, how many returns are written
>
>  ^ anObject aMessage
>
> and how many are written
>
> ^ anObject aMessage.

> Where 100% is "all with" and 0% "all without" dot after return.
> Thus, 50% is the worst value you can get in this test, as it implies, that every second return statement
> is written in the opposing style.

and are there some differences between both ways? I mean, a real difference ? or just to do it the same way in all the code ?

The latter. Its "just" about style consistency.

Have a nice weekend,
       -Tobias