- Pharo-dev - lists.pharo.org

[Pharo-project] What is a well documented class?

by Alexandre Bergel

Hi! I am dreaming about a tool to help me document source code. The question I have is what is a well documented class? What do you think about the following: A well documented class is a class: - that contains a class comment - its class comments contains either an example, or an associated unit test - without 'as yet unclassified' method category - each public method belongs to a method category named public* - each private method belongs to a method category named private* - each method contains a comment, located before the declaration of temporary variables - other methods are considered as "package visible", meaning that they belong to a category that does not begins with 'private' or 'public' - without commented code contained in its methods. Is there anything else? Cheers, Alexandre -- _,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;: Alexandre Bergel http://www.bergel.eu ^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;._,.;:~^~:;.

April 24, 2011

Re: [Pharo-project] Fwd: [Vm-dev] Re: out of memory - cog on windows

by Andres Valloud

Interesting bit from the docs here: "Addresses near the 2-GB boundary are typically used by various system DLLs. Therefore, a 32-bit process cannot allocate more than 2 GB of contiguous memory, even if the entire 4-GB address space is available." http://msdn.microsoft.com/en-us/library/bb613473%28v=VS.85%29.aspx Maybe more fundamental changes are needed, such as the ability to change the image's memory footprint dynamically. On 4/23/11 17:34 , Andres Valloud wrote: > You can determine the switches better than me... for us, it was > /LARGEADDRESSAWARE, also a linker switch: > > http://msdn.microsoft.com/en-us/library/wz223b1z.aspx > > Now, keep in mind that expanding the address space capability of the app > doesn't mean Windows will give it 4gb. Under some Windows > configurations, that won't happen unless you change how Windows boots. > Under some versions, 4gb is just not possible. See here: > > http://msdn.microsoft.com/en-us/library/aa366778%28v=VS.85%29.aspx > > On 4/23/11 15:40 , Igor Stasenko wrote: >> On 23 April 2011 21:48, Andres Valloud >> <avalloud(a)smalltalk.comcastbiz.net> wrote: >>> Some seemingly useful items to start tracing through Google appear >>> here... >>> >>> http://groups.google.com/group/gnu.gcc.help/browse_thread/thread/b1548cd5e7… >>> >>> >> so we can add >> '-Wl,--large-address-aware'. >> option to linker. >> >> >>

April 24, 2011

Re: [Pharo-project] Fwd: [Vm-dev] Re: out of memory - cog on windows

by Andres Valloud

You can determine the switches better than me... for us, it was /LARGEADDRESSAWARE, also a linker switch: http://msdn.microsoft.com/en-us/library/wz223b1z.aspx Now, keep in mind that expanding the address space capability of the app doesn't mean Windows will give it 4gb. Under some Windows configurations, that won't happen unless you change how Windows boots. Under some versions, 4gb is just not possible. See here: http://msdn.microsoft.com/en-us/library/aa366778%28v=VS.85%29.aspx On 4/23/11 15:40 , Igor Stasenko wrote: > On 23 April 2011 21:48, Andres Valloud > <avalloud(a)smalltalk.comcastbiz.net> wrote: >> Some seemingly useful items to start tracing through Google appear here... >> >> http://groups.google.com/group/gnu.gcc.help/browse_thread/thread/b1548cd5e7… >> > so we can add > '-Wl,--large-address-aware'. > option to linker. > > >

April 24, 2011

Re: [Pharo-project] About testing that ensure works

by Igor Stasenko

First question what i wanna ask is: - why do you need to play with two different instances of organizer, and especially in such manner (temporary swapping forth and back)? This code doesn't looks to be good. On 24 April 2011 00:44, StÃ©phane Ducasse <stephane.ducasse(a)inria.fr> wrote: > Hi guys > > in RPackage there is a method named withOrganizer:do: Â defined as follows and I would like to test it to understand really if it does > what it says. > > withOrganizer: aNewOrganizer do: aBlock > Â Â Â Â "Perform an action locally to aNewOrganizer. Does not impact any other organizers." > > Â Â Â Â | old shouldRegisterAtTheEnd| > Â Â Â Â [ > Â Â Â Â old := self organizer. > Â Â Â Â shouldRegisterAtTheEnd := false. > Â Â Â Â old hasRegistered ifTrue: [ > Â Â Â Â Â Â Â Â old unregister. > Â Â Â Â Â Â Â Â shouldRegisterAtTheEnd := true. > Â Â Â Â Â Â Â Â ]. > Â Â Â Â self organizer: aNewOrganizer. > Â Â Â Â aBlock cull: aNewOrganizer.] ensure: [ > Â Â Â Â Â Â Â Â self organizer: old. > Â Â Â Â Â Â Â Â shouldRegisterAtTheEnd ifTrue: [ > Â Â Â Â Â Â Â Â Â Â Â Â self organizer register. > Â Â Â Â Â Â Â Â Â Â Â Â ]. > Â Â Â Â Â Â Â Â aNewOrganizer unregister. > Â Â Â Â Â Â Â Â ] > > > So I wrote two tests > > testWithDoIsCorrectlyReinstallingDefault > Â Â Â Â "self debug: #testWithDoIsCorrectlyReinstallingDefault" > > Â Â Â Â | current empty | > Â Â Â Â current := RPackageOrganizer default. > Â Â Â Â empty := RPackageOrganizer basicNew initialize. > Â Â Â Â RPackage withOrganizer: empty > Â Â Â Â Â Â Â Â do: [ self assert: (SystemAnnouncer announcer hasSubscriber: empty). > Â Â Â Â Â Â Â Â Â Â Â Â self deny: (SystemAnnouncer announcer hasSubscriber: current)]. > Â Â Â Â self assert: (SystemAnnouncer announcer hasSubscriber: current). > Â Â Â Â self deny: (SystemAnnouncer announcer hasSubscriber: empty) > > > and > > > testWithDoIsCorrectlyReinstallingDefaultEvenIfHalt > Â Â Â Â "self debug: #testWithDoIsCorrectlyReinstallingDefaultEvenIfHalt" > > Â Â Â Â | current empty | > Â Â Â Â current := RPackageOrganizer default. > Â Â Â Â empty := RPackageOrganizer basicNew initialize. > Â Â Â Â RPackage withOrganizer: empty > Â Â Â Â Â Â Â Â do: [ self error. > Â Â Â Â Â Â Â Â Â Â Â Â self assert: (SystemAnnouncer announcer hasSubscriber: empty). > Â Â Â Â Â Â Â Â Â Â Â Â self deny: (SystemAnnouncer announcer hasSubscriber: current)]. > Â Â Â Â self assert: (SystemAnnouncer announcer hasSubscriber: current). > Â Â Â Â self deny: (SystemAnnouncer announcer hasSubscriber: empty) > > Now I would like to make sure that I raise an error or whaever to make sure that the ensure: block argument > is executed. Does anybody have an idea how I can do that. because self error does not work. > > Stef > > > > > -- Best regards, Igor Stasenko AKA sig.

April 24, 2011

Re: [Pharo-project] Fwd: [Vm-dev] Re: out of memory - cog on windows

by Igor Stasenko

On 23 April 2011 21:48, Andres Valloud <avalloud(a)smalltalk.comcastbiz.net> wrote: > Some seemingly useful items to start tracing through Google appear here... > > http://groups.google.com/group/gnu.gcc.help/browse_thread/thread/b1548cd5e7… > so we can add '-Wl,--large-address-aware'. option to linker. -- Best regards, Igor Stasenko AKA sig.

April 24, 2011

Re: [Pharo-project] is there a way to know whether an object is registered to an announcer?

by Igor Stasenko

On 23 April 2011 21:24, StÃ©phane Ducasse <stephane.ducasse(a)inria.fr> wrote: >> >> hi guys >>> >>> >>> is there Â a way to know whether an object is registered to an announcer? >>> >>> I propose >>> >>> isRegistering: anObject >>> >>> registry subscriptionsOf: anObject Â do: [:each | ^ true]. >>> ^ false >>> >>> >> >> then more appropriate would be #hasSubscriber: > > yes much better. > >> May i ask why you need to test it? > > sure I'm trying to understand why I have 6 instances of RPackageOrganizer and also the code of cyrille. > So knowing if a given instance is registered is important for me to debug and also to write some tests. > >> Usually you don't need to test who subscribed to what. And if you do, >> then i suspect there are some design mistake. > > Exactly, still the API should let me do what I have to do when I need it. > Okay. But i would discourage from using such methods :) > Stef > >> >> >> -- >> Best regards, >> Igor Stasenko AKA sig. >> > > > -- Best regards, Igor Stasenko AKA sig.

April 24, 2011

[Pharo-project] About testing that ensure works

by StÃ©phane Ducasse

Hi guys in RPackage there is a method named withOrganizer:do: defined as follows and I would like to test it to understand really if it does what it says. withOrganizer: aNewOrganizer do: aBlock "Perform an action locally to aNewOrganizer. Does not impact any other organizers." | old shouldRegisterAtTheEnd| [ old := self organizer. shouldRegisterAtTheEnd := false. old hasRegistered ifTrue: [ old unregister. shouldRegisterAtTheEnd := true. ]. self organizer: aNewOrganizer. aBlock cull: aNewOrganizer.] ensure: [ self organizer: old. shouldRegisterAtTheEnd ifTrue: [ self organizer register. ]. aNewOrganizer unregister. ] So I wrote two tests testWithDoIsCorrectlyReinstallingDefault "self debug: #testWithDoIsCorrectlyReinstallingDefault" | current empty | current := RPackageOrganizer default. empty := RPackageOrganizer basicNew initialize. RPackage withOrganizer: empty do: [ self assert: (SystemAnnouncer announcer hasSubscriber: empty). self deny: (SystemAnnouncer announcer hasSubscriber: current)]. self assert: (SystemAnnouncer announcer hasSubscriber: current). self deny: (SystemAnnouncer announcer hasSubscriber: empty) and testWithDoIsCorrectlyReinstallingDefaultEvenIfHalt "self debug: #testWithDoIsCorrectlyReinstallingDefaultEvenIfHalt" | current empty | current := RPackageOrganizer default. empty := RPackageOrganizer basicNew initialize. RPackage withOrganizer: empty do: [ self error. self assert: (SystemAnnouncer announcer hasSubscriber: empty). self deny: (SystemAnnouncer announcer hasSubscriber: current)]. self assert: (SystemAnnouncer announcer hasSubscriber: current). self deny: (SystemAnnouncer announcer hasSubscriber: empty) Now I would like to make sure that I raise an error or whaever to make sure that the ensure: block argument is executed. Does anybody have an idea how I can do that. because self error does not work. Stef

April 23, 2011

Re: [Pharo-project] About (nil@nil)

by StÃ©phane Ducasse

I would like at least to have a well initialized point because it can break tools using the system to generate examples. Stef On Apr 21, 2011, at 7:32 PM, Igor Stasenko wrote: > probably there was a primitives which doing fast Point allocaiton, and > for this it takes an existing point instance as a prototype. > I don't know if this slot are used by something ..

April 23, 2011

Re: [Pharo-project] About (nil@nil)

by Adrian Lienhard

On Apr 21, 2011, at 19:32 , Igor Stasenko wrote: > On 21 April 2011 18:42, StÃ©phane Ducasse <stephane.ducasse(a)inria.fr> wrote: >> of course it is there >> >> newArray at: 34 put: Point new. >> >> now could not we have a well initialized point? >> What is the purpose of this one? >> > > probably there was a primitives which doing fast Point allocaiton, and > for this it takes an existing point instance as a prototype. > I don't know if this slot are used by something .. It doesn't seem so. I (quickly) checked the VM sources and couldn't find an access to this array slot... Adrian

April 23, 2011

Re: [Pharo-project] curl / http request

by Sven Van Caekenberghe

Hey Camillo, On 23 Apr 2011, at 20:05, Camillo Bruni wrote: > I am too dumb and there is too little documentation which is hard to find :). > So can anyone tell me how I do the following bash thingy in pharo? > > curl $URL --data-binary $SOME_FILE -H 'Content-type:application/json' > > I don't manage to get this working properly. I guess HTTPSocket is the class to use... > > thanks a lot > camillo Well, Zinc HTTP Components [1], of course: | json entity | json := (FileStream fileNamed: '/tmp/foo.json') contentsOfEntireFile. entity := ZnEntity with: json type: ZnMimeType applicationJson. ZnClient post: 'http://example.com/foo' data: entity This will return a ZnResponse, inspect it for more details. There are many more options, but this is a simple example to get you started. The source code should be your friend. Sven [1] http://homepage.mac.com/svc/Zinc-HTTP-Components

April 23, 2011