<div class="gmail_extra">Posting recent offline discussion...<br><br>On Fri, Apr 27, 2012 at 10:55 AM, Marius Tibeica <span dir="ltr"><<a href="mailto:mtibeica@gmail.com" target="_blank">mtibeica@gmail.com</a>></span> wrote:<br>
<blockquote style="margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex" class="gmail_quote"><div class="gmail_extra">Hi Liam,</div><div class="gmail_extra"><br></div><div class="gmail_extra">I've added the Enquire class and designed a query spec structured as a JS object. Hope you like it :)</div>
<div class="gmail_extra">
I'll probably be off a few days (there is a
national holiday Tuesday which means i have a long weekend :D) but maybe
I'll finish next week with the design phase.</div><span class="HOEnZb"></span><br><span class="HOEnZb"></span><span class="HOEnZb"><font color="#888888">
Marius</font></span><br><br><br>On Thu, Apr 26, 2012 at 1:31 PM, Marius Tibeica <span dir="ltr"><<a href="mailto:mtibeica@gmail.com" target="_blank">mtibeica@gmail.com</a>></span> wrote:<br></blockquote></div><blockquote style="margin:0pt 0pt 0pt 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex" class="gmail_quote">
<div class="gmail_extra"><blockquote>Hi Liam,<br><br>I have made the changes and added a few more classes: <a href="https://raw.github.com/mtibeica/node-xapian/master/docs.md" target="_blank">https://raw.github.com/mtibeica/node-xapian/master/docs.md</a><br>
<br><br><div class="gmail_quote">On Wed, Apr 25, 2012 at 11:48 AM, Liam Breck <span dir="ltr"><<a href="mailto:networkimprov@gmail.com" target="_blank">networkimprov@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div class="gmail_extra">Hi, some thoughts...<br><br>I think this dev plan could go in a different file than the readme. Maybe start a <a href="http://docs.md" target="_blank">docs.md</a> markdown file?<br>
<br>
Function names: internally i use V8StyleCamelCaseNames, but I
surface underscored_names to Javascript to follow the Xapian style. So
if this text is intended to be a docs draft, switch to the latter.<br><br>Argument names: to indicate expected type in docs, prefix with the V8 type names & underscore:<br> string_n object_n array_n int32_n uint32_n function_n external_n boolean_n<br>
<br>
Similarly with result objects: { name:v8type }<br><br>(I generally use iArg, oArg, ioArg to indicate whether the arg is input, output, or both, but since JS functions get a single Arguments object, I abandoned that in this binding.)<br>
<br>
Should the list-iterator functions take optional start & end arguments to allow the user to limit the range?<br><br>The Xapian query-builder functions are useful because the C++ compiler will validate user's query syntax. In JS we don't have a compiler, so an object-based query spec is easier to use, IMO.<div>
<br>
<br><div class="gmail_quote">On Wed, Apr 25, 2012 at 6:35 AM, Marius Tibeica <span dir="ltr"><<a href="mailto:mtibeica@gmail.com" target="_blank">mtibeica@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div class="gmail_extra">Hi Liam,</div><div class="gmail_extra"><br></div><div class="gmail_extra">I have made a draft for the Database class -
<a href="https://github.com/mtibeica/node-xapian/blob/master/README.txt" target="_blank">https://github.com/mtibeica/node-xapian/blob/master/README.txt</a> </div><div class="gmail_extra">Let me know if you think it's ok and I will continue with the rest.</div>
<div class="gmail_extra">I have only added the Sync version, as the Async is pretty similar (callback with the return value instead of returning)</div><div class="gmail_extra"><br></div><div class="gmail_extra">As for the query, I was thinking about implementing most of the methods similar to the way they are in C++ (for people who already use xapian) and afterwards add helping methods.</div>
<span><font color="#888888">
<div class="gmail_extra"><br></div><div class="gmail_extra">Marius</div></font></span><div><div><div class="gmail_extra"><br><br><div class="gmail_quote">On Tue, Apr 24, 2012 at 9:00 PM, Liam Breck <span dir="ltr"><<a href="mailto:networkimprov@gmail.com" target="_blank">networkimprov@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div class="gmail_extra">Congrats Marius! Welcome aboard.<br><br>Writing up a draft for the APIs you'll be tackling sounds good. You can post it in your github fork as you work on it, and I'll comment there as you go. Watch for where you can combine API features into a higher-level function, as I did with Enquire::GetMset(). Doing sync & async versions of many APIs makes sense. Node does this for the require('fs') module; see node-v.../src/node_file.cc<br>
<br>We might want to design a query spec structured as a JS object, instead of surfacing all the different query functions. For example:<br><br> (one OR two) AND green ==> {op:AND, terms:[ {op:OR, terms:['one' , 'two']} , 'green' ]}<br>
<br>Olly, you mentioned that you're moving to the MIT license, but I only see GPL in the github repo. There are multiple MIT licenses. Perhaps this one? <a href="http://xfree86.org/current/LICENSE4.html" target="_blank">http://xfree86.org/current/LICENSE4.html</a><span><font color="#888888"><br>
<br>Liam</font></span><div><div><br><br><div class="gmail_quote">On Tue, Apr 24, 2012 at 3:31 AM, Marius Tibeica <span dir="ltr"><<a href="mailto:mtibeica@gmail.com" target="_blank">mtibeica@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Hi Liam,<div><br></div><div>I saw that I was chosen for GSoC and started my work by looking for ways in which Xapian is used.</div><div><br></div><div>At <a href="http://oligarchy.co.uk/xapian/1.2.9/Search-Xapian-1.2.9.0.tar.gz" target="_blank">http://oligarchy.co.uk/xapian/1.2.9/Search-Xapian-1.2.9.0.tar.gz</a> (the Xapian Perl binding) there are unit tests and simple and advanced query and indexing methods. </div>
<div>I will look for others and then create a draft of the nodejs interfaces of all the methods, if that is ok with you.</div><div><br></div><div>The one thing that I don't really know is how to decide which methods should be sync and which async. </div>
<div>While I had the irc interview the idea that the other xapian members liked the most was to implement both and explain in the documentation why one should be used over the other, especially since things can change over time. This isn't quite the node way but I think it is an acceptable compromise.</div>
<span><font color="#888888">
<div><br></div><div>Marius</div><div><br></div>
</font></span></blockquote></div></div></div></div>
</blockquote></div></div>
</div></div></blockquote></div></div></div>
</blockquote></div></blockquote>
</div></blockquote>